Group.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Input;

use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Component\Input\Field\Input as LegacyInputInterface;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\Refinery\Constraint;
use ILIAS\Data\Factory as DataFactory;
use ILIAS\Data\Result;
use ILIAS\Data\Result\Ok;

trait Group
{
    use ComponentHelper;

    protected array $inputs = [];

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

    public function withValue($value): LegacyInputInterface
    {
        $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;
    }

    public function withInput(InputData $input): LegacyInputInterface
    {
        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;
    }

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

        return $named_inputs;
    }

    protected function _isClientSideValueOk($value): 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;
    }

    public function getInputs(): array
    {
        return $this->inputs;
    }

    protected function setInputs(array $inputs): void
    {
        $this->inputs = $inputs;
    }

    abstract protected function applyOperationsTo($res): Result;

    abstract protected function setError(string $error): void;

    abstract protected function getLanguage(): \ilLanguage;

    abstract protected function getDataFactory(): DataFactory;
}