ColumnTest Class Reference

Basic Tests for Table-Columns. More...

Inheritance diagram for ColumnTest:

Collaboration diagram for ColumnTest:

Public Member Functions
	setUp ()
	testDataTableColumnsAttributes ()
	testDataTableColumnBoolFormat ()
	testDataTableColumnBoolFormatWithIcon ()
	testDataTableColumnBoolFormatWithGlyph ()
	testDataTableColumnDateFormat ()
	testDataTableColumnTimespanFormat ()
	testDataTableColumnNumnberFormat ()
	testDataTableColumnAllowedFormats (Column\Column $column, $value, bool $ok)
	 * provideColumnFormats  More...
	testDataTableColumnLinkListingFormat ()
	testDataTableColumnLinkListingFormatAcceptsOnlyLinkListings ()
	testDataTableColumnLinkListingItemsFormatAcceptsOnlyLinks ()
	testDataTableColumnCustomOrderingLabels ()
Public Member Functions inherited from ILIAS_UI_TestBase
	setUp ()
	tearDown ()
	getUIFactory ()
	getTemplateFactory ()
	getResourceRegistry ()
	getLanguage ()
	getJavaScriptBinding ()
	getRefinery ()
	getImagePathResolver ()
	getDataFactory ()
	getDefaultRenderer (JavaScriptBinding $js_binding=null, array $with_stub_renderings=[])
	getDecoratedRenderer (Renderer $default)
	normalizeHTML (string $html)
	assertHTMLEquals (string $expected_html_as_string, string $html_as_string)

Static Public Member Functions
static	provideColumnFormats ()

Additional Inherited Members
Protected Member Functions inherited from ILIAS_UI_TestBase
	brutallyTrimHTML (string $html)
	A more radical version of normalizeHTML. More...
	brutallyTrimSignals (string $html)
	A naive replacement of all il_signal-ids with dots to ease comparisons of rendered output. More...

Detailed Description

Basic Tests for Table-Columns.

Definition at line 35 of file ColumnTest.php.

Member Function Documentation

provideColumnFormats()

static ColumnTest::provideColumnFormats ( )

static

Definition at line 134 of file ColumnTest.php.

References $lng, and ILIAS\GlobalScreen\Provider\__construct().

                                                 : 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
            ],
        ];
    }

Here is the call graph for this function:

setUp()

ColumnTest::setUp

(

)

Definition at line 37 of file ColumnTest.php.

References $lng, and ILIAS\Repository\lng().

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

Here is the call graph for this function:

testDataTableColumnAllowedFormats()

ColumnTest::testDataTableColumnAllowedFormats	(	Column\Column	$column,
			$value,
		bool	$ok
	)

 * provideColumnFormats 

Definition at line 188 of file ColumnTest.php.

     : void {
        if(! $ok) {
            $this->expectException(\InvalidArgumentException::class);
        }
        $this->assertEquals($value, $column->format($value));
    }

testDataTableColumnBoolFormat()

ColumnTest::testDataTableColumnBoolFormat

(

)

Definition at line 74 of file ColumnTest.php.

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

testDataTableColumnBoolFormatWithGlyph()

ColumnTest::testDataTableColumnBoolFormatWithGlyph

(

)

Definition at line 90 of file ColumnTest.php.

References ILIAS\Repository\lng().

                                                            : 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));
    }

Here is the call graph for this function:

testDataTableColumnBoolFormatWithIcon()

ColumnTest::testDataTableColumnBoolFormatWithIcon

(

)

Definition at line 81 of file ColumnTest.php.

References ILIAS\Repository\lng().

                                                           : 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));
    }

Here is the call graph for this function:

testDataTableColumnCustomOrderingLabels()

ColumnTest::testDataTableColumnCustomOrderingLabels

(

)

Definition at line 224 of file ColumnTest.php.

References ILIAS\Repository\lng().

                                                             : 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()
        );
    }

Here is the call graph for this function:

testDataTableColumnDateFormat()

ColumnTest::testDataTableColumnDateFormat

(

)

Definition at line 99 of file ColumnTest.php.

References $format, and ILIAS\Repository\lng().

                                                   : 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));
    }

Here is the call graph for this function:

testDataTableColumnLinkListingFormat()

ColumnTest::testDataTableColumnLinkListingFormat

(

)

Definition at line 199 of file ColumnTest.php.

References ILIAS\Repository\lng().

                                                          : 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));
    }

Here is the call graph for this function:

testDataTableColumnLinkListingFormatAcceptsOnlyLinkListings()

ColumnTest::testDataTableColumnLinkListingFormatAcceptsOnlyLinkListings

(

)

Definition at line 207 of file ColumnTest.php.

References ILIAS\Repository\lng().

                                                                                 : 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));
    }

Here is the call graph for this function:

testDataTableColumnLinkListingItemsFormatAcceptsOnlyLinks()

ColumnTest::testDataTableColumnLinkListingItemsFormatAcceptsOnlyLinks

(

)

Definition at line 215 of file ColumnTest.php.

References ILIAS\Repository\lng().

                                                                               : 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));
    }

Here is the call graph for this function:

testDataTableColumnNumnberFormat()

ColumnTest::testDataTableColumnNumnberFormat

(

)

Definition at line 120 of file ColumnTest.php.

References ILIAS\Repository\lng().

                                                      : 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));
    }

Here is the call graph for this function:

testDataTableColumnsAttributes()

ColumnTest::testDataTableColumnsAttributes

(

)

Definition at line 46 of file ColumnTest.php.

References ILIAS\Repository\lng().

                                                    : 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());
    }

Here is the call graph for this function:

testDataTableColumnTimespanFormat()

ColumnTest::testDataTableColumnTimespanFormat

(

)

Definition at line 108 of file ColumnTest.php.

References $format, and ILIAS\Repository\lng().

                                                       : 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])
        );
    }

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• tests/UI/Component/Table/Column/ColumnTest.php