MDL-40919 mod_survey: replaced add_to_log with events
[moodle.git] / mod / survey / classes / event / course_module_viewed.php
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/>.
17 /**
18  * Course module viewed event.
19  *
20  * @package    mod_survey
21  * @copyright  2014 Rajesh Taneja <rajesh@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace mod_survey\event;
27 defined('MOODLE_INTERNAL') || die();
29 class course_module_viewed extends \core\event\course_module_viewed {
31     /**
32      * Set basic properties for the event.
33      */
34     protected function init() {
35         $this->data['objecttable'] = 'survey';
36         $this->data['crud'] = 'r';
37         $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
38     }
40     /**
41      * Return the legacy event log data.
42      *
43      * @return array
44      */
45     protected function get_legacy_logdata() {
46         return array($this->courseid, $this->objecttable, 'view '. $this->other['viewed'], 'view.php?id=' .
47             $this->contextinstanceid, $this->objectid, $this->contextinstanceid);
48     }
50     /**
51      * Custom validation.
52      *
53      * @throws \coding_exception
54      * @return void
55      */
56     protected function validate_data() {
57         if (empty($this->other['viewed'])) {
58             throw new \coding_exception('Other must contain the key viewed.');
59         }
60     }
61 }