Chain::getNotEmptyRule() - Code Metrics - Inspection of "Hash Rule" - particle-php/Validator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#122)

by Carlos

created 2016-02-22 22:58 UTC

Chain::getNotEmptyRule() A

↳ Parent: Chain

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	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
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-2015 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\Structure;
use Particle\Validator\Output\Subject;
use Particle\Validator\Value\Container;

/**
 * Represents a collection of Rules which may break the chain of validation (but usually don't).
 *
 * @package Particle\Validator
 */
class Chain
{
    /**
     * The key we want to validate.
     *
     * @var string
     */
    protected $key;

    /**
     * The name that we can use in error messages.
     *
     * @var string
     */
    protected $name;

    /**
     * The array of all rules for this chain.
     *
     * @var Rule[]
     */
    protected $rules = [];

    /**
     * The message stack to append messages to.
     *
     * @var MessageStack
     */
    protected $messageStack;

    /**
     * Construct the chain.
     *
     * @param string $key
     * @param string $name
     * @param bool $required
     * @param bool $allowEmpty
     */
    public function __construct($key, $name, $required, $allowEmpty)
    {
        $this->key = $key;
        $this->name = $name;

        $this->addRule(new Rule\Required($required));
        $this->addRule(new Rule\NotEmpty($allowEmpty));
    }

    /**
     * Overwrite the default __clone behaviour to make sure the rules are cloned too.
     */
    public function __clone()
    {
        $rules = [];
        foreach ($this->rules as $rule) {
            $rules[] = clone $rule;
        }
        $this->rules = $rules;
    }

    /**
     * Validate the value to consist only out of alphanumeric characters.
     *
     * @param bool $allowWhitespace
     * @return $this
     */
    public function alnum($allowWhitespace = false)
    {
        return $this->addRule(new Rule\Alnum($allowWhitespace));
    }

    /**
     * Validate that the value only consists our of alphabetic characters.
     *
     * @param bool $allowWhitespace
     * @return $this
     */
    public function alpha($allowWhitespace = false)
    {
        return $this->addRule(new Rule\Alpha($allowWhitespace));
    }

    /**
     * Validate that the value is between $min and $max (inclusive).
     *
     * @param int $min
     * @param int $max
     * @return $this
     */
    public function between($min, $max)
    {
        return $this->addRule(new Rule\Between($min, $max));
    }

    /**
     * Validate that the value is a boolean.
     *
     * @return $this
     */
    public function bool()
    {
        return $this->addRule(new Rule\Boolean());
    }

    /**
     * Validate by executing a callback function, and returning its result.
     *
     * @param callable $callable
     * @return $this
     */
    public function callback(callable $callable)
    {
        return $this->addRule(new Rule\Callback($callable));
    }

    /**
     * Validates that the value is a date. If format is passed, it *must* be in that format.
     *
     * @param string|null $format
     * @return $this
     */
    public function datetime($format = null)
    {
        return $this->addRule(new Rule\Datetime($format));
    }

    /**
     * Validates that all characters of the value are decimal digits.
     *
     * @return $this
     */
    public function digits()
    {
        return $this->addRule(new Rule\Digits());
    }

    /**
     * Validates a value to be a nested array, which can then be validated using a new Validator instance.
     *
     * @param callable $callback
     * @return $this
     */
    public function each(callable $callback)
    {
        return $this->addRule(new Rule\Each($callback));
    }

    /**
     * Validates that the value is a valid email address (format only).
     * @return $this
     */
    public function email()
    {
        return $this->addRule(new Rule\Email());
    }

    /**
     * Validates that the value is equal to $value.
     *
     * @param string $value
     * @return $this
     */
    public function equals($value)
    {
        return $this->addRule(new Rule\Equal($value));
    }

    /**
     * Validates that the value is greater than $value.
     *
     * @param int $value
     * @return $this
     */
    public function greaterThan($value)
    {
        return $this->addRule(new Rule\GreaterThan($value));
    }

