Yiisoft\Form\Field\Base\InputField

Complexity

Total Complexity

18

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Test Coverage

Coverage

91.49%

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getInputTagAttributes()	0	9	1
A	inputId()	0	5	1
A	renderHint()	0	5	1
A	inputTagAttributes()	0	5	1
A	prepareIdInInputTagAttributes()	0	13	5
A	renderLabel()	0	15	4
A	setInputIdAttribute()	0	5	1
A	form()	0	5	1
A	renderError()	0	5	1
A	getInputName()	0	3	1
A	prepareInputTagAttributes()	0	2	1

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Field\Base;

use Yiisoft\Form\Field\Part\Error;
use Yiisoft\Form\Field\Part\Hint;
use Yiisoft\Form\Field\Part\Label;
use Yiisoft\Form\Helper\HtmlForm;

abstract class InputField extends PartsField
{
    use FormAttributeTrait;

    protected ?string $inputId = null;
    protected ?string $inputIdFromTag = null;
    protected bool $setInputIdAttribute = true;

    protected array $inputTagAttributes = [];

    /**
     * Specifies the form element the tag input element belongs to. The value of this attribute must be the ID
     * attribute of a form element in the same document.
     *
     * @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fae-form
     */
    final public function form(string $value): static
    {
        $new = clone $this;
        $new->inputTagAttributes['form'] = $value;
        return $new;
    }

    final public function inputId(?string $inputId): static
    {
        $new = clone $this;
        $new->inputId = $inputId;
        return $new;
    }

    final public function setInputIdAttribute(bool $value): static
    {
        $new = clone $this;
        $new->setInputIdAttribute = $value;
        return $new;
    }

    final public function inputTagAttributes(array $attributes): static
    {
        $new = clone $this;
        $new->inputTagAttributes = $attributes;
        return $new;
    }

    final protected function getInputName(): string
    {
        return HtmlForm::getInputName($this->getFormModel(), $this->attribute);
    }

    final protected function getInputTagAttributes(): array
    {
        $attributes = $this->inputTagAttributes;

        $this->prepareIdInInputTagAttributes($attributes);

        $this->prepareInputTagAttributes($attributes);

        return $attributes;
    }

    protected function prepareInputTagAttributes(array &$attributes): void
    {
    }

    final protected function prepareIdInInputTagAttributes(array &$attributes): void
    {
        /** @var mixed $idFromTag */
        $idFromTag = $attributes['id'] ?? null;
        if ($idFromTag !== null) {
            $this->inputIdFromTag = (string) $idFromTag;
        }

        if ($this->setInputIdAttribute) {
            if ($this->inputId !== null) {
                $attributes['id'] = $this->inputId;
            } elseif ($idFromTag === null) {
                $attributes['id'] = $this->getInputId();
            }
        }
    }

    final protected function renderLabel(Label $label): string
    {
        $label = $label->attribute($this->getFormModel(), $this->attribute);

        if ($this->setInputIdAttribute === false) {
            $label = $label->useInputIdAttribute(false);
        }

        if ($this->inputId !== null) {
            $label = $label->forId($this->inputId);
        } elseif ($this->inputIdFromTag !== null) {
            $label = $label->forId($this->inputIdFromTag);
        }

        return $label->render();
    }

    final protected function renderHint(Hint $hint): string
    {
        return $hint
            ->attribute($this->getFormModel(), $this->attribute)
            ->render();
    }

    final protected function renderError(Error $error): string
    {
        return $error
            ->attribute($this->getFormModel(), $this->attribute)
            ->render();
    }
}