DataRendererTest Class Reference

Tests for the Renderer of DataTables. More...

Inheritance diagram for DataRendererTest:

Collaboration diagram for DataRendererTest:

Public Member Functions
	getDataFactory ()
	getUIFactory ()
	testDataTableGetMultiActionHandler ()
	testDataTableGetActionRegistration ()
	testDataTableMultiActionsDropdown ()
	testDataTableSingleActionsDropdown ()
	testDataTableRenderTableHeader ()
	testDataTableRenderHeaderWithoutSortableColums ()
	testDataTableRenderHeaderWithActions ()
	testDataTableRowBuilder ()
	testDataTableDataRowFromBuilder (array $params)
	testDataTableRowBuilder More...
	testDataTableRenderStandardRow (I\Table\DataRow $row)
	testDataTableDataRowFromBuilder More...
	testRenderEmptyDataCell ()
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)

Private Member Functions
	getRenderer ()
	getActionFactory ()
	getColumnFactory ()
	getDummyRequest ()

Additional Inherited Members
Protected Member Functions inherited from TableTestBase
	buildFieldFactory ()
	buildRefinery ()
	getViewControlFactory ()
	getViewControlContainerFactory ()
	getTableFactory ()
	getMockStorage ()
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

Tests for the Renderer of DataTables.

Definition at line 73 of file DataRendererTest.php.

Member Function Documentation

getActionFactory()

DataRendererTest::getActionFactory ( )

private

Definition at line 88 of file DataRendererTest.php.

    {
        return new I\Table\Action\Factory();
    }

getColumnFactory()

DataRendererTest::getColumnFactory ( )

private

Definition at line 93 of file DataRendererTest.php.

References ILIAS\UI\Implementation\Component\Input\getLanguage().

    {
        return new I\Table\Column\Factory(
            $this->getLanguage()
        );
    }

Here is the call graph for this function:

getDataFactory()

DataRendererTest::getDataFactory

(

)

Definition at line 118 of file DataRendererTest.php.

                                    : Data\Factory
    {
        return new Data\Factory();
    }

getDummyRequest()

DataRendererTest::getDummyRequest ( )

private

Definition at line 100 of file DataRendererTest.php.

    {
        $request = $this->createMock(ServerRequestInterface::class);
        $request
            ->method("getUri")
            ->willReturn(new class () {
                public function __toString()
                {
                    return 'http://localhost:80';
                }
            });

        $request
            ->method("getQueryParams")
            ->willReturn([]);
        return $request;
    }

getRenderer()

DataRendererTest::getRenderer ( )

private

Definition at line 75 of file DataRendererTest.php.

References ILIAS\UI\Implementation\Component\Input\getLanguage().

    {
        return new DTRenderer(
            $this->getUIFactory(),
            $this->getTemplateFactory(),
            $this->getLanguage(),
            $this->getJavaScriptBinding(),
            $this->getRefinery(),
            new ilImagePathResolver(),
            new \ILIAS\Data\Factory()
        );
    }

Here is the call graph for this function:

getUIFactory()

DataRendererTest::getUIFactory

(

)

Definition at line 123 of file DataRendererTest.php.

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

                                  : NoUIFactory
    {
        $factory = new class ($this->getTableFactory()) extends NoUIFactory {
            protected Component\Table\Factory $table_factory;
            public function __construct(
                Component\Table\Factory $table_factory
            ) {
                $this->table_factory = $table_factory;
            }
            public function button(): Component\Button\Factory
            {
                return new I\Button\Factory();
            }
            public function dropdown(): Component\Dropdown\Factory
            {
                return new I\Dropdown\Factory();
            }
            public function symbol(): Component\Symbol\Factory
            {
                return new I\Symbol\Factory(
                    new I\Symbol\Icon\Factory(),
                    new I\Symbol\Glyph\Factory(),
                    new I\Symbol\Avatar\Factory()
                );
            }
            public function table(): Component\Table\Factory
            {
                return $this->table_factory;
            }
            public function divider(): Component\Divider\Factory
            {
                return new I\Divider\Factory();
            }
        };
        return $factory;
    }

Here is the call graph for this function:

testDataTableDataRowFromBuilder()

DataRendererTest::testDataTableDataRowFromBuilder

(

array

$params

)

testDataTableRowBuilder

Definition at line 466 of file DataRendererTest.php.

References $params.

                                                                  : I\Table\DataRow
    {
        list($rb, $columns, $actions) = $params;
        $record = [
            'f1' => 'v1',
            'f2' => 'v2',
            'f3' => 3
        ];
        $row = $rb->buildDataRow('row_id-1', $record);

        $this->assertEquals(
            $columns,
            $row->getColumns()
        );
        $this->assertEquals(
            $actions,
            $row->getActions()
        );
        $this->assertEquals(
            $record['f2'],
            $row->getCellContent('f2')
        );

        return $row;
    }

