lib/classes/task/messaging_cleanup_task.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * A scheduled task.
  19  *
  20  * @package    core
  21  * @copyright  2013 onwards Martin Dougiamas  http://dougiamas.com
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24 namespace core\task;
  25
  26 /**
  27  * Simple task to delete old messaging records.
  28  */
  29 class messaging_cleanup_task extends scheduled_task {
  30
  31     /**
  32      * Get a descriptive name for this task (shown to admins).
  33      *
  34      * @return string
  35      */
  36     public function get_name() {
  37         return get_string('taskmessagingcleanup', 'admin');
  38     }
  39
  40     /**
  41      * Do the job.
  42      * Throw exceptions on errors (the job will be retried).
  43      */
  44     public function execute() {
  45         global $CFG, $DB;
  46
  47         $timenow = time();
  48
  49         // Cleanup messaging.
  50         if (!empty($CFG->messagingdeletereadnotificationsdelay)) {
  51             $notificationdeletetime = $timenow - $CFG->messagingdeletereadnotificationsdelay;
  52             $params = array('notificationdeletetime' => $notificationdeletetime);
  53             $DB->delete_records_select('notifications', 'timeread < :notificationdeletetime', $params);
  54         }
  55
  56     }
  57
  58 }