Current Path : C:/xampp/htdocs/moodle/lib/classes/event/ |
Current File : C:/xampp/htdocs/moodle/lib/classes/event/webservice_token_created.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/>. /** * Web service token created 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(); /** * Web service token created event class. * * @property-read array $other { * Extra information about event. * * - bool auto: true if it was automatically created. * } * * @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 webservice_token_created extends base { /** * Returns description of what happened. * * @return string */ public function get_description() { return "The user with id '$this->userid' created a web service token for the user with id '$this->relateduserid'."; } /** * Return the legacy event log data. * * @return array|null */ protected function get_legacy_logdata() { if (!empty($this->other['auto'])) { // The token has been automatically created. return array(SITEID, 'webservice', 'automatically create user token', '' , 'User ID: ' . $this->relateduserid); } } /** * Return localised event name. * * @return string */ public static function get_name() { return get_string('eventwebservicetokencreated', 'webservice'); } /** * Get URL related to the action. * * @return \moodle_url */ public function get_url() { return new \moodle_url('/admin/settings.php', array('section' => 'webservicetokens')); } /** * Init method. * * @return void */ protected function init() { $this->context = \context_system::instance(); $this->data['crud'] = 'c'; $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = 'external_tokens'; } /** * Custom validation. * * @throws \coding_exception * @return void */ protected function validate_data() { parent::validate_data(); if (!isset($this->relateduserid)) { throw new \coding_exception('The \'relateduserid\' must be set.'); } if (!isset($this->other['auto'])) { throw new \coding_exception('The \'auto\' value must be set in other.'); } } public static function get_objectid_mapping() { // Webservices are not included in backups. return array('db' => 'external_tokens', 'restore' => base::NOT_MAPPED); } public static function get_other_mapping() { return false; } }