MDL-61257 reports: Report logs link to unavailable completion report
[moodle.git] / lib / classes / event / course_module_completion_updated.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 completion event.
19  *
20  * @package    core
21  * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core\event;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Course module completion event class.
31  *
32  * @property-read array $other {
33  *      Extra information about event.
34  *
35  *      - int relateduserid: (optional) the related user id.
36  * }
37  *
38  * @package    core
39  * @since      Moodle 2.6
40  * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
41  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42  */
43 class course_module_completion_updated extends base {
45     /**
46      * Initialise required event data properties.
47      */
48     protected function init() {
49         $this->data['objecttable'] = 'course_modules_completion';
50         $this->data['crud'] = 'u';
51         $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
52     }
54     /**
55      * Returns localised event name.
56      *
57      * @return string
58      */
59     public static function get_name() {
60         return get_string('eventcoursemodulecompletionupdated', 'core_completion');
61     }
63     /**
64      * Returns non-localised event description with id's for admin use only.
65      *
66      * @return string
67      */
68     public function get_description() {
69         if (isset($this->other['overrideby']) && $this->other['overrideby']) {
70             return "The user with id '{$this->userid}' overrode the completion state to '{$this->other['completionstate']}' ".
71                 "for the course module with id '{$this->contextinstanceid}' for the user with id '{$this->relateduserid}'.";
72         } else {
73             return "The user with id '{$this->userid}' updated the completion state for the course module with id " .
74                 "'{$this->contextinstanceid}' for the user with id '{$this->relateduserid}'.";
75         }
76     }
78     /**
79      * Returns relevant URL.
80      *
81      * @return \moodle_url
82      */
83     public function get_url() {
84         return new \moodle_url('/report/progress/index.php', array('course' => $this->courseid));
85     }
87     /**
88      * Return name of the legacy event, which is replaced by this event.
89      *
90      * @return string legacy event name
91      */
92     public static function get_legacy_eventname() {
93         return 'activity_completion_changed';
94     }
96     /**
97      * Return course module completion legacy event data.
98      *
99      * @return \stdClass completion data.
100      */
101     protected function get_legacy_eventdata() {
102         return $this->get_record_snapshot('course_modules_completion', $this->objectid);
103     }
105     /**
106      * Custom validation.
107      *
108      * @throws \coding_exception in case of a problem.
109      */
110     protected function validate_data() {
111         parent::validate_data();
112         // Make sure the context level is set to module.
113         if ($this->contextlevel !== CONTEXT_MODULE) {
114             throw new \coding_exception('Context level must be CONTEXT_MODULE.');
115         }
117         if (!isset($this->relateduserid)) {
118             throw new \coding_exception('The \'relateduserid\' must be set.');
119         }
120     }
122     public static function get_objectid_mapping() {
123         // Sorry mapping info is not available for course modules completion records.
124         return array('db' => 'course_modules_completion', 'restore' => base::NOT_MAPPED);
125     }
127     public static function get_other_mapping() {
128         $othermapped = array();
129         $othermapped['relateduserid'] = array('db' => 'user', 'restore' => 'user');
130         $othermapped['overrideby'] = array('db' => 'user', 'restore' => 'user');
132         return $othermapped;
133     }