Yiisoft\Form\Field\Base\ButtonField

Complexity

Total Complexity

12

Size/Duplication

Total Lines	132
Duplicated Lines	0 %

Test Coverage

Coverage

64.44%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	button()	0	5	1
A	attributes()	0	5	1
A	replaceAttributes()	0	5	1
A	autofocus()	0	5	1
A	generateInput()	0	15	3
A	tabIndex()	0	5	1
A	ariaLabel()	0	5	1
A	ariaDescribedBy()	0	5	1
A	form()	0	5	1
A	disabled()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Field\Base;

use Yiisoft\Html\Tag\Button;

/**
 * @link https://html.spec.whatwg.org/multipage/form-elements.html#the-button-element
 */
abstract class ButtonField extends PartsField
{
    use FieldContentTrait;

    private ?Button $button = null;
    private array $attributes = [];

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

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

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

    /**
     * Identifies the element (or elements) that describes the object.
     *
     * @link https://w3c.github.io/aria/#aria-describedby
     */
    final public function ariaDescribedBy(string $value): static
    {
        $new = clone $this;
        $new->attributes['aria-describedby'] = $value;
        return $new;
    }

    /**
     * Defines a string value that labels the current element.
     *
     * @link https://w3c.github.io/aria/#aria-label
     */
    final public function ariaLabel(string $value): static
    {
        $new = clone $this;
        $new->attributes['aria-label'] = $value;
        return $new;
    }

    /**
     * Focus on the control (put cursor into it) when the page loads. Only one form element could be in focus
     * at the same time.
     *
     * @link https://html.spec.whatwg.org/multipage/interaction.html#attr-fe-autofocus
     */
    final public function autofocus(bool $value = true): static
    {
        $new = clone $this;
        $new->attributes['autofocus'] = $value;
        return $new;
    }

    /**
     * The `tabindex` attribute indicates that its element can be focused, and where it participates in sequential
     * keyboard navigation (usually with the Tab key, hence the name).
     *
     * It accepts an integer as a value, with different results depending on the integer's value:
     *
     * - A negative value (usually `tabindex="-1"`) means that the element is not reachable via sequential keyboard
     *   navigation, but could be focused with Javascript or visually. It's mostly useful to create accessible widgets
     *   with JavaScript.
     * - `tabindex="0"` means that the element should be focusable in sequential keyboard navigation, but its order is
     *   defined by the document's source order.
     * - A positive value means the element should be focusable in sequential keyboard navigation, with its order
     *   defined by the value of the number. That is, `tabindex="4"` is focused before `tabindex="5"`, but after
     *   `tabindex="3"`.
     *
     * @link https://html.spec.whatwg.org/multipage/interaction.html#attr-tabindex
     */
    final public function tabIndex(?int $value): static
    {
        $new = clone $this;
        $new->attributes['tabindex'] = $value;
        return $new;
    }

    /**
     * @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-disabled
     */
    final public function disabled(bool $disabled = true): static
    {
        $new = clone $this;
        $new->attributes['disabled'] = $disabled;
        return $new;
    }

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

    final protected function generateInput(): string
    {
        $button = ($this->button ?? Button::tag())
            ->type($this->getType());

        if (!empty($this->attributes)) {
            $button = $button->attributes($this->attributes);
        }

        $content = $this->renderContent();
        if ($content !== '') {
            $button = $button->content($content);
        }

        return $button->render();
    }

    abstract protected function getType(): string;
}