[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 section shuffle 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 section shuffle updated event class.
  29   *
  30   * @property-read array $other {
  31   *      Extra information about event.
  32   *
  33   *      - int quizid: the id of the quiz.
  34   *      - bool shuffle: shuffle option value.
  35   *      - int firstslotnumber: slot number of the slot which is right after the section break.
  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 section_shuffle_updated extends \core\event\base {
  43      protected function init() {
  44          $this->data['objecttable'] = 'quiz_sections';
  45          $this->data['crud'] = 'u';
  46          $this->data['edulevel'] = self::LEVEL_TEACHING;
  47      }
  48  
  49      public static function get_name() {
  50          return get_string('eventsectionshuffleupdated', 'mod_quiz');
  51      }
  52  
  53      public function get_description() {
  54          return "The user with id '$this->userid' updated the section with id '{$this->objectid}' " .
  55              "before the slot number '{$this->other['firstslotnumber']}' " .
  56              "belonging to the quiz with course module id '$this->contextinstanceid'. " .
  57              "Its shuffle option was set to '{$this->other['shuffle']}'.";
  58      }
  59  
  60      public function get_url() {
  61          return new \moodle_url('/mod/quiz/edit.php', [
  62              'cmid' => $this->contextinstanceid
  63          ]);
  64      }
  65  
  66      protected function validate_data() {
  67          parent::validate_data();
  68  
  69          if (!isset($this->objectid)) {
  70              throw new \coding_exception('The \'objectid\' value must be set.');
  71          }
  72  
  73          if (!isset($this->contextinstanceid)) {
  74              throw new \coding_exception('The \'contextinstanceid\' value must be set.');
  75          }
  76  
  77          if (!isset($this->other['quizid'])) {
  78              throw new \coding_exception('The \'quizid\' value must be set in other.');
  79          }
  80  
  81          if (!isset($this->other['firstslotnumber'])) {
  82              throw new \coding_exception('The \'firstslotnumber\' value must be set in other.');
  83          }
  84  
  85          if (!isset($this->other['shuffle'])) {
  86              throw new \coding_exception('The \'shuffle\' value must be set in other.');
  87          }
  88  
  89      }
  90  
  91      public static function get_objectid_mapping() {
  92          return ['db' => 'quiz_sections', 'restore' => 'quiz_section'];
  93      }
  94  
  95      public static function get_other_mapping() {
  96          $othermapped = [];
  97          $othermapped['quizid'] = ['db' => 'quiz', 'restore' => 'quiz'];
  98  
  99          return $othermapped;
 100      }
 101  }