Rule::shouldBreakChainOnError() - Code Metrics - Inspection of "[CRITICAL] Consider the break chain only in case t..." - particle-php/Validator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#177)

by Vasile

created 2018-01-25 18:02 UTC

Rule::shouldBreakChainOnError() A

↳ Parent: Rule

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php
/**
 * Particle.
 *
 * @link      http://github.com/particle-php for the canonical source repository
 * @copyright Copyright (c) 2005-2016 Particle (http://particle-php.com)
 * @license   https://github.com/particle-php/validator/blob/master/LICENSE New BSD License
 */
namespace Particle\Validator;

use Particle\Validator\Output\Subject;
use Particle\Validator\Value\Container;

/**
 * The Rule class is the abstract parent of all rules of Particle and defines their common behaviour.
 *
 * @package Particle\Validator
 */
abstract class Rule
{
    /**
     * Contains an array of all values to be validated.
     *
     * @var array
     */
    protected $values;

    /**
     * Contains an array of messages to be returned on validation errors.
     *
     * @var array
     */
    protected $messageTemplates = [];

    /**
     * Contains a reference to the MessageStack to append errors to.
     *
     * @var MessageStack
     */
    protected $messageStack;

    /**
     * The key we have to validate the value of.
     *
     * @var string
     */
    protected $key;

    /**
     * The name may be used in validation error messages.
     *
     * @var string
     */
    protected $name;

    /**
     * This method should validate, possibly log errors, and return the result as a boolean.
     *
     * @param mixed $value
     * @return bool
     */
    abstract public function validate($value);

    /**
     * This indicates whether or not the rule can and should break the chain it's in.
     *
     * @return bool
     */
    public function shouldBreakChain()
    {
        return false;
    }

    /**
     * This indicates whether or not the rule should break the chain it's in on validation failure.
     *
     * @return bool
     */
    public function shouldBreakChainOnError()
    {
        return false;
    }

    /**
     * Registers the message stack to append errors to.
     *
     * @param MessageStack $messageStack
     * @return $this
     */
    public function setMessageStack(MessageStack $messageStack)
    {
        $this->messageStack = $messageStack;
        return $this;
    }

    /**
     * Sets the default parameters for each validation rule (key and name).
     *
     * @param string $key
     * @param string $name
     * @return $this
     */
    public function setParameters($key, $name)
    {
        $this->key = $key;
        $this->name = $name;
        return $this;
    }

    /**
     * Determines whether or not the value of $key is valid in the array $values and returns the result as a bool.
     *
     * @param string $key
     * @param Container $input
     * @return bool
     */
    public function isValid($key, Container $input)
    {
        return $this->validate($input->get($key));
    }

    /**
     * Attach a representation of this rule to the Output\Subject $subject.
     *
     * @internal
     * @param Subject $subject
     * @param MessageStack $messageStack
     */
    public function output(Subject $subject, MessageStack $messageStack)
    {
        $this->setParameters($subject->getKey(), $subject->getName());

        $outputRule = new Output\Rule(
            $this->getShortName(),
            $this->getMessageTemplates($messageStack),
            $this->getMessageParameters()
        );

        $subject->addRule($outputRule);
    }

    /**
     * Appends the error for reason $reason to the MessageStack.
     *
     * @param string $reason
     * @return bool
     */
    protected function error($reason)
    {
        $this->messageStack->append(
            new Failure(
                $this->key,
                $reason,
                $this->getMessage($reason),
                $this->getMessageParameters()
            )
        );

        return false;
    }

    /**
     * Return an array of all parameters that might be replaced in the validation error messages.
     *
     * @return array
     */
    protected function getMessageParameters()
    {
        $name = isset($this->name) ? $this->name : str_replace('_', ' ', $this->key);

        return [
            'key' => $this->key,
            'name' => $name,
        ];
    }

    /**
     * Returns an error message for the reason $reason, or an empty string if it doesn't exist.
     *
     * @param mixed $reason
     * @return string
     */
    protected function getMessage($reason)
    {
        $messageTemplate = '';
        if (array_key_exists($reason, $this->messageTemplates)) {
            $messageTemplate = $this->messageTemplates[$reason];
        }

        return $messageTemplate;
    }

    /**
     * Returns the name of this class, without the namespace.
     *
     * @return string
     */
    protected function getShortName()
    {
        return substr(get_class($this), strrpos(get_class($this), '\\') + 1);
    }

    /**
     * Get an array of Message Templates to be returned in output.
     *
     * @param MessageStack $messageStack
     * @return array
     */
    protected function getMessageTemplates(MessageStack $messageStack)
    {
        $messages = $this->messageTemplates;
        foreach ($messages as $reason => $message) {
            $overwrite = $messageStack->getOverwrite($reason, $this->key);

            if (is_string($overwrite)) {
                $messages[$reason] = $overwrite;
            }
        }

        return $messages;
    }
}


