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