Yiisoft\Form\Widget\Attribute\GlobalAttributes

Complexity

Total Complexity

15

Size/Duplication

Total Lines	199
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	name()	0	5	1
A	disabled()	0	5	1
A	title()	0	5	1
A	getIdWithoutModel()	0	13	5
A	form()	0	5	1
A	id()	0	5	1
A	required()	0	5	1
A	autofocus()	0	5	1
A	value()	0	5	1
A	autoIdPrefix()	0	5	1
A	tabIndex()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Widget\Attribute;

use InvalidArgumentException;
use Stringable;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Html\Html;

trait GlobalAttributes
{
    private string $autoIdPrefix = '';

    /**
     * Focus on the control (put cursor into it) when the page loads.
     * Only one form element could be in focus at the same time.
     *
     * @param bool $value
     *
     * @return static
     *
     * @link https://www.w3.org/TR/html52/sec-forms.html#autofocusing-a-form-control-the-autofocus-attribute
     */
    public function autofocus(bool $value = true): self
    {
        $new = clone $this;
        $new->attributes['autofocus'] = $value;

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $new;
    }

    /**
     * The prefix to the automatically generated widget IDs.
     *
     * @param string $value
     *
     * @return static
     */
    public function autoIdPrefix(string $value): self
    {
        $new = clone $this;
        $new->autoIdPrefix = $value;
        return $new;
    }

    /**
     * Set whether the element is disabled or not.
     *
     * If this attribute is set to `true`, the element is disabled. Disabled elements are usually drawn with grayed-out
     * text.
     * If the element is disabled, it does not respond to user actions, it cannot be focused, and the command event
     * will not fire. In the case of form elements, it will not be submitted. Do not set the attribute to true, as
     * this will suggest you can set it to `false` to enable the element again, which is not the case.
     *
     * @param bool $value
     *
     * @return static
     *
     * @link https://www.w3.org/TR/html52/sec-forms.html#element-attrdef-disabledformelements-disabled
     */
    public function disabled(bool $value = true): self
    {
        $new = clone $this;
        $new->attributes['disabled'] = $value;

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $new;
    }

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

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $new;
    }

    /**
     * Set the ID of the widget.
     *
     * @param string|null $id
     *
     * @return static
     *
     * @link https://html.spec.whatwg.org/multipage/dom.html#the-id-attribute
     */
    public function id(?string $id): self
    {
        $new = clone $this;
        $new->attributes['id'] = $id;

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $new;
    }

    /**
     * The name part of the name/value pair associated with this element for the purposes of form submission.
     *
     * @param string|null The name of the widget.

The type Yiisoft\Form\Widget\Attribute\The was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @return static
     *
     * @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-name
     */
    public function name(?string $value): self
    {
        $new = clone $this;
        $new->attributes['name'] = $value;

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $new;
    }

    /**
     * If it is required to fill in a value in order to submit the form.
     *
     * @param bool $value
     *
     * @return static
     *
     * @link https://www.w3.org/TR/html52/sec-forms.html#the-required-attribute
     */
    public function required(bool $value = true): self
    {
        $new = clone $this;
        $new->attributes['required'] = $value;

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $new;
    }

    /**
     * The tabindex global 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".
     *
     * @param int $value
     *
     * @return static
     *
     * @link https://html.spec.whatwg.org/multipage/interaction.html#attr-tabindex
     */
    public function tabIndex(int $value = 0): self
    {
        $new = clone $this;
        $new->attributes['tabindex'] = $value;

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $new;
    }

    /**
     * The title global attribute contains text representing advisory information related to the element it belongs to.
     *
     * @param string $value
     *
     * @return static
     *
     * @link https://html.spec.whatwg.org/multipage/dom.html#attr-title
     */
    public function title(string $value): self
    {
        $new = clone $this;
        $new->attributes['title'] = $value;

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $new;
    }

    /**
     * The value of the radio button.
     *
     * @param scalar|Stringable|null $value
     *
     * @return static
     *
     * @link https://html.spec.whatwg.org/multipage/input.html#attr-input-value
     */
    public function value($value): self
    {
        $new = clone $this;
        $new->attributes['value'] = $value;

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $new;
    }

    /**
     * Generates a unique ID for the attribute without model, if it does not have one yet.
     *
     * @return string
     */
    protected function getIdWithoutModel(): ?string
    {
        $id = ArrayHelper::remove($this->attributes, 'id', '');

        if (!is_string($id) && null !== $id) {
            throw new InvalidArgumentException('Attribute "id" must be a string or null.');
        }

        if ($id === '') {
            $id = Html::generateId($this->autoIdPrefix);
        }

        return $id === null ? null : $id;
    }
}