80c88908482e464210cf42b00b19c1386d9c1464
[moodle.git] / lib / classes / analytics / target / course_dropout.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  * Drop out course target.
19  *
20  * @package   core
21  * @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core\analytics\target;
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->dirroot . '/course/lib.php');
30 require_once($CFG->dirroot . '/lib/gradelib.php');
31 require_once($CFG->dirroot . '/lib/completionlib.php');
32 require_once($CFG->dirroot . '/completion/completion_completion.php');
34 /**
35  * Drop out course target.
36  *
37  * @package   core
38  * @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
39  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class course_dropout extends \core_analytics\local\target\binary {
43     /**
44      * get_name
45      *
46      * @return string
47      */
48     public static function get_name() {
49         return get_string('target:coursedropout');
50     }
52     /**
53      * prediction_actions
54      *
55      * @param \core_analytics\prediction $prediction
56      * @param bool $includedetailsaction
57      * @return \core_analytics\prediction_action[]
58      */
59     public function prediction_actions(\core_analytics\prediction $prediction, $includedetailsaction = false) {
60         global $USER;
62         $actions = parent::prediction_actions($prediction, $includedetailsaction);
64         $sampledata = $prediction->get_sample_data();
65         $studentid = $sampledata['user']->id;
67         // Send a message.
68         $url = new \moodle_url('/message/index.php', array('user' => $USER->id, 'id' => $studentid));
69         $pix = new \pix_icon('t/message', get_string('sendmessage', 'message'));
70         $actions['studentmessage'] = new \core_analytics\prediction_action('studentmessage', $prediction, $url, $pix,
71             get_string('sendmessage', 'message'));
73         // View outline report.
74         $url = new \moodle_url('/report/outline/user.php', array('id' => $studentid, 'course' => $sampledata['course']->id,
75             'mode' => 'outline'));
76         $pix = new \pix_icon('i/report', get_string('outlinereport'));
77         $actions['viewoutlinereport'] = new \core_analytics\prediction_action('viewoutlinereport', $prediction, $url, $pix,
78             get_string('outlinereport'));
80         return $actions;
81     }
83     /**
84      * classes_description
85      *
86      * @return string[]
87      */
88     protected static function classes_description() {
89         return array(
90             get_string('targetlabelstudentdropoutno'),
91             get_string('targetlabelstudentdropoutyes')
92         );
93     }
95     /**
96      * Returns the predicted classes that will be ignored.
97      *
98      * Overwriten because we are also interested in knowing when the student is far from the risk of dropping out.
99      *
100      * @return array
101      */
102     protected function ignored_predicted_classes() {
103         return array();
104     }
106     /**
107      * get_analyser_class
108      *
109      * @return string
110      */
111     public function get_analyser_class() {
112         return '\core\analytics\analyser\student_enrolments';
113     }
115     /**
116      * is_valid_analysable
117      *
118      * @param \core_analytics\analysable $course
119      * @param bool $fortraining
120      * @return true|string
121      */
122     public function is_valid_analysable(\core_analytics\analysable $course, $fortraining = true) {
123         global $DB;
125         if (!$course->was_started()) {
126             return get_string('coursenotyetstarted');
127         }
129         if (!$students = $course->get_students()) {
130             return get_string('nocoursestudents');
131         }
133         if (!course_format_uses_sections($course->get_course_data()->format)) {
134             // We can not split activities in time ranges.
135             return get_string('nocoursesections');
136         }
138         if ($course->get_start() == 0) {
139             // We require time start to be set.
140             return get_string('nocoursestarttime');
141         }
143         if ($course->get_end() == 0) {
144             // We require time end to be set.
145             return get_string('nocourseendtime');
146         }
148         // Ongoing courses data can not be used to train.
149         if ($fortraining && !$course->is_finished()) {
150             return get_string('coursenotyetfinished');
151         }
153         if ($fortraining) {
154             // Not a valid target for training if there are not enough course accesses.
156             $params = array('courseid' => $course->get_id(), 'anonymous' => 0, 'start' => $course->get_start(),
157                 'end' => $course->get_end());
158             list($studentssql, $studentparams) = $DB->get_in_or_equal($students, SQL_PARAMS_NAMED);
159             // Using anonymous to use the db index, not filtering by timecreated to speed it up.
160             $select = 'courseid = :courseid AND anonymous = :anonymous AND timecreated > :start AND timecreated < :end ' .
161                 'AND userid ' . $studentssql;
163             if (!$logstore = \core_analytics\manager::get_analytics_logstore()) {
164                 throw new \coding_exception('No available log stores');
165             }
166             $nlogs = $logstore->get_events_select_count($select, array_merge($params, $studentparams));
168             // At least a minimum of students activity.
169             $nstudents = count($students);
170             if ($nlogs / $nstudents < 10) {
171                 return get_string('nocourseactivity');
172             }
173         }
175         return true;
176     }
178     /**
179      * All student enrolments are valid.
180      *
181      * @param int $sampleid
182      * @param \core_analytics\analysable $course
183      * @param bool $fortraining
184      * @return true|string
185      */
186     public function is_valid_sample($sampleid, \core_analytics\analysable $course, $fortraining = true) {
187         return true;
188     }
190     /**
191      * calculate_sample
192      *
193      * The meaning of a drop out changes depending on the settings enabled in the course. Following these priorities order:
194      * 1.- Course completion
195      * 2.- No logs during the last quarter of the course
196      *
197      * @param int $sampleid
198      * @param \core_analytics\analysable $course
199      * @param int $starttime
200      * @param int $endtime
201      * @return float
202      */
203     protected function calculate_sample($sampleid, \core_analytics\analysable $course, $starttime = false, $endtime = false) {
205         $userenrol = $this->retrieve('user_enrolments', $sampleid);
207         // We use completion as a success metric only when it is enabled.
208         $completion = new \completion_info($course->get_course_data());
209         if ($completion->is_enabled() && $completion->has_criteria()) {
210             $ccompletion = new \completion_completion(array('userid' => $userenrol->userid, 'course' => $course->get_id()));
211             if ($ccompletion->is_complete()) {
212                 return 0;
213             } else {
214                 return 1;
215             }
216         }
218         if (!$logstore = \core_analytics\manager::get_analytics_logstore()) {
219             throw new \coding_exception('No available log stores');
220         }
222         // No logs during the last quarter of the course.
223         $courseduration = $course->get_end() - $course->get_start();
224         $limit = intval($course->get_end() - ($courseduration / 4));
225         $select = "courseid = :courseid AND userid = :userid AND timecreated > :limit";
226         $params = array('userid' => $userenrol->userid, 'courseid' => $course->get_id(), 'limit' => $limit);
227         $nlogs = $logstore->get_events_select_count($select, $params);
228         if ($nlogs == 0) {
229             return 0;
230         }
231         return 1;
232     }