[Summary view]

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]

   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 updated 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 enrolment is updated.
  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_updated 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'] = 'u';
  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('eventuserenrolmentupdated', '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' updated the enrolment for the user with id '$this->relateduserid' using the " .
  69              "enrolment method '{$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('/enrol/editenrolment.php', array('ue' => $this->objectid));
  79      }
  80  
  81      /**
  82       * Custom validation.
  83       *
  84       * @throws \coding_exception
  85       * @return void
  86       */
  87      protected function validate_data() {
  88          parent::validate_data();
  89          if (!isset($this->other['enrol'])) {
  90              throw new \coding_exception('The \'enrol\' value must be set in other.');
  91          }
  92          if (!isset($this->relateduserid)) {
  93              throw new \coding_exception('The \'relateduserid\' must be set.');
  94          }
  95      }
  96  
  97      public static function get_objectid_mapping() {
  98          // User enrolments table is not mappable.
  99          return array('db' => 'user_enrolments', 'restore' => base::NOT_MAPPED);
 100      }
 101  
 102      public static function get_other_mapping() {
 103          return false;
 104      }
 105  }