ValidatorResult::writeErrorsIntoTheDom() - Code Metrics - Inspection of "[*]: merge changes" - voku/HtmlFormValidator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 84f9de...ae5555 )

by Lars

created 2018-12-31 19:44 UTC

ValidatorResult::writeErrorsIntoTheDom() A

↳ Parent: ValidatorResult

Complexity

Conditions	6
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	19
c	0
b	0
f	0
ccs	11
cts	11
cp	1
rs	9.0111
cc	6
nc	6
nop	0
crap	6

<?php

declare(strict_types=1);

namespace voku\HtmlFormValidator;

use voku\helper\HtmlDomParser;

class ValidatorResult
{
    /**
     * List of errors from validation
     *
     * @var string[][]
     */
    private $errors = [];

    /**
     * @var array
     */
    private $values = [];

    /**
     * @var HtmlDomParser
     */
    private $formDocument;

    /**
     * ValidatorResult constructor.
     *
     * @param HtmlDomParser $formDocument
     */
    public function __construct($formDocument)
    {
        $this->formDocument = clone $formDocument;
    }

    /**
     * @return int
     */
    public function countErrors(): int
    {
        return \count($this->errors);
    }

    /**
     * @return array
     */
    public function getErrorMessages(): array
    {
        return $this->errors;
    }

    /**
     * @return string
     */
    public function getHtml(): string
    {
        return $this->formDocument->html();
    }

    /**
     * @return array
     */
    public function getValues(): array
    {
        return $this->values;
    }

    /**
     * @return bool
     */
    public function isSuccess(): bool
    {
        return $this->countErrors() === 0;
    }

