Yiisoft\Form\Field\Base\PlaceholderTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	usePlaceholder()	0	5	1
A	preparePlaceholderInFormElementTagAttributes()	0	9	4
A	placeholder()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Field\Base;

/**
 * @psalm-import-type HtmlAttributes from \Yiisoft\Html\Html
 * @psalm-require-extends AbstractField
 */
trait PlaceholderTrait
{
    private ?string $placeholder = null;
    private bool $usePlaceholder = true;

    public function placeholder(?string $placeholder): self
    {
        $new = clone $this;
        $new->placeholder = $placeholder;
        return $new;
    }

    public function usePlaceholder(bool $use): self
    {
        $new = clone $this;
        $new->usePlaceholder = $use;
        return $new;
    }

    /**
     * @psalm-param HtmlAttributes $attributes
     */
    protected function preparePlaceholderInFormElementTagAttributes(array &$attributes): void
    {
        if (
            $this->usePlaceholder
            && !isset($attributes['placeholder'])
        ) {
            $placeholder = $this->placeholder ?? $this->getAttributePlaceholder();

It seems like getAttributePlaceholder() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            if ($placeholder !== null) {
                $attributes['placeholder'] = $placeholder;
            }
        }
        /** @psalm-var HtmlAttributes $attributes */
    }
}