Chain::creditCard() - Code Metrics - Inspection of "Credit card validation rule" - particle-php/Validator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#118)

by Carlos

created 2016-02-17 05:27 UTC

Chain::creditCard() 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	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
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 valid credit card number.
     * @return $this
     */
    public function creditCard()
    {
        return $this->addRule(new Rule\CreditCard());
    }

    /**
     * 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 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());
    }

    /**
     * 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	155	public function __construct($key, $name, $required, $allowEmpty)
59		{
60	155	$this->key = $key;
61	155	$this->name = $name;
62
63	155	$this->addRule(new Rule\Required($required));
64	155	$this->addRule(new Rule\NotEmpty($allowEmpty));
65	155	}
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 valid credit card number.
136		* @return $this
137		*/
138	15	public function creditCard()
139		{
140	15	return $this->addRule(new Rule\CreditCard());
141		}
142
143		/**
144		* Validates that the value is a date. If format is passed, it must be in that format.
145		*
146		* @param string\|null $format
147		* @return $this
148		*/
149	8	public function datetime($format = null)
150		{
151	8	return $this->addRule(new Rule\Datetime($format));
152		}
153
154		/**
155		* Validates that all characters of the value are decimal digits.
156		*
157		* @return $this
158		*/
159	4	public function digits()
160		{
161	4	return $this->addRule(new Rule\Digits());
162		}
163
164		/**
165		* Validates a value to be a nested array, which can then be validated using a new Validator instance.
166		*
167		* @param callable $callback
168		* @return $this
169		*/
170	5	public function each(callable $callback)
171		{
172	5	return $this->addRule(new Rule\Each($callback));
173		}
174
175		/**
176		* Validates that the value is a valid email address (format only).
177		* @return $this
178		*/
179	6	public function email()
180		{
181	6	return $this->addRule(new Rule\Email());
182		}
183
184		/**
185		* Validates that the value is equal to $value.
186		*
187		* @param string $value
188		* @return $this
189		*/
190	2	public function equals($value)
191		{
192	2	return $this->addRule(new Rule\Equal($value));
193		}
194
195		/**
196		* Validates that the value is greater than $value.
197		*
198		* @param int $value
199		* @return $this
200		*/
201	3	public function greaterThan($value)
202		{
203	3	return $this->addRule(new Rule\GreaterThan($value));
204		}
205
206		/**
207		* Validates that the value is in the array with optional "loose" checking.
208		*
209		* @param array $array
210		* @param bool $strict
211		* @return $this
212		*/
213	4	public function inArray(array $array, $strict = true)
214		{
215	4	return $this->addRule(new Rule\InArray($array, $strict));
216		}
217
218		/**
219		* Validates the value represents a valid integer
220		*
221		* @return $this
222		* @see \Particle\Validator\Rule\Integer
223		*/
224	10	public function integer()
225		{
226	10	return $this->addRule(new Rule\Integer());
227		}
228
229		/**
230		* Validate the value to be of precisely length $length.
231		*
232		* @param int $length
233		* @return $this
234		*/
235	13	public function length($length)
236		{
237	13	return $this->addRule(new Rule\Length($length));
238		}
239
240		/**
241		* Validates that the length of the value is between $min and $max.
242		*
243		* If $max is null, it has no upper limit. The default is inclusive.
244		*
245		* @param int $min
246		* @param int\|null $max
247		* @return $this
248		*/
249	7	public function lengthBetween($min, $max)
250		{
251	7	return $this->addRule(new Rule\LengthBetween($min, $max));
252		}
253
254		/**
255		* Validates that the value is less than $value.
256		*
257		* @param int $value
258		* @return $this
259		*/
260	3	public function lessThan($value)
261		{
262	3	return $this->addRule(new Rule\LessThan($value));
263		}
264
265		/**
266		* Mount a rule object onto this chain.
267		*
268		* @param Rule $rule
269		* @return $this
270		*/
271	1	public function mount(Rule $rule)
272		{
273	1	return $this->addRule($rule);
274		}
275
276		/**
277		* Validates that the value is either a integer or a float.
278		*
279		* @return $this
280		*/
281	11	public function numeric()
282		{
283	11	return $this->addRule(new Rule\Numeric());
284		}
285
286		/**
287		* Validates that the value matches the regular expression $regex.
288		*
289		* @param string $regex
290		* @return $this
291		*/
292	2	public function regex($regex)
293		{
294	2	return $this->addRule(new Rule\Regex($regex));
295		}
296
297		/**
298		* Validates that the value is a valid URL. The schemes array is to selectively whitelist URL schemes.
299		*
300		* @param array $schemes
301		* @return $this
302		*/
303	7	public function url(array $schemes = [])
304		{
305	7	return $this->addRule(new Rule\Url($schemes));
306		}
307
308		/**
309		* Validates that the value is a valid UUID
310		*
311		* @param int $version
312		* @return $this
313		*/
314	12	public function uuid($version = Rule\Uuid::UUID_V4)
315		{
316	12	return $this->addRule(new Rule\Uuid($version));
317		}
318
319		/**
320		* Set a callable or boolean value which may be used to alter the required requirement on validation time.
321		*
322		* This may be incredibly helpful when doing conditional validation.
323		*
324		* @param callable\|bool $required
325		* @return $this
326		*/
327	5	public function required($required)
328		{
329	5	$this->getRequiredRule()->setRequired($required);
330	5	return $this;
331		}
332
333		/**
334		* Set a callable or boolean value which may be used to alter the allow empty requirement on validation time.
335		*
336		* This may be incredibly helpful when doing conditional validation.
337		*
338		* @param callable\|bool $allowEmpty
339		* @return $this
340		*/
341	11	public function allowEmpty($allowEmpty)
342		{
343	11	$this->getNotEmptyRule()->setAllowEmpty($allowEmpty);
344	11	return $this;
345		}
346
347		/**
348		* Attach a representation of this Chain to the Output\Structure $structure.
349		*
350		* @internal
351		* @param Structure $structure
352		* @param MessageStack $messageStack
353		* @return Structure
354		*/
355	2	public function output(Structure $structure, MessageStack $messageStack)
356		{
357	2	$subject = new Subject($this->key, $this->name);
358
359	2	foreach ($this->rules as $rule) {
360	2	$rule->output($subject, $messageStack);
361	2	}
362
363	2	$structure->addSubject($subject);
364
365	2	return $structure;
366		}
367
368		/**
369		* Validates the values in the $values array and appends messages to $messageStack. Returns the result as a bool.
370		*
371		* @param MessageStack $messageStack
372		* @param Container $input
373		* @param Container $output
374		* @return bool
375		*/
376	152	public function validate(MessageStack $messageStack, Container $input, Container $output)
377		{
378	152	$valid = true;
379	152	foreach ($this->rules as $rule) {
380	152	$rule->setMessageStack($messageStack);
381	152	$rule->setParameters($this->key, $this->name);
382
383	152	$valid = $rule->isValid($this->key, $input) && $valid;
384
385	152	if ($rule->shouldBreakChain()) {
386	15	break;
387		}
388	152	}
389
390	152	if ($valid && $input->has($this->key)) {
391	82	$output->set($this->key, $input->get($this->key));
392	82	}
393	152	return $valid;
394		}
395
396		/**
397		* Shortcut method for storing a rule on this chain, and returning the chain.
398		*
399		* @param Rule $rule
400		* @return $this
401		*/
402	155	protected function addRule(Rule $rule)
403		{
404	155	$this->rules[] = $rule;
405
406	155	return $this;
407		}
408
409		/**
410		* Returns the first rule, which is always the required rule.
411		*
412		* @return Rule\Required
413		*/
414	5	protected function getRequiredRule()
415		{
416	5	return $this->rules[0];
417		}
418
419		/**
420		* Returns the second rule, which is always the allow empty rule.
421		*
422		* @return Rule\NotEmpty
423		*/
424	11	protected function getNotEmptyRule()
425		{
426	11	return $this->rules[1];
427		}
428		}
429

particle-php / Validator

GitHub Access Token became invalid

Pull Request — master (#118)

Chain::creditCard() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like