[Summary view]

Differences Between: [Versions 39 and 402] [Versions 39 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 updated 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 updated event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - string shortname: (optional) shortname of course.
  36   *      - string fullname: (optional) fullname of course.
  37   *      - string updatedfields: (optional) array of course table fields edited in this event, ['fieldname' => 'newvalue']
  38   * }
  39   *
  40   * @package    core
  41   * @since      Moodle 2.6
  42   * @copyright  2013 Mark Nelson <markn@moodle.com>
  43   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  44   */
  45  class course_updated extends base {
  46  
  47      /** @var array The legacy log data. */
  48      private $legacylogdata;
  49  
  50      /**
  51       * Initialise the event data.
  52       */
  53      protected function init() {
  54          $this->data['objecttable'] = 'course';
  55          $this->data['crud'] = 'u';
  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('eventcourseupdated');
  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' updated the course with id '$this->courseid'.";
  75      }
  76  
  77      /**
  78       * Returns relevant URL.
  79       *
  80       * @return \moodle_url
  81       */
  82      public function get_url() {
  83          return new \moodle_url('/course/edit.php', array('id' => $this->objectid));
  84      }
  85  
  86      /**
  87       * Returns the name of the legacy event.
  88       *
  89       * @return string legacy event name
  90       */
  91      public static function get_legacy_eventname() {
  92          return 'course_updated';
  93      }
  94  
  95      /**
  96       * Returns the legacy event data.
  97       *
  98       * @return \stdClass the course that was updated
  99       */
 100      protected function get_legacy_eventdata() {
 101          return $this->get_record_snapshot('course', $this->objectid);
 102      }
 103  
 104      /**
 105       * Set the legacy data used for add_to_log().
 106       *
 107       * @param array $logdata
 108       */
 109      public function set_legacy_logdata($logdata) {
 110          $this->legacylogdata = $logdata;
 111      }
 112  
 113      /**
 114       * Return legacy data for add_to_log().
 115       *
 116       * @return array
 117       */
 118      protected function get_legacy_logdata() {
 119          return $this->legacylogdata;
 120      }
 121  
 122      public static function get_objectid_mapping() {
 123          return array('db' => 'course', 'restore' => 'course');
 124      }
 125  
 126      public static function get_other_mapping() {
 127          // Nothing to map.
 128          return false;
 129      }
 130  }