SWAMPy

✎ CARVE FLESH

EDITING: reorder_test.php

<?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 core_external\external_api;
use core_reportbuilder\exception\report_access_exception;
use core_reportbuilder\local\models\column;
use core_user\reportbuilder\datasource\users;

/**
 * Unit tests of external class for re-ordering report column sorting
 *
 * @package     core_reportbuilder
 * @covers      \core_reportbuilder\external\columns\sort\reorder
 * @copyright   2021 Paul Holden <paulh@moodle.com>
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
final class reorder_test extends \core_external\tests\externallib_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 four columns.
        $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:country']);
        $columncity = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:city']);

// Move the city column sort order to second position.
        $result = reorder::execute($report->get('id'), $columncity->get('id'), 2);
        $result = external_api::clean_returnvalue(reorder::execute_returns(), $result);

$this->assertTrue($result['hassortablecolumns']);
        $this->assertCount(4, $result['sortablecolumns']);

$sortablecolumn = $result['sortablecolumns'][1];
        $this->assertEquals('City/town', $sortablecolumn['title']);
        $this->assertEquals(SORT_ASC, $sortablecolumn['sortdirection']);
        $this->assertEquals(0, $sortablecolumn['sortenabled']);
        $this->assertEquals(2, $sortablecolumn['sortorder']);
        $this->assertArrayHasKey('sorticon', $sortablecolumn);

// Assert report column sort order.
        $columns = column::get_records(['reportid' => $report->get('id')], 'sortorder');

$columnidentifiers = array_map(static function(column $column): string {
            return $column->get('uniqueidentifier');
        }, $columns);

$this->assertEquals([
            'user:fullname',
            'user:city',
            'user:email',
            'user:country',
        ], $columnidentifiers);
    }

/**
     * Test execute method for a user without permission to edit reports
     */
    public function test_execute_access_exception(): void {
        $this->resetAfterTest();

$user = $this->getDataGenerator()->create_user();
        $this->setUser($user);

$this->expectException(report_access_exception::class);
        $this->expectExceptionMessage('You cannot edit this report');
        reorder::execute($report->get('id'), $column->get('id'), 2);
    }
}

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 get_test.php	PHP	3.2 KB	2026-02-11 01:44	EDIT
📄 reorder_test.php	PHP	4.2 KB	2026-02-11 01:44	EDIT
📄 toggle_test.php	PHP	3.6 KB	2026-02-11 01:44	EDIT