[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   * 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       * Return localised event name.
  57       *
  58       * @return string
  59       */
  60      public static function get_name() {
  61          return get_string('eventgroupmemberadded', 'group');
  62      }
  63  
  64      /**
  65       * Get URL related to the action
  66       *
  67       * @return \moodle_url
  68       */
  69      public function get_url() {
  70          return new \moodle_url('/group/members.php', array('group' => $this->objectid));
  71      }
  72  
  73      /**
  74       * Init method.
  75       *
  76       * @return void
  77       */
  78      protected function init() {
  79          $this->data['crud'] = 'c';
  80          $this->data['edulevel'] = self::LEVEL_OTHER;
  81          $this->data['objecttable'] = 'groups';
  82      }
  83  
  84      /**
  85       * Custom validation.
  86       *
  87       * @throws \coding_exception
  88       * @return void
  89       */
  90      protected function validate_data() {
  91          parent::validate_data();
  92  
  93          if (!isset($this->relateduserid)) {
  94              throw new \coding_exception('The \'relateduserid\' must be set.');
  95          }
  96  
  97          if (!isset($this->other['component'])) {
  98              throw new \coding_exception('The \'component\' value must be set in other, even if empty.');
  99          }
 100  
 101          if (!isset($this->other['itemid'])) {
 102              throw new \coding_exception('The \'itemid\' value must be set in other, even if empty.');
 103          }
 104      }
 105  
 106      public static function get_objectid_mapping() {
 107          return array('db' => 'groups', 'restore' => 'group');
 108      }
 109  
 110      public static function get_other_mapping() {
 111          $othermapped = array();
 112          $othermapped['itemid'] = base::NOT_MAPPED;
 113  
 114          return $othermapped;
 115      }
 116  }