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