testDataTableGetActionRegistration()

DataRendererTest::testDataTableGetActionRegistration

(

)

Definition at line 175 of file DataRendererTest.php.

References Vendor\Package\$f, $token, $url, and ILIAS\UI\Implementation\Component\Input\getDataFactory().

    {
        $renderer = $this->getRenderer();
        $f = $this->getActionFactory();
        $url = $this->getDataFactory()->uri('http://wwww.ilias.de?ref_id=1');
        $url_builder = new URLBuilder($url);
        list($builder, $token) = $url_builder->acquireParameter(['namespace'], 'param');

        $action = $f->standard('label', $builder, $token);
        $closure = $renderer->p_getActionRegistration('action_id', $action);

        $actual = $this->brutallyTrimHTML($closure('component_id'));
        $url = $url->__toString();
        $expected = $this->brutallyTrimHTML(
            'il.UI.table.data.get(\'component_id\').registerAction(\'action_id\', false, new il.UI.core.URLBuilder(new URL("http://wwww.ilias.de?ref_id=1&namespace_param="), new Map([["namespace_param",new il.UI.core.URLBuilderToken(["namespace"], "param",'
        );
        $this->assertStringStartsWith($expected, $actual);
    }

Here is the call graph for this function:

testDataTableGetMultiActionHandler()

DataRendererTest::testDataTableGetMultiActionHandler

(

)

Definition at line 160 of file DataRendererTest.php.

    {
        $renderer = $this->getRenderer();
        $signal = new I\Signal('signal_id');
        $closure = $renderer->p_getMultiActionHandler($signal);
        $actual = $this->brutallyTrimHTML($closure('component_id'));
        $expected = $this->brutallyTrimHTML(
            "$(document).on('signal_id', function(event, signal_data) { 
                il.UI.table.data.get('component_id').doMultiAction(signal_data); 
                return false; 
            });"
        );
        $this->assertEquals($expected, $actual);
    }

testDataTableMultiActionsDropdown()

DataRendererTest::testDataTableMultiActionsDropdown

(

)

Definition at line 194 of file DataRendererTest.php.

References Vendor\Package\$f, $token, $url, and ILIAS\UI\Implementation\Component\Input\getDataFactory().

    {
        $renderer = $this->getRenderer();
        $f = $this->getActionFactory();
        $signal1 = new I\Signal('signal_id');
        $signal2 = new I\Signal('signal_id2');
        $url = $this->getDataFactory()->uri('http://wwww.ilias.de?ref_id=1');
        $url_builder = new URLBuilder($url);
        list($builder, $token) = $url_builder->acquireParameter(['namespace'], 'param');
        $actions = [
            $f->standard('label1', $builder, $token),
            $f->standard('label2', $builder, $token)
        ];
        $this->assertNull(
            $renderer->p_buildMultiActionsDropdown([], $signal1, $signal2)
        );
        $this->assertEquals(
            4, //2 actions, 1 divider, one all-action
            count($renderer->p_buildMultiActionsDropdown($actions, $signal1, $signal2)->getItems())
        );
    }

Here is the call graph for this function:

testDataTableRenderHeaderWithActions()

DataRendererTest::testDataTableRenderHeaderWithActions

(

)

Definition at line 387 of file DataRendererTest.php.

References $data, Vendor\Package\$f, $token, $tpl, and $url.

                                                          : void
    {
        $renderer = $this->getRenderer();
        $data_factory = new \ILIAS\Data\Factory();
        $tpl = $this->getTemplateFactory()->getTemplate("src/UI/templates/default/Table/tpl.datatable.html", true, true);
        $f = $this->getColumnFactory();

        $url = $data_factory->uri('http://wwww.ilias.de?ref_id=1');
        $url_builder = new URLBuilder($url);
        list($builder, $token) = $url_builder->acquireParameter(['namespace'], 'param');
        $actions = [
            'a2' => $this->getActionFactory()->standard('some action', $builder, $token)
        ];

        $data = new class () implements ILIAS\UI\Component\Table\DataRetrieval {
            public function getRows(
                Component\Table\DataRowBuilder $row_builder,
                array $visible_column_ids,
                Data\Range $range,
                Data\Order $order,
                ?array $filter_data,
                ?array $additional_parameters
            ): \Generator {
                yield $row_builder->buldDataRow('', []);
            }
            public function getTotalRowCount(
                ?array $filter_data,
                ?array $additional_parameters
            ): ?int {
                return null;
            }
        };
        $columns = [
            'f1' => $f->text("Field 1")->withIsSortable(false),
        ];

        $sortation_signal = null;

        $table = $this->getUIFactory()->table()->data('', $columns, $data)
            ->withActions($actions)
            ->withRequest($this->getDummyRequest());
        $renderer->p_renderTableHeader($this->getDefaultRenderer(), $table, $tpl, $sortation_signal);
        $actual = $this->brutallyTrimHTML($tpl->get());

        $expected = '<th class="c-table-data__header c-table-data__cell c-table-data__header__rowaction" role="columnheader" aria-colindex="1">actions</th>';
        $this->assertStringContainsString($expected, $actual);
    }

