ILIAS\UI\Component\Table\Data Interface Reference

This describes a Data Table. More...

Inheritance diagram for ILIAS\UI\Component\Table\Data:

Collaboration diagram for ILIAS\UI\Component\Table\Data:

Public Member Functions
	withActions (array $actions)
	withRequest (ServerRequestInterface $request)
	Rendering the Table must be done using the current Request: it (the request) will be forwarded to the Table's View Control Container, and parameters will already influence e.g. More...
	withSelectedOptionalColumns (array $selected_optional_column_ids)
	Not all columns are neccessarily visible; "selected optional" is the positive list of shown columns (the non-optional columns are always shown and are not included here) More...
	withOrder (?Order $order)
	withRange (?Range $range)
	withFilter (mixed $filter)
	withAdditionalParameters (mixed $additional_parameters)
	withId (string $id)
	The DataTable comes with a storage to keep e.g. More...
	withAdditionalViewControl (ViewControlInput $view_control)
	Consumers may add additional view controls; their data will be relayed to DataRetrieval::getRows and ::getTotalRowCount as additional parameter. More...
Public Member Functions inherited from ILIAS\UI\Component\Table\Table
	withTitle (string $title)
	getTitle ()
Public Member Functions inherited from ILIAS\UI\Component\Component
	getCanonicalName ()
	Get the canonical name of the component. More...
	reduceWith (\Closure $fn)
	The scheme starts at the leaves of the structure and applies the function to each leave and moves up the tree recursively. More...

Detailed Description

This describes a Data Table.

Definition at line 32 of file Data.php.

Member Function Documentation

withActions()

ILIAS\UI\Component\Table\Data::withActions

(

array

$actions

)

Parameters

array<string,Action

Action> $actions

Referenced by ILIAS\Test\Logging\LogTable\getTable(), and ILIAS\TestQuestionPool\Questions\Presentation\QuestionTable\getTable().

Here is the caller graph for this function:

withAdditionalParameters()

ILIAS\UI\Component\Table\Data::withAdditionalParameters

(

mixed

$additional_parameters

)

withAdditionalViewControl()

ILIAS\UI\Component\Table\Data::withAdditionalViewControl

(

ViewControlInput

$view_control

)

Consumers may add additional view controls; their data will be relayed to DataRetrieval::getRows and ::getTotalRowCount as additional parameter.

If you want to add more than one additional view control, bundle them into an Input\ViewControl\Group.

withFilter()

ILIAS\UI\Component\Table\Data::withFilter

(

mixed

$filter

)

withId()

ILIAS\UI\Component\Table\Data::withId

(

string

$id

)

The DataTable comes with a storage to keep e.g.

ViewControl-settings throughout requests. Set an Id to enable the storage and identify the distinct table.

Referenced by ILIAS\Test\Questions\Presentation\QuestionsBrowserTable\getComponent(), ilOrgUnitPositionGUI\getTable(), and ilOrgUnitTypeGUI\getTable().

Here is the caller graph for this function:

withOrder()

ILIAS\UI\Component\Table\Data::withOrder

(

?Order

$order

)

Referenced by ILIAS\Certificate\Overview\CertificateOverviewTable\buildTable().

Here is the caller graph for this function:

withRange()

ILIAS\UI\Component\Table\Data::withRange

(

?Range

$range

)

withRequest()

ILIAS\UI\Component\Table\Data::withRequest

(

ServerRequestInterface

$request

)

Rendering the Table must be done using the current Request: it (the request) will be forwarded to the Table's View Control Container, and parameters will already influence e.g.

the presentation of column-titles (think of ordering...).

Referenced by ILIAS\components\ResourceStorage\Collections\View\RequestToDataTable\buildTable(), and ILIAS\components\ResourceStorage\Container\View\RequestToDataTable\buildTable().

Here is the caller graph for this function:

withSelectedOptionalColumns()

ILIAS\UI\Component\Table\Data::withSelectedOptionalColumns

(

array

$selected_optional_column_ids

)

Not all columns are neccessarily visible; "selected optional" is the positive list of shown columns (the non-optional columns are always shown and are not included here)

Parameters

string[]

$selected_optional_column_ids

---

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

• components/ILIAS/UI/src/Component/Table/Data.php