Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
   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   * Capability assigned event.
  19   *
  20   * @package    core
  21   * @since      Moodle 3.8
  22   * @copyright  2019 Simey Lameze <simey@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   * Capability assigned event class.
  32   *
  33   * @package    core
  34   * @since      Moodle 3.8
  35   * @copyright  2019 Simey Lameze <simey@moodle.com>
  36   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class capability_assigned extends base {
  39      /**
  40       * Initialise event parameters.
  41       */
  42      protected function init() {
  43          $this->data['objecttable'] = 'role_capabilities';
  44          $this->data['crud'] = 'u';
  45          $this->data['edulevel'] = self::LEVEL_OTHER;
  46      }
  47  
  48      /**
  49       * Returns localised event name.
  50       *
  51       * @return string
  52       */
  53      public static function get_name() {
  54          return get_string('eventcapabilityassigned', 'role');
  55      }
  56  
  57      /**
  58       * Returns non-localised event description with id's for admin use only.
  59       *
  60       * @return string
  61       */
  62      public function get_description() {
  63  
  64          $strpermissions = [
  65              CAP_INHERIT => get_string('notset', 'role'),
  66              CAP_ALLOW => get_string('allow', 'role'),
  67              CAP_PREVENT => get_string('prevent', 'role'),
  68              CAP_PROHIBIT => get_string('prohibit', 'role')
  69          ];
  70  
  71          $capability = $this->other['capability'];
  72          $oldpermission = $this->other['oldpermission'];
  73          $permission = $this->other['permission'];
  74  
  75          if ($oldpermission == CAP_INHERIT && $permission == CAP_ALLOW) {
  76              $description = "The user id '$this->userid' assigned the '$capability' capability for " .
  77                  "role '$this->objectid' with '$strpermissions[$permission]' permission";
  78          } else {
  79              $description = "The user id '$this->userid' changed the '$capability' capability permission for " .
  80              "role '$this->objectid' from '$strpermissions[$oldpermission]' to '$strpermissions[$permission]'";
  81          }
  82  
  83          return $description;
  84      }
  85  
  86      /**
  87       * Returns relevant URL.
  88       *
  89       * @return \moodle_url
  90       */
  91      public function get_url() {
  92          if ($this->contextlevel == CONTEXT_SYSTEM) {
  93              return new \moodle_url('/admin/roles/define.php', ['action' => 'edit', 'roleid' => $this->objectid]);
  94          } else {
  95              return new \moodle_url('/admin/roles/override.php', ['contextid' => $this->contextid,
  96                  'roleid' => $this->objectid]);
  97          }
  98      }
  99  }