PHP Class Elcodi\Plugin\StoreSetupWizardBundle\Services\WizardRoutes

Afficher le fichier Open project: elcodi/bamboo Class Usage Examples

Protected Properties

Свойство Type Description
$wizardRoutesByStep array The wizard routes by step
$wizardStatus WizardStatus The wizardStatus service

Méthodes publiques

Méthode 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.

Method Details

__construct() public méthode

Builds a new WizardRoutes class
public __construct ( WizardStatus $wizardStatus )
$wizardStatus WizardStatus

getDefaultWizardRoute() public méthode

Gets the default route.
public getDefaultWizardRoute ( ) : boolean
Résultat boolean If is the default route.

getNextStepRoute() public méthode

Get the next step route.
public getNextStepRoute ( ) : string
Résultat string The route

getStepByRoute() public méthode

Gets the step for the given routes.
public getStepByRoute ( string $route ) : integer | null
$route string The route to check
Résultat integer | null The step route

getStepRoute() public méthode

Get the route for the given step.
public getStepRoute ( string $step ) : string
$step string The received step
Résultat string The route

isWizardHidden() public méthode

Checks if the wizard is hidden on the given route.
public isWizardHidden ( string $route ) : boolean
$route string The route to check.
Résultat boolean If the wizard is hidden.

isWizardSetupRoute() public méthode

Checks if the received route is one of the wizards setup pages.
public isWizardSetupRoute ( string $route ) : boolean
$route string The received route
Résultat boolean If is part of the wizards setup.

Property Details

$wizardRoutesByStep protected_oe property

The wizard routes by step
protected array $wizardRoutesByStep
Résultat array

$wizardStatus protected_oe property

The wizardStatus service
protected WizardStatus,Elcodi\Plugin\StoreSetupWizardBundle\Services $wizardStatus
Résultat WizardStatus