Add filter queries feature

Remove unnecessary comma

Language string

Author: sharpchi

amd/build/reportsearch.min.js

@@ -0,0 +1,66 @@
+// 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/>.
+
+/**
+ * Filter queries by search term.
+ *
+ * @module     report_customsql/reportsearch
+ * @copyright  2025 Southampton Solent University {@link https://www.solent.ac.uk}
+ * @author     Mark Sharp <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+import {updateExpandCollapseAll} from 'report_customsql/reportcategories';
+
+export const init = () => {
+    const searchBox = document.querySelector('#csl_search');
+    if (!searchBox) {
+        return;
+    }
+    searchBox.addEventListener('keyup', doSearch);
+    const clearbutton = document.querySelector('#csl_clearsearch');
+    if (clearbutton) {
+        clearbutton.addEventListener('click', () => {
+            searchBox.value = '';
+            doSearch({currentTarget: searchBox});
+        });
+    }
+};
+
+const doSearch = (e) => {
+    const searchBox = e.currentTarget;
+    const searchTerm = searchBox.value.toLowerCase();
+    const queries = document.querySelectorAll('.csql_query');
+    queries.forEach(query => {
+        const title = query.querySelector('.csql_displayname').textContent.toLowerCase();
+        if (title.includes(searchTerm)) {
+            query.style.display = '';
+        } else {
+            query.style.display = 'none';
+        }
+    });
+    document.querySelectorAll('.csql_category').forEach(cat => {
+        const hasVisibleQueries = Array.from(cat.querySelectorAll('.csql_query')).some(q => q.style.display !== 'none');
+        if (hasVisibleQueries) {
+            cat.classList.remove('csql_categoryhidden');
+            cat.classList.add('csql_categoryshown');
+        } else {
+            cat.classList.remove('csql_categoryshown');
+            cat.classList.add('csql_categoryhidden');
+        }
+    });
+    // Update the expand/collapse all button state.
+    updateExpandCollapseAll();
+};
+

amd/build/reportsearch.min.js.map

@@ -176,6 +176,7 @@
 $string['runquery'] = 'Run query';
 $string['schedulednote'] = 'These queries are automatically run on the first day of each week or month, to report on the previous week or month. These links let you view the results that has already been accumulated.';
 $string['scheduledqueries'] = 'Scheduled queries';
+$string['searchqueries'] = 'Search queries...';
 $string['showonlythiscategory'] = 'Show only {$a}';
 $string['startofweek'] = 'Day to run weekly reports';
 $string['startofweek_default'] = 'Use site calendar start of week ({$a})';

amd/src/reportsearch.js

@@ -49,8 +49,8 @@
     }
 }}
 
-<p>
-    <a href="{{url}}">{{{displayname}}}</a> {{{timenote}}}
+<p class="csql_query">
+    <a href="{{url}}" class="csql_displayname">{{{displayname}}}</a> {{{timenote}}}
     {{#canedit}}
         <span class="admin_note">{{#str}}availableto, report_customsql, {{capability}} {{/str}}</span>
         {{#editbutton}}

lang/en/report_customsql.php

@@ -35,6 +35,7 @@
       "categories": []
     }
 }}
+{{>report_customsql/search_queries}}
 {{#expandable}}
     {{>report_customsql/expand_collapse_link}}
 {{/expandable}}
@@ -51,7 +52,7 @@
 {{{managecategorybutton}}}
 
 {{#js}}
-    require(['report_customsql/reportcategories'], function(reportcategories) {
+    require(['report_customsql/reportcategories', 'report_customsql/reportsearch'], function(reportcategories, reportsearch) {
         reportcategories.init();
     });
 {{/js}}

templates/category_query.mustache

@@ -0,0 +1,38 @@
+{{!
+    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/>.
+}}
+{{!
+    @template report_customsql/search_queries
+
+    Adds search form to filter queries
+
+    Example context (json):
+    {
+    }
+}}
+<div class="input-group mb-3">
+    <input type="text" id="csl_search" class="form-control" placeholder="{{#str}} searchqueries, report_customsql {{/str}}">
+    <span class="input-group-append">
+            <button class="btn btn-secondary border-left-0 border" type="button" id="csl_clearsearch">
+            <i class="fa fa-times"></i>
+        </button>
+    </span>
+</div>
+{{#js}}
+    require(['report_customsql/reportsearch'], function(reportsearch) {
+        reportsearch.init();
+    });
+{{/js}}