[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 quiz re-paginated 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 quiz re-paginated event class.
  29   *
  30   * @property-read array $other {
  31   *      Extra information about event.
  32   *
  33   *      - int slotsperpage: the slot number per page option.
  34   * }
  35   *
  36   * @package    mod_quiz
  37   * @copyright  2021 The Open University
  38   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39   */
  40  class quiz_repaginated extends \core\event\base {
  41      protected function init() {
  42          $this->data['objecttable'] = 'quiz';
  43          $this->data['crud'] = 'u';
  44          $this->data['edulevel'] = self::LEVEL_TEACHING;
  45      }
  46  
  47      public static function get_name() {
  48          return get_string('eventquizrepaginated', 'mod_quiz');
  49      }
  50  
  51      public function get_description() {
  52          return "The user with id '$this->userid' re-paginated the quiz with course module id '$this->contextinstanceid' " .
  53              " with the new option '{$this->other['slotsperpage']}' slot(s) per page.";
  54      }
  55  
  56      public function get_url() {
  57          return new \moodle_url('/mod/quiz/edit.php', [
  58              'cmid' => $this->contextinstanceid
  59          ]);
  60      }
  61  
  62      protected function validate_data() {
  63          parent::validate_data();
  64  
  65          if (!isset($this->objectid)) {
  66              throw new \coding_exception('The \'objectid\' value must be set.');
  67          }
  68  
  69          if (!isset($this->contextinstanceid)) {
  70              throw new \coding_exception('The \'contextinstanceid\' value must be set.');
  71          }
  72  
  73          if (!isset($this->other['slotsperpage'])) {
  74              throw new \coding_exception('The \'slotsperpage\' value must be set in other.');
  75          }
  76      }
  77  
  78      public static function get_objectid_mapping() {
  79          return ['db' => 'quiz', 'restore' => 'quiz'];
  80      }
  81  
  82      public static function get_other_mapping() {
  83          return [];
  84      }
  85  }