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 use core\task\database_logger;
  29 use core\task\logmanager;
  30
  31 /**
  32  * A task to cleanup log entries for tasks.
  33  *
  34  * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36  */
  37 class task_log_cleanup_task extends scheduled_task {
  38
  39     /**
  40      * Get a descriptive name for this task (shown to admins).
  41      *
  42      * @return string
  43      */
  44     public function get_name() {
  45         return get_string('tasklogcleanup', 'admin');
  46     }
  47
  48     /**
  49      * Perform the cleanup task.
  50      */
  51     public function execute() {
  52         $logger = logmanager::get_logger_classname();
  53         if (is_a($logger, database_logger::class, true)) {
  54             $logger::cleanup();
  55         }
  56     }
  57 }