[Summary view] [Print] [Text view]

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