1		<?php
2		/**
3		* Particle.
4		*
5		* @link http://github.com/particle-php for the canonical source repository
6		* @copyright Copyright (c) 2005-2016 Particle (http://particle-php.com)
7		* @license https://github.com/particle-php/validator/blob/master/LICENSE New BSD License
8		*/
9		namespace Particle\Validator;
10
11		use Particle\Validator\Output\Subject;
12		use Particle\Validator\Value\Container;
13
14		/**
15		* The Rule class is the abstract parent of all rules of Particle and defines their common behaviour.
16		*
17		* @package Particle\Validator
18		*/
19		abstract class Rule
20		{
21		/**
22		* Contains an array of all values to be validated.
23		*
24		* @var array
25		*/
26		protected $values;
27
28		/**
29		* Contains an array of messages to be returned on validation errors.
30		*
31		* @var array
32		*/
33		protected $messageTemplates = [];
34
35		/**
36		* Contains a reference to the MessageStack to append errors to.
37		*
38		* @var MessageStack
39		*/
40		protected $messageStack;
41
42		/**
43		* The key we have to validate the value of.
44		*
45		* @var string
46		*/
47		protected $key;
48
49		/**
50		* The name may be used in validation error messages.
51		*
52		* @var string
53		*/
54		protected $name;
55
56		/**
57		* This method should validate, possibly log errors, and return the result as a boolean.
58		*
59		* @param mixed $value
60		* @return bool
61		*/
62		abstract public function validate($value);
63
64		/**
65		* This indicates whether or not the rule can and should break the chain it's in.
66		*
67		* @return bool
68		*/
69	199	public function shouldBreakChain()
70		{
71	199	return false;
72		}
73
74		/**
75		* This indicates whether or not the rule should break the chain it's in on validation failure.
76		*
77		* @return bool
78		*/
79	87	public function shouldBreakChainOnError()
80		{
81	87	return false;
82		}
83
84		/**
85		* Registers the message stack to append errors to.
86		*
87		* @param MessageStack $messageStack
88		* @return $this
89		*/
90	252	public function setMessageStack(MessageStack $messageStack)
91		{
92	252	$this->messageStack = $messageStack;
93	252	return $this;
94		}
95
96		/**
97		* Sets the default parameters for each validation rule (key and name).
98		*
99		* @param string $key
100		* @param string $name
101		* @return $this
102		*/
103	254	public function setParameters($key, $name)
104		{
105	254	$this->key = $key;
106	254	$this->name = $name;
107	254	return $this;
108		}
109
110		/**
111		* Determines whether or not the value of $key is valid in the array $values and returns the result as a bool.
112		*
113		* @param string $key
114		* @param Container $input
115		* @return bool
116		*/
117	228	public function isValid($key, Container $input)
118		{
119	228	return $this->validate($input->get($key));
120		}
121
122		/**
123		* Attach a representation of this rule to the Output\Subject $subject.
124		*
125		* @internal
126		* @param Subject $subject
127		* @param MessageStack $messageStack
128		*/
129	2	public function output(Subject $subject, MessageStack $messageStack)
130		{
131	2	$this->setParameters($subject->getKey(), $subject->getName());
132
133	2	$outputRule = new Output\Rule(
134	2	$this->getShortName(),
135	2	$this->getMessageTemplates($messageStack),
136	2	$this->getMessageParameters()
137	2	);
138
139	2	$subject->addRule($outputRule);
140	2	}
141
142		/**
143		* Appends the error for reason $reason to the MessageStack.
144		*
145		* @param string $reason
146		* @return bool
147		*/
148	116	protected function error($reason)
149		{
150	116	$this->messageStack->append(
151	116	new Failure(
152	116	$this->key,
153	116	$reason,
154	116	$this->getMessage($reason),
155	116	$this->getMessageParameters()
156	116	)
157	116	);
158
159	116	return false;
160		}
161
162		/**
163		* Return an array of all parameters that might be replaced in the validation error messages.
164		*
165		* @return array
166		*/
167	118	protected function getMessageParameters()
168		{
169	118	$name = isset($this->name) ? $this->name : str_replace('_', ' ', $this->key);
170
171		return [
172	118	'key' => $this->key,
173	118	'name' => $name,
174	118	];
175		}
176
177		/**
178		* Returns an error message for the reason $reason, or an empty string if it doesn't exist.
179		*
180		* @param mixed $reason
181		* @return string
182		*/
183	116	protected function getMessage($reason)
184		{
185	116	$messageTemplate = '';
186	116	if (array_key_exists($reason, $this->messageTemplates)) {
187	116	$messageTemplate = $this->messageTemplates[$reason];
188	116	}
189
190	116	return $messageTemplate;
191		}
192
193		/**
194		* Returns the name of this class, without the namespace.
195		*
196		* @return string
197		*/
198	2	protected function getShortName()
199		{
200	2	return substr(get_class($this), strrpos(get_class($this), '\\') + 1);
201		}
202
203		/**
204		* Get an array of Message Templates to be returned in output.
205		*
206		* @param MessageStack $messageStack
207		* @return array
208		*/
209	2	protected function getMessageTemplates(MessageStack $messageStack)
210		{
211	2	$messages = $this->messageTemplates;
212	2	foreach ($messages as $reason => $message) {
213	2	$overwrite = $messageStack->getOverwrite($reason, $this->key);
214
215	2	if (is_string($overwrite)) {
216	1	$messages[$reason] = $overwrite;
217	1	}
218	2	}
219
220	2	return $messages;
221		}
222		}
223

particle-php / Validator

GitHub Access Token became invalid

Pull Request — master (#177)

Rule::shouldBreakChainOnError() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like