PHP Интерфейс MarvinLabs\SetupWizard\Contracts\SetupWizard

Показать файл Открыть проект

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

Метод	Описание
currentStep ( ) : MarvinLabs\SetupWizard\Contracts\WizardStep
firstStep ( ) : MarvinLabs\SetupWizard\Contracts\WizardStep
initialize ( $currentStepSlug )	Initialize the wizard for the current request. Sets the current step, etc.
isCurrent ( string $stepId ) : boolean	Check if the step ID corresponds to the current step
isFirst ( string $stepId = null ) : boolean	If the step the first one of the wizard
isLast ( string $stepId = null ) : boolean	If the step the first one of the wizard
nextStep ( ) : MarvinLabs\SetupWizard\Contracts\WizardStep
previousStep ( ) : MarvinLabs\SetupWizard\Contracts\WizardStep
progress ( ) : integer
stepIndex ( string $stepId ) : integer
steps ( ) : array	Get the steps which

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

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

public currentStep ( ) : MarvinLabs\SetupWizard\Contracts\WizardStep
Результат	MarvinLabs\SetupWizard\Contracts\WizardStep	The current step

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

public firstStep ( ) : MarvinLabs\SetupWizard\Contracts\WizardStep
Результат	MarvinLabs\SetupWizard\Contracts\WizardStep	The first step of the wizard

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

Initialize the wizard for the current request. Sets the current step, etc.

public initialize ( $currentStepSlug )
$currentStepSlug

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

Check if the step ID corresponds to the current step

public isCurrent ( string $stepId ) : boolean
$stepId	string	The ID of the step
Результат	boolean	true if the step is the current one

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

If the step the first one of the wizard

public isFirst ( string $stepId = null ) : boolean
$stepId	string	The ID of the step, or null to target the current step
Результат	boolean	true if the step is the first

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

If the step the first one of the wizard

public isLast ( string $stepId = null ) : boolean
$stepId	string	The ID of the step, or null to target the current step
Результат	boolean	true if the step is the last

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

public nextStep ( ) : MarvinLabs\SetupWizard\Contracts\WizardStep
Результат	MarvinLabs\SetupWizard\Contracts\WizardStep	The next step

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

public previousStep ( ) : MarvinLabs\SetupWizard\Contracts\WizardStep
Результат	MarvinLabs\SetupWizard\Contracts\WizardStep	The previous step

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

public progress ( ) : integer
Результат	integer	Percentage of progress for the wizard, given the current step

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

public stepIndex ( string $stepId ) : integer
$stepId	string	The ID of the step
Результат	integer	The step order number (0 is the first step)

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

Get the steps which

public steps ( ) : array
Результат	array	The step objects