ILIAS
trunk Revision v5.2.0beta1-34115-g3a2438be29
|
Public Member Functions | |||
__construct (string $title, array $view_controls, protected Closure $row_mapping, protected SignalGeneratorInterface $signal_generator) | |||
getSignalGenerator () | |||
withRowMapping (Closure $row_mapping) | |||
Get a table like this with the closure $row_mapping.This closure is called by the renderer upon building a row from a record. The renderer will call the closure with these parameters:$row An instance of Component; fill the mutator according to your needs and the structure of your record. $record An element of the table's data. This is the actually variable part when rendering rows. $ui_factory You might, e.g., want a descriptive listing or and image within the content of the row. Use the UI-Factory to build it. $environment When you need auxiliary classes or functions to properly render the data, this is the place to put it.In short: The closure MUST accept the following parameter $row mixed $record $ui_factory mixed $environment The closure MUST return More... | |||
getRowMapping () | |||
Get the closure to construct row-entries with. More... | |||
withEnvironment (array $environment) | |||
Add a list of additional things the mapping-closure needs for processing.These can be virtually anything.
| |||
getEnvironment () | |||
Get an array of additionally needed elements to build a data-entry.
| |||
withData (array $records) | |||
Fill a recordset into the table.All elements in $records MUST be processable by the mapping-closure.
| |||
getData () | |||
Get the recordset of this table.All elements in $records MUST be processable by the mapping-closure.
| |||
getExpandCollapseAllSignal () | |||
Public Member Functions inherited from ILIAS\UI\Implementation\Component\Table\Table | |||
__construct (protected string $title) | |||
withTitle (string $title) | |||
getTitle () | |||
Public Member Functions inherited from ILIAS\UI\Component\Component | |||
getCanonicalName () | |||
Get the canonical name of the component. More... | |||
Public Member Functions inherited from ILIAS\UI\Component\ViewControl\HasViewControls | |||
withViewControls (array $view_controls) | |||
Add View Controls. More... | |||
getViewControls () | |||
Get View Controls. More... | |||
Public Member Functions inherited from ILIAS\UI\Component\JavaScriptBindable | |||
withOnLoadCode (Closure $binder) | |||
withAdditionalOnLoadCode (Closure $binder) | |||
Add some onload-code to the component instead of replacing the existing one. More... | |||
getOnLoadCode () | |||
Get the currently bound on load code. More... | |||
Protected Attributes | |
Signal | $signal_toggle_all |
Private Attributes | |
array | $environment = [] |
array | $records = [] |
Definition at line 31 of file Presentation.php.
ILIAS\UI\Implementation\Component\Table\Presentation::__construct | ( | string | $title, |
array | $view_controls, | ||
protected Closure | $row_mapping, | ||
protected SignalGeneratorInterface | $signal_generator | ||
) |
Definition at line 45 of file Presentation.php.
References ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\UI\Implementation\Component\SignalGeneratorInterface\create().
ILIAS\UI\Implementation\Component\Table\Presentation::getData | ( | ) |
Get the recordset of this table.All elements in $records MUST be processable by the mapping-closure.
Implements ILIAS\UI\Component\Table\Presentation.
Definition at line 110 of file Presentation.php.
References ILIAS\UI\Implementation\Component\Table\Presentation\$records.
ILIAS\UI\Implementation\Component\Table\Presentation::getEnvironment | ( | ) |
Get an array of additionally needed elements to build a data-entry.
Implements ILIAS\UI\Component\Table\Presentation.
Definition at line 92 of file Presentation.php.
References ILIAS\UI\Implementation\Component\Table\Presentation\$environment.
ILIAS\UI\Implementation\Component\Table\Presentation::getExpandCollapseAllSignal | ( | ) |
Definition at line 115 of file Presentation.php.
References ILIAS\UI\Implementation\Component\Table\Presentation\$signal_toggle_all.
ILIAS\UI\Implementation\Component\Table\Presentation::getRowMapping | ( | ) |
Get the closure to construct row-entries with.
Implements ILIAS\UI\Component\Table\Presentation.
Definition at line 74 of file Presentation.php.
ILIAS\UI\Implementation\Component\Table\Presentation::getSignalGenerator | ( | ) |
Definition at line 56 of file Presentation.php.
ILIAS\UI\Implementation\Component\Table\Presentation::withData | ( | array | $records | ) |
Fill a recordset into the table.All elements in $records MUST be processable by the mapping-closure.
array<mixed> | $records |
Implements ILIAS\UI\Component\Table\Presentation.
Definition at line 100 of file Presentation.php.
References ILIAS\UI\Implementation\Component\Table\Presentation\$records.
ILIAS\UI\Implementation\Component\Table\Presentation::withEnvironment | ( | array | $environment | ) |
Add a list of additional things the mapping-closure needs for processing.These can be virtually anything.
array<string,mixed> | $environment |
Implements ILIAS\UI\Component\Table\Presentation.
Definition at line 82 of file Presentation.php.
References ILIAS\UI\Implementation\Component\Table\Presentation\$environment.
ILIAS\UI\Implementation\Component\Table\Presentation::withRowMapping | ( | Closure | $row_mapping | ) |
Get a table like this with the closure $row_mapping.This closure is called by the renderer upon building a row from a record. The renderer will call the closure with these parameters:$row An instance of Component; fill the mutator according to your needs and the structure of your record. $record An element of the table's data. This is the actually variable part when rendering rows. $ui_factory You might, e.g., want a descriptive listing or and image within the content of the row. Use the UI-Factory to build it. $environment When you need auxiliary classes or functions to properly render the data, this is the place to put it.In short: The closure MUST accept the following parameter $row mixed $record $ui_factory mixed $environment The closure MUST return
Implements ILIAS\UI\Component\Table\Presentation.
Definition at line 64 of file Presentation.php.
|
private |
Definition at line 40 of file Presentation.php.
Referenced by ILIAS\UI\Implementation\Component\Table\Presentation\getEnvironment(), and ILIAS\UI\Implementation\Component\Table\Presentation\withEnvironment().
|
private |
Definition at line 42 of file Presentation.php.
Referenced by ILIAS\UI\Implementation\Component\Table\Presentation\getData(), and ILIAS\UI\Implementation\Component\Table\Presentation\withData().
|
protected |
Definition at line 43 of file Presentation.php.
Referenced by ILIAS\UI\Implementation\Component\Table\Presentation\getExpandCollapseAllSignal().