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