Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?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\manager;
use core_reportbuilder\local\report\column;
use core_user\reportbuilder\datasource\users;
> use stdClass;
defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/helpers.php"); /** * Unit tests for sum aggregation * * @package core_reportbuilder * @covers \core_reportbuilder\local\aggregation\base * @covers \core_reportbuilder\local\aggregation\sum * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class sum_test extends core_reportbuilder_testcase { /** * Test aggregation when applied to column */ public function test_column_aggregation(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]); /** @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:suspended', 'aggregation' => sum::get_class_name() ]); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ [ 'c0_firstname' => 'Admin', 'c1_suspended' => 0, ], [ 'c0_firstname' => 'Bob', 'c1_suspended' => 2, ], ], $content); } /** * Test aggregation when applied to column with callback */ public function test_column_aggregation_with_callback(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]); /** @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:suspended', 'aggregation' => sum::get_class_name()] ); // Set callback to format the column (hack column definition to ensure callbacks are executed). $instance = manager::get_report_from_persistent($report); $instance->get_column('user:suspended') ->set_type(column::TYPE_INTEGER)
< ->set_callback(static function(int $value): string { < return "{$value} suspended";
> ->set_callback(static function(int $value, stdClass $row, $arguments, ?string $aggregation): string { > // Simple callback to return the given value, and append aggregation type. > return "{$value} ({$aggregation})";
}); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ [ 'c0_firstname' => 'Admin',
< 'c1_suspended' => '0 suspended',
> 'c1_suspended' => '0 (sum)',
], [ 'c0_firstname' => 'Bob',
< 'c1_suspended' => '2 suspended',
> 'c1_suspended' => '2 (sum)',
], ], $content); } }