FieldHasErrorCondition::checkConditionConfiguration() - Code Metrics - Inspection of "[FEATURE] Upgrade condition support" - romm/formz - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — unit-tests-validation ( 34c29c...a12b55 )

by Romain

created 2017-02-27 12:35 UTC

FieldHasErrorCondition::checkConditionConfiguration() A

↳ Parent: Project

Complexity

Conditions	3
Paths	3

Size

Total Lines	20
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
c	0
b	0
f	0
rs	9.4285
cc	3
eloc	11
nc	3
nop	0

<?php
/*
 * 2017 Romain CANON <[email protected]>
 *
 * This file is part of the TYPO3 Formz project.
 * It is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, either
 * version 3 of the License, or any later version.
 *
 * For the full copyright and license information, see:
 * http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace Romm\Formz\Condition\Items;

use Romm\Formz\AssetHandler\Html\DataAttributesAssetHandler;
use Romm\Formz\Condition\Exceptions\InvalidConditionException;
use Romm\Formz\Condition\Processor\DataObject\PhpConditionDataObject;
use Romm\Formz\Error\FormzMessageInterface;

/**
 * This condition will match when a field is does have a specific error.
 *
 * Note: an error is identified by a name of validation (example "isValid"), and
 * by the name of the error returned by the validator ("default" by default).
 */
class FieldHasErrorCondition extends AbstractConditionItem
{
    const CONDITION_NAME = 'fieldHasError';

    /**
     * @inheritdoc
     * @var array
     */
    protected static $javaScriptFiles = [
        'EXT:formz/Resources/Public/JavaScript/Conditions/Formz.Condition.FieldHasError.js'
    ];

    /**
     * @var string
     * @validate NotEmpty
     */
    protected $fieldName;

    /**
     * @var string
     * @validate NotEmpty
     */
    protected $validationName;

    /**
     * @var string
     * @validate NotEmpty
     */
    protected $errorName = 'default';

    /**
     * @inheritdoc
     */
    public function getCssResult()
    {
        return sprintf(
            '[%s="1"]',
            DataAttributesAssetHandler::getFieldDataValidationErrorKey($this->fieldName, $this->validationName, $this->errorName)
        );
    }

    /**
     * @inheritdoc
     */
    public function getJavaScriptResult()
    {
        return $this->getDefaultJavaScriptCall(
            [
                'fieldName'      => $this->fieldName,
                'validationName' => $this->validationName,
                'errorName'      => $this->errorName
            ]
        );
    }

    /**
     * @inheritdoc
     */
    public function getPhpResult(PhpConditionDataObject $dataObject)
    {
        $flag = false;
        $field = $this->formObject
            ->getConfiguration()
            ->getField($this->fieldName);
        $result = $dataObject->getFormValidator()
            ->validateField($field)
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            ->forProperty($this->fieldName);

        foreach ($result->getErrors() as $error) {
            if ($error instanceof FormzMessageInterface
                && $this->validationName === $error->getValidationName()
                && $this->errorName === $error->getMessageKey()
            ) {
                $flag = true;
                break;
            }
        }

        return $flag;
    }

    /**
     * @return string
     */
    public function getFieldName()
    {
        return $this->fieldName;
    }

    /**
     * @return string
     */
    public function getValidationName()
    {
        return $this->validationName;
    }

    /**
     * @return string
     */
    public function getErrorName()
    {
        return $this->errorName;
    }

    /**
     * @see validateConditionConfiguration()
     * @throws InvalidConditionException
     * @return bool
     */
    protected function checkConditionConfiguration()
    {
        $configuration = $this->formObject->getConfiguration();

        if (false === $configuration->hasField($this->fieldName)) {
            throw new InvalidConditionException(
                'The field "' . $this->fieldName . '" does not exist.',
                1488192037
            );
        }

        if (false === $configuration->getField($this->fieldName)->hasValidation($this->validationName)) {
            throw new InvalidConditionException(
                'The validation "' . $this->validationName . '" does not exist for the field "' . $this->fieldName . '".',
                1488192055
            );
        }

        return true;
    }
}


