tonyair/silverstripe-multiform
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-multiform synced 2024-07-01 16:59:28 +02:00
Code Issues Projects Releases Wiki Activity

encapsulated $this->session->CurrentStep() calls to getCurrentStep()

Browse Source
This commit is contained in:
Sean Harvey 2008-04-20 00:28:18 +00:00
parent a0dfd338fb
commit eb5b57f418
1 changed files with 20 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
code/MultiForm.php
View File

@ -75,8 +75,8 @@ abstract class MultiForm extends Form {
* It does NOT work like a normal controller init()! It has to be explicity called when MultiForm * It does NOT work like a normal controller init()! It has to be explicity called when MultiForm
* is intanciated on your controller. @TODO perhaps find a better name, that doesn't quite conflict. * is intanciated on your controller. @TODO perhaps find a better name, that doesn't quite conflict.
* *
* It sets up the right form session, gets the form step and populates the fields, actions, * This method sets up the session, figures out the current step, sets the current step, and
* and validation (if it's applicable). *
*/ */
public function init() { public function init() {
// Set up the session // Set up the session
@ -190,14 +190,14 @@ abstract class MultiForm extends Form {
// If the form is at final step, create a submit button to perform final actions // 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 // The last step doesn't have a next button, so add that action to any step that isn't the final one
if($this->session->CurrentStep()->isFinalStep()) { if($this->getCurrentStep()->isFinalStep()) {
$this->actions->push(new FormAction('finish', _t('MultiForm.SUBMIT', 'Submit'))); $this->actions->push(new FormAction('finish', _t('MultiForm.SUBMIT', 'Submit')));
} else { } else {
$this->actions->push(new FormAction('next', _t('MultiForm.NEXT', 'Next'))); $this->actions->push(new FormAction('next', _t('MultiForm.NEXT', 'Next')));
} }
// If there is a previous step defined, add the back button // If there is a previous step defined, add the back button
if($this->session->CurrentStep()->getPreviousStep()) { if($this->getCurrentStep()->getPreviousStep()) {
if($this->actions->fieldByName('action_next')) { if($this->actions->fieldByName('action_next')) {
$this->actions->insertBefore(new FormAction('prev', _t('MultiForm.BACK', 'Back')), 'action_next'); $this->actions->insertBefore(new FormAction('prev', _t('MultiForm.BACK', 'Back')), 'action_next');
} elseif($this->actions->fieldByName('action_finish')) { } elseif($this->actions->fieldByName('action_finish')) {
@ -208,7 +208,7 @@ abstract class MultiForm extends Form {
} }
// Merge any extra action fields defined on the step // Merge any extra action fields defined on the step
$this->actions->merge($this->session->CurrentStep()->getExtraActions()); $this->actions->merge($this->getCurrentStep()->getExtraActions());
} }
/** /**
@ -220,7 +220,7 @@ abstract class MultiForm extends Form {
*/ */
function forTemplate() { function forTemplate() {
return $this->renderWith(array( return $this->renderWith(array(
$this->session->CurrentStep()->class, $this->getCurrentStep()->class,
'MultiFormStep', 'MultiFormStep',
$this->class, $this->class,
'MultiForm', 'MultiForm',
@ -238,7 +238,7 @@ abstract class MultiForm extends Form {
* @param object $form The form that the action was called on * @param object $form The form that the action was called on
*/ */
public function finish($data, $form) { public function finish($data, $form) {
if(!$this->session->CurrentStep()->isFinalStep()) { if(!$this->getCurrentStep->isFinalStep()) {
Director::redirectBack(); Director::redirectBack();
return false; return false;
} }
@ -258,13 +258,13 @@ abstract class MultiForm extends Form {
* @param object $form The form that the action was called on * @param object $form The form that the action was called on
*/ */
public function next($data, $form) { public function next($data, $form) {
if(!$this->session->CurrentStep()->getNextStep()) { if(!$this->getCurrentStep()->getNextStep()) {
Director::redirectBack(); Director::redirectBack();
return false; return false;
} }
// Switch the step to the next! // Switch the step to the next!
$nextStepClass = $this->session->CurrentStep()->getNextStep(); $nextStepClass = $this->getCurrentStep()->getNextStep();
// Save the form data for the current step // Save the form data for the current step
$this->save($data); $this->save($data);
@ -273,14 +273,14 @@ abstract class MultiForm extends Form {
if(!$nextStep = DataObject::get_one($nextStepClass, "SessionID = {$this->session->ID}")) { if(!$nextStep = DataObject::get_one($nextStepClass, "SessionID = {$this->session->ID}")) {
$nextStep = new $nextStepClass(); $nextStep = new $nextStepClass();
$nextStep->SessionID = $this->session->ID; $nextStep->SessionID = $this->session->ID;
$nextStep->write();
} }
$nextStep->write(); // Set the next step to be the current step
$this->session->CurrentStepID = $nextStep->ID; $this->setCurrentStep($nextStep);
$this->session->write();
// Redirect to the next step // Redirect to the next step
Director::redirect($this->session->CurrentStep()->Link()); Director::redirect($this->getCurrentStep()->Link());
return; return;
} }
@ -298,23 +298,22 @@ abstract class MultiForm extends Form {
* @param object $form The form that the action was called on * @param object $form The form that the action was called on
*/ */
public function prev($data, $form) { public function prev($data, $form) {
if(!$this->session->CurrentStep()->getPreviousStep()) { if(!$this->getCurrentStep()->getPreviousStep()) {
Director::redirectBack(); Director::redirectBack();
return false; return false;
} }
// Switch the step to the previous! // Switch the step to the previous!
$prevStepClass = $this->session->CurrentStep()->getPreviousStep(); $prevStepClass = $this->getCurrentStep()->getPreviousStep();
// Get the previous step of the class instance returned from $currentStep->getPreviousStep() // Get the previous step of the class instance returned from $currentStep->getPreviousStep()
$prevStep = DataObject::get_one($prevStepClass, "SessionID = {$this->session->ID}"); $prevStep = DataObject::get_one($prevStepClass, "SessionID = {$this->session->ID}");
// Set the current step as the previous step // Set the current step as the previous step
$this->session->CurrentStepID = $prevStep->ID; $this->setCurrentStep($prevStep);
$this->session->write();
// Redirect to the previous step // Redirect to the previous step
Director::redirect($this->session->CurrentStep()->Link()); Director::redirect($this->getCurrentStep()->Link());
return; return;
} }
@ -328,7 +327,7 @@ abstract class MultiForm extends Form {
* @param array $data An array of data to save * @param array $data An array of data to save
*/ */
protected function save($data) { protected function save($data) {
$currentStep = $this->session->CurrentStep(); $currentStep = $this->getCurrentStep();
if(is_array($data)) { if(is_array($data)) {
foreach($data as $field => $value) { foreach($data as $field => $value) {
if(in_array($field, self::$ignored_fields) || self::is_action_field($field)) { if(in_array($field, self::$ignored_fields) || self::is_action_field($field)) {
@ -373,7 +372,7 @@ abstract class MultiForm extends Form {
'ClassName' => $firstStep->class, 'ClassName' => $firstStep->class,
'Title' => $firstStep->getTitle(), 'Title' => $firstStep->getTitle(),
'SessionID' => ($this->stat('url_type') == 'ID') ? $this->session->ID : $this->session->Hash, 'SessionID' => ($this->stat('url_type') == 'ID') ? $this->session->ID : $this->session->Hash,
'LinkingMode' => ($firstStep->ID == $this->session->CurrentStep()->ID) ? 'current' : 'link' 'LinkingMode' => ($firstStep->ID == $this->getCurrentStep()->ID) ? 'current' : 'link'
); );
$stepsFound->push(new ArrayData($templateData)); $stepsFound->push(new ArrayData($templateData));
@ -406,7 +405,7 @@ abstract class MultiForm extends Form {
'ClassName' => $nextStep->class, 'ClassName' => $nextStep->class,
'Title' => $nextStep->getTitle(), 'Title' => $nextStep->getTitle(),
'SessionID' => ($this->stat('url_type') == 'ID') ? $this->session->ID : $this->session->Hash, 'SessionID' => ($this->stat('url_type') == 'ID') ? $this->session->ID : $this->session->Hash,
'LinkingMode' => ($nextStep->ID == $this->session->CurrentStep()->ID) ? 'current' : 'link' 'LinkingMode' => ($nextStep->ID == $this->getCurrentStep()->ID) ? 'current' : 'link'
); );
$stepsFound->push(new ArrayData($templateData)); $stepsFound->push(new ArrayData($templateData));
} else { } else {