L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Sara Arjona
2026-03-06 09:03:41 +07:00
committed by Huong Nguyen
parent 062377e7dc 0b5a3d3350
commit fd32880e0b
10 changed files with 247 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.upgradenotes/MDL-87451-2025121216105683.yml
+13
View File
@@ -0,0 +1,13 @@
issueNumber: MDL-87451
notes:
core_reportbuilder:
- message: >-
The following methods now support both string or entity instance types
for parameters referring to entities by name, which prevents lookups of
instances which most report sources will already have:
- `add_all_from_[entity|entities]()`
- `add_[columns|filters|conditions]_from_entity()`
type: changed
public/badges/classes/reportbuilder/datasource/badges.php
+3 -7
View File
@@ -88,13 +88,9 @@ class badges extends datasource {
);
// Add report elements from each of the entities we added to the report.
$this->add_all_from_entity($badgeentity->get_entity_name());
$this->add_all_from_entity($tagentity->get_entity_name(), ['name', 'namewithlink'], ['name'], ['name']);
$this->add_all_from_entities([
$badgeissuedentity->get_entity_name(),
$userentity->get_entity_name(),
$courseentity->get_entity_name(),
]);
$this->add_all_from_entity($badgeentity);
$this->add_all_from_entity($tagentity, ['name', 'namewithlink'], ['name'], ['name']);
$this->add_all_from_entities([$badgeissuedentity, $userentity, $courseentity]);
}
/**
public/badges/classes/reportbuilder/datasource/users.php
+9 -9
View File
@@ -99,15 +99,15 @@ class users extends datasource {
]));
// Add report elements from each of the entities we added to the report.
$this->add_all_from_entities([
$userentity->get_entity_name(),
$badgeissuedentity->get_entity_name(),
$badgeentity->get_entity_name(),
]);
$this->add_all_from_entity($tagentity->get_entity_name(), ['name', 'namewithlink'], ['name'], ['name']);
$this->add_all_from_entity($courseentity->get_entity_name());
$this->add_all_from_entity($cohortentity->get_entity_name(), ['name', 'idnumber', 'description', 'customfield*'],
['cohortselect', 'name', 'idnumber', 'customfield*'], ['cohortselect', 'name', 'idnumber', 'customfield*']);
$this->add_all_from_entities([$userentity, $badgeissuedentity, $badgeentity]);
$this->add_all_from_entity($tagentity, ['name', 'namewithlink'], ['name'], ['name']);
$this->add_all_from_entity($courseentity);
$this->add_all_from_entity(
$cohortentity,
['name', 'idnumber', 'description', 'customfield*'],
['cohortselect', 'name', 'idnumber', 'customfield*'],
['cohortselect', 'name', 'idnumber', 'customfield*'],
);
}
/**
public/blog/classes/reportbuilder/datasource/blogs.php
+6 -13
View File
@@ -105,24 +105,17 @@ class blogs extends datasource {
->add_join("LEFT JOIN {user} {$commenteralias} ON {$commenteralias}.id = {$commentalias}.userid"));
// Add report elements from each of the entities we added to the report.
$this->add_all_from_entity($blogentity->get_entity_name());
$this->add_all_from_entity($blogentity);
$this->add_all_from_entity(
$fileentity->get_entity_name(),
$fileentity,
['name', 'size', 'type', 'timecreated'],
['name', 'size', 'timecreated'],
['name', 'size', 'timecreated'],
);
$this->add_all_from_entity($tagentity->get_entity_name(), ['name', 'namewithlink'], ['name'], ['name']);
$this->add_all_from_entities([
$authorentity->get_entity_name(),
$courseentity->get_entity_name(),
]);
$this->add_all_from_entity($commententity->get_entity_name(), ['content', 'timecreated'], ['timecreated'], ['timecreated']);
$this->add_all_from_entity($commenterentity->get_entity_name());
$this->add_all_from_entity($tagentity, ['name', 'namewithlink'], ['name'], ['name']);
$this->add_all_from_entities([$authorentity, $courseentity]);
$this->add_all_from_entity($commententity, ['content', 'timecreated'], ['timecreated'], ['timecreated']);
$this->add_all_from_entity($commenterentity);
}
/**
public/course/classes/reportbuilder/datasource/courses.php
+3 -8
View File
@@ -87,20 +87,15 @@ class courses extends datasource {
AND {$filesalias}.filename != '.'"));
// Add all columns/filters/conditions from entities to be available in custom reports.
$this->add_all_from_entities([
$coursecatentity->get_entity_name(),
$courseentity->get_entity_name(),
]);
$this->add_all_from_entities([$coursecatentity, $courseentity]);
$this->add_all_from_entity(
$tagentity->get_entity_name(),
$tagentity,
['name', 'namewithlink'],
['name'],
['name'],
);
$this->add_all_from_entity(
$fileentity->get_entity_name(),
$fileentity,
['name', 'size', 'type', 'timecreated'],
['name', 'size', 'timecreated'],
['name', 'size', 'timecreated'],
public/course/classes/reportbuilder/datasource/participants.php
+14 -15
View File
@@ -152,22 +152,21 @@ class participants extends datasource {
// Add all entities columns/filters/conditions.
$this->add_all_from_entities([
$coursecatentity->get_entity_name(),
$courseentity->get_entity_name(),
$enrolentity->get_entity_name(),
$enrolmententity->get_entity_name(),
$userentity->get_entity_name(),
$roleentity->get_entity_name(),
$groupentity->get_entity_name(),
]);
$this->add_all_from_entity($cohortentity->get_entity_name(), ['name', 'idnumber', 'description', 'customfield*'],
['cohortselect', 'name', 'idnumber', 'customfield*'], ['cohortselect', 'name', 'idnumber', 'customfield*']);
$this->add_all_from_entities([
$completionentity->get_entity_name(),
$accessentity->get_entity_name(),
$coursecatentity,
$courseentity,
$enrolentity,
$enrolmententity,
$userentity,
$roleentity,
$groupentity,
]);
$this->add_all_from_entity(
$cohortentity,
['name', 'idnumber', 'description', 'customfield*'],
['cohortselect', 'name', 'idnumber', 'customfield*'],
['cohortselect', 'name', 'idnumber', 'customfield*'],
);
$this->add_all_from_entities([$completionentity, $accessentity]);
}
/**
public/mod/forum/classes/reportbuilder/datasource/forums.php
+7 -7
View File
@@ -100,13 +100,13 @@ class forums extends datasource {
// Add report elements from each of the entities we added to the report.
$this->add_all_from_entities([
$coursecatentity->get_entity_name(),
$courseentity->get_entity_name(),
$coursemodentity->get_entity_name(),
$forumentity->get_entity_name(),
$discussionentity->get_entity_name(),
$postentity->get_entity_name(),
$userentity->get_entity_name(),
$coursecatentity,
$courseentity,
$coursemodentity,
$forumentity,
$discussionentity,
$postentity,
$userentity,
]);
}
public/reportbuilder/classes/datasource.php
+14 -21
View File
@@ -19,10 +19,10 @@ declare(strict_types=1);
namespace core_reportbuilder;
use coding_exception;
use core_reportbuilder\local\entities\base as entity_base;
use core_reportbuilder\local\helpers\report;
use core_reportbuilder\local\models\{column as column_model, filter as filter_model};
use core_reportbuilder\local\report\base;
use core_reportbuilder\local\report\{column, filter};
use core_reportbuilder\local\report\{base, column, filter};
/**
* Class datasource
@@ -207,17 +207,21 @@ abstract class datasource extends base {
*
* Wildcard matching is supported with '*' in both $include and $exclude, e.g. ['customfield*']
*
* @param string $entityname
* @param string|entity_base $entityname
* @param string[] $include Include only these conditions, if omitted then include all
* @param string[] $exclude Exclude these conditions, if omitted then exclude none
* @throws coding_exception If both $include and $exclude are non-empty
*/
final protected function add_conditions_from_entity(string $entityname, array $include = [], array $exclude = []): void {
final protected function add_conditions_from_entity(
string|entity_base $entityname,
array $include = [],
array $exclude = [],
): void {
if (!empty($include) && !empty($exclude)) {
throw new coding_exception('Cannot specify conditions to include and exclude simultaneously');
}
$entity = $this->get_entity($entityname);
$entity = $this->normalise_entity($entityname);
// Retrieve filtered conditions from entity, respecting given $include/$exclude parameters.
$conditions = array_filter($entity->get_conditions(), function (filter $condition) use ($include, $exclude): bool {
@@ -312,13 +316,13 @@ abstract class datasource extends base {
/**
* Adds all columns/filters/conditions from the given entity to the report at once
*
* @param string $entityname
* @param string|entity_base $entityname
* @param string[] $limitcolumns Include only these columns
* @param string[] $limitfilters Include only these filters
* @param string[] $limitconditions Include only these conditions
*/
final protected function add_all_from_entity(
string $entityname,
string|entity_base $entityname,
array $limitcolumns = [],
array $limitfilters = [],
array $limitconditions = [],
@@ -331,23 +335,12 @@ abstract class datasource extends base {
/**
* Adds all columns/filters/conditions from all the entities added to the report at once
*
* @param string[] $entitynames If specified, then only these entity elements are added in the order that they are specified
* @param string[]|entity_base[] $entitynames Limit to only these entity elements, in the order that they are specified
*/
final protected function add_all_from_entities(array $entitynames = []): void {
if (empty($entitynames)) {
$entities = $this->get_entities();
} else {
$entities = array_combine(
$entitynames,
array_map(
fn(string $entityname) => $this->get_entity($entityname),
$entitynames,
),
);
}
$entities = empty($entitynames) ? $this->get_entities() : $entitynames;
foreach ($entities as $entity) {
$this->add_all_from_entity($entity->get_entity_name());
$this->add_all_from_entity($entity);
}
}
public/reportbuilder/classes/local/report/base.php
+25 -6
View File
@@ -305,6 +305,17 @@ abstract class base {
return $this->entities;
}
/**
* Helper to normalise entity instance based on type of passed parameter
*
* @param string|entity_base $entity
* @return entity_base
*/
final protected function normalise_entity(string|entity_base $entity): entity_base {
$entityname = $entity instanceof entity_base ? $entity->get_entity_name() : $entity;
return $this->get_entity($entityname);
}
/**
* Define a new entity for the report
*
@@ -385,17 +396,21 @@ abstract class base {
*
* Wildcard matching is supported with '*' in both $include and $exclude, e.g. ['customfield*']
*
* @param string $entityname
* @param string|entity_base $entityname
* @param string[] $include Include only these columns, if omitted then include all
* @param string[] $exclude Exclude these columns, if omitted then exclude none
* @throws coding_exception If both $include and $exclude are non-empty
*/
final protected function add_columns_from_entity(string $entityname, array $include = [], array $exclude = []): void {
final protected function add_columns_from_entity(
string|entity_base $entityname,
array $include = [],
array $exclude = [],
): void {
if (!empty($include) && !empty($exclude)) {
throw new coding_exception('Cannot specify columns to include and exclude simultaneously');
}
$entity = $this->get_entity($entityname);
$entity = $this->normalise_entity($entityname);
// Retrieve filtered columns from entity, respecting given $include/$exclude parameters.
$columns = array_filter($entity->get_columns(), function(column $column) use ($include, $exclude): bool {
@@ -683,17 +698,21 @@ abstract class base {
*
* Wildcard matching is supported with '*' in both $include and $exclude, e.g. ['customfield*']
*
* @param string $entityname
* @param string|entity_base $entityname
* @param string[] $include Include only these filters, if omitted then include all
* @param string[] $exclude Exclude these filters, if omitted then exclude none
* @throws coding_exception If both $include and $exclude are non-empty
*/
final protected function add_filters_from_entity(string $entityname, array $include = [], array $exclude = []): void {
final protected function add_filters_from_entity(
string|entity_base $entityname,
array $include = [],
array $exclude = [],
): void {
if (!empty($include) && !empty($exclude)) {
throw new coding_exception('Cannot specify filters to include and exclude simultaneously');
}
$entity = $this->get_entity($entityname);
$entity = $this->normalise_entity($entityname);
// Retrieve filtered filters from entity, respecting given $include/$exclude parameters.
$filters = array_filter($entity->get_filters(), function(filter $filter) use ($include, $exclude): bool {
public/reportbuilder/tests/datasource_test.php
+153 -16
View File
@@ -27,6 +27,7 @@ declare(strict_types=1);
namespace core_reportbuilder;
use advanced_testcase;
use core\exception\coding_exception;
use core\lang_string;
use core_reportbuilder_generator;
use core_reportbuilder\local\entities\base;
@@ -40,7 +41,7 @@ defined('MOODLE_INTERNAL') || die();
* Unit tests for base datasource
*
* @package core_reportbuilder
* @coversDefaultClass \core_reportbuilder\datasource
* @covers \core_reportbuilder\datasource
* @copyright 2023 Paul Holden <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -91,8 +92,6 @@ final class datasource_test extends advanced_testcase {
* @param string[] $exclude
* @param string[] $expectedcolumns
*
* @covers ::add_columns_from_entity
*
* @dataProvider add_columns_from_entity_provider
*/
public function test_add_columns_from_entity(
@@ -102,10 +101,10 @@ final class datasource_test extends advanced_testcase {
): void {
$instance = $this->get_datasource_test_source();
// Assert we can pass the entity name when adding columns.
$method = (new ReflectionClass($instance))->getMethod('add_columns_from_entity');
$method->invoke($instance, 'entityone', $include, $exclude);
// Get all our entity columns.
$this->assertEquals(
$expectedcolumns,
array_map(
@@ -115,6 +114,56 @@ final class datasource_test extends advanced_testcase {
);
}
/**
* Test adding columns from entity instance
*/
public function test_add_columns_from_entity_instance(): void {
$instance = $this->get_datasource_test_source();
// Get the entity instance.
$method = (new ReflectionClass($instance))->getMethod('get_entity');
$entity = $method->invoke($instance, 'entityone');
// Assert we can pass the entity instance itself when adding columns.
$method = (new ReflectionClass($instance))->getMethod('add_columns_from_entity');
$method->invoke($instance, $entity, ['first']);
$this->assertEquals(
[
'dummy:test',
'entityone:first',
],
array_map(
fn(column $column) => $column->get_unique_identifier(),
array_values($instance->get_columns()),
),
);
}
/**
* Test adding columns from entity that has not been added to report
*/
public function test_add_columns_from_entity_invalid(): void {
$instance = $this->get_datasource_test_source();
$method = (new ReflectionClass($instance))->getMethod('add_columns_from_entity');
// Invalid entity name.
try {
$method->invoke($instance, 'invalid');
$this->fail('Exception expected');
} catch (coding_exception $exception) {
$this->assertStringContainsString("Invalid entity name (invalid)", $exception->getMessage());
}
// Invalid entity instance.
try {
$method->invoke($instance, new datasource_test_entity());
$this->fail('Exception expected');
} catch (coding_exception $exception) {
$this->assertStringContainsString("Invalid entity name (datasource_test_entity)", $exception->getMessage());
}
}
/**
* Data provider for {@see test_add_filters_from_entity}
*
@@ -158,8 +207,6 @@ final class datasource_test extends advanced_testcase {
* @param string[] $exclude
* @param string[] $expectedfilters
*
* @covers ::add_filters_from_entity
*
* @dataProvider add_filters_from_entity_provider
*/
public function test_add_filters_from_entity(
@@ -169,10 +216,10 @@ final class datasource_test extends advanced_testcase {
): void {
$instance = $this->get_datasource_test_source();
// Assert we can pass the entity name when adding filters.
$method = (new ReflectionClass($instance))->getMethod('add_filters_from_entity');
$method->invoke($instance, 'entityone', $include, $exclude);
// Get all our entity filters.
$this->assertEquals(
$expectedfilters,
array_map(
@@ -182,6 +229,55 @@ final class datasource_test extends advanced_testcase {
);
}
/**
* Test adding filters from entity instance
*/
public function test_add_filters_from_entity_instance(): void {
$instance = $this->get_datasource_test_source();
// Get the entity instance.
$method = (new ReflectionClass($instance))->getMethod('get_entity');
$entity = $method->invoke($instance, 'entityone');
// Assert we can pass the entity instance itself when adding filters.
$method = (new ReflectionClass($instance))->getMethod('add_filters_from_entity');
$method->invoke($instance, $entity, ['first']);
$this->assertEquals(
[
'entityone:first',
],
array_map(
fn(filter $filter) => $filter->get_unique_identifier(),
array_values($instance->get_filters()),
),
);
}
/**
* Test adding filters from entity that has not been added to report
*/
public function test_add_filters_from_entity_invalid(): void {
$instance = $this->get_datasource_test_source();
$method = (new ReflectionClass($instance))->getMethod('add_filters_from_entity');
// Invalid entity name.
try {
$method->invoke($instance, 'invalid');
$this->fail('Exception expected');
} catch (coding_exception $exception) {
$this->assertStringContainsString("Invalid entity name (invalid)", $exception->getMessage());
}
// Invalid entity instance.
try {
$method->invoke($instance, new datasource_test_entity());
$this->fail('Exception expected');
} catch (coding_exception $exception) {
$this->assertStringContainsString("Invalid entity name (datasource_test_entity)", $exception->getMessage());
}
}
/**
* Data provider for {@see test_add_conditions_from_entity}
*
@@ -225,8 +321,6 @@ final class datasource_test extends advanced_testcase {
* @param string[] $exclude
* @param string[] $expectedconditions
*
* @covers ::add_conditions_from_entity
*
* @dataProvider add_conditions_from_entity_provider
*/
public function test_add_conditions_from_entity(
@@ -236,10 +330,10 @@ final class datasource_test extends advanced_testcase {
): void {
$instance = $this->get_datasource_test_source();
// Assert we can pass the entity name when adding conditions.
$method = (new ReflectionClass($instance))->getMethod('add_conditions_from_entity');
$method->invoke($instance, 'entityone', $include, $exclude);
// Get all our entity conditions.
$this->assertEquals(
$expectedconditions,
array_map(
@@ -249,10 +343,57 @@ final class datasource_test extends advanced_testcase {
);
}
/**
* Test adding conditions from entity instance
*/
public function test_add_conditions_from_entity_instance(): void {
$instance = $this->get_datasource_test_source();
// Get the entity instance.
$method = (new ReflectionClass($instance))->getMethod('get_entity');
$entity = $method->invoke($instance, 'entityone');
// Assert we can pass the entity instance itself when adding conditions.
$method = (new ReflectionClass($instance))->getMethod('add_conditions_from_entity');
$method->invoke($instance, $entity, ['first']);
$this->assertEquals(
[
'entityone:first',
],
array_map(
fn(filter $condition) => $condition->get_unique_identifier(),
array_values($instance->get_conditions()),
),
);
}
/**
* Test adding conditions from entity that has not been added to report
*/
public function test_add_conditions_from_entity_invalid(): void {
$instance = $this->get_datasource_test_source();
$method = (new ReflectionClass($instance))->getMethod('add_conditions_from_entity');
// Invalid entity name.
try {
$method->invoke($instance, 'invalid');
$this->fail('Exception expected');
} catch (coding_exception $exception) {
$this->assertStringContainsString("Invalid entity name (invalid)", $exception->getMessage());
}
// Invalid entity instance.
try {
$method->invoke($instance, new datasource_test_entity());
$this->fail('Exception expected');
} catch (coding_exception $exception) {
$this->assertStringContainsString("Invalid entity name (datasource_test_entity)", $exception->getMessage());
}
}
/**
* Test adding all from entity
*
* @covers ::add_all_from_entity
*/
public function test_add_all_from_entity(): void {
$instance = $this->get_datasource_test_source();
@@ -393,8 +534,6 @@ final class datasource_test extends advanced_testcase {
* @param string[] $expectedfilters
* @param string[] $expectedconditions
*
* @covers ::add_all_from_entities
*
* @dataProvider add_all_from_entities_provider
*/
public function test_add_all_from_entities(
@@ -438,8 +577,6 @@ final class datasource_test extends advanced_testcase {
/**
* Test getting active conditions
*
* @covers ::get_active_conditions
*/
public function test_get_active_conditions(): void {
$instance = $this->get_datasource_test_source();