MDL-58859 analytics: Analytics API added to core

Part of MDL-57791 epic.
2017-07-24 07:53:03 +02:00
parent efaf853426
commit 369389c9a6
89 changed files with 8889 additions and 0 deletions
@@ -0,0 +1,81 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Abstract binary indicator.
+ *
+ * @package   core_analytics
+ * @copyright 2017 David Monllao {@link http://www.davidmonllao.com}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_analytics\local\indicator;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Abstract binary indicator.
+ *
+ * @package   core_analytics
+ * @copyright 2017 David Monllao {@link http://www.davidmonllao.com}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+abstract class binary extends discrete {
+
+    public static final function get_classes() {
+        return array(0, 1);
+    }
+
+    public function get_display_value($value, $subtype = false) {
+
+        // No subtypes for binary values by default.
+        if ($value == -1) {
+            return get_string('no');
+        } else if ($value == 1) {
+            return get_string('yes');
+        } else {
+            throw new \moodle_exception('errorpredictionformat', 'analytics');
+        }
+    }
+
+    public function get_value_style($value, $subtype = false) {
+
+        // No subtypes for binary values by default.
+        if ($value == -1) {
+            return 'alert alert-warning';
+        } else if ($value == 1) {
+            return 'alert alert-info';
+        } else {
+            throw new \moodle_exception('errorpredictionformat', 'analytics');
+        }
+    }
+
+    public static function get_feature_headers() {
+        // Just 1 single feature obtained from the calculated value.
+        return array(get_called_class());
+    }
+
+    protected function to_features($calculatedvalues) {
+        // Indicators with binary values have only 1 feature for indicator, here we do nothing else
+        // than converting each sample scalar value to an array of scalars with 1 element.
+        array_walk($calculatedvalues, function(&$calculatedvalue) {
+            // Just return it as an array.
+            $calculatedvalue = array($calculatedvalue);
+        });
+
+        return $calculatedvalues;
+    }
+}