PHP Class MarvinLabs\SetupWizard\Wizard\DefaultSetupWizard

Inheritance: implements MarvinLabs\SetupWizard\Contracts\SetupWizard
Show file Open project: marvinlabs/laravel-setup-wizard

Protected Properties

Property Type Description
$app The Laravel application instance.
$currentStep The step currently displayed to the user
$currentStepIndex The index of the current step
$steps The steps of the wizard

Public Methods

Method Description
__construct ( Illuminate\Contracts\Foundation\Application $app = null )
currentStep ( )
firstStep ( )
initialize ( $currentStepSlug )
isCurrent ( $stepId )
isFirst ( $stepId = null )
isLast ( $stepId = null )
nextStep ( )
previousStep ( )
progress ( )
stepIndex ( $stepId )
steps ( )

Protected Methods

Method Description
createStepsFromConfig ( ) : array Get configuration and create the step objects
findStepByIndex ( $index )
findStepBySlug ( $slug = '' )

Method Details

__construct() public method

public __construct ( Illuminate\Contracts\Foundation\Application $app = null )
$app Illuminate\Contracts\Foundation\Application

createStepsFromConfig() protected method

Get configuration and create the step objects
protected createStepsFromConfig ( ) : array
return array The step objects, indexed by ID

currentStep() public method

public currentStep ( )

findStepByIndex() protected method

protected findStepByIndex ( $index )

findStepBySlug() protected method

protected findStepBySlug ( $slug = '' )

firstStep() public method

public firstStep ( )

initialize() public method

public initialize ( $currentStepSlug )

isCurrent() public method

public isCurrent ( $stepId )

isFirst() public method

public isFirst ( $stepId = null )

isLast() public method

public isLast ( $stepId = null )

nextStep() public method

public nextStep ( )

previousStep() public method

public previousStep ( )

progress() public method

public progress ( )

stepIndex() public method

public stepIndex ( $stepId )

steps() public method

public steps ( )

Property Details

$app protected property

The Laravel application instance.
protected $app

$currentStep protected property

The step currently displayed to the user
protected $currentStep

$currentStepIndex protected property

The index of the current step
protected $currentStepIndex

$steps protected property

The steps of the wizard
protected $steps