1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace TraderInteractive\Filter; |
4
|
|
|
|
5
|
|
|
use TraderInteractive\Exceptions\FilterException; |
6
|
|
|
use TypeError; |
7
|
|
|
|
8
|
|
|
/** |
9
|
|
|
* A collection of filters for strings. |
10
|
|
|
*/ |
11
|
|
|
final class Strings |
12
|
|
|
{ |
13
|
|
|
/** |
14
|
|
|
* Filter a string. |
15
|
|
|
* |
16
|
|
|
* Verify that the passed in value is a string. By default, nulls are not allowed, and the length is restricted |
17
|
|
|
* between 1 and PHP_INT_MAX. These parameters can be overwritten for custom behavior. |
18
|
|
|
* |
19
|
|
|
* The return value is the string, as expected by the \TraderInteractive\Filterer class. |
20
|
|
|
* |
21
|
|
|
* @param mixed $value The value to filter. |
22
|
|
|
* @param bool $allowNull True to allow nulls through, and false (default) if nulls should not be allowed. |
23
|
|
|
* @param int $minLength Minimum length to allow for $value. |
24
|
|
|
* @param int $maxLength Maximum length to allow for $value. |
25
|
|
|
* @return string|null The passed in $value. |
26
|
|
|
* |
27
|
|
|
* @throws FilterException if the value did not pass validation. |
28
|
|
|
* @throws \InvalidArgumentException if one of the parameters was not correctly typed. |
29
|
|
|
*/ |
30
|
|
|
public static function filter( |
31
|
|
|
$value = null, |
32
|
|
|
bool $allowNull = false, |
33
|
|
|
int $minLength = 1, |
34
|
|
|
int $maxLength = PHP_INT_MAX |
35
|
|
|
) { |
36
|
|
|
self::validateMinimumLength($minLength); |
37
|
|
|
self::validateMaximumLength($maxLength); |
38
|
|
|
|
39
|
|
|
if (self::valueIsNullAndValid($allowNull, $value)) { |
40
|
|
|
return null; |
41
|
|
|
} |
42
|
|
|
|
43
|
|
|
$value = self::enforceValueCanBeCastAsString($value); |
44
|
|
|
|
45
|
|
|
self::validateStringLength($value, $minLength, $maxLength); |
46
|
|
|
|
47
|
|
|
return $value; |
48
|
|
|
} |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* Explodes a string into an array using the given delimiter. |
52
|
|
|
* |
53
|
|
|
* For example, given the string 'foo,bar,baz', this would return the array ['foo', 'bar', 'baz']. |
54
|
|
|
* |
55
|
|
|
* @param string $value The string to explode. |
56
|
|
|
* @param string $delimiter The non-empty delimiter to explode on. |
57
|
|
|
* @return array The exploded values. |
58
|
|
|
* |
59
|
|
|
* @throws \InvalidArgumentException if the delimiter does not pass validation. |
60
|
|
|
*/ |
61
|
|
|
public static function explode($value, string $delimiter = ',') |
62
|
|
|
{ |
63
|
|
|
self::validateIfObjectIsAString($value); |
64
|
|
|
|
65
|
|
|
if (empty($delimiter)) { |
66
|
|
|
throw new \InvalidArgumentException( |
67
|
|
|
"Delimiter '" . var_export($delimiter, true) . "' is not a non-empty string" |
68
|
|
|
); |
69
|
|
|
} |
70
|
|
|
|
71
|
|
|
return explode($delimiter, $value); |
72
|
|
|
} |
73
|
|
|
|
74
|
|
|
/** |
75
|
|
|
* This filter takes the given string and translates it using the given value map. |
76
|
|
|
* |
77
|
|
|
* @param string $value The string value to translate |
78
|
|
|
* @param array $valueMap Array of key value pairs where a key will match the given $value. |
79
|
|
|
* |
80
|
|
|
* @return string |
81
|
|
|
*/ |
82
|
|
|
public static function translate(string $value, array $valueMap) : string |
83
|
|
|
{ |
84
|
|
|
if (!array_key_exists($value, $valueMap)) { |
85
|
|
|
throw new FilterException("The value '{$value}' was not found in the translation map array."); |
86
|
|
|
} |
87
|
|
|
|
88
|
|
|
return $valueMap[$value]; |
89
|
|
|
} |
90
|
|
|
|
91
|
|
|
/** |
92
|
|
|
* This filter prepends $prefix and appends $suffix to the string value. |
93
|
|
|
* |
94
|
|
|
* @param mixed $value The string value to which $prefix and $suffix will be added. |
95
|
|
|
* @param string $prefix The value to prepend to the string. |
96
|
|
|
* @param string $suffix The value to append to the string. |
97
|
|
|
* |
98
|
|
|
* @return string |
99
|
|
|
* |
100
|
|
|
* @throws FilterException Thrown if $value cannot be casted to a string. |
101
|
|
|
*/ |
102
|
|
|
public static function concat($value, string $prefix = '', string $suffix = '') : string |
103
|
|
|
{ |
104
|
|
|
self::enforceValueCanBeCastAsString($value); |
105
|
|
|
return "{$prefix}{$value}{$suffix}"; |
106
|
|
|
} |
107
|
|
|
|
108
|
|
|
/** |
109
|
|
|
* This filter trims and removes superfluous whitespace characters from the given string. |
110
|
|
|
* |
111
|
|
|
* @param string|null $value The string to compress. |
112
|
|
|
* @param bool $replaceVerticalWhitespace Flag to replace vertical whitespace such as newlines with |
113
|
|
|
* single space. |
114
|
|
|
* |
115
|
|
|
* @return string|null |
116
|
|
|
*/ |
117
|
|
|
public static function compress(string $value = null, bool $replaceVerticalWhitespace = false) |
118
|
|
|
{ |
119
|
|
|
if ($value === null) { |
120
|
|
|
return null; |
121
|
|
|
} |
122
|
|
|
|
123
|
|
|
$pattern = $replaceVerticalWhitespace ? '\s+' : '\h+'; |
124
|
|
|
|
125
|
|
|
return trim(preg_replace("/{$pattern}/", ' ', $value)); |
126
|
|
|
} |
127
|
|
|
|
128
|
|
|
/** |
129
|
|
|
* This filter replaces the given words with a replacement character. |
130
|
|
|
* |
131
|
|
|
* @param mixed $value The raw input to run the filter against. |
132
|
|
|
* @param array|callable $words The words to filter out. |
133
|
|
|
* @param string $replacement The character to replace the words with. |
134
|
|
|
* |
135
|
|
|
* @return string|null |
136
|
|
|
* |
137
|
|
|
* @throws FilterException Thrown when a bad value is encountered. |
138
|
|
|
*/ |
139
|
|
|
public static function redact( |
140
|
|
|
$value, |
141
|
|
|
$words, |
142
|
|
|
string $replacement = '' |
143
|
|
|
) { |
144
|
|
|
if ($value === null || $value === '') { |
145
|
|
|
return $value; |
146
|
|
|
} |
147
|
|
|
|
148
|
|
|
$stringValue = self::filter($value); |
149
|
|
|
if (is_callable($words)) { |
150
|
|
|
$words = $words(); |
151
|
|
|
} |
152
|
|
|
|
153
|
|
|
if (is_array($words) === false) { |
154
|
|
|
throw new FilterException("Words was not an array or a callable that returns an array"); |
155
|
|
|
} |
156
|
|
|
|
157
|
|
|
return self::replaceWordsWithReplacementString($stringValue, $words, $replacement); |
|
|
|
|
158
|
|
|
} |
159
|
|
|
|
160
|
|
|
/** |
161
|
|
|
* Strip HTML and PHP tags from a string and, optionally, replace the tags with a string. |
162
|
|
|
* Unlike the strip_tags function, this method will return null if a null value is given. |
163
|
|
|
* The native php function will return an empty string. |
164
|
|
|
* |
165
|
|
|
* @param string|null $value The input string. |
166
|
|
|
* @param string $replacement The string to replace the tags with. Defaults to an empty string. |
167
|
|
|
* |
168
|
|
|
* @return string|null |
169
|
|
|
*/ |
170
|
|
|
public static function stripTags(string $value = null, string $replacement = '') |
171
|
|
|
{ |
172
|
|
|
if ($value === null) { |
173
|
|
|
return null; |
174
|
|
|
} |
175
|
|
|
|
176
|
|
|
if ($replacement === '') { |
177
|
|
|
return strip_tags($value); |
178
|
|
|
} |
179
|
|
|
|
180
|
|
|
$findTagEntities = '/<[^>]+?>/'; |
181
|
|
|
$valueWithReplacements = preg_replace($findTagEntities, $replacement, $value); |
182
|
|
|
return strip_tags($valueWithReplacements); // use built-in as a safeguard to ensure tags are stripped |
183
|
|
|
} |
184
|
|
|
|
185
|
|
|
private static function validateMinimumLength(int $minLength) |
186
|
|
|
{ |
187
|
|
|
if ($minLength < 0) { |
188
|
|
|
throw new \InvalidArgumentException('$minLength was not a positive integer value'); |
189
|
|
|
} |
190
|
|
|
} |
191
|
|
|
|
192
|
|
|
private static function validateMaximumLength(int $maxLength) |
193
|
|
|
{ |
194
|
|
|
if ($maxLength < 0) { |
195
|
|
|
throw new \InvalidArgumentException('$maxLength was not a positive integer value'); |
196
|
|
|
} |
197
|
|
|
} |
198
|
|
|
|
199
|
|
|
private static function validateStringLength(string $value = null, int $minLength, int $maxLength) |
200
|
|
|
{ |
201
|
|
|
$valueLength = strlen($value); |
202
|
|
|
if ($valueLength < $minLength || $valueLength > $maxLength) { |
203
|
|
|
$format = "Value '%s' with length '%d' is less than '%d' or greater than '%d'"; |
204
|
|
|
throw new FilterException( |
205
|
|
|
sprintf($format, $value, $valueLength, $minLength, $maxLength) |
206
|
|
|
); |
207
|
|
|
} |
208
|
|
|
} |
209
|
|
|
|
210
|
|
|
private static function valueIsNullAndValid(bool $allowNull, $value = null) : bool |
211
|
|
|
{ |
212
|
|
|
if ($allowNull === false && $value === null) { |
213
|
|
|
throw new FilterException('Value failed filtering, $allowNull is set to false'); |
214
|
|
|
} |
215
|
|
|
|
216
|
|
|
return $allowNull === true && $value === null; |
217
|
|
|
} |
218
|
|
|
|
219
|
|
|
private static function validateIfObjectIsAString($value) |
220
|
|
|
{ |
221
|
|
|
if (!is_string($value)) { |
222
|
|
|
throw new FilterException("Value '" . var_export($value, true) . "' is not a string"); |
223
|
|
|
} |
224
|
|
|
} |
225
|
|
|
|
226
|
|
|
private static function enforceValueCanBeCastAsString($value) |
227
|
|
|
{ |
228
|
|
|
try { |
229
|
|
|
$value = ( |
230
|
|
|
function (string $str) : string { |
231
|
|
|
return $str; |
232
|
|
|
} |
233
|
|
|
)($value); |
234
|
|
|
} catch (TypeError $te) { |
235
|
|
|
throw new FilterException(sprintf("Value '%s' is not a string", var_export($value, true))); |
236
|
|
|
} |
237
|
|
|
|
238
|
|
|
return $value; |
239
|
|
|
} |
240
|
|
|
|
241
|
|
|
private static function replaceWordsWithReplacementString(string $value, array $words, string $replacement) : string |
242
|
|
|
{ |
243
|
|
|
$matchingWords = self::getMatchingWords($words, $value); |
244
|
|
|
if (count($matchingWords) === 0) { |
245
|
|
|
return $value; |
246
|
|
|
} |
247
|
|
|
|
248
|
|
|
$replacements = self::generateReplacementsMap($matchingWords, $replacement); |
249
|
|
|
|
250
|
|
|
return str_ireplace($matchingWords, $replacements, $value); |
251
|
|
|
} |
252
|
|
|
|
253
|
|
|
private static function getMatchingWords(array $words, string $value) : array |
254
|
|
|
{ |
255
|
|
|
$matchingWords = []; |
256
|
|
|
foreach ($words as $word) { |
257
|
|
|
$escapedWord = preg_quote($word, '/'); |
258
|
|
|
$caseInsensitiveWordPattern = "/\b{$escapedWord}\b/i"; |
259
|
|
|
if (preg_match($caseInsensitiveWordPattern, $value)) { |
260
|
|
|
$matchingWords[] = $word; |
261
|
|
|
} |
262
|
|
|
} |
263
|
|
|
|
264
|
|
|
return $matchingWords; |
265
|
|
|
} |
266
|
|
|
|
267
|
|
|
private static function generateReplacementsMap(array $words, string $replacement) : array |
268
|
|
|
{ |
269
|
|
|
$replacement = mb_substr($replacement, 0, 1); |
270
|
|
|
|
271
|
|
|
return array_map( |
272
|
|
|
function ($word) use ($replacement) { |
273
|
|
|
if ($replacement === '') { |
274
|
|
|
return ''; |
275
|
|
|
} |
276
|
|
|
|
277
|
|
|
return str_repeat($replacement, strlen($word)); |
278
|
|
|
}, |
279
|
|
|
$words |
280
|
|
|
); |
281
|
|
|
} |
282
|
|
|
} |
283
|
|
|
|