silverstripe-multiform/src/Models/MultiFormSession.php

82 lines
2.0 KiB
PHP
Raw Normal View History

<?php
namespace SilverStripe\MultiForm\Models;
use SilverStripe\ORM\DataObject;
use SilverStripe\Security\Security;
/**
2015-11-02 01:38:50 +01:00
* Serializes one or more {@link MultiFormStep}s into
* a database object.
2015-11-02 01:38:50 +01: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
*
* @package multiform
*/
class MultiFormSession extends DataObject
{
private static $db = [
'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
private static $has_one = [
'Submitter' => 'Member',
'CurrentStep' => 'MultiFormStep'
];
private static $has_many = [
'FormSteps' => 'MultiFormStep'
];
private static $table_name = 'MultiFormSession';
2015-11-02 01:38:50 +01:00
/**
* Mark this session as completed.
*
* 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
/**
* These actions are performed when write() is called on this object.
*/
public function onBeforeWrite()
{
// save submitter if a Member is logged in
$currentMember = Security::getCurrentUser();
if (!$this->SubmitterID && $currentMember->ID) {
$this->SubmitterID = $currentMember->ID;
}
2015-11-02 01:38:50 +01: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();
}
}
}
parent::onBeforeDelete();
}
}