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

Merge pull request #33 from kinglozzer/pulls/configure-get-var

Browse Source 
NEW session ID GET var can be renamed
This commit is contained in:
Will Rossiter 2015-02-04 09:29:47 +13:00
commit 77d6d60f45
3 changed files with 28 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
code/model/MultiForm.php
View File

@ -48,6 +48,11 @@ abstract class MultiForm extends Form {
'TotalStepCount' => 'Int', 'TotalStepCount' => 'Int',
'CompletedPercent' => 'Float' 'CompletedPercent' => 'Float'
); );
/**
* @var string
*/
private static $get_var = 'MultiFormSessionID';
/** /**
* These fields are ignored when saving the raw form data into session. * These fields are ignored when saving the raw form data into session.
@ -59,7 +64,6 @@ abstract class MultiForm extends Form {
public static $ignored_fields = array( public static $ignored_fields = array(
'url', 'url',
'executeForm', 'executeForm',
'MultiFormSessionID',
'SecurityID' 'SecurityID'
); );
@ -138,8 +142,10 @@ abstract class MultiForm extends Form {
// Give the fields, actions, and validation for the current step back to the parent Form class // Give the fields, actions, and validation for the current step back to the parent Form class
parent::__construct($controller, $name, $fields, $actions, $validator); parent::__construct($controller, $name, $fields, $actions, $validator);
$getVar = $this->config()->get_var;
// Set a hidden field in our form with an encrypted hash to identify this session. // 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)); $this->fields->push(new HiddenField($getVar, false, $this->session->Hash));
// If there is saved data for the current step, we load it into the form it here // If there is saved data for the current step, we load it into the form it here
//(CAUTION: loadData() MUST unserialize first!) //(CAUTION: loadData() MUST unserialize first!)
@ -149,6 +155,8 @@ abstract class MultiForm extends Form {
// Disable security token - we tie a form to a session ID instead // Disable security token - we tie a form to a session ID instead
$this->disableSecurityToken(); $this->disableSecurityToken();
self::$ignored_fields[] = $getVar;
} }
/** /**
@ -266,7 +274,7 @@ abstract class MultiForm extends Form {
*/ */
public function getCurrentSession() { public function getCurrentSession() {
if(!$this->currentSessionHash) { if(!$this->currentSessionHash) {
$this->currentSessionHash = $this->controller->request->getVar('MultiFormSessionID'); $this->currentSessionHash = $this->controller->request->getVar($this->config()->get_var);
if(!$this->currentSessionHash) { if(!$this->currentSessionHash) {
return false; return false;
@ -528,7 +536,7 @@ abstract class MultiForm extends Form {
function FormAction() { function FormAction() {
$action = parent::FormAction(); $action = parent::FormAction();
$action .= (strpos($action, '?')) ? '&' : '?'; $action .= (strpos($action, '?')) ? '&' : '?';
$action .= "MultiFormSessionID={$this->session->Hash}"; $action .= "{$this->config()->get_var}={$this->session->Hash}";
return $action; return $action;
} }

3
code/model/MultiFormStep.php
View File

@ -126,7 +126,8 @@ class MultiFormStep extends DataObject {
* @return string Relative URL to this step * @return string Relative URL to this step
*/ */
public function Link() { public function Link() {
return Controller::join_links($this->form->getDisplayLink(), "?MultiFormSessionID={$this->Session()->Hash}"); $form = $this->form;
return Controller::join_links($form->getDisplayLink(), "?{$form->config()->get_var}={$this->Session()->Hash}");
} }
/** /**

14
tests/MultiFormTest.php
View File

@ -78,6 +78,20 @@ class MultiFormTest extends FunctionalTest {
// A new session is generated, even though we made up the identifier // A new session is generated, even though we made up the identifier
$this->assertInstanceOf('MultiFormSession', $this->form->session); $this->assertInstanceOf('MultiFormSession', $this->form->session);
} }
function testCustomGetVar() {
Config::nest();
Config::inst()->update('MultiForm', 'get_var', 'SuperSessionID');
$form = $this->controller->Form();
$this->assertContains('SuperSessionID', $form::$ignored_fields, "GET var wasn't added to ignored fields");
$this->assertContains('SuperSessionID', $form->FormAction(), "Form action doesn't contain correct session
ID parameter");
$this->assertContains('SuperSessionID', $form->getCurrentStep()->Link(), "Form step doesn't contain correct
session ID parameter");
Config::unnest();
}
} }