ILIAS  trunk Revision v11.0_alpha-2645-g16283d3b3f8
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 (?array $filter)
 
 withAdditionalParameters (?array $additional_parameters)
 
 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 Data Table.

Definition at line 30 of file Data.php.

Member Function Documentation

◆ withActions()

ILIAS\UI\Component\Table\Data::withActions ( array  $actions)
Parameters
array<string,Action

◆ withAdditionalParameters()

ILIAS\UI\Component\Table\Data::withAdditionalParameters ( ?array  $additional_parameters)

◆ withFilter()

ILIAS\UI\Component\Table\Data::withFilter ( ?array  $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.

◆ withOrder()

ILIAS\UI\Component\Table\Data::withOrder ( ?Order  $order)

◆ 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...).

◆ 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: