[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   * Role assigned event.
  19   *
  20   * @package    core
  21   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Role assigned event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - string shortname: shortname of role.
  36   *      - string description: (optional) role description.
  37   *      - string archetype: (optional) role type.
  38   * }
  39   *
  40   * @package    core
  41   * @since      Moodle 2.6
  42   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  43   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  44   */
  45  class role_deleted extends base {
  46      /**
  47       * Initialise event parameters.
  48       */
  49      protected function init() {
  50          $this->data['objecttable'] = 'role';
  51          $this->data['crud'] = 'd';
  52          $this->data['edulevel'] = self::LEVEL_OTHER;
  53      }
  54  
  55      /**
  56       * Returns localised event name.
  57       *
  58       * @return string
  59       */
  60      public static function get_name() {
  61          return get_string('eventroledeleted', 'role');
  62      }
  63  
  64      /**
  65       * Returns non-localised event description with id's for admin use only.
  66       *
  67       * @return string
  68       */
  69      public function get_description() {
  70          return "The user with id '$this->userid' deleted the role with id '$this->objectid'.";
  71      }
  72  
  73      /**
  74       * Returns relevant URL.
  75       *
  76       * @return \moodle_url
  77       */
  78      public function get_url() {
  79          return new \moodle_url('/admin/roles/manage.php');
  80      }
  81  
  82      /**
  83       * Returns array of parameters to be passed to legacy add_to_log() function.
  84       *
  85       * @return array
  86       */
  87      protected function get_legacy_logdata() {
  88          return array(SITEID, 'role', 'delete', 'admin/roles/manage.php?action=delete&roleid=' . $this->objectid,
  89              $this->other['shortname'], '');
  90      }
  91  
  92      /**
  93       * Custom validation.
  94       *
  95       * @throws \coding_exception
  96       * @return void
  97       */
  98      protected function validate_data() {
  99          parent::validate_data();
 100  
 101          if (!isset($this->other['shortname'])) {
 102              throw new \coding_exception('The \'shortname\' value must be set in other.');
 103          }
 104      }
 105  
 106      public static function get_objectid_mapping() {
 107          return array('db' => 'role', 'restore' => 'role');
 108      }
 109  
 110      public static function get_other_mapping() {
 111          // Nothing to map.
 112          return false;
 113      }
 114  }