[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   * The mod_quiz slots mark updated event.
  19   *
  20   * @package    mod_quiz
  21   * @copyright  2021 The Open University
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_quiz\event;
  26  
  27  /**
  28   * The mod_quiz slot mark updated event class.
  29   *
  30   * @property-read array $other {
  31   *      Extra information about event.
  32   *
  33   *      - int quizid: the id of the quiz.
  34   *      - int previousmaxmark: the previous max mark value.
  35   *      - int newmaxmark: the new max mark value.
  36   * }
  37   *
  38   * @package    mod_quiz
  39   * @copyright  2021 The Open University
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class slot_mark_updated extends \core\event\base {
  43      protected function init() {
  44          $this->data['objecttable'] = 'quiz_slots';
  45          $this->data['crud'] = 'u';
  46          $this->data['edulevel'] = self::LEVEL_TEACHING;
  47      }
  48  
  49      public static function get_name() {
  50          return get_string('eventslotmarkupdated', 'mod_quiz');
  51      }
  52  
  53      public function get_description() {
  54          return "The user with id '$this->userid' updated the slot with id '{$this->objectid}' " .
  55              "belonging to the quiz with course module id '$this->contextinstanceid'. " .
  56              "Its max mark was changed from '{$this->other['previousmaxmark']}' to '{$this->other['newmaxmark']}'.";
  57      }
  58  
  59      public function get_url() {
  60          return new \moodle_url('/mod/quiz/edit.php', [
  61              'cmid' => $this->contextinstanceid
  62          ]);
  63      }
  64  
  65      protected function validate_data() {
  66          parent::validate_data();
  67  
  68          if (!isset($this->objectid)) {
  69              throw new \coding_exception('The \'objectid\' value must be set.');
  70          }
  71  
  72          if (!isset($this->contextinstanceid)) {
  73              throw new \coding_exception('The \'contextinstanceid\' value must be set.');
  74          }
  75  
  76          if (!isset($this->other['quizid'])) {
  77              throw new \coding_exception('The \'quizid\' value must be set in other.');
  78          }
  79  
  80          if (!isset($this->other['previousmaxmark'])) {
  81              throw new \coding_exception('The \'previousmaxmark\' value must be set in other.');
  82          }
  83  
  84          if (!isset($this->other['newmaxmark'])) {
  85              throw new \coding_exception('The \'newmaxmark\' value must be set in other.');
  86          }
  87      }
  88  
  89      public static function get_objectid_mapping() {
  90          return ['db' => 'quiz_slots', 'restore' => 'quiz_question_instance'];
  91      }
  92  
  93      public static function get_other_mapping() {
  94          $othermapped = [];
  95          $othermapped['quizid'] = ['db' => 'quiz', 'restore' => 'quiz'];
  96  
  97          return $othermapped;
  98      }
  99  }