testDataTableRenderHeaderWithoutSortableColums()

DataRendererTest::testDataTableRenderHeaderWithoutSortableColums

(

)

Definition at line 314 of file DataRendererTest.php.

References $data, Vendor\Package\$f, and $tpl.

                                                                    : void
    {
        $renderer = $this->getRenderer();
        $data_factory = new \ILIAS\Data\Factory();
        $tpl = $this->getTemplateFactory()->getTemplate("src/UI/templates/default/Table/tpl.datatable.html", true, true);
        $f = $this->getColumnFactory();
        $data = new class () implements ILIAS\UI\Component\Table\DataRetrieval {
            public function getRows(
                Component\Table\DataRowBuilder $row_builder,
                array $visible_column_ids,
                Data\Range $range,
                Data\Order $order,
                ?array $filter_data,
                ?array $additional_parameters
            ): \Generator {
                yield $row_builder->buldDataRow('', []);
            }
            public function getTotalRowCount(
                ?array $filter_data,
                ?array $additional_parameters
            ): ?int {
                return null;
            }
        };
        $columns = [
            'f1' => $f->text("Field 1")->withIsSortable(false),
            'f2' => $f->text("Field 2")->withIsSortable(false)
        ];

        $sortation_signal = null;

        $table = $this->getUIFactory()->table()->data('', $columns, $data)
            ->withRequest($this->getDummyRequest());
        $renderer->p_renderTableHeader($this->getDefaultRenderer(), $table, $tpl, $sortation_signal);
        $actual = $this->brutallyTrimHTML($tpl->get());
        $expected = <<<EOT
<div class="c-table-data" id="{ID}">
    <div class="viewcontrols">{VIEW_CONTROLS}</div>
    <div class="c-table-data__table-wrapper">
        <table class="c-table-data__table" role="grid" aria-labelledby="{ID}_label" aria-colcount="{COL_COUNT}">
            <thead>
                <tr class="c-table-data__header c-table-data__row" role="rowgroup">
                    <th class="c-table-data__header c-table-data__cell c-table-data__cell--text" role="columnheader" tabindex="-1" aria-colindex="0">
                        <div class="c-table-data__header__resize-wrapper">Field 1</div>
                    </th>
                    <th class="c-table-data__header c-table-data__cell c-table-data__cell--text" role="columnheader" tabindex="-1" aria-colindex="1">
                        <div class="c-table-data__header__resize-wrapper">Field 2</div>
                    </th>
                </tr>
            </thead>
            <tbody class="c-table-data__body" role="rowgroup"></tbody>
        </table>
    </div>

    <div class="c-table-data__async_modal_container"></div>

    <div class="c-table-data__async_message modal" role="dialog" id="{ID}_msgmodal">
        <div class="modal-dialog" role="document">
            <div class="modal-content">
                <div class="modal-header">
                    <button type="button" class="close" data-dismiss="modal" aria-label="close"><span aria-hidden="true">&times;</span></button>
                </div>
                <div class="c-table-data__async_messageresponse modal-body"></div>
            </div>
        </div>
    </div>

</div>
EOT;
        $expected = $this->brutallyTrimHTML($expected);
        $this->assertEquals($expected, $actual);
    }

testDataTableRenderStandardRow()

DataRendererTest::testDataTableRenderStandardRow

(

I\Table\DataRow

$row

)

testDataTableDataRowFromBuilder

