lib/classes/event/course_category_deleted.php

   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  * }
  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_category_deleted extends base {
  44
  45     /**
  46      * The course category class used for legacy reasons.
  47      */
  48     private $coursecat;
  49
  50     /**
  51      * Initialise the event data.
  52      */
  53     protected function init() {
  54         $this->data['objecttable'] = 'course_categories';
  55         $this->data['crud'] = 'd';
  56         $this->data['edulevel'] = self::LEVEL_OTHER;
  57     }
  58
  59     /**
  60      * Returns localised general event name.
  61      *
  62      * @return string
  63      */
  64     public static function get_name() {
  65         return get_string('eventcoursecategorydeleted');
  66     }
  67
  68     /**
  69      * Returns non-localised description of what happened.
  70      *
  71      * @return string
  72      */
  73     public function get_description() {
  74         return "The user with id '$this->userid' deleted the course category with id '$this->objectid'.";
  75     }
  76
  77     /**
  78      * Returns the name of the legacy event.
  79      *
  80      * @return string legacy event name
  81      */
  82     public static function get_legacy_eventname() {
  83         return 'course_category_deleted';
  84     }
  85
  86     /**
  87      * Returns the legacy event data.
  88      *
  89      * @return \coursecat the category that was deleted
  90      */
  91     protected function get_legacy_eventdata() {
  92         return $this->coursecat;
  93     }
  94
  95     /**
  96      * Set custom data of the event - deleted coursecat.
  97      *
  98      * @param \coursecat $coursecat
  99      */
 100     public function set_coursecat(\coursecat $coursecat) {
 101         $this->coursecat = $coursecat;
 102     }
 103
 104     /**
 105      * Returns deleted coursecat for event observers.
 106      *
 107      * @throws \coding_exception
 108      * @return \coursecat
 109      */
 110     public function get_coursecat() {
 111         if ($this->is_restored()) {
 112             throw new \coding_exception('Function get_coursecat() can not be used on restored events.');
 113         }
 114         return $this->coursecat;
 115     }
 116
 117     /**
 118      * Return legacy data for add_to_log().
 119      *
 120      * @return array
 121      */
 122     protected function get_legacy_logdata() {
 123         return array(SITEID, 'category', 'delete', 'index.php', $this->other['name'] . '(ID ' . $this->objectid . ')');
 124     }
 125
 126     /**
 127      * Custom validation.
 128      *
 129      * @throws \coding_exception
 130      * @return void
 131      */
 132     protected function validate_data() {
 133         parent::validate_data();
 134
 135         if (!isset($this->other['name'])) {
 136             throw new \coding_exception('The \'name\' value must be set in other.');
 137         }
 138     }
 139 }