[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   * Scheduled task to delete expired context instances once they are approved for deletion.
  19   *
  20   * @package    tool_dataprivacy
  21   * @copyright  2018 David Monllao
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace tool_dataprivacy\task;
  26  
  27  use coding_exception;
  28  use core\task\scheduled_task;
  29  use tool_dataprivacy\api;
  30  
  31  defined('MOODLE_INTERNAL') || die();
  32  
  33  require_once($CFG->dirroot . '/' . $CFG->admin . '/tool/dataprivacy/lib.php');
  34  
  35  /**
  36   * Scheduled task to delete expired context instances once they are approved for deletion.
  37   *
  38   * @package     tool_dataprivacy
  39   * @copyright   2018 David Monllao
  40   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class delete_expired_contexts extends scheduled_task {
  43  
  44      /**
  45       * Returns the task name.
  46       *
  47       * @return string
  48       */
  49      public function get_name() {
  50          return get_string('deleteexpiredcontextstask', 'tool_dataprivacy');
  51      }
  52  
  53      /**
  54       * Run the task to delete context instances based on their retention periods.
  55       */
  56      public function execute() {
  57          $manager = new \tool_dataprivacy\expired_contexts_manager(new \text_progress_trace());
  58          list($courses, $users) = $manager->process_approved_deletions();
  59          mtrace("Processed deletions for {$courses} course contexts, and {$users} user contexts as expired");
  60      }
  61  }