Current Path : C:/xampp/htdocs/moodle/lib/classes/event/ |
Current File : C:/xampp/htdocs/moodle/lib/classes/event/competency_user_competency_review_requested.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 competency review requested event. * * @package core_competency * @copyright 2016 Issam Taboubi <issam.taboubi@umontreal.ca> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace core\event; use core\event\base; use core_competency\user_competency; defined('MOODLE_INTERNAL') || die(); /** * User competency review requested event class. * * * @package core_competency * @since Moodle 3.1 * @copyright 2016 Issam Taboubi <issam.taboubi@umontreal.ca> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class competency_user_competency_review_requested extends base { /** * Convenience method to instantiate the event. * * @param user_competency $usercompetency The user competency. * @return self */ public static function create_from_user_competency(user_competency $usercompetency) { if (!$usercompetency->get('id')) { throw new \coding_exception('The user competency ID must be set.'); } $params = array( 'contextid' => $usercompetency->get_context()->id, 'objectid' => $usercompetency->get('id'), 'relateduserid' => $usercompetency->get('userid') ); $event = static::create($params); $event->add_record_snapshot(user_competency::TABLE, $usercompetency->to_record()); return $event; } /** * Returns description of what happened. * * @return string */ public function get_description() { return "The user with id '$this->userid' sent a review request for the user competency with id '$this->objectid'"; } /** * Return localised event name. * * @return string */ public static function get_name() { return get_string('eventusercompetencyreviewrequested', 'core_competency'); } /** * Get URL related to the action * * @return \moodle_url */ public function get_url() { return \core_competency\url::user_competency($this->objectid); } /** * Init method. * * @return void */ protected function init() { $this->data['crud'] = 'u'; $this->data['edulevel'] = self::LEVEL_PARTICIPATING; $this->data['objecttable'] = user_competency::TABLE; } /** * Get_objectid_mapping method. * * @return string the name of the restore mapping the objectid links to */ public static function get_objectid_mapping() { return base::NOT_MAPPED; } /** * Custom validation. * * Throw \coding_exception notice in case of any problems. */ protected function validate_data() { if (!$this->relateduserid) { throw new \coding_exception('The \'relateduserid\' value must be set.'); } } }