Email::ariaDescribedBy() - Code Metrics - Inspection of "Big refactoring (v. 2)" - yiisoft/form - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#192)

by Sergei

created 2022-04-20 13:21 UTC

Email::ariaDescribedBy() A

↳ Parent: Email

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	5
ccs	0
cts	4
cp	0
crap	2
rs	10
c	1
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Field;

use InvalidArgumentException;
use Yiisoft\Form\Field\Base\InputField;
use Yiisoft\Form\Field\Base\PlaceholderTrait;
use Yiisoft\Html\Html;

use function is_string;

final class Email extends InputField
{
    use PlaceholderTrait;

    /**
     * Maximum length of value.
     *
     * @param int $value A limit on the number of characters a user can input.
     *
     * @link https://html.spec.whatwg.org/multipage/input.html#attr-input-maxlength
     * @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-maxlength
     */
    public function maxlength(int $value): self
    {
        $new = clone $this;
        $new->inputTagAttributes['maxlength'] = $value;
        return $new;
    }

    /**
     * Minimum length of value.
     *
     * @param int $value A lower bound on the number of characters a user can input.
     *
     * @link https://html.spec.whatwg.org/multipage/input.html#attr-input-minlength
     * @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-minlength
     */
    public function minlength(int $value): self
    {
        $new = clone $this;
        $new->inputTagAttributes['minlength'] = $value;
        return $new;
    }

    /**
     * Allow to specify more than one value.
     *
     * @param bool $value Whether the user is to be allowed to specify more than one value.
     *
     * @link https://html.spec.whatwg.org/multipage/input.html#attr-input-multiple
     */
    public function multiple(bool $value = true): self
    {
        $new = clone $this;
        $new->inputTagAttributes['multiple'] = $value;
        return $new;
    }

    /**
     * Pattern to be matched by the form control's value.
     *
     * @param string $value A regular expression against which the control's value.
     *
     * @link https://html.spec.whatwg.org/multipage/input.html#attr-input-pattern
     */
    public function pattern(string $value): self
    {
        $new = clone $this;
        $new->inputTagAttributes['pattern'] = $value;
        return $new;
    }

    /**
     * A boolean attribute that controls whether or not the user can edit the form control.
     *
     * @param bool $value Whether to allow the value to be edited by the user.
     *
     * @link https://html.spec.whatwg.org/multipage/input.html#attr-input-readonly
     */
    public function readonly(bool $value = true): self
    {
        $new = clone $this;
        $new->inputTagAttributes['readonly'] = $value;
        return $new;
    }

    /**
     * A boolean attribute. When specified, the element is required.
     *
     * @param bool $value Whether the control is required for form submission.
     *
     * @link https://html.spec.whatwg.org/multipage/input.html#attr-input-required
     */
    public function required(bool $value = true): self
    {
        $new = clone $this;
        $new->inputTagAttributes['required'] = $value;
        return $new;
    }

    /**
     * The size of the control.
     *
     * @param int $value The number of characters that allow the user to see while editing the element's value.
     *
     * @link https://html.spec.whatwg.org/multipage/input.html#attr-input-size
     */
    public function size(int $value): self
    {
        $new = clone $this;
        $new->inputTagAttributes['size'] = $value;
        return $new;
    }

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

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