1			<?php
2			/*
3			* 2017 Romain CANON <[email protected]>
4			*
5			* This file is part of the TYPO3 Formz project.
6			* It is free software; you can redistribute it and/or modify it
7			* under the terms of the GNU General Public License, either
8			* version 3 of the License, or any later version.
9			*
10			* For the full copyright and license information, see:
11			* http://www.gnu.org/licenses/gpl-3.0.html
12			*/
13
14			namespace Romm\Formz\Condition\Items;
15
16			use Romm\Formz\AssetHandler\Html\DataAttributesAssetHandler;
17			use Romm\Formz\Condition\Exceptions\InvalidConditionException;
18			use Romm\Formz\Condition\Processor\DataObject\PhpConditionDataObject;
19			use Romm\Formz\Error\FormzMessageInterface;
20
21			/**
22			* This condition will match when a field is does have a specific error.
23			*
24			* Note: an error is identified by a name of validation (example "isValid"), and
25			* by the name of the error returned by the validator ("default" by default).
26			*/
27			class FieldHasErrorCondition extends AbstractConditionItem
28			{
29			const CONDITION_NAME = 'fieldHasError';
30
31			/**
32			* @inheritdoc
33			* @var array
34			*/
35			protected static $javaScriptFiles = [
36			'EXT:formz/Resources/Public/JavaScript/Conditions/Formz.Condition.FieldHasError.js'
37			];
38
39			/**
40			* @var string
41			* @validate NotEmpty
42			*/
43			protected $fieldName;
44
45			/**
46			* @var string
47			* @validate NotEmpty
48			*/
49			protected $validationName;
50
51			/**
52			* @var string
53			* @validate NotEmpty
54			*/
55			protected $errorName = 'default';
56
57			/**
58			* @inheritdoc
59			*/
60			public function getCssResult()
61			{
62			return sprintf(
63			'[%s="1"]',
64			DataAttributesAssetHandler::getFieldDataValidationErrorKey($this->fieldName, $this->validationName, $this->errorName)
65			);
66			}
67
68			/**
69			* @inheritdoc
70			*/
71			public function getJavaScriptResult()
72			{
73			return $this->getDefaultJavaScriptCall(
74			[
75			'fieldName' => $this->fieldName,
76			'validationName' => $this->validationName,
77			'errorName' => $this->errorName
78			]
79			);
80			}
81
82			/**
83			* @inheritdoc
84			*/
85			public function getPhpResult(PhpConditionDataObject $dataObject)
86			{
87			$flag = false;
88			$field = $this->formObject
89			->getConfiguration()
90			->getField($this->fieldName);
91			$result = $dataObject->getFormValidator()
92			->validateField($field)
			0 ignored issues – show Bug introduced 2017-02-27 12:38 UTC by Report Bug Copy Issue Report It seems like `$field` defined by `$this->formObject->getCo...Field($this->fieldName)` on line `88` can be `null`; however, `Romm\Formz\Validation\Va...ecutor::validateField()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
93			->forProperty($this->fieldName);
94
95			foreach ($result->getErrors() as $error) {
96			if ($error instanceof FormzMessageInterface
97			&& $this->validationName === $error->getValidationName()
98			&& $this->errorName === $error->getMessageKey()
99			) {
100			$flag = true;
101			break;
102			}
103			}
104
105			return $flag;
106			}
107
108			/**
109			* @return string
110			*/
111			public function getFieldName()
112			{
113			return $this->fieldName;
114			}
115
116			/**
117			* @return string
118			*/
119			public function getValidationName()
120			{
121			return $this->validationName;
122			}
123
124			/**
125			* @return string
126			*/
127			public function getErrorName()
128			{
129			return $this->errorName;
130			}
131
132			/**
133			* @see validateConditionConfiguration()
134			* @throws InvalidConditionException
135			* @return bool
136			*/
137			protected function checkConditionConfiguration()
138			{
139			$configuration = $this->formObject->getConfiguration();
140
141			if (false === $configuration->hasField($this->fieldName)) {
142			throw new InvalidConditionException(
143			'The field "' . $this->fieldName . '" does not exist.',
144			1488192037
145			);
146			}
147
148			if (false === $configuration->getField($this->fieldName)->hasValidation($this->validationName)) {
149			throw new InvalidConditionException(
150			'The validation "' . $this->validationName . '" does not exist for the field "' . $this->fieldName . '".',
151			1488192055
152			);
153			}
154
155			return true;
156			}
157			}
158

romm / formz

Push — unit-tests-validation ( 34c29c...a12b55 )

FieldHasErrorCondition::checkConditionConfiguration() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like