Text.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

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

use ILIAS\UI\Component as C;
use ILIAS\Data\Factory as DataFactory;
use ILIAS\Refinery\Constraint;
use Closure;
use Generator;

class Text extends FormInput implements C\Input\Field\Text
{
    private ?int $max_length = null;
    private bool $strip_tags_from_input = true;

    public function __construct(
        DataFactory $data_factory,
        \ILIAS\Refinery\Factory $refinery,
        string $label,
        ?string $byline
    ) {
        parent::__construct($data_factory, $refinery, $label, $byline);
    }

    public function withMaxLength(int $max_length): C\Input\Field\Text
    {
        $clone = $this->withAdditionalTransformation(
            $this->refinery->string()->hasMaxLength($max_length)
        );
        $clone->max_length = $max_length;

        return $clone;
    }

    public function getMaxLength(): ?int
    {
        return $this->max_length;
    }

    protected function isClientSideValueOk($value): bool
    {
        if (!is_string($value)) {
            return false;
        }

        if ($this->max_length !== null &&
            strlen($value) > $this->max_length) {
            return false;
        }

        return true;
    }

    protected function getConstraintForRequirement(): ?Constraint
    {
        if ($this->requirement_constraint !== null) {
            return $this->requirement_constraint;
        }

        return $this->refinery->string()->hasMinLength(1);
    }

    public function getUpdateOnLoadCode(): Closure
    {
        return fn($id) => "$('#$id').on('input', function(event) {
                                il.UI.input.onFieldUpdate(event, '$id', $('#$id').val());
                        });
                        il.UI.input.onFieldUpdate(event, '$id', $('#$id').val());";
    }

    public function isComplex(): bool
    {
        return false;
    }

    public function getOperations(): Generator
    {
        if ($this->strip_tags_from_input) {
            yield $this->refinery->custom()->transformation(fn($v) => strip_tags($v));
        }
        yield from parent::getOperations();
    }

    public function withoutStripTags(): Text
    {
        $clone = clone $this;
        $clone->strip_tags_from_input = false;
        return $clone;
    }
}