[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 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 deleted event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - string fullname: fullname of course.
  36   *      - string shortname: (optional) shortname of course.
  37   *      - string idnumber: (optional) id number of course.
  38   * }
  39   *
  40   * @package    core
  41   * @since      Moodle 2.6
  42   * @copyright  2013 Mark Nelson <markn@moodle.com>
  43   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  44   */
  45  class course_deleted extends base {
  46  
  47      /**
  48       * Initialise the event data.
  49       */
  50      protected function init() {
  51          $this->data['objecttable'] = 'course';
  52          $this->data['crud'] = 'd';
  53          $this->data['edulevel'] = self::LEVEL_TEACHING;
  54      }
  55  
  56      /**
  57       * Returns localised general event name.
  58       *
  59       * @return string
  60       */
  61      public static function get_name() {
  62          return get_string('eventcoursedeleted');
  63      }
  64  
  65      /**
  66       * Returns non-localised description of what happened.
  67       *
  68       * @return string
  69       */
  70      public function get_description() {
  71          return "The user with id '$this->userid' deleted the course with id '$this->courseid'.";
  72      }
  73  
  74      /**
  75       * Returns the name of the legacy event.
  76       *
  77       * @return string legacy event name
  78       */
  79      public static function get_legacy_eventname() {
  80          return 'course_deleted';
  81      }
  82  
  83      /**
  84       * Returns the legacy event data.
  85       *
  86       * @return \stdClass the course that was deleted
  87       */
  88      protected function get_legacy_eventdata() {
  89          $course = $this->get_record_snapshot('course', $this->objectid);
  90          $course->context = $this->context;
  91          $course->timemodified = $this->data['timecreated'];
  92          return $course;
  93      }
  94  
  95      /**
  96       * Return legacy data for add_to_log().
  97       *
  98       * @return array
  99       */
 100      protected function get_legacy_logdata() {
 101          return array(SITEID, 'course', 'delete', 'view.php?id=' . $this->objectid, $this->other['fullname']  . '(ID ' . $this->objectid . ')');
 102      }
 103  
 104      /**
 105       * Custom validation.
 106       *
 107       * @throws \coding_exception
 108       * @return void
 109       */
 110      protected function validate_data() {
 111          parent::validate_data();
 112  
 113          if (!isset($this->other['fullname'])) {
 114              throw new \coding_exception('The \'fullname\' value must be set in other.');
 115          }
 116      }
 117  
 118      public static function get_objectid_mapping() {
 119          return array('db' => 'course', 'restore' => 'course');
 120      }
 121  
 122      public static function get_other_mapping() {
 123          // Nothing to map.
 124          return false;
 125      }
 126  }