1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* Copyright (c) 2015-present Ganbaro Digital Ltd |
5
|
|
|
* All rights reserved. |
6
|
|
|
* |
7
|
|
|
* Redistribution and use in source and binary forms, with or without |
8
|
|
|
* modification, are permitted provided that the following conditions |
9
|
|
|
* are met: |
10
|
|
|
* |
11
|
|
|
* * Redistributions of source code must retain the above copyright |
12
|
|
|
* notice, this list of conditions and the following disclaimer. |
13
|
|
|
* |
14
|
|
|
* * Redistributions in binary form must reproduce the above copyright |
15
|
|
|
* notice, this list of conditions and the following disclaimer in |
16
|
|
|
* the documentation and/or other materials provided with the |
17
|
|
|
* distribution. |
18
|
|
|
* |
19
|
|
|
* * Neither the names of the copyright holders nor the names of his |
20
|
|
|
* contributors may be used to endorse or promote products derived |
21
|
|
|
* from this software without specific prior written permission. |
22
|
|
|
* |
23
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
24
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
25
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
26
|
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
27
|
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
28
|
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
29
|
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
30
|
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
31
|
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
32
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
33
|
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
34
|
|
|
* POSSIBILITY OF SUCH DAMAGE. |
35
|
|
|
* |
36
|
|
|
* @category Libraries |
37
|
|
|
* @package MissingBits\Checks |
38
|
|
|
* @author Stuart Herbert <[email protected]> |
39
|
|
|
* @copyright 2015-present Ganbaro Digital Ltd www.ganbarodigital.com |
40
|
|
|
* @license http://www.opensource.org/licenses/bsd-license.php BSD License |
41
|
|
|
* @link http://ganbarodigital.github.io/php-the-missing-bits |
42
|
|
|
*/ |
43
|
|
|
|
44
|
|
|
namespace GanbaroDigital\MissingBits\Checks; |
45
|
|
|
|
46
|
|
|
use GanbaroDigital\MissingBits\TypeChecks\IsList; |
47
|
|
|
use GanbaroDigital\MissingBits\TypeInspectors\GetPrintableType; |
48
|
|
|
use TypeError; |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* base class for anything that wants to check a list of values |
52
|
|
|
*/ |
53
|
|
|
class CheckList |
54
|
|
|
{ |
55
|
|
|
/** |
56
|
|
|
* the check that we'll apply to everything in the list |
57
|
|
|
* @var Check[] |
58
|
|
|
*/ |
59
|
|
|
private $checks; |
60
|
|
|
|
61
|
|
|
/** |
62
|
|
|
* create a customised CheckList, ready to use |
63
|
|
|
* |
64
|
|
|
* @param array $checks |
65
|
|
|
* a list of checks to apply |
66
|
|
|
*/ |
67
|
|
|
protected function __construct(array $checks) |
68
|
|
|
{ |
69
|
|
|
$this->checks = $checks; |
70
|
|
|
} |
71
|
|
|
|
72
|
|
|
/** |
73
|
|
|
* does a list of values pass inspection? |
74
|
|
|
* |
75
|
|
|
* we apply the list of checks that you passed into our constructor |
76
|
|
|
* |
77
|
|
|
* @param mixed $list |
78
|
|
|
* the list of data to be examined |
79
|
|
|
* @return bool |
80
|
|
|
* TRUE if the inspection passes |
81
|
|
|
* FALSE otherwise |
82
|
|
|
* @throws TypeError |
83
|
|
|
* if $list isn't a list we can use |
84
|
|
|
*/ |
85
|
|
|
public function inspect($list) |
86
|
|
|
{ |
87
|
|
|
// robustness |
88
|
|
|
if (!IsList::check($list)) { |
89
|
|
|
throw new TypeError('$list is not a list, is a ' . GetPrintableType::of($list)); |
90
|
|
|
} |
91
|
|
|
|
92
|
|
|
// a simple nested foreach() is all that we need here |
93
|
|
|
foreach ($list as $name => $item) { |
94
|
|
|
foreach ($this->checks as $check) { |
95
|
|
|
if (!$check->inspect($item)) { |
96
|
|
|
// no need to continue |
97
|
|
|
return false; |
98
|
|
|
} |
99
|
|
|
} |
100
|
|
|
} |
101
|
|
|
|
102
|
|
|
// if we get here, then all is good |
103
|
|
|
return true; |
104
|
|
|
} |
105
|
|
|
} |
106
|
|
|
|