[Summary view]

   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  
  25  namespace core\task;
  26  
  27  /**
  28   * Simple task to delete old context records.
  29   */
  30  class context_cleanup_task extends scheduled_task {
  31  
  32      /**
  33       * Get a descriptive name for this task (shown to admins).
  34       *
  35       * @return string
  36       */
  37      public function get_name() {
  38          return get_string('taskcontextcleanup', 'admin');
  39      }
  40  
  41      /**
  42       * Do the job.
  43       * Throw exceptions on errors (the job will be retried).
  44       */
  45      public function execute() {
  46          // Context maintenance stuff.
  47          \context_helper::cleanup_instances();
  48          mtrace(' Cleaned up context instances');
  49          \context_helper::build_all_paths(false);
  50          // If you suspect that the context paths are somehow corrupt
  51          // replace the line below with: context_helper::build_all_paths(true).
  52      }
  53  
  54  }