[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 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 content deleted event.
  19   *
  20   * @package    core
  21   * @copyright  2013 Mark Nelson <markn@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 content deleted event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - array options: list of options which were skipped while deleting course content.
  36   * }
  37   *
  38   * @package    core
  39   * @since      Moodle 2.6
  40   * @copyright  2013 Mark Nelson <markn@moodle.com>
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class course_content_deleted extends base {
  44  
  45      /**
  46       * Initialise the event data.
  47       */
  48      protected function init() {
  49          $this->data['objecttable'] = 'course';
  50          $this->data['crud'] = 'd';
  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('eventcoursecontentdeleted');
  61      }
  62  
  63      /**
  64       * Returns non-localised description of what happened.
  65       *
  66       * @return string
  67       */
  68      public function get_description() {
  69          return "The user with id '$this->userid' deleted content from course with id '$this->courseid'.";
  70      }
  71  
  72      /**
  73       * Returns the name of the legacy event.
  74       *
  75       * @return string legacy event name
  76       */
  77      public static function get_legacy_eventname() {
  78          return 'course_content_removed';
  79      }
  80  
  81      /**
  82       * Returns the legacy event data.
  83       *
  84       * @return \stdClass the course the content was deleted from
  85       */
  86      protected function get_legacy_eventdata() {
  87          $course = $this->get_record_snapshot('course', $this->objectid);
  88          $course->context = $this->context;
  89          $course->options = $this->other['options'];
  90  
  91          return $course;
  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['options'])) {
 104              throw new \coding_exception('The \'options\' value must be set in other.');
 105          }
 106      }
 107  
 108      public static function get_objectid_mapping() {
 109          return array('db' => 'course', 'restore' => 'course');
 110      }
 111  
 112      public static function get_other_mapping() {
 113          return false;
 114      }
 115  }