    /**
     * @param string          $field
     * @param string          $fieldRule
     * @param string|string[] $errorMsg
     * @param mixed           $currentFieldValue
     *
     * @return self
     */
    public function setError(string $field, string $fieldRule, $errorMsg, $currentFieldValue): self
    {
        $inputTag = $this->formDocument->find('[name=\'' . $field . '\']', 0);
        if ($inputTag) {
            /** @noinspection UnusedFunctionResultInspection */
            $inputTag->setAttribute('aria-invalid', 'true');
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

        // overwrite the error message if needed
        $fieldRule = (new ValidatorRulesManager)->getClassViaAlias($fieldRule)['class'];
        $errorMsgFromHtml = $inputTag->getAttribute('data-error-message--' . \strtolower($fieldRule));
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        if ($errorMsgFromHtml) {
            $errorMsg = \sprintf($errorMsgFromHtml, \htmlspecialchars((string) $currentFieldValue, \ENT_COMPAT));
        }

        // save the error message per field into this object
        if (\is_array($errorMsg) === false) {
            $errorMsg = [$errorMsg];
        }
        foreach ($errorMsg as &$errorMsgSingle) {
            if (
                isset($this->errors[$field])
                &&
                \in_array($errorMsgSingle, $this->errors[$field], true)
            ) {
                continue;
            }

            $this->errors[$field][] = $errorMsgSingle;
        }
        unset($errorMsgSingle);

        return $this;
    }

    /**
     * @param string $field
     * @param mixed  $value
     *
     * @return self
     */
    public function setValue(string $field, $value): self
    {
        $inputTag = $this->formDocument->find('[name=\'' . $field . '\']', 0);
        if ($inputTag) {
            /** @noinspection UnusedFunctionResultInspection */
            $inputTag->setAttribute('aria-invalid', 'false');
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

            /** @noinspection UnusedFunctionResultInspection */
            $inputTag->val($value);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

        return $this;
    }

    /**
     * Write the error messages into the dom, if needed.
     *
     * @return self
     */
    public function writeErrorsIntoTheDom(): self
    {
        foreach ($this->errors as $field => $errors) {
            $inputTag = $this->formDocument->find('[name=\'' . $field . '\']', 0);
            if ($inputTag) {

                $errorMsgTemplateSelector = $inputTag->getAttribute('data-error-template-selector');

                if ($errorMsgTemplateSelector) {
                    $errorMsgTemplate = $this->formDocument->find($errorMsgTemplateSelector, 0);
                    if ($errorMsgTemplate) {

                        foreach ($errors as $error) {
                            $errorMsgTemplate->innerText .= ' ' . $error;
                        }
                    }
                }
            }
        }

        return $this;
    }

    /**
     * @param string $field
     * @param mixed  $value
     *
     * @return self
     */
    public function saveValue(string $field, $value): self
    {
        $this->values[$field] = $value;

        return $this;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace voku\HtmlFormValidator;
6
7		use voku\helper\HtmlDomParser;
8
9		class ValidatorResult
10		{
11		/**
12		* List of errors from validation
13		*
14		* @var string[][]
15		*/
16		private $errors = [];
17
18		/**
19		* @var array
20		*/
21		private $values = [];
22
23		/**
24		* @var HtmlDomParser
25		*/
26		private $formDocument;
27
28		/**
29		* ValidatorResult constructor.
30		*
31		* @param HtmlDomParser $formDocument
32		*/
33	24	public function __construct($formDocument)
34		{
35	24	$this->formDocument = clone $formDocument;
36	24	}
37
38		/**
39		* @return int
40		*/
41	9	public function countErrors(): int
42		{
43	9	return \count($this->errors);
44		}
45
46		/**
47		* @return array
48		*/
49	17	public function getErrorMessages(): array
50		{
51	17	return $this->errors;
52		}
53
54		/**
55		* @return string
56		*/
57	3	public function getHtml(): string
58		{
59	3	return $this->formDocument->html();
60		}
61
62		/**
63		* @return array
64		*/
65	2	public function getValues(): array
66		{
67	2	return $this->values;
68		}
69
70		/**
71		* @return bool
72		*/
73	9	public function isSuccess(): bool
74		{
75	9	return $this->countErrors() === 0;
76		}
77
78		/**
79		* @param string $field
80		* @param string $fieldRule
81		* @param string\|string[] $errorMsg
82		* @param mixed $currentFieldValue
83		*
84		* @return self
85		*/
86	17	public function setError(string $field, string $fieldRule, $errorMsg, $currentFieldValue): self
87		{
88	17	$inputTag = $this->formDocument->find('[name=\'' . $field . '\']', 0);
89	17	if ($inputTag) {
90		/** @noinspection UnusedFunctionResultInspection */
91	17	$inputTag->setAttribute('aria-invalid', 'true');
		0 ignored issues – show Bug introduced 2017-12-17 06:05 UTC by Report Bug Copy Issue Report The method `setAttribute` does only exist in `voku\helper\SimpleHtmlDom`, but not in `voku\helper\SimpleHtmlDomNodeInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
92		}
93
94		// overwrite the error message if needed
95	17	$fieldRule = (new ValidatorRulesManager)->getClassViaAlias($fieldRule)['class'];
96	17	$errorMsgFromHtml = $inputTag->getAttribute('data-error-message--' . \strtolower($fieldRule));
		0 ignored issues – show Bug introduced 2018-12-31 19:49 UTC by Report Bug Copy Issue Report The method `getAttribute` does only exist in `voku\helper\SimpleHtmlDom`, but not in `voku\helper\SimpleHtmlDomNodeInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
97	17	if ($errorMsgFromHtml) {
98	1	$errorMsg = \sprintf($errorMsgFromHtml, \htmlspecialchars((string) $currentFieldValue, \ENT_COMPAT));
99		}
100
101		// save the error message per field into this object
102	17	if (\is_array($errorMsg) === false) {
103	17	$errorMsg = [$errorMsg];
104		}
105	17	foreach ($errorMsg as &$errorMsgSingle) {
106		if (
107	17	isset($this->errors[$field])
108		&&
109	17	\in_array($errorMsgSingle, $this->errors[$field], true)
110		) {
111		continue;
112		}
113
114	17	$this->errors[$field][] = $errorMsgSingle;
115		}
116	17	unset($errorMsgSingle);
117
118	17	return $this;
119		}
120
121		/**
122		* @param string $field
123		* @param mixed $value
124		*
125		* @return self
126		*/
127	19	public function setValue(string $field, $value): self
128		{
129	19	$inputTag = $this->formDocument->find('[name=\'' . $field . '\']', 0);
130	19	if ($inputTag) {
131		/** @noinspection UnusedFunctionResultInspection */
132	19	$inputTag->setAttribute('aria-invalid', 'false');
		0 ignored issues – show Bug introduced 2018-12-31 19:49 UTC by Report Bug Copy Issue Report The method `setAttribute` does only exist in `voku\helper\SimpleHtmlDom`, but not in `voku\helper\SimpleHtmlDomNodeInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
133
134		/** @noinspection UnusedFunctionResultInspection */
135	19	$inputTag->val($value);
		0 ignored issues – show Bug introduced 2018-12-31 19:49 UTC by Report Bug Copy Issue Report The method `val` does only exist in `voku\helper\SimpleHtmlDom`, but not in `voku\helper\SimpleHtmlDomNodeInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
136		}
137
138	19	return $this;
139		}
140
141		/**
142		* Write the error messages into the dom, if needed.
143		*
144		* @return self
145		*/
146	23	public function writeErrorsIntoTheDom(): self
147		{
148	23	foreach ($this->errors as $field => $errors) {
149	17	$inputTag = $this->formDocument->find('[name=\'' . $field . '\']', 0);
150	17	if ($inputTag) {
		0 ignored issues – show Bug Best Practice introduced 2018-12-31 19:49 UTC by Report Bug Copy Issue Report The expression `$inputTag` of type `voku\helper\SimpleHtmlDom[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
151	17	$errorMsgTemplateSelector = $inputTag->getAttribute('data-error-template-selector');
		0 ignored issues – show Bug introduced 2018-12-31 19:49 UTC by Report Bug Copy Issue Report The method `getAttribute` cannot be called on `$inputTag` (of type `array<integer,object<voku\helper\SimpleHtmlDom>>`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
152	17	if ($errorMsgTemplateSelector) {
153	1	$errorMsgTemplate = $this->formDocument->find($errorMsgTemplateSelector, 0);
154	1	if ($errorMsgTemplate) {
		0 ignored issues – show Bug Best Practice introduced 2018-12-31 19:49 UTC by Report Bug Copy Issue Report The expression `$errorMsgTemplate` of type `voku\helper\SimpleHtmlDom[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
155	1	foreach ($errors as $error) {
156	17	$errorMsgTemplate->innerText .= ' ' . $error;
157		}
158		}
159		}
160		}
161		}
162
163	23	return $this;
164		}
165
166		/**
167		* @param string $field
168		* @param mixed $value
169		*
170		* @return self
171		*/
172	23	public function saveValue(string $field, $value): self
173		{
174	23	$this->values[$field] = $value;
175
176	23	return $this;
177		}
178		}
179

voku / HtmlFormValidator

Push — master ( 84f9de...ae5555 )

ValidatorResult::writeErrorsIntoTheDom() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like