sydney/IPB
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Version 5.0.0 beta 1

Browse Source
This commit is contained in:
Neo committed 2025-12-19 16:27:35 -08:00
1 parent 25ddeb65d6
commit 15c7beabc5
6736 files changed
+627902 -497943
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

system/Helpers/Wizard/Wizard.php
+43 -33
View File
@@ -11,9 +11,22 @@
namespace IPS\Helpers;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
use Exception;
use IPS\Http\Url;
use IPS\IPS;
use IPS\Output;
use IPS\Request;
use IPS\Theme;
use Throwable;
use function defined;
use function in_array;
use function is_array;
use function is_null;
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
@@ -44,70 +57,70 @@ if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
);
* @endcode
*/
class _Wizard
class Wizard
{
/**
* @brief Steps
*/
protected $steps = array();
protected array $steps = array();
/**
* @brief Base URL
*/
protected $baseUrl;
protected Url $baseUrl;
/**
* @brief Show steps?
*/
protected $showSteps = TRUE;
protected bool $showSteps = TRUE;
/**
* @brief Key used for \IPS\Data\Store
*/
protected $dataKey = TRUE;
protected bool $dataKey = TRUE;
/**
* @brief Flag to reset session data when wizard completes
*/
public $resetWhenDone = FALSE;
public bool $resetWhenDone = FALSE;
/**
* @brief Template
*/
public $template = NULL;
public ?array $template = NULL;
/**
* Constructor
*
* @param array $steps An array of callback functions. Each function should return either a string to output or (if the step is done) an array (which can be blank) of arbitrary data to retain between steps (which will be passed to each callback function). The keys should be langauge keys for the title of the step.
* @param \IPS\Http\Url $baseUrl The base URL (used when moving between steps)
* @param bool $showSteps Whether or not to show the step bar
* @param array|NULL $initialData The initial data, if any
* @param bool $resetWhenDone Whether or not to reset the session data when the wizard completes
* @param string|array|null $ignoreQueryParams String or array of URL params to ignore. For example, the base URL may be /submit/ but your userland code adds params /submit/?foo=bar, this changes the baseUrl and creates a new wizard session
* @param array $steps An array of callback functions. Each function should return either a string to output or (if the step is done) an array (which can be blank) of arbitrary data to retain between steps (which will be passed to each callback function). The keys should be langauge keys for the title of the step.
* @param Url $baseUrl The base URL (used when moving between steps)
* @param bool $showSteps Whether or not to show the step bar
* @param array|null $initialData The initial data, if any
* @param bool $resetWhenDone Whether or not to reset the session data when the wizard completes
* @param array|string|null $ignoreQueryParams String or array of URL params to ignore. For example, the base URL may be /submit/ but your userland code adds params /submit/?foo=bar, this changes the baseUrl and creates a new wizard session
* @return void
*/
public function __construct( $steps, $baseUrl, $showSteps=TRUE, $initialData=NULL, $resetWhenDone=FALSE, $ignoreQueryParams=NULL )
public function __construct(array $steps, Url $baseUrl, bool $showSteps=TRUE, array $initialData=NULL, bool $resetWhenDone=FALSE, array|string $ignoreQueryParams=NULL )
{
$this->steps = $steps;
$this->baseUrl = ( $ignoreQueryParams != NULL ) ? $baseUrl->stripQueryString( $ignoreQueryParams ) : $baseUrl;
$this->showSteps = $showSteps;
$this->resetWhenDone = $resetWhenDone;
$this->template = array( \IPS\Theme::i()->getTemplate( 'global', 'core', 'global' ), 'wizard' );
$this->template = array( Theme::i()->getTemplate( 'global', 'core', 'global' ), 'wizard' );
if ( isset( \IPS\Request::i()->_new ) )
if ( isset( Request::i()->_new ) )
{
unset( $_SESSION[ 'wizard-' . md5( $this->baseUrl ) . '-step' ] );
unset( $_SESSION[ 'wizard-' . md5( $this->baseUrl ) . '-data' ] );
if ( !\is_null( $initialData ) )
if ( !is_null( $initialData ) )
{
$_SESSION[ 'wizard-' . md5( $this->baseUrl ) . '-data' ] = $initialData;
}
if ( !\IPS\Request::i()->isAjax() )
if ( !Request::i()->isAjax() )
{
\IPS\Output::i()->redirect( $baseUrl );
Output::i()->redirect( $baseUrl );
}
}
}
@@ -120,7 +133,7 @@ class _Wizard
public function __toString()
{
/* Don't cache for a short while to ensure sessions work */
\IPS\Output::setCacheTime( false );
Output::i()->pageCaching = FALSE;
try
{
@@ -139,7 +152,7 @@ class _Wizard
{
$activeStep = $_SESSION[ 'wizard-' . md5( $this->baseUrl ) . '-step' ];
if ( isset( \IPS\Request::i()->_step ) and \in_array( \IPS\Request::i()->_step, $stepKeys ) )
if ( isset( Request::i()->_step ) and in_array( Request::i()->_step, $stepKeys ) )
{
foreach ( $stepKeys as $key )
{
@@ -147,7 +160,7 @@ class _Wizard
{
break;
}
elseif ( $key == \IPS\Request::i()->_step )
elseif ( $key == Request::i()->_step )
{
$activeStep = $key;
break;
@@ -164,11 +177,11 @@ class _Wizard
}
}
if ( isset( \IPS\Request::i()->_moveToStep ) and \in_array( \IPS\Request::i()->_moveToStep, $stepKeys ) )
if ( isset( Request::i()->_moveToStep ) and in_array( Request::i()->_moveToStep, $stepKeys ) )
{
foreach ( $stepKeys as $key )
{
if ( $key == \IPS\Request::i()->_moveToStep )
if ( $key == Request::i()->_moveToStep )
{
$activeStep = $key;
break;
@@ -179,7 +192,7 @@ class _Wizard
/* Get it's output */
$activeStepFunction = $this->steps[ $activeStep ];
$output = $activeStepFunction( $data );
while ( \is_array( $output ) )
while ( is_array( $output ) )
{
$data = array_merge( $data, $output );
@@ -222,13 +235,10 @@ class _Wizard
$htmlTemplate = $this->template;
return $htmlTemplate( $stepKeys, $activeStep, $output, $this->baseUrl, $this->showSteps );
}
catch ( \Exception $e )
catch ( Exception | Throwable $e )
{
\IPS\IPS::exceptionHandler( $e );
}
catch ( \Throwable $e )
{
\IPS\IPS::exceptionHandler( $e );
IPS::exceptionHandler( $e );
}
return '';
}
}