MDL-59106 report_insights: Order prediction values
[moodle.git] / report / insights / classes / output / insights_list.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  * Insights list page.
19  *
20  * @package    report_insights
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 report_insights\output;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Shows report_insights insights list.
31  *
32  * @package    report_insights
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 class insights_list implements \renderable, \templatable {
38     /**
39      * @var \core_analytics\model
40      */
41     protected $model;
43     /**
44      * @var \context
45      */
46     protected $context;
48     /**
49      * @var \core_analytics\model[]
50      */
51     protected $othermodels;
53     /**
54      * @var int
55      */
56     protected $page;
58     /**
59      * @var int
60      */
61     protected $perpage;
63     /**
64      * Constructor
65      *
66      * @param \core_analytics\model $model
67      * @param \context $context
68      * @param \core_analytics\model[] $othermodels
69      * @param int $page
70      * @param int $perpage The max number of results to fetch
71      * @return void
72      */
73     public function __construct(\core_analytics\model $model, \context $context, $othermodels, $page = 0, $perpage = 100) {
74         $this->model = $model;
75         $this->context = $context;
76         $this->othermodels = $othermodels;
77         $this->page = $page;
78         $this->perpage = $perpage;
79     }
81     /**
82      * Exports the data.
83      *
84      * @param \renderer_base $output
85      * @return \stdClass
86      */
87     public function export_for_template(\renderer_base $output) {
88         global $PAGE;
90         $data = new \stdClass();
91         $data->insightname = format_string($this->model->get_target()->get_name());
93         $total = 0;
95         if ($this->model->uses_insights()) {
96             $predictionsdata = $this->model->get_predictions($this->context, true, $this->page, $this->perpage);
98             $data->predictions = array();
99             $predictionvalues = array();
100             $insights = array();
101             if ($predictionsdata) {
102                 list($total, $predictions) = $predictionsdata;
104                 foreach ($predictions as $prediction) {
105                     $predictedvalue = $prediction->get_prediction_data()->prediction;
107                     // Only need to fill this data once.
108                     if (!isset($predictionvalues[$predictedvalue])) {
109                         $preddata = array();
110                         $preddata['predictiondisplayvalue'] = $this->model->get_target()->get_display_value($predictedvalue);
111                         list($preddata['style'], $preddata['outcomeicon']) =
112                             insight::get_calculation_display($this->model->get_target(), floatval($predictedvalue), $output);
113                         $predictionvalues[$predictedvalue] = $preddata;
114                     }
116                     $insightrenderable = new \report_insights\output\insight($prediction, $this->model, true);
117                     $insights[$predictedvalue][] = $insightrenderable->export_for_template($output);
118                 }
120                 // Order predicted values.
121                 if ($this->model->get_target()->is_linear()) {
122                     // During regression what we will be interested on most of the time is in low values so let's show them first.
123                     ksort($predictionvalues);
124                 } else {
125                     // During classification targets flag "not that important" samples as 0 so let's show them at the end.
126                     krsort($predictionvalues);
127                 }
129                 // Ok, now we have all the data we want, put it into a format that mustache can handle.
130                 foreach ($predictionvalues as $key => $prediction) {
131                     if (isset($insights[$key])) {
132                         $prediction['insights'] = $insights[$key];
133                     }
135                     $data->predictions[] = $prediction;
136                 }
137             }
139             if (empty($insights) && $this->page == 0) {
140                 if ($this->model->any_prediction_obtained()) {
141                     $data->noinsights = get_string('noinsights', 'analytics');
142                 } else {
143                     $data->noinsights = get_string('nopredictionsyet', 'analytics');
144                 }
145             }
146         } else {
147             $data->noinsights = get_string('noinsights', 'analytics');
148         }
150         if (!empty($data->noinsights)) {
151             $notification = new \core\output\notification($data->noinsights);
152             $data->noinsights = $notification->export_for_template($output);
153         }
155         if ($this->othermodels) {
157             $options = array();
158             foreach ($this->othermodels as $model) {
159                 $options[$model->get_id()] = $model->get_target()->get_name();
160             }
162             // New moodle_url instance returned by magic_get_url.
163             $url = $PAGE->url;
164             $url->remove_params('modelid');
165             $modelselector = new \single_select($url, 'modelid', $options, '',
166                 array('' => get_string('selectotherinsights', 'report_insights')));
167             $data->modelselector = $modelselector->export_for_template($output);
168         }
170         $data->pagingbar = $output->render(new \paging_bar($total, $this->page, $this->perpage, $PAGE->url));
172         return $data;
173     }