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 ()

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

Additional Inherited Members
Protected Member Functions inherited from TableTestBase
	buildFieldFactory ()
	buildRefinery ()
	getViewControlFactory ()
	getViewControlContainerFactory ()
	getTableFactory ()
	getMockStorage ()

Detailed Description

Tests for the Renderer of DataTables.

Definition at line 81 of file DataRendererTest.php.

Member Function Documentation

getActionFactory()

DataRendererTest::getActionFactory ( )

private

Definition at line 97 of file DataRendererTest.php.

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

getColumnFactory()

DataRendererTest::getColumnFactory ( )

private

Definition at line 102 of file DataRendererTest.php.

References getLanguage().

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

Here is the call graph for this function:

getDataFactory()

DataRendererTest::getDataFactory

(

)

Definition at line 121 of file DataRendererTest.php.

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

getDummyRequest()

DataRendererTest::getDummyRequest ( )

private

Definition at line 109 of file DataRendererTest.php.

    {
        $request = $this->createMock(ServerRequestInterface::class);
        $request
            ->method("getUri")
            ->willReturn(new \GuzzleHttp\Psr7\Uri('http://localhost:80'));
        $request
            ->method("getQueryParams")
            ->willReturn([]);
        return $request;
    }

getRenderer()

DataRendererTest::getRenderer ( )

private

Definition at line 83 of file DataRendererTest.php.

References getLanguage().

    {
        return new DTRenderer(
            $this->getUIFactory(),
            $this->getTemplateFactory(),
            $this->getLanguage(),
            $this->getJavaScriptBinding(),
            new ilImagePathResolver(),
            new \ILIAS\Data\Factory(),
            new \ILIAS\UI\Help\TextRetriever\Echoing(),
            $this->getUploadLimitResolver()
        );
    }

Here is the call graph for this function:

getUIFactory()

DataRendererTest::getUIFactory

(

)

Definition at line 126 of file DataRendererTest.php.

References ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\button(), and ILIAS\Repository\symbol().

                                  : NoUIFactory
    {
        $factory = new class ($this->getTableFactory()) extends NoUIFactory {
            public function __construct(
                protected I\Table\Factory $table_factory
            ) {
            }
            public function button(): I\Button\Factory
            {
                return new I\Button\Factory();
            }
            public function dropdown(): I\Dropdown\Factory
            {
                return new I\Dropdown\Factory();
            }
            public function symbol(): I\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(): I\Table\Factory
            {
                return $this->table_factory;
            }
            public function divider(): I\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 467 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 176 of file DataRendererTest.php.

References Vendor\Package\$f, $renderer, $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 161 of file DataRendererTest.php.

References $renderer.

    {
        $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 195 of file DataRendererTest.php.

References Vendor\Package\$f, $renderer, $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 388 of file DataRendererTest.php.

References $data, Vendor\Package\$f, ILIAS\UI\Implementation\Component\Table\$range, $renderer, $token, $url, and null.

                                                          : void
    {
        $renderer = $this->getRenderer();
        $data_factory = new \ILIAS\Data\Factory();
        $tpl = $this->getTemplateFactory()->getTemplate("components/ILIAS/UI/src/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($data, '', $columns)
            ->withActions($actions)
            ->withRequest($this->getDummyRequest());
        $renderer->p_renderActionsHeader($this->getDefaultRenderer(), $table, $tpl);
        $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 315 of file DataRendererTest.php.

References $data, Vendor\Package\$f, ILIAS\UI\Implementation\Component\Table\$range, $renderer, ILIAS\Repository\button(), ILIAS\Repository\form(), and null.

                                                                    : void
    {
        $renderer = $this->getRenderer();
        $data_factory = new \ILIAS\Data\Factory();
        $tpl = $this->getTemplateFactory()->getTemplate("components/ILIAS/UI/src/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($data, '', $columns)
            ->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>

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

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

Here is the call graph for this function:

testDataTableRenderStandardRow()

DataRendererTest::testDataTableRenderStandardRow

(

I\Table\DataRow

$row

)

testDataTableDataRowFromBuilder

Definition at line 496 of file DataRendererTest.php.

References ILIAS\Repository\button().

    {
        $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" id="id_3">
        <button class="btn btn-default dropdown-toggle" type="button" 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);
    }

Here is the call graph for this function:

testDataTableRenderTableHeader()

DataRendererTest::testDataTableRenderTableHeader

(

)

Definition at line 233 of file DataRendererTest.php.

References $data, Vendor\Package\$f, ILIAS\UI\Implementation\Component\Table\$range, $renderer, ILIAS\Repository\button(), ILIAS\Repository\form(), null, and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

    {
        $renderer = $this->getRenderer();
        $data_factory = new \ILIAS\Data\Factory();
        $tpl = $this->getTemplateFactory()->getTemplate("components/ILIAS/UI/src/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($data, '', $columns)
            ->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>

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

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

Here is the call graph for this function:

testDataTableRowBuilder()

DataRendererTest::testDataTableRowBuilder

(

)

Definition at line 436 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 216 of file DataRendererTest.php.

References Vendor\Package\$f, $renderer, $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 526 of file DataRendererTest.php.

References $data, ILIAS\UI\Implementation\Component\Table\$range, ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), and 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($data, '', $columns)
            ->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:

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