mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-64777 analytics: Add ability to restore missing default models
The patch introduces a new page restoredefault.php that allows the user to select missing models to be restored.
- Loading branch information
Showing
8 changed files
with
593 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
142 changes: 142 additions & 0 deletions
142
admin/tool/analytics/classes/output/restorable_models.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| <?php | ||
| // This file is part of Moodle - https://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/>. | ||
|
|
||
| /** | ||
| * Provides {@link \tool_analytics\output\restorable_models} class. | ||
| * | ||
| * @package tool_analytics | ||
| * @category output | ||
| * @copyright 2019 David Mudrák <david@moodle.com> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| namespace tool_analytics\output; | ||
|
|
||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| /** | ||
| * Represents the list of default models that can be eventually restored. | ||
| * | ||
| * @copyright 2019 David Mudrák <david@moodle.com> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class restorable_models implements \renderable, \templatable { | ||
|
|
||
| /** @var array */ | ||
| protected $models; | ||
|
|
||
| /** | ||
| * Instantiate an object of this class. | ||
| * | ||
| * @param array $models List of models as returned by {@link \core_analytics\manager::load_default_models_for_all_components()} | ||
| */ | ||
| public function __construct(array $models) { | ||
|
|
||
| $this->models = $models; | ||
| } | ||
|
|
||
| /** | ||
| * Export the list of models to be rendered. | ||
| * | ||
| * @param renderer_base $output | ||
| * @return string | ||
| */ | ||
| public function export_for_template(\renderer_base $output) { | ||
|
|
||
| $components = []; | ||
|
|
||
| foreach ($this->models as $componentname => $modelslist) { | ||
| $component = [ | ||
| 'name' => $this->component_name($componentname), | ||
| 'component' => $componentname, | ||
| 'models' => [], | ||
| ]; | ||
|
|
||
| foreach ($modelslist as $definition) { | ||
| list($target, $indicators) = \core_analytics\manager::get_declared_target_and_indicators_instances($definition); | ||
|
|
||
| if (\core_analytics\model::exists($target, $indicators)) { | ||
| continue; | ||
| } | ||
|
|
||
| $targetnamelangstring = $target->get_name(); | ||
|
|
||
| $model = [ | ||
| 'defid' => \core_analytics\manager::model_declaration_identifier($definition), | ||
| 'targetname' => $targetnamelangstring, | ||
| 'targetclass' => $definition['target'], | ||
| 'indicatorsnum' => count($definition['indicators']), | ||
| 'indicators' => [], | ||
| ]; | ||
|
|
||
| if (get_string_manager()->string_exists($targetnamelangstring->get_identifier().'_help', | ||
| $targetnamelangstring->get_component())) { | ||
| $helpicon = new \help_icon($targetnamelangstring->get_identifier(), $targetnamelangstring->get_component()); | ||
| $model['targethelp'] = $helpicon->export_for_template($output); | ||
| } | ||
|
|
||
| foreach ($indicators as $indicator) { | ||
| $indicatornamelangstring = $indicator->get_name(); | ||
| $indicatordata = [ | ||
| 'name' => $indicatornamelangstring, | ||
| 'classname' => $indicator->get_id(), | ||
| ]; | ||
|
|
||
| if (get_string_manager()->string_exists($indicatornamelangstring->get_identifier().'_help', | ||
| $indicatornamelangstring->get_component())) { | ||
| $helpicon = new \help_icon($indicatornamelangstring->get_identifier(), | ||
| $indicatornamelangstring->get_component()); | ||
| $indicatordata['indicatorhelp'] = $helpicon->export_for_template($output); | ||
| } | ||
|
|
||
| $model['indicators'][] = $indicatordata; | ||
| } | ||
|
|
||
| $component['models'][] = $model; | ||
| } | ||
|
|
||
| if (!empty($component['models'])) { | ||
| $components[] = $component; | ||
| } | ||
| } | ||
|
|
||
| $result = [ | ||
| 'hasdata' => !empty($components), | ||
| 'components' => array_values($components), | ||
| 'submiturl' => new \moodle_url('/admin/tool/analytics/restoredefault.php'), | ||
| 'backurl' => new \moodle_url('/admin/tool/analytics/index.php'), | ||
| 'sesskey' => sesskey(), | ||
| ]; | ||
|
|
||
| return $result; | ||
| } | ||
|
|
||
| /** | ||
| * Return a human readable name for the given frankenstyle component. | ||
| * | ||
| * @param string $component Frankenstyle component such as 'core', 'core_analytics' or 'mod_workshop' | ||
| * @return string Human readable name of the component | ||
| */ | ||
| protected function component_name(string $component): string { | ||
|
|
||
| if ($component === 'core' || strpos($component, 'core_')) { | ||
| return get_string('componentcore', 'tool_analytics'); | ||
|
|
||
| } else { | ||
| return get_string('pluginname', $component); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| <?php | ||
| // This file is part of Moodle - https://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/>. | ||
|
|
||
| /** | ||
| * Check and create missing default prediction models. | ||
| * | ||
| * @package tool_analytics | ||
| * @copyright 2019 David Mudrák <david@moodle.com> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| require_once(__DIR__ . '/../../../config.php'); | ||
|
|
||
| require_login(); | ||
| \core_analytics\manager::check_can_manage_models(); | ||
|
|
||
| $confirmed = optional_param('confirmed', false, PARAM_BOOL); | ||
| $restoreids = optional_param_array('restoreid', [], PARAM_ALPHANUM); | ||
|
|
||
| $returnurl = new \moodle_url('/admin/tool/analytics/index.php'); | ||
| $myurl = new \moodle_url('/admin/tool/analytics/restoredefault.php'); | ||
|
|
||
| \tool_analytics\output\helper::set_navbar(get_string('restoredefault', 'tool_analytics'), $myurl); | ||
|
|
||
| if (data_submitted()) { | ||
| require_sesskey(); | ||
|
|
||
| if (empty($restoreids)) { | ||
| $message = get_string('restoredefaultempty', 'tool_analytics'); | ||
| $type = \core\output\notification::NOTIFY_WARNING; | ||
| redirect($myurl, $message, null, $type); | ||
| } | ||
|
|
||
| $numcreated = 0; | ||
|
|
||
| foreach (\core_analytics\manager::load_default_models_for_all_components() as $componentname => $modelslist) { | ||
| foreach ($modelslist as $definition) { | ||
| if (!in_array(\core_analytics\manager::model_declaration_identifier($definition), $restoreids)) { | ||
| // This model has not been selected by the user. | ||
| continue; | ||
| } | ||
|
|
||
| list($target, $indicators) = \core_analytics\manager::get_declared_target_and_indicators_instances($definition); | ||
|
|
||
| if (\core_analytics\model::exists($target, $indicators)) { | ||
| // This model exists (normally this should not happen as we do not show such models in the UI to select). | ||
| continue; | ||
| } | ||
|
|
||
| \core_analytics\manager::create_declared_model($definition); | ||
| $numcreated++; | ||
| } | ||
| } | ||
|
|
||
| $message = get_string('restoredefaultsome', 'tool_analytics', ['count' => $numcreated]); | ||
| $type = \core\output\notification::NOTIFY_SUCCESS; | ||
|
|
||
| redirect($returnurl, $message, null, $type); | ||
| } | ||
|
|
||
| $models = \core_analytics\manager::load_default_models_for_all_components(); | ||
| $ui = new \tool_analytics\output\restorable_models($models); | ||
|
|
||
| echo $OUTPUT->header(); | ||
| echo $PAGE->get_renderer('tool_analytics')->render($ui); | ||
| echo $OUTPUT->footer(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.