@@ -41,71 +41,71 @@ discard block |
||
41 | 41 | */ |
42 | 42 | class Highlighter |
43 | 43 | { |
44 | - /** |
|
45 | - * Creates a new GeSHi instance from a source code string. |
|
46 | - * |
|
47 | - * @param string $sourceCode |
|
48 | - * @param string $format |
|
49 | - * @return GeSHi |
|
50 | - */ |
|
44 | + /** |
|
45 | + * Creates a new GeSHi instance from a source code string. |
|
46 | + * |
|
47 | + * @param string $sourceCode |
|
48 | + * @param string $format |
|
49 | + * @return GeSHi |
|
50 | + */ |
|
51 | 51 | public static function fromString(string $sourceCode, string $format) : GeSHi |
52 | 52 | { |
53 | 53 | return new GeSHi($sourceCode, $format); |
54 | 54 | } |
55 | 55 | |
56 | - /** |
|
57 | - * Creates a new GeSHi instance from the contents of a file. |
|
58 | - * |
|
59 | - * @param string $path |
|
60 | - * @param string $format |
|
61 | - * @return GeSHi |
|
62 | - */ |
|
56 | + /** |
|
57 | + * Creates a new GeSHi instance from the contents of a file. |
|
58 | + * |
|
59 | + * @param string $path |
|
60 | + * @param string $format |
|
61 | + * @return GeSHi |
|
62 | + */ |
|
63 | 63 | public static function fromFile(string $path, string $format) : GeSHi |
64 | 64 | { |
65 | 65 | return self::fromString(FileHelper::readContents($path), $format); |
66 | 66 | } |
67 | 67 | |
68 | - /** |
|
69 | - * Parses and highlights the target string. |
|
70 | - * |
|
71 | - * @param string $sourceCode |
|
72 | - * @param string $format |
|
73 | - * @return string |
|
74 | - */ |
|
68 | + /** |
|
69 | + * Parses and highlights the target string. |
|
70 | + * |
|
71 | + * @param string $sourceCode |
|
72 | + * @param string $format |
|
73 | + * @return string |
|
74 | + */ |
|
75 | 75 | public static function parseString(string $sourceCode, string $format) : string |
76 | 76 | { |
77 | 77 | return self::fromString($sourceCode, $format)->parse_code(); |
78 | 78 | } |
79 | 79 | |
80 | - /** |
|
81 | - * Parses and highlights the contents of the target file. |
|
82 | - * |
|
83 | - * @param string $path |
|
84 | - * @param string $format |
|
85 | - * @return string |
|
86 | - */ |
|
80 | + /** |
|
81 | + * Parses and highlights the contents of the target file. |
|
82 | + * |
|
83 | + * @param string $path |
|
84 | + * @param string $format |
|
85 | + * @return string |
|
86 | + */ |
|
87 | 87 | public static function parseFile(string $path, string $format) : string |
88 | 88 | { |
89 | 89 | return self::fromFile($path, $format)->parse_code(); |
90 | 90 | } |
91 | 91 | |
92 | - /** |
|
93 | - * Adds HTML syntax highlighting to the specified SQL string. |
|
94 | - * |
|
95 | - * @param string $sql |
|
96 | - * @return string |
|
97 | - */ |
|
92 | + /** |
|
93 | + * Adds HTML syntax highlighting to the specified SQL string. |
|
94 | + * |
|
95 | + * @param string $sql |
|
96 | + * @return string |
|
97 | + */ |
|
98 | 98 | public static function sql(string $sql) : string |
99 | 99 | { |
100 | 100 | return self::parseString($sql, 'sql'); |
101 | 101 | } |
102 | 102 | |
103 | - /** |
|
104 | - * Adds HTML syntax highlighting to a JSON string, or a data array/object. |
|
105 | - * |
|
106 | - * @param array|object|string $subject A JSON string, or data array/object to convert to JSON to highlight. |
|
107 | - * @return string |
|
108 | - */ |
|
103 | + /** |
|
104 | + * Adds HTML syntax highlighting to a JSON string, or a data array/object. |
|
105 | + * |
|
106 | + * @param array|object|string $subject A JSON string, or data array/object to convert to JSON to highlight. |
|
107 | + * @return string |
|
108 | + */ |
|
109 | 109 | public static function json($subject) : string |
110 | 110 | { |
111 | 111 | if(!is_string($subject)) |
@@ -118,13 +118,13 @@ discard block |
||
118 | 118 | return self::parseString($subject, 'javascript'); |
119 | 119 | } |
120 | 120 | |
121 | - /** |
|
122 | - * Adds HTML syntax highlighting to the specified XML code. |
|
123 | - * |
|
124 | - * @param string $xml The XML to highlight. |
|
125 | - * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
126 | - * @return string |
|
127 | - */ |
|
121 | + /** |
|
122 | + * Adds HTML syntax highlighting to the specified XML code. |
|
123 | + * |
|
124 | + * @param string $xml The XML to highlight. |
|
125 | + * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
126 | + * @return string |
|
127 | + */ |
|
128 | 128 | public static function xml(string $xml, bool $formatSource=false) : string |
129 | 129 | { |
130 | 130 | if($formatSource) |
@@ -141,13 +141,13 @@ discard block |
||
141 | 141 | return self::parseString($xml, 'xml'); |
142 | 142 | } |
143 | 143 | |
144 | - /** |
|
145 | - * Adds HTML syntax highlighting to the specified HTML code. |
|
146 | - * |
|
147 | - * @param string $html |
|
148 | - * @param bool $formatSource |
|
149 | - * @return string |
|
150 | - */ |
|
144 | + /** |
|
145 | + * Adds HTML syntax highlighting to the specified HTML code. |
|
146 | + * |
|
147 | + * @param string $html |
|
148 | + * @param bool $formatSource |
|
149 | + * @return string |
|
150 | + */ |
|
151 | 151 | public static function html(string $html, bool $formatSource=false) : string |
152 | 152 | { |
153 | 153 | if($formatSource) |
@@ -164,27 +164,27 @@ discard block |
||
164 | 164 | return self::parseString($html, 'xml'); |
165 | 165 | } |
166 | 166 | |
167 | - /** |
|
168 | - * Adds HTML syntax highlighting to a bit of PHP code. |
|
169 | - * |
|
170 | - * @param string $phpCode |
|
171 | - * @return string |
|
172 | - */ |
|
167 | + /** |
|
168 | + * Adds HTML syntax highlighting to a bit of PHP code. |
|
169 | + * |
|
170 | + * @param string $phpCode |
|
171 | + * @return string |
|
172 | + */ |
|
173 | 173 | public static function php(string $phpCode) : string |
174 | 174 | { |
175 | 175 | return self::parseString($phpCode, 'php'); |
176 | 176 | } |
177 | 177 | |
178 | - /** |
|
179 | - * Adds HTML syntax highlighting to an URL. |
|
180 | - * |
|
181 | - * NOTE: Includes the necessary CSS styles. When |
|
182 | - * highlighting several URLs in the same page, |
|
183 | - * prefer using the `parseURL` function instead. |
|
184 | - * |
|
185 | - * @param string $url |
|
186 | - * @return string |
|
187 | - */ |
|
178 | + /** |
|
179 | + * Adds HTML syntax highlighting to an URL. |
|
180 | + * |
|
181 | + * NOTE: Includes the necessary CSS styles. When |
|
182 | + * highlighting several URLs in the same page, |
|
183 | + * prefer using the `parseURL` function instead. |
|
184 | + * |
|
185 | + * @param string $url |
|
186 | + * @return string |
|
187 | + */ |
|
188 | 188 | public static function url(string $url) : string |
189 | 189 | { |
190 | 190 | $info = parseURL($url); |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | */ |
109 | 109 | public static function json($subject) : string |
110 | 110 | { |
111 | - if(!is_string($subject)) |
|
111 | + if (!is_string($subject)) |
|
112 | 112 | { |
113 | 113 | $subject = json_encode($subject, JSON_PRETTY_PRINT); |
114 | 114 | } |
@@ -125,9 +125,9 @@ discard block |
||
125 | 125 | * @param bool $formatSource Whether to format the source with indentation to make it readable. |
126 | 126 | * @return string |
127 | 127 | */ |
128 | - public static function xml(string $xml, bool $formatSource=false) : string |
|
128 | + public static function xml(string $xml, bool $formatSource = false) : string |
|
129 | 129 | { |
130 | - if($formatSource) |
|
130 | + if ($formatSource) |
|
131 | 131 | { |
132 | 132 | $dom = new DOMDocument(); |
133 | 133 | $dom->preserveWhiteSpace = false; |
@@ -148,9 +148,9 @@ discard block |
||
148 | 148 | * @param bool $formatSource |
149 | 149 | * @return string |
150 | 150 | */ |
151 | - public static function html(string $html, bool $formatSource=false) : string |
|
151 | + public static function html(string $html, bool $formatSource = false) : string |
|
152 | 152 | { |
153 | - if($formatSource) |
|
153 | + if ($formatSource) |
|
154 | 154 | { |
155 | 155 | $dom = new DOMDocument(); |
156 | 156 | $dom->preserveWhiteSpace = false; |
@@ -55,13 +55,13 @@ discard block |
||
55 | 55 | return str_replace("\t", str_repeat(' ', $tabSize), $string); |
56 | 56 | } |
57 | 57 | |
58 | - /** |
|
59 | - * Converts spaces to tabs in the specified string. |
|
60 | - * |
|
61 | - * @param string $string |
|
62 | - * @param int $tabSize The amount of spaces per tab in the source string. |
|
63 | - * @return string |
|
64 | - */ |
|
58 | + /** |
|
59 | + * Converts spaces to tabs in the specified string. |
|
60 | + * |
|
61 | + * @param string $string |
|
62 | + * @param int $tabSize The amount of spaces per tab in the source string. |
|
63 | + * @return string |
|
64 | + */ |
|
65 | 65 | public static function spaces2tabs(string $string, int $tabSize=4) : string |
66 | 66 | { |
67 | 67 | return str_replace(str_repeat(' ', $tabSize), "\t", $string); |
@@ -74,14 +74,14 @@ discard block |
||
74 | 74 | return $converter->convert($string); |
75 | 75 | } |
76 | 76 | |
77 | - /** |
|
78 | - * Converts the specified amount of seconds into |
|
79 | - * a human readable string split in months, weeks, |
|
80 | - * days, hours, minutes and seconds. |
|
81 | - * |
|
82 | - * @param float $seconds |
|
83 | - * @return string |
|
84 | - */ |
|
77 | + /** |
|
78 | + * Converts the specified amount of seconds into |
|
79 | + * a human readable string split in months, weeks, |
|
80 | + * days, hours, minutes and seconds. |
|
81 | + * |
|
82 | + * @param float $seconds |
|
83 | + * @return string |
|
84 | + */ |
|
85 | 85 | public static function time2string($seconds) |
86 | 86 | { |
87 | 87 | static $units = null; |
@@ -153,119 +153,119 @@ discard block |
||
153 | 153 | return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
154 | 154 | } |
155 | 155 | |
156 | - /** |
|
157 | - * Converts a timestamp into an easily understandable |
|
158 | - * format, e.g. "2 hours", "1 day", "3 months" |
|
159 | - * |
|
160 | - * If you set the date to parameter, the difference |
|
161 | - * will be calculated between the two dates and not |
|
162 | - * the current time. |
|
163 | - * |
|
164 | - * @param integer|\DateTime $datefrom |
|
165 | - * @param integer|\DateTime $dateto |
|
166 | - * @return string |
|
167 | - */ |
|
156 | + /** |
|
157 | + * Converts a timestamp into an easily understandable |
|
158 | + * format, e.g. "2 hours", "1 day", "3 months" |
|
159 | + * |
|
160 | + * If you set the date to parameter, the difference |
|
161 | + * will be calculated between the two dates and not |
|
162 | + * the current time. |
|
163 | + * |
|
164 | + * @param integer|\DateTime $datefrom |
|
165 | + * @param integer|\DateTime $dateto |
|
166 | + * @return string |
|
167 | + */ |
|
168 | 168 | public static function duration2string($datefrom, $dateto = -1) : string |
169 | 169 | { |
170 | - $converter = new ConvertHelper_DurationConverter(); |
|
170 | + $converter = new ConvertHelper_DurationConverter(); |
|
171 | 171 | |
172 | - if($datefrom instanceof \DateTime) |
|
173 | - { |
|
174 | - $converter->setDateFrom($datefrom); |
|
175 | - } |
|
176 | - else |
|
177 | - { |
|
178 | - $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
179 | - } |
|
172 | + if($datefrom instanceof \DateTime) |
|
173 | + { |
|
174 | + $converter->setDateFrom($datefrom); |
|
175 | + } |
|
176 | + else |
|
177 | + { |
|
178 | + $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
179 | + } |
|
180 | 180 | |
181 | - if($dateto instanceof \DateTime) |
|
182 | - { |
|
183 | - $converter->setDateTo($dateto); |
|
184 | - } |
|
185 | - else if($dateto > 0) |
|
186 | - { |
|
187 | - $converter->setDateTo(self::timestamp2date($dateto)); |
|
188 | - } |
|
181 | + if($dateto instanceof \DateTime) |
|
182 | + { |
|
183 | + $converter->setDateTo($dateto); |
|
184 | + } |
|
185 | + else if($dateto > 0) |
|
186 | + { |
|
187 | + $converter->setDateTo(self::timestamp2date($dateto)); |
|
188 | + } |
|
189 | 189 | |
190 | - return $converter->convert(); |
|
190 | + return $converter->convert(); |
|
191 | 191 | } |
192 | 192 | |
193 | - /** |
|
194 | - * Adds HTML syntax highlighting to the specified SQL string. |
|
195 | - * |
|
196 | - * @param string $sql |
|
197 | - * @return string |
|
198 | - * @deprecated Use the Highlighter class directly instead. |
|
199 | - * @see Highlighter::sql() |
|
200 | - */ |
|
193 | + /** |
|
194 | + * Adds HTML syntax highlighting to the specified SQL string. |
|
195 | + * |
|
196 | + * @param string $sql |
|
197 | + * @return string |
|
198 | + * @deprecated Use the Highlighter class directly instead. |
|
199 | + * @see Highlighter::sql() |
|
200 | + */ |
|
201 | 201 | public static function highlight_sql(string $sql) : string |
202 | 202 | { |
203 | 203 | return Highlighter::sql($sql); |
204 | 204 | } |
205 | 205 | |
206 | - /** |
|
207 | - * Adds HTML syntax highlighting to the specified XML code. |
|
208 | - * |
|
209 | - * @param string $xml The XML to highlight. |
|
210 | - * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
211 | - * @return string |
|
212 | - * @deprecated Use the Highlighter class directly instead. |
|
213 | - * @see Highlighter::xml() |
|
214 | - */ |
|
206 | + /** |
|
207 | + * Adds HTML syntax highlighting to the specified XML code. |
|
208 | + * |
|
209 | + * @param string $xml The XML to highlight. |
|
210 | + * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
211 | + * @return string |
|
212 | + * @deprecated Use the Highlighter class directly instead. |
|
213 | + * @see Highlighter::xml() |
|
214 | + */ |
|
215 | 215 | public static function highlight_xml(string $xml, bool $formatSource=false) : string |
216 | 216 | { |
217 | 217 | return Highlighter::xml($xml, $formatSource); |
218 | 218 | } |
219 | 219 | |
220 | - /** |
|
221 | - * @param string $phpCode |
|
222 | - * @return string |
|
223 | - * @deprecated Use the Highlighter class directly instead. |
|
224 | - * @see Highlighter::php() |
|
225 | - */ |
|
220 | + /** |
|
221 | + * @param string $phpCode |
|
222 | + * @return string |
|
223 | + * @deprecated Use the Highlighter class directly instead. |
|
224 | + * @see Highlighter::php() |
|
225 | + */ |
|
226 | 226 | public static function highlight_php(string $phpCode) : string |
227 | 227 | { |
228 | 228 | return Highlighter::php($phpCode); |
229 | 229 | } |
230 | 230 | |
231 | - /** |
|
232 | - * Converts a number of bytes to a human readable form, |
|
233 | - * e.g. xx Kb / xx Mb / xx Gb |
|
234 | - * |
|
235 | - * @param int $bytes The amount of bytes to convert. |
|
236 | - * @param int $precision The amount of decimals |
|
237 | - * @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). |
|
238 | - * @return string |
|
239 | - * |
|
240 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
241 | - */ |
|
231 | + /** |
|
232 | + * Converts a number of bytes to a human readable form, |
|
233 | + * e.g. xx Kb / xx Mb / xx Gb |
|
234 | + * |
|
235 | + * @param int $bytes The amount of bytes to convert. |
|
236 | + * @param int $precision The amount of decimals |
|
237 | + * @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). |
|
238 | + * @return string |
|
239 | + * |
|
240 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
241 | + */ |
|
242 | 242 | public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string |
243 | 243 | { |
244 | 244 | return self::parseBytes($bytes)->toString($precision, $base); |
245 | 245 | } |
246 | 246 | |
247 | - /** |
|
248 | - * Parses a number of bytes, and creates a converter instance which |
|
249 | - * allows doing common operations with it. |
|
250 | - * |
|
251 | - * @param int $bytes |
|
252 | - * @return ConvertHelper_ByteConverter |
|
253 | - */ |
|
247 | + /** |
|
248 | + * Parses a number of bytes, and creates a converter instance which |
|
249 | + * allows doing common operations with it. |
|
250 | + * |
|
251 | + * @param int $bytes |
|
252 | + * @return ConvertHelper_ByteConverter |
|
253 | + */ |
|
254 | 254 | public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter |
255 | 255 | { |
256 | 256 | return new ConvertHelper_ByteConverter($bytes); |
257 | 257 | } |
258 | 258 | |
259 | - /** |
|
260 | - * Cuts a text to the specified length if it is longer than the |
|
261 | - * target length. Appends a text to signify it has been cut at |
|
262 | - * the end of the string. |
|
263 | - * |
|
264 | - * @param string $text |
|
265 | - * @param int $targetLength |
|
266 | - * @param string $append |
|
267 | - * @return string |
|
268 | - */ |
|
259 | + /** |
|
260 | + * Cuts a text to the specified length if it is longer than the |
|
261 | + * target length. Appends a text to signify it has been cut at |
|
262 | + * the end of the string. |
|
263 | + * |
|
264 | + * @param string $text |
|
265 | + * @param int $targetLength |
|
266 | + * @param string $append |
|
267 | + * @return string |
|
268 | + */ |
|
269 | 269 | public static function text_cut(string $text, int $targetLength, string $append = '...') : string |
270 | 270 | { |
271 | 271 | $length = mb_strlen($text); |
@@ -289,14 +289,14 @@ discard block |
||
289 | 289 | return $info->toString(); |
290 | 290 | } |
291 | 291 | |
292 | - /** |
|
293 | - * Pretty print_r. |
|
294 | - * |
|
295 | - * @param mixed $var The variable to dump. |
|
296 | - * @param bool $return Whether to return the dumped code. |
|
297 | - * @param bool $html Whether to style the dump as HTML. |
|
298 | - * @return string |
|
299 | - */ |
|
292 | + /** |
|
293 | + * Pretty print_r. |
|
294 | + * |
|
295 | + * @param mixed $var The variable to dump. |
|
296 | + * @param bool $return Whether to return the dumped code. |
|
297 | + * @param bool $html Whether to style the dump as HTML. |
|
298 | + * @return string |
|
299 | + */ |
|
300 | 300 | public static function print_r($var, bool $return=false, bool $html=true) : string |
301 | 301 | { |
302 | 302 | $result = parseVariable($var)->enableType()->toString(); |
@@ -326,15 +326,15 @@ discard block |
||
326 | 326 | 'no' => false |
327 | 327 | ); |
328 | 328 | |
329 | - /** |
|
330 | - * Converts a string, number or boolean value to a boolean value. |
|
331 | - * |
|
332 | - * @param mixed $string |
|
333 | - * @throws ConvertHelper_Exception |
|
334 | - * @return bool |
|
335 | - * |
|
336 | - * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
337 | - */ |
|
329 | + /** |
|
330 | + * Converts a string, number or boolean value to a boolean value. |
|
331 | + * |
|
332 | + * @param mixed $string |
|
333 | + * @throws ConvertHelper_Exception |
|
334 | + * @return bool |
|
335 | + * |
|
336 | + * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
337 | + */ |
|
338 | 338 | public static function string2bool($string) : bool |
339 | 339 | { |
340 | 340 | if($string === '' || $string === null || !is_scalar($string)) |
@@ -362,27 +362,27 @@ discard block |
||
362 | 362 | ); |
363 | 363 | } |
364 | 364 | |
365 | - /** |
|
366 | - * Whether the specified string is a boolean string or boolean value. |
|
367 | - * Alias for {@link ConvertHelper::isBoolean()}. |
|
368 | - * |
|
369 | - * @param mixed $string |
|
370 | - * @return bool |
|
371 | - * @deprecated |
|
372 | - * @see ConvertHelper::isBoolean() |
|
373 | - */ |
|
365 | + /** |
|
366 | + * Whether the specified string is a boolean string or boolean value. |
|
367 | + * Alias for {@link ConvertHelper::isBoolean()}. |
|
368 | + * |
|
369 | + * @param mixed $string |
|
370 | + * @return bool |
|
371 | + * @deprecated |
|
372 | + * @see ConvertHelper::isBoolean() |
|
373 | + */ |
|
374 | 374 | public static function isBooleanString($string) : bool |
375 | 375 | { |
376 | 376 | return self::isBoolean($string); |
377 | 377 | } |
378 | 378 | |
379 | - /** |
|
380 | - * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
381 | - * |
|
382 | - * @param string $text |
|
383 | - * @return string |
|
384 | - * @deprecated |
|
385 | - */ |
|
379 | + /** |
|
380 | + * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
381 | + * |
|
382 | + * @param string $text |
|
383 | + * @return string |
|
384 | + * @deprecated |
|
385 | + */ |
|
386 | 386 | public static function text_makeXMLCompliant($text) |
387 | 387 | { |
388 | 388 | return XMLHelper::string2xml($text); |
@@ -484,80 +484,80 @@ discard block |
||
484 | 484 | return $translit->convert($string); |
485 | 485 | } |
486 | 486 | |
487 | - /** |
|
488 | - * Retrieves the HEX character codes for all control |
|
489 | - * characters that the {@link stripControlCharacters()} |
|
490 | - * method will remove. |
|
491 | - * |
|
492 | - * @return string[] |
|
493 | - */ |
|
487 | + /** |
|
488 | + * Retrieves the HEX character codes for all control |
|
489 | + * characters that the {@link stripControlCharacters()} |
|
490 | + * method will remove. |
|
491 | + * |
|
492 | + * @return string[] |
|
493 | + */ |
|
494 | 494 | public static function getControlCharactersAsHex() |
495 | 495 | { |
496 | 496 | return self::createControlCharacters()->getCharsAsHex(); |
497 | 497 | } |
498 | 498 | |
499 | - /** |
|
500 | - * Retrieves an array of all control characters that |
|
501 | - * the {@link stripControlCharacters()} method will |
|
502 | - * remove, as the actual UTF-8 characters. |
|
503 | - * |
|
504 | - * @return string[] |
|
505 | - */ |
|
499 | + /** |
|
500 | + * Retrieves an array of all control characters that |
|
501 | + * the {@link stripControlCharacters()} method will |
|
502 | + * remove, as the actual UTF-8 characters. |
|
503 | + * |
|
504 | + * @return string[] |
|
505 | + */ |
|
506 | 506 | public static function getControlCharactersAsUTF8() |
507 | 507 | { |
508 | 508 | return self::createControlCharacters()->getCharsAsUTF8(); |
509 | 509 | } |
510 | 510 | |
511 | - /** |
|
512 | - * Retrieves all control characters as JSON encoded |
|
513 | - * characters, e.g. "\u200b". |
|
514 | - * |
|
515 | - * @return string[] |
|
516 | - */ |
|
511 | + /** |
|
512 | + * Retrieves all control characters as JSON encoded |
|
513 | + * characters, e.g. "\u200b". |
|
514 | + * |
|
515 | + * @return string[] |
|
516 | + */ |
|
517 | 517 | public static function getControlCharactersAsJSON() |
518 | 518 | { |
519 | 519 | return self::createControlCharacters()->getCharsAsJSON(); |
520 | 520 | } |
521 | 521 | |
522 | - /** |
|
523 | - * Removes all control characters from the specified string |
|
524 | - * that can cause problems in some cases, like creating |
|
525 | - * valid XML documents. This includes invisible non-breaking |
|
526 | - * spaces. |
|
527 | - * |
|
528 | - * @param string $string |
|
529 | - * @return string |
|
530 | - */ |
|
522 | + /** |
|
523 | + * Removes all control characters from the specified string |
|
524 | + * that can cause problems in some cases, like creating |
|
525 | + * valid XML documents. This includes invisible non-breaking |
|
526 | + * spaces. |
|
527 | + * |
|
528 | + * @param string $string |
|
529 | + * @return string |
|
530 | + */ |
|
531 | 531 | public static function stripControlCharacters(string $string) : string |
532 | 532 | { |
533 | 533 | return self::createControlCharacters()->stripControlCharacters($string); |
534 | 534 | } |
535 | 535 | |
536 | - /** |
|
537 | - * Creates the control characters class, used to |
|
538 | - * work with control characters in strings. |
|
539 | - * |
|
540 | - * @return ConvertHelper_ControlCharacters |
|
541 | - */ |
|
536 | + /** |
|
537 | + * Creates the control characters class, used to |
|
538 | + * work with control characters in strings. |
|
539 | + * |
|
540 | + * @return ConvertHelper_ControlCharacters |
|
541 | + */ |
|
542 | 542 | public static function createControlCharacters() : ConvertHelper_ControlCharacters |
543 | 543 | { |
544 | 544 | return new ConvertHelper_ControlCharacters(); |
545 | 545 | } |
546 | 546 | |
547 | - /** |
|
548 | - * Converts a unicode character to the PHPO notation. |
|
549 | - * |
|
550 | - * Example: |
|
551 | - * |
|
552 | - * <pre>unicodeChar2php('"\u0000"')</pre> |
|
553 | - * |
|
554 | - * Returns |
|
555 | - * |
|
556 | - * <pre>\x0</pre> |
|
557 | - * |
|
558 | - * @param string $unicodeChar |
|
559 | - * @return string |
|
560 | - */ |
|
547 | + /** |
|
548 | + * Converts a unicode character to the PHPO notation. |
|
549 | + * |
|
550 | + * Example: |
|
551 | + * |
|
552 | + * <pre>unicodeChar2php('"\u0000"')</pre> |
|
553 | + * |
|
554 | + * Returns |
|
555 | + * |
|
556 | + * <pre>\x0</pre> |
|
557 | + * |
|
558 | + * @param string $unicodeChar |
|
559 | + * @return string |
|
560 | + */ |
|
561 | 561 | public static function unicodeChar2php(string $unicodeChar) : string |
562 | 562 | { |
563 | 563 | $unicodeChar = json_decode($unicodeChar); |
@@ -683,25 +683,25 @@ discard block |
||
683 | 683 | return 'false'; |
684 | 684 | } |
685 | 685 | |
686 | - /** |
|
687 | - * Converts an associative array with attribute name > value pairs |
|
688 | - * to an attribute string that can be used in an HTML tag. Empty |
|
689 | - * attribute values are ignored. |
|
690 | - * |
|
691 | - * Example: |
|
692 | - * |
|
693 | - * array2attributeString(array( |
|
694 | - * 'id' => 45, |
|
695 | - * 'href' => 'http://www.mistralys.com' |
|
696 | - * )); |
|
697 | - * |
|
698 | - * Result: |
|
699 | - * |
|
700 | - * id="45" href="http://www.mistralys.com" |
|
701 | - * |
|
702 | - * @param array $array |
|
703 | - * @return string |
|
704 | - */ |
|
686 | + /** |
|
687 | + * Converts an associative array with attribute name > value pairs |
|
688 | + * to an attribute string that can be used in an HTML tag. Empty |
|
689 | + * attribute values are ignored. |
|
690 | + * |
|
691 | + * Example: |
|
692 | + * |
|
693 | + * array2attributeString(array( |
|
694 | + * 'id' => 45, |
|
695 | + * 'href' => 'http://www.mistralys.com' |
|
696 | + * )); |
|
697 | + * |
|
698 | + * Result: |
|
699 | + * |
|
700 | + * id="45" href="http://www.mistralys.com" |
|
701 | + * |
|
702 | + * @param array $array |
|
703 | + * @return string |
|
704 | + */ |
|
705 | 705 | public static function array2attributeString($array) |
706 | 706 | { |
707 | 707 | $tokens = array(); |
@@ -720,14 +720,14 @@ discard block |
||
720 | 720 | return ' '.implode(' ', $tokens); |
721 | 721 | } |
722 | 722 | |
723 | - /** |
|
724 | - * Converts a string so it can safely be used in a javascript |
|
725 | - * statement in an HTML tag: uses single quotes around the string |
|
726 | - * and encodes all special characters as needed. |
|
727 | - * |
|
728 | - * @param string $string |
|
729 | - * @return string |
|
730 | - */ |
|
723 | + /** |
|
724 | + * Converts a string so it can safely be used in a javascript |
|
725 | + * statement in an HTML tag: uses single quotes around the string |
|
726 | + * and encodes all special characters as needed. |
|
727 | + * |
|
728 | + * @param string $string |
|
729 | + * @return string |
|
730 | + */ |
|
731 | 731 | public static function string2attributeJS($string, $quoted=true) |
732 | 732 | { |
733 | 733 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
@@ -738,15 +738,15 @@ discard block |
||
738 | 738 | return $converted; |
739 | 739 | } |
740 | 740 | |
741 | - /** |
|
742 | - * Checks if the specified string is a boolean value, which |
|
743 | - * includes string representations of boolean values, like |
|
744 | - * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
745 | - * or <code>false</code>. |
|
746 | - * |
|
747 | - * @param mixed $value |
|
748 | - * @return boolean |
|
749 | - */ |
|
741 | + /** |
|
742 | + * Checks if the specified string is a boolean value, which |
|
743 | + * includes string representations of boolean values, like |
|
744 | + * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
745 | + * or <code>false</code>. |
|
746 | + * |
|
747 | + * @param mixed $value |
|
748 | + * @return boolean |
|
749 | + */ |
|
750 | 750 | public static function isBoolean($value) : bool |
751 | 751 | { |
752 | 752 | if(is_bool($value)) { |
@@ -760,12 +760,12 @@ discard block |
||
760 | 760 | return array_key_exists($value, self::$booleanStrings); |
761 | 761 | } |
762 | 762 | |
763 | - /** |
|
764 | - * Converts an associative array to an HTML style attribute value string. |
|
765 | - * |
|
766 | - * @param array $subject |
|
767 | - * @return string |
|
768 | - */ |
|
763 | + /** |
|
764 | + * Converts an associative array to an HTML style attribute value string. |
|
765 | + * |
|
766 | + * @param array $subject |
|
767 | + * @return string |
|
768 | + */ |
|
769 | 769 | public static function array2styleString(array $subject) : string |
770 | 770 | { |
771 | 771 | $tokens = array(); |
@@ -776,23 +776,23 @@ discard block |
||
776 | 776 | return implode(';', $tokens); |
777 | 777 | } |
778 | 778 | |
779 | - /** |
|
780 | - * Converts a DateTime object to a timestamp, which |
|
781 | - * is PHP 5.2 compatible. |
|
782 | - * |
|
783 | - * @param \DateTime $date |
|
784 | - * @return integer |
|
785 | - */ |
|
779 | + /** |
|
780 | + * Converts a DateTime object to a timestamp, which |
|
781 | + * is PHP 5.2 compatible. |
|
782 | + * |
|
783 | + * @param \DateTime $date |
|
784 | + * @return integer |
|
785 | + */ |
|
786 | 786 | public static function date2timestamp(\DateTime $date) : int |
787 | 787 | { |
788 | 788 | return (int)$date->format('U'); |
789 | 789 | } |
790 | 790 | |
791 | - /** |
|
792 | - * Converts a timestamp into a DateTime instance. |
|
793 | - * @param int $timestamp |
|
794 | - * @return \DateTime |
|
795 | - */ |
|
791 | + /** |
|
792 | + * Converts a timestamp into a DateTime instance. |
|
793 | + * @param int $timestamp |
|
794 | + * @return \DateTime |
|
795 | + */ |
|
796 | 796 | public static function timestamp2date(int $timestamp) : \DateTime |
797 | 797 | { |
798 | 798 | $date = new \DateTime(); |
@@ -800,50 +800,50 @@ discard block |
||
800 | 800 | return $date; |
801 | 801 | } |
802 | 802 | |
803 | - /** |
|
804 | - * Strips an absolute path to a file within the application |
|
805 | - * to make the path relative to the application root path. |
|
806 | - * |
|
807 | - * @param string $path |
|
808 | - * @return string |
|
809 | - * |
|
810 | - * @see FileHelper::relativizePath() |
|
811 | - * @see FileHelper::relativizePathByDepth() |
|
812 | - */ |
|
803 | + /** |
|
804 | + * Strips an absolute path to a file within the application |
|
805 | + * to make the path relative to the application root path. |
|
806 | + * |
|
807 | + * @param string $path |
|
808 | + * @return string |
|
809 | + * |
|
810 | + * @see FileHelper::relativizePath() |
|
811 | + * @see FileHelper::relativizePathByDepth() |
|
812 | + */ |
|
813 | 813 | public static function fileRelativize(string $path) : string |
814 | 814 | { |
815 | 815 | return FileHelper::relativizePathByDepth($path); |
816 | 816 | } |
817 | 817 | |
818 | 818 | /** |
819 | - * Converts a PHP regex to a javascript RegExp object statement. |
|
820 | - * |
|
821 | - * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
822 | - * More details are available on its usage there. |
|
823 | - * |
|
824 | - * @param string $regex A PHP preg regex |
|
825 | - * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
826 | - * @return array|string Depending on the specified return type. |
|
827 | - * |
|
828 | - * @see JSHelper::buildRegexStatement() |
|
829 | - */ |
|
819 | + * Converts a PHP regex to a javascript RegExp object statement. |
|
820 | + * |
|
821 | + * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
822 | + * More details are available on its usage there. |
|
823 | + * |
|
824 | + * @param string $regex A PHP preg regex |
|
825 | + * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
826 | + * @return array|string Depending on the specified return type. |
|
827 | + * |
|
828 | + * @see JSHelper::buildRegexStatement() |
|
829 | + */ |
|
830 | 830 | public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
831 | 831 | { |
832 | 832 | return JSHelper::buildRegexStatement($regex, $statementType); |
833 | 833 | } |
834 | 834 | |
835 | - /** |
|
836 | - * Converts the specified variable to JSON. Works just |
|
837 | - * like the native `json_encode` method, except that it |
|
838 | - * will trigger an exception on failure, which has the |
|
839 | - * json error details included in its developer details. |
|
840 | - * |
|
841 | - * @param mixed $variable |
|
842 | - * @param int $options JSON encode options. |
|
843 | - * @param int $depth |
|
844 | - * @throws ConvertHelper_Exception |
|
845 | - * @return string |
|
846 | - */ |
|
835 | + /** |
|
836 | + * Converts the specified variable to JSON. Works just |
|
837 | + * like the native `json_encode` method, except that it |
|
838 | + * will trigger an exception on failure, which has the |
|
839 | + * json error details included in its developer details. |
|
840 | + * |
|
841 | + * @param mixed $variable |
|
842 | + * @param int $options JSON encode options. |
|
843 | + * @param int $depth |
|
844 | + * @throws ConvertHelper_Exception |
|
845 | + * @return string |
|
846 | + */ |
|
847 | 847 | public static function var2json($variable, int $options=0, int $depth=512) : string |
848 | 848 | { |
849 | 849 | $result = json_encode($variable, $options, $depth); |
@@ -864,12 +864,12 @@ discard block |
||
864 | 864 | ); |
865 | 865 | } |
866 | 866 | |
867 | - /** |
|
868 | - * Strips all known UTF byte order marks from the specified string. |
|
869 | - * |
|
870 | - * @param string $string |
|
871 | - * @return string |
|
872 | - */ |
|
867 | + /** |
|
868 | + * Strips all known UTF byte order marks from the specified string. |
|
869 | + * |
|
870 | + * @param string $string |
|
871 | + * @return string |
|
872 | + */ |
|
873 | 873 | public static function stripUTFBom($string) |
874 | 874 | { |
875 | 875 | $boms = FileHelper::getUTFBOMs(); |
@@ -884,13 +884,13 @@ discard block |
||
884 | 884 | return $string; |
885 | 885 | } |
886 | 886 | |
887 | - /** |
|
888 | - * Converts a string to valid utf8, regardless |
|
889 | - * of the string's encoding(s). |
|
890 | - * |
|
891 | - * @param string $string |
|
892 | - * @return string |
|
893 | - */ |
|
887 | + /** |
|
888 | + * Converts a string to valid utf8, regardless |
|
889 | + * of the string's encoding(s). |
|
890 | + * |
|
891 | + * @param string $string |
|
892 | + * @return string |
|
893 | + */ |
|
894 | 894 | public static function string2utf8($string) |
895 | 895 | { |
896 | 896 | if(!self::isStringASCII($string)) { |
@@ -900,15 +900,15 @@ discard block |
||
900 | 900 | return $string; |
901 | 901 | } |
902 | 902 | |
903 | - /** |
|
904 | - * Checks whether the specified string is an ASCII |
|
905 | - * string, without any special or UTF8 characters. |
|
906 | - * Note: empty strings and NULL are considered ASCII. |
|
907 | - * Any variable types other than strings are not. |
|
908 | - * |
|
909 | - * @param mixed $string |
|
910 | - * @return boolean |
|
911 | - */ |
|
903 | + /** |
|
904 | + * Checks whether the specified string is an ASCII |
|
905 | + * string, without any special or UTF8 characters. |
|
906 | + * Note: empty strings and NULL are considered ASCII. |
|
907 | + * Any variable types other than strings are not. |
|
908 | + * |
|
909 | + * @param mixed $string |
|
910 | + * @return boolean |
|
911 | + */ |
|
912 | 912 | public static function isStringASCII($string) : bool |
913 | 913 | { |
914 | 914 | if($string === '' || $string === NULL) { |
@@ -922,39 +922,39 @@ discard block |
||
922 | 922 | return !preg_match('/[^\x00-\x7F]/', $string); |
923 | 923 | } |
924 | 924 | |
925 | - /** |
|
926 | - * Adds HTML syntax highlighting to an URL. |
|
927 | - * |
|
928 | - * NOTE: Includes the necessary CSS styles. When |
|
929 | - * highlighting several URLs in the same page, |
|
930 | - * prefer using the `parseURL` function instead. |
|
931 | - * |
|
932 | - * @param string $url |
|
933 | - * @return string |
|
934 | - * @deprecated Use the Highlighter class directly instead. |
|
935 | - * @see Highlighter |
|
936 | - */ |
|
925 | + /** |
|
926 | + * Adds HTML syntax highlighting to an URL. |
|
927 | + * |
|
928 | + * NOTE: Includes the necessary CSS styles. When |
|
929 | + * highlighting several URLs in the same page, |
|
930 | + * prefer using the `parseURL` function instead. |
|
931 | + * |
|
932 | + * @param string $url |
|
933 | + * @return string |
|
934 | + * @deprecated Use the Highlighter class directly instead. |
|
935 | + * @see Highlighter |
|
936 | + */ |
|
937 | 937 | public static function highlight_url(string $url) : string |
938 | 938 | { |
939 | 939 | return Highlighter::url($url); |
940 | 940 | } |
941 | 941 | |
942 | - /** |
|
943 | - * Calculates a percentage match of the source string with the target string. |
|
944 | - * |
|
945 | - * Options are: |
|
946 | - * |
|
947 | - * - maxLevenshtein, default: 10 |
|
948 | - * Any levenshtein results above this value are ignored. |
|
949 | - * |
|
950 | - * - precision, default: 1 |
|
951 | - * The precision of the percentage float value |
|
952 | - * |
|
953 | - * @param string $source |
|
954 | - * @param string $target |
|
955 | - * @param array $options |
|
956 | - * @return float |
|
957 | - */ |
|
942 | + /** |
|
943 | + * Calculates a percentage match of the source string with the target string. |
|
944 | + * |
|
945 | + * Options are: |
|
946 | + * |
|
947 | + * - maxLevenshtein, default: 10 |
|
948 | + * Any levenshtein results above this value are ignored. |
|
949 | + * |
|
950 | + * - precision, default: 1 |
|
951 | + * The precision of the percentage float value |
|
952 | + * |
|
953 | + * @param string $source |
|
954 | + * @param string $target |
|
955 | + * @param array $options |
|
956 | + * @return float |
|
957 | + */ |
|
958 | 958 | public static function matchString($source, $target, $options=array()) |
959 | 959 | { |
960 | 960 | $defaults = array( |
@@ -978,14 +978,14 @@ discard block |
||
978 | 978 | return round(100 - $percent, $options['precision']); |
979 | 979 | } |
980 | 980 | |
981 | - /** |
|
982 | - * Converts a date interval to a human readable string with |
|
983 | - * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
984 | - * |
|
985 | - * @param \DateInterval $interval |
|
986 | - * @return string |
|
987 | - * @see ConvertHelper_IntervalConverter |
|
988 | - */ |
|
981 | + /** |
|
982 | + * Converts a date interval to a human readable string with |
|
983 | + * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
984 | + * |
|
985 | + * @param \DateInterval $interval |
|
986 | + * @return string |
|
987 | + * @see ConvertHelper_IntervalConverter |
|
988 | + */ |
|
989 | 989 | public static function interval2string(\DateInterval $interval) : string |
990 | 990 | { |
991 | 991 | $converter = new ConvertHelper_IntervalConverter(); |
@@ -1000,60 +1000,60 @@ discard block |
||
1000 | 1000 | |
1001 | 1001 | const INTERVAL_SECONDS = 'seconds'; |
1002 | 1002 | |
1003 | - /** |
|
1004 | - * Converts an interval to its total amount of days. |
|
1005 | - * @param \DateInterval $interval |
|
1006 | - * @return int |
|
1007 | - */ |
|
1003 | + /** |
|
1004 | + * Converts an interval to its total amount of days. |
|
1005 | + * @param \DateInterval $interval |
|
1006 | + * @return int |
|
1007 | + */ |
|
1008 | 1008 | public static function interval2days(\DateInterval $interval) : int |
1009 | 1009 | { |
1010 | 1010 | return self::interval2total($interval, self::INTERVAL_DAYS); |
1011 | 1011 | } |
1012 | 1012 | |
1013 | - /** |
|
1014 | - * Converts an interval to its total amount of hours. |
|
1015 | - * @param \DateInterval $interval |
|
1016 | - * @return int |
|
1017 | - */ |
|
1013 | + /** |
|
1014 | + * Converts an interval to its total amount of hours. |
|
1015 | + * @param \DateInterval $interval |
|
1016 | + * @return int |
|
1017 | + */ |
|
1018 | 1018 | public static function interval2hours(\DateInterval $interval) : int |
1019 | 1019 | { |
1020 | 1020 | return self::interval2total($interval, self::INTERVAL_HOURS); |
1021 | 1021 | } |
1022 | 1022 | |
1023 | - /** |
|
1024 | - * Converts an interval to its total amount of minutes. |
|
1025 | - * @param \DateInterval $interval |
|
1026 | - * @return int |
|
1027 | - */ |
|
1023 | + /** |
|
1024 | + * Converts an interval to its total amount of minutes. |
|
1025 | + * @param \DateInterval $interval |
|
1026 | + * @return int |
|
1027 | + */ |
|
1028 | 1028 | public static function interval2minutes(\DateInterval $interval) : int |
1029 | 1029 | { |
1030 | 1030 | return self::interval2total($interval, self::INTERVAL_MINUTES); |
1031 | 1031 | } |
1032 | 1032 | |
1033 | - /** |
|
1034 | - * Converts an interval to its total amount of seconds. |
|
1035 | - * @param \DateInterval $interval |
|
1036 | - * @return int |
|
1037 | - */ |
|
1033 | + /** |
|
1034 | + * Converts an interval to its total amount of seconds. |
|
1035 | + * @param \DateInterval $interval |
|
1036 | + * @return int |
|
1037 | + */ |
|
1038 | 1038 | public static function interval2seconds(\DateInterval $interval) : int |
1039 | 1039 | { |
1040 | 1040 | return self::interval2total($interval, self::INTERVAL_SECONDS); |
1041 | 1041 | } |
1042 | 1042 | |
1043 | - /** |
|
1044 | - * Calculates the total amount of days / hours / minutes or seconds |
|
1045 | - * of a date interval object (depending in the specified units), and |
|
1046 | - * returns the total amount. |
|
1047 | - * |
|
1048 | - * @param \DateInterval $interval |
|
1049 | - * @param string $unit What total value to calculate. |
|
1050 | - * @return integer |
|
1051 | - * |
|
1052 | - * @see ConvertHelper::INTERVAL_SECONDS |
|
1053 | - * @see ConvertHelper::INTERVAL_MINUTES |
|
1054 | - * @see ConvertHelper::INTERVAL_HOURS |
|
1055 | - * @see ConvertHelper::INTERVAL_DAYS |
|
1056 | - */ |
|
1043 | + /** |
|
1044 | + * Calculates the total amount of days / hours / minutes or seconds |
|
1045 | + * of a date interval object (depending in the specified units), and |
|
1046 | + * returns the total amount. |
|
1047 | + * |
|
1048 | + * @param \DateInterval $interval |
|
1049 | + * @param string $unit What total value to calculate. |
|
1050 | + * @return integer |
|
1051 | + * |
|
1052 | + * @see ConvertHelper::INTERVAL_SECONDS |
|
1053 | + * @see ConvertHelper::INTERVAL_MINUTES |
|
1054 | + * @see ConvertHelper::INTERVAL_HOURS |
|
1055 | + * @see ConvertHelper::INTERVAL_DAYS |
|
1056 | + */ |
|
1057 | 1057 | public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
1058 | 1058 | { |
1059 | 1059 | $total = (int)$interval->format('%a'); |
@@ -1093,13 +1093,13 @@ discard block |
||
1093 | 1093 | 'Sunday' |
1094 | 1094 | ); |
1095 | 1095 | |
1096 | - /** |
|
1097 | - * Converts a date to the corresponding day name. |
|
1098 | - * |
|
1099 | - * @param \DateTime $date |
|
1100 | - * @param bool $short |
|
1101 | - * @return string|NULL |
|
1102 | - */ |
|
1096 | + /** |
|
1097 | + * Converts a date to the corresponding day name. |
|
1098 | + * |
|
1099 | + * @param \DateTime $date |
|
1100 | + * @param bool $short |
|
1101 | + * @return string|NULL |
|
1102 | + */ |
|
1103 | 1103 | public static function date2dayName(\DateTime $date, bool $short=false) |
1104 | 1104 | { |
1105 | 1105 | $day = $date->format('l'); |
@@ -1114,21 +1114,21 @@ discard block |
||
1114 | 1114 | return null; |
1115 | 1115 | } |
1116 | 1116 | |
1117 | - /** |
|
1118 | - * Retrieves a list of english day names. |
|
1119 | - * @return string[] |
|
1120 | - */ |
|
1117 | + /** |
|
1118 | + * Retrieves a list of english day names. |
|
1119 | + * @return string[] |
|
1120 | + */ |
|
1121 | 1121 | public static function getDayNamesInvariant() |
1122 | 1122 | { |
1123 | 1123 | return self::$daysInvariant; |
1124 | 1124 | } |
1125 | 1125 | |
1126 | - /** |
|
1127 | - * Retrieves the day names list for the current locale. |
|
1128 | - * |
|
1129 | - * @param bool $short |
|
1130 | - * @return array |
|
1131 | - */ |
|
1126 | + /** |
|
1127 | + * Retrieves the day names list for the current locale. |
|
1128 | + * |
|
1129 | + * @param bool $short |
|
1130 | + * @return array |
|
1131 | + */ |
|
1132 | 1132 | public static function getDayNames(bool $short=false) : array |
1133 | 1133 | { |
1134 | 1134 | if($short) { |
@@ -1188,16 +1188,16 @@ discard block |
||
1188 | 1188 | return $last; |
1189 | 1189 | } |
1190 | 1190 | |
1191 | - /** |
|
1192 | - * Splits a string into an array of all characters it is composed of. |
|
1193 | - * Unicode character safe. |
|
1194 | - * |
|
1195 | - * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1196 | - * characters. |
|
1197 | - * |
|
1198 | - * @param string $string |
|
1199 | - * @return array |
|
1200 | - */ |
|
1191 | + /** |
|
1192 | + * Splits a string into an array of all characters it is composed of. |
|
1193 | + * Unicode character safe. |
|
1194 | + * |
|
1195 | + * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1196 | + * characters. |
|
1197 | + * |
|
1198 | + * @param string $string |
|
1199 | + * @return array |
|
1200 | + */ |
|
1201 | 1201 | public static function string2array(string $string) : array |
1202 | 1202 | { |
1203 | 1203 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
@@ -1208,12 +1208,12 @@ discard block |
||
1208 | 1208 | return array(); |
1209 | 1209 | } |
1210 | 1210 | |
1211 | - /** |
|
1212 | - * Checks whether the specified string contains HTML code. |
|
1213 | - * |
|
1214 | - * @param string $string |
|
1215 | - * @return boolean |
|
1216 | - */ |
|
1211 | + /** |
|
1212 | + * Checks whether the specified string contains HTML code. |
|
1213 | + * |
|
1214 | + * @param string $string |
|
1215 | + * @return boolean |
|
1216 | + */ |
|
1217 | 1217 | public static function isStringHTML(string $string) : bool |
1218 | 1218 | { |
1219 | 1219 | if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
@@ -1228,17 +1228,17 @@ discard block |
||
1228 | 1228 | return false; |
1229 | 1229 | } |
1230 | 1230 | |
1231 | - /** |
|
1232 | - * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1233 | - * PHP function but compatible with UTF8. Otherwise the lengths |
|
1234 | - * are not calculated correctly. |
|
1235 | - * |
|
1236 | - * @param string $str |
|
1237 | - * @param int $width |
|
1238 | - * @param string $break |
|
1239 | - * @param bool $cut |
|
1240 | - * @return string |
|
1241 | - */ |
|
1231 | + /** |
|
1232 | + * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1233 | + * PHP function but compatible with UTF8. Otherwise the lengths |
|
1234 | + * are not calculated correctly. |
|
1235 | + * |
|
1236 | + * @param string $str |
|
1237 | + * @param int $width |
|
1238 | + * @param string $break |
|
1239 | + * @param bool $cut |
|
1240 | + * @return string |
|
1241 | + */ |
|
1242 | 1242 | public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string |
1243 | 1243 | { |
1244 | 1244 | $wrapper = new ConvertHelper_WordWrapper(); |
@@ -1250,27 +1250,27 @@ discard block |
||
1250 | 1250 | ->wrapText($str); |
1251 | 1251 | } |
1252 | 1252 | |
1253 | - /** |
|
1254 | - * Calculates the byte length of a string, taking into |
|
1255 | - * account any unicode characters. |
|
1256 | - * |
|
1257 | - * @param string $string |
|
1258 | - * @return int |
|
1259 | - * @see https://stackoverflow.com/a/9718273/2298192 |
|
1260 | - */ |
|
1253 | + /** |
|
1254 | + * Calculates the byte length of a string, taking into |
|
1255 | + * account any unicode characters. |
|
1256 | + * |
|
1257 | + * @param string $string |
|
1258 | + * @return int |
|
1259 | + * @see https://stackoverflow.com/a/9718273/2298192 |
|
1260 | + */ |
|
1261 | 1261 | public static function string2bytes($string) |
1262 | 1262 | { |
1263 | 1263 | return mb_strlen($string, '8bit'); |
1264 | 1264 | } |
1265 | 1265 | |
1266 | - /** |
|
1267 | - * Creates a short, 8-character long hash for the specified string. |
|
1268 | - * |
|
1269 | - * WARNING: Not cryptographically safe. |
|
1270 | - * |
|
1271 | - * @param string $string |
|
1272 | - * @return string |
|
1273 | - */ |
|
1266 | + /** |
|
1267 | + * Creates a short, 8-character long hash for the specified string. |
|
1268 | + * |
|
1269 | + * WARNING: Not cryptographically safe. |
|
1270 | + * |
|
1271 | + * @param string $string |
|
1272 | + * @return string |
|
1273 | + */ |
|
1274 | 1274 | public static function string2shortHash($string) |
1275 | 1275 | { |
1276 | 1276 | return hash('crc32', $string, false); |
@@ -1296,40 +1296,40 @@ discard block |
||
1296 | 1296 | return ConvertHelper_ThrowableInfo::fromThrowable($e); |
1297 | 1297 | } |
1298 | 1298 | |
1299 | - /** |
|
1300 | - * Parses the specified query string like the native |
|
1301 | - * function <code>parse_str</code>, without the key |
|
1302 | - * naming limitations. |
|
1303 | - * |
|
1304 | - * Using parse_str, dots or spaces in key names are |
|
1305 | - * replaced by underscores. This method keeps all names |
|
1306 | - * intact. |
|
1307 | - * |
|
1308 | - * It still uses the parse_str implementation as it |
|
1309 | - * is tested and tried, but fixes the parameter names |
|
1310 | - * after parsing, as needed. |
|
1311 | - * |
|
1312 | - * @param string $queryString |
|
1313 | - * @return array |
|
1314 | - * @see ConvertHelper_QueryParser |
|
1315 | - */ |
|
1299 | + /** |
|
1300 | + * Parses the specified query string like the native |
|
1301 | + * function <code>parse_str</code>, without the key |
|
1302 | + * naming limitations. |
|
1303 | + * |
|
1304 | + * Using parse_str, dots or spaces in key names are |
|
1305 | + * replaced by underscores. This method keeps all names |
|
1306 | + * intact. |
|
1307 | + * |
|
1308 | + * It still uses the parse_str implementation as it |
|
1309 | + * is tested and tried, but fixes the parameter names |
|
1310 | + * after parsing, as needed. |
|
1311 | + * |
|
1312 | + * @param string $queryString |
|
1313 | + * @return array |
|
1314 | + * @see ConvertHelper_QueryParser |
|
1315 | + */ |
|
1316 | 1316 | public static function parseQueryString(string $queryString) : array |
1317 | 1317 | { |
1318 | 1318 | $parser = new ConvertHelper_QueryParser(); |
1319 | 1319 | return $parser->parse($queryString); |
1320 | 1320 | } |
1321 | 1321 | |
1322 | - /** |
|
1323 | - * Searches for needle in the specified string, and returns a list |
|
1324 | - * of all occurrences, including the matched string. The matched |
|
1325 | - * string is useful when doing a case insensitive search, as it |
|
1326 | - * shows the exact matched case of needle. |
|
1327 | - * |
|
1328 | - * @param string $needle |
|
1329 | - * @param string $haystack |
|
1330 | - * @param bool $caseInsensitive |
|
1331 | - * @return ConvertHelper_StringMatch[] |
|
1332 | - */ |
|
1322 | + /** |
|
1323 | + * Searches for needle in the specified string, and returns a list |
|
1324 | + * of all occurrences, including the matched string. The matched |
|
1325 | + * string is useful when doing a case insensitive search, as it |
|
1326 | + * shows the exact matched case of needle. |
|
1327 | + * |
|
1328 | + * @param string $needle |
|
1329 | + * @param string $haystack |
|
1330 | + * @param bool $caseInsensitive |
|
1331 | + * @return ConvertHelper_StringMatch[] |
|
1332 | + */ |
|
1333 | 1333 | public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
1334 | 1334 | { |
1335 | 1335 | if($needle === '') { |
@@ -1355,14 +1355,14 @@ discard block |
||
1355 | 1355 | return $positions; |
1356 | 1356 | } |
1357 | 1357 | |
1358 | - /** |
|
1359 | - * Like explode, but trims all entries, and removes |
|
1360 | - * empty entries from the resulting array. |
|
1361 | - * |
|
1362 | - * @param string $delimiter |
|
1363 | - * @param string $string |
|
1364 | - * @return string[] |
|
1365 | - */ |
|
1358 | + /** |
|
1359 | + * Like explode, but trims all entries, and removes |
|
1360 | + * empty entries from the resulting array. |
|
1361 | + * |
|
1362 | + * @param string $delimiter |
|
1363 | + * @param string $string |
|
1364 | + * @return string[] |
|
1365 | + */ |
|
1366 | 1366 | public static function explodeTrim(string $delimiter, string $string) : array |
1367 | 1367 | { |
1368 | 1368 | if(empty($string) || empty($delimiter)) { |
@@ -1384,12 +1384,12 @@ discard block |
||
1384 | 1384 | |
1385 | 1385 | protected static $eolChars; |
1386 | 1386 | |
1387 | - /** |
|
1388 | - * Detects the most used end-of-line character in the subject string. |
|
1389 | - * |
|
1390 | - * @param string $subjectString The string to check. |
|
1391 | - * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1392 | - */ |
|
1387 | + /** |
|
1388 | + * Detects the most used end-of-line character in the subject string. |
|
1389 | + * |
|
1390 | + * @param string $subjectString The string to check. |
|
1391 | + * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1392 | + */ |
|
1393 | 1393 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1394 | 1394 | { |
1395 | 1395 | if(empty($subjectString)) { |
@@ -1401,27 +1401,27 @@ discard block |
||
1401 | 1401 | $cr = chr((int)hexdec('0d')); |
1402 | 1402 | $lf = chr((int)hexdec('0a')); |
1403 | 1403 | |
1404 | - self::$eolChars = array( |
|
1405 | - array( |
|
1406 | - 'char' => $cr.$lf, |
|
1407 | - 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
1408 | - 'description' => t('Carriage return followed by a line feed'), |
|
1409 | - ), |
|
1410 | - array( |
|
1411 | - 'char' => $lf.$cr, |
|
1412 | - 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
1413 | - 'description' => t('Line feed followed by a carriage return'), |
|
1414 | - ), |
|
1415 | - array( |
|
1416 | - 'char' => $lf, |
|
1417 | - 'type' => ConvertHelper_EOL::TYPE_LF, |
|
1418 | - 'description' => t('Line feed'), |
|
1419 | - ), |
|
1420 | - array( |
|
1421 | - 'char' => $cr, |
|
1422 | - 'type' => ConvertHelper_EOL::TYPE_CR, |
|
1423 | - 'description' => t('Carriage Return'), |
|
1424 | - ), |
|
1404 | + self::$eolChars = array( |
|
1405 | + array( |
|
1406 | + 'char' => $cr.$lf, |
|
1407 | + 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
1408 | + 'description' => t('Carriage return followed by a line feed'), |
|
1409 | + ), |
|
1410 | + array( |
|
1411 | + 'char' => $lf.$cr, |
|
1412 | + 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
1413 | + 'description' => t('Line feed followed by a carriage return'), |
|
1414 | + ), |
|
1415 | + array( |
|
1416 | + 'char' => $lf, |
|
1417 | + 'type' => ConvertHelper_EOL::TYPE_LF, |
|
1418 | + 'description' => t('Line feed'), |
|
1419 | + ), |
|
1420 | + array( |
|
1421 | + 'char' => $cr, |
|
1422 | + 'type' => ConvertHelper_EOL::TYPE_CR, |
|
1423 | + 'description' => t('Carriage Return'), |
|
1424 | + ), |
|
1425 | 1425 | ); |
1426 | 1426 | } |
1427 | 1427 | |
@@ -1449,13 +1449,13 @@ discard block |
||
1449 | 1449 | ); |
1450 | 1450 | } |
1451 | 1451 | |
1452 | - /** |
|
1453 | - * Removes the specified keys from the target array, |
|
1454 | - * if they exist. |
|
1455 | - * |
|
1456 | - * @param array $array |
|
1457 | - * @param array $keys |
|
1458 | - */ |
|
1452 | + /** |
|
1453 | + * Removes the specified keys from the target array, |
|
1454 | + * if they exist. |
|
1455 | + * |
|
1456 | + * @param array $array |
|
1457 | + * @param array $keys |
|
1458 | + */ |
|
1459 | 1459 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1460 | 1460 | { |
1461 | 1461 | foreach($keys as $key) |
@@ -1466,13 +1466,13 @@ discard block |
||
1466 | 1466 | } |
1467 | 1467 | } |
1468 | 1468 | |
1469 | - /** |
|
1470 | - * Checks if the specified variable is an integer or a string containing an integer. |
|
1471 | - * Accepts both positive and negative integers. |
|
1472 | - * |
|
1473 | - * @param mixed $value |
|
1474 | - * @return bool |
|
1475 | - */ |
|
1469 | + /** |
|
1470 | + * Checks if the specified variable is an integer or a string containing an integer. |
|
1471 | + * Accepts both positive and negative integers. |
|
1472 | + * |
|
1473 | + * @param mixed $value |
|
1474 | + * @return bool |
|
1475 | + */ |
|
1476 | 1476 | public static function isInteger($value) : bool |
1477 | 1477 | { |
1478 | 1478 | if(is_int($value)) { |
@@ -1492,52 +1492,52 @@ discard block |
||
1492 | 1492 | return false; |
1493 | 1493 | } |
1494 | 1494 | |
1495 | - /** |
|
1496 | - * Converts an amount of seconds to a DateInterval object. |
|
1497 | - * |
|
1498 | - * @param int $seconds |
|
1499 | - * @return \DateInterval |
|
1500 | - * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1501 | - * |
|
1502 | - * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1503 | - */ |
|
1495 | + /** |
|
1496 | + * Converts an amount of seconds to a DateInterval object. |
|
1497 | + * |
|
1498 | + * @param int $seconds |
|
1499 | + * @return \DateInterval |
|
1500 | + * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1501 | + * |
|
1502 | + * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1503 | + */ |
|
1504 | 1504 | public static function seconds2interval(int $seconds) : \DateInterval |
1505 | 1505 | { |
1506 | 1506 | return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval(); |
1507 | 1507 | } |
1508 | 1508 | |
1509 | - /** |
|
1510 | - * Converts a size string like "50 MB" to the corresponding byte size. |
|
1511 | - * It is case insensitive, ignores spaces, and supports both traditional |
|
1512 | - * "MB" and "MiB" notations. |
|
1513 | - * |
|
1514 | - * @param string $size |
|
1515 | - * @return int |
|
1516 | - */ |
|
1509 | + /** |
|
1510 | + * Converts a size string like "50 MB" to the corresponding byte size. |
|
1511 | + * It is case insensitive, ignores spaces, and supports both traditional |
|
1512 | + * "MB" and "MiB" notations. |
|
1513 | + * |
|
1514 | + * @param string $size |
|
1515 | + * @return int |
|
1516 | + */ |
|
1517 | 1517 | public static function size2bytes(string $size) : int |
1518 | 1518 | { |
1519 | 1519 | return self::parseSize($size)->toBytes(); |
1520 | 1520 | } |
1521 | 1521 | |
1522 | - /** |
|
1523 | - * Parses a size string like "50 MB" and returns a size notation instance |
|
1524 | - * that has utility methods to access information on it, and convert it. |
|
1525 | - * |
|
1526 | - * @param string $size |
|
1527 | - * @return ConvertHelper_SizeNotation |
|
1528 | - */ |
|
1522 | + /** |
|
1523 | + * Parses a size string like "50 MB" and returns a size notation instance |
|
1524 | + * that has utility methods to access information on it, and convert it. |
|
1525 | + * |
|
1526 | + * @param string $size |
|
1527 | + * @return ConvertHelper_SizeNotation |
|
1528 | + */ |
|
1529 | 1529 | public static function parseSize(string $size) : ConvertHelper_SizeNotation |
1530 | 1530 | { |
1531 | 1531 | return new ConvertHelper_SizeNotation($size); |
1532 | 1532 | } |
1533 | 1533 | |
1534 | - /** |
|
1535 | - * Creates a URL finder instance, which can be used to find |
|
1536 | - * URLs in a string - be it plain text, or HTML. |
|
1537 | - * |
|
1538 | - * @param string $subject |
|
1539 | - * @return ConvertHelper_URLFinder |
|
1540 | - */ |
|
1534 | + /** |
|
1535 | + * Creates a URL finder instance, which can be used to find |
|
1536 | + * URLs in a string - be it plain text, or HTML. |
|
1537 | + * |
|
1538 | + * @param string $subject |
|
1539 | + * @return ConvertHelper_URLFinder |
|
1540 | + */ |
|
1541 | 1541 | public static function createURLFinder(string $subject) : ConvertHelper_URLFinder |
1542 | 1542 | { |
1543 | 1543 | return new ConvertHelper_URLFinder($subject); |
@@ -50,7 +50,7 @@ discard block |
||
50 | 50 | * @param int $tabSize The amount of spaces per tab. |
51 | 51 | * @return string |
52 | 52 | */ |
53 | - public static function tabs2spaces(string $string, int $tabSize=4) : string |
|
53 | + public static function tabs2spaces(string $string, int $tabSize = 4) : string |
|
54 | 54 | { |
55 | 55 | return str_replace("\t", str_repeat(' ', $tabSize), $string); |
56 | 56 | } |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | * @param int $tabSize The amount of spaces per tab in the source string. |
63 | 63 | * @return string |
64 | 64 | */ |
65 | - public static function spaces2tabs(string $string, int $tabSize=4) : string |
|
65 | + public static function spaces2tabs(string $string, int $tabSize = 4) : string |
|
66 | 66 | { |
67 | 67 | return str_replace(str_repeat(' ', $tabSize), "\t", $string); |
68 | 68 | } |
@@ -122,10 +122,10 @@ discard block |
||
122 | 122 | |
123 | 123 | // specifically handle zero |
124 | 124 | if ($seconds <= 0) { |
125 | - return '0 ' . t('seconds'); |
|
125 | + return '0 '.t('seconds'); |
|
126 | 126 | } |
127 | 127 | |
128 | - if($seconds < 1) { |
|
128 | + if ($seconds < 1) { |
|
129 | 129 | return t('less than a second'); |
130 | 130 | } |
131 | 131 | |
@@ -133,7 +133,7 @@ discard block |
||
133 | 133 | foreach ($units as $def) { |
134 | 134 | $quot = intval($seconds / $def['value']); |
135 | 135 | if ($quot) { |
136 | - $item = $quot . ' '; |
|
136 | + $item = $quot.' '; |
|
137 | 137 | if (abs($quot) > 1) { |
138 | 138 | $item .= $def['plural']; |
139 | 139 | } else { |
@@ -150,7 +150,7 @@ discard block |
||
150 | 150 | return $last; |
151 | 151 | } |
152 | 152 | |
153 | - return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
|
153 | + return implode(', ', $tokens).' '.t('and').' '.$last; |
|
154 | 154 | } |
155 | 155 | |
156 | 156 | /** |
@@ -169,7 +169,7 @@ discard block |
||
169 | 169 | { |
170 | 170 | $converter = new ConvertHelper_DurationConverter(); |
171 | 171 | |
172 | - if($datefrom instanceof \DateTime) |
|
172 | + if ($datefrom instanceof \DateTime) |
|
173 | 173 | { |
174 | 174 | $converter->setDateFrom($datefrom); |
175 | 175 | } |
@@ -178,11 +178,11 @@ discard block |
||
178 | 178 | $converter->setDateFrom(self::timestamp2date($datefrom)); |
179 | 179 | } |
180 | 180 | |
181 | - if($dateto instanceof \DateTime) |
|
181 | + if ($dateto instanceof \DateTime) |
|
182 | 182 | { |
183 | 183 | $converter->setDateTo($dateto); |
184 | 184 | } |
185 | - else if($dateto > 0) |
|
185 | + else if ($dateto > 0) |
|
186 | 186 | { |
187 | 187 | $converter->setDateTo(self::timestamp2date($dateto)); |
188 | 188 | } |
@@ -212,7 +212,7 @@ discard block |
||
212 | 212 | * @deprecated Use the Highlighter class directly instead. |
213 | 213 | * @see Highlighter::xml() |
214 | 214 | */ |
215 | - public static function highlight_xml(string $xml, bool $formatSource=false) : string |
|
215 | + public static function highlight_xml(string $xml, bool $formatSource = false) : string |
|
216 | 216 | { |
217 | 217 | return Highlighter::xml($xml, $formatSource); |
218 | 218 | } |
@@ -273,16 +273,16 @@ discard block |
||
273 | 273 | return $text; |
274 | 274 | } |
275 | 275 | |
276 | - $text = trim(mb_substr($text, 0, $targetLength)) . $append; |
|
276 | + $text = trim(mb_substr($text, 0, $targetLength)).$append; |
|
277 | 277 | |
278 | 278 | return $text; |
279 | 279 | } |
280 | 280 | |
281 | - public static function var_dump($var, $html=true) : string |
|
281 | + public static function var_dump($var, $html = true) : string |
|
282 | 282 | { |
283 | 283 | $info = parseVariable($var); |
284 | 284 | |
285 | - if($html) { |
|
285 | + if ($html) { |
|
286 | 286 | return $info->toHTML(); |
287 | 287 | } |
288 | 288 | |
@@ -297,11 +297,11 @@ discard block |
||
297 | 297 | * @param bool $html Whether to style the dump as HTML. |
298 | 298 | * @return string |
299 | 299 | */ |
300 | - public static function print_r($var, bool $return=false, bool $html=true) : string |
|
300 | + public static function print_r($var, bool $return = false, bool $html = true) : string |
|
301 | 301 | { |
302 | 302 | $result = parseVariable($var)->enableType()->toString(); |
303 | 303 | |
304 | - if($html) |
|
304 | + if ($html) |
|
305 | 305 | { |
306 | 306 | $result = |
307 | 307 | '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'. |
@@ -309,7 +309,7 @@ discard block |
||
309 | 309 | '</pre>'; |
310 | 310 | } |
311 | 311 | |
312 | - if(!$return) |
|
312 | + if (!$return) |
|
313 | 313 | { |
314 | 314 | echo $result; |
315 | 315 | } |
@@ -337,17 +337,17 @@ discard block |
||
337 | 337 | */ |
338 | 338 | public static function string2bool($string) : bool |
339 | 339 | { |
340 | - if($string === '' || $string === null || !is_scalar($string)) |
|
340 | + if ($string === '' || $string === null || !is_scalar($string)) |
|
341 | 341 | { |
342 | 342 | return false; |
343 | 343 | } |
344 | 344 | |
345 | - if(is_bool($string)) |
|
345 | + if (is_bool($string)) |
|
346 | 346 | { |
347 | 347 | return $string; |
348 | 348 | } |
349 | 349 | |
350 | - if(array_key_exists($string, self::$booleanStrings)) |
|
350 | + if (array_key_exists($string, self::$booleanStrings)) |
|
351 | 351 | { |
352 | 352 | return self::$booleanStrings[$string]; |
353 | 353 | } |
@@ -402,10 +402,10 @@ discard block |
||
402 | 402 | public static function date2listLabel(\DateTime $date, $includeTime = false, $shortMonth = false) |
403 | 403 | { |
404 | 404 | $today = new \DateTime(); |
405 | - if($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
405 | + if ($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
406 | 406 | $label = t('Today'); |
407 | 407 | } else { |
408 | - $label = $date->format('d') . '. ' . self::month2string((int)$date->format('m'), $shortMonth) . ' '; |
|
408 | + $label = $date->format('d').'. '.self::month2string((int)$date->format('m'), $shortMonth).' '; |
|
409 | 409 | if ($date->format('Y') != date('Y')) { |
410 | 410 | $label .= $date->format('Y'); |
411 | 411 | } |
@@ -565,12 +565,12 @@ discard block |
||
565 | 565 | $output = ''; |
566 | 566 | $split = str_split($unicodeChar); |
567 | 567 | |
568 | - foreach($split as $octet) |
|
568 | + foreach ($split as $octet) |
|
569 | 569 | { |
570 | 570 | $ordInt = ord($octet); |
571 | 571 | // Convert from int (base 10) to hex (base 16), for PHP \x syntax |
572 | 572 | $ordHex = base_convert((string)$ordInt, 10, 16); |
573 | - $output .= '\x' . $ordHex; |
|
573 | + $output .= '\x'.$ordHex; |
|
574 | 574 | } |
575 | 575 | |
576 | 576 | return $output; |
@@ -603,19 +603,19 @@ discard block |
||
603 | 603 | |
604 | 604 | protected static function convertScalarForComparison($scalar) |
605 | 605 | { |
606 | - if($scalar === '' || is_null($scalar)) { |
|
606 | + if ($scalar === '' || is_null($scalar)) { |
|
607 | 607 | return null; |
608 | 608 | } |
609 | 609 | |
610 | - if(is_bool($scalar)) { |
|
610 | + if (is_bool($scalar)) { |
|
611 | 611 | return self::bool2string($scalar); |
612 | 612 | } |
613 | 613 | |
614 | - if(is_array($scalar)) { |
|
614 | + if (is_array($scalar)) { |
|
615 | 615 | $scalar = md5(serialize($scalar)); |
616 | 616 | } |
617 | 617 | |
618 | - if($scalar !== null && !is_scalar($scalar)) { |
|
618 | + if ($scalar !== null && !is_scalar($scalar)) { |
|
619 | 619 | throw new ConvertHelper_Exception( |
620 | 620 | 'Not a scalar value in comparison', |
621 | 621 | null, |
@@ -664,7 +664,7 @@ discard block |
||
664 | 664 | public static function bool2string($boolean, bool $yesno = false) : string |
665 | 665 | { |
666 | 666 | // allow 'yes', 'true', 'no', 'false' string notations as well |
667 | - if(!is_bool($boolean)) { |
|
667 | + if (!is_bool($boolean)) { |
|
668 | 668 | $boolean = self::string2bool($boolean); |
669 | 669 | } |
670 | 670 | |
@@ -705,15 +705,15 @@ discard block |
||
705 | 705 | public static function array2attributeString($array) |
706 | 706 | { |
707 | 707 | $tokens = array(); |
708 | - foreach($array as $attr => $value) { |
|
709 | - if($value == '' || $value == null) { |
|
708 | + foreach ($array as $attr => $value) { |
|
709 | + if ($value == '' || $value == null) { |
|
710 | 710 | continue; |
711 | 711 | } |
712 | 712 | |
713 | 713 | $tokens[] = $attr.'="'.$value.'"'; |
714 | 714 | } |
715 | 715 | |
716 | - if(empty($tokens)) { |
|
716 | + if (empty($tokens)) { |
|
717 | 717 | return ''; |
718 | 718 | } |
719 | 719 | |
@@ -728,10 +728,10 @@ discard block |
||
728 | 728 | * @param string $string |
729 | 729 | * @return string |
730 | 730 | */ |
731 | - public static function string2attributeJS($string, $quoted=true) |
|
731 | + public static function string2attributeJS($string, $quoted = true) |
|
732 | 732 | { |
733 | 733 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
734 | - if($quoted) { |
|
734 | + if ($quoted) { |
|
735 | 735 | $converted = "'".$converted."'"; |
736 | 736 | } |
737 | 737 | |
@@ -749,11 +749,11 @@ discard block |
||
749 | 749 | */ |
750 | 750 | public static function isBoolean($value) : bool |
751 | 751 | { |
752 | - if(is_bool($value)) { |
|
752 | + if (is_bool($value)) { |
|
753 | 753 | return true; |
754 | 754 | } |
755 | 755 | |
756 | - if(!is_scalar($value)) { |
|
756 | + if (!is_scalar($value)) { |
|
757 | 757 | return false; |
758 | 758 | } |
759 | 759 | |
@@ -769,7 +769,7 @@ discard block |
||
769 | 769 | public static function array2styleString(array $subject) : string |
770 | 770 | { |
771 | 771 | $tokens = array(); |
772 | - foreach($subject as $name => $value) { |
|
772 | + foreach ($subject as $name => $value) { |
|
773 | 773 | $tokens[] = $name.':'.$value; |
774 | 774 | } |
775 | 775 | |
@@ -827,7 +827,7 @@ discard block |
||
827 | 827 | * |
828 | 828 | * @see JSHelper::buildRegexStatement() |
829 | 829 | */ |
830 | - public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
|
830 | + public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) |
|
831 | 831 | { |
832 | 832 | return JSHelper::buildRegexStatement($regex, $statementType); |
833 | 833 | } |
@@ -844,11 +844,11 @@ discard block |
||
844 | 844 | * @throws ConvertHelper_Exception |
845 | 845 | * @return string |
846 | 846 | */ |
847 | - public static function var2json($variable, int $options=0, int $depth=512) : string |
|
847 | + public static function var2json($variable, int $options = 0, int $depth = 512) : string |
|
848 | 848 | { |
849 | 849 | $result = json_encode($variable, $options, $depth); |
850 | 850 | |
851 | - if($result !== false) { |
|
851 | + if ($result !== false) { |
|
852 | 852 | return $result; |
853 | 853 | } |
854 | 854 | |
@@ -873,10 +873,10 @@ discard block |
||
873 | 873 | public static function stripUTFBom($string) |
874 | 874 | { |
875 | 875 | $boms = FileHelper::getUTFBOMs(); |
876 | - foreach($boms as $bomChars) { |
|
876 | + foreach ($boms as $bomChars) { |
|
877 | 877 | $length = mb_strlen($bomChars); |
878 | 878 | $text = mb_substr($string, 0, $length); |
879 | - if($text==$bomChars) { |
|
879 | + if ($text == $bomChars) { |
|
880 | 880 | return mb_substr($string, $length); |
881 | 881 | } |
882 | 882 | } |
@@ -893,7 +893,7 @@ discard block |
||
893 | 893 | */ |
894 | 894 | public static function string2utf8($string) |
895 | 895 | { |
896 | - if(!self::isStringASCII($string)) { |
|
896 | + if (!self::isStringASCII($string)) { |
|
897 | 897 | return \ForceUTF8\Encoding::toUTF8($string); |
898 | 898 | } |
899 | 899 | |
@@ -911,11 +911,11 @@ discard block |
||
911 | 911 | */ |
912 | 912 | public static function isStringASCII($string) : bool |
913 | 913 | { |
914 | - if($string === '' || $string === NULL) { |
|
914 | + if ($string === '' || $string === NULL) { |
|
915 | 915 | return true; |
916 | 916 | } |
917 | 917 | |
918 | - if(!is_string($string)) { |
|
918 | + if (!is_string($string)) { |
|
919 | 919 | return false; |
920 | 920 | } |
921 | 921 | |
@@ -955,7 +955,7 @@ discard block |
||
955 | 955 | * @param array $options |
956 | 956 | * @return float |
957 | 957 | */ |
958 | - public static function matchString($source, $target, $options=array()) |
|
958 | + public static function matchString($source, $target, $options = array()) |
|
959 | 959 | { |
960 | 960 | $defaults = array( |
961 | 961 | 'maxLevenshtein' => 10, |
@@ -965,12 +965,12 @@ discard block |
||
965 | 965 | $options = array_merge($defaults, $options); |
966 | 966 | |
967 | 967 | // avoid doing this via levenshtein |
968 | - if($source == $target) { |
|
968 | + if ($source == $target) { |
|
969 | 969 | return 100; |
970 | 970 | } |
971 | 971 | |
972 | 972 | $diff = levenshtein($source, $target); |
973 | - if($diff > $options['maxLevenshtein']) { |
|
973 | + if ($diff > $options['maxLevenshtein']) { |
|
974 | 974 | return 0; |
975 | 975 | } |
976 | 976 | |
@@ -1054,24 +1054,24 @@ discard block |
||
1054 | 1054 | * @see ConvertHelper::INTERVAL_HOURS |
1055 | 1055 | * @see ConvertHelper::INTERVAL_DAYS |
1056 | 1056 | */ |
1057 | - public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
|
1057 | + public static function interval2total(\DateInterval $interval, $unit = self::INTERVAL_SECONDS) : int |
|
1058 | 1058 | { |
1059 | 1059 | $total = (int)$interval->format('%a'); |
1060 | 1060 | if ($unit == self::INTERVAL_DAYS) { |
1061 | 1061 | return $total; |
1062 | 1062 | } |
1063 | 1063 | |
1064 | - $total = ($total * 24) + ((int)$interval->h ); |
|
1064 | + $total = ($total * 24) + ((int)$interval->h); |
|
1065 | 1065 | if ($unit == self::INTERVAL_HOURS) { |
1066 | 1066 | return $total; |
1067 | 1067 | } |
1068 | 1068 | |
1069 | - $total = ($total * 60) + ((int)$interval->i ); |
|
1069 | + $total = ($total * 60) + ((int)$interval->i); |
|
1070 | 1070 | if ($unit == self::INTERVAL_MINUTES) { |
1071 | 1071 | return $total; |
1072 | 1072 | } |
1073 | 1073 | |
1074 | - $total = ($total * 60) + ((int)$interval->s ); |
|
1074 | + $total = ($total * 60) + ((int)$interval->s); |
|
1075 | 1075 | if ($unit == self::INTERVAL_SECONDS) { |
1076 | 1076 | return $total; |
1077 | 1077 | } |
@@ -1100,13 +1100,13 @@ discard block |
||
1100 | 1100 | * @param bool $short |
1101 | 1101 | * @return string|NULL |
1102 | 1102 | */ |
1103 | - public static function date2dayName(\DateTime $date, bool $short=false) |
|
1103 | + public static function date2dayName(\DateTime $date, bool $short = false) |
|
1104 | 1104 | { |
1105 | 1105 | $day = $date->format('l'); |
1106 | 1106 | $invariant = self::getDayNamesInvariant(); |
1107 | 1107 | |
1108 | 1108 | $idx = array_search($day, $invariant); |
1109 | - if($idx !== false) { |
|
1109 | + if ($idx !== false) { |
|
1110 | 1110 | $localized = self::getDayNames($short); |
1111 | 1111 | return $localized[$idx]; |
1112 | 1112 | } |
@@ -1129,10 +1129,10 @@ discard block |
||
1129 | 1129 | * @param bool $short |
1130 | 1130 | * @return array |
1131 | 1131 | */ |
1132 | - public static function getDayNames(bool $short=false) : array |
|
1132 | + public static function getDayNames(bool $short = false) : array |
|
1133 | 1133 | { |
1134 | - if($short) { |
|
1135 | - if(!isset(self::$daysShort)) { |
|
1134 | + if ($short) { |
|
1135 | + if (!isset(self::$daysShort)) { |
|
1136 | 1136 | self::$daysShort = array( |
1137 | 1137 | t('Mon'), |
1138 | 1138 | t('Tue'), |
@@ -1147,7 +1147,7 @@ discard block |
||
1147 | 1147 | return self::$daysShort; |
1148 | 1148 | } |
1149 | 1149 | |
1150 | - if(!isset(self::$days)) { |
|
1150 | + if (!isset(self::$days)) { |
|
1151 | 1151 | self::$days = array( |
1152 | 1152 | t('Monday'), |
1153 | 1153 | t('Tuesday'), |
@@ -1172,17 +1172,17 @@ discard block |
||
1172 | 1172 | */ |
1173 | 1173 | public static function implodeWithAnd(array $list, $sep = ', ', $conjunction = null) |
1174 | 1174 | { |
1175 | - if(empty($list)) { |
|
1175 | + if (empty($list)) { |
|
1176 | 1176 | return ''; |
1177 | 1177 | } |
1178 | 1178 | |
1179 | - if(empty($conjunction)) { |
|
1179 | + if (empty($conjunction)) { |
|
1180 | 1180 | $conjunction = t('and'); |
1181 | 1181 | } |
1182 | 1182 | |
1183 | 1183 | $last = array_pop($list); |
1184 | - if($list) { |
|
1185 | - return implode($sep, $list) . $conjunction . ' ' . $last; |
|
1184 | + if ($list) { |
|
1185 | + return implode($sep, $list).$conjunction.' '.$last; |
|
1186 | 1186 | } |
1187 | 1187 | |
1188 | 1188 | return $last; |
@@ -1201,7 +1201,7 @@ discard block |
||
1201 | 1201 | public static function string2array(string $string) : array |
1202 | 1202 | { |
1203 | 1203 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
1204 | - if($result !== false) { |
|
1204 | + if ($result !== false) { |
|
1205 | 1205 | return $result; |
1206 | 1206 | } |
1207 | 1207 | |
@@ -1216,12 +1216,12 @@ discard block |
||
1216 | 1216 | */ |
1217 | 1217 | public static function isStringHTML(string $string) : bool |
1218 | 1218 | { |
1219 | - if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
1219 | + if (preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
1220 | 1220 | return true; |
1221 | 1221 | } |
1222 | 1222 | |
1223 | 1223 | $decoded = html_entity_decode($string); |
1224 | - if($decoded !== $string) { |
|
1224 | + if ($decoded !== $string) { |
|
1225 | 1225 | return true; |
1226 | 1226 | } |
1227 | 1227 | |
@@ -1330,14 +1330,14 @@ discard block |
||
1330 | 1330 | * @param bool $caseInsensitive |
1331 | 1331 | * @return ConvertHelper_StringMatch[] |
1332 | 1332 | */ |
1333 | - public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
|
1333 | + public static function findString(string $needle, string $haystack, bool $caseInsensitive = false) |
|
1334 | 1334 | { |
1335 | - if($needle === '') { |
|
1335 | + if ($needle === '') { |
|
1336 | 1336 | return array(); |
1337 | 1337 | } |
1338 | 1338 | |
1339 | 1339 | $function = 'mb_strpos'; |
1340 | - if($caseInsensitive) { |
|
1340 | + if ($caseInsensitive) { |
|
1341 | 1341 | $function = 'mb_stripos'; |
1342 | 1342 | } |
1343 | 1343 | |
@@ -1345,7 +1345,7 @@ discard block |
||
1345 | 1345 | $positions = array(); |
1346 | 1346 | $length = mb_strlen($needle); |
1347 | 1347 | |
1348 | - while( ($pos = $function($haystack, $needle, $pos)) !== false) |
|
1348 | + while (($pos = $function($haystack, $needle, $pos)) !== false) |
|
1349 | 1349 | { |
1350 | 1350 | $match = mb_substr($haystack, $pos, $length); |
1351 | 1351 | $positions[] = new ConvertHelper_StringMatch($pos, $match); |
@@ -1365,7 +1365,7 @@ discard block |
||
1365 | 1365 | */ |
1366 | 1366 | public static function explodeTrim(string $delimiter, string $string) : array |
1367 | 1367 | { |
1368 | - if(empty($string) || empty($delimiter)) { |
|
1368 | + if (empty($string) || empty($delimiter)) { |
|
1369 | 1369 | return array(); |
1370 | 1370 | } |
1371 | 1371 | |
@@ -1373,8 +1373,8 @@ discard block |
||
1373 | 1373 | $tokens = array_map('trim', $tokens); |
1374 | 1374 | |
1375 | 1375 | $keep = array(); |
1376 | - foreach($tokens as $token) { |
|
1377 | - if($token !== '') { |
|
1376 | + foreach ($tokens as $token) { |
|
1377 | + if ($token !== '') { |
|
1378 | 1378 | $keep[] = $token; |
1379 | 1379 | } |
1380 | 1380 | } |
@@ -1392,11 +1392,11 @@ discard block |
||
1392 | 1392 | */ |
1393 | 1393 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1394 | 1394 | { |
1395 | - if(empty($subjectString)) { |
|
1395 | + if (empty($subjectString)) { |
|
1396 | 1396 | return null; |
1397 | 1397 | } |
1398 | 1398 | |
1399 | - if(!isset(self::$eolChars)) |
|
1399 | + if (!isset(self::$eolChars)) |
|
1400 | 1400 | { |
1401 | 1401 | $cr = chr((int)hexdec('0d')); |
1402 | 1402 | $lf = chr((int)hexdec('0a')); |
@@ -1427,18 +1427,18 @@ discard block |
||
1427 | 1427 | |
1428 | 1428 | $max = 0; |
1429 | 1429 | $results = array(); |
1430 | - foreach(self::$eolChars as $def) |
|
1430 | + foreach (self::$eolChars as $def) |
|
1431 | 1431 | { |
1432 | 1432 | $amount = substr_count($subjectString, $def['char']); |
1433 | 1433 | |
1434 | - if($amount > $max) |
|
1434 | + if ($amount > $max) |
|
1435 | 1435 | { |
1436 | 1436 | $max = $amount; |
1437 | 1437 | $results[] = $def; |
1438 | 1438 | } |
1439 | 1439 | } |
1440 | 1440 | |
1441 | - if(empty($results)) { |
|
1441 | + if (empty($results)) { |
|
1442 | 1442 | return null; |
1443 | 1443 | } |
1444 | 1444 | |
@@ -1458,9 +1458,9 @@ discard block |
||
1458 | 1458 | */ |
1459 | 1459 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1460 | 1460 | { |
1461 | - foreach($keys as $key) |
|
1461 | + foreach ($keys as $key) |
|
1462 | 1462 | { |
1463 | - if(array_key_exists($key, $array)) { |
|
1463 | + if (array_key_exists($key, $array)) { |
|
1464 | 1464 | unset($array[$key]); |
1465 | 1465 | } |
1466 | 1466 | } |
@@ -1475,17 +1475,17 @@ discard block |
||
1475 | 1475 | */ |
1476 | 1476 | public static function isInteger($value) : bool |
1477 | 1477 | { |
1478 | - if(is_int($value)) { |
|
1478 | + if (is_int($value)) { |
|
1479 | 1479 | return true; |
1480 | 1480 | } |
1481 | 1481 | |
1482 | 1482 | // booleans get converted to numbers, so they would |
1483 | 1483 | // actually match the regex. |
1484 | - if(is_bool($value)) { |
|
1484 | + if (is_bool($value)) { |
|
1485 | 1485 | return false; |
1486 | 1486 | } |
1487 | 1487 | |
1488 | - if(is_string($value) && $value !== '') { |
|
1488 | + if (is_string($value) && $value !== '') { |
|
1489 | 1489 | return preg_match('/\A-?\d+\z/', $value) === 1; |
1490 | 1490 | } |
1491 | 1491 |