Yiisoft\Form\Field\Part\Label

Complexity

Total Complexity

21

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getThemeConfig()	0	3	1
A	id()	0	5	1
A	setFor()	0	5	1
B	render()	0	31	10
A	content()	0	5	1
A	addAttributes()	0	5	1
A	attributes()	0	5	1
A	encode()	0	5	1
A	class()	0	5	1
A	addClass()	0	8	1
A	forId()	0	5	1
A	useInputId()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Field\Part;

use Stringable;
use Yiisoft\Form\Field\Base\FormAttributeTrait;
use Yiisoft\Form\ThemeContainer;
use Yiisoft\Html\Html;
use Yiisoft\Widget\Widget;

/**
 * Represents label for a form field.
 */
final class Label extends Widget
{
    use FormAttributeTrait;

    private array $attributes = [];

    private bool $setFor = true;

    private ?string $forId = null;
    private bool $useInputId = true;

    private string|Stringable|null $content = null;

    private bool $encode = true;

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

    public function addAttributes(array $attributes): self
    {
        $new = clone $this;
        $new->attributes = array_merge($this->attributes, $attributes);
        return $new;
    }

    /**
     * Set tag ID.
     *
     * @param string|null $id Tag ID.
     */
    public function id(?string $id): self
    {
        $new = clone $this;
        $new->attributes['id'] = $id;
        return $new;
    }

    /**
     * Replace tag CSS classes with a new set of classes.
     *
     * @param string|null ...$class One or many CSS classes.
     */
    public function class(?string ...$class): self
    {
        $new = clone $this;
        $new->attributes['class'] = array_filter($class, static fn ($c) => $c !== null);
        return $new;
    }

    /**
     * Add one or more CSS classes to the tag.
     *
     * @param string|null ...$class One or many CSS classes.
     */
    public function addClass(?string ...$class): self
    {
        $new = clone $this;
        Html::addCssClass(
            $new->attributes,
            array_filter($class, static fn ($c) => $c !== null),
        );
        return $new;
    }

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

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

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

    public function content(string|Stringable|null $content): self
    {
        $new = clone $this;
        $new->content = $content;
        return $new;
    }

    /**
     * Whether content should be HTML-encoded.
     */
    public function encode(bool $value): self
    {
        $new = clone $this;
        $new->encode = $value;
        return $new;
    }

    public function render(): string
    {
        $useModel = $this->hasFormModelAndAttribute();

        $content = $useModel
            ? $this->content ?? $this->getFormAttributeLabel()
            : (string) $this->content;

        if ($content === '') {
            return '';
        }

        $labelAttributes = $this->attributes;

        if ($this->setFor && !isset($labelAttributes['for'])) {
            $id = $this->forId;
            if ($useModel && $id === null && $this->useInputId) {
                $id = $this->getInputId();
            }
            if ($id !== null) {
                $labelAttributes['for'] = $id;
            }
        }

        $tag = Html::label($content)->addAttributes($labelAttributes);

        if (!$this->encode) {
            $tag = $tag->encode(false);
        }

        return $tag->render();
    }

    protected static function getThemeConfig(?string $theme): array
    {
        return ThemeContainer::getTheme($theme)?->getLabelConfig() ?? [];
    }
}