[Summary 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  namespace core\event;
  18  
  19  /**
  20   * Role create event class.
  21   *
  22   * @property-read array $other {
  23   *      Extra information about the event.
  24   *
  25   *      - string name: The name of role.
  26   *      - string shortname: The shortname of role.
  27   *      - string archetype: The archetype.
  28   * }
  29   *
  30   * @package    core
  31   * @since      Moodle 4.2
  32   * @copyright  2023 The Open University.
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class role_created extends base {
  36      protected function init() {
  37          $this->data['objecttable'] = 'role';
  38          $this->data['crud'] = 'c';
  39          $this->data['edulevel'] = self::LEVEL_OTHER;
  40      }
  41  
  42      public static function get_name() {
  43          return get_string('eventrolecreated', 'role');
  44      }
  45  
  46      public function get_url() {
  47          return new \moodle_url('/admin/roles/define.php', ['action' => 'view', 'roleid' => $this->objectid]);
  48      }
  49  
  50      public function get_description() {
  51          return "The user with id '$this->userid' created the role with id '$this->objectid'.";
  52      }
  53  
  54      protected function validate_data() {
  55          parent::validate_data();
  56  
  57          if (!isset($this->other['name'])) {
  58              throw new \coding_exception('The \'name\' value must be set in other.');
  59          }
  60  
  61          if (!isset($this->other['shortname'])) {
  62              throw new \coding_exception('The \'shortname\' value must be set in other.');
  63          }
  64  
  65          if (!isset($this->other['archetype'])) {
  66              throw new \coding_exception('The \'archetype\' value must be set in other.');
  67          }
  68      }
  69  }