[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   * Category 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   * Category deleted event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - string name: category name.
  36   *      - string contentmovedcategoryid: (optional) category id where content was moved on deletion
  37   * }
  38   *
  39   * @package    core
  40   * @since      Moodle 2.6
  41   * @copyright  2013 Mark Nelson <markn@moodle.com>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class course_category_deleted extends base {
  45  
  46      /**
  47       * The course category class used for legacy reasons.
  48       */
  49      private $coursecat;
  50  
  51      /**
  52       * Initialise the event data.
  53       */
  54      protected function init() {
  55          $this->data['objecttable'] = 'course_categories';
  56          $this->data['crud'] = 'd';
  57          $this->data['edulevel'] = self::LEVEL_OTHER;
  58      }
  59  
  60      /**
  61       * Returns localised general event name.
  62       *
  63       * @return string
  64       */
  65      public static function get_name() {
  66          return get_string('eventcoursecategorydeleted');
  67      }
  68  
  69      /**
  70       * Returns non-localised description of what happened.
  71       *
  72       * @return string
  73       */
  74      public function get_description() {
  75          $descr = "The user with id '$this->userid' deleted the course category with id '$this->objectid'.";
  76          if (!empty($this->other['contentmovedcategoryid'])) {
  77              $descr .= " Its content has been moved to category with id '{$this->other['contentmovedcategoryid']}'.";
  78          }
  79          return $descr;
  80      }
  81  
  82      /**
  83       * Returns the name of the legacy event.
  84       *
  85       * @return string legacy event name
  86       */
  87      public static function get_legacy_eventname() {
  88          return 'course_category_deleted';
  89      }
  90  
  91      /**
  92       * Returns the legacy event data.
  93       *
  94       * @return \core_course_category the category that was deleted
  95       */
  96      protected function get_legacy_eventdata() {
  97          return $this->coursecat;
  98      }
  99  
 100      /**
 101       * Set custom data of the event - deleted coursecat.
 102       *
 103       * @param \core_course_category $coursecat
 104       */
 105      public function set_coursecat(\core_course_category $coursecat) {
 106          $this->coursecat = $coursecat;
 107      }
 108  
 109      /**
 110       * Returns deleted coursecat for event observers.
 111       *
 112       * @throws \coding_exception
 113       * @return \core_course_category
 114       */
 115      public function get_coursecat() {
 116          if ($this->is_restored()) {
 117              throw new \coding_exception('Function get_coursecat() can not be used on restored events.');
 118          }
 119          return $this->coursecat;
 120      }
 121  
 122      /**
 123       * Return legacy data for add_to_log().
 124       *
 125       * @return array
 126       */
 127      protected function get_legacy_logdata() {
 128          return array(SITEID, 'category', 'delete', 'index.php', $this->other['name'] . '(ID ' . $this->objectid . ')');
 129      }
 130  
 131      /**
 132       * Custom validation.
 133       *
 134       * @throws \coding_exception
 135       * @return void
 136       */
 137      protected function validate_data() {
 138          parent::validate_data();
 139  
 140          if (!isset($this->other['name'])) {
 141              throw new \coding_exception('The \'name\' value must be set in other.');
 142          }
 143      }
 144  
 145      public static function get_objectid_mapping() {
 146          // Categories are not backed up, so no need to map them on restore.
 147          return array('db' => 'course_categories', 'restore' => base::NOT_MAPPED);
 148      }
 149  
 150      public static function get_other_mapping() {
 151          return false;
 152      }
 153  }