Current Path : C:/xampp/htdocs/moodle/lib/classes/event/ |
Current File : C:/xampp/htdocs/moodle/lib/classes/event/competency_plan_review_stopped.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/>. /** * Plan review stopped 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\plan; defined('MOODLE_INTERNAL') || die(); /** * Plan review stopped event class. * * @property-read array $other { * Extra information about event. * } * * @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_plan_review_stopped extends base { /** * Convenience method to instantiate the plan review stopped event. * * * @param plan $plan The plan. * @return self */ public static final function create_from_plan(plan $plan) { if (!$plan->get('id')) { throw new \coding_exception('The plan ID must be set.'); } $event = static::create(array( 'contextid' => $plan->get_context()->id, 'objectid' => $plan->get('id'), 'relateduserid' => $plan->get('userid'), )); $event->add_record_snapshot(plan::TABLE, $plan->to_record()); return $event; } /** * Returns description of what happened. * * @return string */ public function get_description() { return "The user with id '$this->userid' stopped a review for the learning plan with id '$this->objectid'."; } /** * Return localised event name. * * @return string */ public static function get_name() { return get_string('eventplanreviewstopped', 'core_competency'); } /** * Get URL related to the action * * @return \moodle_url */ public function get_url() { return \core_competency\url::plan($this->objectid); } /** * Init method. * * @return void */ protected function init() { $this->data['crud'] = 'u'; $this->data['edulevel'] = self::LEVEL_OTHER; $this->data['objecttable'] = plan::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; } }