Definition at line 495 of file DataRendererTest.php.

    {
        $actual = $this->brutallyTrimHTML($this->getDefaultRenderer()->render($row));
        $expected = <<<EOT
<td class="c-table-data__cell c-table-data__rowselection" role="gridcell" tabindex="-1">
    <input type="checkbox" value="row_id-1" class="c-table-data__row-selector">
</td>
<td class="c-table-data__cell c-table-data__cell--text " role="gridcell" aria-colindex="1" tabindex="-1">
    <span class="c-table-data__cell__col-title">Field 1:</span>v1
</td>
<td class="c-table-data__cell c-table-data__cell--text " role="gridcell" aria-colindex="2" tabindex="-1">
    <span class="c-table-data__cell__col-title">Field 2:</span>v2
</td>
<td class="c-table-data__cell c-table-data__cell--number " role="gridcell" aria-colindex="3" tabindex="-1">
    <span class="c-table-data__cell__col-title">Field 3:</span>3
</td>
<td class="c-table-data__cell c-table-data__rowaction" role="gridcell" tabindex="-1">
    <div class="dropdown">
        <button class="btn btn-default dropdown-toggle" type="button" data-toggle="dropdown" id="id_3" aria-label="actions" aria-haspopup="true" aria-expanded="false" aria-controls="id_3_menu"><span class="caret"></span></button>
        <ul id="id_3_menu" class="dropdown-menu">
            <li><button class="btn btn-link" data-action="http://wwww.ilias.de?ref_id=1&namespace_param%5B%5D=row_id-1" id="id_1">label1</button></li>
            <li><button class="btn btn-link" data-action="http://wwww.ilias.de?ref_id=1&namespace_param%5B%5D=row_id-1" id="id_2">label2</button></li>
        </ul>
    </div>
</td>
EOT;
        $expected = $this->brutallyTrimHTML($expected);
        $this->assertEquals($expected, $actual);
    }

testDataTableRenderTableHeader()

DataRendererTest::testDataTableRenderTableHeader

(

)

Definition at line 232 of file DataRendererTest.php.

References $data, Vendor\Package\$f, and $tpl.

    {
        $renderer = $this->getRenderer();
        $data_factory = new \ILIAS\Data\Factory();
        $tpl = $this->getTemplateFactory()->getTemplate("src/UI/templates/default/Table/tpl.datatable.html", true, true);
        $f = $this->getColumnFactory();
        $data = new class () implements ILIAS\UI\Component\Table\DataRetrieval {
            public function getRows(
                Component\Table\DataRowBuilder $row_builder,
                array $visible_column_ids,
                Data\Range $range,
                Data\Order $order,
                ?array $filter_data,
                ?array $additional_parameters
            ): \Generator {
                yield $row_builder->buldDataRow('', []);
            }
            public function getTotalRowCount(
                ?array $filter_data,
                ?array $additional_parameters
            ): ?int {
                return null;
            }
        };
        $columns = [
            'f1' => $f->text("Field 1")->withIndex(1),
            'f2' => $f->text("Field 2")->withIndex(2)->withIsSortable(false),
            'f3' => $f->number("Field 3")->withIndex(3)
        ];
        $sortation_signal = new I\Signal('sort_header_signal_id');
        $sortation_signal->addOption('value', 'f1:ASC');
        $table = $this->getUIFactory()->table()->data('', $columns, $data)
            ->withRequest($this->getDummyRequest());
        $renderer->p_renderTableHeader($this->getDefaultRenderer(), $table, $tpl, $sortation_signal);

        $actual = $this->brutallyTrimHTML($tpl->get());
        $expected = <<<EOT
<div class="c-table-data" id="{ID}">
    <div class="viewcontrols">{VIEW_CONTROLS}</div>
    <div class="c-table-data__table-wrapper">
        <table class="c-table-data__table" role="grid" aria-labelledby="{ID}_label" aria-colcount="{COL_COUNT}">
            <thead>
                <tr class="c-table-data__header c-table-data__row" role="rowgroup">
                    <th class="c-table-data__header c-table-data__cell c-table-data__cell--text" role="columnheader" tabindex="-1" aria-colindex="0" aria-sort="order_option_generic_ascending">
                        <div class="c-table-data__header__resize-wrapper">
                            <a tabindex="0" class="glyph" href="#" aria-label="sort_ascending" id="id_2"><span class="glyphicon glyphicon-arrow-up" aria-hidden="true"></span></a>
                            <button class="btn btn-link" id="id_1">Field 1</button>
                        </div>
                    </th>
                    <th class="c-table-data__header c-table-data__cell c-table-data__cell--text" role="columnheader" tabindex="-1" aria-colindex="1">
                        <div class="c-table-data__header__resize-wrapper">Field 2</div>
                    </th>
                    <th class="c-table-data__header c-table-data__cell c-table-data__cell--number" role="columnheader" tabindex="-1" aria-colindex="2">
                        <div class="c-table-data__header__resize-wrapper">
                            <button class="btn btn-link" id="id_3">Field 3</button>
                        </div>
                    </th>
                </tr>
            </thead>
            <tbody class="c-table-data__body" role="rowgroup"></tbody>
        </table>
    </div>
    <div class="c-table-data__async_modal_container"></div>

    <div class="c-table-data__async_message modal" role="dialog" id="{ID}_msgmodal">
        <div class="modal-dialog" role="document">
            <div class="modal-content">
                <div class="modal-header">
                    <button type="button" class="close" data-dismiss="modal" aria-label="close"><span aria-hidden="true">&times;</span></button>
                </div>
                <div class="c-table-data__async_messageresponse modal-body"></div>
            </div>
        </div>
    </div>

</div>
EOT;
        $expected = $this->brutallyTrimHTML($expected);
        $this->assertEquals($expected, $actual);
    }

