2010-03-22 11:49:04 +01:00
|
|
|
<?php
|
2008-04-18 00:03:51 +02:00
|
|
|
|
2017-09-08 07:09:16 +02:00
|
|
|
namespace SilverStripe\MultiForm\Tasks;
|
2017-09-07 01:32:55 +02:00
|
|
|
|
|
|
|
use SilverStripe\Dev\BuildTask;
|
2017-09-08 07:09:16 +02:00
|
|
|
use SilverStripe\MultiForm\Models\MultiFormSession;
|
2017-09-07 01:32:55 +02:00
|
|
|
use SilverStripe\ORM\DataList;
|
|
|
|
use SilverStripe\ORM\DataObject;
|
|
|
|
|
2008-04-18 00:03:51 +02:00
|
|
|
/**
|
|
|
|
* Task to clean out all {@link MultiFormSession} objects from the database.
|
2015-11-02 01:38:50 +01:00
|
|
|
*
|
2008-04-18 00:03:51 +02:00
|
|
|
* Setup Instructions:
|
|
|
|
* You need to create an automated task for your system (cronjobs on unix)
|
2013-10-15 05:12:45 +02:00
|
|
|
* which triggers the process() method through cli-script.php:
|
|
|
|
* `php framework/cli-script.php MultiFormPurgeTask`
|
|
|
|
* or
|
|
|
|
* `framework/sake MultiFormPurgeTask`
|
2015-11-02 01:38:50 +01:00
|
|
|
*
|
2008-04-18 00:03:51 +02:00
|
|
|
* @package multiform
|
|
|
|
*/
|
2017-09-06 22:47:35 +02:00
|
|
|
class MultiFormPurgeTask extends BuildTask
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* Days after which sessions expire and
|
|
|
|
* are automatically deleted.
|
|
|
|
*
|
|
|
|
* @var int
|
|
|
|
*/
|
|
|
|
public static $session_expiry_days = 7;
|
2008-07-02 02:39:40 +02:00
|
|
|
|
2017-09-06 22:47:35 +02:00
|
|
|
/**
|
|
|
|
* Run this cron task.
|
|
|
|
*
|
|
|
|
* Go through all MultiFormSession records that
|
|
|
|
* are older than the days specified in $session_expiry_days
|
|
|
|
* and delete them.
|
|
|
|
*/
|
|
|
|
public function run($request)
|
|
|
|
{
|
|
|
|
$sessions = $this->getExpiredSessions();
|
|
|
|
$delCount = 0;
|
|
|
|
if ($sessions) {
|
|
|
|
foreach ($sessions as $session) {
|
|
|
|
$session->delete();
|
|
|
|
$delCount++;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
echo $delCount . ' session records deleted that were older than ' . self::$session_expiry_days . ' days.';
|
|
|
|
}
|
2015-11-02 01:38:50 +01:00
|
|
|
|
2017-09-06 22:47:35 +02:00
|
|
|
/**
|
|
|
|
* Return all MultiFormSession database records that are older than
|
|
|
|
* the days specified in $session_expiry_days
|
|
|
|
*
|
2017-09-07 01:32:55 +02:00
|
|
|
* @return DataList
|
2017-09-06 22:47:35 +02:00
|
|
|
*/
|
|
|
|
protected function getExpiredSessions()
|
|
|
|
{
|
|
|
|
return DataObject::get(
|
2017-09-07 01:32:55 +02:00
|
|
|
MultiFormSession::class,
|
2017-09-06 22:47:35 +02:00
|
|
|
"DATEDIFF(NOW(), \"MultiFormSession\".\"Created\") > " . self::$session_expiry_days
|
|
|
|
);
|
|
|
|
}
|
2010-03-22 11:49:04 +01:00
|
|
|
}
|