SingleInput::allowNull() - Code Metrics - tfettig01/InputGuard - Measure and Improve Code Quality continuously with Scrutinizer

SingleInput::allowNull() A
last analyzed 2019-04-22 12:36 UTC

↳ Parent: SingleInput

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php
declare(strict_types=1);

namespace InputGuard\Guards\Bases;

trait SingleInput
{
    /**
     * The input to be validated.
     *
     * @var mixed
     */
    private $input;

    /**
     * The value to be returned after validation is complete.
     *
     * @var mixed
     */
    private $value;

    /**
     * A flag that indicates the validated state the object is in.
     *
     * @var bool|null
     */
    private $validated;

    /**
     * A flag that if set to true indicates that a null as the input is acceptable.
     *
     * @var bool
     */
    private $allowNull = false;

    /**
     * A flag that if set to true indicates that an empty string as the input is acceptable.
     *
     * @var bool
     */
    private $allowEmptyString = false;

    /**
     * The validation algorithm that determines if the input was successfully validated.
     *
     * If PHP allowed the behavior the method would be private.
     *
     * @param mixed $input
     * @param mixed &$value
     *
     * @return bool
     */
    abstract protected function validation($input, &$value): bool;

    /**
     * A switch to update the object state to allow nulls as a valid value for the input.
     *
     * @return $this
     */
    public function allowNull(): self
    {
        $this->allowNull = true;

        return $this;
    }

    /**
     * A switch to update the object state to allow empty strings as a valid value for the input.
     *
     * @return $this
     */
    public function allowEmptyString(): self
    {
        $this->allowEmptyString = true;

        return $this;
    }

    /**
     * Execute to determine the success status of the input validation.
     *
     * @return bool
     */
    public function success(): bool
    {
        if ($this->validated === null) {
            if ($this->allowNull && $this->input === null) {
                $this->validated = true;
            } elseif ($this->allowEmptyString && $this->input === '') {
                $this->validated = true;
            } else {
                $this->validated = $this->validation($this->input, $this->value);
            }
        }

        return $this->validated;
    }
}


1		<?php
2		declare(strict_types=1);
3
4		namespace InputGuard\Guards\Bases;
5
6		trait SingleInput
7		{
8		/**
9		* The input to be validated.
10		*
11		* @var mixed
12		*/
13		private $input;
14
15		/**
16		* The value to be returned after validation is complete.
17		*
18		* @var mixed
19		*/
20		private $value;
21
22		/**
23		* A flag that indicates the validated state the object is in.
24		*
25		* @var bool\|null
26		*/
27		private $validated;
28
29		/**
30		* A flag that if set to true indicates that a null as the input is acceptable.
31		*
32		* @var bool
33		*/
34		private $allowNull = false;
35
36		/**
37		* A flag that if set to true indicates that an empty string as the input is acceptable.
38		*
39		* @var bool
40		*/
41		private $allowEmptyString = false;
42
43		/**
44		* The validation algorithm that determines if the input was successfully validated.
45		*
46		* If PHP allowed the behavior the method would be private.
47		*
48		* @param mixed $input
49		* @param mixed &$value
50		*
51		* @return bool
52		*/
53		abstract protected function validation($input, &$value): bool;
54
55		/**
56		* A switch to update the object state to allow nulls as a valid value for the input.
57		*
58		* @return $this
59		*/
60	2	public function allowNull(): self
61		{
62	2	$this->allowNull = true;
63
64	2	return $this;
65		}
66
67		/**
68		* A switch to update the object state to allow empty strings as a valid value for the input.
69		*
70		* @return $this
71		*/
72	2	public function allowEmptyString(): self
73		{
74	2	$this->allowEmptyString = true;
75
76	2	return $this;
77		}
78
79		/**
80		* Execute to determine the success status of the input validation.
81		*
82		* @return bool
83		*/
84	125	public function success(): bool
85		{
86	125	if ($this->validated === null) {
87	125	if ($this->allowNull && $this->input === null) {
88	2	$this->validated = true;
89	124	} elseif ($this->allowEmptyString && $this->input === '') {
90	2	$this->validated = true;
91		} else {
92	123	$this->validated = $this->validation($this->input, $this->value);
93		}
94		}
95
96	125	return $this->validated;
97		}
98		}
99

tfettig01 / InputGuard

SingleInput::allowNull() A last analyzed 2019-04-22 12:36 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

SingleInput::allowNull() A
last analyzed 2019-04-22 12:36 UTC