[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 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 created 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 created event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - string fullname: fullname of course.
  36   *      - string shortname: (optional) shortname of course.
  37   * }
  38   *
  39   * @package    core
  40   * @since      Moodle 2.6
  41   * @copyright  2013 Mark Nelson <markn@moodle.com>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class course_created extends base {
  45  
  46      /**
  47       * Initialise the event data.
  48       */
  49      protected function init() {
  50          $this->data['objecttable'] = 'course';
  51          $this->data['crud'] = 'c';
  52          $this->data['edulevel'] = self::LEVEL_TEACHING;
  53      }
  54  
  55      /**
  56       * Returns localised general event name.
  57       *
  58       * @return string
  59       */
  60      public static function get_name() {
  61          return get_string('eventcoursecreated');
  62      }
  63  
  64      /**
  65       * Returns non-localised description of what happened.
  66       *
  67       * @return string
  68       */
  69      public function get_description() {
  70          return "The user with id '$this->userid' created the course with id '$this->courseid'.";
  71      }
  72  
  73      /**
  74       * Returns relevant URL.
  75       *
  76       * @return \moodle_url
  77       */
  78      public function get_url() {
  79          return new \moodle_url('/course/view.php', array('id' => $this->objectid));
  80      }
  81  
  82      /**
  83       * Returns the name of the legacy event.
  84       *
  85       * @return string legacy event name
  86       */
  87      public static function get_legacy_eventname() {
  88          return 'course_created';
  89      }
  90  
  91      /**
  92       * Returns the legacy event data.
  93       *
  94       * @return \stdClass the course that was created
  95       */
  96      protected function get_legacy_eventdata() {
  97          return $this->get_record_snapshot('course', $this->objectid);
  98      }
  99  
 100      /**
 101       * Return legacy data for add_to_log().
 102       *
 103       * @return array
 104       */
 105      protected function get_legacy_logdata() {
 106          return array(SITEID, 'course', 'new', 'view.php?id=' . $this->objectid, $this->other['fullname'] . ' (ID ' . $this->objectid . ')');
 107      }
 108  
 109      /**
 110       * Custom validation.
 111       *
 112       * @throws \coding_exception
 113       * @return void
 114       */
 115      protected function validate_data() {
 116          parent::validate_data();
 117  
 118          if (!isset($this->other['fullname'])) {
 119              throw new \coding_exception('The \'fullname\' value must be set in other.');
 120          }
 121      }
 122  
 123      public static function get_objectid_mapping() {
 124          return array('db' => 'course', 'restore' => 'course');
 125      }
 126  
 127      public static function get_other_mapping() {
 128          // Nothing to map.
 129          return false;
 130      }
 131  }