Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
<?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\local\aggregation;

use core_reportbuilder_testcase;
use core_reportbuilder_generator;
> use core_reportbuilder\local\report\column;
use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/helpers.php"); /** * Unit tests for group concatenation distinct aggregation * * @package core_reportbuilder * @covers \core_reportbuilder\local\aggregation\base * @covers \core_reportbuilder\local\aggregation\groupconcatdistinct * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class groupconcatdistinct_test extends core_reportbuilder_testcase { /** * Test setup, we need to skip these tests on non-supported databases */ public function setUp(): void { global $DB;
< $dbfamily = $DB->get_dbfamily(); < if (!in_array($dbfamily, ['mysql', 'postgres'])) { < $this->markTestSkipped("Distinct group concatenation not supported in {$dbfamily}");
> if (!groupconcatdistinct::compatible(column::TYPE_TEXT)) { > $this->markTestSkipped('Distinct group concatenation not supported in ' . $DB->get_dbfamily());
} } /** * Test aggregation when applied to column */ public function test_column_aggregation(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Banana']); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Apple']); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Banana']); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // First column, sorted. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname', 'sortenabled' => 1]); // This is the column we'll aggregate. $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname', 'aggregation' => groupconcatdistinct::get_class_name(), ]); // Assert lastname column was aggregated, and sorted predictably. $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ [ 'c0_firstname' => 'Admin', 'c1_lastname' => 'User', ], [ 'c0_firstname' => 'Bob', 'c1_lastname' => 'Apple, Banana', ], ], $content);
> } } > > /** /** > * Test aggregation when applied to column with multiple fields * Test aggregation when applied to column with callback > */ */ > public function test_column_aggregation_multiple_fields(): void { public function test_column_aggregation_with_callback(): void { > $this->resetAfterTest(); $this->resetAfterTest(); > > $user = $this->getDataGenerator()->create_user(['firstname' => 'Adam', 'lastname' => 'Apple']); // Test subjects. > $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'confirmed' => 1]); > /** @var core_reportbuilder_generator $generator */ $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'confirmed' => 0]); > $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'confirmed' => 1]); > $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); > /** @var core_reportbuilder_generator $generator */ > // This is the column we'll aggregate. $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); > $generator->create_column([ $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); > 'reportid' => $report->get('id'), > 'uniqueidentifier' => 'user:fullnamewithlink', // First column, sorted. > 'aggregation' => groupconcatdistinct::get_class_name(), $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname', 'sortenabled' => 1]); > ]); > // This is the column we'll aggregate. > $content = $this->get_custom_report_content($report->get('id')); $generator->create_column([ > $this->assertCount(1, $content); 'reportid' => $report->get('id'), > 'uniqueidentifier' => 'user:confirmed', > // Ensure users are sorted predictably (Adam -> Admin). 'aggregation' => groupconcatdistinct::get_class_name(), > [$userone, $usertwo] = explode(', ', reset($content[0])); ]); > $this->assertStringContainsString(fullname($user, true), $userone); > $this->assertStringContainsString(fullname(get_admin(), true), $usertwo);
// Assert confirmed column was aggregated, and sorted predictably with callback applied. $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ [ 'c0_firstname' => 'Admin', 'c1_confirmed' => 'Yes', ], [ 'c0_firstname' => 'Bob', 'c1_confirmed' => 'No, Yes', ], ], $content); } }