lib/classes/event/user_loggedinas.php

   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  * User loggedinas event.
  19  *
  20  * @package    core
  21  * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  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  * User loggedinas event class.
  31  *
  32  * @property-read array $other {
  33  *      Extra information about event.
  34  *
  35  *      - string originalusername: original username.
  36  *      - string loggedinasusername: username of logged in as user.
  37  * }
  38  *
  39  * @package    core
  40  * @since      Moodle 2.6
  41  * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  42  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43  */
  44 class user_loggedinas extends base {
  45
  46     /**
  47      * Init method.
  48      *
  49      * @return void
  50      */
  51     protected function init() {
  52         $this->data['crud'] = 'r';
  53         $this->data['edulevel'] = self::LEVEL_OTHER;
  54         $this->data['objecttable'] = 'user';
  55     }
  56
  57     /**
  58      * Return localised event name.
  59      *
  60      * @return string
  61      */
  62     public static function get_name() {
  63         return get_string('eventuserloggedinas', 'auth');
  64     }
  65
  66     /**
  67      * Returns non-localised event description with id's for admin use only.
  68      *
  69      * @return string
  70      */
  71     public function get_description() {
  72         return "The user with id '$this->userid' has logged in as the user with id '$this->relateduserid'.";
  73     }
  74
  75     /**
  76      * Return legacy data for add_to_log().
  77      *
  78      * @return array
  79      */
  80     protected function get_legacy_logdata() {
  81         return array($this->courseid, 'course', 'loginas', '../user/view.php?id=' . $this->courseid . '&amp;user=' . $this->userid,
  82             $this->other['originalusername'] . ' -> ' . $this->other['loggedinasusername']);
  83     }
  84
  85     /**
  86      * Get URL related to the action.
  87      *
  88      * @return \moodle_url
  89      */
  90     public function get_url() {
  91         return new \moodle_url('/user/view.php', array('id' => $this->objectid));
  92     }
  93
  94     /**
  95      * Custom validation.
  96      *
  97      * @throws \coding_exception when validation does not pass.
  98      * @return void
  99      */
 100     protected function validate_data() {
 101         parent::validate_data();
 102
 103         if (!isset($this->relateduserid)) {
 104             throw new \coding_exception('The \'relateduserid\' must be set.');
 105         }
 106
 107         if (!isset($this->other['originalusername'])) {
 108             throw new \coding_exception('The \'originalusername\' value must be set in other.');
 109         }
 110
 111         if (!isset($this->other['loggedinasusername'])) {
 112             throw new \coding_exception('The \'loggedinasusername\' value must be set in other.');
 113         }
 114     }
 115 }