ValidationResult::addSkip() - Code Metrics - Inspection of "Introduce logging support" - jkphl/antibot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( df4949...df4068 )

by Joschi

created 2018-12-09 11:39 UTC

ValidationResult::addSkip() A

↳ Parent: ValidationResult

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

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

<?php

/**
 * antibot
 *
 * @category   Jkphl
 * @package    Jkphl\Antibot
 * @subpackage Jkphl\Antibot\Domain\Model
 * @author     Joschi Kuphal <[email protected]> / @jkphl
 * @copyright  Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
 * @license    http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2018 Joschi Kuphal <[email protected]>
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Jkphl\Antibot\Domain\Model;

use Jkphl\Antibot\Domain\Exceptions\ErrorException;

/**
 * Validation Result
 *
 * @package    Jkphl\Antibot
 * @subpackage Jkphl\Antibot\Domain\Model
 */
class ValidationResult
{
    /**
     * Request was valid
     *
     * @var bool
     */
    protected $valid = true;
    /**
     * Whitelisted
     *
     * @var bool
     */
    protected $whitelisted = false;
    /**
     * Named whitelists
     *
     * @var string[]
     */
    protected $whitelists = [];
    /**
     * Blacklisted
     *
     * @var bool
     */
    protected $blacklisted = false;
    /**
     * Named blacklists
     *
     * @var string[]
     */
    protected $blacklists = [];
    /**
     * Error messages
     *
     * @var ErrorException[]
     */
    protected $errors = [];
    /**
     * Skipping validators
     *
     * @var string[]
     */
    protected $skips = [];
    /**
     * Skipped
     *
     * @var bool
     */
    protected $skipped = false;

    /**
     * Return whether the request was valid
     *
     * @return bool Valid
     */
    public function isValid(): bool
    {
        return $this->valid && !$this->skipped;
    }

    /**
     * Return whether the request was invalid
     *
     * @return bool Valid
     */
    public function isFailed(): bool
    {
        return !$this->valid && !$this->skipped;
    }

    /**
     * Set whether the request was valid in general
     *
     * @param bool $valid Valid
     */
    public function setValid(bool $valid): void
    {
        $this->valid = $valid;
    }

    /**
     * Return whether the request was whitelisted
     *
     * @return bool Whitelisted
     */
    public function isWhitelisted(): bool
    {
        return $this->whitelisted;
    }

    /**
     * Add a named whitelist
     *
     * @param string $whitelist Whitelist
     */
    public function addWhitelist(string $whitelist): void
    {
        $this->whitelists[] = $whitelist;
        $this->whitelisted  = true;
    }

    /**
     * Return all whitelists
     *
     * @return string[] Whitelist names
     */
    public function getWhitelists(): array
    {
        return $this->whitelists;
    }

    /**
     * Return whether the request was blacklisted
     *
     * @return bool Blacklisted
     */
    public function isBlacklisted(): bool
    {
        return $this->blacklisted;
    }

    /**
     * Add a named blacklist
     *
     * @param string $blacklist Blacklist
     */
    public function addBlacklist(string $blacklist): void
    {
        $this->blacklists[] = $blacklist;
        $this->blacklisted  = true;
    }

    /**
     * Return all blacklists
     *
     * @return string[] Blacklist names
     */
    public function getBlacklists(): array
    {
        return $this->blacklists;
    }

    /**
     * Add an error
     *
     * @param ErrorException $error
     */
    public function addError(ErrorException $error): void
    {
        $this->errors[] = $error;
    }

    /**
     * Return all errors
     *
     * @return ErrorException[] Errors
     */
    public function getErrors(): array
    {
        return $this->errors;
    }

    /**
     * Return whether this result has errors
     *
     * @return bool Has errors
     */
    public function hasErrors(): bool
    {
        return count($this->errors) > 0;
    }

    /**
     * Add a skipping validator
     *
     * @param string $skip Skipping validator
     */
    public function addSkip(string $skip): void
    {
        $this->skips[] = $skip;
        $this->skipped = true;
    }

    /**
     * Return whether this result has skipping validators
     *
     * @return bool Has skipping validators
     */
    public function hasSkips(): bool
    {
        return count($this->skips) > 0;
    }

    /**
     * Return whether a validator skipped this validation
     *
     * @return bool Validation skipped
     */
    public function isSkipped(): bool
    {
        return $this->skipped;
    }
}


