Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.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\external\columns\sort;

use core_reportbuilder_generator;
< use external_api;
> use core_external\external_api;
use externallib_advanced_testcase; use core_reportbuilder\report_access_exception; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for retrieving report column sorting * * @package core_reportbuilder * @covers \core_reportbuilder\external\columns\sort\get * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class get_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); // Add some columns (note 'user:picture' is not a sortable column). $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:picture']); $result = get::execute($report->get('id')); $result = external_api::clean_returnvalue(get::execute_returns(), $result); $this->assertTrue($result['hassortablecolumns']); $sortablecolumntitles = array_column($result['sortablecolumns'], 'title'); $this->assertEquals([ 'Full name', 'Email address', ], $sortablecolumntitles); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); get::execute($report->get('id')); } }