a7309961d6965527978b328ffefb452f82e3338a
[moodle.git] / analytics / classes / local / indicator / binary.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 binary indicator.
19  *
20  * @package   core_analytics
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_analytics\local\indicator;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Abstract binary indicator.
31  *
32  * @package   core_analytics
33  * @copyright 2017 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 binary extends discrete {
38     /**
39      * get_classes
40      *
41      * @return array
42      */
43     public static final function get_classes() {
44         // It does not really matter, all \core_analytics\local\indicator\discrete get_classes calls have been overwriten as we
45         // only need 1 column here.
46         return array(0);
47     }
49     /**
50      * It should always be displayed.
51      *
52      * Binary values have no subtypes by default, please overwrite if
53      * your indicator is adding extra features.
54      *
55      * @param float $value
56      * @param string $subtype
57      * @return bool
58      */
59     public function should_be_displayed($value, $subtype) {
60         if ($subtype != false) {
61             return false;
62         }
63         return true;
64     }
66     /**
67      * get_display_value
68      *
69      * @param float $value
70      * @param string $subtype
71      * @return string
72      */
73     public function get_display_value($value, $subtype = false) {
75         // No subtypes for binary values by default.
76         if ($value == -1) {
77             return get_string('no');
78         } else if ($value == 1) {
79             return get_string('yes');
80         } else {
81             throw new \moodle_exception('errorpredictionformat', 'analytics');
82         }
83     }
85     /**
86      * get_calculation_outcome
87      *
88      * @param float $value
89      * @param string $subtype
90      * @return int
91      */
92     public function get_calculation_outcome($value, $subtype = false) {
94         // No subtypes for binary values by default.
95         if ($value == -1) {
96             return self::OUTCOME_NEGATIVE;
97         } else if ($value == 1) {
98             return self::OUTCOME_OK;
99         } else {
100             throw new \moodle_exception('errorpredictionformat', 'analytics');
101         }
102     }
104     /**
105      * get_feature_headers
106      *
107      * @return array
108      */
109     public static function get_feature_headers() {
110         // Just 1 single feature obtained from the calculated value.
111         return array('\\' . get_called_class());
112     }
114     /**
115      * to_features
116      *
117      * @param array $calculatedvalues
118      * @return array
119      */
120     protected function to_features($calculatedvalues) {
121         // Indicators with binary values have only 1 feature for indicator, here we do nothing else
122         // than converting each sample scalar value to an array of scalars with 1 element.
123         array_walk($calculatedvalues, function(&$calculatedvalue) {
124             // Just return it as an array.
125             $calculatedvalue = array($calculatedvalue);
126         });
128         return $calculatedvalues;
129     }