[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   * User enrolment created event.
  19   *
  20   * @package    core
  21   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace core\event;
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * Event class for when user is enrolled in a course.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - string enrol: name of enrolment instance.
  35   * }
  36   *
  37   * @package    core
  38   * @since      Moodle 2.6
  39   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class user_enrolment_created extends base {
  43  
  44      /**
  45       * Initialise required event data properties.
  46       */
  47      protected function init() {
  48          $this->data['objecttable'] = 'user_enrolments';
  49          $this->data['crud'] = 'c';
  50          $this->data['edulevel'] = self::LEVEL_OTHER;
  51      }
  52  
  53      /**
  54       * Returns localised event name.
  55       *
  56       * @return string
  57       */
  58      public static function get_name() {
  59          return get_string('eventuserenrolmentcreated', 'core_enrol');
  60      }
  61  
  62      /**
  63       * Returns non-localised event description with id's for admin use only.
  64       *
  65       * @return string
  66       */
  67      public function get_description() {
  68          return "The user with id '$this->userid' enrolled the user with id '$this->relateduserid' using the enrolment method " .
  69              "'{$this->other['enrol']}' in the course with id '$this->courseid'.";
  70      }
  71  
  72      /**
  73       * Returns relevant URL.
  74       *
  75       * @return \moodle_url
  76       */
  77      public function get_url() {
  78          return new \moodle_url('/user/index.php', array('id' => $this->courseid));
  79      }
  80  
  81      /**
  82       * Return name of the legacy event, which is replaced by this event.
  83       *
  84       * @return string legacy event name
  85       */
  86      public static function get_legacy_eventname() {
  87          return 'user_enrolled';
  88      }
  89  
  90      /**
  91       * Return user_enrolled legacy event data.
  92       *
  93       * @return \stdClass
  94       */
  95      protected function get_legacy_eventdata() {
  96          $legacyeventdata = $this->get_record_snapshot('user_enrolments', $this->objectid);
  97          $legacyeventdata->enrol = $this->other['enrol'];
  98          $legacyeventdata->courseid = $this->courseid;
  99          return $legacyeventdata;
 100      }
 101  
 102      /**
 103       * Return legacy data for add_to_log().
 104       *
 105       * @return array
 106       */
 107      protected function get_legacy_logdata() {
 108          return array($this->courseid, 'course', 'enrol', '../enrol/users.php?id=' . $this->courseid, $this->courseid);
 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->relateduserid)) {
 121              throw new \coding_exception('The \'relateduserid\' must be set.');
 122          }
 123  
 124          if (!isset($this->other['enrol'])) {
 125              throw new \coding_exception('The \'enrol\' value must be set in other.');
 126          }
 127      }
 128  
 129      public static function get_objectid_mapping() {
 130          // User enrolments table is not mappable.
 131          return array('db' => 'user_enrolments', 'restore' => base::NOT_MAPPED);
 132      }
 133  
 134      public static function get_other_mapping() {
 135          return false;
 136      }
 137  }