Current Path : C:/xampp/htdocs/moodle/report/completion/classes/event/ |
Current File : C:/xampp/htdocs/moodle/report/completion/classes/event/user_report_viewed.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/>. /** * The report_completion user report viewed event. * * @package report_completion * @copyright 2014 onwards Ankit Agarwal<ankit.agrr@gmail.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace report_completion\event; defined('MOODLE_INTERNAL') || die(); /** * The report_completion user report viewed event class. * * @package report_completion * @since Moodle 2.7 * @copyright 2014 onwards Ankit Agarwal <ankit.agrr@gmail.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class user_report_viewed extends \core\event\base { /** * Init method. * * @return void */ protected function init() { $this->data['crud'] = 'r'; $this->data['edulevel'] = self::LEVEL_OTHER; } /** * Return localised event name. * * @return string */ public static function get_name() { return get_string('eventuserreportviewed', 'report_completion'); } /** * Returns description of what happened. * * @return string */ public function get_description() { return "The user with id '$this->userid' viewed the user completion report for the user with id '$this->relateduserid'."; } /** * Return the legacy event log data. * * @return array */ protected function get_legacy_logdata() { $url = 'report/completion/user.php?id=' . $this->relateduserid . '&course=' . $this->courseid; return array($this->courseid, 'course', 'report completion', $url, $this->courseid); } /** * Returns relevant URL. * * @return \moodle_url */ public function get_url() { return new \moodle_url('/report/completion/user.php', array('course' => $this->courseid, 'id' => $this->relateduserid)); } /** * custom validations. * * @throws \coding_exception when validation fails. * @return void */ protected function validate_data() { parent::validate_data(); if ($this->contextlevel != CONTEXT_COURSE) { throw new \coding_exception('Context level must be CONTEXT_COURSE.'); } if (!isset($this->relateduserid)) { throw new \coding_exception('The \'relateduserid\' must be set.'); } } }