PHP Класс Elcodi\Plugin\StoreSetupWizardBundle\Services\WizardRoutes

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$wizardRoutesByStep array The wizard routes by step
$wizardStatus WizardStatus The wizardStatus service

Открытые методы

Метод Описание
__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.

Описание методов

__construct() публичный Метод

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

getDefaultWizardRoute() публичный Метод

Gets the default route.
public getDefaultWizardRoute ( ) : boolean
Результат boolean If is the default route.

getNextStepRoute() публичный Метод

Get the next step route.
public getNextStepRoute ( ) : string
Результат string The route

getStepByRoute() публичный Метод

Gets the step for the given routes.
public getStepByRoute ( string $route ) : integer | null
$route string The route to check
Результат integer | null The step route

getStepRoute() публичный Метод

Get the route for the given step.
public getStepRoute ( string $step ) : string
$step string The received step
Результат string The route

isWizardHidden() публичный Метод

Checks if the wizard is hidden on the given route.
public isWizardHidden ( string $route ) : boolean
$route string The route to check.
Результат boolean If the wizard is hidden.

isWizardSetupRoute() публичный Метод

Checks if the received route is one of the wizards setup pages.
public isWizardSetupRoute ( string $route ) : boolean
$route string The received route
Результат boolean If is part of the wizards setup.

Описание свойств

$wizardRoutesByStep защищенное свойство

The wizard routes by step
protected array $wizardRoutesByStep
Результат array

$wizardStatus защищенное свойство

The wizardStatus service
protected WizardStatus,Elcodi\Plugin\StoreSetupWizardBundle\Services $wizardStatus
Результат WizardStatus