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

BUGFIX Removing url_type which isnt very useful MINOR documentation updates ENHANCEMENT return value on MultiForm->setCurrentStep() MINOR code cleanup in general

Browse Source
This commit is contained in:
Sean Harvey 2008-07-21 21:06:59 +00:00
parent 1b662ff9e1
commit a42bb6103b
3 changed files with 47 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
code/MultiForm.php
View File

@ -16,44 +16,27 @@
abstract class MultiForm extends Form {
/**
* A session object stored in the database, which might link
* to further temporary {@link DataObject}s.
* A session object stored in the database, to identify and store
* data for this MultiForm instance.
*
* @var MultiFormSession
*/
protected $session;
/**
* Defines which subclass of {@link MultiFormStep} starts the form -
* needs to be defined for the controller to work correctly
* Defines which subclass of {@link MultiFormStep} should be the first
* step in the multi-step process.
*
* @var string Classname of a {@link MultiFormStep} subclass
*/
protected static $start_step;
/**
* Define what type of URL you want to use throughout the step process.
*
* By default, we store a hash, for example: http://mysite.com/my-form/?MultiFormSessionID=de9f2c7fd25e1b3afad3e850bd17d9b100db4b3
* Alternatively, if you set this variable to "ID", then you get ?MultiFormSessionID=20
*
* The ID is not as secure as the hash, but it all depends on your set up.
* If you're going to add security, such as check the SubmitterID on init
* of the MultiForm and use "ID" for this parameter, then security should be fine.
*
* In any other case, where there's no Member tied to a MultiFormSession, using
* the Hash is the recommended approach.
*
* @var $url_type either "ID", or "Hash"
*/
protected static $url_type = 'Hash';
/**
* Set the casting for these fields.
*
* @var array
*/
static $casting = array(
public static $casting = array(
'CompletedStepCount' => 'Int',
'TotalStepCount' => 'Int',
'CompletedPercent' => 'Float'
@ -66,7 +49,7 @@ abstract class MultiForm extends Form {
*
* @var array
*/
static $ignored_fields = array(
public static $ignored_fields = array(
'url',
'executeForm',
'MultiFormSessionID',
@ -105,7 +88,7 @@ abstract class MultiForm extends Form {
// Set up validation (if necessary) {@TODO find a better way instead
// of hardcoding a check for action_prev in order to prevent validation
// when hitting the back button
$validator = '';
$validator = null;
if(empty($_REQUEST['action_prev'])) {
if($this->getCurrentStep()->getValidator()) {
$validator = $this->getCurrentStep()->getValidator();
@ -113,26 +96,25 @@ abstract class MultiForm extends Form {
}
// Give the fields, actions, and validation for the current step back to the parent Form class
parent::__construct($controller, $name, $fields, $actions, $validator ? $validator : null);
parent::__construct($controller, $name, $fields, $actions, $validator);
// Set a hidden field in the form to identify this session.
// Depending on what has been configured for $url_type, we
// find an encrypted hash by default to identify the session.
$urlMethod = $this->stat('url_type');
$this->fields->push(new HiddenField('MultiFormSessionID', false, $this->session->$urlMethod));
// Set a hidden field in our form with an encrypted hash to identify this session.
$this->fields->push(new HiddenField('MultiFormSessionID', false, $this->session->Hash));
// If there is form data, we populate it here (CAUTION: loadData() MUST unserialize first!)
// If there is saved data for the current step, we load it into the form it here
//(CAUTION: loadData() MUST unserialize first!)
if($currentStep->loadData()) {
$this->loadDataFrom($currentStep->loadData());
}
// Disable security token - we tie a form to a session ID so this is not required
// Disable security token - we tie a form to a session ID instead
$this->disableSecurityToken();
}
/**
* Accessor method to $this->controller
* Returns the controller this form was instanciated on.
* Accessor method to $this->controller.
*
* @return Controller this MultiForm was instanciated on.
*/
public function getController() {
return $this->controller;
@ -173,10 +155,11 @@ abstract class MultiForm extends Form {
* Set the step passed in as the current step.
*
* @param MultiFormStep $step A subclass of MultiFormStep
* @return boolean The return value of write()
*/
protected function setCurrentStep($step) {
$this->session->CurrentStepID = $step->ID;
$this->session->write();
return $this->session->write();
}
/**
@ -191,11 +174,6 @@ abstract class MultiForm extends Form {
/**
* Set up the session.
*
* First of all we check if MultiFormSessionID is set in the URL,
* then we determine what URL type has been set (default is "Hash").
* Knowing this, we can retrieve the session record from the database
* by a particular method (getSessionRecordByHash, or getSessionRecordByID).
*
* If MultiFormSessionID isn't set, we assume that this is a new
* multiform that requires a new session record to be created.
*
@ -206,65 +184,37 @@ abstract class MultiForm extends Form {
* Perhaps it would be best dealt with on a separate class?
*/
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'])) {
switch($urlType) {
case 'Hash':
$this->session = $this->getSessionRecordByHash($_GET['MultiFormSessionID']);
break;
case 'ID':
$this->session = $this->getSessionRecordByID($_GET['MultiFormSessionID']);
break;
default:
user_error('MultiForm::init(): Please define a correct value for $url_type on ' . $this->class, E_USER_ERROR);
break;
}
$this->session = $this->getSessionRecord($_GET['MultiFormSessionID']);
}
// If there was no session found, create a new one instead
if(!$this->session) {
// @TODO fix the fact that you can continually refresh on the first step creating new records
$this->session = new MultiFormSession();
$this->session->write();
}
// We have to have an ID, before we can hash the ID of the session. @TODO a better way here?
if($urlType == 'Hash') {
// Create encrypted identification to the session instance if it doesn't exist
if(!$this->session->Hash) {
$this->session->Hash = sha1($this->session->ID . '-' . microtime());
$this->session->write(); // I guess we could hash something else than the ID, this is a bit ugly...
}
$this->session->write();
}
}
/**
* Return an instance of MultiFormSession from the database by a single
* record with the hash passed into this method.
* Return an instance of MultiFormSession.
*
* @param string $hash The Hash field of the record to retrieve
* @param string $hash The unique, encrypted hash to identify the session
* @return MultiFormSession
*/
function getSessionRecordByHash($hash) {
function getSessionRecord($hash) {
$SQL_hash = Convert::raw2sql($hash);
return DataObject::get_one('MultiFormSession', "Hash = '$SQL_hash' AND IsComplete = 0");
}
/**
* Return an instance of MultiFormSession from the database by it's ID.
*
* @param int|string $id The ID of the record to retrieve
* @return MultiFormSession
*/
function getSessionRecordByID($id) {
$SQL_id = (int)$id;
return DataObject::get_one('MultiFormSession', "MultiFormSession.ID = {$SQL_id} AND IsComplete = 0");
}
/**
* Build a FieldSet of the FormAction fields used for the given step.
* Build a FieldSet of the FormAction fields for the given step.
*
* If the current step is the final step, we push in a submit button, which
* calls the action {@link finish()} to finalise the submission. Otherwise,
@ -317,6 +267,8 @@ abstract class MultiForm extends Form {
* subclass template) to see if one is available to render the form with. If
* any of those don't exist, look for a default Form template to render
* with instead.
*
* @return SSViewer object to render the template with
*/
function forTemplate() {
return $this->renderWith(array(
@ -444,15 +396,15 @@ abstract class MultiForm extends Form {
/**
* Add the MultiFormSessionID variable to the URL on form submission.
* We use this to determine what session the multiform is currently using.
* This is a means to persist the session, by adding it's identification
* to the URL, which ties it back to this MultiForm instance.
*
* @return string
*/
function FormAction() {
$urlMethod = $this->stat('url_type');
$action = parent::FormAction();
$action .= (strpos($action, '?')) ? '&' : '?';
$action .= "MultiFormSessionID={$this->session->$urlMethod}";
$action .= "MultiFormSessionID={$this->session->Hash}";
return $action;
}
@ -472,7 +424,7 @@ abstract class MultiForm extends Form {
'ID' => $firstStep->ID,
'ClassName' => $firstStep->class,
'Title' => $firstStep->title ? $firstStep->title : $firstStep->class,
'SessionID' => ($this->stat('url_type') == 'ID') ? $this->session->ID : $this->session->Hash,
'SessionID' => $this->session->Hash,
'LinkingMode' => ($firstStep->ID == $this->getCurrentStep()->ID) ? 'current' : 'link'
);
$stepsFound->push(new ArrayData($templateData));
@ -501,7 +453,7 @@ abstract class MultiForm extends Form {
'ID' => $nextStep->ID,
'ClassName' => $nextStep->class,
'Title' => $nextStep->title ? $nextStep->title : $nextStep->class,
'SessionID' => ($this->stat('url_type') == 'ID') ? $this->session->ID : $this->session->Hash,
'SessionID' => $this->session->Hash,
'LinkingMode' => ($nextStep->ID == $this->getCurrentStep()->ID) ? 'current' : 'link'
);
} else {

44
code/MultiFormSession.php
View File

@ -56,55 +56,13 @@ class MultiFormSession extends DataObject {
// delete dependent form steps and relation
$steps = $this->FormSteps();
if($steps) foreach($steps as $step) {
$steps->remove($step);
$steps->remove($step); // @TODO not sure if this is required (does delete() remove the relation too?)
$step->delete();
}
parent::onBeforeDelete();
}
/**
* Get all the temporary objects, and set them as temporary, writing
* them back to the database.
*/
public function markTemporaryDataObjectsFinished() {
$temporaryObjects = $this->getTemporaryDataObjects();
if($temporaryObjects) foreach($temporaryObjects as $obj) {
$obj->MultiFormIsTemporary = 0;
$obj->write();
}
}
/**
* Get all classes that implement the MultiFormObjectDecorator,
* find the records for each and merge them together into a
* DataObjectSet.
*
* @return DataObjectSet
*/
public function getTemporaryDataObjects() {
$implementors = Object::get_implementors_for_extension('MultiFormObjectDecorator');
$objs = new DataObjectSet();
if($implementors) foreach($implementors as $implementorClass) {
$objs->merge(
DataObject::get($implementorClass, "MultiFormSessionID = {$this->ID}")
);
}
return $objs;
}
/**
* Remove all related data, either serialized
* in $Data property, or in related stored
* DataObjects.
*
* @return boolean
*/
public function purgeStoredData() {
die('MultiFormSession->purgeStoredData(): Not implemented yet');
}
}
?>

21
code/MultiFormStep.php
View File

@ -1,7 +1,7 @@
<?php
/**
* MultiFormStep controls the behaviour of a single form step in the multi-form
* MultiFormStep controls the behaviour of a single form step in the MultiForm
* process. All form steps are required to be subclasses of this class, as it
* encapsulates the functionality required for the step to be aware of itself
* in the process by knowing what it's next step is, and if applicable, it's previous
@ -122,15 +122,10 @@ class MultiFormStep extends DataObject {
* has already been saved to the database
* for the current {@link MultiFormSession}).
*
* @TODO We check for the Hash field directly on session
* to determine how to identify the session. This isn't
* a very good way of doing it!
*
* @return string Relative URL to this step
*/
public function Link() {
$id = $this->Session()->Hash ? $this->Session()->Hash : $this->Session()->ID;
return Controller::curr()->Link() . '?MultiFormSessionID=' . $id;
return Controller::curr()->Link() . '?MultiFormSessionID=' . $this->Session()->Hash;
}
/**
@ -140,12 +135,8 @@ class MultiFormStep extends DataObject {
*
* You need to overload this method onto your own
* step if you require custom loading. An example
* would be selective loading specific fields, or
* filtering out fields that don't require loading.
*
* This method is called on {@link MultiForm} inside
* the init() method, to load the data by default (if
* it exists, back into the form).
* would be selective loading specific fields, leaving
* others that are not required.
*
* @return array
*/
@ -243,6 +234,8 @@ class MultiFormStep extends DataObject {
/**
* Retrieves the previous step class record from the database.
*
* This will only return a record if you've previously been on the step.
*
* @return MultiFormStep subclass
*/
public function getPreviousStepFromDatabase() {
@ -291,7 +284,7 @@ class MultiFormStep extends DataObject {
* @return boolean
*/
public function isCurrentStep() {
if($this->class == $this->Session()->CurrentStep()->class) return true;
return ($this->class == $this->Session()->CurrentStep()->class) ? true : false;
}
}