This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Namespaces
	Container

	Field
	This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

	ViewControl
	This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

Data Structures
class	ArrayInputData

class	DynamicInputDataIterator

class	DynamicInputsNameSource
	Other than the FormInputNameSource this name source is for inputs that can be dynamically added multiple times on clientside, therefore it must provide a name that is stacked when submitted to the backend. More...

class	Factory

class	FormInputNameSource
	FormInputNameSource is responsible for generating continuous form input names. More...

interface	GroupInternal

class	Input
	This implements commonalities between inputs. More...

interface	InputInternal
	Describes the interface of inputs that is used for internal processing of data from the client. More...

interface	NameSource
	Describes a source for input names. More...

class	PostDataFromServerRequest
	Implements interaction of input element with post data from psr-7 server request. More...

class	QueryParamsFromServerRequest
	Implements interaction of input element with get data from psr-7 server request. More...

class	StackedInputData
	Implements interaction of input element with get data from psr-7 server request. More...

class	UploadLimitResolver
	This class will bee used by. More...

Functions
	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...

	withInput (InputData $input)
	Collects the input, applies trafos and forwards the input to its children and returns a new input group reflecting the inputs with data that was put in. More...

	nameInputs (NameSource $source, string $parent_name)

	_isClientSideValueOk ($value)
	ATTENTION: This is not the same as. More...

	getInputs ()

	setInputs (array $inputs)
	This setter should be used instead of accessing $this->inputs directly. More...

	applyOperationsTo ($res)

	setError (string $error)
	This setter will be used by withInput() to set possible errors. More...

	getLanguage ()

	getDataFactory ()

Variables
trait	Group

array	$inputs = []

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Function Documentation

◆ _isClientSideValueOk()

ILIAS\UI\Implementation\Component\Input\_isClientSideValueOk ( $value )

protected

ATTENTION: This is not the same as.

See also: Input::isClientSideValueOk(), even if it had the same name. These are different symbols, as this trait is not in the hierarchy that defines the original isClientSideValueOk.

Definition at line 131 of file Group.php.

References ILIAS\UI\Implementation\Component\Input\getInputs().

