[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   * Event to be triggered when a new course module is deleted.
  19   *
  20   * @package    core
  21   * @copyright  2013 Ankit Agarwal
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  23   */
  24  
  25  namespace core\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * Class course_module_deleted
  30   *
  31   * Class for event to be triggered when a course module is deleted.
  32   *
  33   * @property-read array $other {
  34   *      Extra information about event.
  35   *
  36   *      - string modulename: name of module deleted.
  37   *      - string instanceid: id of module instance.
  38   * }
  39   *
  40   * @package    core
  41   * @since      Moodle 2.6
  42   * @copyright  2013 Ankit Agarwal
  43   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  44   */
  45  class course_module_deleted extends base {
  46  
  47      /**
  48       * Set basic properties for the event.
  49       */
  50      protected function init() {
  51          $this->data['objecttable'] = 'course_modules';
  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('eventcoursemoduledeleted', 'core');
  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' deleted the '{$this->other['modulename']}' activity with " .
  72              "course module id '$this->contextinstanceid'.";
  73      }
  74  
  75      /**
  76       * Legacy event name.
  77       *
  78       * @return string legacy event name
  79       */
  80      public static function get_legacy_eventname() {
  81          return 'mod_deleted';
  82      }
  83  
  84      /**
  85       * Legacy event data.
  86       *
  87       * @return \stdClass
  88       */
  89      protected function get_legacy_eventdata() {
  90          $eventdata = new \stdClass();
  91          $eventdata->modulename = $this->other['modulename'];
  92          $eventdata->cmid       = $this->objectid;
  93          $eventdata->courseid   = $this->courseid;
  94          $eventdata->userid     = $this->userid;
  95          return $eventdata;
  96      }
  97  
  98      /**
  99       * replace add_to_log() statement.
 100       *
 101       * @return array of parameters to be passed to legacy add_to_log() function.
 102       */
 103      protected function get_legacy_logdata() {
 104          return array ($this->courseid, "course", "delete mod", "view.php?id=$this->courseid",
 105                  $this->other['modulename'] . " " . $this->other['instanceid'], $this->objectid);
 106      }
 107  
 108      /**
 109       * custom validations
 110       *
 111       * Throw \coding_exception notice in case of any problems.
 112       */
 113      protected function validate_data() {
 114          parent::validate_data();
 115          if (!isset($this->other['modulename'])) {
 116              throw new \coding_exception('The \'modulename\' value must be set in other.');
 117          }
 118          if (!isset($this->other['instanceid'])) {
 119              throw new \coding_exception('The \'instanceid\' value must be set in other.');
 120          }
 121      }
 122  
 123      public static function get_objectid_mapping() {
 124          return array('db' => 'course_modules', 'restore' => 'course_module');
 125      }
 126  
 127      public static function get_other_mapping() {
 128          $othermapped = array();
 129          $othermapped['instanceid'] = base::NOT_MAPPED;
 130  
 131          return $othermapped;
 132      }
 133  }
 134