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