Url::readonly() - 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-22 14:18 UTC

Url::readonly() A

↳ Parent: Url

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\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 Yiisoft\Validator\Rule\Url as UrlRule;

use function is_string;

/**
 * @link https://html.spec.whatwg.org/multipage/input.html#url-state-(type=url)
 */
final class Url extends InputField implements PlaceholderInterface, ValidationClassInterface, EnrichmentFromRulesInterface
{
    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;
                    }
                }

                $pattern = null;
                if ($rule instanceof UrlRule) {
                    $pattern = $rule->getOptions()['pattern'];

                    $schemePatterns = [];
                    foreach ($rule->getOptions()['validSchemes'] as $scheme) {
                        $schemePatterns[] = $this->generateSchemePattern($scheme);
                    }

                    if (str_contains($pattern, '{schemes}')) {
                        $pattern = str_replace('{schemes}', '(' . implode('|', $schemePatterns) . ')', $pattern);
                    }
                } elseif ($rule instanceof Regex) {
                    if (!($rule->getOptions()['not'])) {
                        $pattern = $rule->getOptions()['pattern'];
                    }
                }
                if ($pattern !== null) {
                    $this->inputTagAttributes['pattern'] = Html::normalizeRegexpPattern($pattern);
                }
            }
        }
    }

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

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

        $tagAttributes = $this->getInputTagAttributes();

        return Html::input('url', $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);
    }

    private function generateSchemePattern(string $scheme): string
    {
        $result = '';

        for ($i = 0, $length = strlen($scheme); $i < $length; $i++) {
            $result .= '[' . strtolower($scheme[$i]) . strtoupper($scheme[$i]) . ']';
        }

        return $result;
    }
}


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		use Yiisoft\Validator\Rule\Url as UrlRule;
20
21		use function is_string;
22
23		/**
24		* @link https://html.spec.whatwg.org/multipage/input.html#url-state-(type=url)
25		*/
26		final class Url extends InputField implements PlaceholderInterface, ValidationClassInterface, EnrichmentFromRulesInterface
27		{
28		use EnrichmentFromRulesTrait;
29		use PlaceholderTrait;
30		use ValidationClassTrait;
31
32		/**
33		* Maximum length of value.
34		*
35		* @param int $value A limit on the number of characters a user can input.
36		*
37		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-maxlength
38		* @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-maxlength
39		*/
40		public function maxlength(int $value): self
41		{
42		$new = clone $this;
43		$new->inputTagAttributes['maxlength'] = $value;
44		return $new;
45		}
46
47		/**
48		* Minimum length of value.
49		*
50		* @param int $value A lower bound on the number of characters a user can input.
51		*
52		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-minlength
53		* @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-minlength
54		*/
55		public function minlength(int $value): self
56		{
57		$new = clone $this;
58		$new->inputTagAttributes['minlength'] = $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		* @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-disabled
106		*/
107		public function disabled(bool $disabled = true): self
108		{
109		$new = clone $this;
110		$new->inputTagAttributes['disabled'] = $disabled;
111		return $new;
112		}
113
114		/**
115		* Identifies the element (or elements) that describes the object.
116		*
117		* @link https://w3c.github.io/aria/#aria-describedby
118		*/
119		public function ariaDescribedBy(string $value): self
120		{
121		$new = clone $this;
122		$new->inputTagAttributes['aria-describedby'] = $value;
123		return $new;
124		}
125
126		/**
127		* Defines a string value that labels the current element.
128		*
129		* @link https://w3c.github.io/aria/#aria-label
130		*/
131		public function ariaLabel(string $value): self
132		{
133		$new = clone $this;
134		$new->inputTagAttributes['aria-label'] = $value;
135		return $new;
136		}
137
138		/**
139		* Focus on the control (put cursor into it) when the page loads. Only one form element could be in focus
140		* at the same time.
141		*
142		* @link https://html.spec.whatwg.org/multipage/interaction.html#attr-fe-autofocus
143		*/
144		public function autofocus(bool $value = true): self
145		{
146		$new = clone $this;
147		$new->inputTagAttributes['autofocus'] = $value;
148		return $new;
149		}
150
151		/**
152		* The `tabindex` attribute indicates that its element can be focused, and where it participates in sequential
153		* keyboard navigation (usually with the Tab key, hence the name).
154		*
155		* It accepts an integer as a value, with different results depending on the integer's value:
156		*
157		* - A negative value (usually `tabindex="-1"`) means that the element is not reachable via sequential keyboard
158		* navigation, but could be focused with Javascript or visually. It's mostly useful to create accessible widgets
159		* with JavaScript.
160		* - `tabindex="0"` means that the element should be focusable in sequential keyboard navigation, but its order is
161		* defined by the document's source order.
162		* - A positive value means the element should be focusable in sequential keyboard navigation, with its order
163		* defined by the value of the number. That is, `tabindex="4"` is focused before `tabindex="5"`, but after
164		* `tabindex="3"`.
165		*
166		* @link https://html.spec.whatwg.org/multipage/interaction.html#attr-tabindex
167		*/
168		public function tabIndex(?int $value): self
169		{
170		$new = clone $this;
171		$new->inputTagAttributes['tabindex'] = $value;
172		return $new;
173		}
174
175		/**
176		* The size of the control.
177		*
178		* @param int $value The number of characters that allow the user to see while editing the element's value.
179		*
180		* @link https://html.spec.whatwg.org/multipage/input.html#attr-input-size
181		*/
182		public function size(int $value): self
183		{
184		$new = clone $this;
185		$new->inputTagAttributes['size'] = $value;
186		return $new;
187		}
188
189		/**
190		* @psalm-suppress MixedAssignment,MixedArgument Remove after fix https://github.com/yiisoft/validator/issues/225
191		*/
192	8	protected function beforeRender(): void
193		{
194	8	parent::beforeRender();
195	8	if ($this->enrichmentFromRules && $this->hasFormModelAndAttribute()) {
196	7	$rules = $this->getFormModel()->getRules()[$this->getAttributeName()] ?? [];
197	7	foreach ($rules as $rule) {
198	7	if ($rule instanceof Required) {
199	1	$this->inputTagAttributes['required'] = true;
200		}
201
202	7	if ($rule instanceof HasLength) {
203	1	if (null !== $min = $rule->getOptions()['min']) {
204	1	$this->inputTagAttributes['minlength'] = $min;
205		}
206	1	if (null !== $max = $rule->getOptions()['max']) {
207	1	$this->inputTagAttributes['maxlength'] = $max;
208		}
209		}
210
211	7	$pattern = null;
212	7	if ($rule instanceof UrlRule) {
213	3	$pattern = $rule->getOptions()['pattern'];
214
215	3	$schemePatterns = [];
216	3	foreach ($rule->getOptions()['validSchemes'] as $scheme) {
217	3	$schemePatterns[] = $this->generateSchemePattern($scheme);
218		}
219
220	3	if (str_contains($pattern, '{schemes}')) {
221	3	$pattern = str_replace('{schemes}', '(' . implode('\|', $schemePatterns) . ')', $pattern);
222		}
223	6	} elseif ($rule instanceof Regex) {
224	4	if (!($rule->getOptions()['not'])) {
225	3	$pattern = $rule->getOptions()['pattern'];
226		}
227		}
228	7	if ($pattern !== null) {
229	4	$this->inputTagAttributes['pattern'] = Html::normalizeRegexpPattern($pattern);
230		}
231		}
232		}
233		}
234
235	8	protected function generateInput(): string
236		{
237	8	$value = $this->getAttributeValue();
238
239	8	if (!is_string($value) && $value !== null) {
240		throw new InvalidArgumentException('URL widget must be a string or null value.');
241		}
242
243	8	$tagAttributes = $this->getInputTagAttributes();
244
245	8	return Html::input('url', $this->getInputName(), $value, $tagAttributes)->render();
246		}
247
248	1	protected function prepareContainerTagAttributes(array &$attributes): void
249		{
250	1	if ($this->hasFormModelAndAttribute()) {
251	1	$this->addValidationClassToTagAttributes(
252		$attributes,
253	1	$this->getFormModel(),
254	1	$this->getAttributeName(),
255		);
256		}
257		}
258
259	8	protected function prepareInputTagAttributes(array &$attributes): void
260		{
261	8	$this->preparePlaceholderInInputTagAttributes($attributes);
262		}
263
264	3	private function generateSchemePattern(string $scheme): string
265		{
266	3	$result = '';
267
268	3	for ($i = 0, $length = strlen($scheme); $i < $length; $i++) {
269	3	$result .= '[' . strtolower($scheme[$i]) . strtoupper($scheme[$i]) . ']';
270		}
271
272	3	return $result;
273		}
274		}
275

yiisoft / form

Pull Request — master (#192)

Url::readonly() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like