[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 updated event.
  19   *
  20   * @package    core
  21   * @since      Moodle 2.6
  22   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace core\event;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  debugging('core\\event\\role_capabilities_updated has been deprecated. Please use
  31          core\\event\\capability_assigned instead', DEBUG_DEVELOPER);
  32  
  33  /**
  34   * Role updated event class.
  35   *
  36   * @package    core
  37   * @since      Moodle 2.6
  38   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  39   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   */
  41  class role_capabilities_updated extends base {
  42      /** @var array Legacy log data */
  43      protected $legacylogdata = null;
  44  
  45      /**
  46       * Initialise event parameters.
  47       */
  48      protected function init() {
  49          $this->data['objecttable'] = 'role';
  50          $this->data['crud'] = 'u';
  51          $this->data['edulevel'] = self::LEVEL_OTHER;
  52      }
  53  
  54      /**
  55       * Returns localised event name.
  56       *
  57       * @return string
  58       */
  59      public static function get_name() {
  60          return get_string('eventrolecapabilitiesupdated', 'role');
  61      }
  62  
  63      /**
  64       * Returns non-localised event description with id's for admin use only.
  65       *
  66       * @return string
  67       */
  68      public function get_description() {
  69          return "The user with id '$this->userid' updated the capabilities for the role with id '$this->objectid'.";
  70      }
  71  
  72      /**
  73       * Returns relevant URL.
  74       *
  75       * @return \moodle_url
  76       */
  77      public function get_url() {
  78          if ($this->contextlevel == CONTEXT_SYSTEM) {
  79              return new \moodle_url('/admin/roles/define.php', array('action' => 'view', 'roleid' => $this->objectid));
  80          } else {
  81              return new \moodle_url('/admin/roles/override.php', array('contextid' => $this->contextid,
  82                  'roleid' => $this->objectid));
  83          }
  84      }
  85  
  86      /**
  87       * Sets legacy log data.
  88       *
  89       * @param array $legacylogdata
  90       * @return void
  91       */
  92      public function set_legacy_logdata($legacylogdata) {
  93          $this->legacylogdata = $legacylogdata;
  94      }
  95  
  96      /**
  97       * Returns array of parameters to be passed to legacy add_to_log() function.
  98       *
  99       * @return null|array
 100       */
 101      protected function get_legacy_logdata() {
 102          return $this->legacylogdata;
 103      }
 104  
 105      public static function get_objectid_mapping() {
 106          return array('db' => 'role', 'restore' => 'role');
 107      }
 108  
 109  
 110      /**
 111       * This event has been deprecated.
 112       *
 113       * @return boolean
 114       */
 115      public static function is_deprecated() {
 116          return true;
 117      }
 118  }