@@ -110,38 +110,38 @@ discard block |
||
110 | 110 | return $this; |
111 | 111 | } |
112 | 112 | |
113 | - /** |
|
114 | - * Whether to enable sorting the URLs alphabetically (disabled by default). |
|
115 | - * |
|
116 | - * @param bool $enabled |
|
117 | - * @return $this |
|
118 | - */ |
|
113 | + /** |
|
114 | + * Whether to enable sorting the URLs alphabetically (disabled by default). |
|
115 | + * |
|
116 | + * @param bool $enabled |
|
117 | + * @return $this |
|
118 | + */ |
|
119 | 119 | public function enableSorting(bool $enabled=true) : ConvertHelper_URLFinder |
120 | 120 | { |
121 | 121 | $this->setOption('sorting', $enabled); |
122 | 122 | return $this; |
123 | 123 | } |
124 | 124 | |
125 | - /** |
|
126 | - * Whether to include email addresses in the search. |
|
127 | - * This is only relevant when using the getURLs() |
|
128 | - * method. |
|
129 | - * |
|
130 | - * @param bool $include |
|
131 | - * @return ConvertHelper_URLFinder |
|
132 | - */ |
|
125 | + /** |
|
126 | + * Whether to include email addresses in the search. |
|
127 | + * This is only relevant when using the getURLs() |
|
128 | + * method. |
|
129 | + * |
|
130 | + * @param bool $include |
|
131 | + * @return ConvertHelper_URLFinder |
|
132 | + */ |
|
133 | 133 | public function includeEmails(bool $include=true) : ConvertHelper_URLFinder |
134 | 134 | { |
135 | 135 | $this->setOption('include-emails', $include); |
136 | 136 | return $this; |
137 | 137 | } |
138 | 138 | |
139 | - /** |
|
140 | - * Whether to omit the mailto: that is automatically added to all email addresses. |
|
141 | - * |
|
142 | - * @param bool $omit |
|
143 | - * @return ConvertHelper_URLFinder |
|
144 | - */ |
|
139 | + /** |
|
140 | + * Whether to omit the mailto: that is automatically added to all email addresses. |
|
141 | + * |
|
142 | + * @param bool $omit |
|
143 | + * @return ConvertHelper_URLFinder |
|
144 | + */ |
|
145 | 145 | public function omitMailto(bool $omit=true) : ConvertHelper_URLFinder |
146 | 146 | { |
147 | 147 | $this->setOption('omit-mailto', $omit); |
@@ -267,11 +267,11 @@ discard block |
||
267 | 267 | ); |
268 | 268 | } |
269 | 269 | |
270 | - /** |
|
271 | - * Fetches all URLs that can be found in the subject string. |
|
272 | - * |
|
273 | - * @return string[] |
|
274 | - */ |
|
270 | + /** |
|
271 | + * Fetches all URLs that can be found in the subject string. |
|
272 | + * |
|
273 | + * @return string[] |
|
274 | + */ |
|
275 | 275 | public function getURLs() : array |
276 | 276 | { |
277 | 277 | $this->parse(); |
@@ -474,13 +474,13 @@ discard block |
||
474 | 474 | return array_pop($parts); |
475 | 475 | } |
476 | 476 | |
477 | - /** |
|
478 | - * Retrieves all email addresses from the subject string. |
|
479 | - * |
|
480 | - * @return string[] |
|
481 | - * |
|
482 | - * @see omitMailto() |
|
483 | - */ |
|
477 | + /** |
|
478 | + * Retrieves all email addresses from the subject string. |
|
479 | + * |
|
480 | + * @return string[] |
|
481 | + * |
|
482 | + * @see omitMailto() |
|
483 | + */ |
|
484 | 484 | public function getEmails() : array |
485 | 485 | { |
486 | 486 | $this->parse(); |
@@ -506,11 +506,11 @@ discard block |
||
506 | 506 | return $result; |
507 | 507 | } |
508 | 508 | |
509 | - /** |
|
510 | - * Retrieves all URLs as URLInfo instances. |
|
511 | - * |
|
512 | - * @return URLInfo[] |
|
513 | - */ |
|
509 | + /** |
|
510 | + * Retrieves all URLs as URLInfo instances. |
|
511 | + * |
|
512 | + * @return URLInfo[] |
|
513 | + */ |
|
514 | 514 | public function getInfos() : array |
515 | 515 | { |
516 | 516 | $this->parse(); |
@@ -104,7 +104,7 @@ discard block |
||
104 | 104 | * @param bool $enabled |
105 | 105 | * @return $this |
106 | 106 | */ |
107 | - public function enableNormalizing(bool $enabled=true) : ConvertHelper_URLFinder |
|
107 | + public function enableNormalizing(bool $enabled = true) : ConvertHelper_URLFinder |
|
108 | 108 | { |
109 | 109 | $this->setOption('normalize', $enabled); |
110 | 110 | return $this; |
@@ -116,7 +116,7 @@ discard block |
||
116 | 116 | * @param bool $enabled |
117 | 117 | * @return $this |
118 | 118 | */ |
119 | - public function enableSorting(bool $enabled=true) : ConvertHelper_URLFinder |
|
119 | + public function enableSorting(bool $enabled = true) : ConvertHelper_URLFinder |
|
120 | 120 | { |
121 | 121 | $this->setOption('sorting', $enabled); |
122 | 122 | return $this; |
@@ -130,7 +130,7 @@ discard block |
||
130 | 130 | * @param bool $include |
131 | 131 | * @return ConvertHelper_URLFinder |
132 | 132 | */ |
133 | - public function includeEmails(bool $include=true) : ConvertHelper_URLFinder |
|
133 | + public function includeEmails(bool $include = true) : ConvertHelper_URLFinder |
|
134 | 134 | { |
135 | 135 | $this->setOption('include-emails', $include); |
136 | 136 | return $this; |
@@ -142,7 +142,7 @@ discard block |
||
142 | 142 | * @param bool $omit |
143 | 143 | * @return ConvertHelper_URLFinder |
144 | 144 | */ |
145 | - public function omitMailto(bool $omit=true) : ConvertHelper_URLFinder |
|
145 | + public function omitMailto(bool $omit = true) : ConvertHelper_URLFinder |
|
146 | 146 | { |
147 | 147 | $this->setOption('omit-mailto', $omit); |
148 | 148 | return $this; |
@@ -169,7 +169,7 @@ discard block |
||
169 | 169 | { |
170 | 170 | $line = $this->analyzeLine($line); |
171 | 171 | |
172 | - if($line !== null) { |
|
172 | + if ($line !== null) { |
|
173 | 173 | $keep[] = $line; |
174 | 174 | } |
175 | 175 | } |
@@ -190,7 +190,7 @@ discard block |
||
190 | 190 | $line = trim($line, '.'); |
191 | 191 | |
192 | 192 | // Handle detecting an URI scheme |
193 | - if(strstr($line, ':') !== false) |
|
193 | + if (strstr($line, ':') !== false) |
|
194 | 194 | { |
195 | 195 | $scheme = URLInfo_Schemes::detectScheme($line); |
196 | 196 | |
@@ -204,7 +204,7 @@ discard block |
||
204 | 204 | // detect are email addresses and domain names. |
205 | 205 | |
206 | 206 | // No dot? Then it's certainly not a domain name. |
207 | - if(strstr($line, '.') === false) { |
|
207 | + if (strstr($line, '.') === false) { |
|
208 | 208 | return null; |
209 | 209 | } |
210 | 210 | |
@@ -222,10 +222,10 @@ discard block |
||
222 | 222 | { |
223 | 223 | $subject = stripslashes($subject); |
224 | 224 | |
225 | - foreach($this->detectors as $detector) |
|
225 | + foreach ($this->detectors as $detector) |
|
226 | 226 | { |
227 | 227 | // Avoid processing the string if it is not needed. |
228 | - if($detector->getRunPosition() !== ConvertHelper_URLFinder_Detector::RUN_BEFORE || !$detector->isValidFor($subject)) { |
|
228 | + if ($detector->getRunPosition() !== ConvertHelper_URLFinder_Detector::RUN_BEFORE || !$detector->isValidFor($subject)) { |
|
229 | 229 | continue; |
230 | 230 | } |
231 | 231 | |
@@ -246,7 +246,7 @@ discard block |
||
246 | 246 | { |
247 | 247 | $detector = new $className(); |
248 | 248 | |
249 | - if($detector instanceof ConvertHelper_URLFinder_Detector) |
|
249 | + if ($detector instanceof ConvertHelper_URLFinder_Detector) |
|
250 | 250 | { |
251 | 251 | return $detector; |
252 | 252 | } |
@@ -273,12 +273,12 @@ discard block |
||
273 | 273 | |
274 | 274 | $result = $this->getItemsAsString($this->urls); |
275 | 275 | |
276 | - if($this->getBoolOption('include-emails')) |
|
276 | + if ($this->getBoolOption('include-emails')) |
|
277 | 277 | { |
278 | 278 | $result = array_merge($result, $this->getEmails()); |
279 | 279 | } |
280 | 280 | |
281 | - if($this->getBoolOption('sorting')) |
|
281 | + if ($this->getBoolOption('sorting')) |
|
282 | 282 | { |
283 | 283 | usort($result, function(string $a, string $b) { |
284 | 284 | return strnatcasecmp($a, $b); |
@@ -298,12 +298,12 @@ discard block |
||
298 | 298 | |
299 | 299 | $result = array(); |
300 | 300 | |
301 | - foreach($collection as $url => $info) { |
|
302 | - if($normalize) { |
|
301 | + foreach ($collection as $url => $info) { |
|
302 | + if ($normalize) { |
|
303 | 303 | $url = $info->getNormalized(); |
304 | 304 | } |
305 | 305 | |
306 | - if(!in_array($url, $result)) { |
|
306 | + if (!in_array($url, $result)) { |
|
307 | 307 | $result[] = $url; |
308 | 308 | } |
309 | 309 | } |
@@ -320,9 +320,9 @@ discard block |
||
320 | 320 | */ |
321 | 321 | private function initDetectors() : void |
322 | 322 | { |
323 | - foreach($this->enabledDetectorClasses as $className => $enabled) |
|
323 | + foreach ($this->enabledDetectorClasses as $className => $enabled) |
|
324 | 324 | { |
325 | - if($enabled) { |
|
325 | + if ($enabled) { |
|
326 | 326 | $this->detectors[] = $this->createDetector($className); |
327 | 327 | } |
328 | 328 | } |
@@ -337,7 +337,7 @@ discard block |
||
337 | 337 | */ |
338 | 338 | private function parse() : void |
339 | 339 | { |
340 | - if($this->parsed) { |
|
340 | + if ($this->parsed) { |
|
341 | 341 | return; |
342 | 342 | } |
343 | 343 | |
@@ -348,11 +348,11 @@ discard block |
||
348 | 348 | |
349 | 349 | unset($this->subject); |
350 | 350 | |
351 | - foreach($this->matches as $match) |
|
351 | + foreach ($this->matches as $match) |
|
352 | 352 | { |
353 | 353 | $info = parseURL($match); |
354 | 354 | |
355 | - if($info->isEmail()) |
|
355 | + if ($info->isEmail()) |
|
356 | 356 | { |
357 | 357 | $this->emails[$this->filterEmailAddress($match)] = $info; |
358 | 358 | continue; |
@@ -368,7 +368,7 @@ discard block |
||
368 | 368 | * @param bool $enable |
369 | 369 | * @return $this |
370 | 370 | */ |
371 | - public function enableHTMLAttributes(bool $enable=true) : ConvertHelper_URLFinder |
|
371 | + public function enableHTMLAttributes(bool $enable = true) : ConvertHelper_URLFinder |
|
372 | 372 | { |
373 | 373 | $this->enabledDetectorClasses[ConvertHelper_URLFinder_Detector_HTMLAttributes::class] = $enable; |
374 | 374 | return $this; |
@@ -383,7 +383,7 @@ discard block |
||
383 | 383 | */ |
384 | 384 | private function filterEmailAddress(string $email) : string |
385 | 385 | { |
386 | - if(stristr($email, 'mailto:') === false) { |
|
386 | + if (stristr($email, 'mailto:') === false) { |
|
387 | 387 | $email = 'mailto:'.$email; |
388 | 388 | } |
389 | 389 | |
@@ -405,14 +405,14 @@ discard block |
||
405 | 405 | foreach ($lines as $line) |
406 | 406 | { |
407 | 407 | $scheme = URLInfo_Schemes::detectScheme($line); |
408 | - if($scheme !== null) { |
|
408 | + if ($scheme !== null) { |
|
409 | 409 | $this->matches[] = $line; |
410 | 410 | continue; |
411 | 411 | } |
412 | 412 | |
413 | 413 | $extension = $this->detectDomainExtension($line); |
414 | 414 | |
415 | - if($domains->nameExists($extension)) { |
|
415 | + if ($domains->nameExists($extension)) { |
|
416 | 416 | $this->matches[] = $line; |
417 | 417 | } |
418 | 418 | } |
@@ -431,9 +431,9 @@ discard block |
||
431 | 431 | |
432 | 432 | $subject = str_replace($remove, ' ', $subject); |
433 | 433 | |
434 | - foreach($this->detectors as $detector) |
|
434 | + foreach ($this->detectors as $detector) |
|
435 | 435 | { |
436 | - if($detector->getRunPosition() !== ConvertHelper_URLFinder_Detector::RUN_AFTER || !$detector->isValidFor($subject)) { |
|
436 | + if ($detector->getRunPosition() !== ConvertHelper_URLFinder_Detector::RUN_AFTER || !$detector->isValidFor($subject)) { |
|
437 | 437 | continue; |
438 | 438 | } |
439 | 439 | |
@@ -456,8 +456,8 @@ discard block |
||
456 | 456 | $boundaries = array('/', '?'); |
457 | 457 | |
458 | 458 | // Remove the path or query parts to access the domain extension only |
459 | - foreach($boundaries as $boundary) { |
|
460 | - if(strstr($url, $boundary)) { |
|
459 | + foreach ($boundaries as $boundary) { |
|
460 | + if (strstr($url, $boundary)) { |
|
461 | 461 | $parts = explode($boundary, $url); |
462 | 462 | $url = array_shift($parts); |
463 | 463 | break; |
@@ -482,16 +482,16 @@ discard block |
||
482 | 482 | |
483 | 483 | $result = $this->getItemsAsString($this->emails); |
484 | 484 | |
485 | - if($this->getBoolOption('omit-mailto')) { |
|
485 | + if ($this->getBoolOption('omit-mailto')) { |
|
486 | 486 | $keep = array(); |
487 | - foreach($result as $email) { |
|
487 | + foreach ($result as $email) { |
|
488 | 488 | $keep[] = str_replace('mailto:', '', $email); |
489 | 489 | } |
490 | 490 | |
491 | 491 | $result = $keep; |
492 | 492 | } |
493 | 493 | |
494 | - if($this->getBoolOption('sorting')) |
|
494 | + if ($this->getBoolOption('sorting')) |
|
495 | 495 | { |
496 | 496 | usort($result, function(string $a, string $b) { |
497 | 497 | return strnatcasecmp($a, $b); |
@@ -513,16 +513,16 @@ discard block |
||
513 | 513 | $result = array(); |
514 | 514 | $normalize = $this->getBoolOption('normalize'); |
515 | 515 | |
516 | - foreach($this->urls as $url => $info) |
|
516 | + foreach ($this->urls as $url => $info) |
|
517 | 517 | { |
518 | - if($normalize) { |
|
518 | + if ($normalize) { |
|
519 | 519 | $url = $info->getNormalized(); |
520 | 520 | } |
521 | 521 | |
522 | 522 | $result[$url] = $info; |
523 | 523 | } |
524 | 524 | |
525 | - if($this->getBoolOption('sorting')) |
|
525 | + if ($this->getBoolOption('sorting')) |
|
526 | 526 | { |
527 | 527 | ksort($result); |
528 | 528 | } |
@@ -23,24 +23,24 @@ discard block |
||
23 | 23 | */ |
24 | 24 | class URLInfo_Parser |
25 | 25 | { |
26 | - /** |
|
27 | - * @var string |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var string |
|
28 | + */ |
|
29 | 29 | protected $url; |
30 | 30 | |
31 | - /** |
|
32 | - * @var bool |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var bool |
|
33 | + */ |
|
34 | 34 | protected $isValid = false; |
35 | 35 | |
36 | - /** |
|
37 | - * @var array |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @var array |
|
38 | + */ |
|
39 | 39 | protected $info; |
40 | 40 | |
41 | - /** |
|
42 | - * @var array|NULL |
|
43 | - */ |
|
41 | + /** |
|
42 | + * @var array|NULL |
|
43 | + */ |
|
44 | 44 | protected $error; |
45 | 45 | |
46 | 46 | /** |
@@ -57,25 +57,25 @@ discard block |
||
57 | 57 | 'git' |
58 | 58 | ); |
59 | 59 | |
60 | - /** |
|
61 | - * Stores a list of all unicode characters in the URL |
|
62 | - * that have been filtered out before parsing it with |
|
63 | - * parse_url. |
|
64 | - * |
|
65 | - * @var string[]string |
|
66 | - */ |
|
60 | + /** |
|
61 | + * Stores a list of all unicode characters in the URL |
|
62 | + * that have been filtered out before parsing it with |
|
63 | + * parse_url. |
|
64 | + * |
|
65 | + * @var string[]string |
|
66 | + */ |
|
67 | 67 | protected $unicodeChars = array(); |
68 | 68 | |
69 | - /** |
|
70 | - * @var bool |
|
71 | - */ |
|
69 | + /** |
|
70 | + * @var bool |
|
71 | + */ |
|
72 | 72 | protected $encodeUTF = false; |
73 | 73 | |
74 | - /** |
|
75 | - * |
|
76 | - * @param string $url The target URL. |
|
77 | - * @param bool $encodeUTF Whether to URL encode any plain text unicode characters. |
|
78 | - */ |
|
74 | + /** |
|
75 | + * |
|
76 | + * @param string $url The target URL. |
|
77 | + * @param bool $encodeUTF Whether to URL encode any plain text unicode characters. |
|
78 | + */ |
|
79 | 79 | public function __construct(string $url, bool $encodeUTF) |
80 | 80 | { |
81 | 81 | $this->url = $url; |
@@ -88,12 +88,12 @@ discard block |
||
88 | 88 | } |
89 | 89 | } |
90 | 90 | |
91 | - /** |
|
92 | - * Retrieves the array as parsed by PHP's parse_url, |
|
93 | - * filtered and adjusted as necessary. |
|
94 | - * |
|
95 | - * @return array |
|
96 | - */ |
|
91 | + /** |
|
92 | + * Retrieves the array as parsed by PHP's parse_url, |
|
93 | + * filtered and adjusted as necessary. |
|
94 | + * |
|
95 | + * @return array |
|
96 | + */ |
|
97 | 97 | public function getInfo() : array |
98 | 98 | { |
99 | 99 | return $this->info; |
@@ -115,11 +115,11 @@ discard block |
||
115 | 115 | } |
116 | 116 | } |
117 | 117 | |
118 | - /** |
|
119 | - * Finds any non-url encoded unicode characters in |
|
120 | - * the URL, and encodes them before the URL is |
|
121 | - * passed to parse_url. |
|
122 | - */ |
|
118 | + /** |
|
119 | + * Finds any non-url encoded unicode characters in |
|
120 | + * the URL, and encodes them before the URL is |
|
121 | + * passed to parse_url. |
|
122 | + */ |
|
123 | 123 | protected function filterUnicodeChars() : void |
124 | 124 | { |
125 | 125 | $chars = ConvertHelper::string2array($this->url); |
@@ -238,11 +238,11 @@ discard block |
||
238 | 238 | return false; |
239 | 239 | } |
240 | 240 | |
241 | - /** |
|
242 | - * Goes through all information in the parse_url result |
|
243 | - * array, and attempts to fix any user errors in formatting |
|
244 | - * that can be recovered from, mostly regarding stray spaces. |
|
245 | - */ |
|
241 | + /** |
|
242 | + * Goes through all information in the parse_url result |
|
243 | + * array, and attempts to fix any user errors in formatting |
|
244 | + * that can be recovered from, mostly regarding stray spaces. |
|
245 | + */ |
|
246 | 246 | protected function filterParsed() : void |
247 | 247 | { |
248 | 248 | $this->info['params'] = array(); |
@@ -284,13 +284,13 @@ discard block |
||
284 | 284 | } |
285 | 285 | } |
286 | 286 | |
287 | - /** |
|
288 | - * Recursively goes through the array, and converts all previously |
|
289 | - * URL encoded characters with their unicode character counterparts. |
|
290 | - * |
|
291 | - * @param array $subject |
|
292 | - * @return array |
|
293 | - */ |
|
287 | + /** |
|
288 | + * Recursively goes through the array, and converts all previously |
|
289 | + * URL encoded characters with their unicode character counterparts. |
|
290 | + * |
|
291 | + * @param array $subject |
|
292 | + * @return array |
|
293 | + */ |
|
294 | 294 | protected function restoreUnicodeChars(array $subject) : array |
295 | 295 | { |
296 | 296 | $result = array(); |
@@ -314,13 +314,13 @@ discard block |
||
314 | 314 | return $result; |
315 | 315 | } |
316 | 316 | |
317 | - /** |
|
318 | - * Replaces all URL encoded unicode characters |
|
319 | - * in the string with the unicode character. |
|
320 | - * |
|
321 | - * @param string $string |
|
322 | - * @return string |
|
323 | - */ |
|
317 | + /** |
|
318 | + * Replaces all URL encoded unicode characters |
|
319 | + * in the string with the unicode character. |
|
320 | + * |
|
321 | + * @param string $string |
|
322 | + * @return string |
|
323 | + */ |
|
324 | 324 | protected function restoreUnicodeChar(string $string) : string |
325 | 325 | { |
326 | 326 | if(strstr($string, '%')) |
@@ -404,21 +404,21 @@ discard block |
||
404 | 404 | ); |
405 | 405 | } |
406 | 406 | |
407 | - /** |
|
408 | - * Checks whether the URL that was parsed is valid. |
|
409 | - * @return bool |
|
410 | - */ |
|
407 | + /** |
|
408 | + * Checks whether the URL that was parsed is valid. |
|
409 | + * @return bool |
|
410 | + */ |
|
411 | 411 | public function isValid() : bool |
412 | 412 | { |
413 | 413 | return $this->isValid; |
414 | 414 | } |
415 | 415 | |
416 | - /** |
|
417 | - * If the validation failed, retrieves the validation |
|
418 | - * error message. |
|
419 | - * |
|
420 | - * @return string |
|
421 | - */ |
|
416 | + /** |
|
417 | + * If the validation failed, retrieves the validation |
|
418 | + * error message. |
|
419 | + * |
|
420 | + * @return string |
|
421 | + */ |
|
422 | 422 | public function getErrorMessage() : string |
423 | 423 | { |
424 | 424 | if(isset($this->error)) { |
@@ -428,12 +428,12 @@ discard block |
||
428 | 428 | return ''; |
429 | 429 | } |
430 | 430 | |
431 | - /** |
|
432 | - * If the validation failed, retrieves the validation |
|
433 | - * error code. |
|
434 | - * |
|
435 | - * @return int |
|
436 | - */ |
|
431 | + /** |
|
432 | + * If the validation failed, retrieves the validation |
|
433 | + * error code. |
|
434 | + * |
|
435 | + * @return int |
|
436 | + */ |
|
437 | 437 | public function getErrorCode() : int |
438 | 438 | { |
439 | 439 | if(isset($this->error)) { |
@@ -83,7 +83,7 @@ discard block |
||
83 | 83 | |
84 | 84 | $this->parse(); |
85 | 85 | |
86 | - if(!$this->detectType()) { |
|
86 | + if (!$this->detectType()) { |
|
87 | 87 | $this->validate(); |
88 | 88 | } |
89 | 89 | } |
@@ -109,7 +109,7 @@ discard block |
||
109 | 109 | |
110 | 110 | // if the URL contains any URL characters, and we |
111 | 111 | // do not want them URL encoded, restore them. |
112 | - if(!$this->encodeUTF && !empty($this->unicodeChars)) |
|
112 | + if (!$this->encodeUTF && !empty($this->unicodeChars)) |
|
113 | 113 | { |
114 | 114 | $this->info = $this->restoreUnicodeChars($this->info); |
115 | 115 | } |
@@ -126,13 +126,13 @@ discard block |
||
126 | 126 | |
127 | 127 | $keep = array(); |
128 | 128 | |
129 | - foreach($chars as $char) |
|
129 | + foreach ($chars as $char) |
|
130 | 130 | { |
131 | - if(preg_match('/\p{L}/usix', $char)) |
|
131 | + if (preg_match('/\p{L}/usix', $char)) |
|
132 | 132 | { |
133 | 133 | $encoded = rawurlencode($char); |
134 | 134 | |
135 | - if($encoded != $char) |
|
135 | + if ($encoded != $char) |
|
136 | 136 | { |
137 | 137 | $this->unicodeChars[$encoded] = $char; |
138 | 138 | $char = $encoded; |
@@ -154,11 +154,11 @@ discard block |
||
154 | 154 | 'ipAddress' |
155 | 155 | ); |
156 | 156 | |
157 | - foreach($types as $type) |
|
157 | + foreach ($types as $type) |
|
158 | 158 | { |
159 | 159 | $method = 'detectType_'.$type; |
160 | 160 | |
161 | - if($this->$method() === true) |
|
161 | + if ($this->$method() === true) |
|
162 | 162 | { |
163 | 163 | $this->isValid = true; |
164 | 164 | return true; |
@@ -176,11 +176,11 @@ discard block |
||
176 | 176 | 'hostIsPresent' |
177 | 177 | ); |
178 | 178 | |
179 | - foreach($validations as $validation) |
|
179 | + foreach ($validations as $validation) |
|
180 | 180 | { |
181 | 181 | $method = 'validate_'.$validation; |
182 | 182 | |
183 | - if($this->$method() !== true) { |
|
183 | + if ($this->$method() !== true) { |
|
184 | 184 | return; |
185 | 185 | } |
186 | 186 | } |
@@ -193,13 +193,13 @@ discard block |
||
193 | 193 | // every link needs a host. This case can happen for ex, if |
194 | 194 | // the link starts with a typo with only one slash, like: |
195 | 195 | // "http:/hostname" |
196 | - if(isset($this->info['host'])) { |
|
196 | + if (isset($this->info['host'])) { |
|
197 | 197 | return true; |
198 | 198 | } |
199 | 199 | |
200 | 200 | $this->setError( |
201 | 201 | URLInfo::ERROR_MISSING_HOST, |
202 | - t('Cannot determine the link\'s host name.') . ' ' . |
|
202 | + t('Cannot determine the link\'s host name.').' '. |
|
203 | 203 | t('This usually happens when there\'s a typo somewhere.') |
204 | 204 | ); |
205 | 205 | |
@@ -208,7 +208,7 @@ discard block |
||
208 | 208 | |
209 | 209 | protected function validate_schemeIsSet() : bool |
210 | 210 | { |
211 | - if(isset($this->info['scheme'])) { |
|
211 | + if (isset($this->info['scheme'])) { |
|
212 | 212 | return true; |
213 | 213 | } |
214 | 214 | |
@@ -225,13 +225,13 @@ discard block |
||
225 | 225 | |
226 | 226 | protected function validate_schemeIsKnown() : bool |
227 | 227 | { |
228 | - if(in_array($this->info['scheme'], $this->knownSchemes)) { |
|
228 | + if (in_array($this->info['scheme'], $this->knownSchemes)) { |
|
229 | 229 | return true; |
230 | 230 | } |
231 | 231 | |
232 | 232 | $this->setError( |
233 | 233 | URLInfo::ERROR_INVALID_SCHEME, |
234 | - t('The scheme %1$s is not supported for links.', $this->info['scheme']) . ' ' . |
|
234 | + t('The scheme %1$s is not supported for links.', $this->info['scheme']).' '. |
|
235 | 235 | t('Valid schemes are: %1$s.', implode(', ', $this->knownSchemes)) |
236 | 236 | ); |
237 | 237 | |
@@ -248,36 +248,36 @@ discard block |
||
248 | 248 | $this->info['params'] = array(); |
249 | 249 | $this->info['type'] = URLInfo::TYPE_URL; |
250 | 250 | |
251 | - if(isset($this->info['scheme'])) |
|
251 | + if (isset($this->info['scheme'])) |
|
252 | 252 | { |
253 | 253 | $this->info['scheme'] = strtolower($this->info['scheme']); |
254 | 254 | } |
255 | 255 | else |
256 | 256 | { |
257 | 257 | $scheme = URLInfo_Schemes::detectScheme($this->url); |
258 | - if(!empty($scheme)) { |
|
259 | - $this->info['scheme'] = substr($scheme,0, strpos($scheme, ':')); |
|
258 | + if (!empty($scheme)) { |
|
259 | + $this->info['scheme'] = substr($scheme, 0, strpos($scheme, ':')); |
|
260 | 260 | } |
261 | 261 | } |
262 | 262 | |
263 | - if(isset($this->info['user'])) { |
|
263 | + if (isset($this->info['user'])) { |
|
264 | 264 | $this->info['user'] = urldecode($this->info['user']); |
265 | 265 | } |
266 | 266 | |
267 | - if(isset($this->info['pass'])) { |
|
267 | + if (isset($this->info['pass'])) { |
|
268 | 268 | $this->info['pass'] = urldecode($this->info['pass']); |
269 | 269 | } |
270 | 270 | |
271 | - if(isset($this->info['host'])) { |
|
271 | + if (isset($this->info['host'])) { |
|
272 | 272 | $this->info['host'] = strtolower($this->info['host']); |
273 | 273 | $this->info['host'] = str_replace(' ', '', $this->info['host']); |
274 | 274 | } |
275 | 275 | |
276 | - if(isset($this->info['path'])) { |
|
276 | + if (isset($this->info['path'])) { |
|
277 | 277 | $this->info['path'] = str_replace(' ', '', $this->info['path']); |
278 | 278 | } |
279 | 279 | |
280 | - if(isset($this->info['query']) && !empty($this->info['query'])) |
|
280 | + if (isset($this->info['query']) && !empty($this->info['query'])) |
|
281 | 281 | { |
282 | 282 | $this->info['params'] = ConvertHelper::parseQueryString($this->info['query']); |
283 | 283 | ksort($this->info['params']); |
@@ -295,9 +295,9 @@ discard block |
||
295 | 295 | { |
296 | 296 | $result = array(); |
297 | 297 | |
298 | - foreach($subject as $key => $val) |
|
298 | + foreach ($subject as $key => $val) |
|
299 | 299 | { |
300 | - if(is_array($val)) |
|
300 | + if (is_array($val)) |
|
301 | 301 | { |
302 | 302 | $val = $this->restoreUnicodeChars($val); |
303 | 303 | } |
@@ -323,7 +323,7 @@ discard block |
||
323 | 323 | */ |
324 | 324 | protected function restoreUnicodeChar(string $string) : string |
325 | 325 | { |
326 | - if(strstr($string, '%')) |
|
326 | + if (strstr($string, '%')) |
|
327 | 327 | { |
328 | 328 | return str_replace(array_keys($this->unicodeChars), array_values($this->unicodeChars), $string); |
329 | 329 | } |
@@ -333,12 +333,12 @@ discard block |
||
333 | 333 | |
334 | 334 | protected function detectType_email() : bool |
335 | 335 | { |
336 | - if(isset($this->info['scheme']) && $this->info['scheme'] == 'mailto') { |
|
336 | + if (isset($this->info['scheme']) && $this->info['scheme'] == 'mailto') { |
|
337 | 337 | $this->info['type'] = URLInfo::TYPE_EMAIL; |
338 | 338 | return true; |
339 | 339 | } |
340 | 340 | |
341 | - if(isset($this->info['path']) && preg_match(RegexHelper::REGEX_EMAIL, $this->info['path'])) |
|
341 | + if (isset($this->info['path']) && preg_match(RegexHelper::REGEX_EMAIL, $this->info['path'])) |
|
342 | 342 | { |
343 | 343 | $this->info['scheme'] = 'mailto'; |
344 | 344 | $this->info['type'] = URLInfo::TYPE_EMAIL; |
@@ -350,13 +350,13 @@ discard block |
||
350 | 350 | |
351 | 351 | protected function detectType_ipAddress() : bool |
352 | 352 | { |
353 | - if($this->isPathOnly() && preg_match(RegexHelper::REGEX_IPV4, $this->info['path'])) { |
|
353 | + if ($this->isPathOnly() && preg_match(RegexHelper::REGEX_IPV4, $this->info['path'])) { |
|
354 | 354 | $this->info['host'] = $this->info['path']; |
355 | 355 | $this->info['scheme'] = 'https'; |
356 | 356 | unset($this->info['path']); |
357 | 357 | } |
358 | 358 | |
359 | - if($this->isHostOnly() && preg_match(RegexHelper::REGEX_IPV4, $this->info['host'])) { |
|
359 | + if ($this->isHostOnly() && preg_match(RegexHelper::REGEX_IPV4, $this->info['host'])) { |
|
360 | 360 | $this->info['ip'] = $this->info['host']; |
361 | 361 | return true; |
362 | 362 | } |
@@ -376,7 +376,7 @@ discard block |
||
376 | 376 | |
377 | 377 | protected function detectType_fragmentLink() : bool |
378 | 378 | { |
379 | - if(isset($this->info['fragment']) && !isset($this->info['scheme'])) { |
|
379 | + if (isset($this->info['fragment']) && !isset($this->info['scheme'])) { |
|
380 | 380 | $this->info['type'] = URLInfo::TYPE_FRAGMENT; |
381 | 381 | return true; |
382 | 382 | } |
@@ -386,7 +386,7 @@ discard block |
||
386 | 386 | |
387 | 387 | protected function detectType_phoneLink() : bool |
388 | 388 | { |
389 | - if(isset($this->info['scheme']) && $this->info['scheme'] == 'tel') { |
|
389 | + if (isset($this->info['scheme']) && $this->info['scheme'] == 'tel') { |
|
390 | 390 | $this->info['type'] = URLInfo::TYPE_PHONE; |
391 | 391 | return true; |
392 | 392 | } |
@@ -421,7 +421,7 @@ discard block |
||
421 | 421 | */ |
422 | 422 | public function getErrorMessage() : string |
423 | 423 | { |
424 | - if(isset($this->error)) { |
|
424 | + if (isset($this->error)) { |
|
425 | 425 | return $this->error['message']; |
426 | 426 | } |
427 | 427 | |
@@ -436,7 +436,7 @@ discard block |
||
436 | 436 | */ |
437 | 437 | public function getErrorCode() : int |
438 | 438 | { |
439 | - if(isset($this->error)) { |
|
439 | + if (isset($this->error)) { |
|
440 | 440 | return $this->error['code']; |
441 | 441 | } |
442 | 442 |
@@ -251,8 +251,7 @@ discard block |
||
251 | 251 | if(isset($this->info['scheme'])) |
252 | 252 | { |
253 | 253 | $this->info['scheme'] = strtolower($this->info['scheme']); |
254 | - } |
|
255 | - else |
|
254 | + } else |
|
256 | 255 | { |
257 | 256 | $scheme = URLInfo_Schemes::detectScheme($this->url); |
258 | 257 | if(!empty($scheme)) { |
@@ -300,8 +299,7 @@ discard block |
||
300 | 299 | if(is_array($val)) |
301 | 300 | { |
302 | 301 | $val = $this->restoreUnicodeChars($val); |
303 | - } |
|
304 | - else |
|
302 | + } else |
|
305 | 303 | { |
306 | 304 | $val = $this->restoreUnicodeChar($val); |
307 | 305 | } |
@@ -72,8 +72,8 @@ discard block |
||
72 | 72 | { |
73 | 73 | self::buildCache(); |
74 | 74 | |
75 | - foreach(self::$cache as $scheme => $length) { |
|
76 | - if(strtolower(substr($url, 0, $length)) === $scheme) { |
|
75 | + foreach (self::$cache as $scheme => $length) { |
|
76 | + if (strtolower(substr($url, 0, $length)) === $scheme) { |
|
77 | 77 | return $scheme; |
78 | 78 | } |
79 | 79 | } |
@@ -88,11 +88,11 @@ discard block |
||
88 | 88 | */ |
89 | 89 | private static function buildCache() : void |
90 | 90 | { |
91 | - if(!empty(self::$cache)) { |
|
91 | + if (!empty(self::$cache)) { |
|
92 | 92 | return; |
93 | 93 | } |
94 | 94 | |
95 | - foreach(self::$schemes as $scheme) { |
|
95 | + foreach (self::$schemes as $scheme) { |
|
96 | 96 | self::$cache[$scheme] = strlen($scheme); |
97 | 97 | } |
98 | 98 | } |
@@ -42,10 +42,10 @@ discard block |
||
42 | 42 | |
43 | 43 | const REGEX_MD5 = '/^[a-f0-9]{32}$/i'; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string |
|
47 | - * @see https://en.wikipedia.org/wiki/Email_address#Local-part |
|
48 | - */ |
|
45 | + /** |
|
46 | + * @var string |
|
47 | + * @see https://en.wikipedia.org/wiki/Email_address#Local-part |
|
48 | + */ |
|
49 | 49 | const REGEX_EMAIL = '/[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?/i'; |
50 | 50 | |
51 | 51 | const REGEX_PHONE = '/\A[+0-9][0-9 +\-()]+\z/m'; |
@@ -97,14 +97,14 @@ discard block |
||
97 | 97 | */ |
98 | 98 | const REGEX_IS_HTML = '%<{0,1}[a-z\/][\s\S]*>|<[a-z\/][\s\S]*>{0,1}%i'; |
99 | 99 | |
100 | - /** |
|
101 | - * Hexadecimal color codes. Allows the following formats: |
|
102 | - * |
|
103 | - * FFFFFF |
|
104 | - * FFF |
|
105 | - * |
|
106 | - * @var string |
|
107 | - */ |
|
100 | + /** |
|
101 | + * Hexadecimal color codes. Allows the following formats: |
|
102 | + * |
|
103 | + * FFFFFF |
|
104 | + * FFF |
|
105 | + * |
|
106 | + * @var string |
|
107 | + */ |
|
108 | 108 | const REGEX_HEX_COLOR_CODE = '/\A(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{3})\z/iU'; |
109 | 109 | |
110 | 110 | /** |
@@ -33,14 +33,14 @@ |
||
33 | 33 | { |
34 | 34 | preg_match_all('%<([A-Z][A-Z0-9]*)\b[^>]*>(.*?)</\1>%si', $html, $result, PREG_PATTERN_ORDER); |
35 | 35 | |
36 | - if(empty($result[1])) { |
|
36 | + if (empty($result[1])) { |
|
37 | 37 | return '<p>'.$text.'</p>'; |
38 | 38 | } |
39 | 39 | |
40 | 40 | $tagName = array_pop($result[1]); |
41 | 41 | $pos = strrpos($html, '</'.$tagName.'>'); |
42 | 42 | |
43 | - if(in_array(strtolower($tagName), self::$newParaTags)) { |
|
43 | + if (in_array(strtolower($tagName), self::$newParaTags)) { |
|
44 | 44 | $replace = '</'.$tagName.'><p>'.$text.'</p>'; |
45 | 45 | } else { |
46 | 46 | $replace = $text.'</'.$tagName.'>'; |
@@ -25,10 +25,10 @@ |
||
25 | 25 | * |
26 | 26 | * @return string |
27 | 27 | */ |
28 | - function render() : string; |
|
28 | + function render() : string; |
|
29 | 29 | |
30 | 30 | /** |
31 | 31 | * Renders the string and echos it. |
32 | 32 | */ |
33 | - function display() : void; |
|
33 | + function display() : void; |
|
34 | 34 | } |
@@ -23,18 +23,18 @@ |
||
23 | 23 | * @see Microtime::ERROR_FAILED_CREATING_DATE_OBJECT |
24 | 24 | * @see Microtime::ERROR_FAILED_CONVERTING_STRING |
25 | 25 | */ |
26 | - public function __construct($datetime='now', DateTimeZone $timeZone=null) |
|
26 | + public function __construct($datetime = 'now', DateTimeZone $timeZone = null) |
|
27 | 27 | { |
28 | - if($timeZone === null) |
|
28 | + if ($timeZone === null) |
|
29 | 29 | { |
30 | 30 | $timeZone = new DateTimeZone(date_default_timezone_get()); |
31 | 31 | } |
32 | 32 | |
33 | - if(empty($datetime) || $datetime === 'now') |
|
33 | + if (empty($datetime) || $datetime === 'now') |
|
34 | 34 | { |
35 | 35 | $dateObj = DateTime::createFromFormat('0.u00 U', microtime(), new DateTimeZone('America/Denver')); |
36 | 36 | |
37 | - if($dateObj === false) { |
|
37 | + if ($dateObj === false) { |
|
38 | 38 | throw new ConvertHelper_Exception( |
39 | 39 | 'Failed to create microseconds date.', |
40 | 40 | '', |
@@ -49,8 +49,7 @@ |
||
49 | 49 | try |
50 | 50 | { |
51 | 51 | parent::__construct($datetime, $timeZone); |
52 | - } |
|
53 | - catch (Exception $e) |
|
52 | + } catch (Exception $e) |
|
54 | 53 | { |
55 | 54 | throw new ConvertHelper_Exception( |
56 | 55 | 'Failed to create date from string.', |
@@ -55,13 +55,13 @@ discard block |
||
55 | 55 | return ConvertHelper_String::tabs2spaces($string, $tabSize); |
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 ConvertHelper_String::spaces2tabs($string, $tabSize); |
@@ -79,14 +79,14 @@ discard block |
||
79 | 79 | return ConvertHelper_String::hidden2visible($string); |
80 | 80 | } |
81 | 81 | |
82 | - /** |
|
83 | - * Converts the specified amount of seconds into |
|
84 | - * a human-readable string split in months, weeks, |
|
85 | - * days, hours, minutes and seconds. |
|
86 | - * |
|
87 | - * @param float $seconds |
|
88 | - * @return string |
|
89 | - */ |
|
82 | + /** |
|
83 | + * Converts the specified amount of seconds into |
|
84 | + * a human-readable string split in months, weeks, |
|
85 | + * days, hours, minutes and seconds. |
|
86 | + * |
|
87 | + * @param float $seconds |
|
88 | + * @return string |
|
89 | + */ |
|
90 | 90 | public static function time2string($seconds) : string |
91 | 91 | { |
92 | 92 | $converter = new ConvertHelper_TimeConverter($seconds); |
@@ -110,85 +110,85 @@ discard block |
||
110 | 110 | */ |
111 | 111 | public static function duration2string($datefrom, $dateto = -1) : string |
112 | 112 | { |
113 | - return ConvertHelper_DurationConverter::toString($datefrom, $dateto); |
|
113 | + return ConvertHelper_DurationConverter::toString($datefrom, $dateto); |
|
114 | 114 | } |
115 | 115 | |
116 | - /** |
|
117 | - * Adds HTML syntax highlighting to the specified SQL string. |
|
118 | - * |
|
119 | - * @param string $sql |
|
120 | - * @return string |
|
121 | - * @deprecated Use the Highlighter class directly instead. |
|
122 | - * @see Highlighter::sql() |
|
123 | - */ |
|
116 | + /** |
|
117 | + * Adds HTML syntax highlighting to the specified SQL string. |
|
118 | + * |
|
119 | + * @param string $sql |
|
120 | + * @return string |
|
121 | + * @deprecated Use the Highlighter class directly instead. |
|
122 | + * @see Highlighter::sql() |
|
123 | + */ |
|
124 | 124 | public static function highlight_sql(string $sql) : string |
125 | 125 | { |
126 | 126 | return Highlighter::sql($sql); |
127 | 127 | } |
128 | 128 | |
129 | - /** |
|
130 | - * Adds HTML syntax highlighting to the specified XML code. |
|
131 | - * |
|
132 | - * @param string $xml The XML to highlight. |
|
133 | - * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
134 | - * @return string |
|
135 | - * @deprecated Use the Highlighter class directly instead. |
|
136 | - * @see Highlighter::xml() |
|
137 | - */ |
|
129 | + /** |
|
130 | + * Adds HTML syntax highlighting to the specified XML code. |
|
131 | + * |
|
132 | + * @param string $xml The XML to highlight. |
|
133 | + * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
134 | + * @return string |
|
135 | + * @deprecated Use the Highlighter class directly instead. |
|
136 | + * @see Highlighter::xml() |
|
137 | + */ |
|
138 | 138 | public static function highlight_xml(string $xml, bool $formatSource=false) : string |
139 | 139 | { |
140 | 140 | return Highlighter::xml($xml, $formatSource); |
141 | 141 | } |
142 | 142 | |
143 | - /** |
|
144 | - * @param string $phpCode |
|
145 | - * @return string |
|
146 | - * @deprecated Use the Highlighter class directly instead. |
|
147 | - * @see Highlighter::php() |
|
148 | - */ |
|
143 | + /** |
|
144 | + * @param string $phpCode |
|
145 | + * @return string |
|
146 | + * @deprecated Use the Highlighter class directly instead. |
|
147 | + * @see Highlighter::php() |
|
148 | + */ |
|
149 | 149 | public static function highlight_php(string $phpCode) : string |
150 | 150 | { |
151 | 151 | return Highlighter::php($phpCode); |
152 | 152 | } |
153 | 153 | |
154 | - /** |
|
155 | - * Converts a number of bytes to a human readable form, |
|
156 | - * e.g. xx Kb / xx Mb / xx Gb |
|
157 | - * |
|
158 | - * @param int $bytes The amount of bytes to convert. |
|
159 | - * @param int $precision The amount of decimals |
|
160 | - * @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). |
|
161 | - * @return string |
|
162 | - * |
|
163 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
164 | - */ |
|
154 | + /** |
|
155 | + * Converts a number of bytes to a human readable form, |
|
156 | + * e.g. xx Kb / xx Mb / xx Gb |
|
157 | + * |
|
158 | + * @param int $bytes The amount of bytes to convert. |
|
159 | + * @param int $precision The amount of decimals |
|
160 | + * @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). |
|
161 | + * @return string |
|
162 | + * |
|
163 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
164 | + */ |
|
165 | 165 | public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string |
166 | 166 | { |
167 | 167 | return self::parseBytes($bytes)->toString($precision, $base); |
168 | 168 | } |
169 | 169 | |
170 | - /** |
|
171 | - * Parses a number of bytes, and creates a converter instance which |
|
172 | - * allows doing common operations with it. |
|
173 | - * |
|
174 | - * @param int $bytes |
|
175 | - * @return ConvertHelper_ByteConverter |
|
176 | - */ |
|
170 | + /** |
|
171 | + * Parses a number of bytes, and creates a converter instance which |
|
172 | + * allows doing common operations with it. |
|
173 | + * |
|
174 | + * @param int $bytes |
|
175 | + * @return ConvertHelper_ByteConverter |
|
176 | + */ |
|
177 | 177 | public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter |
178 | 178 | { |
179 | 179 | return new ConvertHelper_ByteConverter($bytes); |
180 | 180 | } |
181 | 181 | |
182 | - /** |
|
183 | - * Cuts a text to the specified length if it is longer than the |
|
184 | - * target length. Appends a text to signify it has been cut at |
|
185 | - * the end of the string. |
|
186 | - * |
|
187 | - * @param string $text |
|
188 | - * @param int $targetLength |
|
189 | - * @param string $append |
|
190 | - * @return string |
|
191 | - */ |
|
182 | + /** |
|
183 | + * Cuts a text to the specified length if it is longer than the |
|
184 | + * target length. Appends a text to signify it has been cut at |
|
185 | + * the end of the string. |
|
186 | + * |
|
187 | + * @param string $text |
|
188 | + * @param int $targetLength |
|
189 | + * @param string $append |
|
190 | + * @return string |
|
191 | + */ |
|
192 | 192 | public static function text_cut(string $text, int $targetLength, string $append = '...') : string |
193 | 193 | { |
194 | 194 | return ConvertHelper_String::cutText($text, $targetLength, $append); |
@@ -212,14 +212,14 @@ discard block |
||
212 | 212 | return $info->toString(); |
213 | 213 | } |
214 | 214 | |
215 | - /** |
|
216 | - * Pretty `print_r`. |
|
217 | - * |
|
218 | - * @param mixed $var The variable to dump. |
|
219 | - * @param bool $return Whether to return the dumped code. |
|
220 | - * @param bool $html Whether to style the dump as HTML. |
|
221 | - * @return string |
|
222 | - */ |
|
215 | + /** |
|
216 | + * Pretty `print_r`. |
|
217 | + * |
|
218 | + * @param mixed $var The variable to dump. |
|
219 | + * @param bool $return Whether to return the dumped code. |
|
220 | + * @param bool $html Whether to style the dump as HTML. |
|
221 | + * @return string |
|
222 | + */ |
|
223 | 223 | public static function print_r($var, bool $return=false, bool $html=true) : string |
224 | 224 | { |
225 | 225 | $result = parseVariable($var)->enableType()->toString(); |
@@ -240,41 +240,41 @@ discard block |
||
240 | 240 | return $result; |
241 | 241 | } |
242 | 242 | |
243 | - /** |
|
244 | - * Converts a string, number or boolean value to a boolean value. |
|
245 | - * |
|
246 | - * @param mixed $string |
|
247 | - * @throws ConvertHelper_Exception |
|
248 | - * @return bool |
|
249 | - * |
|
250 | - * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
251 | - */ |
|
243 | + /** |
|
244 | + * Converts a string, number or boolean value to a boolean value. |
|
245 | + * |
|
246 | + * @param mixed $string |
|
247 | + * @throws ConvertHelper_Exception |
|
248 | + * @return bool |
|
249 | + * |
|
250 | + * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
251 | + */ |
|
252 | 252 | public static function string2bool($string) : bool |
253 | 253 | { |
254 | 254 | return ConvertHelper_Bool::fromString($string); |
255 | 255 | } |
256 | 256 | |
257 | - /** |
|
258 | - * Whether the specified string is a boolean string or boolean value. |
|
259 | - * Alias for {@link ConvertHelper::isBoolean()}. |
|
260 | - * |
|
261 | - * @param mixed $string |
|
262 | - * @return bool |
|
263 | - * @deprecated |
|
264 | - * @see ConvertHelper::isBoolean() |
|
265 | - */ |
|
257 | + /** |
|
258 | + * Whether the specified string is a boolean string or boolean value. |
|
259 | + * Alias for {@link ConvertHelper::isBoolean()}. |
|
260 | + * |
|
261 | + * @param mixed $string |
|
262 | + * @return bool |
|
263 | + * @deprecated |
|
264 | + * @see ConvertHelper::isBoolean() |
|
265 | + */ |
|
266 | 266 | public static function isBooleanString($string) : bool |
267 | 267 | { |
268 | 268 | return self::isBoolean($string); |
269 | 269 | } |
270 | 270 | |
271 | - /** |
|
272 | - * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
273 | - * |
|
274 | - * @param string $text |
|
275 | - * @return string |
|
276 | - * @deprecated |
|
277 | - */ |
|
271 | + /** |
|
272 | + * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
273 | + * |
|
274 | + * @param string $text |
|
275 | + * @return string |
|
276 | + * @deprecated |
|
277 | + */ |
|
278 | 278 | public static function text_makeXMLCompliant($text) |
279 | 279 | { |
280 | 280 | return XMLHelper::string2xml($text); |
@@ -331,36 +331,36 @@ discard block |
||
331 | 331 | return ConvertHelper_String::transliterate($string, $spaceChar, $lowercase); |
332 | 332 | } |
333 | 333 | |
334 | - /** |
|
335 | - * Retrieves the HEX character codes for all control |
|
336 | - * characters that the {@link stripControlCharacters()} |
|
337 | - * method will remove. |
|
338 | - * |
|
339 | - * @return string[] |
|
340 | - */ |
|
334 | + /** |
|
335 | + * Retrieves the HEX character codes for all control |
|
336 | + * characters that the {@link stripControlCharacters()} |
|
337 | + * method will remove. |
|
338 | + * |
|
339 | + * @return string[] |
|
340 | + */ |
|
341 | 341 | public static function getControlCharactersAsHex() : array |
342 | 342 | { |
343 | 343 | return self::createControlCharacters()->getCharsAsHex(); |
344 | 344 | } |
345 | 345 | |
346 | - /** |
|
347 | - * Retrieves an array of all control characters that |
|
348 | - * the {@link stripControlCharacters()} method will |
|
349 | - * remove, as the actual UTF-8 characters. |
|
350 | - * |
|
351 | - * @return string[] |
|
352 | - */ |
|
346 | + /** |
|
347 | + * Retrieves an array of all control characters that |
|
348 | + * the {@link stripControlCharacters()} method will |
|
349 | + * remove, as the actual UTF-8 characters. |
|
350 | + * |
|
351 | + * @return string[] |
|
352 | + */ |
|
353 | 353 | public static function getControlCharactersAsUTF8() : array |
354 | 354 | { |
355 | 355 | return self::createControlCharacters()->getCharsAsUTF8(); |
356 | 356 | } |
357 | 357 | |
358 | - /** |
|
359 | - * Retrieves all control characters as JSON encoded |
|
360 | - * characters, e.g. "\u200b". |
|
361 | - * |
|
362 | - * @return string[] |
|
363 | - */ |
|
358 | + /** |
|
359 | + * Retrieves all control characters as JSON encoded |
|
360 | + * characters, e.g. "\u200b". |
|
361 | + * |
|
362 | + * @return string[] |
|
363 | + */ |
|
364 | 364 | public static function getControlCharactersAsJSON() : array |
365 | 365 | { |
366 | 366 | return self::createControlCharacters()->getCharsAsJSON(); |
@@ -381,31 +381,31 @@ discard block |
||
381 | 381 | return self::createControlCharacters()->stripControlCharacters($string); |
382 | 382 | } |
383 | 383 | |
384 | - /** |
|
385 | - * Creates the control characters class, used to |
|
386 | - * work with control characters in strings. |
|
387 | - * |
|
388 | - * @return ConvertHelper_ControlCharacters |
|
389 | - */ |
|
384 | + /** |
|
385 | + * Creates the control characters class, used to |
|
386 | + * work with control characters in strings. |
|
387 | + * |
|
388 | + * @return ConvertHelper_ControlCharacters |
|
389 | + */ |
|
390 | 390 | public static function createControlCharacters() : ConvertHelper_ControlCharacters |
391 | 391 | { |
392 | 392 | return new ConvertHelper_ControlCharacters(); |
393 | 393 | } |
394 | 394 | |
395 | - /** |
|
396 | - * Converts a unicode character to the PHP notation. |
|
397 | - * |
|
398 | - * Example: |
|
399 | - * |
|
400 | - * <pre>unicodeChar2php('"\u0000"')</pre> |
|
401 | - * |
|
402 | - * Returns |
|
403 | - * |
|
404 | - * <pre>\x0</pre> |
|
405 | - * |
|
406 | - * @param string $unicodeChar |
|
407 | - * @return string |
|
408 | - */ |
|
395 | + /** |
|
396 | + * Converts a unicode character to the PHP notation. |
|
397 | + * |
|
398 | + * Example: |
|
399 | + * |
|
400 | + * <pre>unicodeChar2php('"\u0000"')</pre> |
|
401 | + * |
|
402 | + * Returns |
|
403 | + * |
|
404 | + * <pre>\x0</pre> |
|
405 | + * |
|
406 | + * @param string $unicodeChar |
|
407 | + * @return string |
|
408 | + */ |
|
409 | 409 | public static function unicodeChar2php(string $unicodeChar) : string |
410 | 410 | { |
411 | 411 | $unicodeChar = json_decode($unicodeChar); |
@@ -556,138 +556,138 @@ discard block |
||
556 | 556 | return ConvertHelper_Bool::toStringStrict($boolean, $yesNo); |
557 | 557 | } |
558 | 558 | |
559 | - /** |
|
560 | - * Converts an associative array with attribute name > value pairs |
|
561 | - * to an attribute string that can be used in an HTML tag. Empty |
|
562 | - * attribute values are ignored. |
|
563 | - * |
|
564 | - * Example: |
|
565 | - * |
|
566 | - * array2attributeString(array( |
|
567 | - * 'id' => 45, |
|
568 | - * 'href' => 'http://www.mistralys.com' |
|
569 | - * )); |
|
570 | - * |
|
571 | - * Result: |
|
572 | - * |
|
573 | - * id="45" href="http://www.mistralys.com" |
|
574 | - * |
|
575 | - * @param array<string,mixed> $array |
|
576 | - * @return string |
|
577 | - */ |
|
559 | + /** |
|
560 | + * Converts an associative array with attribute name > value pairs |
|
561 | + * to an attribute string that can be used in an HTML tag. Empty |
|
562 | + * attribute values are ignored. |
|
563 | + * |
|
564 | + * Example: |
|
565 | + * |
|
566 | + * array2attributeString(array( |
|
567 | + * 'id' => 45, |
|
568 | + * 'href' => 'http://www.mistralys.com' |
|
569 | + * )); |
|
570 | + * |
|
571 | + * Result: |
|
572 | + * |
|
573 | + * id="45" href="http://www.mistralys.com" |
|
574 | + * |
|
575 | + * @param array<string,mixed> $array |
|
576 | + * @return string |
|
577 | + */ |
|
578 | 578 | public static function array2attributeString(array $array) : string |
579 | 579 | { |
580 | 580 | return ConvertHelper_Array::toAttributeString($array); |
581 | 581 | } |
582 | 582 | |
583 | - /** |
|
584 | - * Converts a string, so it can safely be used in a javascript |
|
585 | - * statement in an HTML tag: uses single quotes around the string |
|
586 | - * and encodes all special characters as needed. |
|
587 | - * |
|
588 | - * @param string $string |
|
589 | - * @return string |
|
590 | - * @deprecated Use the JSHelper class instead. |
|
591 | - * @see JSHelper::phpVariable2AttributeJS() |
|
592 | - */ |
|
583 | + /** |
|
584 | + * Converts a string, so it can safely be used in a javascript |
|
585 | + * statement in an HTML tag: uses single quotes around the string |
|
586 | + * and encodes all special characters as needed. |
|
587 | + * |
|
588 | + * @param string $string |
|
589 | + * @return string |
|
590 | + * @deprecated Use the JSHelper class instead. |
|
591 | + * @see JSHelper::phpVariable2AttributeJS() |
|
592 | + */ |
|
593 | 593 | public static function string2attributeJS(string $string) : string |
594 | 594 | { |
595 | 595 | return JSHelper::phpVariable2AttributeJS($string); |
596 | 596 | } |
597 | 597 | |
598 | - /** |
|
599 | - * Checks if the specified string is a boolean value, which |
|
600 | - * includes string representations of boolean values, like |
|
601 | - * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
602 | - * or <code>false</code>. |
|
603 | - * |
|
604 | - * @param mixed $value |
|
605 | - * @return boolean |
|
606 | - */ |
|
598 | + /** |
|
599 | + * Checks if the specified string is a boolean value, which |
|
600 | + * includes string representations of boolean values, like |
|
601 | + * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
602 | + * or <code>false</code>. |
|
603 | + * |
|
604 | + * @param mixed $value |
|
605 | + * @return boolean |
|
606 | + */ |
|
607 | 607 | public static function isBoolean($value) : bool |
608 | 608 | { |
609 | 609 | return ConvertHelper_Bool::isBoolean($value); |
610 | 610 | } |
611 | 611 | |
612 | - /** |
|
613 | - * Converts an associative array to an HTML style attribute value string. |
|
614 | - * |
|
615 | - * @param array<string,mixed> $subject |
|
616 | - * @return string |
|
617 | - */ |
|
612 | + /** |
|
613 | + * Converts an associative array to an HTML style attribute value string. |
|
614 | + * |
|
615 | + * @param array<string,mixed> $subject |
|
616 | + * @return string |
|
617 | + */ |
|
618 | 618 | public static function array2styleString(array $subject) : string |
619 | 619 | { |
620 | 620 | return ConvertHelper_Array::toStyleString($subject); |
621 | 621 | } |
622 | 622 | |
623 | - /** |
|
624 | - * Converts a DateTime object to a timestamp, which |
|
625 | - * is PHP 5.2 compatible. |
|
626 | - * |
|
627 | - * @param DateTime $date |
|
628 | - * @return integer |
|
629 | - */ |
|
623 | + /** |
|
624 | + * Converts a DateTime object to a timestamp, which |
|
625 | + * is PHP 5.2 compatible. |
|
626 | + * |
|
627 | + * @param DateTime $date |
|
628 | + * @return integer |
|
629 | + */ |
|
630 | 630 | public static function date2timestamp(DateTime $date) : int |
631 | 631 | { |
632 | 632 | return ConvertHelper_Date::toTimestamp($date); |
633 | 633 | } |
634 | 634 | |
635 | - /** |
|
636 | - * Converts a timestamp into a DateTime instance. |
|
637 | - * @param int $timestamp |
|
638 | - * @return DateTime |
|
639 | - */ |
|
635 | + /** |
|
636 | + * Converts a timestamp into a DateTime instance. |
|
637 | + * @param int $timestamp |
|
638 | + * @return DateTime |
|
639 | + */ |
|
640 | 640 | public static function timestamp2date(int $timestamp) : DateTime |
641 | 641 | { |
642 | 642 | return ConvertHelper_Date::fromTimestamp($timestamp); |
643 | 643 | } |
644 | 644 | |
645 | - /** |
|
646 | - * Strips an absolute path to a file within the application |
|
647 | - * to make the path relative to the application root path. |
|
648 | - * |
|
649 | - * @param string $path |
|
650 | - * @return string |
|
651 | - * |
|
652 | - * @see FileHelper::relativizePath() |
|
653 | - * @see FileHelper::relativizePathByDepth() |
|
654 | - */ |
|
645 | + /** |
|
646 | + * Strips an absolute path to a file within the application |
|
647 | + * to make the path relative to the application root path. |
|
648 | + * |
|
649 | + * @param string $path |
|
650 | + * @return string |
|
651 | + * |
|
652 | + * @see FileHelper::relativizePath() |
|
653 | + * @see FileHelper::relativizePathByDepth() |
|
654 | + */ |
|
655 | 655 | public static function fileRelativize(string $path) : string |
656 | 656 | { |
657 | 657 | return FileHelper::relativizePathByDepth($path); |
658 | 658 | } |
659 | 659 | |
660 | 660 | /** |
661 | - * Converts a PHP regex to a javascript RegExp object statement. |
|
662 | - * |
|
663 | - * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
664 | - * More details are available on its usage there. |
|
665 | - * |
|
666 | - * @param string $regex A PHP preg regex |
|
667 | - * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
668 | - * @return string Depending on the specified return type. |
|
669 | - * |
|
670 | - * @see JSHelper::buildRegexStatement() |
|
671 | - */ |
|
661 | + * Converts a PHP regex to a javascript RegExp object statement. |
|
662 | + * |
|
663 | + * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
664 | + * More details are available on its usage there. |
|
665 | + * |
|
666 | + * @param string $regex A PHP preg regex |
|
667 | + * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
668 | + * @return string Depending on the specified return type. |
|
669 | + * |
|
670 | + * @see JSHelper::buildRegexStatement() |
|
671 | + */ |
|
672 | 672 | public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) : string |
673 | 673 | { |
674 | 674 | return JSHelper::buildRegexStatement($regex, $statementType); |
675 | 675 | } |
676 | 676 | |
677 | - /** |
|
678 | - * Converts the specified variable to JSON. Works just |
|
679 | - * like the native `json_encode` method, except that it |
|
680 | - * will trigger an exception on failure, which has the |
|
681 | - * json error details included in its developer details. |
|
682 | - * |
|
683 | - * @param mixed $variable |
|
684 | - * @param int $options JSON encode options. |
|
685 | - * @param int $depth |
|
686 | - * @return string |
|
687 | - * |
|
688 | - * @throws ConvertHelper_Exception |
|
689 | - * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED |
|
690 | - */ |
|
677 | + /** |
|
678 | + * Converts the specified variable to JSON. Works just |
|
679 | + * like the native `json_encode` method, except that it |
|
680 | + * will trigger an exception on failure, which has the |
|
681 | + * json error details included in its developer details. |
|
682 | + * |
|
683 | + * @param mixed $variable |
|
684 | + * @param int $options JSON encode options. |
|
685 | + * @param int $depth |
|
686 | + * @return string |
|
687 | + * |
|
688 | + * @throws ConvertHelper_Exception |
|
689 | + * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED |
|
690 | + */ |
|
691 | 691 | public static function var2json($variable, int $options=0, int $depth=512) : string |
692 | 692 | { |
693 | 693 | $result = json_encode($variable, $options, $depth); |
@@ -722,12 +722,12 @@ discard block |
||
722 | 722 | ->toString(); |
723 | 723 | } |
724 | 724 | |
725 | - /** |
|
726 | - * Strips all known UTF byte order marks from the specified string. |
|
727 | - * |
|
728 | - * @param string $string |
|
729 | - * @return string |
|
730 | - */ |
|
725 | + /** |
|
726 | + * Strips all known UTF byte order marks from the specified string. |
|
727 | + * |
|
728 | + * @param string $string |
|
729 | + * @return string |
|
730 | + */ |
|
731 | 731 | public static function stripUTFBom($string) |
732 | 732 | { |
733 | 733 | $boms = FileHelper::getUTFBOMs(); |
@@ -742,65 +742,65 @@ discard block |
||
742 | 742 | return $string; |
743 | 743 | } |
744 | 744 | |
745 | - /** |
|
746 | - * Converts a string to valid utf8, regardless |
|
747 | - * of the string's encoding(s). |
|
748 | - * |
|
749 | - * @param string $string |
|
750 | - * @return string |
|
751 | - */ |
|
745 | + /** |
|
746 | + * Converts a string to valid utf8, regardless |
|
747 | + * of the string's encoding(s). |
|
748 | + * |
|
749 | + * @param string $string |
|
750 | + * @return string |
|
751 | + */ |
|
752 | 752 | public static function string2utf8(string $string) : string |
753 | 753 | { |
754 | 754 | return ConvertHelper_String::toUtf8($string); |
755 | 755 | } |
756 | 756 | |
757 | - /** |
|
758 | - * Checks whether the specified string is an ASCII |
|
759 | - * string, without any special or UTF8 characters. |
|
760 | - * Note: empty strings and NULL are considered ASCII. |
|
761 | - * Any variable types other than strings are not. |
|
762 | - * |
|
763 | - * @param string|float|int|NULL $string |
|
764 | - * @return boolean |
|
765 | - */ |
|
757 | + /** |
|
758 | + * Checks whether the specified string is an ASCII |
|
759 | + * string, without any special or UTF8 characters. |
|
760 | + * Note: empty strings and NULL are considered ASCII. |
|
761 | + * Any variable types other than strings are not. |
|
762 | + * |
|
763 | + * @param string|float|int|NULL $string |
|
764 | + * @return boolean |
|
765 | + */ |
|
766 | 766 | public static function isStringASCII($string) : bool |
767 | 767 | { |
768 | 768 | return ConvertHelper_String::isASCII(strval($string)); |
769 | 769 | } |
770 | 770 | |
771 | - /** |
|
772 | - * Adds HTML syntax highlighting to an URL. |
|
773 | - * |
|
774 | - * NOTE: Includes the necessary CSS styles. When |
|
775 | - * highlighting several URLs in the same page, |
|
776 | - * prefer using the `parseURL` function instead. |
|
777 | - * |
|
778 | - * @param string $url |
|
779 | - * @return string |
|
780 | - * @deprecated Use the Highlighter class directly instead. |
|
781 | - * @see Highlighter |
|
782 | - */ |
|
771 | + /** |
|
772 | + * Adds HTML syntax highlighting to an URL. |
|
773 | + * |
|
774 | + * NOTE: Includes the necessary CSS styles. When |
|
775 | + * highlighting several URLs in the same page, |
|
776 | + * prefer using the `parseURL` function instead. |
|
777 | + * |
|
778 | + * @param string $url |
|
779 | + * @return string |
|
780 | + * @deprecated Use the Highlighter class directly instead. |
|
781 | + * @see Highlighter |
|
782 | + */ |
|
783 | 783 | public static function highlight_url(string $url) : string |
784 | 784 | { |
785 | 785 | return Highlighter::url($url); |
786 | 786 | } |
787 | 787 | |
788 | - /** |
|
789 | - * Calculates a percentage match of the source string with the target string. |
|
790 | - * |
|
791 | - * Options are: |
|
792 | - * |
|
793 | - * - maxLevenshtein, default: 10 |
|
794 | - * Any levenshtein results above this value are ignored. |
|
795 | - * |
|
796 | - * - precision, default: 1 |
|
797 | - * The precision of the percentage float value |
|
798 | - * |
|
799 | - * @param string $source |
|
800 | - * @param string $target |
|
801 | - * @param array<string,mixed> $options |
|
802 | - * @return float |
|
803 | - */ |
|
788 | + /** |
|
789 | + * Calculates a percentage match of the source string with the target string. |
|
790 | + * |
|
791 | + * Options are: |
|
792 | + * |
|
793 | + * - maxLevenshtein, default: 10 |
|
794 | + * Any levenshtein results above this value are ignored. |
|
795 | + * |
|
796 | + * - precision, default: 1 |
|
797 | + * The precision of the percentage float value |
|
798 | + * |
|
799 | + * @param string $source |
|
800 | + * @param string $target |
|
801 | + * @param array<string,mixed> $options |
|
802 | + * @return float |
|
803 | + */ |
|
804 | 804 | public static function matchString(string $source, string $target, array $options=array()) : float |
805 | 805 | { |
806 | 806 | $defaults = array( |
@@ -824,14 +824,14 @@ discard block |
||
824 | 824 | return round(100 - $percent, $options['precision']); |
825 | 825 | } |
826 | 826 | |
827 | - /** |
|
828 | - * Converts a date interval to a human readable string with |
|
829 | - * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
830 | - * |
|
831 | - * @param DateInterval $interval |
|
832 | - * @return string |
|
833 | - * @see ConvertHelper_IntervalConverter |
|
834 | - */ |
|
827 | + /** |
|
828 | + * Converts a date interval to a human readable string with |
|
829 | + * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
830 | + * |
|
831 | + * @param DateInterval $interval |
|
832 | + * @return string |
|
833 | + * @see ConvertHelper_IntervalConverter |
|
834 | + */ |
|
835 | 835 | public static function interval2string(DateInterval $interval) : string |
836 | 836 | { |
837 | 837 | $converter = new ConvertHelper_IntervalConverter(); |
@@ -843,92 +843,92 @@ discard block |
||
843 | 843 | const INTERVAL_MINUTES = 'minutes'; |
844 | 844 | const INTERVAL_SECONDS = 'seconds'; |
845 | 845 | |
846 | - /** |
|
847 | - * Converts an interval to its total amount of days. |
|
848 | - * @param DateInterval $interval |
|
849 | - * @return int |
|
850 | - */ |
|
846 | + /** |
|
847 | + * Converts an interval to its total amount of days. |
|
848 | + * @param DateInterval $interval |
|
849 | + * @return int |
|
850 | + */ |
|
851 | 851 | public static function interval2days(DateInterval $interval) : int |
852 | 852 | { |
853 | 853 | return ConvertHelper_DateInterval::toDays($interval); |
854 | 854 | } |
855 | 855 | |
856 | - /** |
|
857 | - * Converts an interval to its total amount of hours. |
|
858 | - * @param DateInterval $interval |
|
859 | - * @return int |
|
860 | - */ |
|
856 | + /** |
|
857 | + * Converts an interval to its total amount of hours. |
|
858 | + * @param DateInterval $interval |
|
859 | + * @return int |
|
860 | + */ |
|
861 | 861 | public static function interval2hours(DateInterval $interval) : int |
862 | 862 | { |
863 | 863 | return ConvertHelper_DateInterval::toHours($interval); |
864 | 864 | } |
865 | 865 | |
866 | - /** |
|
867 | - * Converts an interval to its total amount of minutes. |
|
868 | - * @param DateInterval $interval |
|
869 | - * @return int |
|
870 | - */ |
|
866 | + /** |
|
867 | + * Converts an interval to its total amount of minutes. |
|
868 | + * @param DateInterval $interval |
|
869 | + * @return int |
|
870 | + */ |
|
871 | 871 | public static function interval2minutes(DateInterval $interval) : int |
872 | 872 | { |
873 | 873 | return ConvertHelper_DateInterval::toMinutes($interval); |
874 | 874 | } |
875 | 875 | |
876 | - /** |
|
877 | - * Converts an interval to its total amount of seconds. |
|
878 | - * @param DateInterval $interval |
|
879 | - * @return int |
|
880 | - */ |
|
876 | + /** |
|
877 | + * Converts an interval to its total amount of seconds. |
|
878 | + * @param DateInterval $interval |
|
879 | + * @return int |
|
880 | + */ |
|
881 | 881 | public static function interval2seconds(DateInterval $interval) : int |
882 | 882 | { |
883 | 883 | return ConvertHelper_DateInterval::toSeconds($interval); |
884 | 884 | } |
885 | 885 | |
886 | - /** |
|
887 | - * Calculates the total amount of days / hours / minutes or seconds |
|
888 | - * of a date interval object (depending on the specified units), and |
|
889 | - * returns the total amount. |
|
890 | - * |
|
891 | - * @param DateInterval $interval |
|
892 | - * @param string $unit What total value to calculate. |
|
893 | - * @return integer |
|
894 | - * |
|
895 | - * @see ConvertHelper::INTERVAL_SECONDS |
|
896 | - * @see ConvertHelper::INTERVAL_MINUTES |
|
897 | - * @see ConvertHelper::INTERVAL_HOURS |
|
898 | - * @see ConvertHelper::INTERVAL_DAYS |
|
899 | - */ |
|
886 | + /** |
|
887 | + * Calculates the total amount of days / hours / minutes or seconds |
|
888 | + * of a date interval object (depending on the specified units), and |
|
889 | + * returns the total amount. |
|
890 | + * |
|
891 | + * @param DateInterval $interval |
|
892 | + * @param string $unit What total value to calculate. |
|
893 | + * @return integer |
|
894 | + * |
|
895 | + * @see ConvertHelper::INTERVAL_SECONDS |
|
896 | + * @see ConvertHelper::INTERVAL_MINUTES |
|
897 | + * @see ConvertHelper::INTERVAL_HOURS |
|
898 | + * @see ConvertHelper::INTERVAL_DAYS |
|
899 | + */ |
|
900 | 900 | public static function interval2total(DateInterval $interval, string $unit=self::INTERVAL_SECONDS) : int |
901 | 901 | { |
902 | 902 | return ConvertHelper_DateInterval::toTotal($interval, $unit); |
903 | 903 | } |
904 | 904 | |
905 | - /** |
|
906 | - * Converts a date to the corresponding day name. |
|
907 | - * |
|
908 | - * @param DateTime $date |
|
909 | - * @param bool $short |
|
910 | - * @return string|NULL |
|
911 | - */ |
|
905 | + /** |
|
906 | + * Converts a date to the corresponding day name. |
|
907 | + * |
|
908 | + * @param DateTime $date |
|
909 | + * @param bool $short |
|
910 | + * @return string|NULL |
|
911 | + */ |
|
912 | 912 | public static function date2dayName(DateTime $date, bool $short=false) : ?string |
913 | 913 | { |
914 | 914 | return ConvertHelper_Date::toDayName($date, $short); |
915 | 915 | } |
916 | 916 | |
917 | - /** |
|
918 | - * Retrieves a list of english day names. |
|
919 | - * @return string[] |
|
920 | - */ |
|
917 | + /** |
|
918 | + * Retrieves a list of english day names. |
|
919 | + * @return string[] |
|
920 | + */ |
|
921 | 921 | public static function getDayNamesInvariant() : array |
922 | 922 | { |
923 | 923 | return ConvertHelper_Date::getDayNamesInvariant(); |
924 | 924 | } |
925 | 925 | |
926 | - /** |
|
927 | - * Retrieves the day names list for the current locale. |
|
928 | - * |
|
929 | - * @param bool $short |
|
930 | - * @return string[] |
|
931 | - */ |
|
926 | + /** |
|
927 | + * Retrieves the day names list for the current locale. |
|
928 | + * |
|
929 | + * @param bool $short |
|
930 | + * @return string[] |
|
931 | + */ |
|
932 | 932 | public static function getDayNames(bool $short=false) : array |
933 | 933 | { |
934 | 934 | return ConvertHelper_Date::getDayNames($short); |
@@ -947,68 +947,68 @@ discard block |
||
947 | 947 | return ConvertHelper_Array::implodeWithAnd($list, $sep, $conjunction); |
948 | 948 | } |
949 | 949 | |
950 | - /** |
|
951 | - * Splits a string into an array of all characters it is composed of. |
|
952 | - * Unicode character safe. |
|
953 | - * |
|
954 | - * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
955 | - * characters. |
|
956 | - * |
|
957 | - * @param string $string |
|
958 | - * @return string[] |
|
959 | - */ |
|
950 | + /** |
|
951 | + * Splits a string into an array of all characters it is composed of. |
|
952 | + * Unicode character safe. |
|
953 | + * |
|
954 | + * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
955 | + * characters. |
|
956 | + * |
|
957 | + * @param string $string |
|
958 | + * @return string[] |
|
959 | + */ |
|
960 | 960 | public static function string2array(string $string) : array |
961 | 961 | { |
962 | 962 | return ConvertHelper_String::toArray($string); |
963 | 963 | } |
964 | 964 | |
965 | - /** |
|
966 | - * Checks whether the specified string contains HTML code. |
|
967 | - * |
|
968 | - * @param string $string |
|
969 | - * @return boolean |
|
970 | - */ |
|
965 | + /** |
|
966 | + * Checks whether the specified string contains HTML code. |
|
967 | + * |
|
968 | + * @param string $string |
|
969 | + * @return boolean |
|
970 | + */ |
|
971 | 971 | public static function isStringHTML(string $string) : bool |
972 | 972 | { |
973 | 973 | return ConvertHelper_String::isHTML($string); |
974 | 974 | } |
975 | 975 | |
976 | - /** |
|
977 | - * UTF8-safe wordwrap method: works like the regular wordwrap |
|
978 | - * PHP function but compatible with UTF8. Otherwise the lengths |
|
979 | - * are not calculated correctly. |
|
980 | - * |
|
981 | - * @param string $str |
|
982 | - * @param int $width |
|
983 | - * @param string $break |
|
984 | - * @param bool $cut |
|
985 | - * @return string |
|
986 | - */ |
|
976 | + /** |
|
977 | + * UTF8-safe wordwrap method: works like the regular wordwrap |
|
978 | + * PHP function but compatible with UTF8. Otherwise the lengths |
|
979 | + * are not calculated correctly. |
|
980 | + * |
|
981 | + * @param string $str |
|
982 | + * @param int $width |
|
983 | + * @param string $break |
|
984 | + * @param bool $cut |
|
985 | + * @return string |
|
986 | + */ |
|
987 | 987 | public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string |
988 | 988 | { |
989 | 989 | return ConvertHelper_String::wordwrap($str, $width, $break, $cut); |
990 | 990 | } |
991 | 991 | |
992 | - /** |
|
993 | - * Calculates the byte length of a string, taking into |
|
994 | - * account any unicode characters. |
|
995 | - * |
|
996 | - * @param string $string |
|
997 | - * @return int |
|
998 | - */ |
|
992 | + /** |
|
993 | + * Calculates the byte length of a string, taking into |
|
994 | + * account any unicode characters. |
|
995 | + * |
|
996 | + * @param string $string |
|
997 | + * @return int |
|
998 | + */ |
|
999 | 999 | public static function string2bytes(string $string): int |
1000 | 1000 | { |
1001 | 1001 | return ConvertHelper_String::toBytes($string); |
1002 | 1002 | } |
1003 | 1003 | |
1004 | - /** |
|
1005 | - * Creates a short, 8-character long hash for the specified string. |
|
1006 | - * |
|
1007 | - * WARNING: Not cryptographically safe. |
|
1008 | - * |
|
1009 | - * @param string $string |
|
1010 | - * @return string |
|
1011 | - */ |
|
1004 | + /** |
|
1005 | + * Creates a short, 8-character long hash for the specified string. |
|
1006 | + * |
|
1007 | + * WARNING: Not cryptographically safe. |
|
1008 | + * |
|
1009 | + * @param string $string |
|
1010 | + * @return string |
|
1011 | + */ |
|
1012 | 1012 | public static function string2shortHash(string $string) : string |
1013 | 1013 | { |
1014 | 1014 | return ConvertHelper_String::toShortHash($string); |
@@ -1054,88 +1054,88 @@ discard block |
||
1054 | 1054 | return ConvertHelper_ThrowableInfo::fromThrowable($e); |
1055 | 1055 | } |
1056 | 1056 | |
1057 | - /** |
|
1058 | - * Parses the specified query string like the native |
|
1059 | - * function <code>parse_str</code>, without the key |
|
1060 | - * naming limitations. |
|
1061 | - * |
|
1062 | - * Using parse_str, dots or spaces in key names are |
|
1063 | - * replaced by underscores. This method keeps all names |
|
1064 | - * intact. |
|
1065 | - * |
|
1066 | - * It still uses the parse_str implementation as it |
|
1067 | - * is tested and tried, but fixes the parameter names |
|
1068 | - * after parsing, as needed. |
|
1069 | - * |
|
1070 | - * @param string $queryString |
|
1071 | - * @return array<string,string> |
|
1072 | - * @see ConvertHelper_QueryParser |
|
1073 | - */ |
|
1057 | + /** |
|
1058 | + * Parses the specified query string like the native |
|
1059 | + * function <code>parse_str</code>, without the key |
|
1060 | + * naming limitations. |
|
1061 | + * |
|
1062 | + * Using parse_str, dots or spaces in key names are |
|
1063 | + * replaced by underscores. This method keeps all names |
|
1064 | + * intact. |
|
1065 | + * |
|
1066 | + * It still uses the parse_str implementation as it |
|
1067 | + * is tested and tried, but fixes the parameter names |
|
1068 | + * after parsing, as needed. |
|
1069 | + * |
|
1070 | + * @param string $queryString |
|
1071 | + * @return array<string,string> |
|
1072 | + * @see ConvertHelper_QueryParser |
|
1073 | + */ |
|
1074 | 1074 | public static function parseQueryString(string $queryString) : array |
1075 | 1075 | { |
1076 | 1076 | $parser = new ConvertHelper_QueryParser(); |
1077 | 1077 | return $parser->parse($queryString); |
1078 | 1078 | } |
1079 | 1079 | |
1080 | - /** |
|
1081 | - * Searches for needle in the specified string, and returns a list |
|
1082 | - * of all occurrences, including the matched string. The matched |
|
1083 | - * string is useful when doing a case insensitive search, as it |
|
1084 | - * shows the exact matched case of needle. |
|
1085 | - * |
|
1086 | - * @param string $needle |
|
1087 | - * @param string $haystack |
|
1088 | - * @param bool $caseInsensitive |
|
1089 | - * @return ConvertHelper_StringMatch[] |
|
1090 | - */ |
|
1080 | + /** |
|
1081 | + * Searches for needle in the specified string, and returns a list |
|
1082 | + * of all occurrences, including the matched string. The matched |
|
1083 | + * string is useful when doing a case insensitive search, as it |
|
1084 | + * shows the exact matched case of needle. |
|
1085 | + * |
|
1086 | + * @param string $needle |
|
1087 | + * @param string $haystack |
|
1088 | + * @param bool $caseInsensitive |
|
1089 | + * @return ConvertHelper_StringMatch[] |
|
1090 | + */ |
|
1091 | 1091 | public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array |
1092 | 1092 | { |
1093 | 1093 | return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive); |
1094 | 1094 | } |
1095 | 1095 | |
1096 | - /** |
|
1097 | - * Like explode, but trims all entries, and removes |
|
1098 | - * empty entries from the resulting array. |
|
1099 | - * |
|
1100 | - * @param string $delimiter |
|
1101 | - * @param string $string |
|
1102 | - * @return string[] |
|
1103 | - */ |
|
1096 | + /** |
|
1097 | + * Like explode, but trims all entries, and removes |
|
1098 | + * empty entries from the resulting array. |
|
1099 | + * |
|
1100 | + * @param string $delimiter |
|
1101 | + * @param string $string |
|
1102 | + * @return string[] |
|
1103 | + */ |
|
1104 | 1104 | public static function explodeTrim(string $delimiter, string $string) : array |
1105 | 1105 | { |
1106 | 1106 | return ConvertHelper_String::explodeTrim($delimiter, $string); |
1107 | 1107 | } |
1108 | 1108 | |
1109 | - /** |
|
1110 | - * Detects the most used end-of-line character in the subject string. |
|
1111 | - * |
|
1112 | - * @param string $subjectString The string to check. |
|
1113 | - * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1114 | - */ |
|
1109 | + /** |
|
1110 | + * Detects the most used end-of-line character in the subject string. |
|
1111 | + * |
|
1112 | + * @param string $subjectString The string to check. |
|
1113 | + * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1114 | + */ |
|
1115 | 1115 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1116 | 1116 | { |
1117 | 1117 | return ConvertHelper_EOL::detect($subjectString); |
1118 | 1118 | } |
1119 | 1119 | |
1120 | - /** |
|
1121 | - * Removes the specified keys from the target array, |
|
1122 | - * if they exist. |
|
1123 | - * |
|
1124 | - * @param array<string|int,mixed> $array |
|
1125 | - * @param string[] $keys |
|
1126 | - */ |
|
1120 | + /** |
|
1121 | + * Removes the specified keys from the target array, |
|
1122 | + * if they exist. |
|
1123 | + * |
|
1124 | + * @param array<string|int,mixed> $array |
|
1125 | + * @param string[] $keys |
|
1126 | + */ |
|
1127 | 1127 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1128 | 1128 | { |
1129 | 1129 | ConvertHelper_Array::removeKeys($array, $keys); |
1130 | 1130 | } |
1131 | 1131 | |
1132 | - /** |
|
1133 | - * Checks if the specified variable is an integer or a string containing an integer. |
|
1134 | - * Accepts both positive and negative integers. |
|
1135 | - * |
|
1136 | - * @param mixed $value |
|
1137 | - * @return bool |
|
1138 | - */ |
|
1132 | + /** |
|
1133 | + * Checks if the specified variable is an integer or a string containing an integer. |
|
1134 | + * Accepts both positive and negative integers. |
|
1135 | + * |
|
1136 | + * @param mixed $value |
|
1137 | + * @return bool |
|
1138 | + */ |
|
1139 | 1139 | public static function isInteger($value) : bool |
1140 | 1140 | { |
1141 | 1141 | if(is_int($value)) { |
@@ -1155,52 +1155,52 @@ discard block |
||
1155 | 1155 | return false; |
1156 | 1156 | } |
1157 | 1157 | |
1158 | - /** |
|
1159 | - * Converts an amount of seconds to a DateInterval object. |
|
1160 | - * |
|
1161 | - * @param int $seconds |
|
1162 | - * @return DateInterval |
|
1163 | - * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1164 | - * |
|
1165 | - * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1166 | - */ |
|
1158 | + /** |
|
1159 | + * Converts an amount of seconds to a DateInterval object. |
|
1160 | + * |
|
1161 | + * @param int $seconds |
|
1162 | + * @return DateInterval |
|
1163 | + * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1164 | + * |
|
1165 | + * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1166 | + */ |
|
1167 | 1167 | public static function seconds2interval(int $seconds) : DateInterval |
1168 | 1168 | { |
1169 | 1169 | return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval(); |
1170 | 1170 | } |
1171 | 1171 | |
1172 | - /** |
|
1173 | - * Converts a size string like "50 MB" to the corresponding byte size. |
|
1174 | - * It is case-insensitive, ignores spaces, and supports both traditional |
|
1175 | - * "MB" and "MiB" notations. |
|
1176 | - * |
|
1177 | - * @param string $size |
|
1178 | - * @return int |
|
1179 | - */ |
|
1172 | + /** |
|
1173 | + * Converts a size string like "50 MB" to the corresponding byte size. |
|
1174 | + * It is case-insensitive, ignores spaces, and supports both traditional |
|
1175 | + * "MB" and "MiB" notations. |
|
1176 | + * |
|
1177 | + * @param string $size |
|
1178 | + * @return int |
|
1179 | + */ |
|
1180 | 1180 | public static function size2bytes(string $size) : int |
1181 | 1181 | { |
1182 | 1182 | return self::parseSize($size)->toBytes(); |
1183 | 1183 | } |
1184 | 1184 | |
1185 | - /** |
|
1186 | - * Parses a size string like "50 MB" and returns a size notation instance |
|
1187 | - * that has utility methods to access information on it, and convert it. |
|
1188 | - * |
|
1189 | - * @param string $size |
|
1190 | - * @return ConvertHelper_SizeNotation |
|
1191 | - */ |
|
1185 | + /** |
|
1186 | + * Parses a size string like "50 MB" and returns a size notation instance |
|
1187 | + * that has utility methods to access information on it, and convert it. |
|
1188 | + * |
|
1189 | + * @param string $size |
|
1190 | + * @return ConvertHelper_SizeNotation |
|
1191 | + */ |
|
1192 | 1192 | public static function parseSize(string $size) : ConvertHelper_SizeNotation |
1193 | 1193 | { |
1194 | 1194 | return new ConvertHelper_SizeNotation($size); |
1195 | 1195 | } |
1196 | 1196 | |
1197 | - /** |
|
1198 | - * Creates a URL finder instance, which can be used to find |
|
1199 | - * URLs in a string - be it plain text, or HTML. |
|
1200 | - * |
|
1201 | - * @param string $subject |
|
1202 | - * @return ConvertHelper_URLFinder |
|
1203 | - */ |
|
1197 | + /** |
|
1198 | + * Creates a URL finder instance, which can be used to find |
|
1199 | + * URLs in a string - be it plain text, or HTML. |
|
1200 | + * |
|
1201 | + * @param string $subject |
|
1202 | + * @return ConvertHelper_URLFinder |
|
1203 | + */ |
|
1204 | 1204 | public static function createURLFinder(string $subject) : ConvertHelper_URLFinder |
1205 | 1205 | { |
1206 | 1206 | 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 ConvertHelper_String::tabs2spaces($string, $tabSize); |
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 ConvertHelper_String::spaces2tabs($string, $tabSize); |
68 | 68 | } |
@@ -135,7 +135,7 @@ discard block |
||
135 | 135 | * @deprecated Use the Highlighter class directly instead. |
136 | 136 | * @see Highlighter::xml() |
137 | 137 | */ |
138 | - public static function highlight_xml(string $xml, bool $formatSource=false) : string |
|
138 | + public static function highlight_xml(string $xml, bool $formatSource = false) : string |
|
139 | 139 | { |
140 | 140 | return Highlighter::xml($xml, $formatSource); |
141 | 141 | } |
@@ -201,11 +201,11 @@ discard block |
||
201 | 201 | * @param bool $html |
202 | 202 | * @return string |
203 | 203 | */ |
204 | - public static function var_dump($var, bool $html=true) : string |
|
204 | + public static function var_dump($var, bool $html = true) : string |
|
205 | 205 | { |
206 | 206 | $info = parseVariable($var); |
207 | 207 | |
208 | - if($html) { |
|
208 | + if ($html) { |
|
209 | 209 | return $info->toHTML(); |
210 | 210 | } |
211 | 211 | |
@@ -220,11 +220,11 @@ discard block |
||
220 | 220 | * @param bool $html Whether to style the dump as HTML. |
221 | 221 | * @return string |
222 | 222 | */ |
223 | - public static function print_r($var, bool $return=false, bool $html=true) : string |
|
223 | + public static function print_r($var, bool $return = false, bool $html = true) : string |
|
224 | 224 | { |
225 | 225 | $result = parseVariable($var)->enableType()->toString(); |
226 | 226 | |
227 | - if($html) |
|
227 | + if ($html) |
|
228 | 228 | { |
229 | 229 | $result = |
230 | 230 | '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'. |
@@ -232,7 +232,7 @@ discard block |
||
232 | 232 | '</pre>'; |
233 | 233 | } |
234 | 234 | |
235 | - if(!$return) |
|
235 | + if (!$return) |
|
236 | 236 | { |
237 | 237 | echo $result; |
238 | 238 | } |
@@ -413,12 +413,12 @@ discard block |
||
413 | 413 | $output = ''; |
414 | 414 | $split = str_split($unicodeChar); |
415 | 415 | |
416 | - foreach($split as $octet) |
|
416 | + foreach ($split as $octet) |
|
417 | 417 | { |
418 | 418 | $ordInt = ord($octet); |
419 | 419 | // Convert from int (base 10) to hex (base 16), for PHP \x syntax |
420 | 420 | $ordHex = base_convert((string)$ordInt, 10, 16); |
421 | - $output .= '\x' . $ordHex; |
|
421 | + $output .= '\x'.$ordHex; |
|
422 | 422 | } |
423 | 423 | |
424 | 424 | return $output; |
@@ -471,19 +471,19 @@ discard block |
||
471 | 471 | */ |
472 | 472 | protected static function convertScalarForComparison($scalar) : ?string |
473 | 473 | { |
474 | - if($scalar === '' || is_null($scalar)) { |
|
474 | + if ($scalar === '' || is_null($scalar)) { |
|
475 | 475 | return null; |
476 | 476 | } |
477 | 477 | |
478 | - if(is_bool($scalar)) { |
|
478 | + if (is_bool($scalar)) { |
|
479 | 479 | return self::bool2string($scalar); |
480 | 480 | } |
481 | 481 | |
482 | - if(is_array($scalar)) { |
|
482 | + if (is_array($scalar)) { |
|
483 | 483 | $scalar = md5(serialize($scalar)); |
484 | 484 | } |
485 | 485 | |
486 | - if($scalar !== null && !is_scalar($scalar)) { |
|
486 | + if ($scalar !== null && !is_scalar($scalar)) { |
|
487 | 487 | throw new ConvertHelper_Exception( |
488 | 488 | 'Not a scalar value in comparison', |
489 | 489 | null, |
@@ -669,7 +669,7 @@ discard block |
||
669 | 669 | * |
670 | 670 | * @see JSHelper::buildRegexStatement() |
671 | 671 | */ |
672 | - public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) : string |
|
672 | + public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) : string |
|
673 | 673 | { |
674 | 674 | return JSHelper::buildRegexStatement($regex, $statementType); |
675 | 675 | } |
@@ -688,11 +688,11 @@ discard block |
||
688 | 688 | * @throws ConvertHelper_Exception |
689 | 689 | * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED |
690 | 690 | */ |
691 | - public static function var2json($variable, int $options=0, int $depth=512) : string |
|
691 | + public static function var2json($variable, int $options = 0, int $depth = 512) : string |
|
692 | 692 | { |
693 | 693 | $result = json_encode($variable, $options, $depth); |
694 | 694 | |
695 | - if($result !== false) { |
|
695 | + if ($result !== false) { |
|
696 | 696 | return $result; |
697 | 697 | } |
698 | 698 | |
@@ -731,10 +731,10 @@ discard block |
||
731 | 731 | public static function stripUTFBom($string) |
732 | 732 | { |
733 | 733 | $boms = FileHelper::getUTFBOMs(); |
734 | - foreach($boms as $bomChars) { |
|
734 | + foreach ($boms as $bomChars) { |
|
735 | 735 | $length = mb_strlen($bomChars); |
736 | 736 | $text = mb_substr($string, 0, $length); |
737 | - if($text==$bomChars) { |
|
737 | + if ($text == $bomChars) { |
|
738 | 738 | return mb_substr($string, $length); |
739 | 739 | } |
740 | 740 | } |
@@ -801,7 +801,7 @@ discard block |
||
801 | 801 | * @param array<string,mixed> $options |
802 | 802 | * @return float |
803 | 803 | */ |
804 | - public static function matchString(string $source, string $target, array $options=array()) : float |
|
804 | + public static function matchString(string $source, string $target, array $options = array()) : float |
|
805 | 805 | { |
806 | 806 | $defaults = array( |
807 | 807 | 'maxLevenshtein' => 10, |
@@ -811,12 +811,12 @@ discard block |
||
811 | 811 | $options = array_merge($defaults, $options); |
812 | 812 | |
813 | 813 | // avoid doing this via levenshtein |
814 | - if($source == $target) { |
|
814 | + if ($source == $target) { |
|
815 | 815 | return 100; |
816 | 816 | } |
817 | 817 | |
818 | 818 | $diff = levenshtein($source, $target); |
819 | - if($diff > $options['maxLevenshtein']) { |
|
819 | + if ($diff > $options['maxLevenshtein']) { |
|
820 | 820 | return 0; |
821 | 821 | } |
822 | 822 | |
@@ -897,7 +897,7 @@ discard block |
||
897 | 897 | * @see ConvertHelper::INTERVAL_HOURS |
898 | 898 | * @see ConvertHelper::INTERVAL_DAYS |
899 | 899 | */ |
900 | - public static function interval2total(DateInterval $interval, string $unit=self::INTERVAL_SECONDS) : int |
|
900 | + public static function interval2total(DateInterval $interval, string $unit = self::INTERVAL_SECONDS) : int |
|
901 | 901 | { |
902 | 902 | return ConvertHelper_DateInterval::toTotal($interval, $unit); |
903 | 903 | } |
@@ -909,7 +909,7 @@ discard block |
||
909 | 909 | * @param bool $short |
910 | 910 | * @return string|NULL |
911 | 911 | */ |
912 | - public static function date2dayName(DateTime $date, bool $short=false) : ?string |
|
912 | + public static function date2dayName(DateTime $date, bool $short = false) : ?string |
|
913 | 913 | { |
914 | 914 | return ConvertHelper_Date::toDayName($date, $short); |
915 | 915 | } |
@@ -929,7 +929,7 @@ discard block |
||
929 | 929 | * @param bool $short |
930 | 930 | * @return string[] |
931 | 931 | */ |
932 | - public static function getDayNames(bool $short=false) : array |
|
932 | + public static function getDayNames(bool $short = false) : array |
|
933 | 933 | { |
934 | 934 | return ConvertHelper_Date::getDayNames($short); |
935 | 935 | } |
@@ -1088,7 +1088,7 @@ discard block |
||
1088 | 1088 | * @param bool $caseInsensitive |
1089 | 1089 | * @return ConvertHelper_StringMatch[] |
1090 | 1090 | */ |
1091 | - public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array |
|
1091 | + public static function findString(string $needle, string $haystack, bool $caseInsensitive = false): array |
|
1092 | 1092 | { |
1093 | 1093 | return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive); |
1094 | 1094 | } |
@@ -1138,17 +1138,17 @@ discard block |
||
1138 | 1138 | */ |
1139 | 1139 | public static function isInteger($value) : bool |
1140 | 1140 | { |
1141 | - if(is_int($value)) { |
|
1141 | + if (is_int($value)) { |
|
1142 | 1142 | return true; |
1143 | 1143 | } |
1144 | 1144 | |
1145 | 1145 | // booleans get converted to numbers, so they would |
1146 | 1146 | // actually match the regex. |
1147 | - if(is_bool($value)) { |
|
1147 | + if (is_bool($value)) { |
|
1148 | 1148 | return false; |
1149 | 1149 | } |
1150 | 1150 | |
1151 | - if(is_string($value) && $value !== '') { |
|
1151 | + if (is_string($value) && $value !== '') { |
|
1152 | 1152 | return preg_match('/\A-?\d+\z/', $value) === 1; |
1153 | 1153 | } |
1154 | 1154 | |
@@ -1214,7 +1214,7 @@ discard block |
||
1214 | 1214 | * @param bool $keepKeys |
1215 | 1215 | * @return array<number|string,mixed> |
1216 | 1216 | */ |
1217 | - public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys=false) : array |
|
1217 | + public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys = false) : array |
|
1218 | 1218 | { |
1219 | 1219 | return ConvertHelper_Array::removeValues($sourceArray, $values, $keepKeys); |
1220 | 1220 | } |
@@ -41,14 +41,14 @@ discard block |
||
41 | 41 | const TOKEN_MONTHS = 'm'; |
42 | 42 | const TOKEN_YEARS = 'y'; |
43 | 43 | |
44 | - /** |
|
45 | - * @var DateInterval |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var DateInterval |
|
46 | + */ |
|
47 | 47 | protected $interval; |
48 | 48 | |
49 | - /** |
|
50 | - * @var int |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var int |
|
51 | + */ |
|
52 | 52 | protected $seconds; |
53 | 53 | |
54 | 54 | /** |
@@ -92,22 +92,22 @@ discard block |
||
92 | 92 | return new ConvertHelper_DateInterval($seconds); |
93 | 93 | } |
94 | 94 | |
95 | - /** |
|
96 | - * Creates the interval from an existing regular interval instance. |
|
97 | - * |
|
98 | - * @param DateInterval $interval |
|
99 | - * @return ConvertHelper_DateInterval |
|
100 | - */ |
|
95 | + /** |
|
96 | + * Creates the interval from an existing regular interval instance. |
|
97 | + * |
|
98 | + * @param DateInterval $interval |
|
99 | + * @return ConvertHelper_DateInterval |
|
100 | + */ |
|
101 | 101 | public static function fromInterval(DateInterval $interval) |
102 | 102 | { |
103 | 103 | return self::fromSeconds(ConvertHelper::interval2seconds($interval)); |
104 | 104 | } |
105 | 105 | |
106 | - /** |
|
107 | - * Retrieves the PHP native date interval. |
|
108 | - * |
|
109 | - * @return DateInterval |
|
110 | - */ |
|
106 | + /** |
|
107 | + * Retrieves the PHP native date interval. |
|
108 | + * |
|
109 | + * @return DateInterval |
|
110 | + */ |
|
111 | 111 | public function getInterval() : DateInterval |
112 | 112 | { |
113 | 113 | return $this->interval; |
@@ -143,31 +143,31 @@ discard block |
||
143 | 143 | return $this->getToken(self::TOKEN_YEARS); |
144 | 144 | } |
145 | 145 | |
146 | - /** |
|
147 | - * Retrieves a specific time token, e.g. "h" (for hours). |
|
148 | - * Using the constants to specifiy the tokens is recommended. |
|
149 | - * |
|
150 | - * @param string $token |
|
151 | - * @return int |
|
152 | - * |
|
153 | - * @see ConvertHelper_DateInterval::TOKEN_SECONDS |
|
154 | - * @see ConvertHelper_DateInterval::TOKEN_MINUTES |
|
155 | - * @see ConvertHelper_DateInterval::TOKEN_HOURS |
|
156 | - * @see ConvertHelper_DateInterval::TOKEN_DAYS |
|
157 | - * @see ConvertHelper_DateInterval::TOKEN_MONTHS |
|
158 | - * @see ConvertHelper_DateInterval::TOKEN_YEARS |
|
159 | - */ |
|
146 | + /** |
|
147 | + * Retrieves a specific time token, e.g. "h" (for hours). |
|
148 | + * Using the constants to specifiy the tokens is recommended. |
|
149 | + * |
|
150 | + * @param string $token |
|
151 | + * @return int |
|
152 | + * |
|
153 | + * @see ConvertHelper_DateInterval::TOKEN_SECONDS |
|
154 | + * @see ConvertHelper_DateInterval::TOKEN_MINUTES |
|
155 | + * @see ConvertHelper_DateInterval::TOKEN_HOURS |
|
156 | + * @see ConvertHelper_DateInterval::TOKEN_DAYS |
|
157 | + * @see ConvertHelper_DateInterval::TOKEN_MONTHS |
|
158 | + * @see ConvertHelper_DateInterval::TOKEN_YEARS |
|
159 | + */ |
|
160 | 160 | public function getToken(string $token) : int |
161 | 161 | { |
162 | 162 | return (int)$this->interval->$token; |
163 | 163 | } |
164 | 164 | |
165 | - /** |
|
166 | - * The total amount of seconds in the interval (including |
|
167 | - * everything, from seconds to days, months, years...). |
|
168 | - * |
|
169 | - * @return int |
|
170 | - */ |
|
165 | + /** |
|
166 | + * The total amount of seconds in the interval (including |
|
167 | + * everything, from seconds to days, months, years...). |
|
168 | + * |
|
169 | + * @return int |
|
170 | + */ |
|
171 | 171 | public function getTotalSeconds() : int |
172 | 172 | { |
173 | 173 | return $this->seconds; |
@@ -68,7 +68,7 @@ discard block |
||
68 | 68 | |
69 | 69 | $interval = $d2->diff($d1); |
70 | 70 | |
71 | - if(!$interval instanceof DateInterval) |
|
71 | + if (!$interval instanceof DateInterval) |
|
72 | 72 | { |
73 | 73 | throw new ConvertHelper_Exception( |
74 | 74 | 'Cannot create interval', |
@@ -187,24 +187,24 @@ discard block |
||
187 | 187 | * @see ConvertHelper::INTERVAL_HOURS |
188 | 188 | * @see ConvertHelper::INTERVAL_DAYS |
189 | 189 | */ |
190 | - public static function toTotal(DateInterval $interval, string $unit=ConvertHelper::INTERVAL_SECONDS) : int |
|
190 | + public static function toTotal(DateInterval $interval, string $unit = ConvertHelper::INTERVAL_SECONDS) : int |
|
191 | 191 | { |
192 | 192 | $total = (int)$interval->format('%a'); |
193 | 193 | if ($unit == ConvertHelper::INTERVAL_DAYS) { |
194 | 194 | return $total; |
195 | 195 | } |
196 | 196 | |
197 | - $total = ($total * 24) + ((int)$interval->h ); |
|
197 | + $total = ($total * 24) + ((int)$interval->h); |
|
198 | 198 | if ($unit == ConvertHelper::INTERVAL_HOURS) { |
199 | 199 | return $total; |
200 | 200 | } |
201 | 201 | |
202 | - $total = ($total * 60) + ((int)$interval->i ); |
|
202 | + $total = ($total * 60) + ((int)$interval->i); |
|
203 | 203 | if ($unit == ConvertHelper::INTERVAL_MINUTES) { |
204 | 204 | return $total; |
205 | 205 | } |
206 | 206 | |
207 | - $total = ($total * 60) + ((int)$interval->s ); |
|
207 | + $total = ($total * 60) + ((int)$interval->s); |
|
208 | 208 | if ($unit == ConvertHelper::INTERVAL_SECONDS) { |
209 | 209 | return $total; |
210 | 210 | } |