PHP Class Elcodi\Plugin\StoreSetupWizardBundle\Services\WizardRoutes

Protected Properties

Property	Type	Description
$wizardRoutesByStep	array	The wizard routes by step
$wizardStatus	WizardStatus	The wizardStatus service

Method	Description
__construct ( WizardStatus $wizardStatus )	Builds a new WizardRoutes class
getDefaultWizardRoute ( ) : boolean	Gets the default route.
getNextStepRoute ( ) : string	Get the next step route.
getStepByRoute ( string $route ) : integer \| null	Gets the step for the given routes.
getStepRoute ( string $step ) : string	Get the route for the given step.
isWizardHidden ( string $route ) : boolean	Checks if the wizard is hidden on the given route.
isWizardSetupRoute ( string $route ) : boolean	Checks if the received route is one of the wizards setup pages.

Builds a new WizardRoutes class

public __construct ( WizardStatus $wizardStatus )
$wizardStatus	WizardStatus

Gets the default route.

public getDefaultWizardRoute ( ) : boolean
return	boolean	If is the default route.

Get the next step route.

public getNextStepRoute ( ) : string
return	string	The route

Gets the step for the given routes.

public getStepByRoute ( string $route ) : integer \| null
$route	string	The route to check
return	integer \| null	The step route

Get the route for the given step.

public getStepRoute ( string $step ) : string
$step	string	The received step
return	string	The route

Checks if the wizard is hidden on the given route.

public isWizardHidden ( string $route ) : boolean
$route	string	The route to check.
return	boolean	If the wizard is hidden.

Checks if the received route is one of the wizards setup pages.

public isWizardSetupRoute ( string $route ) : boolean
$route	string	The received route
return	boolean	If is part of the wizards setup.

The wizard routes by step

protected array $wizardRoutesByStep
return	array

The wizardStatus service

protected WizardStatus,Elcodi\Plugin\StoreSetupWizardBundle\Services $wizardStatus
return	WizardStatus