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