MBS-10145: add a previewall page

amd/src/management.js

@@ -396,8 +396,10 @@ const wipeModal = (event) => {
         try {
             await wipe();
             reload();
+            return;
         } catch (error) {
             displayException(error);
+            return;
         }
     }).catch((err) => {
         if (err.message) {

amd/src/previewall.js

@@ -0,0 +1,45 @@
+// 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/>.
+
+/**
+ * Elements preview all.
+ *
+ * @module      tiny_elements/previewall
+ * @copyright   2025 Tobias Garske
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+import {add as addToast} from 'core/toast';
+import {get_string as getString} from "core/str";
+
+export const init = async() => {
+    // Add listener to copy all elements as string.
+    document.getElementById("elements_to_clipboard").addEventListener("click", () => {
+        const allelements = document.getElementById("elements_output");
+        navigator.clipboard.writeText(allelements.value)
+        .then(() => {
+            addToast(getString('copysuccess', 'tiny_elements'), {
+                type: 'info',
+            });
+            return;
+        })
+        .catch(() => {
+            addToast(getString('copyfail', 'tiny_elements'), {
+                type: 'warning',
+            });
+            return;
+        });
+    });
+};

classes/exporter.php

@@ -212,7 +212,7 @@ public function export_flavors_and_variants(
             $params
         );
         $this->write_elements($xmlwriter, constants::TABLES['compflavor'], $compflavors);
-        $flavornames = array_unique(array_column($compflavors, 'flavor'));
+        $flavornames = array_unique(array_column($compflavors, 'flavorname'));
 
         $sql = ' = name';
         if (!empty($categoryname)) {

classes/external/wipe.php

@@ -45,6 +45,7 @@ public static function execute_parameters(): external_function_parameters {
 
     /**
      * Implementation of web service tiny_elements_wipe
+     * @param int $contextid
      * @return array
      */
     public static function execute(int $contextid): array {

classes/form/management_editlicense_form.php

@@ -108,6 +108,7 @@ public function definition(): void {
         $mform->removeElement('adddummy');
 
         $mform->setAttributes(['data-formtype' => 'tiny_elements_editlicense']);
+        $mform->disable_form_change_checker();
     }
 
     /**

lang/de/tiny_elements.php

@@ -47,7 +47,10 @@
 $string['componentname_help'] = 'Name der Komponente zur internen Verwendung (auch als Klassenname in CSS)';
 $string['components'] = 'Komponenten';
 $string['content'] = 'Inhalt';
+$string['copyasstring'] = 'Alle Elemente als String in den Zwischenspeicher laden';
+$string['copyfail'] = 'Fehler beim Kopieren aufgetreten';
 $string['copyof'] = 'Kopie von {$a}';
+$string['copysuccess'] = 'Elemente in den Zwischenspeicher kopiert';
 $string['css'] = 'CSS';
 $string['delete'] = 'Element "{$a}" löschen';
 $string['deletewarning'] = 'Sind Sie sicher, dass Sie dieses Element löschen möchten?';
@@ -94,6 +97,8 @@
 $string['js'] = 'JS';
 $string['linktomanagerdesc'] = 'Gehen Sie zu <a href="{$a}">Verwaltung</a>, um Änderungen vorzunehmen.';
 $string['linktomanagername'] = 'Link zur Verwaltung';
+$string['linktopreviewall'] = 'Link zur Vorschau';
+$string['linktopreviewall_desc'] = 'Gehen Sie zu <a href="{$a}">Vorschau</a>, um alle Elements anzusehen und als String zu exportieren.';
 $string['manage'] = 'Verwalten';
 $string['management'] = 'Verwaltung';
 $string['menuitem_elements'] = 'Kurselemente';

lang/en/tiny_elements.php

@@ -45,7 +45,10 @@
 $string['componentname_help'] = 'Name of the component use for internal use (also as a class name in CSS)';
 $string['components'] = 'Components';
 $string['content'] = 'Content';
+$string['copyasstring'] = 'Save all elements to clipboard';
+$string['copyfail'] = 'Error copying elements';
 $string['copyof'] = 'Copy of {$a}';
+$string['copysuccess'] = 'Elements copied to clipboard';
 $string['css'] = 'CSS';
 $string['delete'] = 'Delete item "{$a}"';
 $string['deletewarning'] = 'Are you sure you want to delete this item.';
@@ -91,6 +94,9 @@
 $string['js'] = 'JS';
 $string['linktomanagerdesc'] = 'Go to <a href="{$a}">management page</a> to edit categories, components, flavors and variants.';
 $string['linktomanagername'] = 'Link to management';
+$string['linktopreviewall'] = 'Link to preview';
+$string['linktopreviewall_desc'] = 'Go to <a href="{$a}">preview</a> to watch all elements and export as string.';
+
 $string['manage'] = 'Manage';
 $string['management'] = 'Management';
 $string['menuitem_elements'] = 'Course elements';

preview.php

@@ -53,10 +53,6 @@
 
 $componentdata->code = tiny_elements\local\utils::replace_pluginfile_urls($componentdata->code, true);
 
-if (empty($flavordata)) {
-    echo str_replace('{{FLAVOR}}', '', $componentdata->code);
-} else {
-    echo str_replace('{{FLAVOR}}', $flavordata->name, $componentdata->code);
-}
+echo $componentdata->code;
 
 echo $OUTPUT->footer();

previewall.php

@@ -0,0 +1,96 @@
+<?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/>.
+
+/**
+ * Creates a preview for all elements components in all flavors and variants.
+ *
+ * @package    tiny_elements
+ * @copyright  2024 Tobias Garske, ISB Bayern
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require('../../../../../config.php');
+
+require_login();
+
+$url = new moodle_url('/lib/editor/tiny/plugins/elements/previewall.php', []);
+$PAGE->set_url($url);
+$PAGE->set_context(context_system::instance());
+$PAGE->set_heading($SITE->fullname);
+
+echo $OUTPUT->header();
+
+// Iterate over every category.
+$categorydata = $DB->get_records('tiny_elements_compcat');
+$outputbuffer = '';
+foreach ($categorydata as $category) {
+    $outputbuffer .= '<h2>' . $category->name . '</h2>';
+    $category = $category->name;
+    $componentdata = $DB->get_records('tiny_elements_component', ['categoryname' => $category]);
+    // Iterate over every component.
+    foreach ($componentdata as $component) {
+        $outputbuffer .= '<h3>' . $component->name . '</h3>';
+        // Select corresponding flavors and variants.
+        $sql = "SELECT * FROM {tiny_elements_flavor} fla
+                JOIN {tiny_elements_comp_flavor} comfla ON comfla.flavorname = fla.name
+                WHERE fla.categoryname = :categoryname AND comfla.componentname = :componentname";
+        $allflavors = $DB->get_records_sql($sql, ['categoryname' => $component->categoryname, 'componentname' => $component->name]);
+        $sql = "SELECT * FROM {tiny_elements_variant} var
+                JOIN {tiny_elements_comp_variant} covar ON var.name = covar.variant
+                WHERE covar.componentname = :componentname";
+        $allvariants = $DB->get_records_sql($sql, ['componentname' => $component->name]);
+        // Add default "variant".
+        array_unshift($allvariants, (object) ['name' => '']);
+        foreach ($allflavors as $flavordata) {
+            foreach ($allvariants as $variantdata) {
+                $tmpcomponent = clone $component;
+                $variant = '';
+                if (strlen($variantdata->name) > 0) {
+                    $variant = 'elements-' . $variantdata->name . '-variant';
+                }
+                $varianthtml = '';
+                // Build elements by replacing placeholders.
+                $tmpcomponent->code = str_replace('{{CATEGORY}}', 'elements-' . $category, $tmpcomponent->code);
+                $tmpcomponent->code = str_replace('{{COMPONENT}}', 'elements-' . $tmpcomponent->name, $tmpcomponent->code);
+                $tmpcomponent->code = str_replace(
+                    '{{FLAVOR}}',
+                    'elements-' . $flavordata->name . '-flavor',
+                    $tmpcomponent->code
+                );
+                $tmpcomponent->code = str_replace('{{VARIANTS}}', $variant, $tmpcomponent->code);
+                $tmpcomponent->code = str_replace('{{VARIANTSHTML}}', $varianthtml, $tmpcomponent->code);
+                $tmpcomponent->code = str_replace(
+                    '{{PLACEHOLDER}}',
+                    $flavordata->name . ' ' . $variantdata->name,
+                    $tmpcomponent->code
+                );
+                // Output element.
+                $tmpcomponent->code = tiny_elements\local\utils::replace_pluginfile_urls($tmpcomponent->code, true);
+                $outputbuffer .= $tmpcomponent->code;
+            }
+        }
+    }
+}
+
+// Create button to copy elements to clipboard.
+echo "<button id='elements_to_clipboard' type='button' class='btn btn-primary mb-3'>"
+    . get_string('copyasstring', 'tiny_elements') . "</button>";
+echo "<input type='hidden' id='elements_output' value='$outputbuffer' />";
+$PAGE->requires->js_call_amd('tiny_elements/previewall', 'init');
+
+echo $outputbuffer;
+
+echo $OUTPUT->footer();

settings.php

@@ -51,4 +51,15 @@
             (new moodle_url('/lib/editor/tiny/plugins/elements/management.php'))->out()
         )
     ));
+
+    // Add text with link to previewpage as setting.
+    $settings->add(new admin_setting_description(
+        'tiny_elements/previewall',
+        get_string('linktopreviewall', 'tiny_elements'),
+        get_string(
+            'linktopreviewall_desc',
+            'tiny_elements',
+            (new moodle_url('/lib/editor/tiny/plugins/elements/previewall.php'))->out()
+        )
+    ));
 }

templates/management.mustache

@@ -76,7 +76,7 @@
     <h2>{{#str}} compcat, tiny_elements {{/str}}</h2>
     <div class="row row-cols-8">
         {{#compcats}}
-            <div 
+            <div
                 class="col mb-4 item compcat {{^id}}addcontainer{{/id}}" data-compcat="{{name}}" data-id="{{id}}"
                 data-categoryname="{{categoryname}}"
             >
@@ -154,11 +154,11 @@
     </div>
 
     <div class="row{{^showbulkedit}} hidden{{/showbulkedit}}">
-        <div class="col mb-4"> 
+        <div class="col mb-4">
             <button id="elements_displaynames_flavor_button" class="btn btn-secondary">{{#str}} bulk_edit_flavor_displaynames, tiny_elements {{/str}}</button>
         </div>
     </div>
-    
+
     <h2>{{#str}} components, tiny_elements {{/str}} </h2>
 
     <div class="row row-cols-12">
@@ -207,15 +207,15 @@
     </div>
 
     <div class="row{{^showbulkedit}} hidden{{/showbulkedit}}">
-        <div class="col mb-4"> 
+        <div class="col mb-4">
             <button id="elements_displaynames_button" class="btn btn-secondary">{{#str}} bulk_edit_displaynames, tiny_elements {{/str}}</button>
         </div>
     </div>
 
     <h2>{{#str}} variants, tiny_elements {{/str}}</h2>
     <div class="row row-cols-12">
         {{#variant}}
-            <div 
+            <div
                 class="col mb-4 item variant {{name}} {{#id}}hidden{{/id}}{{^id}}addcontainer{{/id}}" data-categoryname="{{categoryname}}">
                 <div class="card h-100">
                 <div class="card-body">
@@ -246,9 +246,8 @@
     </div>
 
     <div class="row{{^showbulkedit}} hidden{{/showbulkedit}}">
-        <div class="col mb-4"> 
+        <div class="col mb-4">
             <button id="elements_displaynames_variant_button" class="btn btn-secondary">{{#str}} bulk_edit_variant_displaynames, tiny_elements {{/str}}</button>
         </div>
     </div>
-
 </div>

templates/management_preview.mustache

@@ -38,4 +38,4 @@
             </iframe>
         {{/flavors}}
     {{/body}}
-{{/ core/modal }}
+{{/ core/modal }}