ILIAS  trunk Revision v11.0_alpha-1715-g7fc467680fb
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
DefInput Class Reference
+ Inheritance diagram for DefInput:
+ Collaboration diagram for DefInput:

Public Member Functions

 isClientSideValueOk ($value)
 
 getUpdateOnLoadCode ()
 
- Public Member Functions inherited from ILIAS\UI\Implementation\Component\Input\Field\FormInput
 __construct (DataFactory $data_factory, Refinery $refinery, protected string $label, protected ?string $byline=null,)
 
 withInput (InputData $input)
 
 getLabel ()
 
 withLabel (string $label)
 
 getByline ()
 
 withByline (string $byline)
 
 isRequired ()
 
 withRequired (bool $is_required, ?Constraint $requirement_constraint=null)
 
 isDisabled ()
 
 withDisabled (bool $is_disabled)
 
 withOnUpdate (Signal $signal)
 
 appendOnUpdate (Signal $signal)
 
- Public Member Functions inherited from ILIAS\UI\Implementation\Component\Input\Input
 __construct (protected DataFactory $data_factory, protected Refinery $refinery,)
 Input constructor. More...
 
 getValue ()
 Get the value that is displayed in the input client side. More...
 
 withValue ($value)
 Get an input like this with another value displayed on the client side. More...
 
 getError ()
 The error of the input as used in HTML. More...
 
 withError (string $error)
 Get an input like this one, with a different error. More...
 
 withAdditionalTransformation (Transformation $trafo)
 Apply a transformation to the current or future content. More...
 
 getDedicatedName ()
 
 withDedicatedName (string $dedicated_name)
 
 getName ()
 
 withNameFrom (NameSource $source, ?string $parent_name=null)
 
 withInput (InputData $input)
 Collects the input, applies trafos on the input and returns a new input reflecting the data that was put in. More...
 
 getContent ()
 
- Public Member Functions inherited from ILIAS\UI\Implementation\Component\Input\InputInternal
 withNameFrom (NameSource $source)
 Get an input like this one, with a different name. More...
 
 getName ()
 The name of the input as used in HTML. More...
 
 getContent ()
 Get the current content of the input. More...
 
 withError (string $error)
 Get an input like this one, with a different error. More...
 
 getError ()
 The error of the input as used in HTML. More...
 

Data Fields

bool $value_ok = true
 
Constraint $requirement_constraint = null
 

Protected Member Functions

 getConstraintForRequirement ()
 
- Protected Member Functions inherited from ILIAS\UI\Implementation\Component\Input\Field\FormInput
 getConstraintForRequirement ()
 This may return a constraint that will be checked first if the field is required. More...
 
 applyOperationsTo ($res)
 
 getOperations ()
 
- Protected Member Functions inherited from ILIAS\UI\Implementation\Component\Input\Input
 isClientSideValueOk ($value)
 Check if the value is good to be displayed client side. More...
 
 setAdditionalTransformation (Transformation $trafo)
 Apply a transformation to the current or future content. More...
 
 applyOperationsTo ($res)
 Applies the operations in this instance to the value. More...
 
 getOperations ()
 Get the operations that should be performed on the input. More...
 

Additional Inherited Members

- Protected Attributes inherited from ILIAS\UI\Implementation\Component\Input\Field\FormInput
bool $is_disabled = false
 
bool $is_required = false
 
Constraint $requirement_constraint = null
 
- Protected Attributes inherited from ILIAS\UI\Implementation\Component\Input\Input
 $value = null
 
string $error = null
 This is an error on the input as displayed client side. More...
 
string $dedicated_name = null
 
Result $content = null
 This is the current content of the input in the abstraction. More...
 
array $operations = []
 

Detailed Description

Definition at line 32 of file InputTest.php.

Member Function Documentation

◆ getConstraintForRequirement()

DefInput::getConstraintForRequirement ( )
protected

Definition at line 42 of file InputTest.php.

References $requirement_constraint.

42  : ?Constraint
43  {
45  }
A constraint encodes some resrtictions on values.
Definition: Constraint.php:31
Constraint $requirement_constraint
Definition: InputTest.php:35

◆ getUpdateOnLoadCode()

DefInput::getUpdateOnLoadCode ( )

Definition at line 47 of file InputTest.php.

47  : Closure
48  {
49  return function (): void {
50  };
51  }

◆ isClientSideValueOk()

DefInput::isClientSideValueOk (   $value)

Definition at line 37 of file InputTest.php.

References $value_ok.

37  : bool
38  {
39  return $this->value_ok;
40  }
bool $value_ok
Definition: InputTest.php:34

Field Documentation

◆ $requirement_constraint

Constraint DefInput::$requirement_constraint = null

Definition at line 35 of file InputTest.php.

Referenced by getConstraintForRequirement().

◆ $value_ok

bool DefInput::$value_ok = true

Definition at line 34 of file InputTest.php.

Referenced by isClientSideValueOk().


The documentation for this class was generated from the following file: