Tests for the Data Table. More...

Inheritance diagram for DataViewControlsTest:

Collaboration diagram for DataViewControlsTest:

Public Member Functions
	testDataTableHasViewControls ()

	testDataTableHasNoPaginationViewControl ()

	testDataTableHasNoOrderingViewControl ()

	testDataTableHasNoOrderingViewControlDueToRecordCount ()

	testDataTableHasNoFieldSelectionViewControl ()

	testDataTableViewControlStorage ()

Protected Member Functions
	getDataRetrieval (int $total_count)

	getTable (int $total_count, array $columns)

Protected Member Functions inherited from TableTestBase
	buildFieldFactory ()

	buildRefinery ()

	getViewControlFactory ()

	getViewControlContainerFactory ()

	getTableFactory ()

	getMockStorage ()

Private Member Functions
	getRequestMock (array $returns)

Detailed Description

Tests for the Data Table.

Definition at line 35 of file DataViewControlsTest.php.

Member Function Documentation

◆ getDataRetrieval()

DataViewControlsTest::getDataRetrieval ( int $total_count )

protected

Definition at line 37 of file DataViewControlsTest.php.

References ILIAS\UI\Implementation\Component\Table\$range, and ILIAS\GlobalScreen\Provider\__construct().

Referenced by getTable().

                                                          : I\Table\DataRetrieval
     {
         return new class ($total_count) implements I\Table\DataRetrieval {
             public function __construct(
                 protected int $total_count
             ) {
             }
             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 $this->total_count;
             }
         };
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRequestMock()

DataViewControlsTest::getRequestMock ( array $returns )

private

Definition at line 201 of file DataViewControlsTest.php.

Referenced by testDataTableViewControlStorage().

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

Here is the caller graph for this function:

◆ getTable()

DataViewControlsTest::getTable	(	int	$total_count,
		array	$columns
	)

protected

Definition at line 63 of file DataViewControlsTest.php.

References getDataRetrieval(), and TableTestBase\getTableFactory().

