ColumnTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);


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

use ILIAS\UI\Implementation\Component\Table\Column;
use ILIAS\UI\Implementation\Component\Link;
use ILIAS\UI\Implementation\Component\Listing;
use ILIAS\UI\Implementation\Component\Symbol\Icon\Standard as StandardIcon;
use ILIAS\UI\Implementation\Component\Symbol\Glyph\Glyph;
use ILIAS\UI\Component\Symbol\Glyph\Glyph as GlyphInterface;
use ILIAS\Language\Language;

class ColumnTest extends ILIAS_UI_TestBase
{
    protected Language $lng;

    public function setUp(): void
    {
        $lng = $this->getMockBuilder(\ILIAS\Language\Language::class)
            ->disableOriginalConstructor()
            ->getMock();
        $lng->method('txt')->willReturnCallback(fn($v) => $v);
        $this->lng = $lng;
    }

    public function testDataTableColumnsAttributes(): void
    {
        $col = new Column\Text($this->lng, 'col');
        $this->assertEquals('col', $col->getTitle());

        $this->assertTrue($col->isSortable());
        $this->assertFalse($col->withIsSortable(false)->isSortable());
        $this->assertTrue($col->withIsSortable(true)->isSortable());
        $this->assertEquals([
            'col, order_option_alphabetical_ascending',
            'col, order_option_alphabetical_descending',
        ], $col->getOrderingLabels());

        $this->assertFalse($col->isOptional());
        $this->assertTrue($col->withIsOptional(true)->isOptional());
        $this->assertFalse($col->withIsOptional(false)->isOptional());

        $this->assertTrue($col->isInitiallyVisible());
        $this->assertFalse($col->withIsOptional(true, false)->isInitiallyVisible());
        $this->assertTrue($col->withIsOptional(true, true)->isInitiallyVisible());

        $this->assertFalse($col->isHighlighted());
        $this->assertTrue($col->withHighlight(true)->isHighlighted());
        $this->assertFalse($col->withHighlight(false)->isHighlighted());

        $this->assertEquals(12, $col->withIndex(12)->getIndex());
    }

    public function testDataTableColumnBoolFormat(): void
    {
        $col = new Column\Boolean($this->lng, 'col', 'TRUE', 'FALSE');
        $this->assertEquals('TRUE', $col->format(true));
        $this->assertEquals('FALSE', $col->format(false));
    }

    public function testDataTableColumnBoolFormatWithIcon(): void
    {
        $ok = new StandardIcon('', 'ok', 'small', false);
        $no = new StandardIcon('', 'notok', 'small', false);
        $col = new Column\Boolean($this->lng, 'col', $ok, $no);
        $this->assertEquals($ok, $col->format(true));
        $this->assertEquals($no, $col->format(false));
    }

    public function testDataTableColumnBoolFormatWithGlyph(): void
    {
        $ok = new Glyph(GlyphInterface::LIKE, '');
        $no = new Glyph(GlyphInterface::DISLIKE, '');
        $col = new Column\Boolean($this->lng, 'col', $ok, $no);
        $this->assertEquals($ok, $col->format(true));
        $this->assertEquals($no, $col->format(false));
    }

    public function testDataTableColumnDateFormat(): void
    {
        $df = new \ILIAS\Data\Factory();
        $format = $df->dateFormat()->germanShort();
        $dat = new \DateTimeImmutable();
        $col = new Column\Date($this->lng, 'col', $format);
        $this->assertEquals($dat->format($format->toString()), $col->format($dat));
    }

    public function testDataTableColumnTimespanFormat(): void
    {
        $df = new \ILIAS\Data\Factory();
        $format = $df->dateFormat()->germanShort();
        $dat = new \DateTimeImmutable();
        $col = new Column\TimeSpan($this->lng, 'col', $format);
        $this->assertEquals(
            $dat->format($format->toString()) . ' - ' . $dat->format($format->toString()),
            $col->format([$dat, $dat])
        );
    }

    public function testDataTableColumnNumnberFormat(): void
    {
        $df = new \ILIAS\Data\Factory();
        $dat = new \DateTimeImmutable();
        $col = new Column\Number($this->lng, 'col');
        $this->assertEquals('1', $col->format(1));
        $col = $col->withDecimals(3);
        $this->assertEquals('1,000', $col->format(1));
        $col = $col->withDecimals(2)->withUnit('$', $col::UNIT_POSITION_FORE);
        $this->assertEquals('$ 1,00', $col->format(1));
        $col = $col->withUnit('€', $col::UNIT_POSITION_AFT);
        $this->assertEquals('1,00 €', $col->format(1));
    }

    public static function provideColumnFormats(): array
    {
        $lng = new class () extends \ilLanguage {
            public function __construct()
            {
            }
        };
        return [
            [
                'column' => new Column\LinkListing($lng, ''),
                'value' => new Listing\Unordered([(new Link\Standard('label', '#')),(new Link\Standard('label', '#'))]),
                'ok' => true
            ],
            [
                'column' => new Column\LinkListing($lng, ''),
                'value' => new Listing\Unordered(['string', 'string']),
                'ok' => false
            ],
            [
                'column' => new Column\LinkListing($lng, ''),
                'value' => new Listing\Ordered([(new Link\Standard('label', '#')),(new Link\Standard('label', '#'))]),
                'ok' => true
            ],
            [
                'column' => new Column\LinkListing($lng, ''),
                'value' => 123,
                'ok' => false
            ],
            [
                'column' => new Column\Link($lng, ''),
                'value' => new Link\Standard('label', '#'),
                'ok' => true
            ],
            [
                'column' => new Column\Link($lng, ''),
                'value' => 'some string',
                'ok' => false
            ],
            [
                'column' => new Column\StatusIcon($lng, ''),
                'value' => new StandardIcon('', '', 'small', false),
                'ok' => true
            ],
            [
                'column' => new Column\StatusIcon($lng, ''),
                'value' => 'some string',
                'ok' => false
            ],
        ];
    }

    public function testDataTableColumnAllowedFormats(
        Column\Column $column,
        mixed $value,
        bool $ok
    ): void {
        if(! $ok) {
            $this->expectException(\InvalidArgumentException::class);
        }
        $this->assertEquals($value, $column->format($value));
    }


    public function testDataTableColumnLinkListingFormat(): void
    {
        $col = new Column\LinkListing($this->lng, 'col');
        $link = new Link\Standard('label', '#');
        $linklisting = new Listing\Unordered([$link, $link, $link]);
        $this->assertEquals($linklisting, $col->format($linklisting));
    }

    public function testDataTableColumnLinkListingFormatAcceptsOnlyLinkListings(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $col = new Column\LinkListing($this->lng, 'col');
        $linklisting_invalid = new Link\Standard('label', '#');
        $this->assertEquals($linklisting_invalid, $col->format($linklisting_invalid));
    }

    public function testDataTableColumnLinkListingItemsFormatAcceptsOnlyLinks(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $col = new Column\LinkListing($this->lng, 'col');
        $link = 'some string';
        $linklisting_invalid = new Listing\Unordered([$link, $link, $link]);
        $this->assertEquals($linklisting_invalid, $col->format($linklisting_invalid));
    }

    public function testDataTableColumnCustomOrderingLabels(): void
    {
        $col = (new Column\LinkListing($this->lng, 'col'))
            ->withIsSortable(true)
            ->withOrderingLabels(
                'custom label ASC',
                'custom label DESC',
            );
        $this->assertEquals(
            [
                'custom label ASC',
                'custom label DESC'
            ],
            $col->getOrderingLabels()
        );
    }

}