Yiisoft\Form\Field\Base\FormAttributeTrait

Complexity

Total Complexity

13

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Test Coverage

Coverage

96.15%

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	attribute()	0	6	1
A	getFirstError()	0	3	1
A	getAttributeValue()	0	3	1
A	getAttributeHint()	0	3	1
A	getInputId()	0	3	1
A	getFormModel()	0	7	2
A	hasFormModelAndAttribute()	0	3	2
A	getAttributeName()	0	3	1
A	getAttributePlaceholder()	0	4	2
A	getAttributeLabel()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Field\Base;

use InvalidArgumentException;
use Yiisoft\Form\FormModelInterface;
use Yiisoft\Form\Helper\HtmlForm;

trait FormAttributeTrait
{
    private ?FormModelInterface $formModel = null;
    private string $attribute = '';

    final public function attribute(FormModelInterface $formModel, string $attribute): static
    {
        $new = clone $this;
        $new->formModel = $formModel;
        $new->attribute = $attribute;
        return $new;
    }

    final protected function getFormModel(): FormModelInterface
    {
        if ($this->formModel === null) {
            throw new InvalidArgumentException('Form model is not set.');
        }

        return $this->formModel;
    }

    final protected function hasFormModelAndAttribute(): bool
    {
        return $this->formModel !== null && $this->attribute !== '';
    }

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

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

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

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

    final protected function getAttributePlaceholder(): ?string
    {
        $placeholder = $this->getFormModel()->getAttributePlaceholder($this->getAttributeName());
        return $placeholder === '' ? null : $placeholder;
    }

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

    final protected function getFirstError(): ?string
    {
        return $this->getFormModel()->getFormErrors()->getFirstError($this->getAttributeName());
    }
}