lib/classes/event/grouping_updated.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 grouping updated 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 grouping updated 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 grouping_updated extends \core\event\base {
  36
  37     /**
  38      * Legacy data.
  39      *
  40      * @var mixed
  41      */
  42     protected $legacydata;
  43
  44     /**
  45      * Returns description of what happened.
  46      *
  47      * @return string
  48      */
  49     public function get_description() {
  50         return "User {$this->userid} updated the grouping {$this->objectid}.";
  51     }
  52
  53     /**
  54      * Legacy event data if get_legacy_eventname() is not empty.
  55      *
  56      * @return stdClass
  57      */
  58     protected function get_legacy_eventdata() {
  59         return $this->legacydata;
  60     }
  61
  62     /**
  63      * Return the legacy event name.
  64      *
  65      * @return string
  66      */
  67     public static function get_legacy_eventname() {
  68         return 'groups_grouping_updated';
  69     }
  70
  71     /**
  72      * Return localised event name.
  73      *
  74      * @return string
  75      */
  76     public static function get_name() {
  77         return get_string('event_grouping_updated', 'group');
  78     }
  79
  80     /**
  81      * Get URL related to the action
  82      *
  83      * @return \moodle_url
  84      */
  85     public function get_url() {
  86         return new \moodle_url('/group/groupings/index.php', array('id' => $this->courseid));
  87     }
  88
  89     /**
  90      * Init method.
  91      *
  92      * @return void
  93      */
  94     protected function init() {
  95         $this->data['crud'] = 'u';
  96         $this->data['level'] = self::LEVEL_OTHER;
  97         $this->data['objecttable'] = 'groupings';
  98     }
  99
 100     /**
 101      * Set legacy data.
 102      *
 103      * @param mixed $legacydata.
 104      * @return void
 105      */
 106     public function set_legacy_eventdata($legacydata) {
 107         $this->legacydata = $legacydata;
 108     }
 109
 110 }