|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* Copyright (c) 2016-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/ArrayFunctions |
|
38
|
|
|
* @author Stuart Herbert <[email protected]> |
|
39
|
|
|
* @copyright 2016-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
|
|
|
/** |
|
45
|
|
|
* append one array to another, ignoring the array keys in $extra |
|
46
|
|
|
* |
|
47
|
|
|
* added because of the observed performance problems with array_merge() |
|
48
|
|
|
* at scale |
|
49
|
|
|
* |
|
50
|
|
|
* @param array $target |
|
51
|
|
|
* the array to append to |
|
52
|
|
|
* @param array $extra |
|
53
|
|
|
* the array that we want to append |
|
54
|
|
|
* @return array |
|
55
|
|
|
* the combined array |
|
56
|
|
|
*/ |
|
57
|
|
|
function array_append_values(array $target, array $extra) |
|
58
|
|
|
{ |
|
59
|
|
|
$retval = $target; |
|
60
|
|
|
foreach ($extra as $value) { |
|
61
|
|
|
$retval[] = $value; |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
|
|
// all done |
|
65
|
|
|
return $retval; |
|
66
|
|
|
} |
|
67
|
|
|
|
|
68
|
|
|
/** |
|
69
|
|
|
* append one array to another, respecting the array keys in $extra |
|
70
|
|
|
* |
|
71
|
|
|
* added because of the observed performance problems with array_merge() |
|
72
|
|
|
* at scale |
|
73
|
|
|
* |
|
74
|
|
|
* @param array $target |
|
75
|
|
|
* the array to merge into |
|
76
|
|
|
* @param array $extra |
|
77
|
|
|
* the array that we want to merge with $target |
|
78
|
|
|
* @return array |
|
79
|
|
|
* the combined array |
|
80
|
|
|
*/ |
|
81
|
|
|
function array_merge_keys($target, $extra) |
|
82
|
|
|
{ |
|
83
|
|
|
$retval = $target; |
|
84
|
|
|
foreach ($extra as $key => $value) { |
|
85
|
|
|
$retval[$key] = $value; |
|
86
|
|
|
} |
|
87
|
|
|
|
|
88
|
|
|
// all done |
|
89
|
|
|
return $retval; |
|
90
|
|
|
} |
|
91
|
|
|
|
|
92
|
|
|
/** |
|
93
|
|
|
* build a subset of an array, that only consists of content that has |
|
94
|
|
|
* been explicitly whitelisted |
|
95
|
|
|
* |
|
96
|
|
|
* we only keep: |
|
97
|
|
|
* - keys in $target |
|
98
|
|
|
* - that have a corresponding filter in $filterMap |
|
99
|
|
|
* - where the corresponding filter: |
|
100
|
|
|
* - is `true` |
|
101
|
|
|
* - or is a `callable` |
|
102
|
|
|
* |
|
103
|
|
|
* we support child arrays, with corresponding child array filters |
|
104
|
|
|
* |
|
105
|
|
|
* @param array $target |
|
106
|
|
|
* the array we want to filter |
|
107
|
|
|
* @param array $filterMap |
|
108
|
|
|
* list of whitelisted fields |
|
109
|
|
|
* @return array |
|
110
|
|
|
* the resulting filtered array |
|
111
|
|
|
*/ |
|
112
|
|
|
function array_whitelist(array $target, array $filterMap) |
|
113
|
|
|
{ |
|
114
|
|
|
// step 1: drop all filters that are FALSE |
|
115
|
|
|
// |
|
116
|
|
|
// it's a thing, what can I say? |
|
117
|
|
|
$filterMap = array_filter($filterMap); |
|
118
|
|
|
|
|
119
|
|
|
// step 2: first pass at fields that are whitelisted |
|
120
|
|
|
// |
|
121
|
|
|
// with simple filterMaps, this will do all the work |
|
122
|
|
|
$retval = array_intersect_key($target, $filterMap); |
|
123
|
|
|
|
|
124
|
|
|
// step 3: apply remaining filters |
|
125
|
|
|
foreach ($filterMap as $key => $filter) { |
|
126
|
|
|
switch(true) { |
|
127
|
|
|
case is_callable($filter): |
|
128
|
|
|
$retval[$key] = $filter($retval); |
|
129
|
|
|
break; |
|
130
|
|
|
|
|
131
|
|
|
// support for n-depth filters |
|
132
|
|
|
case isset($retval[$key]) && is_array($filter) && (is_array($retval[$key]) || is_object($retval[$key])): |
|
133
|
|
|
$retval[$key] = array_whitelist($retval[$key], $filter); |
|
134
|
|
|
break; |
|
135
|
|
|
} |
|
136
|
|
|
|
|
137
|
|
|
// var_dump($key, $filter, $retval, $target); |
|
|
|
|
|
|
138
|
|
|
} |
|
139
|
|
|
|
|
140
|
|
|
return $retval; |
|
141
|
|
|
} |
|
142
|
|
|
|
|
143
|
|
|
function array_filter_contents(array $target, array $filterMap) |
|
144
|
|
|
{ |
|
145
|
|
|
$retval = $target; |
|
146
|
|
|
|
|
147
|
|
|
foreach ($filterMap as $key => $filter) { |
|
148
|
|
|
// nothing needs doing |
|
149
|
|
|
if (!isset($retval[$key]) || $filter === true) { |
|
150
|
|
|
continue; |
|
151
|
|
|
} |
|
152
|
|
|
|
|
153
|
|
|
// we want to remove this field |
|
154
|
|
|
if ($filter === false) { |
|
155
|
|
|
unset($retval[$key]); |
|
156
|
|
|
continue; |
|
157
|
|
|
} |
|
158
|
|
|
|
|
159
|
|
|
if (is_callable($filter)) { |
|
160
|
|
|
$retval[$key] = $filter($retval); |
|
161
|
|
|
continue; |
|
162
|
|
|
} |
|
163
|
|
|
|
|
164
|
|
|
if (is_array($retval[$key]) && is_array($filter)) { |
|
165
|
|
|
$retval[$key] = array_filter_contents($retval[$key], $filter); |
|
166
|
|
|
} |
|
167
|
|
|
} |
|
168
|
|
|
|
|
169
|
|
|
return $retval; |
|
170
|
|
|
} |
|
171
|
|
|
|
|
172
|
|
|
function array_quote(array $data, string $separator = ',', string $quote = '"') |
|
173
|
|
|
{ |
|
174
|
|
|
return $quote . implode($quote . $separator . $quote, $data) . $quote; |
|
175
|
|
|
} |
ganbarodigital /
php-the-missing-bits
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.