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

Passed

Pull Request — master (#192)

by Alexander

created 2022-04-24 09:52 UTC

Password::required() 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
nc	1
nop	1
dl	0
loc	5
ccs	0
cts	4
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?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 extends InputField implements EnrichmentFromRulesInterface, PlaceholderInterface, ValidationClassInterface
28		{
29		use EnrichmentFromRulesTrait;
30		use PlaceholderTrait;
31		use ValidationClassTrait;
32
33		/**
34		* Maximum length of value.
35		*
36		* @param int $value A limit on the number of characters a user can input.
37		*
38		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-maxlength
39		* @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-maxlength
40		*/
41		public function maxlength(int $value): self
42		{
43		$new = clone $this;
44		$new->inputTagAttributes['maxlength'] = $value;
45		return $new;
46		}
47
48		/**
49		* Minimum length of value.
50		*
51		* @param int $value A lower bound on the number of characters a user can input.
52		*
53		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-minlength
54		* @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-minlength
55		*/
56		public function minlength(int $value): self
57		{
58		$new = clone $this;
59		$new->inputTagAttributes['minlength'] = $value;
60		return $new;
61		}
62
63		/**
64		* Pattern to be matched by the form control's value.
65		*
66		* @param string $value A regular expression against which the control's value.
67		*
68		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-pattern
69		*/
70		public function pattern(string $value): self
71		{
72		$new = clone $this;
73		$new->inputTagAttributes['pattern'] = $value;
74		return $new;
75		}
76
77		/**
78		* A boolean attribute that controls whether or not the user can edit the form control.
79		*
80		* @param bool $value Whether to allow the value to be edited by the user.
81		*
82		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-readonly
83		*/
84		public function readonly(bool $value = true): self
85		{
86		$new = clone $this;
87		$new->inputTagAttributes['readonly'] = $value;
88		return $new;
89		}
90
91		/**
92		* A boolean attribute. When specified, the element is required.
93		*
94		* @param bool $value Whether the control is required for form submission.
95		*
96		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-required
97		*/
98		public function required(bool $value = true): self
99		{
100		$new = clone $this;
101		$new->inputTagAttributes['required'] = $value;
102		return $new;
103		}
104
105		/**
106		* @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-disabled
107		*/
108		public function disabled(bool $disabled = true): self
109		{
110		$new = clone $this;
111		$new->inputTagAttributes['disabled'] = $disabled;
112		return $new;
113		}
114
115		/**
116		* Identifies the element (or elements) that describes the object.
117		*
118		* @link https://w3c.github.io/aria/#aria-describedby
119		*/
120		public function ariaDescribedBy(?string $value): self
121		{
122		$new = clone $this;
123		$new->inputTagAttributes['aria-describedby'] = $value;
124		return $new;
125		}
126
127		/**
128		* Defines a string value that labels the current element.
129		*
130		* @link https://w3c.github.io/aria/#aria-label
131		*/
132		public function ariaLabel(?string $value): self
133		{
134		$new = clone $this;
135		$new->inputTagAttributes['aria-label'] = $value;
136		return $new;
137		}
138
139		/**
140		* Focus on the control (put cursor into it) when the page loads. Only one form element could be in focus
141		* at the same time.
142		*
143		* @link https://html.spec.whatwg.org/multipage/interaction.html#attr-fe-autofocus
144		*/
145		public function autofocus(bool $value = true): self
146		{
147		$new = clone $this;
148		$new->inputTagAttributes['autofocus'] = $value;
149		return $new;
150		}
151
152		/**
153		* The `tabindex` attribute indicates that its element can be focused, and where it participates in sequential
154		* keyboard navigation (usually with the Tab key, hence the name).
155		*
156		* It accepts an integer as a value, with different results depending on the integer's value:
157		*
158		* - A negative value (usually `tabindex="-1"`) means that the element is not reachable via sequential keyboard
159		* navigation, but could be focused with Javascript or visually. It's mostly useful to create accessible widgets
160		* with JavaScript.
161		* - `tabindex="0"` means that the element should be focusable in sequential keyboard navigation, but its order is
162		* defined by the document's source order.
163		* - A positive value means the element should be focusable in sequential keyboard navigation, with its order
164		* defined by the value of the number. That is, `tabindex="4"` is focused before `tabindex="5"`, but after
165		* `tabindex="3"`.
166		*
167		* @link https://html.spec.whatwg.org/multipage/interaction.html#attr-tabindex
168		*/
169		public function tabIndex(?int $value): self
170		{
171		$new = clone $this;
172		$new->inputTagAttributes['tabindex'] = $value;
173		return $new;
174		}
175
176		/**
177		* The size of the control.
178		*
179		* @param int $value The number of characters that allow the user to see while editing the element's value.
180		*
181		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-size
182		*/
183		public function size(int $value): self
184		{
185		$new = clone $this;
186		$new->inputTagAttributes['size'] = $value;
187		return $new;
188		}
189
190		/**
191		* @psalm-suppress MixedAssignment,MixedArgument Remove after fix https://github.com/yiisoft/validator/issues/225
192		*/
193	2	protected function beforeRender(): void
194		{
195	2	parent::beforeRender();
196	2	if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
197		$rules = $this->getFormModel()->getRules()[$this->getAttributeName()] ?? [];
198		foreach ($rules as $rule) {
199		if ($rule instanceof Required) {
200		$this->inputTagAttributes['required'] = true;
201		}
202
203		if ($rule instanceof HasLength) {
204		if (null !== $min = $rule->getOptions()['min']) {
205		$this->inputTagAttributes['minlength'] = $min;
206		}
207		if (null !== $max = $rule->getOptions()['max']) {
208		$this->inputTagAttributes['maxlength'] = $max;
209		}
210		}
211
212		if ($rule instanceof Regex) {
213		if (!($rule->getOptions()['not'])) {
214		$this->inputTagAttributes['pattern'] = Html::normalizeRegexpPattern(
215		$rule->getOptions()['pattern']
216		);
217		}
218		}
219		}
220		}
221		}
222
223	2	protected function generateInput(): string
224		{
225	2	$value = $this->getAttributeValue();
226
227	2	if (!is_string($value) && $value !== null) {
228		throw new InvalidArgumentException('Password widget must be a string or null value.');
229		}
230
231	2	$tagAttributes = $this->getInputTagAttributes();
232
233	2	return Html::passwordInput($this->getInputName(), $value, $tagAttributes)->render();
234		}
235
236	2	protected function prepareContainerTagAttributes(array &$attributes): void
237		{
238	2	if ($this->hasFormModelAndAttribute()) {
239	2	$this->addValidationClassToTagAttributes(
240		$attributes,
241	2	$this->getFormModel(),
242	2	$this->getAttributeName(),
243		);
244		}
245		}
246
247	2	protected function prepareInputTagAttributes(array &$attributes): void
248		{
249	2	$this->preparePlaceholderInInputTagAttributes($attributes);
250		}
251		}
252

yiisoft / form

Pull Request — master (#192)

Password::required() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like