PHP Interface MarvinLabs\SetupWizard\Contracts\WizardStep

Implement that interface to describe your wizard steps

Inheritance: extends Illuminate\Contracts\Support\MessageProvider

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

Public Methods

Method	Description
__construct ( $id )
apply ( array $formData ) : boolean
getFormData ( ) : array
getId ( ) : string
getSlug ( ) : string
undo ( ) : boolean

Method Details

__construct() public method

public __construct ( $id )

apply() public method

public apply ( array $formData ) : boolean
$formData	array	An array containing all the form data for that step
return	boolean	true if the step has been applied successfully

getFormData() public method

public getFormData ( ) : array
return	array	The initial form data to be used to populate the step fields

getId() public method

public getId ( ) : string
return	string	The unique identifier for the step

getSlug() public method

public getSlug ( ) : string
return	string	The slug shown in the URL when viewing that wizard step

undo() public method

public undo ( ) : boolean
return	boolean	true if the step has been undone successfully