[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 and 403]

   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 group override created event.
  19   *
  20   * @package    mod_quiz
  21   * @copyright  2014 Mark Nelson <markn@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_quiz\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The mod_quiz group override created event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - int quizid: the id of the quiz.
  36   *      - int groupid: the id of the group.
  37   * }
  38   *
  39   * @package    mod_quiz
  40   * @since      Moodle 2.7
  41   * @copyright  2014 Mark Nelson <markn@moodle.com>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class group_override_created extends \core\event\base {
  45  
  46      /**
  47       * Init method.
  48       */
  49      protected function init() {
  50          $this->data['objecttable'] = 'quiz_overrides';
  51          $this->data['crud'] = 'c';
  52          $this->data['edulevel'] = self::LEVEL_TEACHING;
  53      }
  54  
  55      /**
  56       * Returns localised general event name.
  57       *
  58       * @return string
  59       */
  60      public static function get_name() {
  61          return get_string('eventoverridecreated', 'mod_quiz');
  62      }
  63  
  64      /**
  65       * Returns description of what happened.
  66       *
  67       * @return string
  68       */
  69      public function get_description() {
  70          return "The user with id '$this->userid' created the override with id '$this->objectid' for the quiz with " .
  71              "course module id '$this->contextinstanceid' for the group with id '{$this->other['groupid']}'.";
  72      }
  73  
  74      /**
  75       * Returns relevant URL.
  76       *
  77       * @return \moodle_url
  78       */
  79      public function get_url() {
  80          return new \moodle_url('/mod/quiz/overrideedit.php', array('id' => $this->objectid));
  81      }
  82  
  83      /**
  84       * Custom validation.
  85       *
  86       * @throws \coding_exception
  87       * @return void
  88       */
  89      protected function validate_data() {
  90          parent::validate_data();
  91  
  92          if (!isset($this->other['quizid'])) {
  93              throw new \coding_exception('The \'quizid\' value must be set in other.');
  94          }
  95  
  96          if (!isset($this->other['groupid'])) {
  97              throw new \coding_exception('The \'groupid\' value must be set in other.');
  98          }
  99      }
 100  
 101      public static function get_objectid_mapping() {
 102          return array('db' => 'quiz_overrides', 'restore' => 'quiz_override');
 103      }
 104  
 105      public static function get_other_mapping() {
 106          $othermapped = array();
 107          $othermapped['quizid'] = array('db' => 'quiz', 'restore' => 'quiz');
 108          $othermapped['groupid'] = array('db' => 'groups', 'restore' => 'group');
 109  
 110          return $othermapped;
 111      }
 112  }