@@ -26,9 +26,9 @@ discard block |
||
26 | 26 | */ |
27 | 27 | trait Traits_Optionable |
28 | 28 | { |
29 | - /** |
|
30 | - * @var array<string,mixed>|NULL |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var array<string,mixed>|NULL |
|
31 | + */ |
|
32 | 32 | protected ?array $options = null; |
33 | 33 | |
34 | 34 | /** |
@@ -49,13 +49,13 @@ discard block |
||
49 | 49 | return $this; |
50 | 50 | } |
51 | 51 | |
52 | - /** |
|
53 | - * Sets a collection of options at once, from an |
|
54 | - * associative array. |
|
55 | - * |
|
56 | - * @param array<string,mixed> $options |
|
57 | - * @return $this |
|
58 | - */ |
|
52 | + /** |
|
53 | + * Sets a collection of options at once, from an |
|
54 | + * associative array. |
|
55 | + * |
|
56 | + * @param array<string,mixed> $options |
|
57 | + * @return $this |
|
58 | + */ |
|
59 | 59 | public function setOptions(array $options) : self |
60 | 60 | { |
61 | 61 | foreach($options as $name => $value) { |
@@ -65,16 +65,16 @@ discard block |
||
65 | 65 | return $this; |
66 | 66 | } |
67 | 67 | |
68 | - /** |
|
69 | - * Retrieves an option's value. |
|
70 | - * |
|
71 | - * NOTE: Use the specialized type getters to ensure an option |
|
72 | - * contains the expected type (for ex. getArrayOption()). |
|
73 | - * |
|
74 | - * @param string $name |
|
75 | - * @param mixed $default The default value to return if the option does not exist. |
|
76 | - * @return mixed |
|
77 | - */ |
|
68 | + /** |
|
69 | + * Retrieves an option's value. |
|
70 | + * |
|
71 | + * NOTE: Use the specialized type getters to ensure an option |
|
72 | + * contains the expected type (for ex. getArrayOption()). |
|
73 | + * |
|
74 | + * @param string $name |
|
75 | + * @param mixed $default The default value to return if the option does not exist. |
|
76 | + * @return mixed |
|
77 | + */ |
|
78 | 78 | public function getOption(string $name, $default=null) |
79 | 79 | { |
80 | 80 | if(!isset($this->options)) |
@@ -85,16 +85,16 @@ discard block |
||
85 | 85 | return $this->options[$name] ?? $default; |
86 | 86 | } |
87 | 87 | |
88 | - /** |
|
89 | - * Enforces that the option value is a string. Numbers are converted |
|
90 | - * to string, strings are passed through, and all other types will |
|
91 | - * return the default value. The default value is also returned if |
|
92 | - * the string is empty. |
|
93 | - * |
|
94 | - * @param string $name |
|
95 | - * @param string $default Used if the option does not exist, is invalid, or empty. |
|
96 | - * @return string |
|
97 | - */ |
|
88 | + /** |
|
89 | + * Enforces that the option value is a string. Numbers are converted |
|
90 | + * to string, strings are passed through, and all other types will |
|
91 | + * return the default value. The default value is also returned if |
|
92 | + * the string is empty. |
|
93 | + * |
|
94 | + * @param string $name |
|
95 | + * @param string $default Used if the option does not exist, is invalid, or empty. |
|
96 | + * @return string |
|
97 | + */ |
|
98 | 98 | public function getStringOption(string $name, string $default='') : string |
99 | 99 | { |
100 | 100 | $value = $this->getOption($name, false); |
@@ -126,15 +126,15 @@ discard block |
||
126 | 126 | return $default; |
127 | 127 | } |
128 | 128 | |
129 | - /** |
|
130 | - * Treats the option value as an integer value: will return |
|
131 | - * valid integer values (also from integer strings), or the |
|
132 | - * default value otherwise. |
|
133 | - * |
|
134 | - * @param string $name |
|
135 | - * @param int $default |
|
136 | - * @return int |
|
137 | - */ |
|
129 | + /** |
|
130 | + * Treats the option value as an integer value: will return |
|
131 | + * valid integer values (also from integer strings), or the |
|
132 | + * default value otherwise. |
|
133 | + * |
|
134 | + * @param string $name |
|
135 | + * @param int $default |
|
136 | + * @return int |
|
137 | + */ |
|
138 | 138 | public function getIntOption(string $name, int $default=0) : int |
139 | 139 | { |
140 | 140 | $value = $this->getOption($name); |
@@ -145,14 +145,14 @@ discard block |
||
145 | 145 | return $default; |
146 | 146 | } |
147 | 147 | |
148 | - /** |
|
149 | - * Treats an option as an array, and returns its value |
|
150 | - * only if it contains an array - otherwise, an empty |
|
151 | - * array is returned. |
|
152 | - * |
|
153 | - * @param string $name |
|
154 | - * @return array<int|string,mixed> |
|
155 | - */ |
|
148 | + /** |
|
149 | + * Treats an option as an array, and returns its value |
|
150 | + * only if it contains an array - otherwise, an empty |
|
151 | + * array is returned. |
|
152 | + * |
|
153 | + * @param string $name |
|
154 | + * @return array<int|string,mixed> |
|
155 | + */ |
|
156 | 156 | public function getArrayOption(string $name) : array |
157 | 157 | { |
158 | 158 | $val = $this->getOption($name); |
@@ -163,13 +163,13 @@ discard block |
||
163 | 163 | return array(); |
164 | 164 | } |
165 | 165 | |
166 | - /** |
|
167 | - * Checks whether the specified option exists - even |
|
168 | - * if it has a NULL value. |
|
169 | - * |
|
170 | - * @param string $name |
|
171 | - * @return bool |
|
172 | - */ |
|
166 | + /** |
|
167 | + * Checks whether the specified option exists - even |
|
168 | + * if it has a NULL value. |
|
169 | + * |
|
170 | + * @param string $name |
|
171 | + * @return bool |
|
172 | + */ |
|
173 | 173 | public function hasOption(string $name) : bool |
174 | 174 | { |
175 | 175 | if(!isset($this->options)) { |
@@ -179,11 +179,11 @@ discard block |
||
179 | 179 | return array_key_exists($name, $this->options); |
180 | 180 | } |
181 | 181 | |
182 | - /** |
|
183 | - * Returns all options in one associative array. |
|
184 | - * |
|
185 | - * @return array<string,mixed> |
|
186 | - */ |
|
182 | + /** |
|
183 | + * Returns all options in one associative array. |
|
184 | + * |
|
185 | + * @return array<string,mixed> |
|
186 | + */ |
|
187 | 187 | public function getOptions() : array |
188 | 188 | { |
189 | 189 | if(!isset($this->options)) { |
@@ -193,13 +193,13 @@ discard block |
||
193 | 193 | return $this->options; |
194 | 194 | } |
195 | 195 | |
196 | - /** |
|
197 | - * Checks whether the option's value is the one specified. |
|
198 | - * |
|
199 | - * @param string $name |
|
200 | - * @param mixed $value |
|
201 | - * @return bool |
|
202 | - */ |
|
196 | + /** |
|
197 | + * Checks whether the option's value is the one specified. |
|
198 | + * |
|
199 | + * @param string $name |
|
200 | + * @param mixed $value |
|
201 | + * @return bool |
|
202 | + */ |
|
203 | 203 | public function isOption(string $name, $value) : bool |
204 | 204 | { |
205 | 205 | return $this->getOption($name) === $value; |
@@ -41,7 +41,7 @@ discard block |
||
41 | 41 | */ |
42 | 42 | public function setOption(string $name, $value) : self |
43 | 43 | { |
44 | - if(!isset($this->options)) { |
|
44 | + if (!isset($this->options)) { |
|
45 | 45 | $this->options = $this->getDefaultOptions(); |
46 | 46 | } |
47 | 47 | |
@@ -58,7 +58,7 @@ discard block |
||
58 | 58 | */ |
59 | 59 | public function setOptions(array $options) : self |
60 | 60 | { |
61 | - foreach($options as $name => $value) { |
|
61 | + foreach ($options as $name => $value) { |
|
62 | 62 | $this->setOption($name, $value); |
63 | 63 | } |
64 | 64 | |
@@ -75,9 +75,9 @@ discard block |
||
75 | 75 | * @param mixed $default The default value to return if the option does not exist. |
76 | 76 | * @return mixed |
77 | 77 | */ |
78 | - public function getOption(string $name, $default=null) |
|
78 | + public function getOption(string $name, $default = null) |
|
79 | 79 | { |
80 | - if(!isset($this->options)) |
|
80 | + if (!isset($this->options)) |
|
81 | 81 | { |
82 | 82 | $this->options = $this->getDefaultOptions(); |
83 | 83 | } |
@@ -95,11 +95,11 @@ discard block |
||
95 | 95 | * @param string $default Used if the option does not exist, is invalid, or empty. |
96 | 96 | * @return string |
97 | 97 | */ |
98 | - public function getStringOption(string $name, string $default='') : string |
|
98 | + public function getStringOption(string $name, string $default = '') : string |
|
99 | 99 | { |
100 | 100 | $value = $this->getOption($name, false); |
101 | 101 | |
102 | - if((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
102 | + if ((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
103 | 103 | return (string)$value; |
104 | 104 | } |
105 | 105 | |
@@ -116,9 +116,9 @@ discard block |
||
116 | 116 | * @param bool $default |
117 | 117 | * @return bool |
118 | 118 | */ |
119 | - public function getBoolOption(string $name, bool $default=false) : bool |
|
119 | + public function getBoolOption(string $name, bool $default = false) : bool |
|
120 | 120 | { |
121 | - if($this->getOption($name) === true) |
|
121 | + if ($this->getOption($name) === true) |
|
122 | 122 | { |
123 | 123 | return true; |
124 | 124 | } |
@@ -135,10 +135,10 @@ discard block |
||
135 | 135 | * @param int $default |
136 | 136 | * @return int |
137 | 137 | */ |
138 | - public function getIntOption(string $name, int $default=0) : int |
|
138 | + public function getIntOption(string $name, int $default = 0) : int |
|
139 | 139 | { |
140 | 140 | $value = $this->getOption($name); |
141 | - if(ConvertHelper::isInteger($value)) { |
|
141 | + if (ConvertHelper::isInteger($value)) { |
|
142 | 142 | return (int)$value; |
143 | 143 | } |
144 | 144 | |
@@ -156,7 +156,7 @@ discard block |
||
156 | 156 | public function getArrayOption(string $name) : array |
157 | 157 | { |
158 | 158 | $val = $this->getOption($name); |
159 | - if(is_array($val)) { |
|
159 | + if (is_array($val)) { |
|
160 | 160 | return $val; |
161 | 161 | } |
162 | 162 | |
@@ -172,7 +172,7 @@ discard block |
||
172 | 172 | */ |
173 | 173 | public function hasOption(string $name) : bool |
174 | 174 | { |
175 | - if(!isset($this->options)) { |
|
175 | + if (!isset($this->options)) { |
|
176 | 176 | $this->options = $this->getDefaultOptions(); |
177 | 177 | } |
178 | 178 | |
@@ -186,7 +186,7 @@ discard block |
||
186 | 186 | */ |
187 | 187 | public function getOptions() : array |
188 | 188 | { |
189 | - if(!isset($this->options)) { |
|
189 | + if (!isset($this->options)) { |
|
190 | 190 | $this->options = $this->getDefaultOptions(); |
191 | 191 | } |
192 | 192 |
@@ -56,12 +56,12 @@ |
||
56 | 56 | */ |
57 | 57 | public static function value2string($value) : string |
58 | 58 | { |
59 | - if($value === true) |
|
59 | + if ($value === true) |
|
60 | 60 | { |
61 | 61 | return 'true'; |
62 | 62 | } |
63 | 63 | |
64 | - if($value === false) |
|
64 | + if ($value === false) |
|
65 | 65 | { |
66 | 66 | return 'false'; |
67 | 67 | } |
@@ -53,7 +53,7 @@ |
||
53 | 53 | * @param bool $enabled |
54 | 54 | * @return $this |
55 | 55 | */ |
56 | - public function prop(string $name, bool $enabled=true) : self; |
|
56 | + public function prop(string $name, bool $enabled = true) : self; |
|
57 | 57 | |
58 | 58 | /** |
59 | 59 | * @param string $name |
@@ -45,7 +45,7 @@ discard block |
||
45 | 45 | * @param mixed $default The default value to return if the option does not exist. |
46 | 46 | * @return mixed |
47 | 47 | */ |
48 | - public function getOption(string $name, $default=null); |
|
48 | + public function getOption(string $name, $default = null); |
|
49 | 49 | |
50 | 50 | /** |
51 | 51 | * @param string $name |
@@ -53,11 +53,11 @@ discard block |
||
53 | 53 | */ |
54 | 54 | public function getArrayOption(string $name) : array; |
55 | 55 | |
56 | - public function getIntOption(string $name, int $default=0) : int; |
|
56 | + public function getIntOption(string $name, int $default = 0) : int; |
|
57 | 57 | |
58 | - public function getBoolOption(string $name, bool $default=false) : bool; |
|
58 | + public function getBoolOption(string $name, bool $default = false) : bool; |
|
59 | 59 | |
60 | - public function getStringOption(string $name, string $default='') : string; |
|
60 | + public function getStringOption(string $name, string $default = '') : string; |
|
61 | 61 | |
62 | 62 | /** |
63 | 63 | * Sets a collection of options at once, from an |
@@ -23,44 +23,44 @@ |
||
23 | 23 | */ |
24 | 24 | class Request_URLComparer |
25 | 25 | { |
26 | - /** |
|
27 | - * @var Request |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var Request |
|
28 | + */ |
|
29 | 29 | protected Request $request; |
30 | 30 | |
31 | - /** |
|
32 | - * @var string |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var string |
|
33 | + */ |
|
34 | 34 | protected string $sourceURL; |
35 | 35 | |
36 | - /** |
|
37 | - * @var string |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @var string |
|
38 | + */ |
|
39 | 39 | protected string $targetURL; |
40 | 40 | |
41 | - /** |
|
42 | - * @var string[] |
|
43 | - */ |
|
41 | + /** |
|
42 | + * @var string[] |
|
43 | + */ |
|
44 | 44 | protected array $limitParams = array(); |
45 | 45 | |
46 | - /** |
|
47 | - * @var bool |
|
48 | - */ |
|
46 | + /** |
|
47 | + * @var bool |
|
48 | + */ |
|
49 | 49 | protected bool $isMatch = false; |
50 | 50 | |
51 | - /** |
|
52 | - * @var bool |
|
53 | - */ |
|
51 | + /** |
|
52 | + * @var bool |
|
53 | + */ |
|
54 | 54 | protected bool $ignoreFragment = true; |
55 | 55 | |
56 | - /** |
|
57 | - * @var URLInfo |
|
58 | - */ |
|
56 | + /** |
|
57 | + * @var URLInfo |
|
58 | + */ |
|
59 | 59 | protected URLInfo $sourceInfo; |
60 | 60 | |
61 | - /** |
|
62 | - * @var URLInfo |
|
63 | - */ |
|
61 | + /** |
|
62 | + * @var URLInfo |
|
63 | + */ |
|
64 | 64 | protected URLInfo $targetInfo; |
65 | 65 | |
66 | 66 | public function __construct(Request $request, string $sourceURL, string $targetURL) |
@@ -81,7 +81,7 @@ discard block |
||
81 | 81 | |
82 | 82 | public function addLimitParam(string $name) : Request_URLComparer |
83 | 83 | { |
84 | - if(!in_array($name, $this->limitParams, true)) |
|
84 | + if (!in_array($name, $this->limitParams, true)) |
|
85 | 85 | { |
86 | 86 | $this->limitParams[] = $name; |
87 | 87 | } |
@@ -95,7 +95,7 @@ discard block |
||
95 | 95 | */ |
96 | 96 | public function addLimitParams(array $names) : Request_URLComparer |
97 | 97 | { |
98 | - foreach($names as $name) |
|
98 | + foreach ($names as $name) |
|
99 | 99 | { |
100 | 100 | $this->addLimitParam($name); |
101 | 101 | } |
@@ -103,7 +103,7 @@ discard block |
||
103 | 103 | return $this; |
104 | 104 | } |
105 | 105 | |
106 | - public function setIgnoreFragment(bool $ignore=true) : Request_URLComparer |
|
106 | + public function setIgnoreFragment(bool $ignore = true) : Request_URLComparer |
|
107 | 107 | { |
108 | 108 | $this->ignoreFragment = $ignore; |
109 | 109 | return $this; |
@@ -126,13 +126,13 @@ discard block |
||
126 | 126 | 'query' |
127 | 127 | ); |
128 | 128 | |
129 | - if(!$this->ignoreFragment) { |
|
129 | + if (!$this->ignoreFragment) { |
|
130 | 130 | $keys[] = 'fragment'; |
131 | 131 | } |
132 | 132 | |
133 | - foreach($keys as $key) |
|
133 | + foreach ($keys as $key) |
|
134 | 134 | { |
135 | - if(!$this->compareKey($key)) { |
|
135 | + if (!$this->compareKey($key)) { |
|
136 | 136 | return false; |
137 | 137 | } |
138 | 138 | } |
@@ -147,7 +147,7 @@ discard block |
||
147 | 147 | |
148 | 148 | $filter = 'filter_'.$key; |
149 | 149 | |
150 | - if(method_exists($this, $filter)) |
|
150 | + if (method_exists($this, $filter)) |
|
151 | 151 | { |
152 | 152 | $sVal = $this->$filter($sVal); |
153 | 153 | $tVal = $this->$filter($tVal); |
@@ -159,7 +159,7 @@ discard block |
||
159 | 159 | protected function filter_path(string $path) : string |
160 | 160 | { |
161 | 161 | // fix double slashes in URLs |
162 | - while(strpos($path, '//') !== false) |
|
162 | + while (strpos($path, '//') !== false) |
|
163 | 163 | { |
164 | 164 | $path = str_replace('//', '/', $path); |
165 | 165 | } |
@@ -169,7 +169,7 @@ discard block |
||
169 | 169 | |
170 | 170 | protected function filter_query(string $query) : string |
171 | 171 | { |
172 | - if(empty($query)) { |
|
172 | + if (empty($query)) { |
|
173 | 173 | return ''; |
174 | 174 | } |
175 | 175 | |
@@ -188,15 +188,15 @@ discard block |
||
188 | 188 | */ |
189 | 189 | protected function limitParams(array $params) : array |
190 | 190 | { |
191 | - if(empty($this->limitParams)) { |
|
191 | + if (empty($this->limitParams)) { |
|
192 | 192 | return $params; |
193 | 193 | } |
194 | 194 | |
195 | 195 | $keep = array(); |
196 | 196 | |
197 | - foreach($this->limitParams as $name) |
|
197 | + foreach ($this->limitParams as $name) |
|
198 | 198 | { |
199 | - if(isset($params[$name])) { |
|
199 | + if (isset($params[$name])) { |
|
200 | 200 | $keep[$name] = $params[$name]; |
201 | 201 | } |
202 | 202 | } |
@@ -35,8 +35,7 @@ |
||
35 | 35 | try |
36 | 36 | { |
37 | 37 | return $this->render(); |
38 | - } |
|
39 | - catch (Throwable $e) |
|
38 | + } catch (Throwable $e) |
|
40 | 39 | { |
41 | 40 | return sprintf( |
42 | 41 | 'Exception while rendering [%s]: %s', |
@@ -35,8 +35,7 @@ |
||
35 | 35 | try |
36 | 36 | { |
37 | 37 | return $this->render(); |
38 | - } |
|
39 | - catch (Throwable $e) |
|
38 | + } catch (Throwable $e) |
|
40 | 39 | { |
41 | 40 | return sprintf( |
42 | 41 | 'Exception while rendering [%s]: %s', |
@@ -12,9 +12,9 @@ discard block |
||
12 | 12 | * @param bool $forceNew |
13 | 13 | * @return NumberInfo |
14 | 14 | */ |
15 | -function parseNumber($value, bool $forceNew=false) |
|
15 | +function parseNumber($value, bool $forceNew = false) |
|
16 | 16 | { |
17 | - if($value instanceof NumberInfo && $forceNew !== true) { |
|
17 | + if ($value instanceof NumberInfo && $forceNew !== true) { |
|
18 | 18 | return $value; |
19 | 19 | } |
20 | 20 | |
@@ -109,7 +109,7 @@ discard block |
||
109 | 109 | $args = func_get_args(); |
110 | 110 | |
111 | 111 | // is the localization package installed? |
112 | - if(function_exists('\AppLocalize\t')) |
|
112 | + if (function_exists('\AppLocalize\t')) |
|
113 | 113 | { |
114 | 114 | return call_user_func_array('\AppLocalize\t', $args); |
115 | 115 | } |
@@ -124,7 +124,7 @@ discard block |
||
124 | 124 | * @param bool $initial The initial boolean value to use. |
125 | 125 | * @return Value_Bool |
126 | 126 | */ |
127 | -function valBool(bool $initial=false) : Value_Bool |
|
127 | +function valBool(bool $initial = false) : Value_Bool |
|
128 | 128 | { |
129 | 129 | return new Value_Bool($initial); |
130 | 130 | } |
@@ -137,7 +137,7 @@ discard block |
||
137 | 137 | * @param bool $initial |
138 | 138 | * @return Value_Bool_True |
139 | 139 | */ |
140 | -function valBoolTrue(bool $initial=false) : Value_Bool_True |
|
140 | +function valBoolTrue(bool $initial = false) : Value_Bool_True |
|
141 | 141 | { |
142 | 142 | return new Value_Bool_True($initial); |
143 | 143 | } |
@@ -150,7 +150,7 @@ discard block |
||
150 | 150 | * @param bool $initial |
151 | 151 | * @return Value_Bool_False |
152 | 152 | */ |
153 | -function valBoolFalse(bool $initial=true) : Value_Bool_False |
|
153 | +function valBoolFalse(bool $initial = true) : Value_Bool_False |
|
154 | 154 | { |
155 | 155 | return new Value_Bool_False($initial); |
156 | 156 | } |
@@ -181,7 +181,7 @@ discard block |
||
181 | 181 | */ |
182 | 182 | function init() : void |
183 | 183 | { |
184 | - if(!class_exists('\AppLocalize\Localization')) { |
|
184 | + if (!class_exists('\AppLocalize\Localization')) { |
|
185 | 185 | return; |
186 | 186 | } |
187 | 187 |
@@ -60,13 +60,13 @@ discard block |
||
60 | 60 | return ConvertHelper_String::tabs2spaces($string, $tabSize); |
61 | 61 | } |
62 | 62 | |
63 | - /** |
|
64 | - * Converts spaces to tabs in the specified string. |
|
65 | - * |
|
66 | - * @param string $string |
|
67 | - * @param int $tabSize The amount of spaces per tab in the source string. |
|
68 | - * @return string |
|
69 | - */ |
|
63 | + /** |
|
64 | + * Converts spaces to tabs in the specified string. |
|
65 | + * |
|
66 | + * @param string $string |
|
67 | + * @param int $tabSize The amount of spaces per tab in the source string. |
|
68 | + * @return string |
|
69 | + */ |
|
70 | 70 | public static function spaces2tabs(string $string, int $tabSize=4) : string |
71 | 71 | { |
72 | 72 | return ConvertHelper_String::spaces2tabs($string, $tabSize); |
@@ -84,14 +84,14 @@ discard block |
||
84 | 84 | return ConvertHelper_String::hidden2visible($string); |
85 | 85 | } |
86 | 86 | |
87 | - /** |
|
88 | - * Converts the specified amount of seconds into |
|
89 | - * a human-readable string split in months, weeks, |
|
90 | - * days, hours, minutes and seconds. |
|
91 | - * |
|
92 | - * @param float $seconds |
|
93 | - * @return string |
|
94 | - */ |
|
87 | + /** |
|
88 | + * Converts the specified amount of seconds into |
|
89 | + * a human-readable string split in months, weeks, |
|
90 | + * days, hours, minutes and seconds. |
|
91 | + * |
|
92 | + * @param float $seconds |
|
93 | + * @return string |
|
94 | + */ |
|
95 | 95 | public static function time2string($seconds) : string |
96 | 96 | { |
97 | 97 | $converter = new ConvertHelper_TimeConverter($seconds); |
@@ -115,85 +115,85 @@ discard block |
||
115 | 115 | */ |
116 | 116 | public static function duration2string($datefrom, $dateto = -1) : string |
117 | 117 | { |
118 | - return ConvertHelper_DurationConverter::toString($datefrom, $dateto); |
|
118 | + return ConvertHelper_DurationConverter::toString($datefrom, $dateto); |
|
119 | 119 | } |
120 | 120 | |
121 | - /** |
|
122 | - * Adds HTML syntax highlighting to the specified SQL string. |
|
123 | - * |
|
124 | - * @param string $sql |
|
125 | - * @return string |
|
126 | - * @deprecated Use the Highlighter class directly instead. |
|
127 | - * @see Highlighter::sql() |
|
128 | - */ |
|
121 | + /** |
|
122 | + * Adds HTML syntax highlighting to the specified SQL string. |
|
123 | + * |
|
124 | + * @param string $sql |
|
125 | + * @return string |
|
126 | + * @deprecated Use the Highlighter class directly instead. |
|
127 | + * @see Highlighter::sql() |
|
128 | + */ |
|
129 | 129 | public static function highlight_sql(string $sql) : string |
130 | 130 | { |
131 | 131 | return Highlighter::sql($sql); |
132 | 132 | } |
133 | 133 | |
134 | - /** |
|
135 | - * Adds HTML syntax highlighting to the specified XML code. |
|
136 | - * |
|
137 | - * @param string $xml The XML to highlight. |
|
138 | - * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
139 | - * @return string |
|
140 | - * @deprecated Use the Highlighter class directly instead. |
|
141 | - * @see Highlighter::xml() |
|
142 | - */ |
|
134 | + /** |
|
135 | + * Adds HTML syntax highlighting to the specified XML code. |
|
136 | + * |
|
137 | + * @param string $xml The XML to highlight. |
|
138 | + * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
139 | + * @return string |
|
140 | + * @deprecated Use the Highlighter class directly instead. |
|
141 | + * @see Highlighter::xml() |
|
142 | + */ |
|
143 | 143 | public static function highlight_xml(string $xml, bool $formatSource=false) : string |
144 | 144 | { |
145 | 145 | return Highlighter::xml($xml, $formatSource); |
146 | 146 | } |
147 | 147 | |
148 | - /** |
|
149 | - * @param string $phpCode |
|
150 | - * @return string |
|
151 | - * @deprecated Use the Highlighter class directly instead. |
|
152 | - * @see Highlighter::php() |
|
153 | - */ |
|
148 | + /** |
|
149 | + * @param string $phpCode |
|
150 | + * @return string |
|
151 | + * @deprecated Use the Highlighter class directly instead. |
|
152 | + * @see Highlighter::php() |
|
153 | + */ |
|
154 | 154 | public static function highlight_php(string $phpCode) : string |
155 | 155 | { |
156 | 156 | return Highlighter::php($phpCode); |
157 | 157 | } |
158 | 158 | |
159 | - /** |
|
160 | - * Converts a number of bytes to a human-readable form, |
|
161 | - * e.g. xx Kb / xx Mb / xx Gb |
|
162 | - * |
|
163 | - * @param int $bytes The amount of bytes to convert. |
|
164 | - * @param int $precision The amount of decimals |
|
165 | - * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB). |
|
166 | - * @return string |
|
167 | - * |
|
168 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
169 | - */ |
|
159 | + /** |
|
160 | + * Converts a number of bytes to a human-readable form, |
|
161 | + * e.g. xx Kb / xx Mb / xx Gb |
|
162 | + * |
|
163 | + * @param int $bytes The amount of bytes to convert. |
|
164 | + * @param int $precision The amount of decimals |
|
165 | + * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB). |
|
166 | + * @return string |
|
167 | + * |
|
168 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
169 | + */ |
|
170 | 170 | public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string |
171 | 171 | { |
172 | 172 | return self::parseBytes($bytes)->toString($precision, $base); |
173 | 173 | } |
174 | 174 | |
175 | - /** |
|
176 | - * Parses a number of bytes, and creates a converter instance which |
|
177 | - * allows doing common operations with it. |
|
178 | - * |
|
179 | - * @param int $bytes |
|
180 | - * @return ConvertHelper_ByteConverter |
|
181 | - */ |
|
175 | + /** |
|
176 | + * Parses a number of bytes, and creates a converter instance which |
|
177 | + * allows doing common operations with it. |
|
178 | + * |
|
179 | + * @param int $bytes |
|
180 | + * @return ConvertHelper_ByteConverter |
|
181 | + */ |
|
182 | 182 | public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter |
183 | 183 | { |
184 | 184 | return new ConvertHelper_ByteConverter($bytes); |
185 | 185 | } |
186 | 186 | |
187 | - /** |
|
188 | - * Cuts a text to the specified length if it is longer than the |
|
189 | - * target length. Appends a text to signify it has been cut at |
|
190 | - * the end of the string. |
|
191 | - * |
|
192 | - * @param string $text |
|
193 | - * @param int $targetLength |
|
194 | - * @param string $append |
|
195 | - * @return string |
|
196 | - */ |
|
187 | + /** |
|
188 | + * Cuts a text to the specified length if it is longer than the |
|
189 | + * target length. Appends a text to signify it has been cut at |
|
190 | + * the end of the string. |
|
191 | + * |
|
192 | + * @param string $text |
|
193 | + * @param int $targetLength |
|
194 | + * @param string $append |
|
195 | + * @return string |
|
196 | + */ |
|
197 | 197 | public static function text_cut(string $text, int $targetLength, string $append = '...') : string |
198 | 198 | { |
199 | 199 | return ConvertHelper_String::cutText($text, $targetLength, $append); |
@@ -217,14 +217,14 @@ discard block |
||
217 | 217 | return $info->toString(); |
218 | 218 | } |
219 | 219 | |
220 | - /** |
|
221 | - * Pretty `print_r`. |
|
222 | - * |
|
223 | - * @param mixed $var The variable to dump. |
|
224 | - * @param bool $return Whether to return the dumped code. |
|
225 | - * @param bool $html Whether to style the dump as HTML. |
|
226 | - * @return string |
|
227 | - */ |
|
220 | + /** |
|
221 | + * Pretty `print_r`. |
|
222 | + * |
|
223 | + * @param mixed $var The variable to dump. |
|
224 | + * @param bool $return Whether to return the dumped code. |
|
225 | + * @param bool $html Whether to style the dump as HTML. |
|
226 | + * @return string |
|
227 | + */ |
|
228 | 228 | public static function print_r($var, bool $return=false, bool $html=true) : string |
229 | 229 | { |
230 | 230 | $result = parseVariable($var)->enableType()->toString(); |
@@ -245,29 +245,29 @@ discard block |
||
245 | 245 | return $result; |
246 | 246 | } |
247 | 247 | |
248 | - /** |
|
249 | - * Converts a string, number or boolean value to a boolean value. |
|
250 | - * |
|
251 | - * @param mixed $string |
|
252 | - * @throws ConvertHelper_Exception |
|
253 | - * @return bool |
|
254 | - * |
|
255 | - * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
256 | - */ |
|
248 | + /** |
|
249 | + * Converts a string, number or boolean value to a boolean value. |
|
250 | + * |
|
251 | + * @param mixed $string |
|
252 | + * @throws ConvertHelper_Exception |
|
253 | + * @return bool |
|
254 | + * |
|
255 | + * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
256 | + */ |
|
257 | 257 | public static function string2bool($string) : bool |
258 | 258 | { |
259 | 259 | return ConvertHelper_Bool::fromString($string); |
260 | 260 | } |
261 | 261 | |
262 | - /** |
|
263 | - * Whether the specified string is a boolean string or boolean value. |
|
264 | - * Alias for {@link ConvertHelper::isBoolean()}. |
|
265 | - * |
|
266 | - * @param mixed $string |
|
267 | - * @return bool |
|
268 | - * @deprecated |
|
269 | - * @see ConvertHelper::isBoolean() |
|
270 | - */ |
|
262 | + /** |
|
263 | + * Whether the specified string is a boolean string or boolean value. |
|
264 | + * Alias for {@link ConvertHelper::isBoolean()}. |
|
265 | + * |
|
266 | + * @param mixed $string |
|
267 | + * @return bool |
|
268 | + * @deprecated |
|
269 | + * @see ConvertHelper::isBoolean() |
|
270 | + */ |
|
271 | 271 | public static function isBooleanString($string) : bool |
272 | 272 | { |
273 | 273 | return self::isBoolean($string); |
@@ -337,36 +337,36 @@ discard block |
||
337 | 337 | return ConvertHelper_String::transliterate($string, $spaceChar, $lowercase); |
338 | 338 | } |
339 | 339 | |
340 | - /** |
|
341 | - * Retrieves the HEX character codes for all control |
|
342 | - * characters that the {@link stripControlCharacters()} |
|
343 | - * method will remove. |
|
344 | - * |
|
345 | - * @return string[] |
|
346 | - */ |
|
340 | + /** |
|
341 | + * Retrieves the HEX character codes for all control |
|
342 | + * characters that the {@link stripControlCharacters()} |
|
343 | + * method will remove. |
|
344 | + * |
|
345 | + * @return string[] |
|
346 | + */ |
|
347 | 347 | public static function getControlCharactersAsHex() : array |
348 | 348 | { |
349 | 349 | return self::createControlCharacters()->getCharsAsHex(); |
350 | 350 | } |
351 | 351 | |
352 | - /** |
|
353 | - * Retrieves an array of all control characters that |
|
354 | - * the {@link stripControlCharacters()} method will |
|
355 | - * remove, as the actual UTF-8 characters. |
|
356 | - * |
|
357 | - * @return string[] |
|
358 | - */ |
|
352 | + /** |
|
353 | + * Retrieves an array of all control characters that |
|
354 | + * the {@link stripControlCharacters()} method will |
|
355 | + * remove, as the actual UTF-8 characters. |
|
356 | + * |
|
357 | + * @return string[] |
|
358 | + */ |
|
359 | 359 | public static function getControlCharactersAsUTF8() : array |
360 | 360 | { |
361 | 361 | return self::createControlCharacters()->getCharsAsUTF8(); |
362 | 362 | } |
363 | 363 | |
364 | - /** |
|
365 | - * Retrieves all control characters as JSON encoded |
|
366 | - * characters, e.g. "\u200b". |
|
367 | - * |
|
368 | - * @return string[] |
|
369 | - */ |
|
364 | + /** |
|
365 | + * Retrieves all control characters as JSON encoded |
|
366 | + * characters, e.g. "\u200b". |
|
367 | + * |
|
368 | + * @return string[] |
|
369 | + */ |
|
370 | 370 | public static function getControlCharactersAsJSON() : array |
371 | 371 | { |
372 | 372 | return self::createControlCharacters()->getCharsAsJSON(); |
@@ -387,31 +387,31 @@ discard block |
||
387 | 387 | return self::createControlCharacters()->stripControlCharacters($string); |
388 | 388 | } |
389 | 389 | |
390 | - /** |
|
391 | - * Creates the control characters class, used to |
|
392 | - * work with control characters in strings. |
|
393 | - * |
|
394 | - * @return ConvertHelper_ControlCharacters |
|
395 | - */ |
|
390 | + /** |
|
391 | + * Creates the control characters class, used to |
|
392 | + * work with control characters in strings. |
|
393 | + * |
|
394 | + * @return ConvertHelper_ControlCharacters |
|
395 | + */ |
|
396 | 396 | public static function createControlCharacters() : ConvertHelper_ControlCharacters |
397 | 397 | { |
398 | 398 | return new ConvertHelper_ControlCharacters(); |
399 | 399 | } |
400 | 400 | |
401 | - /** |
|
402 | - * Converts a unicode character to the PHP notation. |
|
403 | - * |
|
404 | - * Example: |
|
405 | - * |
|
406 | - * <pre>unicodeChar2php('"\u0000"')</pre> |
|
407 | - * |
|
408 | - * Returns |
|
409 | - * |
|
410 | - * <pre>\x0</pre> |
|
411 | - * |
|
412 | - * @param string $unicodeChar |
|
413 | - * @return string |
|
414 | - */ |
|
401 | + /** |
|
402 | + * Converts a unicode character to the PHP notation. |
|
403 | + * |
|
404 | + * Example: |
|
405 | + * |
|
406 | + * <pre>unicodeChar2php('"\u0000"')</pre> |
|
407 | + * |
|
408 | + * Returns |
|
409 | + * |
|
410 | + * <pre>\x0</pre> |
|
411 | + * |
|
412 | + * @param string $unicodeChar |
|
413 | + * @return string |
|
414 | + */ |
|
415 | 415 | public static function unicodeChar2php(string $unicodeChar) : string |
416 | 416 | { |
417 | 417 | $unicodeChar = json_decode($unicodeChar); |
@@ -525,138 +525,138 @@ discard block |
||
525 | 525 | return ConvertHelper_Bool::toStringStrict($boolean, $yesNo); |
526 | 526 | } |
527 | 527 | |
528 | - /** |
|
529 | - * Converts an associative array with attribute name > value pairs |
|
530 | - * to an attribute string that can be used in an HTML tag. Empty |
|
531 | - * attribute values are ignored. |
|
532 | - * |
|
533 | - * Example: |
|
534 | - * |
|
535 | - * array2attributeString(array( |
|
536 | - * 'id' => 45, |
|
537 | - * 'href' => 'http://www.mistralys.com' |
|
538 | - * )); |
|
539 | - * |
|
540 | - * Result: |
|
541 | - * |
|
542 | - * id="45" href="http://www.mistralys.com" |
|
543 | - * |
|
544 | - * @param array<string,mixed> $array |
|
545 | - * @return string |
|
546 | - */ |
|
528 | + /** |
|
529 | + * Converts an associative array with attribute name > value pairs |
|
530 | + * to an attribute string that can be used in an HTML tag. Empty |
|
531 | + * attribute values are ignored. |
|
532 | + * |
|
533 | + * Example: |
|
534 | + * |
|
535 | + * array2attributeString(array( |
|
536 | + * 'id' => 45, |
|
537 | + * 'href' => 'http://www.mistralys.com' |
|
538 | + * )); |
|
539 | + * |
|
540 | + * Result: |
|
541 | + * |
|
542 | + * id="45" href="http://www.mistralys.com" |
|
543 | + * |
|
544 | + * @param array<string,mixed> $array |
|
545 | + * @return string |
|
546 | + */ |
|
547 | 547 | public static function array2attributeString(array $array) : string |
548 | 548 | { |
549 | 549 | return ConvertHelper_Array::toAttributeString($array); |
550 | 550 | } |
551 | 551 | |
552 | - /** |
|
553 | - * Converts a string, so it can safely be used in a javascript |
|
554 | - * statement in an HTML tag: uses single quotes around the string |
|
555 | - * and encodes all special characters as needed. |
|
556 | - * |
|
557 | - * @param string $string |
|
558 | - * @return string |
|
559 | - * @deprecated Use the JSHelper class instead. |
|
560 | - * @see JSHelper::phpVariable2AttributeJS() |
|
561 | - */ |
|
552 | + /** |
|
553 | + * Converts a string, so it can safely be used in a javascript |
|
554 | + * statement in an HTML tag: uses single quotes around the string |
|
555 | + * and encodes all special characters as needed. |
|
556 | + * |
|
557 | + * @param string $string |
|
558 | + * @return string |
|
559 | + * @deprecated Use the JSHelper class instead. |
|
560 | + * @see JSHelper::phpVariable2AttributeJS() |
|
561 | + */ |
|
562 | 562 | public static function string2attributeJS(string $string) : string |
563 | 563 | { |
564 | 564 | return JSHelper::phpVariable2AttributeJS($string); |
565 | 565 | } |
566 | 566 | |
567 | - /** |
|
568 | - * Checks if the specified string is a boolean value, which |
|
569 | - * includes string representations of boolean values, like |
|
570 | - * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
571 | - * or <code>false</code>. |
|
572 | - * |
|
573 | - * @param mixed $value |
|
574 | - * @return boolean |
|
575 | - */ |
|
567 | + /** |
|
568 | + * Checks if the specified string is a boolean value, which |
|
569 | + * includes string representations of boolean values, like |
|
570 | + * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
571 | + * or <code>false</code>. |
|
572 | + * |
|
573 | + * @param mixed $value |
|
574 | + * @return boolean |
|
575 | + */ |
|
576 | 576 | public static function isBoolean($value) : bool |
577 | 577 | { |
578 | 578 | return ConvertHelper_Bool::isBoolean($value); |
579 | 579 | } |
580 | 580 | |
581 | - /** |
|
582 | - * Converts an associative array to an HTML style attribute value string. |
|
583 | - * |
|
584 | - * @param array<string,mixed> $subject |
|
585 | - * @return string |
|
586 | - */ |
|
581 | + /** |
|
582 | + * Converts an associative array to an HTML style attribute value string. |
|
583 | + * |
|
584 | + * @param array<string,mixed> $subject |
|
585 | + * @return string |
|
586 | + */ |
|
587 | 587 | public static function array2styleString(array $subject) : string |
588 | 588 | { |
589 | 589 | return ConvertHelper_Array::toStyleString($subject); |
590 | 590 | } |
591 | 591 | |
592 | - /** |
|
593 | - * Converts a DateTime object to a timestamp, which |
|
594 | - * is PHP 5.2 compatible. |
|
595 | - * |
|
596 | - * @param DateTime $date |
|
597 | - * @return integer |
|
598 | - */ |
|
592 | + /** |
|
593 | + * Converts a DateTime object to a timestamp, which |
|
594 | + * is PHP 5.2 compatible. |
|
595 | + * |
|
596 | + * @param DateTime $date |
|
597 | + * @return integer |
|
598 | + */ |
|
599 | 599 | public static function date2timestamp(DateTime $date) : int |
600 | 600 | { |
601 | 601 | return ConvertHelper_Date::toTimestamp($date); |
602 | 602 | } |
603 | 603 | |
604 | - /** |
|
605 | - * Converts a timestamp into a DateTime instance. |
|
606 | - * @param int $timestamp |
|
607 | - * @return DateTime |
|
608 | - */ |
|
604 | + /** |
|
605 | + * Converts a timestamp into a DateTime instance. |
|
606 | + * @param int $timestamp |
|
607 | + * @return DateTime |
|
608 | + */ |
|
609 | 609 | public static function timestamp2date(int $timestamp) : DateTime |
610 | 610 | { |
611 | 611 | return ConvertHelper_Date::fromTimestamp($timestamp); |
612 | 612 | } |
613 | 613 | |
614 | - /** |
|
615 | - * Strips an absolute path to a file within the application |
|
616 | - * to make the path relative to the application root path. |
|
617 | - * |
|
618 | - * @param string $path |
|
619 | - * @return string |
|
620 | - * |
|
621 | - * @see FileHelper::relativizePath() |
|
622 | - * @see FileHelper::relativizePathByDepth() |
|
623 | - */ |
|
614 | + /** |
|
615 | + * Strips an absolute path to a file within the application |
|
616 | + * to make the path relative to the application root path. |
|
617 | + * |
|
618 | + * @param string $path |
|
619 | + * @return string |
|
620 | + * |
|
621 | + * @see FileHelper::relativizePath() |
|
622 | + * @see FileHelper::relativizePathByDepth() |
|
623 | + */ |
|
624 | 624 | public static function fileRelativize(string $path) : string |
625 | 625 | { |
626 | 626 | return FileHelper::relativizePathByDepth($path); |
627 | 627 | } |
628 | 628 | |
629 | 629 | /** |
630 | - * Converts a PHP regex to a javascript RegExp object statement. |
|
631 | - * |
|
632 | - * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
633 | - * More details are available on its usage there. |
|
634 | - * |
|
635 | - * @param string $regex A PHP preg regex |
|
636 | - * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
637 | - * @return string Depending on the specified return type. |
|
638 | - * |
|
639 | - * @see JSHelper::buildRegexStatement() |
|
640 | - */ |
|
630 | + * Converts a PHP regex to a javascript RegExp object statement. |
|
631 | + * |
|
632 | + * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
633 | + * More details are available on its usage there. |
|
634 | + * |
|
635 | + * @param string $regex A PHP preg regex |
|
636 | + * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
637 | + * @return string Depending on the specified return type. |
|
638 | + * |
|
639 | + * @see JSHelper::buildRegexStatement() |
|
640 | + */ |
|
641 | 641 | public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) : string |
642 | 642 | { |
643 | 643 | return JSHelper::buildRegexStatement($regex, $statementType); |
644 | 644 | } |
645 | 645 | |
646 | - /** |
|
647 | - * Converts the specified variable to JSON. Works just |
|
648 | - * like the native `json_encode` method, except that it |
|
649 | - * will trigger an exception on failure, which has the |
|
650 | - * json error details included in its developer details. |
|
651 | - * |
|
652 | - * @param mixed $variable |
|
653 | - * @param int $options JSON encode options. |
|
654 | - * @param int $depth |
|
655 | - * @return string |
|
656 | - * |
|
657 | - * @throws ConvertHelper_Exception |
|
658 | - * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED |
|
659 | - */ |
|
646 | + /** |
|
647 | + * Converts the specified variable to JSON. Works just |
|
648 | + * like the native `json_encode` method, except that it |
|
649 | + * will trigger an exception on failure, which has the |
|
650 | + * json error details included in its developer details. |
|
651 | + * |
|
652 | + * @param mixed $variable |
|
653 | + * @param int $options JSON encode options. |
|
654 | + * @param int $depth |
|
655 | + * @return string |
|
656 | + * |
|
657 | + * @throws ConvertHelper_Exception |
|
658 | + * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED |
|
659 | + */ |
|
660 | 660 | public static function var2json($variable, int $options=0, int $depth=512) : string |
661 | 661 | { |
662 | 662 | $result = json_encode($variable, $options, $depth); |
@@ -691,12 +691,12 @@ discard block |
||
691 | 691 | ->toString(); |
692 | 692 | } |
693 | 693 | |
694 | - /** |
|
695 | - * Strips all known UTF byte order marks from the specified string. |
|
696 | - * |
|
697 | - * @param string $string |
|
698 | - * @return string |
|
699 | - */ |
|
694 | + /** |
|
695 | + * Strips all known UTF byte order marks from the specified string. |
|
696 | + * |
|
697 | + * @param string $string |
|
698 | + * @return string |
|
699 | + */ |
|
700 | 700 | public static function stripUTFBom(string $string) : string |
701 | 701 | { |
702 | 702 | $boms = FileHelper::createUnicodeHandling()->getUTFBOMs(); |
@@ -715,69 +715,69 @@ discard block |
||
715 | 715 | return $string; |
716 | 716 | } |
717 | 717 | |
718 | - /** |
|
719 | - * Converts a string to valid utf8, regardless |
|
720 | - * of the string's encoding(s). |
|
721 | - * |
|
722 | - * @param string $string |
|
723 | - * @return string |
|
724 | - */ |
|
718 | + /** |
|
719 | + * Converts a string to valid utf8, regardless |
|
720 | + * of the string's encoding(s). |
|
721 | + * |
|
722 | + * @param string $string |
|
723 | + * @return string |
|
724 | + */ |
|
725 | 725 | public static function string2utf8(string $string) : string |
726 | 726 | { |
727 | 727 | return ConvertHelper_String::toUtf8($string); |
728 | 728 | } |
729 | 729 | |
730 | - /** |
|
731 | - * Checks whether the specified string is an ASCII |
|
732 | - * string, without any special or UTF8 characters. |
|
733 | - * Note: empty strings and NULL are considered ASCII. |
|
734 | - * Any variable types other than strings are not. |
|
735 | - * |
|
736 | - * @param string|float|int|NULL $string |
|
737 | - * @return boolean |
|
738 | - */ |
|
730 | + /** |
|
731 | + * Checks whether the specified string is an ASCII |
|
732 | + * string, without any special or UTF8 characters. |
|
733 | + * Note: empty strings and NULL are considered ASCII. |
|
734 | + * Any variable types other than strings are not. |
|
735 | + * |
|
736 | + * @param string|float|int|NULL $string |
|
737 | + * @return boolean |
|
738 | + */ |
|
739 | 739 | public static function isStringASCII($string) : bool |
740 | 740 | { |
741 | 741 | return ConvertHelper_String::isASCII(strval($string)); |
742 | 742 | } |
743 | 743 | |
744 | - /** |
|
745 | - * Adds HTML syntax highlighting to an URL. |
|
746 | - * |
|
747 | - * NOTE: Includes the necessary CSS styles. When |
|
748 | - * highlighting several URLs in the same page, |
|
749 | - * prefer using the `parseURL` function instead. |
|
750 | - * |
|
751 | - * @param string $url |
|
752 | - * @return string |
|
753 | - * @deprecated Use the Highlighter class directly instead. |
|
754 | - * @see Highlighter |
|
755 | - */ |
|
744 | + /** |
|
745 | + * Adds HTML syntax highlighting to an URL. |
|
746 | + * |
|
747 | + * NOTE: Includes the necessary CSS styles. When |
|
748 | + * highlighting several URLs in the same page, |
|
749 | + * prefer using the `parseURL` function instead. |
|
750 | + * |
|
751 | + * @param string $url |
|
752 | + * @return string |
|
753 | + * @deprecated Use the Highlighter class directly instead. |
|
754 | + * @see Highlighter |
|
755 | + */ |
|
756 | 756 | public static function highlight_url(string $url) : string |
757 | 757 | { |
758 | 758 | return Highlighter::url($url); |
759 | 759 | } |
760 | 760 | |
761 | - /** |
|
762 | - * Calculates a percentage match of the source string with the target string. |
|
763 | - * |
|
764 | - * Options are: |
|
765 | - * |
|
766 | - * - maxLevenshtein, default: 10 |
|
767 | - * Any levenshtein results above this value are ignored. |
|
768 | - * |
|
769 | - * - precision, default: 1 |
|
770 | - * The precision of the percentage float value |
|
771 | - * |
|
772 | - * @param string $source |
|
773 | - * @param string $target |
|
774 | - * @param array<string,mixed> $options |
|
775 | - * @return float |
|
776 | - * |
|
777 | - * @see ConvertHelper_TextComparer |
|
778 | - * @see ConvertHelper_TextComparer::OPTION_MAX_LEVENSHTEIN_DISTANCE |
|
779 | - * @see ConvertHelper_TextComparer::OPTION_PRECISION |
|
780 | - */ |
|
761 | + /** |
|
762 | + * Calculates a percentage match of the source string with the target string. |
|
763 | + * |
|
764 | + * Options are: |
|
765 | + * |
|
766 | + * - maxLevenshtein, default: 10 |
|
767 | + * Any levenshtein results above this value are ignored. |
|
768 | + * |
|
769 | + * - precision, default: 1 |
|
770 | + * The precision of the percentage float value |
|
771 | + * |
|
772 | + * @param string $source |
|
773 | + * @param string $target |
|
774 | + * @param array<string,mixed> $options |
|
775 | + * @return float |
|
776 | + * |
|
777 | + * @see ConvertHelper_TextComparer |
|
778 | + * @see ConvertHelper_TextComparer::OPTION_MAX_LEVENSHTEIN_DISTANCE |
|
779 | + * @see ConvertHelper_TextComparer::OPTION_PRECISION |
|
780 | + */ |
|
781 | 781 | public static function matchString(string $source, string $target, array $options=array()) : float |
782 | 782 | { |
783 | 783 | return (new ConvertHelper_TextComparer()) |
@@ -785,109 +785,109 @@ discard block |
||
785 | 785 | ->match($source, $target); |
786 | 786 | } |
787 | 787 | |
788 | - /** |
|
789 | - * Converts a date interval to a human-readable string with |
|
790 | - * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
791 | - * |
|
792 | - * @param DateInterval $interval |
|
793 | - * @return string |
|
794 | - * @see ConvertHelper_IntervalConverter |
|
795 | - * |
|
796 | - * @throws ConvertHelper_Exception |
|
797 | - * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION |
|
798 | - */ |
|
788 | + /** |
|
789 | + * Converts a date interval to a human-readable string with |
|
790 | + * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
791 | + * |
|
792 | + * @param DateInterval $interval |
|
793 | + * @return string |
|
794 | + * @see ConvertHelper_IntervalConverter |
|
795 | + * |
|
796 | + * @throws ConvertHelper_Exception |
|
797 | + * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION |
|
798 | + */ |
|
799 | 799 | public static function interval2string(DateInterval $interval) : string |
800 | 800 | { |
801 | 801 | return (new ConvertHelper_IntervalConverter()) |
802 | 802 | ->toString($interval); |
803 | 803 | } |
804 | 804 | |
805 | - /** |
|
806 | - * Converts an interval to its total amount of days. |
|
807 | - * @param DateInterval $interval |
|
808 | - * @return int |
|
809 | - */ |
|
805 | + /** |
|
806 | + * Converts an interval to its total amount of days. |
|
807 | + * @param DateInterval $interval |
|
808 | + * @return int |
|
809 | + */ |
|
810 | 810 | public static function interval2days(DateInterval $interval) : int |
811 | 811 | { |
812 | 812 | return ConvertHelper_DateInterval::toDays($interval); |
813 | 813 | } |
814 | 814 | |
815 | - /** |
|
816 | - * Converts an interval to its total amount of hours. |
|
817 | - * @param DateInterval $interval |
|
818 | - * @return int |
|
819 | - */ |
|
815 | + /** |
|
816 | + * Converts an interval to its total amount of hours. |
|
817 | + * @param DateInterval $interval |
|
818 | + * @return int |
|
819 | + */ |
|
820 | 820 | public static function interval2hours(DateInterval $interval) : int |
821 | 821 | { |
822 | 822 | return ConvertHelper_DateInterval::toHours($interval); |
823 | 823 | } |
824 | 824 | |
825 | - /** |
|
826 | - * Converts an interval to its total amount of minutes. |
|
827 | - * @param DateInterval $interval |
|
828 | - * @return int |
|
829 | - */ |
|
825 | + /** |
|
826 | + * Converts an interval to its total amount of minutes. |
|
827 | + * @param DateInterval $interval |
|
828 | + * @return int |
|
829 | + */ |
|
830 | 830 | public static function interval2minutes(DateInterval $interval) : int |
831 | 831 | { |
832 | 832 | return ConvertHelper_DateInterval::toMinutes($interval); |
833 | 833 | } |
834 | 834 | |
835 | - /** |
|
836 | - * Converts an interval to its total amount of seconds. |
|
837 | - * @param DateInterval $interval |
|
838 | - * @return int |
|
839 | - */ |
|
835 | + /** |
|
836 | + * Converts an interval to its total amount of seconds. |
|
837 | + * @param DateInterval $interval |
|
838 | + * @return int |
|
839 | + */ |
|
840 | 840 | public static function interval2seconds(DateInterval $interval) : int |
841 | 841 | { |
842 | 842 | return ConvertHelper_DateInterval::toSeconds($interval); |
843 | 843 | } |
844 | 844 | |
845 | - /** |
|
846 | - * Calculates the total amount of days / hours / minutes or seconds |
|
847 | - * of a date interval object (depending on the specified units), and |
|
848 | - * returns the total amount. |
|
849 | - * |
|
850 | - * @param DateInterval $interval |
|
851 | - * @param string $unit What total value to calculate. |
|
852 | - * @return integer |
|
853 | - * |
|
854 | - * @see ConvertHelper::INTERVAL_SECONDS |
|
855 | - * @see ConvertHelper::INTERVAL_MINUTES |
|
856 | - * @see ConvertHelper::INTERVAL_HOURS |
|
857 | - * @see ConvertHelper::INTERVAL_DAYS |
|
858 | - */ |
|
845 | + /** |
|
846 | + * Calculates the total amount of days / hours / minutes or seconds |
|
847 | + * of a date interval object (depending on the specified units), and |
|
848 | + * returns the total amount. |
|
849 | + * |
|
850 | + * @param DateInterval $interval |
|
851 | + * @param string $unit What total value to calculate. |
|
852 | + * @return integer |
|
853 | + * |
|
854 | + * @see ConvertHelper::INTERVAL_SECONDS |
|
855 | + * @see ConvertHelper::INTERVAL_MINUTES |
|
856 | + * @see ConvertHelper::INTERVAL_HOURS |
|
857 | + * @see ConvertHelper::INTERVAL_DAYS |
|
858 | + */ |
|
859 | 859 | public static function interval2total(DateInterval $interval, string $unit=self::INTERVAL_SECONDS) : int |
860 | 860 | { |
861 | 861 | return ConvertHelper_DateInterval::toTotal($interval, $unit); |
862 | 862 | } |
863 | 863 | |
864 | - /** |
|
865 | - * Converts a date to the corresponding day name. |
|
866 | - * |
|
867 | - * @param DateTime $date |
|
868 | - * @param bool $short |
|
869 | - * @return string|NULL |
|
870 | - */ |
|
864 | + /** |
|
865 | + * Converts a date to the corresponding day name. |
|
866 | + * |
|
867 | + * @param DateTime $date |
|
868 | + * @param bool $short |
|
869 | + * @return string|NULL |
|
870 | + */ |
|
871 | 871 | public static function date2dayName(DateTime $date, bool $short=false) : ?string |
872 | 872 | { |
873 | 873 | return ConvertHelper_Date::toDayName($date, $short); |
874 | 874 | } |
875 | 875 | |
876 | - /** |
|
877 | - * Retrieves a list of english day names. |
|
878 | - * @return string[] |
|
879 | - */ |
|
876 | + /** |
|
877 | + * Retrieves a list of english day names. |
|
878 | + * @return string[] |
|
879 | + */ |
|
880 | 880 | public static function getDayNamesInvariant() : array |
881 | 881 | { |
882 | 882 | return ConvertHelper_Date::getDayNamesInvariant(); |
883 | 883 | } |
884 | 884 | |
885 | - /** |
|
886 | - * Retrieves the day names list for the current locale. |
|
887 | - * |
|
888 | - * @param bool $short |
|
889 | - * @return string[] |
|
890 | - */ |
|
885 | + /** |
|
886 | + * Retrieves the day names list for the current locale. |
|
887 | + * |
|
888 | + * @param bool $short |
|
889 | + * @return string[] |
|
890 | + */ |
|
891 | 891 | public static function getDayNames(bool $short=false) : array |
892 | 892 | { |
893 | 893 | return ConvertHelper_Date::getDayNames($short); |
@@ -906,68 +906,68 @@ discard block |
||
906 | 906 | return ConvertHelper_Array::implodeWithAnd($list, $sep, $conjunction); |
907 | 907 | } |
908 | 908 | |
909 | - /** |
|
910 | - * Splits a string into an array of all characters it is composed of. |
|
911 | - * Unicode character safe. |
|
912 | - * |
|
913 | - * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
914 | - * characters. |
|
915 | - * |
|
916 | - * @param string $string |
|
917 | - * @return string[] |
|
918 | - */ |
|
909 | + /** |
|
910 | + * Splits a string into an array of all characters it is composed of. |
|
911 | + * Unicode character safe. |
|
912 | + * |
|
913 | + * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
914 | + * characters. |
|
915 | + * |
|
916 | + * @param string $string |
|
917 | + * @return string[] |
|
918 | + */ |
|
919 | 919 | public static function string2array(string $string) : array |
920 | 920 | { |
921 | 921 | return ConvertHelper_String::toArray($string); |
922 | 922 | } |
923 | 923 | |
924 | - /** |
|
925 | - * Checks whether the specified string contains HTML code. |
|
926 | - * |
|
927 | - * @param string $string |
|
928 | - * @return boolean |
|
929 | - */ |
|
924 | + /** |
|
925 | + * Checks whether the specified string contains HTML code. |
|
926 | + * |
|
927 | + * @param string $string |
|
928 | + * @return boolean |
|
929 | + */ |
|
930 | 930 | public static function isStringHTML(string $string) : bool |
931 | 931 | { |
932 | 932 | return ConvertHelper_String::isHTML($string); |
933 | 933 | } |
934 | 934 | |
935 | - /** |
|
936 | - * UTF8-safe wordwrap method: works like the regular wordwrap |
|
937 | - * PHP function but compatible with UTF8. Otherwise the lengths |
|
938 | - * are not calculated correctly. |
|
939 | - * |
|
940 | - * @param string $str |
|
941 | - * @param int $width |
|
942 | - * @param string $break |
|
943 | - * @param bool $cut |
|
944 | - * @return string |
|
945 | - */ |
|
935 | + /** |
|
936 | + * UTF8-safe wordwrap method: works like the regular wordwrap |
|
937 | + * PHP function but compatible with UTF8. Otherwise the lengths |
|
938 | + * are not calculated correctly. |
|
939 | + * |
|
940 | + * @param string $str |
|
941 | + * @param int $width |
|
942 | + * @param string $break |
|
943 | + * @param bool $cut |
|
944 | + * @return string |
|
945 | + */ |
|
946 | 946 | public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string |
947 | 947 | { |
948 | 948 | return ConvertHelper_String::wordwrap($str, $width, $break, $cut); |
949 | 949 | } |
950 | 950 | |
951 | - /** |
|
952 | - * Calculates the byte length of a string, taking into |
|
953 | - * account any unicode characters. |
|
954 | - * |
|
955 | - * @param string $string |
|
956 | - * @return int |
|
957 | - */ |
|
951 | + /** |
|
952 | + * Calculates the byte length of a string, taking into |
|
953 | + * account any unicode characters. |
|
954 | + * |
|
955 | + * @param string $string |
|
956 | + * @return int |
|
957 | + */ |
|
958 | 958 | public static function string2bytes(string $string): int |
959 | 959 | { |
960 | 960 | return ConvertHelper_String::toBytes($string); |
961 | 961 | } |
962 | 962 | |
963 | - /** |
|
964 | - * Creates a short, 8-character long hash for the specified string. |
|
965 | - * |
|
966 | - * WARNING: Not cryptographically safe. |
|
967 | - * |
|
968 | - * @param string $string |
|
969 | - * @return string |
|
970 | - */ |
|
963 | + /** |
|
964 | + * Creates a short, 8-character long hash for the specified string. |
|
965 | + * |
|
966 | + * WARNING: Not cryptographically safe. |
|
967 | + * |
|
968 | + * @param string $string |
|
969 | + * @return string |
|
970 | + */ |
|
971 | 971 | public static function string2shortHash(string $string) : string |
972 | 972 | { |
973 | 973 | return ConvertHelper_String::toShortHash($string); |
@@ -1013,88 +1013,88 @@ discard block |
||
1013 | 1013 | return ConvertHelper_ThrowableInfo::fromThrowable($e); |
1014 | 1014 | } |
1015 | 1015 | |
1016 | - /** |
|
1017 | - * Parses the specified query string like the native |
|
1018 | - * function <code>parse_str</code>, without the key |
|
1019 | - * naming limitations. |
|
1020 | - * |
|
1021 | - * Using parse_str, dots or spaces in key names are |
|
1022 | - * replaced by underscores. This method keeps all names |
|
1023 | - * intact. |
|
1024 | - * |
|
1025 | - * It still uses the parse_str implementation as it |
|
1026 | - * is tested and tried, but fixes the parameter names |
|
1027 | - * after parsing, as needed. |
|
1028 | - * |
|
1029 | - * @param string $queryString |
|
1030 | - * @return array<string,string> |
|
1031 | - * @see ConvertHelper_QueryParser |
|
1032 | - */ |
|
1016 | + /** |
|
1017 | + * Parses the specified query string like the native |
|
1018 | + * function <code>parse_str</code>, without the key |
|
1019 | + * naming limitations. |
|
1020 | + * |
|
1021 | + * Using parse_str, dots or spaces in key names are |
|
1022 | + * replaced by underscores. This method keeps all names |
|
1023 | + * intact. |
|
1024 | + * |
|
1025 | + * It still uses the parse_str implementation as it |
|
1026 | + * is tested and tried, but fixes the parameter names |
|
1027 | + * after parsing, as needed. |
|
1028 | + * |
|
1029 | + * @param string $queryString |
|
1030 | + * @return array<string,string> |
|
1031 | + * @see ConvertHelper_QueryParser |
|
1032 | + */ |
|
1033 | 1033 | public static function parseQueryString(string $queryString) : array |
1034 | 1034 | { |
1035 | 1035 | $parser = new ConvertHelper_QueryParser(); |
1036 | 1036 | return $parser->parse($queryString); |
1037 | 1037 | } |
1038 | 1038 | |
1039 | - /** |
|
1040 | - * Searches for needle in the specified string, and returns a list |
|
1041 | - * of all occurrences, including the matched string. The matched |
|
1042 | - * string is useful when doing a case-insensitive search, as it |
|
1043 | - * shows the exact matched case of needle. |
|
1044 | - * |
|
1045 | - * @param string $needle |
|
1046 | - * @param string $haystack |
|
1047 | - * @param bool $caseInsensitive |
|
1048 | - * @return ConvertHelper_StringMatch[] |
|
1049 | - */ |
|
1039 | + /** |
|
1040 | + * Searches for needle in the specified string, and returns a list |
|
1041 | + * of all occurrences, including the matched string. The matched |
|
1042 | + * string is useful when doing a case-insensitive search, as it |
|
1043 | + * shows the exact matched case of needle. |
|
1044 | + * |
|
1045 | + * @param string $needle |
|
1046 | + * @param string $haystack |
|
1047 | + * @param bool $caseInsensitive |
|
1048 | + * @return ConvertHelper_StringMatch[] |
|
1049 | + */ |
|
1050 | 1050 | public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array |
1051 | 1051 | { |
1052 | 1052 | return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive); |
1053 | 1053 | } |
1054 | 1054 | |
1055 | - /** |
|
1056 | - * Like explode, but trims all entries, and removes |
|
1057 | - * empty entries from the resulting array. |
|
1058 | - * |
|
1059 | - * @param string $delimiter |
|
1060 | - * @param string $string |
|
1061 | - * @return string[] |
|
1062 | - */ |
|
1055 | + /** |
|
1056 | + * Like explode, but trims all entries, and removes |
|
1057 | + * empty entries from the resulting array. |
|
1058 | + * |
|
1059 | + * @param string $delimiter |
|
1060 | + * @param string $string |
|
1061 | + * @return string[] |
|
1062 | + */ |
|
1063 | 1063 | public static function explodeTrim(string $delimiter, string $string) : array |
1064 | 1064 | { |
1065 | 1065 | return ConvertHelper_String::explodeTrim($delimiter, $string); |
1066 | 1066 | } |
1067 | 1067 | |
1068 | - /** |
|
1069 | - * Detects the most used end-of-line character in the subject string. |
|
1070 | - * |
|
1071 | - * @param string $subjectString The string to check. |
|
1072 | - * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1073 | - */ |
|
1068 | + /** |
|
1069 | + * Detects the most used end-of-line character in the subject string. |
|
1070 | + * |
|
1071 | + * @param string $subjectString The string to check. |
|
1072 | + * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1073 | + */ |
|
1074 | 1074 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1075 | 1075 | { |
1076 | 1076 | return ConvertHelper_EOL::detect($subjectString); |
1077 | 1077 | } |
1078 | 1078 | |
1079 | - /** |
|
1080 | - * Removes the specified keys from the target array, |
|
1081 | - * if they exist. |
|
1082 | - * |
|
1083 | - * @param array<string|int,mixed> $array |
|
1084 | - * @param string[] $keys |
|
1085 | - */ |
|
1079 | + /** |
|
1080 | + * Removes the specified keys from the target array, |
|
1081 | + * if they exist. |
|
1082 | + * |
|
1083 | + * @param array<string|int,mixed> $array |
|
1084 | + * @param string[] $keys |
|
1085 | + */ |
|
1086 | 1086 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1087 | 1087 | { |
1088 | 1088 | ConvertHelper_Array::removeKeys($array, $keys); |
1089 | 1089 | } |
1090 | 1090 | |
1091 | - /** |
|
1092 | - * Checks if the specified variable is an integer or a string containing an integer. |
|
1093 | - * Accepts both positive and negative integers. |
|
1094 | - * |
|
1095 | - * @param mixed $value |
|
1096 | - * @return bool |
|
1097 | - */ |
|
1091 | + /** |
|
1092 | + * Checks if the specified variable is an integer or a string containing an integer. |
|
1093 | + * Accepts both positive and negative integers. |
|
1094 | + * |
|
1095 | + * @param mixed $value |
|
1096 | + * @return bool |
|
1097 | + */ |
|
1098 | 1098 | public static function isInteger($value) : bool |
1099 | 1099 | { |
1100 | 1100 | if(is_int($value)) { |
@@ -1114,52 +1114,52 @@ discard block |
||
1114 | 1114 | return false; |
1115 | 1115 | } |
1116 | 1116 | |
1117 | - /** |
|
1118 | - * Converts an amount of seconds to a DateInterval object. |
|
1119 | - * |
|
1120 | - * @param int $seconds |
|
1121 | - * @return DateInterval |
|
1122 | - * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1123 | - * |
|
1124 | - * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1125 | - */ |
|
1117 | + /** |
|
1118 | + * Converts an amount of seconds to a DateInterval object. |
|
1119 | + * |
|
1120 | + * @param int $seconds |
|
1121 | + * @return DateInterval |
|
1122 | + * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1123 | + * |
|
1124 | + * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1125 | + */ |
|
1126 | 1126 | public static function seconds2interval(int $seconds) : DateInterval |
1127 | 1127 | { |
1128 | 1128 | return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval(); |
1129 | 1129 | } |
1130 | 1130 | |
1131 | - /** |
|
1132 | - * Converts a size string like "50 MB" to the corresponding byte size. |
|
1133 | - * It is case-insensitive, ignores spaces, and supports both traditional |
|
1134 | - * "MB" and "MiB" notations. |
|
1135 | - * |
|
1136 | - * @param string $size |
|
1137 | - * @return int |
|
1138 | - */ |
|
1131 | + /** |
|
1132 | + * Converts a size string like "50 MB" to the corresponding byte size. |
|
1133 | + * It is case-insensitive, ignores spaces, and supports both traditional |
|
1134 | + * "MB" and "MiB" notations. |
|
1135 | + * |
|
1136 | + * @param string $size |
|
1137 | + * @return int |
|
1138 | + */ |
|
1139 | 1139 | public static function size2bytes(string $size) : int |
1140 | 1140 | { |
1141 | 1141 | return self::parseSize($size)->toBytes(); |
1142 | 1142 | } |
1143 | 1143 | |
1144 | - /** |
|
1145 | - * Parses a size string like "50 MB" and returns a size notation instance |
|
1146 | - * that has utility methods to access information on it, and convert it. |
|
1147 | - * |
|
1148 | - * @param string $size |
|
1149 | - * @return ConvertHelper_SizeNotation |
|
1150 | - */ |
|
1144 | + /** |
|
1145 | + * Parses a size string like "50 MB" and returns a size notation instance |
|
1146 | + * that has utility methods to access information on it, and convert it. |
|
1147 | + * |
|
1148 | + * @param string $size |
|
1149 | + * @return ConvertHelper_SizeNotation |
|
1150 | + */ |
|
1151 | 1151 | public static function parseSize(string $size) : ConvertHelper_SizeNotation |
1152 | 1152 | { |
1153 | 1153 | return new ConvertHelper_SizeNotation($size); |
1154 | 1154 | } |
1155 | 1155 | |
1156 | - /** |
|
1157 | - * Creates a URL finder instance, which can be used to find |
|
1158 | - * URLs in a string - be it plain text, or HTML. |
|
1159 | - * |
|
1160 | - * @param string $subject |
|
1161 | - * @return ConvertHelper_URLFinder |
|
1162 | - */ |
|
1156 | + /** |
|
1157 | + * Creates a URL finder instance, which can be used to find |
|
1158 | + * URLs in a string - be it plain text, or HTML. |
|
1159 | + * |
|
1160 | + * @param string $subject |
|
1161 | + * @return ConvertHelper_URLFinder |
|
1162 | + */ |
|
1163 | 1163 | public static function createURLFinder(string $subject) : ConvertHelper_URLFinder |
1164 | 1164 | { |
1165 | 1165 | return new ConvertHelper_URLFinder($subject); |
@@ -55,7 +55,7 @@ discard block |
||
55 | 55 | * @param int $tabSize The amount of spaces per tab. |
56 | 56 | * @return string |
57 | 57 | */ |
58 | - public static function tabs2spaces(string $string, int $tabSize=4) : string |
|
58 | + public static function tabs2spaces(string $string, int $tabSize = 4) : string |
|
59 | 59 | { |
60 | 60 | return ConvertHelper_String::tabs2spaces($string, $tabSize); |
61 | 61 | } |
@@ -67,7 +67,7 @@ discard block |
||
67 | 67 | * @param int $tabSize The amount of spaces per tab in the source string. |
68 | 68 | * @return string |
69 | 69 | */ |
70 | - public static function spaces2tabs(string $string, int $tabSize=4) : string |
|
70 | + public static function spaces2tabs(string $string, int $tabSize = 4) : string |
|
71 | 71 | { |
72 | 72 | return ConvertHelper_String::spaces2tabs($string, $tabSize); |
73 | 73 | } |
@@ -140,7 +140,7 @@ discard block |
||
140 | 140 | * @deprecated Use the Highlighter class directly instead. |
141 | 141 | * @see Highlighter::xml() |
142 | 142 | */ |
143 | - public static function highlight_xml(string $xml, bool $formatSource=false) : string |
|
143 | + public static function highlight_xml(string $xml, bool $formatSource = false) : string |
|
144 | 144 | { |
145 | 145 | return Highlighter::xml($xml, $formatSource); |
146 | 146 | } |
@@ -206,11 +206,11 @@ discard block |
||
206 | 206 | * @param bool $html |
207 | 207 | * @return string |
208 | 208 | */ |
209 | - public static function var_dump($var, bool $html=true) : string |
|
209 | + public static function var_dump($var, bool $html = true) : string |
|
210 | 210 | { |
211 | 211 | $info = parseVariable($var); |
212 | 212 | |
213 | - if($html) { |
|
213 | + if ($html) { |
|
214 | 214 | return $info->toHTML(); |
215 | 215 | } |
216 | 216 | |
@@ -225,11 +225,11 @@ discard block |
||
225 | 225 | * @param bool $html Whether to style the dump as HTML. |
226 | 226 | * @return string |
227 | 227 | */ |
228 | - public static function print_r($var, bool $return=false, bool $html=true) : string |
|
228 | + public static function print_r($var, bool $return = false, bool $html = true) : string |
|
229 | 229 | { |
230 | 230 | $result = parseVariable($var)->enableType()->toString(); |
231 | 231 | |
232 | - if($html) |
|
232 | + if ($html) |
|
233 | 233 | { |
234 | 234 | $result = |
235 | 235 | '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'. |
@@ -237,7 +237,7 @@ discard block |
||
237 | 237 | '</pre>'; |
238 | 238 | } |
239 | 239 | |
240 | - if(!$return) |
|
240 | + if (!$return) |
|
241 | 241 | { |
242 | 242 | echo $result; |
243 | 243 | } |
@@ -419,12 +419,12 @@ discard block |
||
419 | 419 | $output = ''; |
420 | 420 | $split = str_split($unicodeChar); |
421 | 421 | |
422 | - foreach($split as $octet) |
|
422 | + foreach ($split as $octet) |
|
423 | 423 | { |
424 | 424 | $ordInt = ord($octet); |
425 | 425 | // Convert from int (base 10) to hex (base 16), for PHP \x syntax |
426 | 426 | $ordHex = base_convert((string)$ordInt, 10, 16); |
427 | - $output .= '\x' . $ordHex; |
|
427 | + $output .= '\x'.$ordHex; |
|
428 | 428 | } |
429 | 429 | |
430 | 430 | return $output; |
@@ -638,7 +638,7 @@ discard block |
||
638 | 638 | * |
639 | 639 | * @see JSHelper::buildRegexStatement() |
640 | 640 | */ |
641 | - public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) : string |
|
641 | + public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) : string |
|
642 | 642 | { |
643 | 643 | return JSHelper::buildRegexStatement($regex, $statementType); |
644 | 644 | } |
@@ -657,11 +657,11 @@ discard block |
||
657 | 657 | * @throws ConvertHelper_Exception |
658 | 658 | * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED |
659 | 659 | */ |
660 | - public static function var2json($variable, int $options=0, int $depth=512) : string |
|
660 | + public static function var2json($variable, int $options = 0, int $depth = 512) : string |
|
661 | 661 | { |
662 | 662 | $result = json_encode($variable, $options, $depth); |
663 | 663 | |
664 | - if($result !== false) { |
|
664 | + if ($result !== false) { |
|
665 | 665 | return $result; |
666 | 666 | } |
667 | 667 | |
@@ -701,12 +701,12 @@ discard block |
||
701 | 701 | { |
702 | 702 | $boms = FileHelper::createUnicodeHandling()->getUTFBOMs(); |
703 | 703 | |
704 | - foreach($boms as $bomChars) |
|
704 | + foreach ($boms as $bomChars) |
|
705 | 705 | { |
706 | 706 | $length = mb_strlen($bomChars); |
707 | 707 | $text = mb_substr($string, 0, $length); |
708 | 708 | |
709 | - if($text===$bomChars) |
|
709 | + if ($text === $bomChars) |
|
710 | 710 | { |
711 | 711 | return mb_substr($string, $length); |
712 | 712 | } |
@@ -778,7 +778,7 @@ discard block |
||
778 | 778 | * @see ConvertHelper_TextComparer::OPTION_MAX_LEVENSHTEIN_DISTANCE |
779 | 779 | * @see ConvertHelper_TextComparer::OPTION_PRECISION |
780 | 780 | */ |
781 | - public static function matchString(string $source, string $target, array $options=array()) : float |
|
781 | + public static function matchString(string $source, string $target, array $options = array()) : float |
|
782 | 782 | { |
783 | 783 | return (new ConvertHelper_TextComparer()) |
784 | 784 | ->setOptions($options) |
@@ -856,7 +856,7 @@ discard block |
||
856 | 856 | * @see ConvertHelper::INTERVAL_HOURS |
857 | 857 | * @see ConvertHelper::INTERVAL_DAYS |
858 | 858 | */ |
859 | - public static function interval2total(DateInterval $interval, string $unit=self::INTERVAL_SECONDS) : int |
|
859 | + public static function interval2total(DateInterval $interval, string $unit = self::INTERVAL_SECONDS) : int |
|
860 | 860 | { |
861 | 861 | return ConvertHelper_DateInterval::toTotal($interval, $unit); |
862 | 862 | } |
@@ -868,7 +868,7 @@ discard block |
||
868 | 868 | * @param bool $short |
869 | 869 | * @return string|NULL |
870 | 870 | */ |
871 | - public static function date2dayName(DateTime $date, bool $short=false) : ?string |
|
871 | + public static function date2dayName(DateTime $date, bool $short = false) : ?string |
|
872 | 872 | { |
873 | 873 | return ConvertHelper_Date::toDayName($date, $short); |
874 | 874 | } |
@@ -888,7 +888,7 @@ discard block |
||
888 | 888 | * @param bool $short |
889 | 889 | * @return string[] |
890 | 890 | */ |
891 | - public static function getDayNames(bool $short=false) : array |
|
891 | + public static function getDayNames(bool $short = false) : array |
|
892 | 892 | { |
893 | 893 | return ConvertHelper_Date::getDayNames($short); |
894 | 894 | } |
@@ -1047,7 +1047,7 @@ discard block |
||
1047 | 1047 | * @param bool $caseInsensitive |
1048 | 1048 | * @return ConvertHelper_StringMatch[] |
1049 | 1049 | */ |
1050 | - public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array |
|
1050 | + public static function findString(string $needle, string $haystack, bool $caseInsensitive = false): array |
|
1051 | 1051 | { |
1052 | 1052 | return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive); |
1053 | 1053 | } |
@@ -1097,17 +1097,17 @@ discard block |
||
1097 | 1097 | */ |
1098 | 1098 | public static function isInteger($value) : bool |
1099 | 1099 | { |
1100 | - if(is_int($value)) { |
|
1100 | + if (is_int($value)) { |
|
1101 | 1101 | return true; |
1102 | 1102 | } |
1103 | 1103 | |
1104 | 1104 | // booleans get converted to numbers, so they would |
1105 | 1105 | // actually match the regex. |
1106 | - if(is_bool($value)) { |
|
1106 | + if (is_bool($value)) { |
|
1107 | 1107 | return false; |
1108 | 1108 | } |
1109 | 1109 | |
1110 | - if(is_string($value) && $value !== '') { |
|
1110 | + if (is_string($value) && $value !== '') { |
|
1111 | 1111 | return preg_match('/\A-?\d+\z/', $value) === 1; |
1112 | 1112 | } |
1113 | 1113 | |
@@ -1173,7 +1173,7 @@ discard block |
||
1173 | 1173 | * @param bool $keepKeys |
1174 | 1174 | * @return array<number|string,mixed> |
1175 | 1175 | */ |
1176 | - public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys=false) : array |
|
1176 | + public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys = false) : array |
|
1177 | 1177 | { |
1178 | 1178 | return ConvertHelper_Array::removeValues($sourceArray, $values, $keepKeys); |
1179 | 1179 | } |