MDL-76907 lib: Upgrade minify to 1.3.70
[moodle.git] / mod / data / renderer.php
blobae1d910b46f289ae85018c00584d1b358b5308ab
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.
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 * Database activity renderer.
20 * @copyright 2010 Sam Hemelryk
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 * @package mod_data
25 use mod_data\local\importer\preset_existing_importer;
26 use mod_data\manager;
28 defined('MOODLE_INTERNAL') || die();
30 class mod_data_renderer extends plugin_renderer_base {
32 /**
33 * Rendering setting and mapping page to import a preset.
35 * @param stdClass $datamodule Database module to import to.
36 * @param data_preset_importer $importer Importer instance to use for the importing.
37 * @return string
38 * @deprecated since Moodle 4.1 MDL-75140 - please do not use this class any more.
39 * @todo MDL-75189 Final deprecation in Moodle 4.5.
41 public function import_setting_mappings($datamodule, data_preset_importer $importer) {
42 debugging('import_setting_mappings is deprecated. Please use importing_preset instead', DEBUG_DEVELOPER);
44 $manager = \mod_data\manager::create_from_coursemodule($datamodule);
45 $fullname = $importer->get_directory();
46 return $this->importing_preset($datamodule, new preset_existing_importer($manager, $fullname));
49 /**
50 * Importing a preset on a database module.
52 * @param stdClass $datamodule Database module to import to.
53 * @param \mod_data\local\importer\preset_importer $importer Importer instance to use for the importing.
55 * @return string
57 public function importing_preset(stdClass $datamodule, \mod_data\local\importer\preset_importer $importer): string {
59 $strwarning = get_string('mappingwarning', 'data');
61 $params = $importer->settings;
62 $newfields = $params->importfields;
63 $currentfields = $params->currentfields;
65 $html = html_writer::start_tag('div', ['class' => 'presetmapping']);
66 $html .= html_writer::start_tag('form', ['method' => 'post', 'action' => '']);
67 $html .= html_writer::start_tag('div');
68 $html .= html_writer::empty_tag('input', ['type' => 'hidden', 'name' => 'action', 'value' => 'finishimport']);
69 $html .= html_writer::empty_tag('input', ['type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()]);
70 $html .= html_writer::empty_tag('input', ['type' => 'hidden', 'name' => 'd', 'value' => $datamodule->id]);
72 $inputselector = $importer->get_preset_selector();
73 $html .= html_writer::empty_tag(
74 'input',
75 ['type' => 'hidden', 'name' => $inputselector['name'], 'value' => $inputselector['value']]
78 if (!empty($newfields)) {
79 $table = new html_table();
80 $table->data = array();
82 foreach ($newfields as $nid => $newfield) {
83 $row = array();
84 $row[0] = html_writer::tag('label', $newfield->name, array('for'=>'id_'.$newfield->name));
85 $attrs = array('name' => 'field_' . $nid, 'id' => 'id_' . $newfield->name, 'class' => 'custom-select');
86 $row[1] = html_writer::start_tag('select', $attrs);
88 $selected = false;
89 foreach ($currentfields as $cid => $currentfield) {
90 if ($currentfield->type != $newfield->type) {
91 continue;
93 if ($currentfield->name == $newfield->name) {
94 $row[1] .= html_writer::tag(
95 'option',
96 get_string('mapexistingfield', 'data', $currentfield->name),
97 ['value' => $cid, 'selected' => 'selected']
99 $selected = true;
100 } else {
101 $row[1] .= html_writer::tag(
102 'option',
103 get_string('mapexistingfield', 'data', $currentfield->name),
104 ['value' => $cid]
109 if ($selected) {
110 $row[1] .= html_writer::tag('option', get_string('mapnewfield', 'data'), array('value'=>'-1'));
111 } else {
112 $row[1] .= html_writer::tag('option', get_string('mapnewfield', 'data'), array('value'=>'-1', 'selected'=>'selected'));
115 $row[1] .= html_writer::end_tag('select');
116 $table->data[] = $row;
118 $html .= html_writer::table($table);
119 $html .= html_writer::tag('p', $strwarning);
120 } else {
121 $html .= $this->output->notification(get_string('nodefinedfields', 'data'));
124 $html .= html_writer::start_tag('div', array('class'=>'overwritesettings'));
125 $attrs = ['type' => 'checkbox', 'name' => 'overwritesettings', 'id' => 'overwritesettings', 'class' => 'mr-2'];
126 $html .= html_writer::empty_tag('input', $attrs);
127 $html .= html_writer::tag('label', get_string('overwritesettings', 'data'), ['for' => 'overwritesettings']);
128 $html .= html_writer::end_tag('div');
130 $actionbuttons = html_writer::start_div();
131 $cancelurl = new moodle_url('/mod/data/field.php', ['d' => $datamodule->id]);
132 $actionbuttons .= html_writer::tag('a', get_string('cancel') , [
133 'href' => $cancelurl->out(false),
134 'class' => 'btn btn-secondary mx-1',
135 'role' => 'button',
137 $actionbuttons .= html_writer::empty_tag('input', [
138 'type' => 'submit',
139 'class' => 'btn btn-primary mx-1',
140 'value' => get_string('continue'),
142 $actionbuttons .= html_writer::end_div();
144 $stickyfooter = new core\output\sticky_footer($actionbuttons);
145 $html .= $this->render($stickyfooter);
147 $html .= html_writer::end_tag('div');
148 $html .= html_writer::end_tag('form');
149 $html .= html_writer::end_tag('div');
151 return $html;
155 * Renders the action bar for the field page.
157 * @param \mod_data\output\fields_action_bar $actionbar
158 * @return string The HTML output
160 public function render_fields_action_bar(\mod_data\output\fields_action_bar $actionbar): string {
161 $data = $actionbar->export_for_template($this);
162 $data['title'] = get_string('nofields', 'mod_data');
163 $data['intro'] = get_string('createfields', 'mod_data');
164 $data['noitemsimgurl'] = $this->output->image_url('fields_zero_state', 'mod_data')->out();
165 return $this->render_from_template('mod_data/fields_action_bar', $data);
169 * Renders the fields page footer.
171 * @param manager $manager the instance manager
172 * @return string The HTML output
174 public function render_fields_footer(manager $manager): string {
175 $cm = $manager->get_coursemodule();
176 $pageurl = new moodle_url('/mod/data/templates.php', ['id' => $cm->id]);
177 return $this->render_from_template('mod_data/fields_footer', [
178 'pageurl' => $pageurl->out(false),
183 * Renders the action bar for the view page.
185 * @param \mod_data\output\view_action_bar $actionbar
186 * @return string The HTML output
188 public function render_view_action_bar(\mod_data\output\view_action_bar $actionbar): string {
189 $data = $actionbar->export_for_template($this);
190 return $this->render_from_template('mod_data/view_action_bar', $data);
194 * Renders the action bar for the template page.
196 * @param \mod_data\output\templates_action_bar $actionbar
197 * @return string The HTML output
199 public function render_templates_action_bar(\mod_data\output\templates_action_bar $actionbar): string {
200 $data = $actionbar->export_for_template($this);
201 return $this->render_from_template('mod_data/templates_action_bar', $data);
205 * Renders the action bar for the preset page.
207 * @param \mod_data\output\presets_action_bar $actionbar
208 * @return string The HTML output
210 public function render_presets_action_bar(\mod_data\output\presets_action_bar $actionbar): string {
211 $data = $actionbar->export_for_template($this);
212 return $this->render_from_template('mod_data/presets_action_bar', $data);
216 * Renders the presets table in the preset page.
218 * @param \mod_data\output\presets $presets
219 * @return string The HTML output
221 public function render_presets(\mod_data\output\presets $presets): string {
222 $data = $presets->export_for_template($this);
223 return $this->render_from_template('mod_data/presets', $data);
227 * Renders the default template.
229 * @param \mod_data\output\defaulttemplate $template
230 * @return string The HTML output
232 public function render_defaulttemplate(\mod_data\output\defaulttemplate $template): string {
233 $data = $template->export_for_template($this);
234 return $this->render_from_template($template->get_templatename(), $data);
238 * Renders the action bar for the zero state (no fields created) page.
240 * @param \mod_data\manager $manager The manager instance.
242 * @return string The HTML output
244 public function render_database_zero_state(\mod_data\manager $manager): string {
245 $actionbar = new \mod_data\output\zero_state_action_bar($manager);
246 $data = $actionbar->export_for_template($this);
247 if (empty($data)) {
248 // No actions for the user.
249 $data['title'] = get_string('activitynotready');
250 $data['intro'] = get_string('comebacklater');
251 $data['noitemsimgurl'] = $this->output->image_url('noentries_zero_state', 'mod_data')->out();
252 } else {
253 $data['title'] = get_string('startbuilding', 'mod_data');
254 $data['intro'] = get_string('createactivity', 'mod_data');
255 $data['noitemsimgurl'] = $this->output->image_url('view_zero_state', 'mod_data')->out();
258 return $this->render_from_template('mod_data/zero_state', $data);
262 * Renders the action bar for an empty database view page.
264 * @param \mod_data\manager $manager The manager instance.
266 * @return string The HTML output
268 public function render_empty_database(\mod_data\manager $manager): string {
269 $actionbar = new \mod_data\output\empty_database_action_bar($manager);
270 $data = $actionbar->export_for_template($this);
271 $data['noitemsimgurl'] = $this->output->image_url('view_zero_state', 'mod_data')->out();
273 return $this->render_from_template('mod_data/view_noentries', $data);
277 * Renders the action bar for the zero state (no fields created) page.
279 * @param \mod_data\manager $manager The manager instance.
281 * @return string The HTML output
283 public function render_fields_zero_state(\mod_data\manager $manager): string {
284 $data = [
285 'noitemsimgurl' => $this->output->image_url('fields_zero_state', 'mod_data')->out(),
286 'title' => get_string('nofields', 'mod_data'),
287 'intro' => get_string('createfields', 'mod_data'),
289 if ($manager->can_manage_templates()) {
290 $actionbar = new \mod_data\output\action_bar($manager->get_instance()->id, $this->page->url);
291 $createfieldbutton = $actionbar->get_create_fields();
292 $data['createfieldbutton'] = $createfieldbutton->export_for_template($this);
295 return $this->render_from_template('mod_data/zero_state', $data);
299 * Renders the action bar for the templates zero state (no fields created) page.
301 * @param \mod_data\manager $manager The manager instance.
303 * @return string The HTML output
305 public function render_templates_zero_state(\mod_data\manager $manager): string {
306 $actionbar = new \mod_data\output\zero_state_action_bar($manager);
307 $data = $actionbar->export_for_template($this);
308 $data['title'] = get_string('notemplates', 'mod_data');
309 $data['intro'] = get_string('createtemplates', 'mod_data');
310 $data['noitemsimgurl'] = $this->output->image_url('templates_zero_state', 'mod_data')->out();
312 return $this->render_from_template('mod_data/zero_state', $data);