[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 deleted 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 unenrolled from a course.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - string enrol: name of enrolment instance.
  35   *      - array userenrolment: user_enrolment record.
  36   * }
  37   *
  38   * @package    core
  39   * @since      Moodle 2.6
  40   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class user_enrolment_deleted extends base {
  44  
  45      /**
  46       * Initialise required event data properties.
  47       */
  48      protected function init() {
  49          $this->data['objecttable'] = 'user_enrolments';
  50          $this->data['crud'] = 'd';
  51          $this->data['edulevel'] = self::LEVEL_OTHER;
  52      }
  53  
  54      /**
  55       * Returns localised event name.
  56       *
  57       * @return string
  58       */
  59      public static function get_name() {
  60          return get_string('eventuserenrolmentdeleted', 'core_enrol');
  61      }
  62  
  63      /**
  64       * Returns non-localised event description with id's for admin use only.
  65       *
  66       * @return string
  67       */
  68      public function get_description() {
  69          return "The user with id '$this->userid' unenrolled the user with id '$this->relateduserid' using the enrolment method " .
  70              "'{$this->other['enrol']}' from 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('/user/index.php', array('id' => $this->courseid));
  80      }
  81  
  82      /**
  83       * Return name of the legacy event, which is replaced by this event.
  84       *
  85       * @return string legacy event name
  86       */
  87      public static function get_legacy_eventname() {
  88          return 'user_unenrolled';
  89      }
  90  
  91      /**
  92       * Return user_unenrolled legacy event data.
  93       *
  94       * @return \stdClass
  95       */
  96      protected function get_legacy_eventdata() {
  97          return (object)$this->other['userenrolment'];
  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($this->courseid, 'course', 'unenrol', '../enrol/users.php?id=' . $this->courseid, $this->courseid);
 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          if (!isset($this->other['userenrolment'])) {
 118              throw new \coding_exception('The \'userenrolment\' value must be set in other.');
 119          }
 120          if (!isset($this->other['enrol'])) {
 121              throw new \coding_exception('The \'enrol\' value must be set in other.');
 122          }
 123          if (!isset($this->relateduserid)) {
 124              throw new \coding_exception('The \'relateduserid\' must be set.');
 125          }
 126      }
 127  
 128      public static function get_objectid_mapping() {
 129          // User enrolments table is not mappable.
 130          return array('db' => 'user_enrolments', 'restore' => base::NOT_MAPPED);
 131      }
 132  
 133      public static function get_other_mapping() {
 134          return false;
 135      }
 136  }