tonyair/silverstripe-multiform
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-multiform synced 2024-10-22 11:05:49 +02:00
Code Issues Projects Releases Wiki Activity

FEATURE Allow setting a flag (true, by default) so that you can't use the "back" form action for a step.

Browse Source
This commit is contained in:
Sean Harvey 2008-05-27 04:49:16 +00:00
parent 2385c23d63
commit 4f758064d9
2 changed files with 38 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
code/MultiForm.php
View File

@ -83,18 +83,21 @@ abstract class MultiForm extends Form {
* takes the fields, actions and validation (if any) for the step, setting up the form.
*/
public function init() {
// Set up the session
// Set up the session for this MultiForm instance
$this->setSession();
// Get the current step, and set it
// Get the current step available (Note: either returns an existing
// step or creates a new one if none available)
$currentStep = $this->getCurrentStep();
// Set the step returned above as the current step
$this->setCurrentStep($currentStep);
// Set up the fields from the current step
// Set up the fields for the current step
$this->setFields($currentStep->getFields());
// Set up the actions from the current step
$this->setActions();
// Set up the actions for the current step
$this->setActions($currentStep);
// Set a hidden field in the form to identify this session.
// Depending on what has been configured for $url_type, we
@ -102,7 +105,7 @@ abstract class MultiForm extends Form {
$urlMethod = $this->stat('url_type');
$this->fields->push(new HiddenField('MultiFormSessionID', false, $this->session->$urlMethod));
// Set up validator from the form step class
// Set up validator for the step
$this->setValidator();
// If there is form data, we populate it here (CAUTION: loadData() MUST unserialize first!)
@ -282,32 +285,34 @@ abstract class MultiForm extends Form {
* If there are any extra actions defined in MultiFormStep->getExtraActions()
* then that set of actions is appended to the end of the actions FieldSet we
* have created in this method.
*
* @param $currentStep Subclass of MultiFormStep to set actions for
*/
function setActions() {
function setActions($currentStep) {
// Create default multi step actions (next, prev), and merge with extra actions, if any
$this->actions = new FieldSet();
// If the form is at final step, create a submit button to perform final actions
// The last step doesn't have a next button, so add that action to any step that isn't the final one
if($this->getCurrentStep()->isFinalStep()) {
if($currentStep->isFinalStep()) {
$this->actions->push(new FormAction('finish', _t('MultiForm.SUBMIT', 'Submit')));
} else {
$this->actions->push(new FormAction('next', _t('MultiForm.NEXT', 'Next')));
}
// If there is a previous step defined, add the back button
if($this->getCurrentStep()->getPreviousStep()) {
if($this->actions->fieldByName('action_next')) {
if($currentStep->getPreviousStep() && $currentStep->canGoBack()) {
// If there is a next step, insert the action before the next action
if($currentStep->getNextStep()) {
$this->actions->insertBefore(new FormAction('prev', _t('MultiForm.BACK', 'Back')), 'action_next');
} elseif($this->actions->fieldByName('action_finish')) {
$this->actions->insertBefore(new FormAction('prev', _t('MultiForm.BACK', 'Back')), 'action_finish');
// Assume that this is the last step, insert the action before the finish action
} else {
$this->actions->push(new FormAction('prev', _t('MultiForm.BACK', 'Back')));
$this->actions->insertBefore(new FormAction('prev', _t('MultiForm.BACK', 'Back')), 'action_finish');
}
}
// Merge any extra action fields defined on the step
$this->actions->merge($this->getCurrentStep()->getExtraActions());
$this->actions->merge($currentStep->getExtraActions());
}
/**
@ -395,7 +400,7 @@ abstract class MultiForm extends Form {
* @param object $form The form that the action was called on
*/
public function prev($data, $form) {
if(!$this->getCurrentStep()->getPreviousStep()) {
if(!$this->getCurrentStep()->getPreviousStep() && !$this->getCurrentStep()->canGoBack()) {
Director::redirectBack();
return false;
}

18
code/MultiFormStep.php
View File

@ -42,6 +42,14 @@ class MultiFormStep extends DataObject {
*/
protected static $is_final_step = false;
/**
* This variable determines whether a user can use
* the "back" action from this step.
*
* @var boolean
*/
protected static $can_go_back = true;
/**
* Title of this step.
*
@ -232,6 +240,16 @@ class MultiFormStep extends DataObject {
// ##################### Utility ####################
/**
* Determines whether the user is able to go back using the "action_back"
* form action, based on the boolean value of $can_go_back.
*
* @return boolean
*/
public function canGoBack() {
return $this->stat('can_go_back');
}
/**
* Determines whether this step is the final step in the multi-step process or not,
* based on the variable $is_final_step - which must be defined on at least one step.