lib/classes/event/group_member_removed.php

   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  * core_group member removed event.
  19  *
  20  * @package    core_group
  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  * core_group member removed event class.
  30  *
  31  * @package    core_group
  32  * @copyright  2013 Frédéric Massart
  33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34  */
  35 class group_member_removed extends \core\event\base {
  36
  37     /**
  38      * Returns description of what happened.
  39      *
  40      * @return string
  41      */
  42     public function get_description() {
  43         return "User {$this->userid} removed user {$this->relateduserid} from group {$this->objectid}.";
  44     }
  45
  46     /**
  47      * Legacy event data if get_legacy_eventname() is not empty.
  48      *
  49      * @return stdClass
  50      */
  51     protected function get_legacy_eventdata() {
  52         $eventdata = new \stdClass();
  53         $eventdata->groupid = $this->objectid;
  54         $eventdata->userid  = $this->relateduserid;
  55         return $eventdata;
  56     }
  57
  58     /**
  59      * Return the legacy event name.
  60      *
  61      * @return string
  62      */
  63     public static function get_legacy_eventname() {
  64         return 'groups_member_removed';
  65     }
  66
  67     /**
  68      * Return localised event name.
  69      *
  70      * @return string
  71      */
  72     public static function get_name() {
  73         return get_string('event_group_member_removed', 'group');
  74     }
  75
  76     /**
  77      * Get URL related to the action
  78      *
  79      * @return \moodle_url
  80      */
  81     public function get_url() {
  82         return new \moodle_url('/group/index.php', array('id' => $this->courseid));
  83     }
  84
  85     /**
  86      * Init method.
  87      *
  88      * @return void
  89      */
  90     protected function init() {
  91         $this->data['crud'] = 'd';
  92         $this->data['level'] = self::LEVEL_OTHER;
  93         $this->data['objecttable'] = 'groups';
  94     }
  95
  96 }