[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 assigned event.
  19   *
  20   * @package    core
  21   * @copyright  2013 Petr Skoda {@link http://skodak.org}
  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.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - int id: role assigned id.
  36   *      - string component: name of component.
  37   *      - int itemid: (optional) id of the item.
  38   * }
  39   *
  40   * @package    core
  41   * @since      Moodle 2.6
  42   * @copyright  2013 Petr Skoda {@link http://skodak.org}
  43   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  44   */
  45  class role_assigned extends base {
  46  
  47      /**
  48       * Set basic properties for the event.
  49       */
  50      protected function init() {
  51          $this->data['objecttable'] = 'role';
  52          $this->data['crud'] = 'c';
  53          $this->data['edulevel'] = self::LEVEL_OTHER;
  54      }
  55  
  56      /**
  57       * Returns localised general event name.
  58       *
  59       * @return string
  60       */
  61      public static function get_name() {
  62          return get_string('eventroleassigned', 'role');
  63      }
  64  
  65      /**
  66       * Returns non-localised event description with id's for admin use only.
  67       *
  68       * @return string
  69       */
  70      public function get_description() {
  71          return "The user with id '$this->userid' assigned the role with id '$this->objectid' to the user with id " .
  72              "'$this->relateduserid'.";
  73      }
  74  
  75      /**
  76       * Returns relevant URL.
  77       * @return \moodle_url
  78       */
  79      public function get_url() {
  80          return new \moodle_url('/admin/roles/assign.php', array('contextid' => $this->contextid, 'roleid' => $this->objectid));
  81      }
  82  
  83      /**
  84       * Does this event replace legacy event?
  85       *
  86       * @return null|string legacy event name
  87       */
  88      public static function get_legacy_eventname() {
  89          return 'role_assigned';
  90      }
  91  
  92      /**
  93       * Legacy event data if get_legacy_eventname() is not empty.
  94       *
  95       * @return mixed
  96       */
  97      protected function get_legacy_eventdata() {
  98          return $this->get_record_snapshot('role_assignments', $this->other['id']);
  99      }
 100  
 101      /**
 102       * Returns array of parameters to be passed to legacy add_to_log() function.
 103       *
 104       * @return array
 105       */
 106      protected function get_legacy_logdata() {
 107          $roles = get_all_roles();
 108          $rolenames = role_fix_names($roles, $this->get_context(), ROLENAME_ORIGINAL, true);
 109          return array($this->courseid, 'role', 'assign', 'admin/roles/assign.php?contextid='.$this->contextid.'&roleid='.$this->objectid,
 110                  $rolenames[$this->objectid], '', $this->userid);
 111      }
 112  
 113      /**
 114       * Custom validation.
 115       *
 116       * @throws \coding_exception
 117       * @return void
 118       */
 119      protected function validate_data() {
 120          parent::validate_data();
 121  
 122          if (!isset($this->relateduserid)) {
 123              throw new \coding_exception('The \'relateduserid\' must be set.');
 124          }
 125  
 126          if (!isset($this->other['id'])) {
 127              throw new \coding_exception('The \'id\' value must be set in other.');
 128          }
 129  
 130          if (!isset($this->other['component'])) {
 131              throw new \coding_exception('The \'component\' value must be set in other.');
 132          }
 133      }
 134  
 135      public static function get_objectid_mapping() {
 136          return array('db' => 'role', 'restore' => 'role');
 137      }
 138  
 139      public static function get_other_mapping() {
 140          $othermapped = array();
 141          $othermapped['id'] = array('db' => 'role_assignments', 'restore' => base::NOT_MAPPED);
 142          $othermapped['itemid'] = base::NOT_MAPPED;
 143  
 144          return $othermapped;
 145      }
 146  }