[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 removed 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 removed event class.
  30   *
  31   * @package    core
  32   * @since      Moodle 2.6
  33   * @copyright  2013 Frédéric Massart
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class group_member_removed extends base {
  37  
  38      /**
  39       * Returns description of what happened.
  40       *
  41       * @return string
  42       */
  43      public function get_description() {
  44          return "The user with id '$this->userid' removed the user with id '$this->relateduserid' from the group with " .
  45              "id '$this->objectid'.";
  46      }
  47  
  48      /**
  49       * Legacy event data if get_legacy_eventname() is not empty.
  50       *
  51       * @return \stdClass
  52       */
  53      protected function get_legacy_eventdata() {
  54          $eventdata = new \stdClass();
  55          $eventdata->groupid = $this->objectid;
  56          $eventdata->userid  = $this->relateduserid;
  57          return $eventdata;
  58      }
  59  
  60      /**
  61       * Return the legacy event name.
  62       *
  63       * @return string
  64       */
  65      public static function get_legacy_eventname() {
  66          return 'groups_member_removed';
  67      }
  68  
  69      /**
  70       * Return localised event name.
  71       *
  72       * @return string
  73       */
  74      public static function get_name() {
  75          return get_string('eventgroupmemberremoved', 'group');
  76      }
  77  
  78      /**
  79       * Get URL related to the action
  80       *
  81       * @return \moodle_url
  82       */
  83      public function get_url() {
  84          return new \moodle_url('/group/members.php', array('group' => $this->objectid));
  85      }
  86  
  87      /**
  88       * Init method.
  89       *
  90       * @return void
  91       */
  92      protected function init() {
  93          $this->data['crud'] = 'd';
  94          $this->data['edulevel'] = self::LEVEL_OTHER;
  95          $this->data['objecttable'] = 'groups';
  96      }
  97  
  98      /**
  99       * Custom validation.
 100       *
 101       * @throws \coding_exception
 102       * @return void
 103       */
 104      protected function validate_data() {
 105          parent::validate_data();
 106  
 107          if (!isset($this->relateduserid)) {
 108              throw new \coding_exception('The \'relateduserid\' must be set.');
 109          }
 110      }
 111  
 112      public static function get_objectid_mapping() {
 113          return array('db' => 'groups', 'restore' => 'group');
 114      }
 115  
 116  }