ILIAS
release_5-4 Revision v5.4.26-12-gabc799a52e6
◀ ilDoc Overview
Input.php
Go to the documentation of this file.
1
<?
php
2
3
/* Copyright (c) 2017 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */
4
5
namespace
ILIAS\UI\Component\Input\Field
;
6
7
use
ILIAS\UI\Component\Component
;
8
use
ILIAS\Transformation\Transformation
;
9
use
ILIAS\Validation\Constraint
;
10
30
interface
Input
extends
Component
31
{
32
38
public
function
getLabel
();
39
40
48
public
function
withLabel
($label);
49
50
56
public
function
getByline
();
57
58
66
public
function
withByline
($byline);
67
68
74
public
function
isRequired
();
75
76
84
public
function
withRequired
($is_required);
85
86
92
public
function
getValue
();
93
94
104
public
function
withValue
($value);
105
106
112
public
function
getError
();
113
114
122
public
function
withError
($error);
123
124
132
public
function
withAdditionalTransformation
(
Transformation
$trafo);
133
134
142
public
function
withAdditionalConstraint
(
Constraint
$constraint);
143
}
php
An exception for terminatinating execution or to throw for unit testing.
ILIAS\Transformation\Transformation
A transformation is a function from one datatype to another.
Definition:
Transformation.php:16
ILIAS\UI\Component\Component
A component is the most general form of an entity in the UI.
Definition:
Component.php:14
ILIAS\UI\Component\Input\Field\Input
This describes commonalities between all inputs.
Definition:
Input.php:31
ILIAS\UI\Component\Input\Field\Input\withByline
withByline($byline)
Get an input like this, but with an additional/replaced label.
ILIAS\UI\Component\Input\Field\Input\withAdditionalConstraint
withAdditionalConstraint(Constraint $constraint)
Apply a constraint to the content of the input.
ILIAS\UI\Component\Input\Field\Input\getValue
getValue()
Get the value that is displayed in the input client side.
ILIAS\UI\Component\Input\Field\Input\getByline
getByline()
Get the byline of the input.
ILIAS\UI\Component\Input\Field\Input\withValue
withValue($value)
Get an input like this with another value displayed on the client side.
ILIAS\UI\Component\Input\Field\Input\getLabel
getLabel()
Get the label of the input.
ILIAS\UI\Component\Input\Field\Input\withAdditionalTransformation
withAdditionalTransformation(Transformation $trafo)
Apply a transformation to the content of the input.
ILIAS\UI\Component\Input\Field\Input\withLabel
withLabel($label)
Get an input like this, but with a replaced label.
ILIAS\UI\Component\Input\Field\Input\isRequired
isRequired()
Is this field required?
ILIAS\UI\Component\Input\Field\Input\withRequired
withRequired($is_required)
Get an input like this, but set the field to be required (or not).
ILIAS\UI\Component\Input\Field\Input\getError
getError()
The error of the input as used in HTML.
ILIAS\UI\Component\Input\Field\Input\withError
withError($error)
Get an input like this one, with a different error.
ILIAS\Validation\Constraint
A constraint encodes some resrtictions on values.
Definition:
Constraint.php:15
ILIAS\UI\Component\Input\Field
Definition:
Checkbox.php:6
src
UI
Component
Input
Field
Input.php
Generated on Thu Oct 2 2025 19:01:02 for ILIAS by
1.9.4 (using
Doxyfile
)