MDL-64477 analytics: Introduce a new \core_analytics\stats class
[moodle.git] / analytics / classes / stats.php
1 <?php
2 // This file is part of Moodle - https://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  * Provides the {@link \core_analytics\stats} class.
19  *
20  * @package     core_analytics
21  * @copyright   2019 David Mudrák <david@moodle.com>
22  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_analytics;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Provides stats and meta information about the analytics usage on this site.
31  *
32  * @copyright 2019 David Mudrák <david@moodle.com>
33  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class stats {
37     /**
38      * Return the number of models enabled on this site.
39      *
40      * @return int
41      */
42     public static function enabled_models() : int {
43         return count(manager::get_all_models(true));
44     }
46     /**
47      * Return the number of predictions generated by the system.
48      *
49      * @return int
50      */
51     public static function predictions() : int {
52         global $DB;
54         return $DB->count_records('analytics_predictions');
55     }
57     /**
58      * Return the number of suggested actions executed by users.
59      *
60      * @return int
61      */
62     public static function actions() : int {
63         global $DB;
65         return $DB->count_records('analytics_prediction_actions');
66     }
68     /**
69      * Return the number of suggested actions flagged as not useful.
70      *
71      * @return int
72      */
73     public static function actions_not_useful() : int {
74         global $DB;
76         return $DB->count_records('analytics_prediction_actions', ['actionname' => prediction::ACTION_NOT_USEFUL]);
77     }
78 }