See Release Notes
Long Term Support Release
Differences Between: [Versions 401 and 402] [Versions 401 and 403]
1 <?php 2 // This file is part of Moodle - http://moodle.org/ 3 // 4 // Moodle is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // Moodle is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU General Public License for more details. 13 // 14 // You should have received a copy of the GNU General Public License 15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>. 16 17 /** 18 * Course module viewed event. 19 * 20 * @package core 21 * @copyright 2013 onwards Ankit Agarwal 22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 */ 24 25 namespace core\event; 26 defined('MOODLE_INTERNAL') || die(); 27 28 /** 29 * Abstract Course module viewed event class. 30 * 31 * Class for event to be triggered when a course module is viewed. 32 * 33 * @package core 34 * @since Moodle 2.7 35 * @copyright 2013 onwards Ankit Agarwal 36 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 37 */ 38 abstract class course_module_viewed extends base { 39 40 /** 41 * Init method. 42 * 43 * Please override this in extending class and specify objecttable. 44 * 45 * @return void 46 */ 47 protected function init() { 48 $this->data['crud'] = 'r'; 49 $this->data['edulevel'] = self::LEVEL_PARTICIPATING; 50 } 51 52 /** 53 * Returns description of what happened. 54 * 55 * @return string 56 */ 57 public function get_description() { 58 return "The user with id '$this->userid' viewed the '{$this->objecttable}' activity with " . 59 "course module id '$this->contextinstanceid'."; 60 } 61 62 /** 63 * Return localised event name. 64 * 65 * @return string 66 */ 67 public static function get_name() { 68 return get_string('eventcoursemoduleviewed', 'core'); 69 } 70 71 /** 72 * Get URL related to the action. 73 * 74 * @return \moodle_url 75 */ 76 public function get_url() { 77 return new \moodle_url("/mod/$this->objecttable/view.php", array('id' => $this->contextinstanceid)); 78 } 79 80 /** 81 * Return the legacy event log data. 82 * 83 * @return array|null 84 */ 85 protected function get_legacy_logdata() { 86 return array($this->courseid, $this->objecttable, 'view', 'view.php?id=' . $this->contextinstanceid, $this->objectid, 87 $this->contextinstanceid); 88 } 89 90 /** 91 * Custom validation. 92 * 93 * @throws \coding_exception 94 * @return void 95 */ 96 protected function validate_data() { 97 parent::validate_data(); 98 // Make sure this class is never used without proper object details. 99 if (empty($this->objectid) || empty($this->objecttable)) { 100 throw new \coding_exception('The course_module_viewed event must define objectid and object table.'); 101 } 102 // Make sure the context level is set to module. 103 if ($this->contextlevel != CONTEXT_MODULE) { 104 throw new \coding_exception('Context level must be CONTEXT_MODULE.'); 105 } 106 } 107 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body