DataTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

require_once("vendor/composer/vendor/autoload.php");
require_once(__DIR__ . "/TableTestBase.php");

use ILIAS\UI\Component;
use ILIAS\UI\Implementation\Component as C;
use ILIAS\UI\Component as I;
use ILIAS\Data\Range;
use ILIAS\Data\Order;
use Psr\Http\Message\ServerRequestInterface;
use ILIAS\UI\URLBuilder;

class DataTest extends TableTestBase
{
    protected function getFactory()
    {
        return new C\Table\Factory(
            new C\SignalGenerator(),
            new \ILIAS\Data\Factory(),
            new C\Table\Column\Factory(),
            new C\Table\Action\Factory(),
            new C\Table\DataRowBuilder(),
            new C\Table\OrderingRowBuilder()
        );
    }

    protected function getDataRetrieval(): I\Table\DataRetrieval
    {
        return new class () implements I\Table\DataRetrieval {
            public function getRows(
                I\Table\DataRowBuilder $row_builder,
                array $visible_column_ids,
                Range $range,
                Order $order,
                ?array $filter_data,
                ?array $additional_parameters
            ): \Generator {
                yield $row_builder->buildStandardRow('', []);
            }
            public function getTotalRowCount(
                ?array $filter_data,
                ?array $additional_parameters
            ): ?int {
                return null;
            }
        };
    }

    public function testDataTableBasicConstruction(): void
    {
        $data = $this->getDataRetrieval();
        $cols = ['f0' => $this->getTableFactory()->column()->text("col1")];
        $table = $this->getTableFactory()->data('title', $cols, $data);
        $this->assertInstanceOf(Order::class, $table->getOrder());
        $this->assertInstanceOf(Range::class, $table->getRange());
        $this->assertInstanceOf(I\Signal::class, $table->getAsyncActionSignal());
        $this->assertInstanceOf(I\Signal::class, $table->getMultiActionSignal());
        $this->assertInstanceOf(I\Signal::class, $table->getSelectionSignal());
        $this->assertFalse($table->hasSingleActions());
        $this->assertFalse($table->hasMultiActions());
        $this->assertEquals($data, $table->getDataRetrieval());
    }

    public function testDataTableConstructionWithErrorColumns(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $data = $this->getDataRetrieval();
        $cols = ['f0' => "col1"];
        $table = $this->getTableFactory()->data('title', $cols, $data);
    }

    public function testDataTableConstructionWithoutColumns(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $data = $this->getDataRetrieval();
        $cols = [];
        $table = $this->getTableFactory()->data('title', $cols, $data);
    }

    public function testDataTableColumns(): void
    {
        $f = $this->getTableFactory()->column();
        $cols = [
            'f0' => $f->text("col1"),
            'f1' => $f->text("col2")
        ];
        $table = $this->getTableFactory()->data('title', $cols, $this->getDataRetrieval());

        $this->assertEquals(2, $table->getColumnCount());
        $check = [
            'f0' => $f->text("col1")->withIndex(0),
            'f1' => $f->text("col2")->withIndex(1)
        ];
        $this->assertEquals($check, $table->getColumns());
        $this->assertEquals($check, $table->getVisibleColumns());
    }

    public function testDataTableActions(): void
    {
        $f = $this->getTableFactory()->action();
        $df = new \ILIAS\Data\Factory();
        $target = $df->uri('http://wwww.ilias.de?ref_id=1');
        $url_builder = new URLBuilder($target);
        list($builder, $token) = $url_builder->acquireParameter(['namespace'], 'rowids');
        $actions = [
            $f->single('act1', $builder, $token),
            $f->multi('act2', $builder, $token),
            $f->standard('act0', $builder, $token)
        ];
        $cols = ['f0' => $this->getTableFactory()->column()->text("col1")];
        $table = $this->getTableFactory()->data('title', $cols, $this->getDataRetrieval())
            ->withActions($actions);

        $this->assertEquals($actions, $table->getAllActions());
        $this->assertEqualsCanonicalizing([$actions[0], $actions[2]], $table->getSingleActions());
        $this->assertEqualsCanonicalizing([$actions[1], $actions[2]], $table->getMultiActions());
    }

    protected function getTable(): I\Table\Data
    {
        $data = $this->getDataRetrieval();
        $cols = ['f0' => $this->getTableFactory()->column()->text("col1")];
        $table = $this->getTableFactory()->data('title', $cols, $data);
        return $table;
    }

    public function testDataTableWithRequest(): void
    {
        $table = $this->getTable();
        $request = $this->createMock(ServerRequestInterface::class);
        $this->assertEquals($request, $table->withRequest($request)->getRequest());
    }

    public function testDataTableWithOrder(): void
    {
        $table = $this->getTable();
        $order = new Order('aspect', 'DESC');
        $this->assertEquals($order, $table->withOrder($order)->getOrder());
    }

    public function testDataTableWithRange(): void
    {
        $table = $this->getTable();
        $range = new Range(17, 53);
        $this->assertEquals($range, $table->withRange($range)->getRange());
    }

    public function testDataTableWithFilter(): void
    {
        $table = $this->getTable();
        $filter = [
            'aspect' => ['values']
        ];
        $this->assertEquals($filter, $table->withFilter($filter)->getFilter());
    }

    public function testDataTableWithAdditionalParams(): void
    {
        $table = $this->getTable();
        $params = [
            'param' => 'value'
        ];
        $this->assertEquals($params, $table->withAdditionalParameters($params)->getAdditionalParameters());
    }

    public function testDataTableWithSelectedOptionalCols(): void
    {
        $data = $this->getDataRetrieval();
        $cols = [
            'f0' => $this->getTableFactory()->column()->text(''),
            'f1' => $this->getTableFactory()->column()->text('')
                ->withIsOptional(true, false),
            'f2' => $this->getTableFactory()->column()->text('')
        ];
        $table = $this->getTableFactory()->data('title', $cols, $data);
        $this->assertEquals(3, $table->getColumnCount());
        $this->assertEquals(['f0', 'f2'], array_keys($table->getVisibleColumns()));
        $this->assertEquals(0, $table->getVisibleColumns()['f0']->getIndex());
        $this->assertEquals(2, $table->getVisibleColumns()['f2']->getIndex());
    }

    public function testDataTableWithId(): void
    {
        $table = new class () extends C\Table\Data {
            public function __construct()
            {
            }
            public function mockGetStorageId(): ?string
            {
                return $this->getStorageId();
            }
            public function mockGetId(): ?string
            {
                return $this->getId();
            }
        };

        $this->assertNull($table->mockGetId());
        $this->assertNull($table->mockGetStorageId());

        $table_id = 'some_id';
        $internal_table_id = C\Table\Data::STORAGE_ID_PREFIX . $table_id;
        $table = $table->withId($table_id);
        $this->assertEquals($table_id, $table->mockGetId());
        $this->assertEquals($internal_table_id, $table->mockGetStorageId());
    }

    public function testDataTableWithIdAndStorage(): void
    {
        $table_id = 'some_id';
        $internal_table_id = C\Table\Data::STORAGE_ID_PREFIX . $table_id;
        $table_data = ['a' => 'b'];
        $storage = $this->getMockStorage();
        $storage[$internal_table_id] = $table_data;

        $table = new class ($storage) extends C\Table\Data {
            public function __construct(
                protected \ArrayAccess $storage,
            ) {
            }
            public function mockGetStorageData(): ?array
            {
                return $this->getStorageData();
            }
        };

        $table = $table->withId($table_id);
        $this->assertEquals($table_data, $table->mockGetStorageData());
    }
}