forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-75245 tag: implement tags datasource for custom reporting.
Create entity definitions for collections, tags and instances for new report source to provide data for the reportbuilder editor.
- Loading branch information
1 parent
17ee072
commit 065b38f
Showing
7 changed files
with
1,108 additions
and
0 deletions.
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
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
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,119 @@ | ||
| <?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_tag\reportbuilder\datasource; | ||
|
|
||
| use lang_string; | ||
| use core_reportbuilder\datasource; | ||
| use core_reportbuilder\local\entities\user; | ||
| use core_tag\reportbuilder\local\entities\{collection, tag, instance}; | ||
|
|
||
| /** | ||
| * Tags datasource | ||
| * | ||
| * @package core_tag | ||
| * @copyright 2022 Paul Holden <[email protected]> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class tags extends datasource { | ||
|
|
||
| /** | ||
| * Return user friendly name of the report source | ||
| * | ||
| * @return string | ||
| */ | ||
| public static function get_name(): string { | ||
| return get_string('tags', 'core_tag'); | ||
| } | ||
|
|
||
| /** | ||
| * Initialise report | ||
| */ | ||
| protected function initialise(): void { | ||
| $collectionentity = new collection(); | ||
|
|
||
| $collectionalias = $collectionentity->get_table_alias('tag_coll'); | ||
| $this->set_main_table('tag_coll', $collectionalias); | ||
|
|
||
| $this->add_entity($collectionentity); | ||
|
|
||
| // Join tag entity to collection. | ||
| $tagentity = new tag(); | ||
| $tagalias = $tagentity->get_table_alias('tag'); | ||
| $this->add_entity($tagentity | ||
| ->add_join("LEFT JOIN {tag} {$tagalias} ON {$tagalias}.tagcollid = {$collectionalias}.id") | ||
| ); | ||
|
|
||
| // Join instance entity to tag. | ||
| $instanceentity = new instance(); | ||
| $instancealias = $instanceentity->get_table_alias('tag_instance'); | ||
| $this->add_entity($instanceentity | ||
| ->add_joins($tagentity->get_joins()) | ||
| ->add_join("LEFT JOIN {tag_instance} {$instancealias} ON {$instancealias}.tagid = {$tagalias}.id") | ||
| ); | ||
|
|
||
| // Join user entity to represent the tag author. | ||
| $userentity = (new user()) | ||
| ->set_entity_title(new lang_string('tagauthor', 'core_tag')); | ||
| $useralias = $userentity->get_table_alias('user'); | ||
| $this->add_entity($userentity | ||
| ->add_joins($tagentity->get_joins()) | ||
| ->add_join("LEFT JOIN {user} {$useralias} ON {$useralias}.id = {$tagalias}.userid") | ||
| ); | ||
|
|
||
| // Add report elements from each of the entities we added to the report. | ||
| $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 [ | ||
| 'collection:name', | ||
| 'tag:namewithlink', | ||
| 'tag:standard', | ||
| 'instance:context', | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * Return the filters that will be added to the report upon creation | ||
| * | ||
| * @return string[] | ||
| */ | ||
| public function get_default_filters(): array { | ||
| return [ | ||
| 'tag:name', | ||
| 'tag:standard', | ||
| ]; | ||
| } | ||
|
|
||
| /** | ||
| * Return the conditions that will be added to the report upon creation | ||
| * | ||
| * @return string[] | ||
| */ | ||
| public function get_default_conditions(): array { | ||
| return [ | ||
| 'collection:name', | ||
| ]; | ||
| } | ||
| } |
198 changes: 198 additions & 0 deletions
198
tag/classes/reportbuilder/local/entities/collection.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,198 @@ | ||
| <?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_tag\reportbuilder\local\entities; | ||
|
|
||
| use core_tag_collection; | ||
| use lang_string; | ||
| use stdClass; | ||
| use core_reportbuilder\local\entities\base; | ||
| use core_reportbuilder\local\filters\{boolean_select, select}; | ||
| use core_reportbuilder\local\helpers\format; | ||
| use core_reportbuilder\local\report\{column, filter}; | ||
|
|
||
| /** | ||
| * Tag collection entity | ||
| * | ||
| * @package core_tag | ||
| * @copyright 2022 Paul Holden <[email protected]> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class collection extends base { | ||
|
|
||
| /** | ||
| * Database tables that this entity uses and their default aliases | ||
| * | ||
| * @return array | ||
| */ | ||
| protected function get_default_table_aliases(): array { | ||
| return ['tag_coll' => 'tc']; | ||
| } | ||
|
|
||
| /** | ||
| * The default title for this entity | ||
| * | ||
| * @return lang_string | ||
| */ | ||
| protected function get_default_entity_title(): lang_string { | ||
| return new lang_string('tagcollection', 'core_tag'); | ||
| } | ||
|
|
||
| /** | ||
| * 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 { | ||
| $collectionalias = $this->get_table_alias('tag_coll'); | ||
|
|
||
| // Name. | ||
| $columns[] = (new column( | ||
| 'name', | ||
| new lang_string('name'), | ||
| $this->get_entity_name() | ||
| )) | ||
| ->add_joins($this->get_joins()) | ||
| ->set_type(column::TYPE_TEXT) | ||
| ->add_fields("{$collectionalias}.name, {$collectionalias}.component, {$collectionalias}.isdefault, | ||
| {$collectionalias}.id") | ||
| ->set_is_sortable(true) | ||
| ->add_callback(static function(?string $name, stdClass $collection): string { | ||
| return core_tag_collection::display_name($collection); | ||
| }); | ||
|
|
||
| // Default. | ||
| $columns[] = (new column( | ||
| 'default', | ||
| new lang_string('defautltagcoll', 'core_tag'), | ||
| $this->get_entity_name() | ||
| )) | ||
| ->add_joins($this->get_joins()) | ||
| ->set_type(column::TYPE_BOOLEAN) | ||
| ->add_fields("{$collectionalias}.isdefault") | ||
| ->set_is_sortable(true) | ||
| ->add_callback([format::class, 'boolean_as_text']); | ||
|
|
||
| // Component. | ||
| $columns[] = (new column( | ||
| 'component', | ||
| new lang_string('component', 'core_tag'), | ||
| $this->get_entity_name() | ||
| )) | ||
| ->add_joins($this->get_joins()) | ||
| ->set_type(column::TYPE_TEXT) | ||
| ->add_fields("{$collectionalias}.component") | ||
| ->set_is_sortable(true); | ||
|
|
||
| // Searchable. | ||
| $columns[] = (new column( | ||
| 'searchable', | ||
| new lang_string('searchable', 'core_tag'), | ||
| $this->get_entity_name() | ||
| )) | ||
| ->add_joins($this->get_joins()) | ||
| ->set_type(column::TYPE_BOOLEAN) | ||
| ->add_fields("{$collectionalias}.searchable") | ||
| ->set_is_sortable(true) | ||
| ->add_callback([format::class, 'boolean_as_text']); | ||
|
|
||
| // Custom URL. | ||
| $columns[] = (new column( | ||
| 'customurl', | ||
| new lang_string('url'), | ||
| $this->get_entity_name() | ||
| )) | ||
| ->add_joins($this->get_joins()) | ||
| ->set_type(column::TYPE_TEXT) | ||
| ->add_fields("{$collectionalias}.customurl") | ||
| ->set_is_sortable(true); | ||
|
|
||
| return $columns; | ||
| } | ||
|
|
||
| /** | ||
| * Return list of all available filters | ||
| * | ||
| * @return filter[] | ||
| */ | ||
| protected function get_all_filters(): array { | ||
| $collectionalias = $this->get_table_alias('tag_coll'); | ||
|
|
||
| // Name. | ||
| $filters[] = (new filter( | ||
| select::class, | ||
| 'name', | ||
| new lang_string('name'), | ||
| $this->get_entity_name(), | ||
| "{$collectionalias}.id" | ||
| )) | ||
| ->add_joins($this->get_joins()) | ||
| ->set_options_callback(static function(): array { | ||
| global $DB; | ||
|
|
||
| $collections = $DB->get_records('tag_coll', [], 'sortorder', 'id, name, component, isdefault'); | ||
| return array_map(static function(stdClass $collection): string { | ||
| return core_tag_collection::display_name($collection); | ||
| }, $collections); | ||
| }); | ||
|
|
||
| // Default. | ||
| $filters[] = (new filter( | ||
| boolean_select::class, | ||
| 'default', | ||
| new lang_string('defautltagcoll', 'core_tag'), | ||
| $this->get_entity_name(), | ||
| "{$collectionalias}.isdefault" | ||
| )) | ||
| ->add_joins($this->get_joins()); | ||
|
|
||
| // Searchable. | ||
| $filters[] = (new filter( | ||
| boolean_select::class, | ||
| 'searchable', | ||
| new lang_string('searchable', 'core_tag'), | ||
| $this->get_entity_name(), | ||
| "{$collectionalias}.searchable" | ||
| )) | ||
| ->add_joins($this->get_joins()); | ||
|
|
||
| return $filters; | ||
| } | ||
| } |
Oops, something went wrong.