MDL-39962 - Events: Replace the legacy event workshop_viewed
[moodle.git] / mod / workshop / 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  * This file contains an event for when a workshop activity is viewed.
19  *
20  * @package    mod_workshop
21  * @copyright  2013 Adrian Greeve <adrian@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace mod_workshop\event;
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * Event for when a workshop activity is viewed.
30  *
31  * @package    mod_workshop
32  * @copyright  2013 Adrian Greeve
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class course_module_viewed extends \core\event\content_viewed {
37     /**
38      * Init method.
39      */
40     protected function init() {
41         $this->data['crud'] = 'r';
42         $this->data['level'] = self::LEVEL_PARTICIPATING;
43         $this->data['objecttable'] = 'workshop';
44     }
46     /**
47      * Does this event replace a legacy event?
48      *
49      * @return string legacy event name
50      */
51     public static function get_legacy_eventname() {
52         return 'workshop_viewed';
53     }
55     /**
56      * Returns non-localised description of what happened.
57      *
58      * @return string
59      */
60     public function get_description() {
61         return 'User with id ' . $this->userid . ' viewed content ' . $this->get_url() . ' In phase ' . $this->other['content'];
62     }
64     /**
65      * Returns localised general event name.
66      *
67      * @return string
68      */
69     public static function get_name() {
70         return get_string('workshopviewed', 'workshop');
71     }
73     /**
74      * Returns relevant URL.
75      * @return \moodle_url
76      */
77     public function get_url() {
78         $url = '/mod/workshop/view.php';
79         return new \moodle_url($url, array('id'=>$this->context->instanceid));
80     }
82     /**
83      * Legacy event data if get_legacy_eventname() is not empty.
84      *
85      * @return mixed
86      */
87     protected function get_legacy_eventdata() {
88         global $USER;
90         $workshop = $this->get_record_snapshot('workshop', $this->objectid);
91         $course   = $this->get_record_snapshot('course', $this->courseid);
92         $cm       = $this->get_record_snapshot('course_modules', $this->context->instanceid);
93         $workshop = new \workshop($workshop, $cm, $course);
94         return (object)array('workshop' => $workshop, 'user' => $USER);
95     }
97     /**
98      * replace add_to_log() statement.
99      *
100      * @return array of parameters to be passed to legacy add_to_log() function.
101      */
102     protected function get_legacy_logdata() {
103         $url = new \moodle_url('view.php', array('id' => $this->context->instanceid));
104         return array($this->courseid, 'workshop', 'view', $url->out(), $this->objectid, $this->context->instanceid);
105     }