    /**
     * Validates that the value is in the array with optional "loose" checking.
     *
     * @param string $hashAlgorithm
     * @param bool $allowUppercase
     * @return $this
     * @see \Particle\Validator\Rule\Hash
     */
    public function hash($hashAlgorithm, $allowUppercase = false)
    {
        return $this->addRule(new Rule\Hash($hashAlgorithm, $allowUppercase));
    }

    /**
     * Validates that the value is in the array with optional "loose" checking.
     *
     * @param array $array
     * @param bool $strict
     * @return $this
     */
    public function inArray(array $array, $strict = true)
    {
        return $this->addRule(new Rule\InArray($array, $strict));
    }

    /**
     * Validates the value represents a valid integer
     *
     * @return $this
     * @see \Particle\Validator\Rule\Integer
     */
    public function integer()
    {
        return $this->addRule(new Rule\Integer());
    }

    /**
     * Validates that the value represents a valid JSON string
     *
     * @return $this
     * @see \Particle\Validator\Rule\Json
     */
    public function json()
    {
        return $this->addRule(new Rule\Json());
    }

    /**
     * Validate the value to be of precisely length $length.
     *
     * @param int $length
     * @return $this
     */
    public function length($length)
    {
        return $this->addRule(new Rule\Length($length));
    }

    /**
     * Validates that the length of the value is between $min and $max.
     *
     * If $max is null, it has no upper limit. The default is inclusive.
     *
     * @param int $min
     * @param int|null $max
     * @return $this
     */
    public function lengthBetween($min, $max)
    {
        return $this->addRule(new Rule\LengthBetween($min, $max));
    }

    /**
     * Validates that the value is less than $value.
     *
     * @param int $value
     * @return $this
     */
    public function lessThan($value)
    {
        return $this->addRule(new Rule\LessThan($value));
    }

    /**
     * Mount a rule object onto this chain.
     *
     * @param Rule $rule
     * @return $this
     */
    public function mount(Rule $rule)
    {
        return $this->addRule($rule);
    }

    /**
     * Validates that the value is either a integer or a float.
     *
     * @return $this
     */
    public function numeric()
    {
        return $this->addRule(new Rule\Numeric());
    }

    /**
     * Validates that the value matches the regular expression $regex.
     *
     * @param string $regex
     * @return $this
     */
    public function regex($regex)
    {
        return $this->addRule(new Rule\Regex($regex));
    }

    /**
     * Validates that the value is a valid URL. The schemes array is to selectively whitelist URL schemes.
     *
     * @param array $schemes
     * @return $this
     */
    public function url(array $schemes = [])
    {
        return $this->addRule(new Rule\Url($schemes));
    }

    /**
     * Validates that the value is a valid UUID
     *
     * @param int $version
     * @return $this
     */
    public function uuid($version = Rule\Uuid::UUID_V4)
    {
        return $this->addRule(new Rule\Uuid($version));
    }

    /**
     * Set a callable or boolean value which may be used to alter the required requirement on validation time.
     *
     * This may be incredibly helpful when doing conditional validation.
     *
     * @param callable|bool $required
     * @return $this
     */
    public function required($required)
    {
        $this->getRequiredRule()->setRequired($required);
        return $this;
    }

    /**
     * Set a callable or boolean value which may be used to alter the allow empty requirement on validation time.
     *
     * This may be incredibly helpful when doing conditional validation.
     *
     * @param callable|bool $allowEmpty
     * @return $this
     */
    public function allowEmpty($allowEmpty)
    {
        $this->getNotEmptyRule()->setAllowEmpty($allowEmpty);
        return $this;
    }

    /**
     * Attach a representation of this Chain to the Output\Structure $structure.
     *
     * @internal
     * @param Structure $structure
     * @param MessageStack $messageStack
     * @return Structure
     */
    public function output(Structure $structure, MessageStack $messageStack)
    {
        $subject = new Subject($this->key, $this->name);

        foreach ($this->rules as $rule) {
            $rule->output($subject, $messageStack);
        }

        $structure->addSubject($subject);

        return $structure;
    }