    /**
     * Defines a string value that labels the current element.
     *
     * @link https://w3c.github.io/aria/#aria-label
     */
    public function ariaLabel(string $value): self
    {
        $new = clone $this;
        $new->inputTagAttributes['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
     */
    public function autofocus(bool $value = true): self
    {
        $new = clone $this;
        $new->inputTagAttributes['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
     */
    public function tabIndex(?int $value): self
    {
        $new = clone $this;
        $new->inputTagAttributes['tabindex'] = $value;
        return $new;
    }

    protected function generateInput(): string
    {
        $value = $this->getAttributeValue();

        if (!is_string($value) && $value !== null) {
            throw new InvalidArgumentException('Email widget must be a string or null value.');
        }

        $tagAttributes = $this->getInputTagAttributes();

        return Html::input('email', $this->getInputName(), $value, $tagAttributes)->render();
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Form\Field;
6
7		use InvalidArgumentException;
8		use Yiisoft\Form\Field\Base\InputField;
9		use Yiisoft\Form\Field\Base\PlaceholderTrait;
10		use Yiisoft\Html\Html;
11
12		use function is_string;
13
14		final class Email extends InputField
15		{
16		use PlaceholderTrait;
17
18		/**
19		* Maximum length of value.
20		*
21		* @param int $value A limit on the number of characters a user can input.
22		*
23		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-maxlength
24		* @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-maxlength
25		*/
26		public function maxlength(int $value): self
27		{
28		$new = clone $this;
29		$new->inputTagAttributes['maxlength'] = $value;
30		return $new;
31		}
32
33		/**
34		* Minimum length of value.
35		*
36		* @param int $value A lower bound on the number of characters a user can input.
37		*
38		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-minlength
39		* @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-minlength
40		*/
41		public function minlength(int $value): self
42		{
43		$new = clone $this;
44		$new->inputTagAttributes['minlength'] = $value;
45		return $new;
46		}
47
48		/**
49		* Allow to specify more than one value.
50		*
51		* @param bool $value Whether the user is to be allowed to specify more than one value.
52		*
53		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-multiple
54		*/
55		public function multiple(bool $value = true): self
56		{
57		$new = clone $this;
58		$new->inputTagAttributes['multiple'] = $value;
59		return $new;
60		}
61
62		/**
63		* Pattern to be matched by the form control's value.
64		*
65		* @param string $value A regular expression against which the control's value.
66		*
67		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-pattern
68		*/
69		public function pattern(string $value): self
70		{
71		$new = clone $this;
72		$new->inputTagAttributes['pattern'] = $value;
73		return $new;
74		}
75
76		/**
77		* A boolean attribute that controls whether or not the user can edit the form control.
78		*
79		* @param bool $value Whether to allow the value to be edited by the user.
80		*
81		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-readonly
82		*/
83		public function readonly(bool $value = true): self
84		{
85		$new = clone $this;
86		$new->inputTagAttributes['readonly'] = $value;
87		return $new;
88		}
89
90		/**
91		* A boolean attribute. When specified, the element is required.
92		*
93		* @param bool $value Whether the control is required for form submission.
94		*
95		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-required
96		*/
97		public function required(bool $value = true): self
98		{
99		$new = clone $this;
100		$new->inputTagAttributes['required'] = $value;
101		return $new;
102		}
103
104		/**
105		* The size of the control.
106		*
107		* @param int $value The number of characters that allow the user to see while editing the element's value.
108		*
109		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-size
110		*/
111		public function size(int $value): self
112		{
113		$new = clone $this;
114		$new->inputTagAttributes['size'] = $value;
115		return $new;
116		}
117
118		/**
119		* @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-disabled
120		*/
121		public function disabled(bool $disabled = true): self
122		{
123		$new = clone $this;
124		$new->inputTagAttributes['disabled'] = $disabled;
125		return $new;
126		}
127
128		/**
129		* Identifies the element (or elements) that describes the object.
130		*
131		* @link https://w3c.github.io/aria/#aria-describedby
132		*/
133		public function ariaDescribedBy(string $value): self
134		{
135		$new = clone $this;
136		$new->inputTagAttributes['aria-describedby'] = $value;
137		return $new;
138		}
139
140		/**
141		* Defines a string value that labels the current element.
142		*
143		* @link https://w3c.github.io/aria/#aria-label
144		*/
145		public function ariaLabel(string $value): self
146		{
147		$new = clone $this;
148		$new->inputTagAttributes['aria-label'] = $value;
149		return $new;
150		}
151
152		/**
153		* Focus on the control (put cursor into it) when the page loads. Only one form element could be in focus
154		* at the same time.
155		*
156		* @link https://html.spec.whatwg.org/multipage/interaction.html#attr-fe-autofocus
157		*/
158		public function autofocus(bool $value = true): self
159		{
160		$new = clone $this;
161		$new->inputTagAttributes['autofocus'] = $value;
162		return $new;
163		}
164
165		/**
166		* The `tabindex` attribute indicates that its element can be focused, and where it participates in sequential
167		* keyboard navigation (usually with the Tab key, hence the name).
168		*
169		* It accepts an integer as a value, with different results depending on the integer's value:
170		*
171		* - A negative value (usually `tabindex="-1"`) means that the element is not reachable via sequential keyboard
172		* navigation, but could be focused with Javascript or visually. It's mostly useful to create accessible widgets
173		* with JavaScript.
174		* - `tabindex="0"` means that the element should be focusable in sequential keyboard navigation, but its order is
175		* defined by the document's source order.
176		* - A positive value means the element should be focusable in sequential keyboard navigation, with its order
177		* defined by the value of the number. That is, `tabindex="4"` is focused before `tabindex="5"`, but after
178		* `tabindex="3"`.
179		*
180		* @link https://html.spec.whatwg.org/multipage/interaction.html#attr-tabindex
181		*/
182		public function tabIndex(?int $value): self
183		{
184		$new = clone $this;
185		$new->inputTagAttributes['tabindex'] = $value;
186		return $new;
187		}
188
189	1	protected function generateInput(): string
190		{
191	1	$value = $this->getAttributeValue();
192
193	1	if (!is_string($value) && $value !== null) {
194		throw new InvalidArgumentException('Email widget must be a string or null value.');
195		}
196
197	1	$tagAttributes = $this->getInputTagAttributes();
198
199	1	return Html::input('email', $this->getInputName(), $value, $tagAttributes)->render();
200		}
201		}
202

yiisoft / form

Pull Request — master (#192)

Email::ariaDescribedBy() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like