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

Encapsulated procedures from init() into their own methods, specifically, setSession() which sets up the current multiform session, and getCurrentStep() is now smarter and setCurrentStep() does the step writing responsibilities

Browse Source
This commit is contained in:
Sean Harvey 2008-04-20 00:01:27 +00:00
parent 75cee5851a
commit a0dfd338fb
1 changed files with 71 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

133
code/MultiForm.php
View File

@ -73,65 +73,18 @@ abstract class MultiForm extends Form {
* Perform actions when the multiform is first started. * Perform actions when the multiform is first started.
* *
* 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. * 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, * It sets up the right form session, gets the form step and populates the fields, actions,
* and validation (if it's applicable). * and validation (if it's applicable).
*
* @TODO We've currently got some start up routines that probably need to be moved to their own method,
* like start() - like creating a new MultiFormSession instance.
*
* @TODO init() may not be an appropriate name, considering there's already an init() automatically called
* for controller classes. Perhaps we rename this?
*
* @TODO Expiration. We need to make sure that these sessions, making use of {@link MultiFormPurgeTask} and
* {@link MultiFormObjectDecorator}
*/ */
public function init() { public function init() {
$startStepClass = $this->stat('start_step'); // Set up the session
$urlType = $this->stat('url_type'); $this->setSession();
// Check if there was a start step defined on the subclass of MultiForm // Get the current step, and set it
if(!isset($startStepClass)) user_error('MultiForm::init(): Please define a $startStep on ' . $this->class, E_USER_ERROR); $currentStep = $this->getCurrentStep();
$this->setCurrentStep($currentStep);
// If there's a MultiFormSessionID variable set, find that, otherwise create a new session
if(isset($_GET['MultiFormSessionID'])) {
if($urlType == 'Hash') {
$hash = Convert::raw2sql($_GET['MultiFormSessionID']);
$this->session = DataObject::get_one('MultiFormSession', "Hash = '$hash'");
} elseif($urlType == 'ID') {
$this->session = DataObject::get_by_id('MultiFormSession', (int)$_GET['MultiFormSessionID']);
} else {
user_error('MultiForm::init(): Please define a correct value for $url_type on ' . $this->class, E_USER_ERROR);
}
} else {
// @TODO fix the fact that you can continually refresh on the first step creating new records
$this->session = new MultiFormSession();
$this->session->write();
if($urlType == 'Hash') $this->session->Hash = sha1($this->session->ID);
}
// Determine whether we use the current step, or create one if it doesn't exist
if(isset($_GET['StepID'])) {
$stepID = (int)$_GET['StepID'];
$step = DataObject::get_one('MultiFormStep', "SessionID = {$this->session->ID} AND ID = {$stepID}");
if($step) {
$currentStep = $step;
$this->session->CurrentStepID = $currentStep->ID;
$this->session->write();
}
// @TODO if you set a wrong ID, then it ends up at this point with a non-object error.
} elseif($this->session->CurrentStepID) {
$currentStep = $this->session->CurrentStep();
} else {
// @TODO fix the fact that you can continually refresh on the first step creating new records
// @TODO encapsulate this into it's own method - it's the same code as the next() method anyway
$currentStep = new $startStepClass();
$currentStep->SessionID = $this->session->ID;
$currentStep->write();
$this->session->CurrentStepID = $currentStep->ID;
$this->session->write();
}
// Set up the fields from the current step // Set up the fields from the current step
$this->setFields($currentStep->getFields()); $this->setFields($currentStep->getFields());
@ -151,6 +104,71 @@ abstract class MultiForm extends Form {
} }
} }
/**
* Get the current step.
* @return MultiFormStep subclass
*/
public function getCurrentStep() {
$startStepClass = $this->stat('start_step');
// Check if there was a start step defined on the subclass of MultiForm
if(!isset($startStepClass)) user_error('MultiForm::init(): Please define a $startStep on ' . $this->class, E_USER_ERROR);
// Determine whether we use the current step, or create one if it doesn't exist
if(isset($_GET['StepID'])) {
$stepID = (int)$_GET['StepID'];
$step = DataObject::get_one('MultiFormStep', "SessionID = {$this->session->ID} AND ID = {$stepID}");
if($step) {
$currentStep = $step;
}
// @TODO if you set a wrong ID, then it ends up at this point with a non-object error.
} elseif($this->session->CurrentStepID) {
$currentStep = $this->session->CurrentStep();
} else {
// @TODO fix the fact that you can continually refresh on the first step creating new records
// @TODO encapsulate this into it's own method - it's the same code as the next() method anyway
$currentStep = new $startStepClass();
$currentStep->SessionID = $this->session->ID;
$currentStep->write();
}
return $currentStep;
}
/**
* Set the step passed in as the current step.
* @param MultiFormStep $step A subclass of MultiFormStep
*/
protected function setCurrentStep($step) {
$this->session->CurrentStepID = $step->ID;
$this->session->write();
}
/**
* Set up the session. There's a bit of logic to determine this, specifically
* checking if there's a GET variable for a current session set.
*/
protected function setSession() {
$urlType = $this->stat('url_type');
// If there's a MultiFormSessionID variable set, find that, otherwise create a new session
if(isset($_GET['MultiFormSessionID'])) {
if($urlType == 'Hash') {
$hash = Convert::raw2sql($_GET['MultiFormSessionID']);
$this->session = DataObject::get_one('MultiFormSession', "Hash = '$hash'");
} elseif($urlType == 'ID') {
$this->session = DataObject::get_by_id('MultiFormSession', (int)$_GET['MultiFormSessionID']);
} else {
user_error('MultiForm::init(): Please define a correct value for $url_type on ' . $this->class, E_USER_ERROR);
}
} else {
// @TODO fix the fact that you can continually refresh on the first step creating new records
$this->session = new MultiFormSession();
$this->session->write();
if($urlType == 'Hash') $this->session->Hash = sha1($this->session->ID);
$this->session->write(); // I guess we could hash something else than the ID, this is a bit ugly...
}
}
/** /**
* Set the fields for this form. * Set the fields for this form.
* *
@ -409,15 +427,6 @@ abstract class MultiForm extends Form {
} }
} }
/**
* Returns the current step in the form process.
*
* @return Instance of a MultiFormStep subclass
*/
public function getCurrentStep() {
return $this->session->CurrentStep();
}
/** /**
* Number of steps already completed (excluding currently started step). * Number of steps already completed (excluding currently started step).
* The way we determine a step is complete is to check if it has the Data * The way we determine a step is complete is to check if it has the Data