Referenced by ILIAS\UI\Implementation\Component\Input\ViewControl\Group\isClientSideValueOk(), and ILIAS\UI\Implementation\Component\Input\Field\Group\isClientSideValueOk().

                                                    : bool
     {
         if (!is_array($value)) {
             return false;
         }
         if (count($this->getInputs()) !== count($value)) {
             return false;
         }
         foreach ($this->getInputs() as $key => $input) {
             if (!array_key_exists($key, $value)) {
                 return false;
             }
             if (!$input->isClientSideValueOk($value[$key])) {
                 return false;
             }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyOperationsTo()

ILIAS\UI\Implementation\Component\Input\applyOperationsTo ( $res )

abstractprotected

See also: Input::applyOperationsTo()

Referenced by ILIAS\UI\Implementation\Component\Input\Field\FormInput\applyOperationsTo(), and ILIAS\UI\Implementation\Component\Input\setInputs().

Here is the caller graph for this function:

◆ getDataFactory()

ILIAS\UI\Implementation\Component\Input\getDataFactory ( )

abstractprotected

Referenced by TreeSelectTest\getFieldFactory(), TreeMultiSelectTest\getFieldFactory(), ILIAS\UI\Implementation\Component\Input\setInputs(), ILIAS\Tests\UI\Component\Dropzone\File\FileTestBase\setUp(), DataRendererTest\testDataTableGetActionRegistration(), DataRendererTest\testDataTableMultiActionsDropdown(), DataRendererTest\testDataTableRowBuilder(), and DataRendererTest\testDataTableSingleActionsDropdown().

Here is the caller graph for this function:

◆ getInputs()

ILIAS\UI\Implementation\Component\Input\getInputs ( )

Returns: Input[]

Definition at line 153 of file Group.php.

References ILIAS\UI\Implementation\Component\Input\$inputs.

Referenced by ILIAS\UI\Implementation\Component\Input\_isClientSideValueOk(), ILIAS\Repository\Form\addStdTitle(), ILIAS\Repository\Form\addStdTitleAndDescription(), ILIAS\UI\Implementation\Component\Input\nameInputs(), ilObjFooterUIHandling\outAsyncAsModal(), ILIAS\UI\Implementation\Component\Input\withInput(), and ILIAS\UI\Implementation\Component\Input\withValue().

                                : array
     {
         return $this->inputs;
     }

Here is the caller graph for this function:

◆ getLanguage()

ILIAS\UI\Implementation\Component\Input\getLanguage ( )

abstractprotected

Referenced by ILIAS\UI\Implementation\Component\Input\setInputs(), and ILIAS\UI\Implementation\Component\Input\withInput().

Here is the caller graph for this function:

◆ getValue()

ILIAS\UI\Implementation\Component\Input\getValue ( )

Get the value that is displayed in the input client side.

Returns: mixed

Definition at line 49 of file Group.php.

References ILIAS\UI\Implementation\Component\Input\$inputs.

Referenced by ilDclBaseRecordRepresentation\getFormInput(), ilDclDateSelectionRecordRepresentation\getHTML(), ilDclDatetimeSelectionRecordRepresentation\getHTML(), ILIAS\Repository\FieldDefinition\TypeSpecificData\Select\DatabaseGatewayTest\getTranslation(), ILIAS\UI\Implementation\Component\Input\Field\OptionalGroup\getValue(), KeyValueItemMock\getValue(), ilDclBaseFieldModel\hasProperty(), ilObjectRolePermissionTableGUI\initColumns(), ilCalendarDownloadZipInteraction\interaction(), ilDownloadZipInteraction\interaction(), ilICalParser\parseLine(), ilMailDeliveryJob\run(), ilMassMailDeliveryJob\run(), ilFormPropertyGUI\serializeData(), ilAssLacAbstractExpressionTest\setUp(), ILIAS\Data\Description\DObjectTest\simpleObjectsProvider(), ILIAS\Tests\UI\Component\Input\Field\HasDynamicInputsTest\testDynamicInputWithValue(), ilLSPostConditionDBTest\testSelectWithDBResults(), and ilLSPostConditionDBTest\testSelectWithNoDBResults().

     {
         return array_map(fn($i) => $i->getValue(), $this->inputs);
     }

Here is the caller graph for this function:

◆ nameInputs()

ILIAS\UI\Implementation\Component\Input\nameInputs	(	NameSource	$source,
		string	$parent_name
	)

protected

Returns: Input[]

Definition at line 116 of file Group.php.

References ILIAS\UI\Implementation\Component\Input\getInputs().

Referenced by ILIAS\UI\Implementation\Component\Input\ViewControl\Group\__construct(), and ILIAS\UI\Implementation\Component\Input\Field\Group\getUpdateOnLoadCode().

                                                                           : array
     {
         $named_inputs = [];
         foreach ($this->getInputs() as $key => $input) {
             $named_inputs[$key] = $input->withNameFrom($source, $parent_name);
         }
 
         return $named_inputs;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setError()

ILIAS\UI\Implementation\Component\Input\setError ( string $error )

abstractprotected

This setter will be used by withInput() to set possible errors.

Referenced by ILIAS\UI\Implementation\Component\Input\setInputs().

Here is the caller graph for this function:

◆ setInputs()

ILIAS\UI\Implementation\Component\Input\setInputs ( array $inputs )

protected

This setter should be used instead of accessing $this->inputs directly.

Parameters

Definition at line 163 of file Group.php.

References ILIAS\$error, ILIAS\UI\Implementation\Component\Input\$inputs, $res, ILIAS\UI\Implementation\Component\Input\applyOperationsTo(), ILIAS\UI\Implementation\Component\Input\getDataFactory(), ILIAS\UI\Implementation\Component\Input\getLanguage(), and ILIAS\UI\Implementation\Component\Input\setError().

Referenced by ILIAS\UI\Implementation\Component\Input\ViewControl\Group\__construct(), ILIAS\UI\Implementation\Component\Input\Field\Group\__construct(), and ILIAS\UI\Implementation\Component\Input\Field\Section\setInputs().

                                                : void
     {
         $this->inputs = $inputs;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withInput()

ILIAS\UI\Implementation\Component\Input\withInput ( InputData $input )

Collects the input, applies trafos and forwards the input to its children and returns a new input group reflecting the inputs with data that was put in.

Definition at line 77 of file Group.php.

References ILIAS\$error, ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\UI\Implementation\Component\Input\getInputs(), and ILIAS\UI\Implementation\Component\Input\getLanguage().

Referenced by ILIAS\UI\Implementation\Component\Input\Field\FormInput\withInput(), and ILIAS\UI\Implementation\Component\Input\Field\OptionalGroup\withInput().

                                                : self
     {
         if (empty($this->getInputs())) {
             return $this;
         }
 
         $clone = clone $this;
 
         $inputs = [];
         $contents = [];
         $error = false;
 
         foreach ($this->getInputs() as $key => $in) {
             $inputs[$key] = $in->withInput($input);
             $content = $inputs[$key]->getContent();
             if ($content->isError()) {
                 $error = true;
             } else {
                 $contents[$key] = $content->value();
             }
         }
 
         $clone->inputs = $inputs;
         if ($error) {
             $clone->content = $clone->getDataFactory()->error($this->getLanguage()->txt("ui_error_in_group"));
         } else {
             $clone->content = $clone->applyOperationsTo($contents);
         }
 
         if ($clone->content->isError()) {
             $clone->setError("" . $clone->content->error());
         }
 
         return $clone;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withValue()

ILIAS\UI\Implementation\Component\Input\withValue ( $value )

Get an input like this with another value displayed on the client side.

Parameters

mixed $value

Exceptions

Definition at line 61 of file Group.php.

References ILIAS\UI\Implementation\Component\Input\getInputs(), and ILIAS\UI\Implementation\Component\Input\ViewControl\isClientSideValueOk().

                                      : self
     {
         $this->checkArg("value", $this->isClientSideValueOk($value), "Display value does not match input type.");
         $clone = clone $this;
         foreach ($this->getInputs() as $k => $i) {
             $clone->inputs[$k] = $i->withValue($value[$k]);
         }
         return $clone;
     }