MDL-70794 reportbuilder: output components and classes.

This change contains most of the output components required for
reports such as exporters, templates, AMD modules.

Also included are classes within the component table namespace which
are required for extending the dynamic table API.

lang/en/reportbuilder.php

@@ -22,6 +22,11 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+$string['actions'] = 'Actions';
+$string['apply'] = 'Apply';
+$string['errorreportaccess'] = 'You can not view this report';
+$string['errorsourceinvalid'] = 'Could not find valid report source';
+$string['errorsourceunavailable'] = 'Report source is not available';
 $string['filtercontains'] = 'Contains';
 $string['filterdatefrom'] = 'Date from';
 $string['filterdateto'] = 'Date to';
@@ -43,5 +48,5 @@
 $string['filtersapplied'] = 'Filters applied';
 $string['filtersreset'] = 'Filters reset';
 $string['filterstartswith'] = 'Starts with';
-$string['privacy:metadata:preference:reportfilter'] = 'The stored report filters for this user';
+$string['resetall'] = 'Reset all';
 $string['selectcourses'] = 'Select courses';

reportbuilder/amd/src/local/events.js

@@ -0,0 +1,29 @@
+// 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/>.
+
+/**
+ * Report builder events
+ *
+ * @module      core_reportbuilder/local/events
+ * @package     core_reportbuilder
+ * @copyright   2021 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+export default {
+    // Trigger table reloading, passing optional `preservePagination` details argument can be used to
+    // define whether current pagination should be preserved (default is false, i.e. reload first page.)
+    tableReload: 'core_reportbuilder_table_reload',
+};

reportbuilder/amd/src/local/selectors.js

@@ -0,0 +1,34 @@
+// 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/>.
+
+/**
+ * Report builder selectors
+ *
+ * @module      core_reportbuilder/local/selectors
+ * @package     core_reportbuilder
+ * @copyright   2021 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+const SELECTORS = {
+    regions: {
+        systemReport: '[data-region="core_reportbuilder/system-report"]',
+        filtersForm: '[data-region="filters-form"]',
+    },
+};
+
+SELECTORS.forSystemReport = reportId => `${SELECTORS.regions.systemReport}[data-reportid="${reportId}"]`;
+
+export default SELECTORS;

reportbuilder/amd/src/report.js

@@ -0,0 +1,49 @@
+// 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/>.
+
+/**
+ * Report builder report management
+ *
+ * @module      core_reportbuilder/report
+ * @package     core_reportbuilder
+ * @copyright   2021 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+import * as reportEvents from 'core_reportbuilder/local/events';
+import * as reportSelectors from 'core_reportbuilder/local/selectors';
+import {setPageNumber, refreshTableContent} from 'core_table/dynamic';
+import * as tableSelectors from 'core_table/local/dynamic/selectors';
+
+/**
+ * Initialise module
+ *
+ * @param {Number} reportId
+ */
+export const init = reportId => {
+    // Listen for the table reload event.
+    document.addEventListener(reportEvents.tableReload, async(event) => {
+        const triggerElement = event.target.closest(reportSelectors.forSystemReport(reportId));
+        if (triggerElement === null) {
+            return;
+        }
+
+        const tableRoot = triggerElement.querySelector(tableSelectors.main.region);
+        const pageNumber = event.detail?.preservePagination ? null : 1;
+
+        await setPageNumber(tableRoot, pageNumber, false)
+            .then(refreshTableContent);
+    });
+};

reportbuilder/classes/external/system_report_exporter.php

@@ -0,0 +1,115 @@
+<?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/>.
+
+declare(strict_types=1);
+
+namespace core_reportbuilder\external;
+
+use core\external\persistent_exporter;
+use core_reportbuilder\form\filter;
+use core_reportbuilder\local\models\report;
+use core_reportbuilder\local\report\base;
+use core_reportbuilder\table\system_report_table;
+use core_reportbuilder\table\system_report_table_filterset;
+use core_reportbuilder\table\system_report_table_parameters_filter;
+use renderer_base;
+
+/**
+ * Report exporter class
+ *
+ * @package     core_reportbuilder
+ * @copyright   2020 Paul Holden <paulh@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class system_report_exporter extends persistent_exporter {
+
+    /**
+     * Return the name of the class we are exporting
+     *
+     * @return string
+     */
+    protected static function define_class(): string {
+        return report::class;
+    }
+
+    /**
+     * Return a list of objects that are related to the persistent
+     *
+     * @return array
+     */
+    protected static function define_related(): array {
+        return [
+            'source' => base::class,
+            'parameters' => 'string',
+        ];
+    }
+
+    /**
+     * Return a list of additional properties used only for display
+     *
+     * @return array
+     */
+    protected static function define_other_properties(): array {
+        return [
+            'table' => ['type' => PARAM_RAW],
+            'parameters' => ['type' => PARAM_RAW],
+            'filterspresent' => ['type' => PARAM_BOOL],
+            'filtersform' => [
+                'type' => PARAM_RAW,
+                'optional' => true,
+            ],
+        ];
+    }
+
+    /**
+     * Get additional values to inject while exporting
+     *
+     * @uses \core_reportbuilder\output\renderer::render_system_report_table()
+     *
+     * @param renderer_base $output
+     * @return array
+     */
+    protected function get_other_values(renderer_base $output): array {
+        /** @var base $source */
+        $source = $this->related['source'];
+
+        /** @var array $parameters */
+        $parameters = $this->related['parameters'];
+
+        $filterset = new system_report_table_filterset();
+        $filterset->add_filter(new system_report_table_parameters_filter('parameters', null, [$parameters]));
+
+        $table = system_report_table::create($this->persistent->get('id'), (array) json_decode($parameters, true));
+        $table->set_filterset($filterset);
+
+        // Generate filters form if report contains any filters.
+        $filterspresent = !empty($source->get_filters());
+        if ($filterspresent) {
+            $filtersform = new filter(null, null, 'post', '', [], true, [
+                'reportid' => $this->persistent->get('id'),
+                'parameters' => $parameters,
+            ]);
+            $filtersform->set_data_for_dynamic_submission();
+        }
+
+        return [
+            'table' => $output->render($table),
+            'parameters' => $this->related['parameters'],
+            'filterspresent' => $filterspresent,
+            'filtersform' => $filterspresent ? $filtersform->render() : '',
+        ];
+    }
+}