lib/classes/event/dashboards_reset.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  * Dashboards reset event.
  19  *
  20  * @package    core
  21  * @copyright  2016 Stephen Bourget
  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  * Dashboards reset event class.
  30  *
  31  * Class for event to be triggered when all user dashboards are reset.
  32  *
  33  * @property-read array $other {
  34  *      Extra information about event.
  35  *
  36  *      - string private: Either MY_PAGE_PRIVATE or MY_PAGE_PUBLIC.
  37  *      - string pagetype: Either my-index or user-profile.
  38  * }
  39  *
  40  * @package    core
  41  * @since      Moodle 3.2
  42  * @copyright  2016 Stephen Bourget
  43  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  44  */
  45 class dashboards_reset extends base {
  46
  47     /**
  48      * Init method.
  49      *
  50      * @return void
  51      */
  52     protected function init() {
  53         $this->data['crud'] = 'u';
  54         $this->data['edulevel'] = self::LEVEL_OTHER;
  55     }
  56
  57     /**
  58      * Returns description of what happened.
  59      *
  60      * @return string
  61      */
  62     public function get_description() {
  63         return "The user with id '$this->userid' has reset all user dashboards";
  64     }
  65
  66     /**
  67      * Return localised event name.
  68      *
  69      * @return string
  70      */
  71     public static function get_name() {
  72         return get_string('eventdashboardsreset', 'core');
  73     }
  74
  75     /**
  76      * Get URL related to the action.
  77      *
  78      * @return \moodle_url|null
  79      */
  80     public function get_url() {
  81         return new \moodle_url('/my/indexsys.php');
  82     }
  83 }