source: moodle/trunk/fuentes/lib/classes/event/course_viewed.php @ 1331

Last change on this file since 1331 was 1331, checked in by jrpelegrina, 3 years ago

Updated to moodle 3.0.3

File size: 4.6 KB
Line 
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 viewed event.
19 *
20 * @package    core
21 * @copyright  2014 Adrian Greeve <adrian@moodle.com>
22 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace core\event;
26defined('MOODLE_INTERNAL') || die();
27
28/**
29 * Course viewed event class.
30 *
31 * Class for event to be triggered when a course is viewed.
32 *
33 * @property-read array $other {
34 *      Extra information about the event.
35 *
36 *      - int coursesectionnumber: (optional) The course section number.
37 * }
38 *
39 * @package    core
40 * @since      Moodle 2.7
41 * @copyright  2014 Adrian Greeve <adrian@moodle.com>
42 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43 */
44class course_viewed extends base {
45
46    /**
47     * Init method.
48     *
49     * @return void
50     */
51    protected function init() {
52        $this->data['crud'] = 'r';
53        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
54    }
55
56    /**
57     * Returns description of what happened.
58     *
59     * @return string
60     */
61    public function get_description() {
62
63        // We keep compatibility with 2.7 and 2.8 other['coursesectionid'].
64        $sectionstr = '';
65        if (!empty($this->other['coursesectionnumber'])) {
66            $sectionstr = "section number '{$this->other['coursesectionnumber']}' of the ";
67        } else if (!empty($this->other['coursesectionid'])) {
68            $sectionstr = "section number '{$this->other['coursesectionid']}' of the ";
69        }
70        $description = "The user with id '$this->userid' viewed the " . $sectionstr . "course with id '$this->courseid'.";
71
72        return $description;
73    }
74
75    /**
76     * Return localised event name.
77     *
78     * @return string
79     */
80    public static function get_name() {
81        return get_string('eventcourseviewed', 'core');
82    }
83
84    /**
85     * Get URL related to the action.
86     *
87     * @return \moodle_url|null
88     */
89    public function get_url() {
90        global $CFG;
91
92        // We keep compatibility with 2.7 and 2.8 other['coursesectionid'].
93        $sectionnumber = null;
94        if (isset($this->other['coursesectionnumber'])) {
95            $sectionnumber = $this->other['coursesectionnumber'];
96        } else if (isset($this->other['coursesectionid'])) {
97            $sectionnumber = $this->other['coursesectionid'];
98        }
99        require_once($CFG->dirroot . '/course/lib.php');
100        try {
101            return course_get_url($this->courseid, $sectionnumber);
102        } catch (\Exception $e) {
103            return null;
104        }
105    }
106
107    /**
108     * Return the legacy event log data.
109     *
110     * @return array|null
111     */
112    protected function get_legacy_logdata() {
113        if ($this->courseid == SITEID and !isloggedin()) {
114            // We did not log frontpage access in older Moodle versions.
115            return null;
116        }
117
118        // We keep compatibility with 2.7 and 2.8 other['coursesectionid'].
119        if (isset($this->other['coursesectionnumber']) || isset($this->other['coursesectionid'])) {
120            if (isset($this->other['coursesectionnumber'])) {
121                $sectionnumber = $this->other['coursesectionnumber'];
122            } else {
123                $sectionnumber = $this->other['coursesectionid'];
124            }
125            return array($this->courseid, 'course', 'view section', 'view.php?id=' . $this->courseid . '&amp;section='
126                    . $sectionnumber, $sectionnumber);
127        }
128        return array($this->courseid, 'course', 'view', 'view.php?id=' . $this->courseid, $this->courseid);
129    }
130
131    /**
132     * Custom validation.
133     *
134     * @throws \coding_exception
135     * @return void
136     */
137    protected function validate_data() {
138        parent::validate_data();
139
140        if ($this->contextlevel != CONTEXT_COURSE) {
141            throw new \coding_exception('Context level must be CONTEXT_COURSE.');
142        }
143    }
144
145    public static function get_other_mapping() {
146        // No mapping required.
147        return false;
148    }
149}
Note: See TracBrowser for help on using the repository browser.