MDL-71070 report_configlog: convert report to system report.

Convert to system report API provided by Report builder. The entity
defines the columns and filters, which are used by the system
report class we have created.

report/configlog/classes/local/entities/config_change.php

@@ -0,0 +1,207 @@
+<?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/>.
+
+namespace report_configlog\local\entities;
+
+use lang_string;
+use core_reportbuilder\local\entities\base;
+use core_reportbuilder\local\helpers\format;
+use core_reportbuilder\local\report\column;
+use core_reportbuilder\local\report\filter;
+use core_reportbuilder\local\filters\date;
+use core_reportbuilder\local\filters\text;
+
+/**
+ * Config change entity class implementation
+ *
+ * Defines all the columns and filters that can be added to reports that use this entity.
+ *
+ * @package    report_configlog
+ * @copyright  2020 Paul Holden <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class config_change extends base {
+
+    /**
+     * Database tables that this entity uses and their default aliases
+     *
+     * @return array
+     */
+    protected function get_default_table_aliases(): array {
+        return ['config_log' => 'cl'];
+    }
+
+    /**
+     * The default title for this entity
+     *
+     * @return lang_string
+     */
+    protected function get_default_entity_title(): lang_string {
+        return new lang_string('entityconfigchange', 'report_configlog');
+    }
+
+    /**
+     * Initialize the entity
+     *
+     * @return base
+     */
+    public function initialise(): base {
+        $columns = $this->get_all_columns();
+        foreach ($columns as $column) {
+            $this->add_column($column);
+        }
+
+        $filters = $this->get_all_filters();
+        foreach ($filters as $filter) {
+            $this->add_filter($filter);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Returns list of all available columns
+     *
+     * @return column[]
+     */
+    protected function get_all_columns(): array {
+        $tablealias = $this->get_table_alias('config_log');
+
+        // Time modified column.
+        $columns[] = (new column(
+            'timemodified',
+            new lang_string('timemodified', 'report_configlog'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TIMESTAMP)
+            ->add_fields("{$tablealias}.timemodified")
+            ->set_is_sortable(true)
+            ->add_callback([format::class, 'userdate']);
+
+        // Plugin column.
+        $columns[] = (new column(
+            'plugin',
+            new lang_string('plugin', 'report_configlog'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TEXT)
+            ->add_field("{$tablealias}.plugin")
+            ->set_is_sortable(true)
+            ->add_callback(static function(?string $plugin): string {
+                return $plugin ?? 'core';
+            });
+
+        // Setting column.
+        $columns[] = (new column(
+            'setting',
+            new lang_string('setting', 'report_configlog'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TEXT)
+            ->add_field("{$tablealias}.name")
+            ->set_is_sortable(true);
+
+        // New value column.
+        $columns[] = (new column(
+            'newvalue',
+            new lang_string('valuenew', 'report_configlog'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TEXT)
+            ->add_field("{$tablealias}.value")
+            ->set_is_sortable(true)
+            ->add_callback(static function(?string $value): string {
+                return format_text($value, FORMAT_PLAIN);
+            });
+
+        // Old value column.
+        $columns[] = (new column(
+            'oldvalue',
+            new lang_string('valueold', 'report_configlog'),
+            $this->get_entity_name()
+        ))
+            ->add_joins($this->get_joins())
+            ->set_type(column::TYPE_TEXT)
+            ->add_field("{$tablealias}.oldvalue")
+            ->set_is_sortable(true)
+            ->add_callback(static function(?string $oldvalue): string {
+                return format_text($oldvalue, FORMAT_PLAIN);
+            });
+
+        return $columns;
+    }
+
+    /**
+     * Return list of all available filters
+     *
+     * @return filter[]
+     */
+    protected function get_all_filters(): array {
+        global $DB;
+
+        $tablealias = $this->get_table_alias('config_log');
+
+        // Time modified filter.
+        $filters[] = (new filter(
+            date::class,
+            'timemodified',
+            new lang_string('timemodified', 'report_configlog'),
+            $this->get_entity_name(),
+            "{$tablealias}.timemodified"
+        ))
+            ->add_joins($this->get_joins())
+            ->set_limited_operators([
+                date::DATE_ANY,
+                date::DATE_RANGE,
+            ]);
+
+        // Setting filter.
+        $filters[] = (new filter(
+            text::class,
+            'setting',
+            new lang_string('setting', 'report_configlog'),
+            $this->get_entity_name(),
+            "{$tablealias}.name"
+        ))
+            ->add_joins($this->get_joins());
+
+        // New value filter.
+        $filters[] = (new filter(
+            text::class,
+            'value',
+            new lang_string('valuenew', 'report_configlog'),
+            $this->get_entity_name(),
+            "{$tablealias}.value"
+        ))
+            ->add_joins($this->get_joins());
+
+        // Old value filter.
+        $filters[] = (new filter(
+            text::class,
+            'oldvalue',
+            new lang_string('valueold', 'report_configlog'),
+            $this->get_entity_name(),
+            "{$tablealias}.oldvalue"
+        ))
+            ->add_joins($this->get_joins());
+
+        return $filters;
+    }
+}

report/configlog/classes/local/systemreports/config_changes.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/>.
+
+namespace report_configlog\local\systemreports;
+
+use context_system;
+use report_configlog\local\entities\config_change as config_change_entity;
+use core_reportbuilder\system_report;
+use core_reportbuilder\local\entities\user as user_entity;
+use stdClass;
+
+/**
+ * Config changes system report class implementation
+ *
+ * @package    report_configlog
+ * @copyright  2020 Paul Holden <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class config_changes extends system_report {
+
+    /**
+     * Initialise report, we need to set the main table, load our entities and set columns/filters
+     */
+    protected function initialise(): void {
+        // Our main entity, it contains all of the column definitions that we need.
+        $entitymain = new config_change_entity();
+        $entitymainalias = $entitymain->get_table_alias('config_log');
+
+        $this->set_main_table('config_log', $entitymainalias);
+        $this->add_entity($entitymain);
+
+        // We can join the "user" entity to our "main" entity using standard SQL JOIN.
+        $entityuser = new user_entity();
+        $entityuseralias = $entityuser->get_table_alias('user');
+        $this->add_entity($entityuser
+            ->add_join("LEFT JOIN {user} {$entityuseralias} ON {$entityuseralias}.id = {$entitymainalias}.userid")
+        );
+
+        // Now we can call our helper methods to add the content we want to include in the report.
+        $this->add_columns();
+        $this->add_filters();
+
+        // Set if report can be downloaded.
+        $this->set_downloadable(true, get_string('pluginname', 'report_configlog'));
+    }
+
+    /**
+     * Validates access to view this report
+     *
+     * @return bool
+     */
+    protected function can_view(): bool {
+        return has_capability('moodle/site:config', context_system::instance());
+    }
+
+    /**
+     * Adds the columns we want to display in the report
+     *
+     * They are all provided by the entities we previously added in the {@see initialise} method, referencing each by their
+     * unique identifier
+     */
+    protected function add_columns(): void {
+        $columns = [
+            'config_change:timemodified',
+            'user:fullnamewithlink',
+            'config_change:plugin',
+            'config_change:setting',
+            'config_change:newvalue',
+            'config_change:oldvalue',
+        ];
+
+        $this->add_columns_from_entities($columns);
+
+        // Default sorting.
+        $this->set_initial_sort_column('config_change:timemodified', SORT_DESC);
+
+        // Custom callback to show 'CLI or install' in fullname column when there is no user.
+        if ($column = $this->get_column('user:fullnamewithlink')) {
+            $column->add_callback(static function(string $fullname, stdClass $row): string {
+                return $fullname ?: get_string('usernone', 'report_configlog');
+            });
+        }
+    }
+
+    /**
+     * Adds the filters we want to display in the report
+     *
+     * They are all provided by the entities we previously added in the {@see initialise} method, referencing each by their
+     * unique identifier
+     */
+    protected function add_filters(): void {
+        $filters = [
+            'config_change:setting',
+            'config_change:value',
+            'config_change:oldvalue',
+            'user:fullname',
+            'config_change:timemodified',
+        ];
+
+        $this->add_filters_from_entities($filters);
+    }
+}