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

Documented loadData() and saveData()

Browse Source
This commit is contained in:
Sean Harvey 2008-04-21 08:54:48 +00:00
parent aa6236b495
commit ec747bc6c6
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
code/MultiFormStep.php
View File

@ -108,8 +108,19 @@ class MultiFormStep extends DataObject {
/**
* Unserialize stored session data and return it.
* This should be called when the form is constructed,
* so the fields can be loaded with the values.
* This is used for loading data previously saved
* in session back into the form.
*
* 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).
*
* @return array
*/
public function loadData() {
return unserialize($this->Data);
@ -118,7 +129,10 @@ class MultiFormStep extends DataObject {
/**
* Save the data for this step into session, serializing it first.
*
* @param array $data The processed data from save() on MultiForm
* To selectively save fields, instead of it all, this
* method would need to be overloaded on your step class.
*
* @param array $data The processed data from save() on {@link MultiForm}
*/
public function saveData($data) {
$this->Data = serialize($data);
@ -198,7 +212,7 @@ class MultiFormStep extends DataObject {
}
/**
* Retrieves the previous step record from the database.
* Retrieves the previous step class record from the database.
*
* @return MultiFormStep subclass
*/