[Summary view] [Print] [Text view]

   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 restored 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 restored event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - string type: restore type, activity, course or section.
  36   *      - int target: where restored (new/existing/current/adding/deleting).
  37   *      - int mode: execution mode.
  38   *      - string operation: what operation are we performing?
  39   *      - boolean samesite: true if restoring to same site.
  40   * }
  41   *
  42   * @package    core
  43   * @since      Moodle 2.6
  44   * @copyright  2013 Mark Nelson <markn@moodle.com>
  45   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  46   */
  47  class course_restored extends base {
  48  
  49      /**
  50       * Initialise the event data.
  51       */
  52      protected function init() {
  53          $this->data['objecttable'] = 'course';
  54          $this->data['crud'] = 'c';
  55          $this->data['edulevel'] = self::LEVEL_TEACHING;
  56      }
  57  
  58      /**
  59       * Returns localised general event name.
  60       *
  61       * @return string
  62       */
  63      public static function get_name() {
  64          return get_string('eventcourserestored');
  65      }
  66  
  67      /**
  68       * Returns non-localised description of what happened.
  69       *
  70       * @return string
  71       */
  72      public function get_description() {
  73          return "The user with id '$this->userid' restored the course with id '$this->courseid'.";
  74      }
  75  
  76      /**
  77       * Returns relevant URL.
  78       *
  79       * @return \moodle_url
  80       */
  81      public function get_url() {
  82          return new \moodle_url('/course/view.php', array('id' => $this->objectid));
  83      }
  84  
  85      /**
  86       * Returns the name of the legacy event.
  87       *
  88       * @return string legacy event name
  89       */
  90      public static function get_legacy_eventname() {
  91          return 'course_restored';
  92      }
  93  
  94      /**
  95       * Returns the legacy event data.
  96       *
  97       * @return \stdClass the legacy event data
  98       */
  99      protected function get_legacy_eventdata() {
 100          return (object) array(
 101              'courseid' => $this->objectid,
 102              'userid' => $this->userid,
 103              'type' => $this->other['type'],
 104              'target' => $this->other['target'],
 105              'mode' => $this->other['mode'],
 106              'operation' => $this->other['operation'],
 107              'samesite' => $this->other['samesite'],
 108          );
 109      }
 110  
 111      /**
 112       * Custom validation.
 113       *
 114       * @throws \coding_exception
 115       * @return void
 116       */
 117      protected function validate_data() {
 118          parent::validate_data();
 119  
 120          if (!isset($this->other['type'])) {
 121              throw new \coding_exception('The \'type\' value must be set in other.');
 122          }
 123  
 124          if (!isset($this->other['target'])) {
 125              throw new \coding_exception('The \'target\' value must be set in other.');
 126          }
 127  
 128          if (!isset($this->other['mode'])) {
 129              throw new \coding_exception('The \'mode\' value must be set in other.');
 130          }
 131  
 132          if (!isset($this->other['operation'])) {
 133              throw new \coding_exception('The \'operation\' value must be set in other.');
 134          }
 135  
 136          if (!isset($this->other['samesite'])) {
 137              throw new \coding_exception('The \'samesite\' value must be set in other.');
 138          }
 139      }
 140  
 141      public static function get_objectid_mapping() {
 142          return array('db' => 'course', 'restore' => 'course');
 143      }
 144  
 145      public static function get_other_mapping() {
 146          // No need to map anything.
 147          return false;
 148      }
 149  }