Yiisoft\Form\Field\Image

Complexity

Total Complexity

7

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Test Coverage

Coverage

57.14%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	src()	0	5	1
A	alt()	0	5	1
A	width()	0	5	1
A	height()	0	5	1
A	generateInput()	0	6	1
A	inputTagAttributes()	0	5	1
A	disabled()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Field;

use Stringable;
use Yiisoft\Form\Field\Base\AbstractSimpleField;
use Yiisoft\Html\Html;

/**
 * @link https://html.spec.whatwg.org/multipage/input.html#image-button-state-(type=image)
 */
final class Image extends AbstractSimpleField
{
    private array $inputTagAttributes = [];

    /**
     * Provides the textual label for the button for users and user agents who cannot use the image.
     *
     * @link https://html.spec.whatwg.org/multipage/input.html#attr-input-alt
     */
    public function alt(?string $value): self
    {
        $new = clone $this;
        $new->inputTagAttributes['alt'] = $value;
        return $new;
    }

    public function width(int|string|Stringable|null $width): self
    {
        $new = clone $this;
        $new->inputTagAttributes['width'] = $width;
        return $new;
    }

    public function height(int|string|Stringable|null $height): self
    {
        $new = clone $this;
        $new->inputTagAttributes['height'] = $height;
        return $new;
    }

    /**
     * @link https://html.spec.whatwg.org/multipage/input.html#attr-input-src
     */
    public function src(?string $url): self
    {
        $new = clone $this;
        $new->inputTagAttributes['src'] = $url;
        return $new;
    }

    public function disabled(?bool $disabled = true): self
    {
        $new = clone $this;
        $new->inputTagAttributes['disabled'] = $disabled;
        return $new;
    }

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

    protected function generateInput(): string
    {
        return Html::input(
            type: 'image',
            attributes: $this->inputTagAttributes
        )->render();
    }
}