MDL-57791 analytics: Predictions deleted context management
[moodle.git] / admin / tool / analytics / classes / output / models_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  * Prediction models list page.
19  *
20  * @package    tool_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 tool_analytics\output;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Shows tool_analytics models list.
31  *
32  * @package    tool_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 class models_list implements \renderable, \templatable {
38     /**
39      * models
40      *
41      * @var \core_analytics\model[]
42      */
43     protected $models = array();
45     /**
46      * __construct
47      *
48      * @param \core_analytics\model[] $models
49      * @return void
50      */
51     public function __construct($models) {
52         $this->models = $models;
53     }
55     /**
56      * Exports the data.
57      *
58      * @param \renderer_base $output
59      * @return \stdClass
60      */
61     public function export_for_template(\renderer_base $output) {
63         $data = new \stdClass();
65         $data->models = array();
66         foreach ($this->models as $model) {
67             $modeldata = $model->export();
69             // Model predictions list.
70             if ($model->uses_insights()) {
71                 $predictioncontexts = $model->get_predictions_contexts();
72                 if ($predictioncontexts) {
74                     foreach ($predictioncontexts as $contextid => $unused) {
75                         // We prepare this to be used as single_select template options.
76                         $context = \context::instance_by_id($contextid);
78                         // Special name for system level predictions as showing "System is not visually nice".
79                         if ($contextid == SYSCONTEXTID) {
80                             $contextname = get_string('allpredictions', 'tool_analytics');
81                         } else {
82                             $contextname = shorten_text($context->get_context_name(true, true), 90);
83                         }
84                         $predictioncontexts[$contextid] = $contextname;
85                     }
86                     \core_collator::asort($predictioncontexts);
88                     if (!empty($predictioncontexts)) {
89                         $url = new \moodle_url('/report/insights/insights.php', array('modelid' => $model->get_id()));
90                         $singleselect = new \single_select($url, 'contextid', $predictioncontexts);
91                         $modeldata->insights = $singleselect->export_for_template($output);
92                     }
93                 }
95                 if (empty($modeldata->insights)) {
96                     if ($model->any_prediction_obtained()) {
97                         $modeldata->noinsights = get_string('noinsights', 'analytics');
98                     } else {
99                         $modeldata->noinsights = get_string('nopredictionsyet', 'analytics');
100                     }
101                 }
103             } else {
104                 $modeldata->noinsights = get_string('noinsightsmodel', 'analytics');
105             }
107             // Actions.
108             $actionsmenu = new \action_menu();
109             $actionsmenu->set_menu_trigger(get_string('actions'));
110             $actionsmenu->set_owner_selector('model-actions-' . $model->get_id());
111             $actionsmenu->set_alignment(\action_menu::TL, \action_menu::BL);
113             // Edit model.
114             if (!$model->is_static()) {
115                 $url = new \moodle_url('model.php', array('action' => 'edit', 'id' => $model->get_id()));
116                 $icon = new \action_menu_link_secondary($url, new \pix_icon('t/edit', get_string('edit')), get_string('edit'));
117                 $actionsmenu->add($icon);
118             }
120             // Evaluate machine-learning-based models.
121             if ($model->get_indicators() && !$model->is_static()) {
122                 $url = new \moodle_url('model.php', array('action' => 'evaluate', 'id' => $model->get_id()));
123                 $icon = new \action_menu_link_secondary($url, new \pix_icon('i/calc', get_string('evaluate', 'tool_analytics')),
124                     get_string('evaluate', 'tool_analytics'));
125                 $actionsmenu->add($icon);
126             }
128             if ($modeldata->enabled && !empty($modeldata->timesplitting)) {
129                 $url = new \moodle_url('model.php', array('action' => 'getpredictions', 'id' => $model->get_id()));
130                 $icon = new \action_menu_link_secondary($url, new \pix_icon('i/notifications',
131                     get_string('getpredictions', 'tool_analytics')), get_string('getpredictions', 'tool_analytics'));
132                 $actionsmenu->add($icon);
133             }
135             // Machine-learning-based models evaluation log.
136             if (!$model->is_static()) {
137                 $url = new \moodle_url('model.php', array('action' => 'log', 'id' => $model->get_id()));
138                 $icon = new \action_menu_link_secondary($url, new \pix_icon('i/report', get_string('viewlog', 'tool_analytics')),
139                     get_string('viewlog', 'tool_analytics'));
140                 $actionsmenu->add($icon);
141             }
143             $modeldata->actions = $actionsmenu->export_for_template($output);
145             $data->models[] = $modeldata;
146         }
148         $data->warnings = array(
149             (object)array('message' => get_string('bettercli', 'tool_analytics'), 'closebutton' => true)
150         );
152         return $data;
153     }