Password::beforeRender() - 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

Password::beforeRender() A

↳ Parent: Password

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.0625

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	3
c	1
b	0
f	0
nc	2
nop	0
dl	0
loc	5
ccs	3
cts	4
cp	0.75
crap	2.0625
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;

/**
 * Represents `<input>` element of type "password" are let the user securely enter a password.
 *
 * @link https://html.spec.whatwg.org/multipage/input.html#password-state-(type=password)
 * @link https://developer.mozilla.org/docs/Web/HTML/Element/input/password
 */
final class Password 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;
    }

    /**
     * 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;
    }

    /**
     * @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;
    }

    /**
     * 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;
    }

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

yiisoft / form

Push — master ( 6b3bd5...b249fa )

Password::beforeRender() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like