Password::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-22 14:18 UTC

Password::ariaDescribedBy() A

↳ Parent: Password

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

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

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Field;

use InvalidArgumentException;
use Yiisoft\Form\Field\Base\EnrichmentFromRules\EnrichmentFromRulesInterface;
use Yiisoft\Form\Field\Base\EnrichmentFromRules\EnrichmentFromRulesTrait;
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\Html\Html;
use Yiisoft\Validator\Rule\HasLength;
use Yiisoft\Validator\Rule\Regex;
use Yiisoft\Validator\Rule\Required;

use function is_string;

/**
 * A one-line plain-text edit control for entering a password.
 *
 * @link https://html.spec.whatwg.org/multipage/input.html#password-state-(type=password)
 */
final class Password
    extends InputField
    implements EnrichmentFromRulesInterface, PlaceholderInterface, ValidationClassInterface
{
    use EnrichmentFromRulesTrait;
    use PlaceholderTrait;
    use ValidationClassTrait;

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

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

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

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

    /**
     * @psalm-suppress MixedAssignment,MixedArgument Remove after fix https://github.com/yiisoft/validator/issues/225
     */
    protected function beforeRender(): void
    {
        parent::beforeRender();
        if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
            $rules = $this->getFormModel()->getRules()[$this->getAttributeName()] ?? [];
            foreach ($rules as $rule) {
                if ($rule instanceof Required) {
                    $this->inputTagAttributes['required'] = true;
                }

                if ($rule instanceof HasLength) {
                    if (null !== $min = $rule->getOptions()['min']) {
                        $this->inputTagAttributes['minlength'] = $min;
                    }
                    if (null !== $max = $rule->getOptions()['max']) {
                        $this->inputTagAttributes['maxlength'] = $max;
                    }
                }

                if ($rule instanceof Regex) {
                    if (!($rule->getOptions()['not'])) {
                        $this->inputTagAttributes['pattern'] = Html::normalizeRegexpPattern(
                            $rule->getOptions()['pattern']
                        );
                    }
                }
            }
        }
    }

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

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

        $tagAttributes = $this->getInputTagAttributes();

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

    protected function prepareContainerTagAttributes(array &$attributes): void
    {
        if ($this->hasFormModelAndAttribute()) {
            $this->addValidationClassToTagAttributes(
                $attributes,
                $this->getFormModel(),
                $this->getAttributeName(),
            );
        }
    }

    protected function prepareInputTagAttributes(array &$attributes): void
    {
        $this->preparePlaceholderInInputTagAttributes($attributes);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Form\Field;
6
7		use InvalidArgumentException;
8		use Yiisoft\Form\Field\Base\EnrichmentFromRules\EnrichmentFromRulesInterface;
9		use Yiisoft\Form\Field\Base\EnrichmentFromRules\EnrichmentFromRulesTrait;
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\Html\Html;
16		use Yiisoft\Validator\Rule\HasLength;
17		use Yiisoft\Validator\Rule\Regex;
18		use Yiisoft\Validator\Rule\Required;
19
20		use function is_string;
21
22		/**
23		* A one-line plain-text edit control for entering a password.
24		*
25		* @link https://html.spec.whatwg.org/multipage/input.html#password-state-(type=password)
26		*/
27		final class Password
28		extends InputField
29		implements EnrichmentFromRulesInterface, PlaceholderInterface, ValidationClassInterface
30		{
31		use EnrichmentFromRulesTrait;
32		use PlaceholderTrait;
33		use ValidationClassTrait;
34
35		/**
36		* Maximum length of value.
37		*
38		* @param int $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		public function maxlength(int $value): self
44		{
45		$new = clone $this;
46		$new->inputTagAttributes['maxlength'] = $value;
47		return $new;
48		}
49
50		/**
51		* Minimum length of value.
52		*
53		* @param int $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		public function minlength(int $value): self
59		{
60		$new = clone $this;
61		$new->inputTagAttributes['minlength'] = $value;
62		return $new;
63		}
64
65		/**
66		* Pattern to be matched by the form control's value.
67		*
68		* @param string $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		public function pattern(string $value): self
73		{
74		$new = clone $this;
75		$new->inputTagAttributes['pattern'] = $value;
76		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		public function readonly(bool $value = true): self
87		{
88		$new = clone $this;
89		$new->inputTagAttributes['readonly'] = $value;
90		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		public function required(bool $value = true): self
101		{
102		$new = clone $this;
103		$new->inputTagAttributes['required'] = $value;
104		return $new;
105		}
106
107		/**
108		* @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-disabled
109		*/
110		public function disabled(bool $disabled = true): self
111		{
112		$new = clone $this;
113		$new->inputTagAttributes['disabled'] = $disabled;
114		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		public function ariaDescribedBy(string $value): self
123		{
124		$new = clone $this;
125		$new->inputTagAttributes['aria-describedby'] = $value;
126		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		public function ariaLabel(string $value): self
135		{
136		$new = clone $this;
137		$new->inputTagAttributes['aria-label'] = $value;
138		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		public function autofocus(bool $value = true): self
148		{
149		$new = clone $this;
150		$new->inputTagAttributes['autofocus'] = $value;
151		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		public function tabIndex(?int $value): self
172		{
173		$new = clone $this;
174		$new->inputTagAttributes['tabindex'] = $value;
175		return $new;
176		}
177
178		/**
179		* The size of the control.
180		*
181		* @param int $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		public function size(int $value): self
186		{
187		$new = clone $this;
188		$new->inputTagAttributes['size'] = $value;
189		return $new;
190		}
191
192		/**
193		* @psalm-suppress MixedAssignment,MixedArgument Remove after fix https://github.com/yiisoft/validator/issues/225
194		*/
195	2	protected function beforeRender(): void
196		{
197	2	parent::beforeRender();
198	2	if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
199		$rules = $this->getFormModel()->getRules()[$this->getAttributeName()] ?? [];
200		foreach ($rules as $rule) {
201		if ($rule instanceof Required) {
202		$this->inputTagAttributes['required'] = true;
203		}
204
205		if ($rule instanceof HasLength) {
206		if (null !== $min = $rule->getOptions()['min']) {
207		$this->inputTagAttributes['minlength'] = $min;
208		}
209		if (null !== $max = $rule->getOptions()['max']) {
210		$this->inputTagAttributes['maxlength'] = $max;
211		}
212		}
213
214		if ($rule instanceof Regex) {
215		if (!($rule->getOptions()['not'])) {
216		$this->inputTagAttributes['pattern'] = Html::normalizeRegexpPattern(
217		$rule->getOptions()['pattern']
218		);
219		}
220		}
221		}
222		}
223		}
224
225	2	protected function generateInput(): string
226		{
227	2	$value = $this->getAttributeValue();
228
229	2	if (!is_string($value) && $value !== null) {
230		throw new InvalidArgumentException('Password widget must be a string or null value.');
231		}
232
233	2	$tagAttributes = $this->getInputTagAttributes();
234
235	2	return Html::passwordInput($this->getInputName(), $value, $tagAttributes)->render();
236		}
237
238	2	protected function prepareContainerTagAttributes(array &$attributes): void
239		{
240	2	if ($this->hasFormModelAndAttribute()) {
241	2	$this->addValidationClassToTagAttributes(
242		$attributes,
243	2	$this->getFormModel(),
244	2	$this->getAttributeName(),
245		);
246		}
247		}
248
249	2	protected function prepareInputTagAttributes(array &$attributes): void
250		{
251	2	$this->preparePlaceholderInInputTagAttributes($attributes);
252		}
253		}
254

yiisoft / form

Pull Request — master (#192)

Password::ariaDescribedBy() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like