Current Path : C:/xampp/htdocs/moodle/lib/classes/event/ |
Current File : C:/xampp/htdocs/moodle/lib/classes/event/user_loggedin.php |
<?php // This file is part of Moodle - http://moodle.org/ // // Moodle is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Moodle is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Moodle. If not, see <http://www.gnu.org/licenses/>. /** * User login event. * * @package core * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace core\event; defined('MOODLE_INTERNAL') || die(); /** * User login event class. * * @property-read array $other { * Extra information about event. * * - string username: name of user. * } * * @package core * @since Moodle 2.6 * @copyright 2013 Frédéric Massart * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class user_loggedin extends base { /** * Returns non-localised event description with id's for admin use only. * * @return string */ public function get_description() { return "The user with id '$this->userid' has logged in."; } /** * Return legacy data for add_to_log(). * * @return array */ protected function get_legacy_logdata() { return array(SITEID, 'user', 'login', 'view.php?id=' . $this->data['objectid'] . '&course=' . SITEID, $this->data['objectid'], 0, $this->data['objectid']); } /** * Return localised event name. * * @return string */ public static function get_name() { return get_string('eventuserloggedin', 'auth'); } /** * Get URL related to the action. * * @return \moodle_url */ public function get_url() { return new \moodle_url('/user/profile.php', array('id' => $this->data['objectid'])); } /** * Return the username of the logged in user. * * @return string */ public function get_username() { return $this->other['username']; } /** * Init method. * * @return void */ protected function init() { $this->context = \context_system::instance(); $this->data['crud'] = 'r'; $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = 'user'; } /** * Custom validation. * * @throws \coding_exception when validation does not pass. * @return void */ protected function validate_data() { parent::validate_data(); if (!isset($this->other['username'])) { throw new \coding_exception('The \'username\' value must be set in other.'); } } public static function get_objectid_mapping() { return array('db' => 'user', 'restore' => 'user'); } public static function get_other_mapping() { return false; } }