Email::pattern() - Code Metrics - Inspection of "Remove form model (#289)" - yiisoft/form - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6b3bd5...b249fa )

by Sergei

created 2023-12-01 21:42 UTC

Email::pattern() A

↳ Parent: Email

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Field;

use InvalidArgumentException;
use Yiisoft\Form\Field\Base\EnrichFromValidationRules\EnrichFromValidationRulesInterface;
use Yiisoft\Form\Field\Base\EnrichFromValidationRules\EnrichFromValidationRulesTrait;
use Yiisoft\Form\Field\Base\InputField;
use Yiisoft\Form\Field\Base\Placeholder\PlaceholderInterface;
use Yiisoft\Form\Field\Base\Placeholder\PlaceholderTrait;
use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface;
use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait;
use Yiisoft\Form\ThemeContainer;
use Yiisoft\Html\Html;

use function is_string;

/**
 * @link https://html.spec.whatwg.org/multipage/input.html#email-state-(type=email)
 * @link https://developer.mozilla.org/docs/Web/HTML/Element/input/email
 */
final class Email extends InputField implements EnrichFromValidationRulesInterface, PlaceholderInterface, ValidationClassInterface
{
    use EnrichFromValidationRulesTrait;
    use PlaceholderTrait;
    use ValidationClassTrait;

    /**
     * Maximum length of value.
     *
     * @param int|null $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->inputAttributes['maxlength'] = $value;
        return $new;
    }

    /**
     * Minimum length of value.
     *
     * @param int|null $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->inputAttributes['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->inputAttributes['multiple'] = $value;
        return $new;
    }

    /**
     * Pattern to be matched by the form control's value.
     *
     * @param string|null $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->inputAttributes['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->inputAttributes['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->inputAttributes['required'] = $value;
        return $new;
    }

    /**
     * The size of the control.
     *
     * @param int|null $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->inputAttributes['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->inputAttributes['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->inputAttributes['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->inputAttributes['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->inputAttributes['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->inputAttributes['tabindex'] = $value;
        return $new;
    }

    protected function beforeRender(): void
    {
        parent::beforeRender();
        if ($this->enrichFromValidationRules) {
            $this->enrichment = ThemeContainer::getEnrichment($this, $this->getInputData());
        }
    }

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

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

        /** @psalm-suppress MixedArgument We guess that enrichment contain correct values. */
        $inputAttributes = array_merge(
            $this->enrichment['inputAttributes'] ?? [],
            $this->getInputAttributes()
        );

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

    protected function prepareContainerAttributes(array &$attributes): void
    {
        $this->addValidationClassToAttributes($attributes, $this->getInputData());
    }

    protected function prepareInputAttributes(array &$attributes): void
    {
        $this->preparePlaceholderInInputAttributes($attributes);
        $this->addInputValidationClassToAttributes($attributes, $this->getInputData());
    }
}


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

yiisoft / form

Push — master ( 6b3bd5...b249fa )

Email::pattern() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like