PHP Interface MarvinLabs\SetupWizard\Contracts\SetupWizard

Show file Open project: marvinlabs/laravel-setup-wizard

Public Methods

Method Description
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

Method Details

currentStep() public method

public currentStep ( ) : MarvinLabs\SetupWizard\Contracts\WizardStep
return MarvinLabs\SetupWizard\Contracts\WizardStep The current step

firstStep() public method

public firstStep ( ) : MarvinLabs\SetupWizard\Contracts\WizardStep
return MarvinLabs\SetupWizard\Contracts\WizardStep The first step of the wizard

initialize() public method

Initialize the wizard for the current request. Sets the current step, etc.
public initialize ( $currentStepSlug )
$currentStepSlug

isCurrent() public method

Check if the step ID corresponds to the current step
public isCurrent ( string $stepId ) : boolean
$stepId string The ID of the step
return boolean true if the step is the current one

isFirst() public method

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
return boolean true if the step is the first

isLast() public method

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
return boolean true if the step is the last

nextStep() public method

public nextStep ( ) : MarvinLabs\SetupWizard\Contracts\WizardStep
return MarvinLabs\SetupWizard\Contracts\WizardStep The next step

previousStep() public method

public previousStep ( ) : MarvinLabs\SetupWizard\Contracts\WizardStep
return MarvinLabs\SetupWizard\Contracts\WizardStep The previous step

progress() public method

public progress ( ) : integer
return integer Percentage of progress for the wizard, given the current step

stepIndex() public method

public stepIndex ( string $stepId ) : integer
$stepId string The ID of the step
return integer The step order number (0 is the first step)

steps() public method

Get the steps which
public steps ( ) : array
return array The step objects