lib/classes/task/task_log_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  * Task to cleanup task logs.
  19  *
  20  * @package    core
  21  * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24 namespace core\task;
  25
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 /**
  29  * A task to cleanup log entries for tasks.
  30  *
  31  * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  32  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33  */
  34 class task_log_cleanup_task extends scheduled_task {
  35
  36     /**
  37      * Get a descriptive name for this task (shown to admins).
  38      *
  39      * @return string
  40      */
  41     public function get_name() {
  42         return get_string('tasklogcleanup', 'admin');
  43     }
  44
  45     /**
  46      * Perform the cleanup task.
  47      */
  48     public function execute() {
  49         if (\core\task\database_logger::class == \core\task\logmanager::get_logger_classname()) {
  50             \core\task\database_logger::cleanup();
  51         }
  52     }
  53 }