testDataTableRowBuilder()

DataRendererTest::testDataTableRowBuilder

(

)

Definition at line 435 of file DataRendererTest.php.

References Vendor\Package\$f, $token, $url, and ILIAS\UI\Implementation\Component\Input\getDataFactory().

    {
        $f = $this->getColumnFactory();
        $columns = [
            'f1' => $f->text("Field 1")->withIndex(1),
            'f2' => $f->text("Field 2")->withIndex(2),
            'f3' => $f->number("Field 3")->withIndex(3)
        ];
        $f = $this->getActionFactory();
        $url = $this->getDataFactory()->uri('http://wwww.ilias.de?ref_id=1');
        $url_builder = new URLBuilder($url);
        list($builder, $token) = $url_builder->acquireParameter(['namespace'], 'param');
        $actions = [
            'a1' => $f->standard('label1', $builder, $token)->withAsync(),
            'a2' => $f->standard('label2', $builder, $token)
        ];

        $rb = (new I\Table\DataRowBuilder())
            ->withMultiActionsPresent(true)
            ->withSingleActions($actions)
            ->withVisibleColumns($columns);

        $row = $rb->buildDataRow('row_id-1', []);
        $this->assertInstanceOf(Component\Table\DataRow::class, $row);

        return [$rb, $columns, $actions];
    }

Here is the call graph for this function:

testDataTableSingleActionsDropdown()

DataRendererTest::testDataTableSingleActionsDropdown

(

)

Definition at line 215 of file DataRendererTest.php.

References Vendor\Package\$f, $token, $url, and ILIAS\UI\Implementation\Component\Input\getDataFactory().

    {
        $renderer = $this->getRenderer();
        $f = $this->getActionFactory();
        $url = $this->getDataFactory()->uri('http://wwww.ilias.de?ref_id=1');
        $url_builder = new URLBuilder($url);
        list($builder, $token) = $url_builder->acquireParameter(['namespace'], 'param');
        $actions = [
            'a1' => $f->standard('label1', $builder, $token)->withAsync(),
            'a2' => $f->standard('label2', $builder, $token)
        ];
        $this->assertEquals(
            2,
            count($renderer->p_getSingleActionsForRow('row_id-1', $actions)->getItems())
        );
    }

Here is the call graph for this function:

testRenderEmptyDataCell()

DataRendererTest::testRenderEmptyDataCell

(

)

Definition at line 525 of file DataRendererTest.php.

References $data, and ILIAS\UI\Implementation\Component\Input\getLanguage().

                                             : void
    {
        $data = new class () implements Component\Table\DataRetrieval {
            public function getRows(
                Component\Table\DataRowBuilder $row_builder,
                array $visible_column_ids,
                Data\Range $range,
                Data\Order $order,
                ?array $filter_data,
                ?array $additional_parameters
            ): Generator {
                yield from [];
            }

            public function getTotalRowCount(?array $filter_data, ?array $additional_parameters): ?int
            {
                return 0;
            }
        };

        $columns = [
            'f1' => $this->getUIFactory()->table()->column()->text('f1'),
            'f2' => $this->getUIFactory()->table()->column()->text('f2'),
            'f3' => $this->getUIFactory()->table()->column()->text('f3'),
            'f4' => $this->getUIFactory()->table()->column()->text('f4'),
            'f5' => $this->getUIFactory()->table()->column()->text('f5'),
        ];

        $table = $this->getTableFactory()->data('', $columns, $data)
            ->withRequest($this->getDummyRequest());

        $html = $this->getDefaultRenderer()->render($table);

        $translation = $this->getLanguage()->txt('ui_table_no_records');
        $column_count = count($columns);

        // check that the empty cell is stretched over all columns.
        $this->assertTrue(str_contains($html, "colspan=\"$column_count\""));
        // check that the cell contains the default message.
        $this->assertTrue(str_contains($html, $translation));
    }

Here is the call graph for this function:

---

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

• tests/UI/Component/Table/DataRendererTest.php