2013-05-25 09:04:59 +02:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/**
|
2015-11-02 01:38:50 +01:00
|
|
|
* Serializes one or more {@link MultiFormStep}s into
|
2013-05-25 09:04:59 +02:00
|
|
|
* a database object.
|
2015-11-02 01:38:50 +01:00
|
|
|
*
|
2013-05-25 09:04:59 +02:00
|
|
|
* MultiFormSession also stores the current step, so that
|
|
|
|
* the {@link MultiForm} and {@link MultiFormStep} classes
|
|
|
|
* know what the current step is.
|
2015-11-02 01:38:50 +01:00
|
|
|
*
|
2013-05-25 09:04:59 +02:00
|
|
|
* @package multiform
|
|
|
|
*/
|
|
|
|
class MultiFormSession extends DataObject {
|
2015-11-02 01:38:50 +01:00
|
|
|
|
2014-08-13 00:11:02 +02:00
|
|
|
private static $db = array(
|
2013-05-25 09:04:59 +02:00
|
|
|
'Hash' => 'Varchar(40)', // cryptographic hash identification to this session
|
|
|
|
'IsComplete' => 'Boolean' // flag to determine if this session is marked completed
|
|
|
|
);
|
2015-11-02 01:38:50 +01:00
|
|
|
|
2014-08-13 00:11:02 +02:00
|
|
|
private static $has_one = array(
|
2013-05-25 09:04:59 +02:00
|
|
|
'Submitter' => 'Member',
|
|
|
|
'CurrentStep' => 'MultiFormStep'
|
|
|
|
);
|
|
|
|
|
2014-08-13 00:11:02 +02:00
|
|
|
private static $has_many = array(
|
2013-05-25 09:04:59 +02:00
|
|
|
'FormSteps' => 'MultiFormStep'
|
|
|
|
);
|
2015-11-02 01:38:50 +01:00
|
|
|
|
2013-05-25 09:04:59 +02:00
|
|
|
/**
|
|
|
|
* Mark this session as completed.
|
2015-11-02 01:38:50 +01:00
|
|
|
*
|
2013-05-25 09:04:59 +02:00
|
|
|
* This sets the flag "IsComplete" to true,
|
|
|
|
* and writes the session back.
|
|
|
|
*/
|
|
|
|
public function markCompleted() {
|
|
|
|
$this->IsComplete = 1;
|
|
|
|
$this->write();
|
|
|
|
}
|
2015-11-02 01:38:50 +01:00
|
|
|
|
2013-05-25 09:04:59 +02:00
|
|
|
/**
|
|
|
|
* These actions are performed when write() is called on this object.
|
|
|
|
*/
|
|
|
|
public function onBeforeWrite() {
|
|
|
|
// save submitter if a Member is logged in
|
|
|
|
$currentMember = Member::currentUser();
|
|
|
|
if(!$this->SubmitterID && $currentMember) $this->SubmitterID = $currentMember->ID;
|
2015-11-02 01:38:50 +01:00
|
|
|
|
2013-05-25 09:04:59 +02:00
|
|
|
parent::onBeforeWrite();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* These actions are performed when delete() is called on this object.
|
|
|
|
*/
|
|
|
|
public function onBeforeDelete() {
|
|
|
|
// delete dependent form steps and relation
|
|
|
|
$steps = $this->FormSteps();
|
|
|
|
if($steps) foreach($steps as $step) {
|
|
|
|
if($step && $step->exists()) {
|
|
|
|
$steps->remove($step);
|
|
|
|
$step->delete();
|
|
|
|
$step->destroy();
|
|
|
|
}
|
|
|
|
}
|
2015-11-02 01:38:50 +01:00
|
|
|
|
2013-05-25 09:04:59 +02:00
|
|
|
parent::onBeforeDelete();
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|