1		<?php
2
3		/**
4		* antibot
5		*
6		* @category Jkphl
7		* @package Jkphl\Antibot
8		* @subpackage Jkphl\Antibot\Domain\Model
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12		*/
13
14		/***********************************************************************************
15		* The MIT License (MIT)
16		*
17		* Copyright © 2018 Joschi Kuphal <[email protected]>
18		*
19		* Permission is hereby granted, free of charge, to any person obtaining a copy of
20		* this software and associated documentation files (the "Software"), to deal in
21		* the Software without restriction, including without limitation the rights to
22		* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23		* the Software, and to permit persons to whom the Software is furnished to do so,
24		* subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in all
27		* copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31		* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32		* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33		* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34		* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35		***********************************************************************************/
36
37		namespace Jkphl\Antibot\Domain\Model;
38
39		use Jkphl\Antibot\Domain\Exceptions\ErrorException;
40
41		/**
42		* Validation Result
43		*
44		* @package Jkphl\Antibot
45		* @subpackage Jkphl\Antibot\Domain\Model
46		*/
47		class ValidationResult
48		{
49		/**
50		* Request was valid
51		*
52		* @var bool
53		*/
54		protected $valid = true;
55		/**
56		* Whitelisted
57		*
58		* @var bool
59		*/
60		protected $whitelisted = false;
61		/**
62		* Named whitelists
63		*
64		* @var string[]
65		*/
66		protected $whitelists = [];
67		/**
68		* Blacklisted
69		*
70		* @var bool
71		*/
72		protected $blacklisted = false;
73		/**
74		* Named blacklists
75		*
76		* @var string[]
77		*/
78		protected $blacklists = [];
79		/**
80		* Error messages
81		*
82		* @var ErrorException[]
83		*/
84		protected $errors = [];
85		/**
86		* Skipping validators
87		*
88		* @var string[]
89		*/
90		protected $skips = [];
91		/**
92		* Skipped
93		*
94		* @var bool
95		*/
96		protected $skipped = false;
97
98		/**
99		* Return whether the request was valid
100		*
101		* @return bool Valid
102		*/
103	4	public function isValid(): bool
104		{
105	4	return $this->valid && !$this->skipped;
106		}
107
108		/**
109		* Return whether the request was invalid
110		*
111		* @return bool Valid
112		*/
113	2	public function isFailed(): bool
114		{
115	2	return !$this->valid && !$this->skipped;
116		}
117
118		/**
119		* Set whether the request was valid in general
120		*
121		* @param bool $valid Valid
122		*/
123	2	public function setValid(bool $valid): void
124		{
125	2	$this->valid = $valid;
126	2	}
127
128		/**
129		* Return whether the request was whitelisted
130		*
131		* @return bool Whitelisted
132		*/
133	1	public function isWhitelisted(): bool
134		{
135	1	return $this->whitelisted;
136		}
137
138		/**
139		* Add a named whitelist
140		*
141		* @param string $whitelist Whitelist
142		*/
143	1	public function addWhitelist(string $whitelist): void
144		{
145	1	$this->whitelists[] = $whitelist;
146	1	$this->whitelisted = true;
147	1	}
148
149		/**
150		* Return all whitelists
151		*
152		* @return string[] Whitelist names
153		*/
154		public function getWhitelists(): array
155		{
156		return $this->whitelists;
157		}
158
159		/**
160		* Return whether the request was blacklisted
161		*
162		* @return bool Blacklisted
163		*/
164		public function isBlacklisted(): bool
165		{
166		return $this->blacklisted;
167		}
168
169		/**
170		* Add a named blacklist
171		*
172		* @param string $blacklist Blacklist
173		*/
174		public function addBlacklist(string $blacklist): void
175		{
176		$this->blacklists[] = $blacklist;
177		$this->blacklisted = true;
178		}
179
180		/**
181		* Return all blacklists
182		*
183		* @return string[] Blacklist names
184		*/
185		public function getBlacklists(): array
186		{
187		return $this->blacklists;
188		}
189
190		/**
191		* Add an error
192		*
193		* @param ErrorException $error
194		*/
195	2	public function addError(ErrorException $error): void
196		{
197	2	$this->errors[] = $error;
198	2	}
199
200		/**
201		* Return all errors
202		*
203		* @return ErrorException[] Errors
204		*/
205	2	public function getErrors(): array
206		{
207	2	return $this->errors;
208		}
209
210		/**
211		* Return whether this result has errors
212		*
213		* @return bool Has errors
214		*/
215	2	public function hasErrors(): bool
216		{
217	2	return count($this->errors) > 0;
218		}
219
220		/**
221		* Add a skipping validator
222		*
223		* @param string $skip Skipping validator
224		*/
225	2	public function addSkip(string $skip): void
226		{
227	2	$this->skips[] = $skip;
228	2	$this->skipped = true;
229	2	}
230
231		/**
232		* Return whether this result has skipping validators
233		*
234		* @return bool Has skipping validators
235		*/
236		public function hasSkips(): bool
237		{
238		return count($this->skips) > 0;
239		}
240
241		/**
242		* Return whether a validator skipped this validation
243		*
244		* @return bool Validation skipped
245		*/
246	2	public function isSkipped(): bool
247		{
248	2	return $this->skipped;
249		}
250		}
251

jkphl / antibot

Push — master ( df4949...df4068 )

ValidationResult::addSkip() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like