[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   * Course section updated event.
  19   *
  20   * @package    core
  21   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Course section updated event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - int sectionnum: section number.
  36   * }
  37   *
  38   * @package    core
  39   * @since      Moodle 2.6
  40   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class course_section_updated extends base {
  44  
  45      /**
  46       * Init method.
  47       *
  48       * @return void
  49       */
  50      protected function init() {
  51          $this->data['objecttable'] = 'course_sections';
  52          $this->data['crud'] = 'u';
  53          $this->data['edulevel'] = self::LEVEL_TEACHING;
  54      }
  55  
  56      /**
  57       * Return localised event name.
  58       *
  59       * @return string
  60       */
  61      public static function get_name() {
  62          return get_string('eventcoursesectionupdated');
  63      }
  64  
  65      /**
  66       * Returns non-localised event description with id's for admin use only.
  67       *
  68       * @return string
  69       */
  70      public function get_description() {
  71          return "The user with id '$this->userid' updated section number '{$this->other['sectionnum']}' for the " .
  72              "course with id '$this->courseid'";
  73      }
  74  
  75      /**
  76       * Get URL related to the action.
  77       *
  78       * @return \moodle_url
  79       */
  80      public function get_url() {
  81          return new \moodle_url('/course/editsection.php', array('id' => $this->objectid));
  82      }
  83  
  84      /**
  85       * Return legacy data for add_to_log().
  86       *
  87       * @return array
  88       */
  89      protected function get_legacy_logdata() {
  90          $sectiondata = $this->get_record_snapshot('course_sections', $this->objectid);
  91          return array($this->courseid, 'course', 'editsection', 'editsection.php?id=' . $this->objectid, $sectiondata->section);
  92      }
  93  
  94      /**
  95       * Custom validation.
  96       *
  97       * @throws \coding_exception
  98       * @return void
  99       */
 100      protected function validate_data() {
 101          parent::validate_data();
 102  
 103          if (!isset($this->other['sectionnum'])) {
 104              throw new \coding_exception('The \'sectionnum\' value must be set in other.');
 105          }
 106      }
 107  
 108      public static function get_objectid_mapping() {
 109          return array('db' => 'course_sections', 'restore' => 'course_section');
 110      }
 111  
 112      public static function get_other_mapping() {
 113          // Nothing to map.
 114          return false;
 115      }
 116  }