|
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
|
|
|
* Strip HTML and PHP tags from a string. Unlike the strip_tags function this method will return null if a null |
|
76
|
|
|
* value is given. The native php function will return an empty string. |
|
77
|
|
|
* |
|
78
|
|
|
* @param string|null $value The input string |
|
79
|
|
|
* |
|
80
|
|
|
* @return string|null |
|
81
|
|
|
*/ |
|
82
|
|
|
public static function stripTags(string $value = null) |
|
83
|
|
|
{ |
|
84
|
|
|
if ($value === null) { |
|
85
|
|
|
return null; |
|
86
|
|
|
} |
|
87
|
|
|
|
|
88
|
|
|
return strip_tags($value); |
|
89
|
|
|
} |
|
90
|
|
|
|
|
91
|
|
|
private static function validateMinimumLength(int $minLength) |
|
92
|
|
|
{ |
|
93
|
|
|
if ($minLength < 0) { |
|
94
|
|
|
throw new \InvalidArgumentException('$minLength was not a positive integer value'); |
|
95
|
|
|
} |
|
96
|
|
|
} |
|
97
|
|
|
|
|
98
|
|
|
private static function validateMaximumLength(int $maxLength) |
|
99
|
|
|
{ |
|
100
|
|
|
if ($maxLength < 0) { |
|
101
|
|
|
throw new \InvalidArgumentException('$maxLength was not a positive integer value'); |
|
102
|
|
|
} |
|
103
|
|
|
} |
|
104
|
|
|
|
|
105
|
|
|
private static function validateStringLength(string $value = null, int $minLength, int $maxLength) |
|
106
|
|
|
{ |
|
107
|
|
|
$valueLength = strlen($value); |
|
108
|
|
|
if ($valueLength < $minLength || $valueLength > $maxLength) { |
|
109
|
|
|
$format = "Value '%s' with length '%d' is less than '%d' or greater than '%d'"; |
|
110
|
|
|
throw new FilterException( |
|
111
|
|
|
sprintf($format, $value, $valueLength, $minLength, $maxLength) |
|
112
|
|
|
); |
|
113
|
|
|
} |
|
114
|
|
|
} |
|
115
|
|
|
|
|
116
|
|
|
private static function valueIsNullAndValid(bool $allowNull, $value = null) : bool |
|
117
|
|
|
{ |
|
118
|
|
|
if ($allowNull === false && $value === null) { |
|
119
|
|
|
throw new FilterException('Value failed filtering, $allowNull is set to false'); |
|
120
|
|
|
} |
|
121
|
|
|
|
|
122
|
|
|
return $allowNull === true && $value === null; |
|
123
|
|
|
} |
|
124
|
|
|
|
|
125
|
|
|
private static function validateIfObjectIsAString($value) |
|
126
|
|
|
{ |
|
127
|
|
|
if (!is_string($value)) { |
|
128
|
|
|
throw new FilterException("Value '" . var_export($value, true) . "' is not a string"); |
|
129
|
|
|
} |
|
130
|
|
|
} |
|
131
|
|
|
|
|
132
|
|
|
private static function enforceValueCanBeCastAsString($value) |
|
133
|
|
|
{ |
|
134
|
|
|
try { |
|
135
|
|
|
$value = ( |
|
136
|
|
|
function (string $str) : string { |
|
137
|
|
|
return $str; |
|
138
|
|
|
} |
|
139
|
|
|
)($value); |
|
140
|
|
|
} catch (TypeError $te) { |
|
141
|
|
|
throw new FilterException(sprintf("Value '%s' is not a string", var_export($value, true))); |
|
142
|
|
|
} |
|
143
|
|
|
|
|
144
|
|
|
return $value; |
|
145
|
|
|
} |
|
146
|
|
|
} |
|
147
|
|
|
|
traderinteractive /
filter-strings-php
