8e5b266a1db635284bbfa9bb7aabae5b8bad80b1
[moodle.git] / analytics / classes / local / analyser / by_course.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  * Abstract analyser in course basis.
19  *
20  * @package   core_analytics
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\local\analyser;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Abstract analyser in course basis.
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 abstract class by_course extends base {
38     /**
39      * Return the list of courses to analyse.
40      *
41      * @return \core_analytics\course[]
42      */
43     public function get_analysables() {
45         // Default to all system courses.
46         if (!empty($this->options['filter'])) {
47             $courses = $this->options['filter'];
48         } else {
49             // Iterate through all potentially valid courses.
50             $courses = get_courses('all', 'c.sortorder ASC');
51         }
52         unset($courses[SITEID]);
54         $analysables = array();
55         foreach ($courses as $course) {
56             // Skip the frontpage course.
57             $analysable = \core_analytics\course::instance($course);
58             $analysables[] = $analysable;
59         }
61         if (empty($analysables)) {
62             $this->log[] = get_string('nocourses', 'analytics');
63         }
65         return $analysables;
66     }
67 }