MultiStepFormController class - Documentation for SproutCMS

Info Page:

Page options:

class MultiStepFormController

Supports multistep forms

Name	Visibility	Description
`$complete_function`		Appendage to route, where user is redirected after save on final step
`$page_title`		Page title to be displayed on form steps
`$route`		Route to form, relative to site root
`$session_key`		Key for partitioning session data associated with this form, i.e. $_SESSION[$this->session_key]
`$steps`		Steps and functions/views used to implement them Keys are step numbers, values are function (and matching view) names e.g. [1 => 'intro', 2 => 'personal_details']
`$table`		Table into which data will be saved at the final step
`$view_dir`		Directory in which views are stored, without trailing slash

Name	Visibility	Description
buildUrl	protected	Builds a URL to the form at a particular step
checkStep	protected	Check the user has access to a step
complete	public	Display the thanks message after the process has been completed
firstStep	protected	Gets the number (should be 0 or 1) of first step of the process
form	protected	The method used to drive the forms at each step
getSession	protected	Instantiate the session and make sure the session key is useable
save	protected	Do any final preparation / data massaging; then call saveData and finally redirect.
saveData	protected	Save the data, e.g. into a database, after successful validation at the
submit	protected	The method used to drive the form submissions at each step
validate	protected

string $MultiStepFormController->buildUrl ( int $step [, bool $include_first ] );

Builds a URL to the form at a particular step

void $MultiStepFormController->checkStep ( mixed $session , mixed $step );

Check the user has access to a step

void $MultiStepFormController->complete ( );

Display the thanks message after the process has been completed

int $MultiStepFormController->firstStep ( );

Gets the number (should be 0 or 1) of first step of the process

View $MultiStepFormController->form ( [ int $step ] );

The method used to drive the forms at each step
This should be called by the entry function of the subclass controller

array $MultiStepFormController->getSession ( );

Instantiate the session and make sure the session key is useable

void $MultiStepFormController->save ( );

Do any final preparation / data massaging; then call saveData and finally redirect.
This should generally be overridden.

null|int $MultiStepFormController->saveData ( string $table , array $sub_tables , array $extra_fields );

Save the data, e.g. into a database, after successful validation at the
final step

void $MultiStepFormController->submit ( int $step );

The method used to drive the form submissions at each step
This should be called by the submit function of the subclass controller

void $MultiStepFormController->validate ( int &$step , array $reqd , array $rules [, Validator $valid ] );

This function does not have a description