    /**
     * Validates the values in the $values array and appends messages to $messageStack. Returns the result as a bool.
     *
     * @param MessageStack $messageStack
     * @param Container $input
     * @param Container $output
     * @return bool
     */
    public function validate(MessageStack $messageStack, Container $input, Container $output)
    {
        $valid = true;
        foreach ($this->rules as $rule) {
            $rule->setMessageStack($messageStack);
            $rule->setParameters($this->key, $this->name);

            $valid = $rule->isValid($this->key, $input) && $valid;

            if ($rule->shouldBreakChain()) {
                break;
            }
        }

        if ($valid && $input->has($this->key)) {
            $output->set($this->key, $input->get($this->key));
        }
        return $valid;
    }

    /**
     * Shortcut method for storing a rule on this chain, and returning the chain.
     *
     * @param Rule $rule
     * @return $this
     */
    protected function addRule(Rule $rule)
    {
        $this->rules[] = $rule;

        return $this;
    }

    /**
     * Returns the first rule, which is always the required rule.
     *
     * @return Rule\Required
     */
    protected function getRequiredRule()
    {
        return $this->rules[0];
    }

    /**
     * Returns the second rule, which is always the allow empty rule.
     *
     * @return Rule\NotEmpty
     */
    protected function getNotEmptyRule()
    {
        return $this->rules[1];
    }
}


