mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-80063 roles: implement roles datasource for custom reporting.
Comprised of existing context, role & user entities to provide all report data.
- Loading branch information
1 parent
38a3310
commit 54a51e8
Showing
5 changed files
with
541 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| <?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_role\reportbuilder\datasource; | ||
|
|
||
| use core\reportbuilder\local\entities\context; | ||
| use core_reportbuilder\datasource; | ||
| use core_reportbuilder\local\entities\user; | ||
| use core_role\reportbuilder\local\entities\{role, role_assignment}; | ||
|
|
||
| /** | ||
| * Roles datasource | ||
| * | ||
| * @package core_role | ||
| * @copyright 2024 Paul Holden <paulh@moodle.com> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class roles extends datasource { | ||
|
|
||
| /** | ||
| * Return user friendly name of the report source | ||
| * | ||
| * @return string | ||
| */ | ||
| public static function get_name(): string { | ||
| return get_string('roles', 'core_role'); | ||
| } | ||
|
|
||
| /** | ||
| * Initialise report | ||
| */ | ||
| protected function initialise(): void { | ||
| $contextentity = new context(); | ||
| $contextalias = $contextentity->get_table_alias('context'); | ||
|
|
||
| $roleentity = new role(); | ||
| $rolealias = $roleentity->get_table_alias('role'); | ||
|
|
||
| // Role table. | ||
| $this->add_entity($roleentity->set_table_alias('context', $contextalias)); | ||
| $this->set_main_table('role', $rolealias); | ||
|
|
||
| // Join role assignments. | ||
| $roleassignmententity = new role_assignment(); | ||
| $roleassignmentalias = $roleassignmententity->get_table_alias('role_assignments'); | ||
| $this->add_entity($roleassignmententity); | ||
| $this->add_join("JOIN {role_assignments} {$roleassignmentalias} ON {$roleassignmentalias}.roleid = {$rolealias}.id"); | ||
|
|
||
| // Join context. | ||
| $this->add_entity($contextentity); | ||
| $this->add_join("LEFT JOIN {context} {$contextalias} ON {$contextalias}.id = {$roleassignmentalias}.contextid"); | ||
|
|
||
| // Join user. | ||
| $userentity = new user(); | ||
| $useralias = $userentity->get_table_alias('user'); | ||
| $this->add_entity($userentity | ||
| ->add_join("LEFT JOIN {user} {$useralias} ON {$useralias}.id = {$roleassignmentalias}.userid")); | ||
|
|
||
| $this->add_all_from_entities(); | ||
| } | ||
|
|
||
| /** | ||
| * Return the columns that will be added to the report upon creation | ||
| * | ||
| * @return string[] | ||
| */ | ||
| public function get_default_columns(): array { | ||
| return [ | ||
| 'context:link', | ||
| 'role:originalname', | ||
| 'user:fullnamewithlink', | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * Return the column sorting that will be added to the report upon creation | ||
| * | ||
| * @return int[] | ||
| */ | ||
| public function get_default_column_sorting(): array { | ||
| return [ | ||
| 'context:link' => SORT_ASC, | ||
| 'role:originalname' => SORT_ASC, | ||
| 'user:fullnamewithlink' => SORT_ASC, | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * Return the filters that will be added to the report upon creation | ||
| * | ||
| * @return string[] | ||
| */ | ||
| public function get_default_filters(): array { | ||
| return [ | ||
| 'context:level', | ||
| 'role:name', | ||
| 'user:fullname', | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * Return the conditions that will be added to the report upon creation | ||
| * | ||
| * @return string[] | ||
| */ | ||
| public function get_default_conditions(): array { | ||
| return []; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
143 changes: 143 additions & 0 deletions
143
admin/roles/classes/reportbuilder/local/entities/role_assignment.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| <?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_role\reportbuilder\local\entities; | ||
|
|
||
| use lang_string; | ||
| use core_reportbuilder\local\entities\base; | ||
| use core_reportbuilder\local\filters\date; | ||
| use core_reportbuilder\local\helpers\format; | ||
| use core_reportbuilder\local\report\{column, filter}; | ||
|
|
||
| /** | ||
| * Role assignment entity | ||
| * | ||
| * @package core_role | ||
| * @copyright 2024 Paul Holden <paulh@moodle.com> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class role_assignment extends base { | ||
|
|
||
| /** | ||
| * Database tables that this entity uses | ||
| * | ||
| * @return string[] | ||
| */ | ||
| protected function get_default_tables(): array { | ||
| return [ | ||
| 'role_assignments', | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * The default title for this entity | ||
| * | ||
| * @return lang_string | ||
| */ | ||
| protected function get_default_entity_title(): lang_string { | ||
| return new lang_string('roleassignment', 'core_role'); | ||
| } | ||
|
|
||
| /** | ||
| * Initialise the entity | ||
| * | ||
| * @return base | ||
| */ | ||
| public function initialise(): base { | ||
| $columns = $this->get_all_columns(); | ||
| foreach ($columns as $column) { | ||
| $this->add_column($column); | ||
| } | ||
|
|
||
| // All the filters defined by the entity can also be used as conditions. | ||
| $filters = $this->get_all_filters(); | ||
| foreach ($filters as $filter) { | ||
| $this | ||
| ->add_filter($filter) | ||
| ->add_condition($filter); | ||
| } | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Returns list of all available columns | ||
| * | ||
| * @return column[] | ||
| */ | ||
| protected function get_all_columns(): array { | ||
| $raalias = $this->get_table_alias('role_assignments'); | ||
|
|
||
| // Time modified column. | ||
| $columns[] = (new column( | ||
| 'timemodified', | ||
| new lang_string('timemodified', 'core_reportbuilder'), | ||
| $this->get_entity_name() | ||
| )) | ||
| ->add_joins($this->get_joins()) | ||
| ->set_type(column::TYPE_TIMESTAMP) | ||
| ->add_field("{$raalias}.timemodified") | ||
| ->set_is_sortable(true) | ||
| ->set_callback([format::class, 'userdate']); | ||
|
|
||
| // Component column. | ||
| $columns[] = (new column( | ||
| 'component', | ||
| new lang_string('plugin'), | ||
| $this->get_entity_name() | ||
| )) | ||
| ->add_joins($this->get_joins()) | ||
| ->set_type(column::TYPE_TEXT) | ||
| ->add_field("{$raalias}.component") | ||
| ->set_is_sortable(true); | ||
|
|
||
| // Item ID column. | ||
| $columns[] = (new column( | ||
| 'itemid', | ||
| new lang_string('pluginitemid'), | ||
| $this->get_entity_name() | ||
| )) | ||
| ->add_joins($this->get_joins()) | ||
| ->set_type(column::TYPE_INTEGER) | ||
| ->add_field("{$raalias}.itemid") | ||
| ->set_is_sortable(true); | ||
|
|
||
| return $columns; | ||
| } | ||
|
|
||
| /** | ||
| * Return list of all available filters | ||
| * | ||
| * @return filter[] | ||
| */ | ||
| protected function get_all_filters(): array { | ||
| $raalias = $this->get_table_alias('role_assignments'); | ||
|
|
||
| // Time modified filter. | ||
| $filters[] = (new filter( | ||
| date::class, | ||
| 'timemodified', | ||
| new lang_string('timemodified', 'core_reportbuilder'), | ||
| $this->get_entity_name(), | ||
| "{$raalias}.timemodified" | ||
| )) | ||
| ->add_joins($this->get_joins()); | ||
|
|
||
| return $filters; | ||
| } | ||
| } |
Oops, something went wrong.