This describes a Table to specify the order of its data (rows). More...

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

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

Public Member Functions
	withActions (array $actions)

	withRequest (ServerRequestInterface $request)

	getData ()

	withOrderingDisabled (bool $flag)
	Turns ordering capabilites off/on. 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...

	withId (string $id)
	The DataTable comes with a storage to keep e.g. 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 Table to specify the order of its data (rows).

Definition at line 28 of file Ordering.php.

Member Function Documentation

◆ getData()

ILIAS\UI\Component\Table\Ordering::getData ( )

Returns: string[] the row-ids in the current (submitted) order

◆ withActions()

ILIAS\UI\Component\Table\Ordering::withActions ( array $actions )

Parameters

array<string,Action

Action> $actions

Referenced by ILIAS\LegalDocuments\Table\DocumentTable\buildTable(), ILIAS\GlobalScreen\UI\Footer\Entries\EntriesTable\get(), and ILIAS\GlobalScreen\UI\Footer\Groups\GroupsTable\get().

Here is the caller graph for this function:

◆ withId()

ILIAS\UI\Component\Table\Ordering::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\QuestionsTable\getTableComponent().

Here is the caller graph for this function:

◆ withOrderingDisabled()

ILIAS\UI\Component\Table\Ordering::withOrderingDisabled ( bool $flag )

Turns ordering capabilites off/on.

◆ withRequest()

ILIAS\UI\Component\Table\Ordering::withRequest ( ServerRequestInterface $request )

◆ withSelectedOptionalColumns()

ILIAS\UI\Component\Table\Ordering::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)