Container.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Input\Container;

use ILIAS\UI\Component as C;
use ILIAS\UI\Implementation\Component as CI;
use ILIAS\UI\Implementation\Component\Input\NameSource;
use ILIAS\UI\Component\Input\InputData;
use ILIAS\Refinery\Transformation;
use Psr\Http\Message\ServerRequestInterface;
use ILIAS\Data\Result;

abstract class Container implements C\Input\Container\Container
{
    use CI\ComponentHelper;

    protected C\Input\Group $input_group;
    protected ?Transformation $transformation = null;
    protected ?string $error = null;
    protected ?string $dedicated_name = null;
    protected CI\Input\NameSource $name_source;
    protected ?Result $result = null;

    public function __construct(NameSource $name_source)
    {
        $this->name_source = clone $name_source;
    }

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

    public function withRequest(ServerRequestInterface $request): self
    {
        return $this->withInput(
            $this->extractRequestData($request)
        );
    }

    public function withInput(InputData $input_data): self
    {
        $clone = clone $this;
        $clone->input_group = $this->getInputGroup()->withInput($input_data);
        $clone->result = $clone->input_group->getContent();

        if (!$clone->result->isok()) {
            $clone->setError($clone->result->error());
        }

        return $clone;
    }

    public function withAdditionalTransformation(Transformation $trafo): self
    {
        $clone = clone $this;
        $clone->input_group = $this->getInputGroup()->withAdditionalTransformation($trafo);

        return $clone;
    }

    public function getError(): ?string
    {
        return $this->error;
    }

    protected function setError(string $error): void
    {
        $this->error = $error;
    }

    public function getData()
    {
        if (null !== $this->result && $this->result->isOK()) {
            return $this->result->value();
        }
        return null;
    }

    public function getDedicatedName(): ?string
    {
        return $this->dedicated_name;
    }

    public function withDedicatedName(string $dedicated_name): self
    {
        $clone = clone $this;
        $clone->dedicated_name = $dedicated_name;
        $clone->input_group = $clone->input_group
            ->withDedicatedName($dedicated_name)
            ->withNameFrom($clone->name_source);
        return $clone;
    }

    public function getInputGroup(): C\Input\Group
    {
        return $this->input_group;
    }

    protected function setInputGroup(C\Input\Group $input_group): void
    {
        $this->input_group = $input_group->withNameFrom($this->name_source);
    }

    abstract protected function extractRequestData(ServerRequestInterface $request): InputData;
}