Referenced by testDataTableHasNoFieldSelectionViewControl(), testDataTableHasNoOrderingViewControl(), testDataTableHasNoOrderingViewControlDueToRecordCount(), testDataTableHasNoPaginationViewControl(), testDataTableHasViewControls(), and testDataTableViewControlStorage().

                                                                  : array
     {
         $factory = $this->getTableFactory();
         $table = $factory->data($this->getDataRetrieval($total_count), 'Table', $columns);
         return $table->applyViewControls([], []);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ testDataTableHasNoFieldSelectionViewControl()

DataViewControlsTest::testDataTableHasNoFieldSelectionViewControl ( )

Definition at line 181 of file DataViewControlsTest.php.

References getTable(), and TableTestBase\getTableFactory().

                                                                  : void
     {
         $factory = $this->getTableFactory();
         $columns = [
             'f1' => $factory->column()->text('f1'),
             'f2' => $factory->column()->text('f2'),
         ];
         $total_count = 200;
         list($table, $view_controls) = $this->getTable($total_count, $columns);
 
         $this->assertEquals(
             [
                 C\Table\Data::VIEWCONTROL_KEY_PAGINATION,
                 C\Table\Data::VIEWCONTROL_KEY_ORDERING,
             ],
             array_keys($view_controls->getInputs())
         );
     }

Here is the call graph for this function:

◆ testDataTableHasNoOrderingViewControl()

DataViewControlsTest::testDataTableHasNoOrderingViewControl ( )

Definition at line 124 of file DataViewControlsTest.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, getTable(), and TableTestBase\getTableFactory().

                                                            : void
     {
         $factory = $this->getTableFactory();
         $columns = [
             'f1' => $factory->column()->text('f1')
                 ->withIsSortable(false),
             'f2' => $factory->column()->text('f2')
                 ->withIsSortable(false)
                 ->withIsOptional(true),
         ];
         $total_count = 200;
         list($table, $view_controls) = $this->getTable($total_count, $columns);
 
 
         $inputs = $view_controls->getInputs();
         $this->assertEquals(
             [
                 C\Table\Data::VIEWCONTROL_KEY_PAGINATION,
                 C\Table\Data::VIEWCONTROL_KEY_ORDERING,
                 C\Table\Data::VIEWCONTROL_KEY_FIELDSELECTION,
             ],
             array_keys($inputs)
         );
         $this->assertInstanceOf(
             I\Input\ViewControl\Group::class,
             $inputs[C\Table\Data::VIEWCONTROL_KEY_ORDERING]
         );
     }

Here is the call graph for this function:

◆ testDataTableHasNoOrderingViewControlDueToRecordCount()

DataViewControlsTest::testDataTableHasNoOrderingViewControlDueToRecordCount ( )

Definition at line 153 of file DataViewControlsTest.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, getTable(), and TableTestBase\getTableFactory().

                                                                            : void
     {
         $factory = $this->getTableFactory();
         $columns = [
             'f1' => $factory->column()->text('f1')
                 ->withIsSortable(true),
             'f2' => $factory->column()->text('f2')
                 ->withIsSortable(true)
                 ->withIsOptional(true),
         ];
         $total_count = 1;
         list($table, $view_controls) = $this->getTable($total_count, $columns);
 
         $inputs = $view_controls->getInputs();
         $this->assertEquals(
             [
                 C\Table\Data::VIEWCONTROL_KEY_PAGINATION,
                 C\Table\Data::VIEWCONTROL_KEY_ORDERING,
                 C\Table\Data::VIEWCONTROL_KEY_FIELDSELECTION,
             ],
             array_keys($inputs)
         );
         $this->assertInstanceOf(
             I\Input\ViewControl\Group::class,
             $inputs[C\Table\Data::VIEWCONTROL_KEY_ORDERING]
         );
     }

Here is the call graph for this function:

◆ testDataTableHasNoPaginationViewControl()

DataViewControlsTest::testDataTableHasNoPaginationViewControl ( )

Definition at line 94 of file DataViewControlsTest.php.

References getTable(), and TableTestBase\getTableFactory().

                                                              : void
     {
         $factory = $this->getTableFactory();
         $columns = [
             'f1' => $factory->column()->text('f1'),
             'f2' => $factory->column()->text('f2')->withIsOptional(true),
         ];
         $total_count = current(C\Input\ViewControl\Pagination::DEFAULT_LIMITS) - 1;
         list($table, $view_controls) = $this->getTable($total_count, $columns);
 
         $this->assertEquals(
             [
                 C\Table\Data::VIEWCONTROL_KEY_PAGINATION,
                 C\Table\Data::VIEWCONTROL_KEY_ORDERING,
                 C\Table\Data::VIEWCONTROL_KEY_FIELDSELECTION,
             ],
             array_keys($view_controls->getInputs())
         );
         $this->assertInstanceOf(
             I\Input\ViewControl\Group::class,
             $view_controls->getInputs()[C\Table\Data::VIEWCONTROL_KEY_PAGINATION]
         );
 
         $group_contents = $view_controls->getInputs()[C\Table\Data::VIEWCONTROL_KEY_PAGINATION]->getInputs();
         array_walk(
             $group_contents,
             fn($vc) => $this->assertInstanceOf(I\Input\ViewControl\NullControl::class, $vc)
         );
     }

Here is the call graph for this function:

◆ testDataTableHasViewControls()

DataViewControlsTest::testDataTableHasViewControls ( )

Definition at line 70 of file DataViewControlsTest.php.

References getTable(), and TableTestBase\getTableFactory().

                                                   : void
     {
         $factory = $this->getTableFactory();
         $columns = [
             'f1' => $factory->column()->text('f1'),
             'f2' => $factory->column()->text('f2')->withIsOptional(true),
         ];
         $total_count = 12;
         list($table, $view_controls) = $this->getTable($total_count, $columns);
 
         $this->assertInstanceOf(I\Input\Container\ViewControl\ViewControl::class, $view_controls);
         $this->assertEquals(
             [
                 C\Table\Data::VIEWCONTROL_KEY_PAGINATION,
                 C\Table\Data::VIEWCONTROL_KEY_ORDERING,
                 C\Table\Data::VIEWCONTROL_KEY_FIELDSELECTION,
             ],
             array_keys($view_controls->getInputs())
         );
         foreach (array_values($view_controls->getInputs()) as $vc) {
             $this->assertInstanceOf(I\Input\Container\ViewControl\ViewControlInput::class, $vc);
         }
     }

Here is the call graph for this function:

◆ testDataTableViewControlStorage()

DataViewControlsTest::testDataTableViewControlStorage ( )

Definition at line 213 of file DataViewControlsTest.php.

References getRequestMock(), getTable(), and TableTestBase\getTableFactory().

                                                      : void
     {
         $factory = $this->getTableFactory();
         $columns = [
             'f1' => $factory->column()->text('f1')->withIsOptional(true),
             'f2' => $factory->column()->text('f2')->withIsOptional(true),
             'f3' => $factory->column()->text('f3')->withIsOptional(true),
         ];
         $total_count = 12;
         list($base_table, $view_controls) = $this->getTable($total_count, $columns);
 
         $table_id = 'testing_data_table';
         $table = $base_table
             ->withId($table_id)
             ->withRequest(
                 $this->getRequestMock([
                     'view_control/input_0/input_1' => 0,
                     'view_control/input_0/input_2' => 10,
                     'view_control/input_3/input_4' => 'f2',
                     'view_control/input_3/input_5' => 'DESC',
                     'view_control/input_6' => ['f2']
                 ])
             );
         list($table, $view_controls) = $table->applyViewControls([], []);
         //applied values from viewcontrols
         $this->assertEquals(new Range(0, 10), $table->getRange());
         $this->assertEquals(new Order('f2', Order::DESC), $table->getOrder());
         $this->assertEquals(1, count($table->getSelectedOptionalColumns()));
 
         //default_values for different id
         $table = $base_table
             ->withId('other id')
             ->withRequest($this->getRequestMock([]));
         list($table, $view_controls) = $table->applyViewControls([], []);
         $this->assertEquals(new Range(0, 12), $table->getRange());
         $this->assertEquals(new Order('f1', Order::ASC), $table->getOrder());
         $this->assertEquals(3, count($table->getSelectedOptionalColumns()));
 
         //applied values from session with empty request
         $table = $base_table
             ->withId($table_id)
             ->withRequest($this->getRequestMock([]));
         list($table, $view_controls) = $table->applyViewControls([], []);
         $this->assertEquals(new Range(0, 10), $table->getRange());
         $this->assertEquals(new Order('f2', Order::DESC), $table->getOrder());
         $this->assertEquals(1, count($table->getSelectedOptionalColumns()));
     }

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/DataViewControlsTest.php

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Member Function Documentation

◆ getDataRetrieval()

◆ getRequestMock()

◆ getTable()

◆ testDataTableHasNoFieldSelectionViewControl()

◆ testDataTableHasNoOrderingViewControl()

◆ testDataTableHasNoOrderingViewControlDueToRecordCount()

◆ testDataTableHasNoPaginationViewControl()

◆ testDataTableHasViewControls()

◆ testDataTableViewControlStorage()