ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable Class Reference

Inheritance diagram for ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable:

Collaboration diagram for ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable:

Public Member Functions
	__construct (protected readonly \ilCtrlInterface $ctrl, protected readonly \ilLanguage $lng, protected readonly UIFactory $ui_factory, protected readonly DataFactory $data_factory, protected readonly ServerRequestInterface $request, protected readonly PoolDefinitionList $pool_definition_list)
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, ?array $filter_data, ?array $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (?array $filter_data, ?array $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...
	getComponent ()

Protected Member Functions
	getData (Range $range, Order $order)
	getColumns ()
	getActions ()

Detailed Description

Definition at line 38 of file RandomQuestionSetNonAvailablePoolsTable.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable::__construct	(	protected readonly \ilCtrlInterface	$ctrl,
		protected readonly \ilLanguage	$lng,
		protected readonly UIFactory	$ui_factory,
		protected readonly DataFactory	$data_factory,
		protected readonly ServerRequestInterface	$request,
		protected readonly PoolDefinitionList	$pool_definition_list
	)

Definition at line 40 of file RandomQuestionSetNonAvailablePoolsTable.php.

      {
    }

Member Function Documentation

getActions()

ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable::getActions ( )

protected

Returns

array<string, Action>

Definition at line 109 of file RandomQuestionSetNonAvailablePoolsTable.php.

References ILIAS\Repository\lng().

Referenced by ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable\getComponent().

                                   : array
    {
        $target = $this->data_factory->uri((string) $this->request->getUri());
        $url_builder = new URLBuilder($target);
        [$url_builder, $id_token] = $url_builder->acquireParameters(
            ['derive_pool'],
            'ids'
        );
        return [
            'derive_pool' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('tst_derive_new_pool'),
                $url_builder->withURI($target->withParameter('cmd', ConfigGUI::CMD_SELECT_DERIVATION_TARGET)),
                $id_token
            )
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getColumns()

ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable::getColumns ( )

protected

Returns

array<string, Column>

Definition at line 96 of file RandomQuestionSetNonAvailablePoolsTable.php.

References ILIAS\Repository\lng().

Referenced by ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable\getComponent().

                                   : array
    {
        $column_factory = $this->ui_factory->table()->column();
        return [
            'title' => $column_factory->text($this->lng->txt('title')),
            'path' => $column_factory->text($this->lng->txt('path')),
            'status' => $column_factory->text($this->lng->txt('status')),
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getComponent()

ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable::getComponent

(

)

Definition at line 84 of file RandomQuestionSetNonAvailablePoolsTable.php.

References ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable\getActions(), ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable\getColumns(), and ILIAS\Repository\lng().

                                  : DataTable
    {
        return $this->ui_factory->table()
            ->data($this->lng->txt('tst_non_avail_pools_table'), $this->getColumns(), $this)
            ->withRequest($this->request)
            ->withActions($this->getActions())
            ->withId('tst_non_avail_pools_table');
    }

Here is the call graph for this function:

getData()

ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable::getData ( Range  $range, Order  $order  )

protected

Definition at line 73 of file RandomQuestionSetNonAvailablePoolsTable.php.

References $data, ILIAS\Data\Range\getLength(), and ILIAS\Data\Range\getStart().

Referenced by ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable\getRows().

                                                          : array
    {
        $data = array_map(fn($pool) => [
            'id' => $pool->getId(),
            'title' => $pool->getTitle(),
            'path' => $pool->getPath(),
            'status' => $pool->getUnavailabilityStatus(),
        ], $this->pool_definition_list->getNonAvailablePools());
        return array_slice($data, $range->getStart(), $range->getLength());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRows()

ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		?array	$filter_data,
		?array	$additional_parameters
	)

This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g.

yield $row_builder->buildStandardRow($row_id, $record).

Parameters

string[]

$visible_column_ids

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 50 of file RandomQuestionSetNonAvailablePoolsTable.php.

References ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable\getData(), ILIAS\Repository\lng(), and ilTestRandomQuestionSetNonAvailablePool\UNAVAILABILITY_STATUS_LOST.

     : Generator {
        foreach ($this->getData($range, $order) as $record) {
            $derive = $record['status'] === \ilTestRandomQuestionSetNonAvailablePool::UNAVAILABILITY_STATUS_LOST;

            $record['status'] = $this->lng->txt('tst_non_avail_pool_msg_status_' . $record['status']);
            yield $row_builder
                ->buildDataRow((string) $record['id'], $record)
                ->withDisabledAction('derive_pool', !$derive);
        }
    }

Here is the call graph for this function:

getTotalRowCount()

ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable::getTotalRowCount	(	?array	$filter_data,
		?array	$additional_parameters
	)

Mainly for the purpose of pagination-support, it is important to know about the total number of records available.

Given the nature of a DataTable, which is, opposite to a PresentationTable, rather administrative than explorative, this information will increase user experience quite a bit. However, you may return null, if the call is to costly, but expect the View Control to look a little different in this case.

Make sure that potential filters or user restrictions are being applied to the count.

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 68 of file RandomQuestionSetNonAvailablePoolsTable.php.

                                                                                        : ?int
    {
        return count($this->pool_definition_list->getNonAvailablePools());
    }

---

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

• components/ILIAS/Test/src/Questions/RandomQuestionSetNonAvailablePoolsTable.php