[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   * Group member added event.
  19   *
  20   * @package    core
  21   * @copyright  2013 Frédéric Massart
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * Group member added event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - string component: name of component
  35   *      - int itemid: id of item.
  36   * }
  37   *
  38   * @package    core
  39   * @since      Moodle 2.6
  40   * @copyright  2013 Frédéric Massart
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class group_member_added extends base {
  44  
  45      /**
  46       * Returns description of what happened.
  47       *
  48       * @return string
  49       */
  50      public function get_description() {
  51          return "The user with id '$this->userid' added the user with id '$this->relateduserid' to the group with " .
  52              "id '$this->objectid'.";
  53      }
  54  
  55      /**
  56       * Legacy event data if get_legacy_eventname() is not empty.
  57       *
  58       * @return \stdClass
  59       */
  60      protected function get_legacy_eventdata() {
  61          $eventdata = new \stdClass();
  62          $eventdata->groupid = $this->objectid;
  63          $eventdata->userid  = $this->relateduserid;
  64          $eventdata->component = $this->other['component'];
  65          $eventdata->itemid = $this->other['itemid'];
  66          return $eventdata;
  67      }
  68  
  69      /**
  70       * Return the legacy event name.
  71       *
  72       * @return string
  73       */
  74      public static function get_legacy_eventname() {
  75          return 'groups_member_added';
  76      }
  77  
  78      /**
  79       * Return localised event name.
  80       *
  81       * @return string
  82       */
  83      public static function get_name() {
  84          return get_string('eventgroupmemberadded', 'group');
  85      }
  86  
  87      /**
  88       * Get URL related to the action
  89       *
  90       * @return \moodle_url
  91       */
  92      public function get_url() {
  93          return new \moodle_url('/group/members.php', array('group' => $this->objectid));
  94      }
  95  
  96      /**
  97       * Init method.
  98       *
  99       * @return void
 100       */
 101      protected function init() {
 102          $this->data['crud'] = 'c';
 103          $this->data['edulevel'] = self::LEVEL_OTHER;
 104          $this->data['objecttable'] = 'groups';
 105      }
 106  
 107      /**
 108       * Custom validation.
 109       *
 110       * @throws \coding_exception
 111       * @return void
 112       */
 113      protected function validate_data() {
 114          parent::validate_data();
 115  
 116          if (!isset($this->relateduserid)) {
 117              throw new \coding_exception('The \'relateduserid\' must be set.');
 118          }
 119  
 120          if (!isset($this->other['component'])) {
 121              throw new \coding_exception('The \'component\' value must be set in other, even if empty.');
 122          }
 123  
 124          if (!isset($this->other['itemid'])) {
 125              throw new \coding_exception('The \'itemid\' value must be set in other, even if empty.');
 126          }
 127      }
 128  
 129      public static function get_objectid_mapping() {
 130          return array('db' => 'groups', 'restore' => 'group');
 131      }
 132  
 133      public static function get_other_mapping() {
 134          $othermapped = array();
 135          $othermapped['itemid'] = base::NOT_MAPPED;
 136  
 137          return $othermapped;
 138      }
 139  }