Describes how Input-Elements want to interact with posted data. More...
Inheritance diagram for ILIAS\UI\Component\Input\InputData:
Collaboration diagram for ILIAS\UI\Component\Input\InputData:
Public Member Functions | |
| get (string $name) | |
| Get a named value from the data. More... | |
| getOr (string $name, $default) | |
| Get a named value from the data and fallback to default if that name does not exist. More... | |
| has (string $name) | |
| Check for existence of parameter name in data. More... | |
Detailed Description
Describes how Input-Elements want to interact with posted data.
This basically is a glorified array.
Definition at line 29 of file InputData.php.
Member Function Documentation
◆ get()
| ILIAS\UI\Component\Input\InputData::get | ( | string | $name | ) |
Get a named value from the data.
- Exceptions
-
LogicException if name is not in data
- Returns
- mixed
Implemented in ILIAS\UI\Implementation\Component\Input\PostDataFromServerRequest, ILIAS\UI\Implementation\Component\Input\QueryParamsFromServerRequest, ILIAS\UI\Implementation\Component\Input\StackedInputData, DefInputData, and _PWDInputData.
◆ getOr()
| ILIAS\UI\Component\Input\InputData::getOr | ( | string | $name, |
| $default | |||
| ) |
Get a named value from the data and fallback to default if that name does not exist.
- Parameters
-
mixed $default
- Returns
- mixed
Implemented in ILIAS\UI\Implementation\Component\Input\PostDataFromServerRequest, ILIAS\UI\Implementation\Component\Input\QueryParamsFromServerRequest, ILIAS\UI\Implementation\Component\Input\StackedInputData, DefInputData, and _PWDInputData.
Referenced by ILIAS\UI\Implementation\Component\Input\Field\Checkbox\withInput(), ILIAS\UI\Implementation\Component\Input\Field\OptionalGroup\withInput(), ILIAS\UI\Implementation\Component\Input\Field\Radio\withInput(), ILIAS\UI\Implementation\Component\Input\Field\Tag\withInput(), and ILIAS\UI\Implementation\Component\Input\Input\withInput().
Here is the caller graph for this function:
◆ has()
| ILIAS\UI\Component\Input\InputData::has | ( | string | $name | ) |
Check for existence of parameter name in data.
The documentation for this interface was generated from the following file:
- components/ILIAS/UI/src/Component/Input/InputData.php