1		<?php
2		/**
3		* Particle.
4		*
5		* @link http://github.com/particle-php for the canonical source repository
6		* @copyright Copyright (c) 2005-2015 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\Structure;
12		use Particle\Validator\Output\Subject;
13		use Particle\Validator\Value\Container;
14
15		/**
16		* Represents a collection of Rules which may break the chain of validation (but usually don't).
17		*
18		* @package Particle\Validator
19		*/
20		class Chain
21		{
22		/**
23		* The key we want to validate.
24		*
25		* @var string
26		*/
27		protected $key;
28
29		/**
30		* The name that we can use in error messages.
31		*
32		* @var string
33		*/
34		protected $name;
35
36		/**
37		* The array of all rules for this chain.
38		*
39		* @var Rule[]
40		*/
41		protected $rules = [];
42
43		/**
44		* The message stack to append messages to.
45		*
46		* @var MessageStack
47		*/
48		protected $messageStack;
49
50		/**
51		* Construct the chain.
52		*
53		* @param string $key
54		* @param string $name
55		* @param bool $required
56		* @param bool $allowEmpty
57		*/
58	163	public function __construct($key, $name, $required, $allowEmpty)
59		{
60	163	$this->key = $key;
61	163	$this->name = $name;
62
63	163	$this->addRule(new Rule\Required($required));
64	163	$this->addRule(new Rule\NotEmpty($allowEmpty));
65	163	}
66
67		/**
68		* Overwrite the default __clone behaviour to make sure the rules are cloned too.
69		*/
70	3	public function __clone()
71		{
72	3	$rules = [];
73	3	foreach ($this->rules as $rule) {
74	3	$rules[] = clone $rule;
75	3	}
76	3	$this->rules = $rules;
77	3	}
78
79		/**
80		* Validate the value to consist only out of alphanumeric characters.
81		*
82		* @param bool $allowWhitespace
83		* @return $this
84		*/
85	7	public function alnum($allowWhitespace = false)
86		{
87	7	return $this->addRule(new Rule\Alnum($allowWhitespace));
88		}
89
90		/**
91		* Validate that the value only consists our of alphabetic characters.
92		*
93		* @param bool $allowWhitespace
94		* @return $this
95		*/
96	7	public function alpha($allowWhitespace = false)
97		{
98	7	return $this->addRule(new Rule\Alpha($allowWhitespace));
99		}
100
101		/**
102		* Validate that the value is between $min and $max (inclusive).
103		*
104		* @param int $min
105		* @param int $max
106		* @return $this
107		*/
108	6	public function between($min, $max)
109		{
110	6	return $this->addRule(new Rule\Between($min, $max));
111		}
112
113		/**
114		* Validate that the value is a boolean.
115		*
116		* @return $this
117		*/
118	9	public function bool()
119		{
120	9	return $this->addRule(new Rule\Boolean());
121		}
122
123		/**
124		* Validate by executing a callback function, and returning its result.
125		*
126		* @param callable $callable
127		* @return $this
128		*/
129	5	public function callback(callable $callable)
130		{
131	5	return $this->addRule(new Rule\Callback($callable));
132		}
133
134		/**
135		* Validates that the value is a date. If format is passed, it must be in that format.
136		*
137		* @param string\|null $format
138		* @return $this
139		*/
140	8	public function datetime($format = null)
141		{
142	8	return $this->addRule(new Rule\Datetime($format));
143		}
144
145		/**
146		* Validates that all characters of the value are decimal digits.
147		*
148		* @return $this
149		*/
150	4	public function digits()
151		{
152	4	return $this->addRule(new Rule\Digits());
153		}
154
155		/**
156		* Validates a value to be a nested array, which can then be validated using a new Validator instance.
157		*
158		* @param callable $callback
159		* @return $this
160		*/
161	5	public function each(callable $callback)
162		{
163	5	return $this->addRule(new Rule\Each($callback));
164		}
165
166		/**
167		* Validates that the value is a valid email address (format only).
168		* @return $this
169		*/
170	6	public function email()
171		{
172	6	return $this->addRule(new Rule\Email());
173		}
174
175		/**
176		* Validates that the value is equal to $value.
177		*
178		* @param string $value
179		* @return $this
180		*/
181	2	public function equals($value)
182		{
183	2	return $this->addRule(new Rule\Equal($value));
184		}
185
186		/**
187		* Validates that the value is greater than $value.
188		*
189		* @param int $value
190		* @return $this
191		*/
192	3	public function greaterThan($value)
193		{
194	3	return $this->addRule(new Rule\GreaterThan($value));
195		}
196
197		/**
198		* Validates that the value is in the array with optional "loose" checking.
199		*
200		* @param string $hashAlgorithm
201		* @param bool $allowUppercase
202		* @return $this
203		* @see \Particle\Validator\Rule\Hash
204		*/
205	12	public function hash($hashAlgorithm, $allowUppercase = false)
206		{
207	12	return $this->addRule(new Rule\Hash($hashAlgorithm, $allowUppercase));
208		}
209
210		/**
211		* Validates that the value is in the array with optional "loose" checking.
212		*
213		* @param array $array
214		* @param bool $strict
215		* @return $this
216		*/
217	4	public function inArray(array $array, $strict = true)
218		{
219	4	return $this->addRule(new Rule\InArray($array, $strict));
220		}
221
222		/**
223		* Validates the value represents a valid integer
224		*
225		* @return $this
226		* @see \Particle\Validator\Rule\Integer
227		*/
228	10	public function integer()
229		{
230	10	return $this->addRule(new Rule\Integer());
231		}
232
233		/**
234		* Validates that the value represents a valid JSON string
235		*
236		* @return $this
237		* @see \Particle\Validator\Rule\Json
238		*/
239	11	public function json()
240		{
241	11	return $this->addRule(new Rule\Json());
242		}
243
244		/**
245		* Validate the value to be of precisely length $length.
246		*
247		* @param int $length
248		* @return $this
249		*/
250	13	public function length($length)
251		{
252	13	return $this->addRule(new Rule\Length($length));
253		}
254
255		/**
256		* Validates that the length of the value is between $min and $max.
257		*
258		* If $max is null, it has no upper limit. The default is inclusive.
259		*
260		* @param int $min
261		* @param int\|null $max
262		* @return $this
263		*/
264	7	public function lengthBetween($min, $max)
265		{
266	7	return $this->addRule(new Rule\LengthBetween($min, $max));
267		}
268
269		/**
270		* Validates that the value is less than $value.
271		*
272		* @param int $value
273		* @return $this
274		*/
275	3	public function lessThan($value)
276		{
277	3	return $this->addRule(new Rule\LessThan($value));
278		}
279
280		/**
281		* Mount a rule object onto this chain.
282		*
283		* @param Rule $rule
284		* @return $this
285		*/
286	1	public function mount(Rule $rule)
287		{
288	1	return $this->addRule($rule);
289		}
290
291		/**
292		* Validates that the value is either a integer or a float.
293		*
294		* @return $this
295		*/
296	11	public function numeric()
297		{
298	11	return $this->addRule(new Rule\Numeric());
299		}
300
301		/**
302		* Validates that the value matches the regular expression $regex.
303		*
304		* @param string $regex
305		* @return $this
306		*/
307	2	public function regex($regex)
308		{
309	2	return $this->addRule(new Rule\Regex($regex));
310		}
311
312		/**
313		* Validates that the value is a valid URL. The schemes array is to selectively whitelist URL schemes.
314		*
315		* @param array $schemes
316		* @return $this
317		*/
318	7	public function url(array $schemes = [])
319		{
320	7	return $this->addRule(new Rule\Url($schemes));
321		}
322
323		/**
324		* Validates that the value is a valid UUID
325		*
326		* @param int $version
327		* @return $this
328		*/
329	12	public function uuid($version = Rule\Uuid::UUID_V4)
330		{
331	12	return $this->addRule(new Rule\Uuid($version));
332		}
333
334		/**
335		* Set a callable or boolean value which may be used to alter the required requirement on validation time.
336		*
337		* This may be incredibly helpful when doing conditional validation.
338		*
339		* @param callable\|bool $required
340		* @return $this
341		*/
342	5	public function required($required)
343		{
344	5	$this->getRequiredRule()->setRequired($required);
345	5	return $this;
346		}
347
348		/**
349		* Set a callable or boolean value which may be used to alter the allow empty requirement on validation time.
350		*
351		* This may be incredibly helpful when doing conditional validation.
352		*
353		* @param callable\|bool $allowEmpty
354		* @return $this
355		*/
356	4	public function allowEmpty($allowEmpty)
357		{
358	4	$this->getNotEmptyRule()->setAllowEmpty($allowEmpty);
359	4	return $this;
360		}
361
362		/**
363		* Attach a representation of this Chain to the Output\Structure $structure.
364		*
365		* @internal
366		* @param Structure $structure
367		* @param MessageStack $messageStack
368		* @return Structure
369		*/
370	2	public function output(Structure $structure, MessageStack $messageStack)
371		{
372	2	$subject = new Subject($this->key, $this->name);
373
374	2	foreach ($this->rules as $rule) {
375	2	$rule->output($subject, $messageStack);
376	2	}
377
378	2	$structure->addSubject($subject);
379
380	2	return $structure;
381		}
382
383		/**
384		* Validates the values in the $values array and appends messages to $messageStack. Returns the result as a bool.
385		*
386		* @param MessageStack $messageStack
387		* @param Container $input
388		* @param Container $output
389		* @return bool
390		*/
391	160	public function validate(MessageStack $messageStack, Container $input, Container $output)
392		{
393	160	$valid = true;
394	160	foreach ($this->rules as $rule) {
395	160	$rule->setMessageStack($messageStack);
396	160	$rule->setParameters($this->key, $this->name);
397
398	160	$valid = $rule->isValid($this->key, $input) && $valid;
399
400	160	if ($rule->shouldBreakChain()) {
401	15	break;
402		}
403	160	}
404
405	160	if ($valid && $input->has($this->key)) {
406	87	$output->set($this->key, $input->get($this->key));
407	87	}
408	160	return $valid;
409		}
410
411		/**
412		* Shortcut method for storing a rule on this chain, and returning the chain.
413		*
414		* @param Rule $rule
415		* @return $this
416		*/
417	163	protected function addRule(Rule $rule)
418		{
419	163	$this->rules[] = $rule;
420
421	163	return $this;
422		}
423
424		/**
425		* Returns the first rule, which is always the required rule.
426		*
427		* @return Rule\Required
428		*/
429	5	protected function getRequiredRule()
430		{
431	5	return $this->rules[0];
432		}
433
434		/**
435		* Returns the second rule, which is always the allow empty rule.
436		*
437		* @return Rule\NotEmpty
438		*/
439	4	protected function getNotEmptyRule()
440		{
441	4	return $this->rules[1];
442		}
443		}
444

particle-php / Validator

GitHub Access Token became invalid

Pull Request — master (#122)

Chain::getNotEmptyRule() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like