d240a96ad9180cf8b2e714393cc73767151e4c78
[moodle.git] / course / classes / analytics / indicator / no_teacher.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  * No teacher indicator.
19  *
20  * @package   core_course
21  * @copyright 2017 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_course\analytics\indicator;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * No teacher indicator.
31  *
32  * @package   core_analytics
33  * @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
34  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class no_teacher extends \core_analytics\local\indicator\binary {
38     /**
39      * get_name
40      *
41      * @return string
42      */
43     public static function get_name() {
44         return get_string('indicator:noteacher', 'moodle');
45     }
47     /**
48      * required_sample_data
49      *
50      * @return string[]
51      */
52     public static function required_sample_data() {
53         // We require course because, although calculate_sample only reads context, we need the context to be course
54         // or below.
55         return array('context', 'course');
56     }
58     /**
59      * calculate_sample
60      *
61      * @param int $sampleid
62      * @param string $sampleorigin
63      * @param int|false $notusedstarttime
64      * @param int|false $notusedendtime
65      * @return float
66      */
67     public function calculate_sample($sampleid, $sampleorigin, $notusedstarttime = false, $notusedendtime = false) {
69         $context = $this->retrieve('context', $sampleid);
71         $teacherroles = get_config('analytics', 'teacherroles');
72         $teacherroleids = explode(',', $teacherroles);
73         foreach ($teacherroleids as $role) {
74             // We look for roles, not enrolments as a teacher assigned at category level is supposed to be a
75             // course teacher.
76             $teachers = get_role_users($role, $context, false, 'u.id', 'u.id');
77             if ($teachers) {
78                 return self::get_max_value();
79             }
80         }
82         return self::get_min_value();
83     }
84 }