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