Merge branch 'MDL-74956' of https://github.com/paulholden/moodle

lib/db/services.php

@@ -2818,6 +2818,12 @@
         'type'        => 'read',
         'services'    => [MOODLE_OFFICIAL_MOBILE_SERVICE],
     ],
+    'core_reportbuilder_retrieve_report' => [
+        'classname'   => 'core_reportbuilder\external\reports\retrieve',
+        'description' => 'Retrieve custom report content',
+        'type'        => 'read',
+        'services'    => [MOODLE_OFFICIAL_MOBILE_SERVICE],
+    ],
     'core_reportbuilder_view_report' => [
         'classname'   => 'core_reportbuilder\external\reports\view',
         'description' => 'Trigger custom report viewed',

reportbuilder/classes/external/custom_report_data_exporter.php

@@ -0,0 +1,107 @@
+<?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 renderer_base;
+use core\external\exporter;
+use core_reportbuilder\datasource;
+use core_reportbuilder\table\custom_report_table_view;
+
+/**
+ * Custom report data exporter class
+ *
+ * @package     core_reportbuilder
+ * @copyright   2022 Paul Holden <[email protected]>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class custom_report_data_exporter extends exporter {
+
+    /**
+     * Return a list of objects that are related to the exporter
+     *
+     * @return array
+     */
+    protected static function define_related(): array {
+        return [
+            'report' => datasource::class,
+            'page' => 'int',
+            'perpage' => 'int',
+        ];
+    }
+
+    /**
+     * Return the list of additional properties for read structure and export
+     *
+     * @return array[]
+     */
+    protected static function define_other_properties(): array {
+        return [
+            'headers' => [
+                'type' => PARAM_RAW,
+                'multiple' => true,
+            ],
+            'rows' => [
+                'type' => [
+                    'columns' => [
+                        'type' => PARAM_RAW,
+                        'null' => NULL_ALLOWED,
+                        'multiple' => true,
+                    ],
+                ],
+                'multiple' => true,
+            ],
+            'totalrowcount' => ['type' => PARAM_INT],
+        ];
+    }
+
+    /**
+     * Get the additional values to inject while exporting
+     *
+     * @param renderer_base $output
+     * @return array
+     */
+    protected function get_other_values(renderer_base $output): array {
+        global $DB;
+
+        /** @var datasource $report */
+        $report = $this->related['report'];
+
+        $table = custom_report_table_view::create($report->get_report_persistent()->get('id'));
+        $table->setup();
+
+        // Internally the current page is zero-based, but this method expects value plus one.
+        $table->set_page_number($this->related['page'] + 1);
+        $table->query_db($this->related['perpage'], false);
+
+        $tablerows = [];
+        foreach ($table->rawdata as $record) {
+            $tablerows[] = [
+                'columns' => array_values($table->format_row($record)),
+            ];
+        }
+
+        $table->close_recordset();
+
+        return [
+            'headers' => $table->headers,
+            'rows' => $tablerows,
+            'totalrowcount' => $DB->count_records_sql($table->countsql, $table->countparams),
+        ];
+    }
+}

reportbuilder/classes/external/reports/retrieve.php

@@ -0,0 +1,107 @@
+<?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\reports;
+
+use core_reportbuilder\manager;
+use external_api;
+use external_function_parameters;
+use external_single_structure;
+use external_value;
+use external_warnings;
+use core_reportbuilder\permission;
+use core_reportbuilder\external\{custom_report_data_exporter, custom_report_details_exporter};
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once("{$CFG->libdir}/externallib.php");
+
+/**
+ * External method for retrieving custom report content
+ *
+ * @package     core_reportbuilder
+ * @copyright   2022 Paul Holden <[email protected]>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class retrieve extends external_api {
+
+    /**
+     * External method parameters
+     *
+     * @return external_function_parameters
+     */
+    public static function execute_parameters(): external_function_parameters {
+        return new external_function_parameters([
+            'reportid' => new external_value(PARAM_INT, 'Report ID'),
+            'page' => new external_value(PARAM_INT, 'Page number', VALUE_DEFAULT, 0),
+            'perpage' => new external_value(PARAM_INT, 'Reports per page', VALUE_DEFAULT, 10),
+        ]);
+    }
+
+    /**
+     * External method execution
+     *
+     * @param int $reportid
+     * @param int $page
+     * @param int $perpage
+     * @return array
+     */
+    public static function execute(int $reportid, int $page = 0, int $perpage = 10): array {
+        global $PAGE;
+
+        [
+            'reportid' => $reportid,
+            'page' => $page,
+            'perpage' => $perpage,
+        ] = self::validate_parameters(self::execute_parameters(), [
+            'reportid' => $reportid,
+            'page' => $page,
+            'perpage' => $perpage,
+        ]);
+
+        $report = manager::get_report_from_id($reportid);
+        self::validate_context($report->get_context());
+
+        $persistent = $report->get_report_persistent();
+        permission::require_can_view_report($persistent);
+
+        $output = $PAGE->get_renderer('core');
+
+        return [
+            'details' => (array) (new custom_report_details_exporter($persistent))->export($output),
+            'data' => (array) (new custom_report_data_exporter(null, [
+                'report' => $report, 'page' => $page, 'perpage' => $perpage,
+            ]))->export($output),
+            'warnings' => [],
+        ];
+    }
+
+    /**
+     * External method return value
+     *
+     * @return external_single_structure
+     */
+    public static function execute_returns(): external_single_structure {
+        return new external_single_structure([
+            'details' => custom_report_details_exporter::get_read_structure(),
+            'data' => custom_report_data_exporter::get_read_structure(),
+            'warnings' => new external_warnings(),
+        ]);
+    }
+}

reportbuilder/tests/external/custom_report_data_exporter_test.php

@@ -0,0 +1,72 @@
+<?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 advanced_testcase;
+use core_reportbuilder_generator;
+use core_reportbuilder\manager;
+use core_user\reportbuilder\datasource\users;
+
+/**
+ * Unit tests for custom report data exporter
+ *
+ * @package     core_reportbuilder
+ * @covers      \core_reportbuilder\external\custom_report_data_exporter
+ * @copyright   2022 Paul Holden <[email protected]>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class custom_report_data_exporter_test extends advanced_testcase {
+
+    /**
+     * Test exported data structure
+     */
+    public function test_export(): void {
+        global $PAGE;
+
+        $this->resetAfterTest();
+
+        $this->getDataGenerator()->create_user(['firstname' => 'Zoe', 'lastname' => 'Zebra', 'email' => '[email protected]']);
+        $this->getDataGenerator()->create_user(['firstname' => 'Charlie', 'lastname' => 'Carrot', 'email' => '[email protected]']);
+
+        /** @var core_reportbuilder_generator $generator */
+        $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
+
+        $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]);
+        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname'])
+            ->set_many(['heading' => 'Lovely user', 'sortenabled' => true])->update();
+        $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']);
+
+        $reportinstance = manager::get_report_from_persistent($report);
+
+        $exporter = new custom_report_data_exporter(null, ['report' => $reportinstance, 'page' => 0, 'perpage' => 2]);
+        $export = $exporter->export($PAGE->get_renderer('core_reportbuilder'));
+
+        // There are three users (admin plus the two previouly created), but we're paging the first two only.
+        $this->assertEquals(['Lovely user', 'Email address'], $export->headers);
+        $this->assertEquals([
+            [
+                'columns' => ['Admin User', '[email protected]'],
+            ],
+            [
+                'columns' => ['Charlie Carrot', '[email protected]'],
+            ],
+        ], $export->rows);
+        $this->assertEquals(3, $export->totalrowcount);
+    }
+}