[Summary view]

Differences Between: [Versions 400 and 402] [Versions 400 and 403]

   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   * The mod_quiz user override deleted event.
  19   *
  20   * @package    mod_quiz
  21   * @copyright  2014 Mark Nelson <markn@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace mod_quiz\event;
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_quiz user override deleted event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - int quizid: the id of the quiz.
  35   * }
  36   *
  37   * @package    mod_quiz
  38   * @since      Moodle 2.7
  39   * @copyright  2014 Mark Nelson <markn@moodle.com>
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class user_override_deleted extends \core\event\base {
  43  
  44      /**
  45       * Init method.
  46       */
  47      protected function init() {
  48          $this->data['objecttable'] = 'quiz_overrides';
  49          $this->data['crud'] = 'd';
  50          $this->data['edulevel'] = self::LEVEL_TEACHING;
  51      }
  52  
  53      /**
  54       * Returns localised general event name.
  55       *
  56       * @return string
  57       */
  58      public static function get_name() {
  59          return get_string('eventoverridedeleted', 'mod_quiz');
  60      }
  61  
  62      /**
  63       * Returns description of what happened.
  64       *
  65       * @return string
  66       */
  67      public function get_description() {
  68          return "The user with id '$this->userid' deleted the override with id '$this->objectid' for the quiz with " .
  69              "course module id '$this->contextinstanceid' for the user with id '{$this->relateduserid}'.";
  70      }
  71  
  72      /**
  73       * Returns relevant URL.
  74       *
  75       * @return \moodle_url
  76       */
  77      public function get_url() {
  78          return new \moodle_url('/mod/quiz/overrides.php', array('cmid' => $this->contextinstanceid));
  79      }
  80  
  81      /**
  82       * Return the legacy event log data.
  83       *
  84       * @return array
  85       */
  86      protected function get_legacy_logdata() {
  87          return array($this->courseid, 'quiz', 'delete override', 'overrides.php?cmid=' . $this->contextinstanceid,
  88              $this->other['quizid'], $this->contextinstanceid);
  89      }
  90  
  91      /**
  92       * Custom validation.
  93       *
  94       * @throws \coding_exception
  95       * @return void
  96       */
  97      protected function validate_data() {
  98          parent::validate_data();
  99  
 100          if (!isset($this->relateduserid)) {
 101              throw new \coding_exception('The \'relateduserid\' must be set.');
 102          }
 103  
 104          if (!isset($this->other['quizid'])) {
 105              throw new \coding_exception('The \'quizid\' value must be set in other.');
 106          }
 107      }
 108  
 109      public static function get_objectid_mapping() {
 110          return array('db' => 'quiz_overrides', 'restore' => 'quiz_override');
 111      }
 112  
 113      public static function get_other_mapping() {
 114          $othermapped = array();
 115          $othermapped['quizid'] = array('db' => 'quiz', 'restore' => 'quiz');
 116  
 117          return $othermapped;
 118      }
 119  }