@@ -26,31 +26,31 @@ discard block |
||
26 | 26 | const ERROR_NO_DATE_FROM_SET = 43401; |
27 | 27 | |
28 | 28 | |
29 | - /** |
|
30 | - * @var int |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var int |
|
31 | + */ |
|
32 | 32 | protected $dateFrom; |
33 | 33 | |
34 | - /** |
|
35 | - * @var int |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var int |
|
36 | + */ |
|
37 | 37 | protected $dateTo; |
38 | 38 | |
39 | 39 | public function __construct() |
40 | 40 | { |
41 | 41 | } |
42 | 42 | |
43 | - /** |
|
44 | - * Sets the origin date to calculate from. |
|
45 | - * |
|
46 | - * NOTE: if this is further in the future than |
|
47 | - * the to: date, it will be considered as a |
|
48 | - * calculation for something to come, i.e. |
|
49 | - * "In two days". |
|
50 | - * |
|
51 | - * @param \DateTime $date |
|
52 | - * @return ConvertHelper_DurationConverter |
|
53 | - */ |
|
43 | + /** |
|
44 | + * Sets the origin date to calculate from. |
|
45 | + * |
|
46 | + * NOTE: if this is further in the future than |
|
47 | + * the to: date, it will be considered as a |
|
48 | + * calculation for something to come, i.e. |
|
49 | + * "In two days". |
|
50 | + * |
|
51 | + * @param \DateTime $date |
|
52 | + * @return ConvertHelper_DurationConverter |
|
53 | + */ |
|
54 | 54 | public function setDateFrom(\DateTime $date) : ConvertHelper_DurationConverter |
55 | 55 | { |
56 | 56 | $this->dateFrom = ConvertHelper::date2timestamp($date); |
@@ -58,13 +58,13 @@ discard block |
||
58 | 58 | return $this; |
59 | 59 | } |
60 | 60 | |
61 | - /** |
|
62 | - * Sets the date to calculate to. Defaults to |
|
63 | - * the current time if not set. |
|
64 | - * |
|
65 | - * @param \DateTime $date |
|
66 | - * @return ConvertHelper_DurationConverter |
|
67 | - */ |
|
61 | + /** |
|
62 | + * Sets the date to calculate to. Defaults to |
|
63 | + * the current time if not set. |
|
64 | + * |
|
65 | + * @param \DateTime $date |
|
66 | + * @return ConvertHelper_DurationConverter |
|
67 | + */ |
|
68 | 68 | public function setDateTo(\DateTime $date) : ConvertHelper_DurationConverter |
69 | 69 | { |
70 | 70 | $this->dateTo = ConvertHelper::date2timestamp($date); |
@@ -72,14 +72,14 @@ discard block |
||
72 | 72 | return $this; |
73 | 73 | } |
74 | 74 | |
75 | - /** |
|
76 | - * Converts the specified dates to a human readable string. |
|
77 | - * |
|
78 | - * @throws ConvertHelper_Exception |
|
79 | - * @return string |
|
80 | - * |
|
81 | - * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
82 | - */ |
|
75 | + /** |
|
76 | + * Converts the specified dates to a human readable string. |
|
77 | + * |
|
78 | + * @throws ConvertHelper_Exception |
|
79 | + * @return string |
|
80 | + * |
|
81 | + * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
82 | + */ |
|
83 | 83 | public function convert() : string |
84 | 84 | { |
85 | 85 | if(!isset($this->dateFrom)) |
@@ -82,7 +82,7 @@ discard block |
||
82 | 82 | */ |
83 | 83 | public function convert() : string |
84 | 84 | { |
85 | - if(!isset($this->dateFrom)) |
|
85 | + if (!isset($this->dateFrom)) |
|
86 | 86 | { |
87 | 87 | throw new ConvertHelper_Exception( |
88 | 88 | 'No date from has been specified.', |
@@ -92,7 +92,7 @@ discard block |
||
92 | 92 | } |
93 | 93 | |
94 | 94 | // no date to set? Assume we want to use today. |
95 | - if(!isset($this->dateTo)) |
|
95 | + if (!isset($this->dateTo)) |
|
96 | 96 | { |
97 | 97 | $this->dateTo = time(); |
98 | 98 | } |
@@ -105,7 +105,7 @@ discard block |
||
105 | 105 | $interval = ""; |
106 | 106 | |
107 | 107 | $future = false; |
108 | - if($difference < 0) |
|
108 | + if ($difference < 0) |
|
109 | 109 | { |
110 | 110 | $difference = $difference * -1; |
111 | 111 | $future = true; |
@@ -181,7 +181,7 @@ discard block |
||
181 | 181 | $day = (int)date("j", $this->dateTo); |
182 | 182 | $year = (int)date("Y", $this->dateFrom); |
183 | 183 | |
184 | - while(mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $this->dateTo) |
|
184 | + while (mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $this->dateTo) |
|
185 | 185 | { |
186 | 186 | $months_difference++; |
187 | 187 | } |
@@ -196,7 +196,7 @@ discard block |
||
196 | 196 | $datediff--; |
197 | 197 | } |
198 | 198 | |
199 | - if($future) { |
|
199 | + if ($future) { |
|
200 | 200 | $result = ($datediff == 1) ? t('In one month', $datediff) : t('In %1s months', $datediff); |
201 | 201 | } else { |
202 | 202 | $result = ($datediff == 1) ? t('One month ago', $datediff) : t('%1s months ago', $datediff); |
@@ -205,7 +205,7 @@ discard block |
||
205 | 205 | |
206 | 206 | case "y": |
207 | 207 | $datediff = floor($difference / 60 / 60 / 24 / 365); |
208 | - if($future) { |
|
208 | + if ($future) { |
|
209 | 209 | $result = ($datediff == 1) ? t('In one year', $datediff) : t('In %1s years', $datediff); |
210 | 210 | } else { |
211 | 211 | $result = ($datediff == 1) ? t('One year ago', $datediff) : t('%1s years ago', $datediff); |
@@ -214,7 +214,7 @@ discard block |
||
214 | 214 | |
215 | 215 | case "d": |
216 | 216 | $datediff = floor($difference / 60 / 60 / 24); |
217 | - if($future) { |
|
217 | + if ($future) { |
|
218 | 218 | $result = ($datediff == 1) ? t('In one day', $datediff) : t('In %1s days', $datediff); |
219 | 219 | } else { |
220 | 220 | $result = ($datediff == 1) ? t('One day ago', $datediff) : t('%1s days ago', $datediff); |
@@ -223,7 +223,7 @@ discard block |
||
223 | 223 | |
224 | 224 | case "ww": |
225 | 225 | $datediff = floor($difference / 60 / 60 / 24 / 7); |
226 | - if($future) { |
|
226 | + if ($future) { |
|
227 | 227 | $result = ($datediff == 1) ? t('In one week', $datediff) : t('In %1s weeks', $datediff); |
228 | 228 | } else { |
229 | 229 | $result = ($datediff == 1) ? t('One week ago', $datediff) : t('%1s weeks ago', $datediff); |
@@ -232,7 +232,7 @@ discard block |
||
232 | 232 | |
233 | 233 | case "h": |
234 | 234 | $datediff = floor($difference / 60 / 60); |
235 | - if($future) { |
|
235 | + if ($future) { |
|
236 | 236 | $result = ($datediff == 1) ? t('In one hour', $datediff) : t('In %1s hours', $datediff); |
237 | 237 | } else { |
238 | 238 | $result = ($datediff == 1) ? t('One hour ago', $datediff) : t('%1s hours ago', $datediff); |
@@ -241,7 +241,7 @@ discard block |
||
241 | 241 | |
242 | 242 | case "n": |
243 | 243 | $datediff = floor($difference / 60); |
244 | - if($future) { |
|
244 | + if ($future) { |
|
245 | 245 | $result = ($datediff == 1) ? t('In one minute', $datediff) : t('In %1s minutes', $datediff); |
246 | 246 | } else { |
247 | 247 | $result = ($datediff == 1) ? t('One minute ago', $datediff) : t('%1s minutes ago', $datediff); |
@@ -250,7 +250,7 @@ discard block |
||
250 | 250 | |
251 | 251 | case "s": |
252 | 252 | $datediff = $difference; |
253 | - if($future) { |
|
253 | + if ($future) { |
|
254 | 254 | $result = ($datediff == 1) ? t('In one second', $datediff) : t('In %1s seconds', $datediff); |
255 | 255 | } else { |
256 | 256 | $result = ($datediff == 1) ? t('One second ago', $datediff) : t('%1s seconds ago', $datediff); |
@@ -162,41 +162,41 @@ discard block |
||
162 | 162 | return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
163 | 163 | } |
164 | 164 | |
165 | - /** |
|
166 | - * Converts a timestamp into an easily understandable |
|
167 | - * format, e.g. "2 hours", "1 day", "3 months" |
|
168 | - * |
|
169 | - * If you set the date to parameter, the difference |
|
170 | - * will be calculated between the two dates and not |
|
171 | - * the current time. |
|
172 | - * |
|
173 | - * @param integer|\DateTime $datefrom |
|
174 | - * @param integer|\DateTime $dateto |
|
175 | - * @return string |
|
176 | - */ |
|
165 | + /** |
|
166 | + * Converts a timestamp into an easily understandable |
|
167 | + * format, e.g. "2 hours", "1 day", "3 months" |
|
168 | + * |
|
169 | + * If you set the date to parameter, the difference |
|
170 | + * will be calculated between the two dates and not |
|
171 | + * the current time. |
|
172 | + * |
|
173 | + * @param integer|\DateTime $datefrom |
|
174 | + * @param integer|\DateTime $dateto |
|
175 | + * @return string |
|
176 | + */ |
|
177 | 177 | public static function duration2string($datefrom, $dateto = -1) : string |
178 | 178 | { |
179 | - $converter = new ConvertHelper_DurationConverter(); |
|
179 | + $converter = new ConvertHelper_DurationConverter(); |
|
180 | 180 | |
181 | - if($datefrom instanceof \DateTime) |
|
182 | - { |
|
183 | - $converter->setDateFrom($datefrom); |
|
184 | - } |
|
185 | - else |
|
186 | - { |
|
187 | - $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
188 | - } |
|
189 | - |
|
190 | - if($dateto instanceof \DateTime) |
|
191 | - { |
|
192 | - $converter->setDateTo($dateto); |
|
193 | - } |
|
194 | - else if($dateto > 0) |
|
195 | - { |
|
196 | - $converter->setDateTo(self::timestamp2date($dateto)); |
|
197 | - } |
|
198 | - |
|
199 | - return $converter->convert(); |
|
181 | + if($datefrom instanceof \DateTime) |
|
182 | + { |
|
183 | + $converter->setDateFrom($datefrom); |
|
184 | + } |
|
185 | + else |
|
186 | + { |
|
187 | + $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
188 | + } |
|
189 | + |
|
190 | + if($dateto instanceof \DateTime) |
|
191 | + { |
|
192 | + $converter->setDateTo($dateto); |
|
193 | + } |
|
194 | + else if($dateto > 0) |
|
195 | + { |
|
196 | + $converter->setDateTo(self::timestamp2date($dateto)); |
|
197 | + } |
|
198 | + |
|
199 | + return $converter->convert(); |
|
200 | 200 | } |
201 | 201 | |
202 | 202 | /** |
@@ -269,16 +269,16 @@ discard block |
||
269 | 269 | return $bytes . ' ' . t('B'); |
270 | 270 | } |
271 | 271 | |
272 | - /** |
|
273 | - * Cuts a text to the specified length if it is longer than the |
|
274 | - * target length. Appends a text to signify it has been cut at |
|
275 | - * the end of the string. |
|
276 | - * |
|
277 | - * @param string $text |
|
278 | - * @param int $targetLength |
|
279 | - * @param string $append |
|
280 | - * @return string |
|
281 | - */ |
|
272 | + /** |
|
273 | + * Cuts a text to the specified length if it is longer than the |
|
274 | + * target length. Appends a text to signify it has been cut at |
|
275 | + * the end of the string. |
|
276 | + * |
|
277 | + * @param string $text |
|
278 | + * @param int $targetLength |
|
279 | + * @param string $append |
|
280 | + * @return string |
|
281 | + */ |
|
282 | 282 | public static function text_cut(string $text, int $targetLength, string $append = '...') : string |
283 | 283 | { |
284 | 284 | $length = mb_strlen($text); |
@@ -348,27 +348,27 @@ discard block |
||
348 | 348 | return self::$booleanStrings[$string]; |
349 | 349 | } |
350 | 350 | |
351 | - /** |
|
352 | - * Whether the specified string is a boolean string or boolean value. |
|
353 | - * Alias for {@link ConvertHelper::isBoolean()}. |
|
354 | - * |
|
355 | - * @param mixed $string |
|
356 | - * @return bool |
|
357 | - * @deprecated |
|
358 | - * @see ConvertHelper::isBoolean() |
|
359 | - */ |
|
351 | + /** |
|
352 | + * Whether the specified string is a boolean string or boolean value. |
|
353 | + * Alias for {@link ConvertHelper::isBoolean()}. |
|
354 | + * |
|
355 | + * @param mixed $string |
|
356 | + * @return bool |
|
357 | + * @deprecated |
|
358 | + * @see ConvertHelper::isBoolean() |
|
359 | + */ |
|
360 | 360 | public static function isBooleanString($string) : bool |
361 | 361 | { |
362 | 362 | return self::isBoolean($string); |
363 | 363 | } |
364 | 364 | |
365 | - /** |
|
366 | - * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
367 | - * |
|
368 | - * @param string $text |
|
369 | - * @return string |
|
370 | - * @deprecated |
|
371 | - */ |
|
365 | + /** |
|
366 | + * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
367 | + * |
|
368 | + * @param string $text |
|
369 | + * @return string |
|
370 | + * @deprecated |
|
371 | + */ |
|
372 | 372 | public static function text_makeXMLCompliant($text) |
373 | 373 | { |
374 | 374 | return XMLHelper::string2xml($text); |
@@ -470,13 +470,13 @@ discard block |
||
470 | 470 | return $translit->convert($string); |
471 | 471 | } |
472 | 472 | |
473 | - /** |
|
474 | - * Retrieves the HEX character codes for all control |
|
475 | - * characters that the {@link stripControlCharacters()} |
|
476 | - * method will remove. |
|
477 | - * |
|
478 | - * @return string[] |
|
479 | - */ |
|
473 | + /** |
|
474 | + * Retrieves the HEX character codes for all control |
|
475 | + * characters that the {@link stripControlCharacters()} |
|
476 | + * method will remove. |
|
477 | + * |
|
478 | + * @return string[] |
|
479 | + */ |
|
480 | 480 | public static function getControlCharactersAsHex() |
481 | 481 | { |
482 | 482 | $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'); |
@@ -512,13 +512,13 @@ discard block |
||
512 | 512 | return $stack; |
513 | 513 | } |
514 | 514 | |
515 | - /** |
|
516 | - * Retrieves an array of all control characters that |
|
517 | - * the {@link stripControlCharacters()} method will |
|
518 | - * remove, as the actual UTF-8 characters. |
|
519 | - * |
|
520 | - * @return string[] |
|
521 | - */ |
|
515 | + /** |
|
516 | + * Retrieves an array of all control characters that |
|
517 | + * the {@link stripControlCharacters()} method will |
|
518 | + * remove, as the actual UTF-8 characters. |
|
519 | + * |
|
520 | + * @return string[] |
|
521 | + */ |
|
522 | 522 | public static function getControlCharactersAsUTF8() |
523 | 523 | { |
524 | 524 | $chars = self::getControlCharactersAsHex(); |
@@ -531,12 +531,12 @@ discard block |
||
531 | 531 | return $result; |
532 | 532 | } |
533 | 533 | |
534 | - /** |
|
535 | - * Retrieves all control characters as JSON encoded |
|
536 | - * characters, e.g. "\u200b". |
|
537 | - * |
|
538 | - * @return string[] |
|
539 | - */ |
|
534 | + /** |
|
535 | + * Retrieves all control characters as JSON encoded |
|
536 | + * characters, e.g. "\u200b". |
|
537 | + * |
|
538 | + * @return string[] |
|
539 | + */ |
|
540 | 540 | public static function getControlCharactersAsJSON() |
541 | 541 | { |
542 | 542 | $chars = self::getControlCharactersAsHex(); |
@@ -593,20 +593,20 @@ discard block |
||
593 | 593 | return preg_replace(self::$controlCharsRegex, '', $string); |
594 | 594 | } |
595 | 595 | |
596 | - /** |
|
597 | - * Converts a unicode character to the PHPO notation. |
|
598 | - * |
|
599 | - * Example: |
|
600 | - * |
|
601 | - * <pre>unicodeChar2php('"\u0000"')</pre> |
|
602 | - * |
|
603 | - * Returns |
|
604 | - * |
|
605 | - * <pre>\x0</pre> |
|
606 | - * |
|
607 | - * @param string $unicodeChar |
|
608 | - * @return string |
|
609 | - */ |
|
596 | + /** |
|
597 | + * Converts a unicode character to the PHPO notation. |
|
598 | + * |
|
599 | + * Example: |
|
600 | + * |
|
601 | + * <pre>unicodeChar2php('"\u0000"')</pre> |
|
602 | + * |
|
603 | + * Returns |
|
604 | + * |
|
605 | + * <pre>\x0</pre> |
|
606 | + * |
|
607 | + * @param string $unicodeChar |
|
608 | + * @return string |
|
609 | + */ |
|
610 | 610 | public static function unicodeChar2php($unicodeChar) |
611 | 611 | { |
612 | 612 | $unicodeChar = json_decode($unicodeChar); |
@@ -729,25 +729,25 @@ discard block |
||
729 | 729 | return 'false'; |
730 | 730 | } |
731 | 731 | |
732 | - /** |
|
733 | - * Converts an associative array with attribute name > value pairs |
|
734 | - * to an attribute string that can be used in an HTML tag. Empty |
|
735 | - * attribute values are ignored. |
|
736 | - * |
|
737 | - * Example: |
|
738 | - * |
|
739 | - * array2attributeString(array( |
|
740 | - * 'id' => 45, |
|
741 | - * 'href' => 'http://www.mistralys.com' |
|
742 | - * )); |
|
743 | - * |
|
744 | - * Result: |
|
745 | - * |
|
746 | - * id="45" href="http://www.mistralys.com" |
|
747 | - * |
|
748 | - * @param array $array |
|
749 | - * @return string |
|
750 | - */ |
|
732 | + /** |
|
733 | + * Converts an associative array with attribute name > value pairs |
|
734 | + * to an attribute string that can be used in an HTML tag. Empty |
|
735 | + * attribute values are ignored. |
|
736 | + * |
|
737 | + * Example: |
|
738 | + * |
|
739 | + * array2attributeString(array( |
|
740 | + * 'id' => 45, |
|
741 | + * 'href' => 'http://www.mistralys.com' |
|
742 | + * )); |
|
743 | + * |
|
744 | + * Result: |
|
745 | + * |
|
746 | + * id="45" href="http://www.mistralys.com" |
|
747 | + * |
|
748 | + * @param array $array |
|
749 | + * @return string |
|
750 | + */ |
|
751 | 751 | public static function array2attributeString($array) |
752 | 752 | { |
753 | 753 | $tokens = array(); |
@@ -766,14 +766,14 @@ discard block |
||
766 | 766 | return ' '.implode(' ', $tokens); |
767 | 767 | } |
768 | 768 | |
769 | - /** |
|
770 | - * Converts a string so it can safely be used in a javascript |
|
771 | - * statement in an HTML tag: uses single quotes around the string |
|
772 | - * and encodes all special characters as needed. |
|
773 | - * |
|
774 | - * @param string $string |
|
775 | - * @return string |
|
776 | - */ |
|
769 | + /** |
|
770 | + * Converts a string so it can safely be used in a javascript |
|
771 | + * statement in an HTML tag: uses single quotes around the string |
|
772 | + * and encodes all special characters as needed. |
|
773 | + * |
|
774 | + * @param string $string |
|
775 | + * @return string |
|
776 | + */ |
|
777 | 777 | public static function string2attributeJS($string, $quoted=true) |
778 | 778 | { |
779 | 779 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
@@ -784,15 +784,15 @@ discard block |
||
784 | 784 | return $converted; |
785 | 785 | } |
786 | 786 | |
787 | - /** |
|
788 | - * Checks if the specified string is a boolean value, which |
|
789 | - * includes string representations of boolean values, like |
|
790 | - * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
791 | - * or <code>false</code>. |
|
792 | - * |
|
793 | - * @param mixed $value |
|
794 | - * @return boolean |
|
795 | - */ |
|
787 | + /** |
|
788 | + * Checks if the specified string is a boolean value, which |
|
789 | + * includes string representations of boolean values, like |
|
790 | + * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
791 | + * or <code>false</code>. |
|
792 | + * |
|
793 | + * @param mixed $value |
|
794 | + * @return boolean |
|
795 | + */ |
|
796 | 796 | public static function isBoolean($value) : bool |
797 | 797 | { |
798 | 798 | if(is_bool($value)) { |
@@ -806,12 +806,12 @@ discard block |
||
806 | 806 | return array_key_exists($value, self::$booleanStrings); |
807 | 807 | } |
808 | 808 | |
809 | - /** |
|
810 | - * Converts an associative array to an HTML style attribute value string. |
|
811 | - * |
|
812 | - * @param array $subject |
|
813 | - * @return string |
|
814 | - */ |
|
809 | + /** |
|
810 | + * Converts an associative array to an HTML style attribute value string. |
|
811 | + * |
|
812 | + * @param array $subject |
|
813 | + * @return string |
|
814 | + */ |
|
815 | 815 | public static function array2styleString(array $subject) : string |
816 | 816 | { |
817 | 817 | $tokens = array(); |
@@ -822,23 +822,23 @@ discard block |
||
822 | 822 | return implode(';', $tokens); |
823 | 823 | } |
824 | 824 | |
825 | - /** |
|
826 | - * Converts a DateTime object to a timestamp, which |
|
827 | - * is PHP 5.2 compatible. |
|
828 | - * |
|
829 | - * @param \DateTime $date |
|
830 | - * @return integer |
|
831 | - */ |
|
825 | + /** |
|
826 | + * Converts a DateTime object to a timestamp, which |
|
827 | + * is PHP 5.2 compatible. |
|
828 | + * |
|
829 | + * @param \DateTime $date |
|
830 | + * @return integer |
|
831 | + */ |
|
832 | 832 | public static function date2timestamp(\DateTime $date) : int |
833 | 833 | { |
834 | 834 | return (int)$date->format('U'); |
835 | 835 | } |
836 | 836 | |
837 | - /** |
|
838 | - * Converts a timestamp into a DateTime instance. |
|
839 | - * @param int $timestamp |
|
840 | - * @return \DateTime |
|
841 | - */ |
|
837 | + /** |
|
838 | + * Converts a timestamp into a DateTime instance. |
|
839 | + * @param int $timestamp |
|
840 | + * @return \DateTime |
|
841 | + */ |
|
842 | 842 | public static function timestamp2date(int $timestamp) : \DateTime |
843 | 843 | { |
844 | 844 | $date = new \DateTime(); |
@@ -846,50 +846,50 @@ discard block |
||
846 | 846 | return $date; |
847 | 847 | } |
848 | 848 | |
849 | - /** |
|
850 | - * Strips an absolute path to a file within the application |
|
851 | - * to make the path relative to the application root path. |
|
852 | - * |
|
853 | - * @param string $path |
|
854 | - * @return string |
|
855 | - * |
|
856 | - * @see FileHelper::relativizePath() |
|
857 | - * @see FileHelper::relativizePathByDepth() |
|
858 | - */ |
|
849 | + /** |
|
850 | + * Strips an absolute path to a file within the application |
|
851 | + * to make the path relative to the application root path. |
|
852 | + * |
|
853 | + * @param string $path |
|
854 | + * @return string |
|
855 | + * |
|
856 | + * @see FileHelper::relativizePath() |
|
857 | + * @see FileHelper::relativizePathByDepth() |
|
858 | + */ |
|
859 | 859 | public static function fileRelativize(string $path) : string |
860 | 860 | { |
861 | 861 | return FileHelper::relativizePathByDepth($path); |
862 | 862 | } |
863 | 863 | |
864 | 864 | /** |
865 | - * Converts a PHP regex to a javascript RegExp object statement. |
|
866 | - * |
|
867 | - * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
868 | - * More details are available on its usage there. |
|
869 | - * |
|
870 | - * @param string $regex A PHP preg regex |
|
871 | - * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
872 | - * @return array|string Depending on the specified return type. |
|
873 | - * |
|
874 | - * @see JSHelper::buildRegexStatement() |
|
875 | - */ |
|
865 | + * Converts a PHP regex to a javascript RegExp object statement. |
|
866 | + * |
|
867 | + * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
868 | + * More details are available on its usage there. |
|
869 | + * |
|
870 | + * @param string $regex A PHP preg regex |
|
871 | + * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
872 | + * @return array|string Depending on the specified return type. |
|
873 | + * |
|
874 | + * @see JSHelper::buildRegexStatement() |
|
875 | + */ |
|
876 | 876 | public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
877 | 877 | { |
878 | 878 | return JSHelper::buildRegexStatement($regex, $statementType); |
879 | 879 | } |
880 | 880 | |
881 | - /** |
|
882 | - * Converts the specified variable to JSON. Works just |
|
883 | - * like the native `json_encode` method, except that it |
|
884 | - * will trigger an exception on failure, which has the |
|
885 | - * json error details included in its developer details. |
|
886 | - * |
|
887 | - * @param mixed $variable |
|
888 | - * @param int|NULL $options JSON encode options. |
|
889 | - * @param int|NULL $depth |
|
890 | - * @throws ConvertHelper_Exception |
|
891 | - * @return string |
|
892 | - */ |
|
881 | + /** |
|
882 | + * Converts the specified variable to JSON. Works just |
|
883 | + * like the native `json_encode` method, except that it |
|
884 | + * will trigger an exception on failure, which has the |
|
885 | + * json error details included in its developer details. |
|
886 | + * |
|
887 | + * @param mixed $variable |
|
888 | + * @param int|NULL $options JSON encode options. |
|
889 | + * @param int|NULL $depth |
|
890 | + * @throws ConvertHelper_Exception |
|
891 | + * @return string |
|
892 | + */ |
|
893 | 893 | public static function var2json($variable, int $options=0, int $depth=512) : string |
894 | 894 | { |
895 | 895 | $result = json_encode($variable, $options, $depth); |
@@ -910,12 +910,12 @@ discard block |
||
910 | 910 | ); |
911 | 911 | } |
912 | 912 | |
913 | - /** |
|
914 | - * Strips all known UTF byte order marks from the specified string. |
|
915 | - * |
|
916 | - * @param string $string |
|
917 | - * @return string |
|
918 | - */ |
|
913 | + /** |
|
914 | + * Strips all known UTF byte order marks from the specified string. |
|
915 | + * |
|
916 | + * @param string $string |
|
917 | + * @return string |
|
918 | + */ |
|
919 | 919 | public static function stripUTFBom($string) |
920 | 920 | { |
921 | 921 | $boms = FileHelper::getUTFBOMs(); |
@@ -930,13 +930,13 @@ discard block |
||
930 | 930 | return $string; |
931 | 931 | } |
932 | 932 | |
933 | - /** |
|
934 | - * Converts a string to valid utf8, regardless |
|
935 | - * of the string's encoding(s). |
|
936 | - * |
|
937 | - * @param string $string |
|
938 | - * @return string |
|
939 | - */ |
|
933 | + /** |
|
934 | + * Converts a string to valid utf8, regardless |
|
935 | + * of the string's encoding(s). |
|
936 | + * |
|
937 | + * @param string $string |
|
938 | + * @return string |
|
939 | + */ |
|
940 | 940 | public static function string2utf8($string) |
941 | 941 | { |
942 | 942 | if(!self::isStringASCII($string)) { |
@@ -946,15 +946,15 @@ discard block |
||
946 | 946 | return $string; |
947 | 947 | } |
948 | 948 | |
949 | - /** |
|
950 | - * Checks whether the specified string is an ASCII |
|
951 | - * string, without any special or UTF8 characters. |
|
952 | - * Note: empty strings and NULL are considered ASCII. |
|
953 | - * Any variable types other than strings are not. |
|
954 | - * |
|
955 | - * @param mixed $string |
|
956 | - * @return boolean |
|
957 | - */ |
|
949 | + /** |
|
950 | + * Checks whether the specified string is an ASCII |
|
951 | + * string, without any special or UTF8 characters. |
|
952 | + * Note: empty strings and NULL are considered ASCII. |
|
953 | + * Any variable types other than strings are not. |
|
954 | + * |
|
955 | + * @param mixed $string |
|
956 | + * @return boolean |
|
957 | + */ |
|
958 | 958 | public static function isStringASCII($string) : bool |
959 | 959 | { |
960 | 960 | if($string === '' || $string === NULL) { |
@@ -979,22 +979,22 @@ discard block |
||
979 | 979 | return $url; |
980 | 980 | } |
981 | 981 | |
982 | - /** |
|
983 | - * Calculates a percentage match of the source string with the target string. |
|
984 | - * |
|
985 | - * Options are: |
|
986 | - * |
|
987 | - * - maxLevenshtein, default: 10 |
|
988 | - * Any levenshtein results above this value are ignored. |
|
989 | - * |
|
990 | - * - precision, default: 1 |
|
991 | - * The precision of the percentage float value |
|
992 | - * |
|
993 | - * @param string $source |
|
994 | - * @param string $target |
|
995 | - * @param array $options |
|
996 | - * @return float |
|
997 | - */ |
|
982 | + /** |
|
983 | + * Calculates a percentage match of the source string with the target string. |
|
984 | + * |
|
985 | + * Options are: |
|
986 | + * |
|
987 | + * - maxLevenshtein, default: 10 |
|
988 | + * Any levenshtein results above this value are ignored. |
|
989 | + * |
|
990 | + * - precision, default: 1 |
|
991 | + * The precision of the percentage float value |
|
992 | + * |
|
993 | + * @param string $source |
|
994 | + * @param string $target |
|
995 | + * @param array $options |
|
996 | + * @return float |
|
997 | + */ |
|
998 | 998 | public static function matchString($source, $target, $options=array()) |
999 | 999 | { |
1000 | 1000 | $defaults = array( |
@@ -1078,60 +1078,60 @@ discard block |
||
1078 | 1078 | |
1079 | 1079 | const INTERVAL_SECONDS = 'seconds'; |
1080 | 1080 | |
1081 | - /** |
|
1082 | - * Converts an interval to its total amount of days. |
|
1083 | - * @param \DateInterval $interval |
|
1084 | - * @return int |
|
1085 | - */ |
|
1081 | + /** |
|
1082 | + * Converts an interval to its total amount of days. |
|
1083 | + * @param \DateInterval $interval |
|
1084 | + * @return int |
|
1085 | + */ |
|
1086 | 1086 | public static function interval2days(\DateInterval $interval) : int |
1087 | 1087 | { |
1088 | 1088 | return self::interval2total($interval, self::INTERVAL_DAYS); |
1089 | 1089 | } |
1090 | 1090 | |
1091 | - /** |
|
1092 | - * Converts an interval to its total amount of hours. |
|
1093 | - * @param \DateInterval $interval |
|
1094 | - * @return int |
|
1095 | - */ |
|
1091 | + /** |
|
1092 | + * Converts an interval to its total amount of hours. |
|
1093 | + * @param \DateInterval $interval |
|
1094 | + * @return int |
|
1095 | + */ |
|
1096 | 1096 | public static function interval2hours(\DateInterval $interval) : int |
1097 | 1097 | { |
1098 | 1098 | return self::interval2total($interval, self::INTERVAL_HOURS); |
1099 | 1099 | } |
1100 | 1100 | |
1101 | - /** |
|
1102 | - * Converts an interval to its total amount of minutes. |
|
1103 | - * @param \DateInterval $interval |
|
1104 | - * @return int |
|
1105 | - */ |
|
1101 | + /** |
|
1102 | + * Converts an interval to its total amount of minutes. |
|
1103 | + * @param \DateInterval $interval |
|
1104 | + * @return int |
|
1105 | + */ |
|
1106 | 1106 | public static function interval2minutes(\DateInterval $interval) : int |
1107 | 1107 | { |
1108 | 1108 | return self::interval2total($interval, self::INTERVAL_MINUTES); |
1109 | 1109 | } |
1110 | 1110 | |
1111 | - /** |
|
1112 | - * Converts an interval to its total amount of seconds. |
|
1113 | - * @param \DateInterval $interval |
|
1114 | - * @return int |
|
1115 | - */ |
|
1111 | + /** |
|
1112 | + * Converts an interval to its total amount of seconds. |
|
1113 | + * @param \DateInterval $interval |
|
1114 | + * @return int |
|
1115 | + */ |
|
1116 | 1116 | public static function interval2seconds(\DateInterval $interval) : int |
1117 | 1117 | { |
1118 | 1118 | return self::interval2total($interval, self::INTERVAL_SECONDS); |
1119 | 1119 | } |
1120 | 1120 | |
1121 | - /** |
|
1122 | - * Calculates the total amount of days / hours / minutes or seconds |
|
1123 | - * of a date interval object (depending in the specified units), and |
|
1124 | - * returns the total amount. |
|
1125 | - * |
|
1126 | - * @param \DateInterval $interval |
|
1127 | - * @param string $unit What total value to calculate. |
|
1128 | - * @return integer |
|
1129 | - * |
|
1130 | - * @see ConvertHelper::INTERVAL_SECONDS |
|
1131 | - * @see ConvertHelper::INTERVAL_MINUTES |
|
1132 | - * @see ConvertHelper::INTERVAL_HOURS |
|
1133 | - * @see ConvertHelper::INTERVAL_DAYS |
|
1134 | - */ |
|
1121 | + /** |
|
1122 | + * Calculates the total amount of days / hours / minutes or seconds |
|
1123 | + * of a date interval object (depending in the specified units), and |
|
1124 | + * returns the total amount. |
|
1125 | + * |
|
1126 | + * @param \DateInterval $interval |
|
1127 | + * @param string $unit What total value to calculate. |
|
1128 | + * @return integer |
|
1129 | + * |
|
1130 | + * @see ConvertHelper::INTERVAL_SECONDS |
|
1131 | + * @see ConvertHelper::INTERVAL_MINUTES |
|
1132 | + * @see ConvertHelper::INTERVAL_HOURS |
|
1133 | + * @see ConvertHelper::INTERVAL_DAYS |
|
1134 | + */ |
|
1135 | 1135 | public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
1136 | 1136 | { |
1137 | 1137 | $total = $interval->format('%a'); |
@@ -1171,13 +1171,13 @@ discard block |
||
1171 | 1171 | 'Sunday' |
1172 | 1172 | ); |
1173 | 1173 | |
1174 | - /** |
|
1175 | - * Converts a date to the corresponding day name. |
|
1176 | - * |
|
1177 | - * @param \DateTime $date |
|
1178 | - * @param string $short |
|
1179 | - * @return string|NULL |
|
1180 | - */ |
|
1174 | + /** |
|
1175 | + * Converts a date to the corresponding day name. |
|
1176 | + * |
|
1177 | + * @param \DateTime $date |
|
1178 | + * @param string $short |
|
1179 | + * @return string|NULL |
|
1180 | + */ |
|
1181 | 1181 | public static function date2dayName(\DateTime $date, $short=false) |
1182 | 1182 | { |
1183 | 1183 | $day = $date->format('l'); |
@@ -1192,21 +1192,21 @@ discard block |
||
1192 | 1192 | return null; |
1193 | 1193 | } |
1194 | 1194 | |
1195 | - /** |
|
1196 | - * Retrieves a list of english day names. |
|
1197 | - * @return string[] |
|
1198 | - */ |
|
1195 | + /** |
|
1196 | + * Retrieves a list of english day names. |
|
1197 | + * @return string[] |
|
1198 | + */ |
|
1199 | 1199 | public static function getDayNamesInvariant() |
1200 | 1200 | { |
1201 | 1201 | return self::$daysInvariant; |
1202 | 1202 | } |
1203 | 1203 | |
1204 | - /** |
|
1205 | - * Retrieves the day names list for the current locale. |
|
1206 | - * |
|
1207 | - * @param string $short |
|
1208 | - * @return string[] |
|
1209 | - */ |
|
1204 | + /** |
|
1205 | + * Retrieves the day names list for the current locale. |
|
1206 | + * |
|
1207 | + * @param string $short |
|
1208 | + * @return string[] |
|
1209 | + */ |
|
1210 | 1210 | public static function getDayNames($short=false) |
1211 | 1211 | { |
1212 | 1212 | if($short) { |
@@ -1266,16 +1266,16 @@ discard block |
||
1266 | 1266 | return $last; |
1267 | 1267 | } |
1268 | 1268 | |
1269 | - /** |
|
1270 | - * Splits a string into an array of all characters it is composed of. |
|
1271 | - * Unicode character safe. |
|
1272 | - * |
|
1273 | - * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1274 | - * characters. |
|
1275 | - * |
|
1276 | - * @param string $string |
|
1277 | - * @return array |
|
1278 | - */ |
|
1269 | + /** |
|
1270 | + * Splits a string into an array of all characters it is composed of. |
|
1271 | + * Unicode character safe. |
|
1272 | + * |
|
1273 | + * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1274 | + * characters. |
|
1275 | + * |
|
1276 | + * @param string $string |
|
1277 | + * @return array |
|
1278 | + */ |
|
1279 | 1279 | public static function string2array(string $string) : array |
1280 | 1280 | { |
1281 | 1281 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
@@ -1286,12 +1286,12 @@ discard block |
||
1286 | 1286 | return array(); |
1287 | 1287 | } |
1288 | 1288 | |
1289 | - /** |
|
1290 | - * Checks whether the specified string contains HTML code. |
|
1291 | - * |
|
1292 | - * @param string $string |
|
1293 | - * @return boolean |
|
1294 | - */ |
|
1289 | + /** |
|
1290 | + * Checks whether the specified string contains HTML code. |
|
1291 | + * |
|
1292 | + * @param string $string |
|
1293 | + * @return boolean |
|
1294 | + */ |
|
1295 | 1295 | public static function isStringHTML(string $string) : bool |
1296 | 1296 | { |
1297 | 1297 | if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
@@ -1306,18 +1306,18 @@ discard block |
||
1306 | 1306 | return false; |
1307 | 1307 | } |
1308 | 1308 | |
1309 | - /** |
|
1310 | - * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1311 | - * PHP function but compatible with UTF8. Otherwise the lengths |
|
1312 | - * are no calculated correctly. |
|
1313 | - * |
|
1314 | - * @param string $str |
|
1315 | - * @param int $width |
|
1316 | - * @param string $break |
|
1317 | - * @param bool $cut |
|
1318 | - * @return string |
|
1319 | - * @see https://stackoverflow.com/a/4988494/2298192 |
|
1320 | - */ |
|
1309 | + /** |
|
1310 | + * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1311 | + * PHP function but compatible with UTF8. Otherwise the lengths |
|
1312 | + * are no calculated correctly. |
|
1313 | + * |
|
1314 | + * @param string $str |
|
1315 | + * @param int $width |
|
1316 | + * @param string $break |
|
1317 | + * @param bool $cut |
|
1318 | + * @return string |
|
1319 | + * @see https://stackoverflow.com/a/4988494/2298192 |
|
1320 | + */ |
|
1321 | 1321 | public static function wordwrap($str, $width = 75, $break = "\n", $cut = false) |
1322 | 1322 | { |
1323 | 1323 | $lines = explode($break, $str); |
@@ -1363,27 +1363,27 @@ discard block |
||
1363 | 1363 | return implode($break, $lines); |
1364 | 1364 | } |
1365 | 1365 | |
1366 | - /** |
|
1367 | - * Calculates the byte length of a string, taking into |
|
1368 | - * account any unicode characters. |
|
1369 | - * |
|
1370 | - * @param string $string |
|
1371 | - * @return int |
|
1372 | - * @see https://stackoverflow.com/a/9718273/2298192 |
|
1373 | - */ |
|
1366 | + /** |
|
1367 | + * Calculates the byte length of a string, taking into |
|
1368 | + * account any unicode characters. |
|
1369 | + * |
|
1370 | + * @param string $string |
|
1371 | + * @return int |
|
1372 | + * @see https://stackoverflow.com/a/9718273/2298192 |
|
1373 | + */ |
|
1374 | 1374 | public static function string2bytes($string) |
1375 | 1375 | { |
1376 | 1376 | return mb_strlen($string, '8bit'); |
1377 | 1377 | } |
1378 | 1378 | |
1379 | - /** |
|
1380 | - * Creates a short, 8-character long hash for the specified string. |
|
1381 | - * |
|
1382 | - * WARNING: Not cryptographically safe. |
|
1383 | - * |
|
1384 | - * @param string $string |
|
1385 | - * @return string |
|
1386 | - */ |
|
1379 | + /** |
|
1380 | + * Creates a short, 8-character long hash for the specified string. |
|
1381 | + * |
|
1382 | + * WARNING: Not cryptographically safe. |
|
1383 | + * |
|
1384 | + * @param string $string |
|
1385 | + * @return string |
|
1386 | + */ |
|
1387 | 1387 | public static function string2shortHash($string) |
1388 | 1388 | { |
1389 | 1389 | return hash('crc32', $string, false); |
@@ -1409,23 +1409,23 @@ discard block |
||
1409 | 1409 | return ConvertHelper_ThrowableInfo::fromThrowable($e); |
1410 | 1410 | } |
1411 | 1411 | |
1412 | - /** |
|
1413 | - * Parses the specified query string like the native |
|
1414 | - * function <code>parse_str</code>, without the key |
|
1415 | - * naming limitations. |
|
1416 | - * |
|
1417 | - * Using parse_str, dots or spaces in key names are |
|
1418 | - * replaced by underscores. This method keeps all names |
|
1419 | - * intact. |
|
1420 | - * |
|
1421 | - * It still uses the parse_str implementation as it |
|
1422 | - * is tested and tried, but fixes the parameter names |
|
1423 | - * after parsing, as needed. |
|
1424 | - * |
|
1425 | - * @param string $queryString |
|
1426 | - * @return array |
|
1427 | - * @see https://www.php.net/manual/en/function.parse-str.php |
|
1428 | - */ |
|
1412 | + /** |
|
1413 | + * Parses the specified query string like the native |
|
1414 | + * function <code>parse_str</code>, without the key |
|
1415 | + * naming limitations. |
|
1416 | + * |
|
1417 | + * Using parse_str, dots or spaces in key names are |
|
1418 | + * replaced by underscores. This method keeps all names |
|
1419 | + * intact. |
|
1420 | + * |
|
1421 | + * It still uses the parse_str implementation as it |
|
1422 | + * is tested and tried, but fixes the parameter names |
|
1423 | + * after parsing, as needed. |
|
1424 | + * |
|
1425 | + * @param string $queryString |
|
1426 | + * @return array |
|
1427 | + * @see https://www.php.net/manual/en/function.parse-str.php |
|
1428 | + */ |
|
1429 | 1429 | public static function parseQueryString(string $queryString) : array |
1430 | 1430 | { |
1431 | 1431 | // allow HTML entities notation |
@@ -1465,16 +1465,16 @@ discard block |
||
1465 | 1465 | $placeholders = array(); |
1466 | 1466 | foreach($paramNames as $paramName) |
1467 | 1467 | { |
1468 | - // create a unique placeholder name |
|
1469 | - $placeholder = '__PLACEHOLDER'.$counter.'__'; |
|
1468 | + // create a unique placeholder name |
|
1469 | + $placeholder = '__PLACEHOLDER'.$counter.'__'; |
|
1470 | 1470 | |
1471 | - // store the placeholder name to replace later |
|
1472 | - $table[$placeholder] = $paramName; |
|
1471 | + // store the placeholder name to replace later |
|
1472 | + $table[$placeholder] = $paramName; |
|
1473 | 1473 | |
1474 | - // add the placeholder to replace in the query string before parsing |
|
1475 | - $placeholders[$paramName.'='] = $placeholder.'='; |
|
1474 | + // add the placeholder to replace in the query string before parsing |
|
1475 | + $placeholders[$paramName.'='] = $placeholder.'='; |
|
1476 | 1476 | |
1477 | - $counter++; |
|
1477 | + $counter++; |
|
1478 | 1478 | } |
1479 | 1479 | |
1480 | 1480 | // next challenge: replacing the parameter names by placeholders |
@@ -1501,23 +1501,23 @@ discard block |
||
1501 | 1501 | |
1502 | 1502 | foreach($parsed as $name => $value) |
1503 | 1503 | { |
1504 | - $keep[$table[$name]] = $value; |
|
1504 | + $keep[$table[$name]] = $value; |
|
1505 | 1505 | } |
1506 | 1506 | |
1507 | 1507 | return $keep; |
1508 | 1508 | } |
1509 | 1509 | |
1510 | - /** |
|
1511 | - * Searches for needle in the specified string, and returns a list |
|
1512 | - * of all occurrences, including the matched string. The matched |
|
1513 | - * string is useful when doing a case insensitive search, as it |
|
1514 | - * shows the exact matched case of needle. |
|
1515 | - * |
|
1516 | - * @param string $needle |
|
1517 | - * @param string $haystack |
|
1518 | - * @param bool $caseInsensitive |
|
1519 | - * @return ConvertHelper_StringMatch[] |
|
1520 | - */ |
|
1510 | + /** |
|
1511 | + * Searches for needle in the specified string, and returns a list |
|
1512 | + * of all occurrences, including the matched string. The matched |
|
1513 | + * string is useful when doing a case insensitive search, as it |
|
1514 | + * shows the exact matched case of needle. |
|
1515 | + * |
|
1516 | + * @param string $needle |
|
1517 | + * @param string $haystack |
|
1518 | + * @param bool $caseInsensitive |
|
1519 | + * @return ConvertHelper_StringMatch[] |
|
1520 | + */ |
|
1521 | 1521 | public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
1522 | 1522 | { |
1523 | 1523 | if($needle === '') { |
@@ -1543,14 +1543,14 @@ discard block |
||
1543 | 1543 | return $positions; |
1544 | 1544 | } |
1545 | 1545 | |
1546 | - /** |
|
1547 | - * Like explode, but trims all entries, and removes |
|
1548 | - * empty entries from the resulting array. |
|
1549 | - * |
|
1550 | - * @param string $delimiter |
|
1551 | - * @param string $string |
|
1552 | - * @return string[] |
|
1553 | - */ |
|
1546 | + /** |
|
1547 | + * Like explode, but trims all entries, and removes |
|
1548 | + * empty entries from the resulting array. |
|
1549 | + * |
|
1550 | + * @param string $delimiter |
|
1551 | + * @param string $string |
|
1552 | + * @return string[] |
|
1553 | + */ |
|
1554 | 1554 | public static function explodeTrim(string $delimiter, string $string) : array |
1555 | 1555 | { |
1556 | 1556 | if(empty($string) || empty($delimiter)) { |
@@ -1572,12 +1572,12 @@ discard block |
||
1572 | 1572 | |
1573 | 1573 | protected static $eolChars; |
1574 | 1574 | |
1575 | - /** |
|
1576 | - * Detects the most used end-of-line character in the subject string. |
|
1577 | - * |
|
1578 | - * @param string $str The string to check. |
|
1579 | - * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1580 | - */ |
|
1575 | + /** |
|
1576 | + * Detects the most used end-of-line character in the subject string. |
|
1577 | + * |
|
1578 | + * @param string $str The string to check. |
|
1579 | + * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1580 | + */ |
|
1581 | 1581 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1582 | 1582 | { |
1583 | 1583 | if(empty($subjectString)) { |
@@ -1589,27 +1589,27 @@ discard block |
||
1589 | 1589 | $cr = chr((int)hexdec('0d')); |
1590 | 1590 | $lf = chr((int)hexdec('0a')); |
1591 | 1591 | |
1592 | - self::$eolChars = array( |
|
1593 | - array( |
|
1594 | - 'char' => $cr.$lf, |
|
1595 | - 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
1596 | - 'description' => t('Carriage return followed by a line feed'), |
|
1597 | - ), |
|
1598 | - array( |
|
1599 | - 'char' => $lf.$cr, |
|
1600 | - 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
1601 | - 'description' => t('Line feed followed by a carriage return'), |
|
1602 | - ), |
|
1603 | - array( |
|
1604 | - 'char' => $lf, |
|
1605 | - 'type' => ConvertHelper_EOL::TYPE_LF, |
|
1606 | - 'description' => t('Line feed'), |
|
1607 | - ), |
|
1608 | - array( |
|
1609 | - 'char' => $cr, |
|
1610 | - 'type' => ConvertHelper_EOL::TYPE_CR, |
|
1611 | - 'description' => t('Carriage Return'), |
|
1612 | - ), |
|
1592 | + self::$eolChars = array( |
|
1593 | + array( |
|
1594 | + 'char' => $cr.$lf, |
|
1595 | + 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
1596 | + 'description' => t('Carriage return followed by a line feed'), |
|
1597 | + ), |
|
1598 | + array( |
|
1599 | + 'char' => $lf.$cr, |
|
1600 | + 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
1601 | + 'description' => t('Line feed followed by a carriage return'), |
|
1602 | + ), |
|
1603 | + array( |
|
1604 | + 'char' => $lf, |
|
1605 | + 'type' => ConvertHelper_EOL::TYPE_LF, |
|
1606 | + 'description' => t('Line feed'), |
|
1607 | + ), |
|
1608 | + array( |
|
1609 | + 'char' => $cr, |
|
1610 | + 'type' => ConvertHelper_EOL::TYPE_CR, |
|
1611 | + 'description' => t('Carriage Return'), |
|
1612 | + ), |
|
1613 | 1613 | ); |
1614 | 1614 | } |
1615 | 1615 | |
@@ -1637,13 +1637,13 @@ discard block |
||
1637 | 1637 | ); |
1638 | 1638 | } |
1639 | 1639 | |
1640 | - /** |
|
1641 | - * Removes the specified keys from the target array, |
|
1642 | - * if they exist. |
|
1643 | - * |
|
1644 | - * @param array $array |
|
1645 | - * @param array $keys |
|
1646 | - */ |
|
1640 | + /** |
|
1641 | + * Removes the specified keys from the target array, |
|
1642 | + * if they exist. |
|
1643 | + * |
|
1644 | + * @param array $array |
|
1645 | + * @param array $keys |
|
1646 | + */ |
|
1647 | 1647 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1648 | 1648 | { |
1649 | 1649 | foreach($keys as $key) |
@@ -1654,13 +1654,13 @@ discard block |
||
1654 | 1654 | } |
1655 | 1655 | } |
1656 | 1656 | |
1657 | - /** |
|
1658 | - * Checks if the specified variable is an integer or a string containing an integer. |
|
1659 | - * Accepts both positive and negative integers. |
|
1660 | - * |
|
1661 | - * @param mixed $value |
|
1662 | - * @return bool |
|
1663 | - */ |
|
1657 | + /** |
|
1658 | + * Checks if the specified variable is an integer or a string containing an integer. |
|
1659 | + * Accepts both positive and negative integers. |
|
1660 | + * |
|
1661 | + * @param mixed $value |
|
1662 | + * @return bool |
|
1663 | + */ |
|
1664 | 1664 | public static function isInteger($value) : bool |
1665 | 1665 | { |
1666 | 1666 | if(is_int($value)) { |
@@ -1680,15 +1680,15 @@ discard block |
||
1680 | 1680 | return false; |
1681 | 1681 | } |
1682 | 1682 | |
1683 | - /** |
|
1684 | - * Converts an amount of seconds to a DateInterval object. |
|
1685 | - * |
|
1686 | - * @param int $seconds |
|
1687 | - * @return \DateInterval |
|
1688 | - * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1689 | - * |
|
1690 | - * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1691 | - */ |
|
1683 | + /** |
|
1684 | + * Converts an amount of seconds to a DateInterval object. |
|
1685 | + * |
|
1686 | + * @param int $seconds |
|
1687 | + * @return \DateInterval |
|
1688 | + * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1689 | + * |
|
1690 | + * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1691 | + */ |
|
1692 | 1692 | public static function seconds2interval(int $seconds) : \DateInterval |
1693 | 1693 | { |
1694 | 1694 | // The DateInterval::format() method does not recalculate carry |
@@ -59,7 +59,7 @@ discard block |
||
59 | 59 | $amount = substr_count($line, "\t") - $min; |
60 | 60 | $line = trim($line); |
61 | 61 | if ($amount >= 1) { |
62 | - $line = str_repeat("\t", $amount) . $line; |
|
62 | + $line = str_repeat("\t", $amount).$line; |
|
63 | 63 | } |
64 | 64 | |
65 | 65 | $converted[] = $line; |
@@ -131,10 +131,10 @@ discard block |
||
131 | 131 | |
132 | 132 | // specifically handle zero |
133 | 133 | if ($seconds <= 0) { |
134 | - return '0 ' . t('seconds'); |
|
134 | + return '0 '.t('seconds'); |
|
135 | 135 | } |
136 | 136 | |
137 | - if($seconds < 1) { |
|
137 | + if ($seconds < 1) { |
|
138 | 138 | return t('less than a second'); |
139 | 139 | } |
140 | 140 | |
@@ -142,7 +142,7 @@ discard block |
||
142 | 142 | foreach ($units as $def) { |
143 | 143 | $quot = intval($seconds / $def['value']); |
144 | 144 | if ($quot) { |
145 | - $item = $quot . ' '; |
|
145 | + $item = $quot.' '; |
|
146 | 146 | if (abs($quot) > 1) { |
147 | 147 | $item .= $def['plural']; |
148 | 148 | } else { |
@@ -159,7 +159,7 @@ discard block |
||
159 | 159 | return $last; |
160 | 160 | } |
161 | 161 | |
162 | - return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
|
162 | + return implode(', ', $tokens).' '.t('and').' '.$last; |
|
163 | 163 | } |
164 | 164 | |
165 | 165 | /** |
@@ -178,7 +178,7 @@ discard block |
||
178 | 178 | { |
179 | 179 | $converter = new ConvertHelper_DurationConverter(); |
180 | 180 | |
181 | - if($datefrom instanceof \DateTime) |
|
181 | + if ($datefrom instanceof \DateTime) |
|
182 | 182 | { |
183 | 183 | $converter->setDateFrom($datefrom); |
184 | 184 | } |
@@ -187,11 +187,11 @@ discard block |
||
187 | 187 | $converter->setDateFrom(self::timestamp2date($datefrom)); |
188 | 188 | } |
189 | 189 | |
190 | - if($dateto instanceof \DateTime) |
|
190 | + if ($dateto instanceof \DateTime) |
|
191 | 191 | { |
192 | 192 | $converter->setDateTo($dateto); |
193 | 193 | } |
194 | - else if($dateto > 0) |
|
194 | + else if ($dateto > 0) |
|
195 | 195 | { |
196 | 196 | $converter->setDateTo(self::timestamp2date($dateto)); |
197 | 197 | } |
@@ -211,9 +211,9 @@ discard block |
||
211 | 211 | return $geshi->parse_code(); |
212 | 212 | } |
213 | 213 | |
214 | - public static function highlight_xml($xml, $formatSource=false) |
|
214 | + public static function highlight_xml($xml, $formatSource = false) |
|
215 | 215 | { |
216 | - if($formatSource) |
|
216 | + if ($formatSource) |
|
217 | 217 | { |
218 | 218 | $dom = new \DOMDocument(); |
219 | 219 | $dom->loadXML($xml); |
@@ -251,22 +251,22 @@ discard block |
||
251 | 251 | $terabyte = $gigabyte * 1024; |
252 | 252 | |
253 | 253 | if (($bytes >= 0) && ($bytes < $kilobyte)) { |
254 | - return $bytes . ' ' . t('B'); |
|
254 | + return $bytes.' '.t('B'); |
|
255 | 255 | |
256 | 256 | } elseif (($bytes >= $kilobyte) && ($bytes < $megabyte)) { |
257 | - return round($bytes / $kilobyte, $precision) . ' ' . t('Kb'); |
|
257 | + return round($bytes / $kilobyte, $precision).' '.t('Kb'); |
|
258 | 258 | |
259 | 259 | } elseif (($bytes >= $megabyte) && ($bytes < $gigabyte)) { |
260 | - return round($bytes / $megabyte, $precision) . ' ' . t('Mb'); |
|
260 | + return round($bytes / $megabyte, $precision).' '.t('Mb'); |
|
261 | 261 | |
262 | 262 | } elseif (($bytes >= $gigabyte) && ($bytes < $terabyte)) { |
263 | - return round($bytes / $gigabyte, $precision) . ' ' . t('Gb'); |
|
263 | + return round($bytes / $gigabyte, $precision).' '.t('Gb'); |
|
264 | 264 | |
265 | 265 | } elseif ($bytes >= $terabyte) { |
266 | - return round($bytes / $gigabyte, $precision) . ' ' . t('Tb'); |
|
266 | + return round($bytes / $gigabyte, $precision).' '.t('Tb'); |
|
267 | 267 | } |
268 | 268 | |
269 | - return $bytes . ' ' . t('B'); |
|
269 | + return $bytes.' '.t('B'); |
|
270 | 270 | } |
271 | 271 | |
272 | 272 | /** |
@@ -286,34 +286,34 @@ discard block |
||
286 | 286 | return $text; |
287 | 287 | } |
288 | 288 | |
289 | - $text = trim(mb_substr($text, 0, $targetLength)) . $append; |
|
289 | + $text = trim(mb_substr($text, 0, $targetLength)).$append; |
|
290 | 290 | |
291 | 291 | return $text; |
292 | 292 | } |
293 | 293 | |
294 | - public static function var_dump($var, $html=true) |
|
294 | + public static function var_dump($var, $html = true) |
|
295 | 295 | { |
296 | 296 | $info = parseVariable($var); |
297 | 297 | |
298 | - if($html) { |
|
298 | + if ($html) { |
|
299 | 299 | return $info->toHTML(); |
300 | 300 | } |
301 | 301 | |
302 | 302 | return $info->toString(); |
303 | 303 | } |
304 | 304 | |
305 | - public static function print_r($var, $return=false, $html=true) |
|
305 | + public static function print_r($var, $return = false, $html = true) |
|
306 | 306 | { |
307 | 307 | $result = self::var_dump($var, $html); |
308 | 308 | |
309 | - if($html) { |
|
309 | + if ($html) { |
|
310 | 310 | $result = |
311 | 311 | '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'. |
312 | 312 | $result. |
313 | 313 | '</pre>'; |
314 | 314 | } |
315 | 315 | |
316 | - if($return) { |
|
316 | + if ($return) { |
|
317 | 317 | return $result; |
318 | 318 | } |
319 | 319 | |
@@ -333,7 +333,7 @@ discard block |
||
333 | 333 | |
334 | 334 | public static function string2bool($string) |
335 | 335 | { |
336 | - if($string === '' || $string === null) { |
|
336 | + if ($string === '' || $string === null) { |
|
337 | 337 | return false; |
338 | 338 | } |
339 | 339 | |
@@ -388,10 +388,10 @@ discard block |
||
388 | 388 | public static function date2listLabel(\DateTime $date, $includeTime = false, $shortMonth = false) |
389 | 389 | { |
390 | 390 | $today = new \DateTime(); |
391 | - if($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
391 | + if ($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
392 | 392 | $label = t('Today'); |
393 | 393 | } else { |
394 | - $label = $date->format('d') . '. ' . self::month2string((int)$date->format('m'), $shortMonth) . ' '; |
|
394 | + $label = $date->format('d').'. '.self::month2string((int)$date->format('m'), $shortMonth).' '; |
|
395 | 395 | if ($date->format('Y') != date('Y')) { |
396 | 396 | $label .= $date->format('Y'); |
397 | 397 | } |
@@ -482,28 +482,28 @@ discard block |
||
482 | 482 | $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'); |
483 | 483 | |
484 | 484 | $stack = array(); |
485 | - foreach(self::$controlChars as $char) |
|
485 | + foreach (self::$controlChars as $char) |
|
486 | 486 | { |
487 | 487 | $tokens = explode('-', $char); |
488 | 488 | $start = $tokens[0]; |
489 | 489 | $end = $tokens[1]; |
490 | 490 | $prefix = substr($start, 0, 3); |
491 | 491 | $range = array(); |
492 | - foreach($hexAlphabet as $number) { |
|
492 | + foreach ($hexAlphabet as $number) { |
|
493 | 493 | $range[] = $prefix.$number; |
494 | 494 | } |
495 | 495 | |
496 | 496 | $use = false; |
497 | - foreach($range as $number) { |
|
498 | - if($number == $start) { |
|
497 | + foreach ($range as $number) { |
|
498 | + if ($number == $start) { |
|
499 | 499 | $use = true; |
500 | 500 | } |
501 | 501 | |
502 | - if($use) { |
|
502 | + if ($use) { |
|
503 | 503 | $stack[] = $number; |
504 | 504 | } |
505 | 505 | |
506 | - if($number == $end) { |
|
506 | + if ($number == $end) { |
|
507 | 507 | break; |
508 | 508 | } |
509 | 509 | } |
@@ -524,7 +524,7 @@ discard block |
||
524 | 524 | $chars = self::getControlCharactersAsHex(); |
525 | 525 | |
526 | 526 | $result = array(); |
527 | - foreach($chars as $char) { |
|
527 | + foreach ($chars as $char) { |
|
528 | 528 | $result[] = hex2bin($char); |
529 | 529 | } |
530 | 530 | |
@@ -542,14 +542,14 @@ discard block |
||
542 | 542 | $chars = self::getControlCharactersAsHex(); |
543 | 543 | |
544 | 544 | $result = array(); |
545 | - foreach($chars as $char) { |
|
545 | + foreach ($chars as $char) { |
|
546 | 546 | $result[] = '\u'.strtolower($char); |
547 | 547 | } |
548 | 548 | |
549 | 549 | return $result; |
550 | 550 | } |
551 | 551 | |
552 | - protected static $controlChars = array( |
|
552 | + protected static $controlChars = array( |
|
553 | 553 | '0000-0008', // control chars |
554 | 554 | '000E-000F', // control chars |
555 | 555 | '0010-001F', // control chars |
@@ -571,19 +571,19 @@ discard block |
||
571 | 571 | */ |
572 | 572 | public static function stripControlCharacters(string $string) : string |
573 | 573 | { |
574 | - if(empty($string)) { |
|
574 | + if (empty($string)) { |
|
575 | 575 | return $string; |
576 | 576 | } |
577 | 577 | |
578 | 578 | // create the regex from the unicode characters list |
579 | - if(!isset(self::$controlCharsRegex)) |
|
579 | + if (!isset(self::$controlCharsRegex)) |
|
580 | 580 | { |
581 | 581 | $chars = self::getControlCharactersAsHex(); |
582 | 582 | |
583 | 583 | // we use the notation \x{0000} to specify the unicode character key |
584 | 584 | // in the regular expression. |
585 | 585 | $stack = array(); |
586 | - foreach($chars as $char) { |
|
586 | + foreach ($chars as $char) { |
|
587 | 587 | $stack[] = '\x{'.$char.'}'; |
588 | 588 | } |
589 | 589 | |
@@ -617,7 +617,7 @@ discard block |
||
617 | 617 | $ordInt = ord($octet); |
618 | 618 | // Convert from int (base 10) to hex (base 16), for PHP \x syntax |
619 | 619 | $ordHex = base_convert($ordInt, 10, 16); |
620 | - $output .= '\x' . $ordHex; |
|
620 | + $output .= '\x'.$ordHex; |
|
621 | 621 | } |
622 | 622 | return $output; |
623 | 623 | } |
@@ -649,19 +649,19 @@ discard block |
||
649 | 649 | |
650 | 650 | protected static function convertScalarForComparison($scalar) |
651 | 651 | { |
652 | - if($scalar === '' || is_null($scalar)) { |
|
652 | + if ($scalar === '' || is_null($scalar)) { |
|
653 | 653 | return null; |
654 | 654 | } |
655 | 655 | |
656 | - if(is_bool($scalar)) { |
|
656 | + if (is_bool($scalar)) { |
|
657 | 657 | return self::bool2string($scalar); |
658 | 658 | } |
659 | 659 | |
660 | - if(is_array($scalar)) { |
|
660 | + if (is_array($scalar)) { |
|
661 | 661 | $scalar = md5(serialize($scalar)); |
662 | 662 | } |
663 | 663 | |
664 | - if($scalar !== null && !is_scalar($scalar)) { |
|
664 | + if ($scalar !== null && !is_scalar($scalar)) { |
|
665 | 665 | throw new ConvertHelper_Exception( |
666 | 666 | 'Not a scalar value in comparison', |
667 | 667 | null, |
@@ -710,7 +710,7 @@ discard block |
||
710 | 710 | public static function bool2string($boolean, bool $yesno = false) : string |
711 | 711 | { |
712 | 712 | // allow 'yes', 'true', 'no', 'false' string notations as well |
713 | - if(!is_bool($boolean)) { |
|
713 | + if (!is_bool($boolean)) { |
|
714 | 714 | $boolean = self::string2bool($boolean); |
715 | 715 | } |
716 | 716 | |
@@ -751,15 +751,15 @@ discard block |
||
751 | 751 | public static function array2attributeString($array) |
752 | 752 | { |
753 | 753 | $tokens = array(); |
754 | - foreach($array as $attr => $value) { |
|
755 | - if($value == '' || $value == null) { |
|
754 | + foreach ($array as $attr => $value) { |
|
755 | + if ($value == '' || $value == null) { |
|
756 | 756 | continue; |
757 | 757 | } |
758 | 758 | |
759 | 759 | $tokens[] = $attr.'="'.$value.'"'; |
760 | 760 | } |
761 | 761 | |
762 | - if(empty($tokens)) { |
|
762 | + if (empty($tokens)) { |
|
763 | 763 | return ''; |
764 | 764 | } |
765 | 765 | |
@@ -774,10 +774,10 @@ discard block |
||
774 | 774 | * @param string $string |
775 | 775 | * @return string |
776 | 776 | */ |
777 | - public static function string2attributeJS($string, $quoted=true) |
|
777 | + public static function string2attributeJS($string, $quoted = true) |
|
778 | 778 | { |
779 | 779 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
780 | - if($quoted) { |
|
780 | + if ($quoted) { |
|
781 | 781 | $converted = "'".$converted."'"; |
782 | 782 | } |
783 | 783 | |
@@ -795,11 +795,11 @@ discard block |
||
795 | 795 | */ |
796 | 796 | public static function isBoolean($value) : bool |
797 | 797 | { |
798 | - if(is_bool($value)) { |
|
798 | + if (is_bool($value)) { |
|
799 | 799 | return true; |
800 | 800 | } |
801 | 801 | |
802 | - if(!is_scalar($value)) { |
|
802 | + if (!is_scalar($value)) { |
|
803 | 803 | return false; |
804 | 804 | } |
805 | 805 | |
@@ -815,7 +815,7 @@ discard block |
||
815 | 815 | public static function array2styleString(array $subject) : string |
816 | 816 | { |
817 | 817 | $tokens = array(); |
818 | - foreach($subject as $name => $value) { |
|
818 | + foreach ($subject as $name => $value) { |
|
819 | 819 | $tokens[] = $name.':'.$value; |
820 | 820 | } |
821 | 821 | |
@@ -873,7 +873,7 @@ discard block |
||
873 | 873 | * |
874 | 874 | * @see JSHelper::buildRegexStatement() |
875 | 875 | */ |
876 | - public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
|
876 | + public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) |
|
877 | 877 | { |
878 | 878 | return JSHelper::buildRegexStatement($regex, $statementType); |
879 | 879 | } |
@@ -890,11 +890,11 @@ discard block |
||
890 | 890 | * @throws ConvertHelper_Exception |
891 | 891 | * @return string |
892 | 892 | */ |
893 | - public static function var2json($variable, int $options=0, int $depth=512) : string |
|
893 | + public static function var2json($variable, int $options = 0, int $depth = 512) : string |
|
894 | 894 | { |
895 | 895 | $result = json_encode($variable, $options, $depth); |
896 | 896 | |
897 | - if($result !== false) { |
|
897 | + if ($result !== false) { |
|
898 | 898 | return $result; |
899 | 899 | } |
900 | 900 | |
@@ -919,10 +919,10 @@ discard block |
||
919 | 919 | public static function stripUTFBom($string) |
920 | 920 | { |
921 | 921 | $boms = FileHelper::getUTFBOMs(); |
922 | - foreach($boms as $bomChars) { |
|
922 | + foreach ($boms as $bomChars) { |
|
923 | 923 | $length = mb_strlen($bomChars); |
924 | 924 | $text = mb_substr($string, 0, $length); |
925 | - if($text==$bomChars) { |
|
925 | + if ($text == $bomChars) { |
|
926 | 926 | return mb_substr($string, $length); |
927 | 927 | } |
928 | 928 | } |
@@ -939,7 +939,7 @@ discard block |
||
939 | 939 | */ |
940 | 940 | public static function string2utf8($string) |
941 | 941 | { |
942 | - if(!self::isStringASCII($string)) { |
|
942 | + if (!self::isStringASCII($string)) { |
|
943 | 943 | return \ForceUTF8\Encoding::toUTF8($string); |
944 | 944 | } |
945 | 945 | |
@@ -957,11 +957,11 @@ discard block |
||
957 | 957 | */ |
958 | 958 | public static function isStringASCII($string) : bool |
959 | 959 | { |
960 | - if($string === '' || $string === NULL) { |
|
960 | + if ($string === '' || $string === NULL) { |
|
961 | 961 | return true; |
962 | 962 | } |
963 | 963 | |
964 | - if(!is_string($string)) { |
|
964 | + if (!is_string($string)) { |
|
965 | 965 | return false; |
966 | 966 | } |
967 | 967 | |
@@ -995,7 +995,7 @@ discard block |
||
995 | 995 | * @param array $options |
996 | 996 | * @return float |
997 | 997 | */ |
998 | - public static function matchString($source, $target, $options=array()) |
|
998 | + public static function matchString($source, $target, $options = array()) |
|
999 | 999 | { |
1000 | 1000 | $defaults = array( |
1001 | 1001 | 'maxLevenshtein' => 10, |
@@ -1005,12 +1005,12 @@ discard block |
||
1005 | 1005 | $options = array_merge($defaults, $options); |
1006 | 1006 | |
1007 | 1007 | // avoid doing this via levenshtein |
1008 | - if($source == $target) { |
|
1008 | + if ($source == $target) { |
|
1009 | 1009 | return 100; |
1010 | 1010 | } |
1011 | 1011 | |
1012 | 1012 | $diff = levenshtein($source, $target); |
1013 | - if($diff > $options['maxLevenshtein']) { |
|
1013 | + if ($diff > $options['maxLevenshtein']) { |
|
1014 | 1014 | return 0; |
1015 | 1015 | } |
1016 | 1016 | |
@@ -1024,8 +1024,8 @@ discard block |
||
1024 | 1024 | |
1025 | 1025 | $offset = 0; |
1026 | 1026 | $keep = array(); |
1027 | - foreach($tokens as $token) { |
|
1028 | - if($interval->$token > 0) { |
|
1027 | + foreach ($tokens as $token) { |
|
1028 | + if ($interval->$token > 0) { |
|
1029 | 1029 | $keep = array_slice($tokens, $offset); |
1030 | 1030 | break; |
1031 | 1031 | } |
@@ -1034,16 +1034,16 @@ discard block |
||
1034 | 1034 | } |
1035 | 1035 | |
1036 | 1036 | $parts = array(); |
1037 | - foreach($keep as $token) |
|
1037 | + foreach ($keep as $token) |
|
1038 | 1038 | { |
1039 | 1039 | $value = $interval->$token; |
1040 | 1040 | $label = ''; |
1041 | 1041 | |
1042 | 1042 | $suffix = 'p'; |
1043 | - if($value == 1) { $suffix = 's'; } |
|
1043 | + if ($value == 1) { $suffix = 's'; } |
|
1044 | 1044 | $token .= $suffix; |
1045 | 1045 | |
1046 | - switch($token) { |
|
1046 | + switch ($token) { |
|
1047 | 1047 | case 'ys': $label = t('1 year'); break; |
1048 | 1048 | case 'yp': $label = t('%1$s years', $value); break; |
1049 | 1049 | case 'ms': $label = t('1 month'); break; |
@@ -1061,7 +1061,7 @@ discard block |
||
1061 | 1061 | $parts[] = $label; |
1062 | 1062 | } |
1063 | 1063 | |
1064 | - if(count($parts) == 1) { |
|
1064 | + if (count($parts) == 1) { |
|
1065 | 1065 | return $parts[0]; |
1066 | 1066 | } |
1067 | 1067 | |
@@ -1132,24 +1132,24 @@ discard block |
||
1132 | 1132 | * @see ConvertHelper::INTERVAL_HOURS |
1133 | 1133 | * @see ConvertHelper::INTERVAL_DAYS |
1134 | 1134 | */ |
1135 | - public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
|
1135 | + public static function interval2total(\DateInterval $interval, $unit = self::INTERVAL_SECONDS) : int |
|
1136 | 1136 | { |
1137 | 1137 | $total = $interval->format('%a'); |
1138 | 1138 | if ($unit == self::INTERVAL_DAYS) { |
1139 | 1139 | return (int)$total; |
1140 | 1140 | } |
1141 | 1141 | |
1142 | - $total = ($total * 24) + ($interval->h ); |
|
1142 | + $total = ($total * 24) + ($interval->h); |
|
1143 | 1143 | if ($unit == self::INTERVAL_HOURS) { |
1144 | 1144 | return (int)$total; |
1145 | 1145 | } |
1146 | 1146 | |
1147 | - $total = ($total * 60) + ($interval->i ); |
|
1147 | + $total = ($total * 60) + ($interval->i); |
|
1148 | 1148 | if ($unit == self::INTERVAL_MINUTES) { |
1149 | 1149 | return (int)$total; |
1150 | 1150 | } |
1151 | 1151 | |
1152 | - $total = ($total * 60) + ($interval->s ); |
|
1152 | + $total = ($total * 60) + ($interval->s); |
|
1153 | 1153 | if ($unit == self::INTERVAL_SECONDS) { |
1154 | 1154 | return (int)$total; |
1155 | 1155 | } |
@@ -1178,13 +1178,13 @@ discard block |
||
1178 | 1178 | * @param string $short |
1179 | 1179 | * @return string|NULL |
1180 | 1180 | */ |
1181 | - public static function date2dayName(\DateTime $date, $short=false) |
|
1181 | + public static function date2dayName(\DateTime $date, $short = false) |
|
1182 | 1182 | { |
1183 | 1183 | $day = $date->format('l'); |
1184 | 1184 | $invariant = self::getDayNamesInvariant(); |
1185 | 1185 | |
1186 | 1186 | $idx = array_search($day, $invariant); |
1187 | - if($idx !== false) { |
|
1187 | + if ($idx !== false) { |
|
1188 | 1188 | $localized = self::getDayNames($short); |
1189 | 1189 | return $localized[$idx]; |
1190 | 1190 | } |
@@ -1207,10 +1207,10 @@ discard block |
||
1207 | 1207 | * @param string $short |
1208 | 1208 | * @return string[] |
1209 | 1209 | */ |
1210 | - public static function getDayNames($short=false) |
|
1210 | + public static function getDayNames($short = false) |
|
1211 | 1211 | { |
1212 | - if($short) { |
|
1213 | - if(!isset(self::$daysShort)) { |
|
1212 | + if ($short) { |
|
1213 | + if (!isset(self::$daysShort)) { |
|
1214 | 1214 | self::$daysShort = array( |
1215 | 1215 | t('Mon'), |
1216 | 1216 | t('Tue'), |
@@ -1225,7 +1225,7 @@ discard block |
||
1225 | 1225 | return self::$daysShort; |
1226 | 1226 | } |
1227 | 1227 | |
1228 | - if(!isset(self::$days)) { |
|
1228 | + if (!isset(self::$days)) { |
|
1229 | 1229 | self::$days = array( |
1230 | 1230 | t('Monday'), |
1231 | 1231 | t('Tuesday'), |
@@ -1250,17 +1250,17 @@ discard block |
||
1250 | 1250 | */ |
1251 | 1251 | public static function implodeWithAnd(array $list, $sep = ', ', $conjunction = null) |
1252 | 1252 | { |
1253 | - if(empty($list)) { |
|
1253 | + if (empty($list)) { |
|
1254 | 1254 | return ''; |
1255 | 1255 | } |
1256 | 1256 | |
1257 | - if(empty($conjunction)) { |
|
1257 | + if (empty($conjunction)) { |
|
1258 | 1258 | $conjunction = t('and'); |
1259 | 1259 | } |
1260 | 1260 | |
1261 | 1261 | $last = array_pop($list); |
1262 | - if($list) { |
|
1263 | - return implode($sep, $list) . $conjunction . ' ' . $last; |
|
1262 | + if ($list) { |
|
1263 | + return implode($sep, $list).$conjunction.' '.$last; |
|
1264 | 1264 | } |
1265 | 1265 | |
1266 | 1266 | return $last; |
@@ -1279,7 +1279,7 @@ discard block |
||
1279 | 1279 | public static function string2array(string $string) : array |
1280 | 1280 | { |
1281 | 1281 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
1282 | - if($result !== false) { |
|
1282 | + if ($result !== false) { |
|
1283 | 1283 | return $result; |
1284 | 1284 | } |
1285 | 1285 | |
@@ -1294,12 +1294,12 @@ discard block |
||
1294 | 1294 | */ |
1295 | 1295 | public static function isStringHTML(string $string) : bool |
1296 | 1296 | { |
1297 | - if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
1297 | + if (preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
1298 | 1298 | return true; |
1299 | 1299 | } |
1300 | 1300 | |
1301 | 1301 | $decoded = html_entity_decode($string); |
1302 | - if($decoded !== $string) { |
|
1302 | + if ($decoded !== $string) { |
|
1303 | 1303 | return true; |
1304 | 1304 | } |
1305 | 1305 | |
@@ -1436,7 +1436,7 @@ discard block |
||
1436 | 1436 | // extract parameter names from the query string |
1437 | 1437 | $result = array(); |
1438 | 1438 | preg_match_all('/&?([^&]+)=.*/sixU', $queryString, $result, PREG_PATTERN_ORDER); |
1439 | - if(isset($result[1])) { |
|
1439 | + if (isset($result[1])) { |
|
1440 | 1440 | $paramNames = $result[1]; |
1441 | 1441 | } |
1442 | 1442 | |
@@ -1459,11 +1459,11 @@ discard block |
||
1459 | 1459 | // possible naming conflicts like having both parameters "foo.bar" |
1460 | 1460 | // and "foo_bar" in the query string: since "foo.bar" would be converted |
1461 | 1461 | // to "foo_bar", one of the two would be replaced. |
1462 | - if($fixRequired) |
|
1462 | + if ($fixRequired) |
|
1463 | 1463 | { |
1464 | 1464 | $counter = 1; |
1465 | 1465 | $placeholders = array(); |
1466 | - foreach($paramNames as $paramName) |
|
1466 | + foreach ($paramNames as $paramName) |
|
1467 | 1467 | { |
1468 | 1468 | // create a unique placeholder name |
1469 | 1469 | $placeholder = '__PLACEHOLDER'.$counter.'__'; |
@@ -1493,13 +1493,13 @@ discard block |
||
1493 | 1493 | parse_str($queryString, $parsed); |
1494 | 1494 | |
1495 | 1495 | // do any of the parameter names need to be fixed? |
1496 | - if(!$fixRequired) { |
|
1496 | + if (!$fixRequired) { |
|
1497 | 1497 | return $parsed; |
1498 | 1498 | } |
1499 | 1499 | |
1500 | 1500 | $keep = array(); |
1501 | 1501 | |
1502 | - foreach($parsed as $name => $value) |
|
1502 | + foreach ($parsed as $name => $value) |
|
1503 | 1503 | { |
1504 | 1504 | $keep[$table[$name]] = $value; |
1505 | 1505 | } |
@@ -1518,14 +1518,14 @@ discard block |
||
1518 | 1518 | * @param bool $caseInsensitive |
1519 | 1519 | * @return ConvertHelper_StringMatch[] |
1520 | 1520 | */ |
1521 | - public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
|
1521 | + public static function findString(string $needle, string $haystack, bool $caseInsensitive = false) |
|
1522 | 1522 | { |
1523 | - if($needle === '') { |
|
1523 | + if ($needle === '') { |
|
1524 | 1524 | return array(); |
1525 | 1525 | } |
1526 | 1526 | |
1527 | 1527 | $function = 'mb_strpos'; |
1528 | - if($caseInsensitive) { |
|
1528 | + if ($caseInsensitive) { |
|
1529 | 1529 | $function = 'mb_stripos'; |
1530 | 1530 | } |
1531 | 1531 | |
@@ -1533,7 +1533,7 @@ discard block |
||
1533 | 1533 | $positions = array(); |
1534 | 1534 | $length = mb_strlen($needle); |
1535 | 1535 | |
1536 | - while( ($pos = $function($haystack, $needle, $pos)) !== false) |
|
1536 | + while (($pos = $function($haystack, $needle, $pos)) !== false) |
|
1537 | 1537 | { |
1538 | 1538 | $match = mb_substr($haystack, $pos, $length); |
1539 | 1539 | $positions[] = new ConvertHelper_StringMatch($pos, $match); |
@@ -1553,7 +1553,7 @@ discard block |
||
1553 | 1553 | */ |
1554 | 1554 | public static function explodeTrim(string $delimiter, string $string) : array |
1555 | 1555 | { |
1556 | - if(empty($string) || empty($delimiter)) { |
|
1556 | + if (empty($string) || empty($delimiter)) { |
|
1557 | 1557 | return array(); |
1558 | 1558 | } |
1559 | 1559 | |
@@ -1561,8 +1561,8 @@ discard block |
||
1561 | 1561 | $tokens = array_map('trim', $tokens); |
1562 | 1562 | |
1563 | 1563 | $keep = array(); |
1564 | - foreach($tokens as $token) { |
|
1565 | - if($token !== '') { |
|
1564 | + foreach ($tokens as $token) { |
|
1565 | + if ($token !== '') { |
|
1566 | 1566 | $keep[] = $token; |
1567 | 1567 | } |
1568 | 1568 | } |
@@ -1580,11 +1580,11 @@ discard block |
||
1580 | 1580 | */ |
1581 | 1581 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1582 | 1582 | { |
1583 | - if(empty($subjectString)) { |
|
1583 | + if (empty($subjectString)) { |
|
1584 | 1584 | return null; |
1585 | 1585 | } |
1586 | 1586 | |
1587 | - if(!isset(self::$eolChars)) |
|
1587 | + if (!isset(self::$eolChars)) |
|
1588 | 1588 | { |
1589 | 1589 | $cr = chr((int)hexdec('0d')); |
1590 | 1590 | $lf = chr((int)hexdec('0a')); |
@@ -1615,18 +1615,18 @@ discard block |
||
1615 | 1615 | |
1616 | 1616 | $max = 0; |
1617 | 1617 | $results = array(); |
1618 | - foreach(self::$eolChars as $def) |
|
1618 | + foreach (self::$eolChars as $def) |
|
1619 | 1619 | { |
1620 | 1620 | $amount = substr_count($subjectString, $def['char']); |
1621 | 1621 | |
1622 | - if($amount > $max) |
|
1622 | + if ($amount > $max) |
|
1623 | 1623 | { |
1624 | 1624 | $max = $amount; |
1625 | 1625 | $results[] = $def; |
1626 | 1626 | } |
1627 | 1627 | } |
1628 | 1628 | |
1629 | - if(empty($results)) { |
|
1629 | + if (empty($results)) { |
|
1630 | 1630 | return null; |
1631 | 1631 | } |
1632 | 1632 | |
@@ -1646,9 +1646,9 @@ discard block |
||
1646 | 1646 | */ |
1647 | 1647 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1648 | 1648 | { |
1649 | - foreach($keys as $key) |
|
1649 | + foreach ($keys as $key) |
|
1650 | 1650 | { |
1651 | - if(array_key_exists($key, $array)) { |
|
1651 | + if (array_key_exists($key, $array)) { |
|
1652 | 1652 | unset($array[$key]); |
1653 | 1653 | } |
1654 | 1654 | } |
@@ -1663,17 +1663,17 @@ discard block |
||
1663 | 1663 | */ |
1664 | 1664 | public static function isInteger($value) : bool |
1665 | 1665 | { |
1666 | - if(is_int($value)) { |
|
1666 | + if (is_int($value)) { |
|
1667 | 1667 | return true; |
1668 | 1668 | } |
1669 | 1669 | |
1670 | 1670 | // booleans get converted to numbers, so they would |
1671 | 1671 | // actually match the regex. |
1672 | - if(is_bool($value)) { |
|
1672 | + if (is_bool($value)) { |
|
1673 | 1673 | return false; |
1674 | 1674 | } |
1675 | 1675 | |
1676 | - if(is_string($value) && $value !== '') { |
|
1676 | + if (is_string($value) && $value !== '') { |
|
1677 | 1677 | return preg_match('/\A-?\d+\z/', $value) === 1; |
1678 | 1678 | } |
1679 | 1679 | |
@@ -1700,7 +1700,7 @@ discard block |
||
1700 | 1700 | $d2->add(new \DateInterval('PT'.$seconds.'S')); |
1701 | 1701 | |
1702 | 1702 | $result = $d2->diff($d1); |
1703 | - if($result !== false) { |
|
1703 | + if ($result !== false) { |
|
1704 | 1704 | return $result; |
1705 | 1705 | } |
1706 | 1706 |
@@ -181,8 +181,7 @@ discard block |
||
181 | 181 | if($datefrom instanceof \DateTime) |
182 | 182 | { |
183 | 183 | $converter->setDateFrom($datefrom); |
184 | - } |
|
185 | - else |
|
184 | + } else |
|
186 | 185 | { |
187 | 186 | $converter->setDateFrom(self::timestamp2date($datefrom)); |
188 | 187 | } |
@@ -190,8 +189,7 @@ discard block |
||
190 | 189 | if($dateto instanceof \DateTime) |
191 | 190 | { |
192 | 191 | $converter->setDateTo($dateto); |
193 | - } |
|
194 | - else if($dateto > 0) |
|
192 | + } else if($dateto > 0) |
|
195 | 193 | { |
196 | 194 | $converter->setDateTo(self::timestamp2date($dateto)); |
197 | 195 | } |
@@ -1337,8 +1335,7 @@ discard block |
||
1337 | 1335 | if (mb_strlen($actual.$word) <= $width) |
1338 | 1336 | { |
1339 | 1337 | $actual .= $word.' '; |
1340 | - } |
|
1341 | - else |
|
1338 | + } else |
|
1342 | 1339 | { |
1343 | 1340 | if ($actual != '') { |
1344 | 1341 | $line .= rtrim($actual).$break; |
@@ -80,32 +80,32 @@ discard block |
||
80 | 80 | |
81 | 81 | const ERROR_CANNOT_OPEN_FILE_TO_DETECT_BOM = 340032; |
82 | 82 | |
83 | - /** |
|
84 | - * Opens a serialized file and returns the unserialized data. |
|
85 | - * |
|
86 | - * @param string $file |
|
87 | - * @throws FileHelper_Exception |
|
88 | - * @return array |
|
89 | - * @deprecated Use parseSerializedFile() instead. |
|
90 | - * @see FileHelper::parseSerializedFile() |
|
91 | - */ |
|
83 | + /** |
|
84 | + * Opens a serialized file and returns the unserialized data. |
|
85 | + * |
|
86 | + * @param string $file |
|
87 | + * @throws FileHelper_Exception |
|
88 | + * @return array |
|
89 | + * @deprecated Use parseSerializedFile() instead. |
|
90 | + * @see FileHelper::parseSerializedFile() |
|
91 | + */ |
|
92 | 92 | public static function openUnserialized(string $file) : array |
93 | 93 | { |
94 | 94 | return self::parseSerializedFile($file); |
95 | 95 | } |
96 | 96 | |
97 | - /** |
|
98 | - * Opens a serialized file and returns the unserialized data. |
|
99 | - * |
|
100 | - * @param string $file |
|
101 | - * @throws FileHelper_Exception |
|
102 | - * @return array |
|
103 | - * @see FileHelper::parseSerializedFile() |
|
104 | - * |
|
105 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
106 | - * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
107 | - * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
108 | - */ |
|
97 | + /** |
|
98 | + * Opens a serialized file and returns the unserialized data. |
|
99 | + * |
|
100 | + * @param string $file |
|
101 | + * @throws FileHelper_Exception |
|
102 | + * @return array |
|
103 | + * @see FileHelper::parseSerializedFile() |
|
104 | + * |
|
105 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
106 | + * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
107 | + * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
108 | + */ |
|
109 | 109 | public static function parseSerializedFile(string $file) |
110 | 110 | { |
111 | 111 | self::requireFileExists($file); |
@@ -174,13 +174,13 @@ discard block |
||
174 | 174 | return rmdir($rootFolder); |
175 | 175 | } |
176 | 176 | |
177 | - /** |
|
178 | - * Create a folder, if it does not exist yet. |
|
179 | - * |
|
180 | - * @param string $path |
|
181 | - * @throws FileHelper_Exception |
|
182 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
183 | - */ |
|
177 | + /** |
|
178 | + * Create a folder, if it does not exist yet. |
|
179 | + * |
|
180 | + * @param string $path |
|
181 | + * @throws FileHelper_Exception |
|
182 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
183 | + */ |
|
184 | 184 | public static function createFolder($path) |
185 | 185 | { |
186 | 186 | if(is_dir($path) || mkdir($path, 0777, true)) { |
@@ -227,22 +227,22 @@ discard block |
||
227 | 227 | } |
228 | 228 | } |
229 | 229 | |
230 | - /** |
|
231 | - * Copies a file to the target location. Includes checks |
|
232 | - * for most error sources, like the source file not being |
|
233 | - * readable. Automatically creates the target folder if it |
|
234 | - * does not exist yet. |
|
235 | - * |
|
236 | - * @param string $sourcePath |
|
237 | - * @param string $targetPath |
|
238 | - * @throws FileHelper_Exception |
|
239 | - * |
|
240 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
241 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
242 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
243 | - * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
244 | - * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
245 | - */ |
|
230 | + /** |
|
231 | + * Copies a file to the target location. Includes checks |
|
232 | + * for most error sources, like the source file not being |
|
233 | + * readable. Automatically creates the target folder if it |
|
234 | + * does not exist yet. |
|
235 | + * |
|
236 | + * @param string $sourcePath |
|
237 | + * @param string $targetPath |
|
238 | + * @throws FileHelper_Exception |
|
239 | + * |
|
240 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
241 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
242 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
243 | + * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
244 | + * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
245 | + */ |
|
246 | 246 | public static function copyFile($sourcePath, $targetPath) |
247 | 247 | { |
248 | 248 | self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND); |
@@ -293,15 +293,15 @@ discard block |
||
293 | 293 | ); |
294 | 294 | } |
295 | 295 | |
296 | - /** |
|
297 | - * Deletes the target file. Ignored if it cannot be found, |
|
298 | - * and throws an exception if it fails. |
|
299 | - * |
|
300 | - * @param string $filePath |
|
301 | - * @throws FileHelper_Exception |
|
302 | - * |
|
303 | - * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
304 | - */ |
|
296 | + /** |
|
297 | + * Deletes the target file. Ignored if it cannot be found, |
|
298 | + * and throws an exception if it fails. |
|
299 | + * |
|
300 | + * @param string $filePath |
|
301 | + * @throws FileHelper_Exception |
|
302 | + * |
|
303 | + * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
304 | + */ |
|
305 | 305 | public static function deleteFile(string $filePath) : void |
306 | 306 | { |
307 | 307 | if(!file_exists($filePath)) { |
@@ -323,15 +323,15 @@ discard block |
||
323 | 323 | } |
324 | 324 | |
325 | 325 | /** |
326 | - * Creates a new CSV parser instance and returns it. |
|
327 | - * |
|
328 | - * @param string $delimiter |
|
329 | - * @param string $enclosure |
|
330 | - * @param string $escape |
|
331 | - * @param bool $heading |
|
332 | - * @return \parseCSV |
|
333 | - * @todo Move this to the CSV helper. |
|
334 | - */ |
|
326 | + * Creates a new CSV parser instance and returns it. |
|
327 | + * |
|
328 | + * @param string $delimiter |
|
329 | + * @param string $enclosure |
|
330 | + * @param string $escape |
|
331 | + * @param bool $heading |
|
332 | + * @return \parseCSV |
|
333 | + * @todo Move this to the CSV helper. |
|
334 | + */ |
|
335 | 335 | public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV |
336 | 336 | { |
337 | 337 | if($delimiter==='') { $delimiter = ';'; } |
@@ -346,23 +346,23 @@ discard block |
||
346 | 346 | return $parser; |
347 | 347 | } |
348 | 348 | |
349 | - /** |
|
350 | - * Parses all lines in the specified string and returns an |
|
351 | - * indexed array with all csv values in each line. |
|
352 | - * |
|
353 | - * @param string $csv |
|
354 | - * @param string $delimiter |
|
355 | - * @param string $enclosure |
|
356 | - * @param string $escape |
|
357 | - * @param bool $heading |
|
358 | - * @return array |
|
359 | - * @throws FileHelper_Exception |
|
360 | - * |
|
361 | - * @todo Move this to the CSVHelper. |
|
362 | - * |
|
363 | - * @see parseCSVFile() |
|
364 | - * @see FileHelper::ERROR_PARSING_CSV |
|
365 | - */ |
|
349 | + /** |
|
350 | + * Parses all lines in the specified string and returns an |
|
351 | + * indexed array with all csv values in each line. |
|
352 | + * |
|
353 | + * @param string $csv |
|
354 | + * @param string $delimiter |
|
355 | + * @param string $enclosure |
|
356 | + * @param string $escape |
|
357 | + * @param bool $heading |
|
358 | + * @return array |
|
359 | + * @throws FileHelper_Exception |
|
360 | + * |
|
361 | + * @todo Move this to the CSVHelper. |
|
362 | + * |
|
363 | + * @see parseCSVFile() |
|
364 | + * @see FileHelper::ERROR_PARSING_CSV |
|
365 | + */ |
|
366 | 366 | public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
367 | 367 | { |
368 | 368 | $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading); |
@@ -541,31 +541,31 @@ discard block |
||
541 | 541 | ); |
542 | 542 | } |
543 | 543 | |
544 | - /** |
|
545 | - * Verifies whether the target file is a PHP file. The path |
|
546 | - * to the file can be a path to a file as a string, or a |
|
547 | - * DirectoryIterator object instance. |
|
548 | - * |
|
549 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
550 | - * @return boolean |
|
551 | - */ |
|
544 | + /** |
|
545 | + * Verifies whether the target file is a PHP file. The path |
|
546 | + * to the file can be a path to a file as a string, or a |
|
547 | + * DirectoryIterator object instance. |
|
548 | + * |
|
549 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
550 | + * @return boolean |
|
551 | + */ |
|
552 | 552 | public static function isPHPFile($pathOrDirIterator) |
553 | 553 | { |
554 | - if(self::getExtension($pathOrDirIterator) == 'php') { |
|
555 | - return true; |
|
556 | - } |
|
554 | + if(self::getExtension($pathOrDirIterator) == 'php') { |
|
555 | + return true; |
|
556 | + } |
|
557 | 557 | |
558 | - return false; |
|
558 | + return false; |
|
559 | 559 | } |
560 | 560 | |
561 | - /** |
|
562 | - * Retrieves the extension of the specified file. Can be a path |
|
563 | - * to a file as a string, or a DirectoryIterator object instance. |
|
564 | - * |
|
565 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
566 | - * @param bool $lowercase |
|
567 | - * @return string |
|
568 | - */ |
|
561 | + /** |
|
562 | + * Retrieves the extension of the specified file. Can be a path |
|
563 | + * to a file as a string, or a DirectoryIterator object instance. |
|
564 | + * |
|
565 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
566 | + * @param bool $lowercase |
|
567 | + * @return string |
|
568 | + */ |
|
569 | 569 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
570 | 570 | { |
571 | 571 | if($pathOrDirIterator instanceof \DirectoryIterator) { |
@@ -576,51 +576,51 @@ discard block |
||
576 | 576 | |
577 | 577 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
578 | 578 | if($lowercase) { |
579 | - $ext = mb_strtolower($ext); |
|
579 | + $ext = mb_strtolower($ext); |
|
580 | 580 | } |
581 | 581 | |
582 | 582 | return $ext; |
583 | 583 | } |
584 | 584 | |
585 | - /** |
|
586 | - * Retrieves the file name from a path, with or without extension. |
|
587 | - * The path to the file can be a string, or a DirectoryIterator object |
|
588 | - * instance. |
|
589 | - * |
|
590 | - * In case of folders, behaves like the pathinfo function: returns |
|
591 | - * the name of the folder. |
|
592 | - * |
|
593 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
594 | - * @param bool $extension |
|
595 | - * @return string |
|
596 | - */ |
|
585 | + /** |
|
586 | + * Retrieves the file name from a path, with or without extension. |
|
587 | + * The path to the file can be a string, or a DirectoryIterator object |
|
588 | + * instance. |
|
589 | + * |
|
590 | + * In case of folders, behaves like the pathinfo function: returns |
|
591 | + * the name of the folder. |
|
592 | + * |
|
593 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
594 | + * @param bool $extension |
|
595 | + * @return string |
|
596 | + */ |
|
597 | 597 | public static function getFilename($pathOrDirIterator, $extension = true) |
598 | 598 | { |
599 | 599 | $path = $pathOrDirIterator; |
600 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
601 | - $path = $pathOrDirIterator->getFilename(); |
|
602 | - } |
|
600 | + if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
601 | + $path = $pathOrDirIterator->getFilename(); |
|
602 | + } |
|
603 | 603 | |
604 | - $path = self::normalizePath($path); |
|
604 | + $path = self::normalizePath($path); |
|
605 | 605 | |
606 | - if(!$extension) { |
|
607 | - return pathinfo($path, PATHINFO_FILENAME); |
|
608 | - } |
|
606 | + if(!$extension) { |
|
607 | + return pathinfo($path, PATHINFO_FILENAME); |
|
608 | + } |
|
609 | 609 | |
610 | - return pathinfo($path, PATHINFO_BASENAME); |
|
610 | + return pathinfo($path, PATHINFO_BASENAME); |
|
611 | 611 | } |
612 | 612 | |
613 | - /** |
|
614 | - * Tries to read the contents of the target file and |
|
615 | - * treat it as JSON to return the decoded JSON data. |
|
616 | - * |
|
617 | - * @param string $file |
|
618 | - * @throws FileHelper_Exception |
|
619 | - * @return array |
|
620 | - * |
|
621 | - * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
|
622 | - * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
|
623 | - */ |
|
613 | + /** |
|
614 | + * Tries to read the contents of the target file and |
|
615 | + * treat it as JSON to return the decoded JSON data. |
|
616 | + * |
|
617 | + * @param string $file |
|
618 | + * @throws FileHelper_Exception |
|
619 | + * @return array |
|
620 | + * |
|
621 | + * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
|
622 | + * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
|
623 | + */ |
|
624 | 624 | public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null) |
625 | 625 | { |
626 | 626 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
@@ -656,16 +656,16 @@ discard block |
||
656 | 656 | return $json; |
657 | 657 | } |
658 | 658 | |
659 | - /** |
|
660 | - * Corrects common formatting mistakes when users enter |
|
661 | - * file names, like too many spaces, dots and the like. |
|
662 | - * |
|
663 | - * NOTE: if the file name contains a path, the path is |
|
664 | - * stripped, leaving only the file name. |
|
665 | - * |
|
666 | - * @param string $name |
|
667 | - * @return string |
|
668 | - */ |
|
659 | + /** |
|
660 | + * Corrects common formatting mistakes when users enter |
|
661 | + * file names, like too many spaces, dots and the like. |
|
662 | + * |
|
663 | + * NOTE: if the file name contains a path, the path is |
|
664 | + * stripped, leaving only the file name. |
|
665 | + * |
|
666 | + * @param string $name |
|
667 | + * @return string |
|
668 | + */ |
|
669 | 669 | public static function fixFileName(string $name) : string |
670 | 670 | { |
671 | 671 | $name = trim($name); |
@@ -695,60 +695,60 @@ discard block |
||
695 | 695 | return $name; |
696 | 696 | } |
697 | 697 | |
698 | - /** |
|
699 | - * Creates an instance of the file finder, which is an easier |
|
700 | - * alternative to the other manual findFile methods, since all |
|
701 | - * options can be set by chaining. |
|
702 | - * |
|
703 | - * @param string $path |
|
704 | - * @return FileHelper_FileFinder |
|
705 | - */ |
|
698 | + /** |
|
699 | + * Creates an instance of the file finder, which is an easier |
|
700 | + * alternative to the other manual findFile methods, since all |
|
701 | + * options can be set by chaining. |
|
702 | + * |
|
703 | + * @param string $path |
|
704 | + * @return FileHelper_FileFinder |
|
705 | + */ |
|
706 | 706 | public static function createFileFinder(string $path) : FileHelper_FileFinder |
707 | 707 | { |
708 | 708 | return new FileHelper_FileFinder($path); |
709 | 709 | } |
710 | 710 | |
711 | - /** |
|
712 | - * Searches for all HTML files in the target folder. |
|
713 | - * |
|
714 | - * @param string $targetFolder |
|
715 | - * @param array $options |
|
716 | - * @return array An indexed array with files. |
|
717 | - * @see FileHelper::createFileFinder() |
|
718 | - * |
|
719 | - * @todo Convert this to use the file finder. |
|
720 | - */ |
|
711 | + /** |
|
712 | + * Searches for all HTML files in the target folder. |
|
713 | + * |
|
714 | + * @param string $targetFolder |
|
715 | + * @param array $options |
|
716 | + * @return array An indexed array with files. |
|
717 | + * @see FileHelper::createFileFinder() |
|
718 | + * |
|
719 | + * @todo Convert this to use the file finder. |
|
720 | + */ |
|
721 | 721 | public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
722 | 722 | { |
723 | 723 | return self::findFiles($targetFolder, array('html'), $options); |
724 | 724 | } |
725 | 725 | |
726 | - /** |
|
727 | - * Searches for all PHP files in the target folder. |
|
728 | - * |
|
729 | - * @param string $targetFolder |
|
730 | - * @param array $options |
|
731 | - * @return array An indexed array of PHP files. |
|
732 | - * @see FileHelper::createFileFinder() |
|
733 | - * |
|
734 | - * @todo Convert this to use the file finder. |
|
735 | - */ |
|
726 | + /** |
|
727 | + * Searches for all PHP files in the target folder. |
|
728 | + * |
|
729 | + * @param string $targetFolder |
|
730 | + * @param array $options |
|
731 | + * @return array An indexed array of PHP files. |
|
732 | + * @see FileHelper::createFileFinder() |
|
733 | + * |
|
734 | + * @todo Convert this to use the file finder. |
|
735 | + */ |
|
736 | 736 | public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
737 | 737 | { |
738 | 738 | return self::findFiles($targetFolder, array('php'), $options); |
739 | 739 | } |
740 | 740 | |
741 | - /** |
|
742 | - * |
|
743 | - * @param string $targetFolder |
|
744 | - * @param array $extensions |
|
745 | - * @param array $options |
|
746 | - * @param array $files |
|
747 | - * @throws FileHelper_Exception |
|
748 | - * @return array |
|
749 | - * @see FileHelper::createFileFinder() |
|
750 | - * @todo Convert this to use the file finder. |
|
751 | - */ |
|
741 | + /** |
|
742 | + * |
|
743 | + * @param string $targetFolder |
|
744 | + * @param array $extensions |
|
745 | + * @param array $options |
|
746 | + * @param array $files |
|
747 | + * @throws FileHelper_Exception |
|
748 | + * @return array |
|
749 | + * @see FileHelper::createFileFinder() |
|
750 | + * @todo Convert this to use the file finder. |
|
751 | + */ |
|
752 | 752 | public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array |
753 | 753 | { |
754 | 754 | if(!isset($options['strip-extension'])) { |
@@ -829,13 +829,13 @@ discard block |
||
829 | 829 | return $files; |
830 | 830 | } |
831 | 831 | |
832 | - /** |
|
833 | - * Removes the extension from the specified path or file name, |
|
834 | - * if any, and returns the name without the extension. |
|
835 | - * |
|
836 | - * @param string $filename |
|
837 | - * @return sTring |
|
838 | - */ |
|
832 | + /** |
|
833 | + * Removes the extension from the specified path or file name, |
|
834 | + * if any, and returns the name without the extension. |
|
835 | + * |
|
836 | + * @param string $filename |
|
837 | + * @return sTring |
|
838 | + */ |
|
839 | 839 | public static function removeExtension(string $filename) : string |
840 | 840 | { |
841 | 841 | // normalize paths to allow windows style slashes even on nix servers |
@@ -844,22 +844,22 @@ discard block |
||
844 | 844 | return pathinfo($filename, PATHINFO_FILENAME); |
845 | 845 | } |
846 | 846 | |
847 | - /** |
|
848 | - * Detects the UTF BOM in the target file, if any. Returns |
|
849 | - * the encoding matching the BOM, which can be any of the |
|
850 | - * following: |
|
851 | - * |
|
852 | - * <ul> |
|
853 | - * <li>UTF32-BE</li> |
|
854 | - * <li>UTF32-LE</li> |
|
855 | - * <li>UTF16-BE</li> |
|
856 | - * <li>UTF16-LE</li> |
|
857 | - * <li>UTF8</li> |
|
858 | - * </ul> |
|
859 | - * |
|
860 | - * @param string $filename |
|
861 | - * @return string|NULL |
|
862 | - */ |
|
847 | + /** |
|
848 | + * Detects the UTF BOM in the target file, if any. Returns |
|
849 | + * the encoding matching the BOM, which can be any of the |
|
850 | + * following: |
|
851 | + * |
|
852 | + * <ul> |
|
853 | + * <li>UTF32-BE</li> |
|
854 | + * <li>UTF32-LE</li> |
|
855 | + * <li>UTF16-BE</li> |
|
856 | + * <li>UTF16-LE</li> |
|
857 | + * <li>UTF8</li> |
|
858 | + * </ul> |
|
859 | + * |
|
860 | + * @param string $filename |
|
861 | + * @return string|NULL |
|
862 | + */ |
|
863 | 863 | public static function detectUTFBom(string $filename) : ?string |
864 | 864 | { |
865 | 865 | $fp = fopen($filename, 'r'); |
@@ -891,13 +891,13 @@ discard block |
||
891 | 891 | |
892 | 892 | protected static $utfBoms; |
893 | 893 | |
894 | - /** |
|
895 | - * Retrieves a list of all UTF byte order mark character |
|
896 | - * sequences, as an assocative array with UTF encoding => bom sequence |
|
897 | - * pairs. |
|
898 | - * |
|
899 | - * @return array |
|
900 | - */ |
|
894 | + /** |
|
895 | + * Retrieves a list of all UTF byte order mark character |
|
896 | + * sequences, as an assocative array with UTF encoding => bom sequence |
|
897 | + * pairs. |
|
898 | + * |
|
899 | + * @return array |
|
900 | + */ |
|
901 | 901 | public static function getUTFBOMs() |
902 | 902 | { |
903 | 903 | if(!isset(self::$utfBoms)) { |
@@ -913,15 +913,15 @@ discard block |
||
913 | 913 | return self::$utfBoms; |
914 | 914 | } |
915 | 915 | |
916 | - /** |
|
917 | - * Checks whether the specified encoding is a valid |
|
918 | - * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
919 | - * Also accounts for alternate way to write the, like |
|
920 | - * "UTF-8", and omitting little/big endian suffixes. |
|
921 | - * |
|
922 | - * @param string $encoding |
|
923 | - * @return boolean |
|
924 | - */ |
|
916 | + /** |
|
917 | + * Checks whether the specified encoding is a valid |
|
918 | + * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
919 | + * Also accounts for alternate way to write the, like |
|
920 | + * "UTF-8", and omitting little/big endian suffixes. |
|
921 | + * |
|
922 | + * @param string $encoding |
|
923 | + * @return boolean |
|
924 | + */ |
|
925 | 925 | public static function isValidUnicodeEncoding(string $encoding) : bool |
926 | 926 | { |
927 | 927 | $encodings = self::getKnownUnicodeEncodings(); |
@@ -940,22 +940,22 @@ discard block |
||
940 | 940 | return in_array($encoding, $keep); |
941 | 941 | } |
942 | 942 | |
943 | - /** |
|
944 | - * Retrieves a list of all known unicode file encodings. |
|
945 | - * @return array |
|
946 | - */ |
|
943 | + /** |
|
944 | + * Retrieves a list of all known unicode file encodings. |
|
945 | + * @return array |
|
946 | + */ |
|
947 | 947 | public static function getKnownUnicodeEncodings() |
948 | 948 | { |
949 | 949 | return array_keys(self::getUTFBOMs()); |
950 | 950 | } |
951 | 951 | |
952 | - /** |
|
953 | - * Normalizes the slash style in a file or folder path, |
|
954 | - * by replacing any antislashes with forward slashes. |
|
955 | - * |
|
956 | - * @param string $path |
|
957 | - * @return string |
|
958 | - */ |
|
952 | + /** |
|
953 | + * Normalizes the slash style in a file or folder path, |
|
954 | + * by replacing any antislashes with forward slashes. |
|
955 | + * |
|
956 | + * @param string $path |
|
957 | + * @return string |
|
958 | + */ |
|
959 | 959 | public static function normalizePath(string $path) : string |
960 | 960 | { |
961 | 961 | return str_replace(array('\\', '//'), array('/', '/'), $path); |
@@ -988,18 +988,18 @@ discard block |
||
988 | 988 | } |
989 | 989 | } |
990 | 990 | |
991 | - /** |
|
992 | - * Saves the specified content to the target file, creating |
|
993 | - * the file and the folder as necessary. |
|
994 | - * |
|
995 | - * @param string $filePath |
|
996 | - * @param string $content |
|
997 | - * @throws FileHelper_Exception |
|
998 | - * |
|
999 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
1000 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
1001 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
1002 | - */ |
|
991 | + /** |
|
992 | + * Saves the specified content to the target file, creating |
|
993 | + * the file and the folder as necessary. |
|
994 | + * |
|
995 | + * @param string $filePath |
|
996 | + * @param string $content |
|
997 | + * @throws FileHelper_Exception |
|
998 | + * |
|
999 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
1000 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
1001 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
1002 | + */ |
|
1003 | 1003 | public static function saveFile(string $filePath, string $content='') : void |
1004 | 1004 | { |
1005 | 1005 | // target file already exists |
@@ -1052,12 +1052,12 @@ discard block |
||
1052 | 1052 | ); |
1053 | 1053 | } |
1054 | 1054 | |
1055 | - /** |
|
1056 | - * Checks whether it is possible to run PHP command |
|
1057 | - * line commands. |
|
1058 | - * |
|
1059 | - * @return boolean |
|
1060 | - */ |
|
1055 | + /** |
|
1056 | + * Checks whether it is possible to run PHP command |
|
1057 | + * line commands. |
|
1058 | + * |
|
1059 | + * @return boolean |
|
1060 | + */ |
|
1061 | 1061 | public static function canMakePHPCalls() : bool |
1062 | 1062 | { |
1063 | 1063 | return self::cliCommandExists('php'); |
@@ -1132,16 +1132,16 @@ discard block |
||
1132 | 1132 | return $result; |
1133 | 1133 | } |
1134 | 1134 | |
1135 | - /** |
|
1136 | - * Validates a PHP file's syntax. |
|
1137 | - * |
|
1138 | - * NOTE: This will fail silently if the PHP command line |
|
1139 | - * is not available. Use {@link FileHelper::canMakePHPCalls()} |
|
1140 | - * to check this beforehand as needed. |
|
1141 | - * |
|
1142 | - * @param string $path |
|
1143 | - * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise. |
|
1144 | - */ |
|
1135 | + /** |
|
1136 | + * Validates a PHP file's syntax. |
|
1137 | + * |
|
1138 | + * NOTE: This will fail silently if the PHP command line |
|
1139 | + * is not available. Use {@link FileHelper::canMakePHPCalls()} |
|
1140 | + * to check this beforehand as needed. |
|
1141 | + * |
|
1142 | + * @param string $path |
|
1143 | + * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise. |
|
1144 | + */ |
|
1145 | 1145 | public static function checkPHPFileSyntax($path) |
1146 | 1146 | { |
1147 | 1147 | if(!self::canMakePHPCalls()) { |
@@ -1165,14 +1165,14 @@ discard block |
||
1165 | 1165 | return $output; |
1166 | 1166 | } |
1167 | 1167 | |
1168 | - /** |
|
1169 | - * Retrieves the last modified date for the specified file or folder. |
|
1170 | - * |
|
1171 | - * Note: If the target does not exist, returns null. |
|
1172 | - * |
|
1173 | - * @param string $path |
|
1174 | - * @return \DateTime|NULL |
|
1175 | - */ |
|
1168 | + /** |
|
1169 | + * Retrieves the last modified date for the specified file or folder. |
|
1170 | + * |
|
1171 | + * Note: If the target does not exist, returns null. |
|
1172 | + * |
|
1173 | + * @param string $path |
|
1174 | + * @return \DateTime|NULL |
|
1175 | + */ |
|
1176 | 1176 | public static function getModifiedDate($path) |
1177 | 1177 | { |
1178 | 1178 | $time = filemtime($path); |
@@ -1185,22 +1185,22 @@ discard block |
||
1185 | 1185 | return null; |
1186 | 1186 | } |
1187 | 1187 | |
1188 | - /** |
|
1189 | - * Retrieves the names of all subfolders in the specified path. |
|
1190 | - * |
|
1191 | - * Available options: |
|
1192 | - * |
|
1193 | - * - recursive: true/false |
|
1194 | - * Whether to search for subfolders recursively. |
|
1195 | - * |
|
1196 | - * - absolute-paths: true/false |
|
1197 | - * Whether to return a list of absolute paths. |
|
1198 | - * |
|
1199 | - * @param string $targetFolder |
|
1200 | - * @param array $options |
|
1201 | - * @throws FileHelper_Exception |
|
1202 | - * @return string[] |
|
1203 | - */ |
|
1188 | + /** |
|
1189 | + * Retrieves the names of all subfolders in the specified path. |
|
1190 | + * |
|
1191 | + * Available options: |
|
1192 | + * |
|
1193 | + * - recursive: true/false |
|
1194 | + * Whether to search for subfolders recursively. |
|
1195 | + * |
|
1196 | + * - absolute-paths: true/false |
|
1197 | + * Whether to return a list of absolute paths. |
|
1198 | + * |
|
1199 | + * @param string $targetFolder |
|
1200 | + * @param array $options |
|
1201 | + * @throws FileHelper_Exception |
|
1202 | + * @return string[] |
|
1203 | + */ |
|
1204 | 1204 | public static function getSubfolders($targetFolder, $options = array()) |
1205 | 1205 | { |
1206 | 1206 | if(!is_dir($targetFolder)) |
@@ -1261,16 +1261,16 @@ discard block |
||
1261 | 1261 | return $result; |
1262 | 1262 | } |
1263 | 1263 | |
1264 | - /** |
|
1265 | - * Retrieves the maximum allowed upload file size, in bytes. |
|
1266 | - * Takes into account the PHP ini settings <code>post_max_size</code> |
|
1267 | - * and <code>upload_max_filesize</code>. Since these cannot |
|
1268 | - * be modified at runtime, they are the hard limits for uploads. |
|
1269 | - * |
|
1270 | - * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
1271 | - * |
|
1272 | - * @return int Will return <code>-1</code> if no limit. |
|
1273 | - */ |
|
1264 | + /** |
|
1265 | + * Retrieves the maximum allowed upload file size, in bytes. |
|
1266 | + * Takes into account the PHP ini settings <code>post_max_size</code> |
|
1267 | + * and <code>upload_max_filesize</code>. Since these cannot |
|
1268 | + * be modified at runtime, they are the hard limits for uploads. |
|
1269 | + * |
|
1270 | + * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
1271 | + * |
|
1272 | + * @return int Will return <code>-1</code> if no limit. |
|
1273 | + */ |
|
1274 | 1274 | public static function getMaxUploadFilesize() : int |
1275 | 1275 | { |
1276 | 1276 | static $max_size = -1; |
@@ -1307,16 +1307,16 @@ discard block |
||
1307 | 1307 | return round($size); |
1308 | 1308 | } |
1309 | 1309 | |
1310 | - /** |
|
1311 | - * Makes a path relative using a folder depth: will reduce the |
|
1312 | - * length of the path so that only the amount of folders defined |
|
1313 | - * in the <code>$depth</code> attribute are shown below the actual |
|
1314 | - * folder or file in the path. |
|
1315 | - * |
|
1316 | - * @param string $path The absolute or relative path |
|
1317 | - * @param int $depth The folder depth to reduce the path to |
|
1318 | - * @return string |
|
1319 | - */ |
|
1310 | + /** |
|
1311 | + * Makes a path relative using a folder depth: will reduce the |
|
1312 | + * length of the path so that only the amount of folders defined |
|
1313 | + * in the <code>$depth</code> attribute are shown below the actual |
|
1314 | + * folder or file in the path. |
|
1315 | + * |
|
1316 | + * @param string $path The absolute or relative path |
|
1317 | + * @param int $depth The folder depth to reduce the path to |
|
1318 | + * @return string |
|
1319 | + */ |
|
1320 | 1320 | public static function relativizePathByDepth(string $path, int $depth=2) : string |
1321 | 1321 | { |
1322 | 1322 | $path = self::normalizePath($path); |
@@ -1354,23 +1354,23 @@ discard block |
||
1354 | 1354 | return trim(implode('/', $tokens), '/'); |
1355 | 1355 | } |
1356 | 1356 | |
1357 | - /** |
|
1358 | - * Makes the specified path relative to another path, |
|
1359 | - * by removing one from the other if found. Also |
|
1360 | - * normalizes the path to use forward slashes. |
|
1361 | - * |
|
1362 | - * Example: |
|
1363 | - * |
|
1364 | - * <pre> |
|
1365 | - * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
1366 | - * </pre> |
|
1367 | - * |
|
1368 | - * Result: <code>to/file.txt</code> |
|
1369 | - * |
|
1370 | - * @param string $path |
|
1371 | - * @param string $relativeTo |
|
1372 | - * @return string |
|
1373 | - */ |
|
1357 | + /** |
|
1358 | + * Makes the specified path relative to another path, |
|
1359 | + * by removing one from the other if found. Also |
|
1360 | + * normalizes the path to use forward slashes. |
|
1361 | + * |
|
1362 | + * Example: |
|
1363 | + * |
|
1364 | + * <pre> |
|
1365 | + * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
1366 | + * </pre> |
|
1367 | + * |
|
1368 | + * Result: <code>to/file.txt</code> |
|
1369 | + * |
|
1370 | + * @param string $path |
|
1371 | + * @param string $relativeTo |
|
1372 | + * @return string |
|
1373 | + */ |
|
1374 | 1374 | public static function relativizePath(string $path, string $relativeTo) : string |
1375 | 1375 | { |
1376 | 1376 | $path = self::normalizePath($path); |
@@ -1382,17 +1382,17 @@ discard block |
||
1382 | 1382 | return $relative; |
1383 | 1383 | } |
1384 | 1384 | |
1385 | - /** |
|
1386 | - * Checks that the target file exists, and throws an exception |
|
1387 | - * if it does not. |
|
1388 | - * |
|
1389 | - * @param string $path |
|
1390 | - * @param int|NULL $errorCode Optional custom error code |
|
1391 | - * @throws FileHelper_Exception |
|
1392 | - * @return string The real path to the file |
|
1393 | - * |
|
1394 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1395 | - */ |
|
1385 | + /** |
|
1386 | + * Checks that the target file exists, and throws an exception |
|
1387 | + * if it does not. |
|
1388 | + * |
|
1389 | + * @param string $path |
|
1390 | + * @param int|NULL $errorCode Optional custom error code |
|
1391 | + * @throws FileHelper_Exception |
|
1392 | + * @return string The real path to the file |
|
1393 | + * |
|
1394 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1395 | + */ |
|
1396 | 1396 | public static function requireFileExists(string $path, $errorCode=null) : string |
1397 | 1397 | { |
1398 | 1398 | $result = realpath($path); |
@@ -1411,18 +1411,18 @@ discard block |
||
1411 | 1411 | ); |
1412 | 1412 | } |
1413 | 1413 | |
1414 | - /** |
|
1415 | - * Reads a specific line number from the target file and returns its |
|
1416 | - * contents, if the file has such a line. Does so with little memory |
|
1417 | - * usage, as the file is not read entirely into memory. |
|
1418 | - * |
|
1419 | - * @param string $path |
|
1420 | - * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
1421 | - * @return string|NULL Will return null if the requested line does not exist. |
|
1422 | - * @throws FileHelper_Exception |
|
1423 | - * |
|
1424 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1425 | - */ |
|
1414 | + /** |
|
1415 | + * Reads a specific line number from the target file and returns its |
|
1416 | + * contents, if the file has such a line. Does so with little memory |
|
1417 | + * usage, as the file is not read entirely into memory. |
|
1418 | + * |
|
1419 | + * @param string $path |
|
1420 | + * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
1421 | + * @return string|NULL Will return null if the requested line does not exist. |
|
1422 | + * @throws FileHelper_Exception |
|
1423 | + * |
|
1424 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1425 | + */ |
|
1426 | 1426 | public static function getLineFromFile(string $path, int $lineNumber) : ?string |
1427 | 1427 | { |
1428 | 1428 | self::requireFileExists($path); |
@@ -1438,19 +1438,19 @@ discard block |
||
1438 | 1438 | $file->seek($targetLine); |
1439 | 1439 | |
1440 | 1440 | if($file->key() !== $targetLine) { |
1441 | - return null; |
|
1441 | + return null; |
|
1442 | 1442 | } |
1443 | 1443 | |
1444 | 1444 | return $file->current(); |
1445 | 1445 | } |
1446 | 1446 | |
1447 | - /** |
|
1448 | - * Retrieves the total amount of lines in the file, without |
|
1449 | - * reading the whole file into memory. |
|
1450 | - * |
|
1451 | - * @param string $path |
|
1452 | - * @return int |
|
1453 | - */ |
|
1447 | + /** |
|
1448 | + * Retrieves the total amount of lines in the file, without |
|
1449 | + * reading the whole file into memory. |
|
1450 | + * |
|
1451 | + * @param string $path |
|
1452 | + * @return int |
|
1453 | + */ |
|
1454 | 1454 | public static function countFileLines(string $path) : int |
1455 | 1455 | { |
1456 | 1456 | self::requireFileExists($path); |
@@ -1480,26 +1480,26 @@ discard block |
||
1480 | 1480 | return $number+1; |
1481 | 1481 | } |
1482 | 1482 | |
1483 | - /** |
|
1484 | - * Parses the target file to detect any PHP classes contained |
|
1485 | - * within, and retrieve information on them. Does not use the |
|
1486 | - * PHP reflection API. |
|
1487 | - * |
|
1488 | - * @param string $filePath |
|
1489 | - * @return FileHelper_PHPClassInfo |
|
1490 | - */ |
|
1483 | + /** |
|
1484 | + * Parses the target file to detect any PHP classes contained |
|
1485 | + * within, and retrieve information on them. Does not use the |
|
1486 | + * PHP reflection API. |
|
1487 | + * |
|
1488 | + * @param string $filePath |
|
1489 | + * @return FileHelper_PHPClassInfo |
|
1490 | + */ |
|
1491 | 1491 | public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo |
1492 | 1492 | { |
1493 | 1493 | return new FileHelper_PHPClassInfo($filePath); |
1494 | 1494 | } |
1495 | 1495 | |
1496 | - /** |
|
1497 | - * Detects the end of line style used in the target file, if any. |
|
1498 | - * Can be used with large files, because it only reads part of it. |
|
1499 | - * |
|
1500 | - * @param string $filePath The path to the file. |
|
1501 | - * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
1502 | - */ |
|
1496 | + /** |
|
1497 | + * Detects the end of line style used in the target file, if any. |
|
1498 | + * Can be used with large files, because it only reads part of it. |
|
1499 | + * |
|
1500 | + * @param string $filePath The path to the file. |
|
1501 | + * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
1502 | + */ |
|
1503 | 1503 | public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL |
1504 | 1504 | { |
1505 | 1505 | // 20 lines is enough to get a good picture of the newline style in the file. |
@@ -1512,18 +1512,18 @@ discard block |
||
1512 | 1512 | return ConvertHelper::detectEOLCharacter($string); |
1513 | 1513 | } |
1514 | 1514 | |
1515 | - /** |
|
1516 | - * Reads the specified amount of lines from the target file. |
|
1517 | - * Unicode BOM compatible: any byte order marker is stripped |
|
1518 | - * from the resulting lines. |
|
1519 | - * |
|
1520 | - * @param string $filePath |
|
1521 | - * @param int $amount Set to 0 to read all lines. |
|
1522 | - * @return array |
|
1523 | - * |
|
1524 | - * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
1525 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1526 | - */ |
|
1515 | + /** |
|
1516 | + * Reads the specified amount of lines from the target file. |
|
1517 | + * Unicode BOM compatible: any byte order marker is stripped |
|
1518 | + * from the resulting lines. |
|
1519 | + * |
|
1520 | + * @param string $filePath |
|
1521 | + * @param int $amount Set to 0 to read all lines. |
|
1522 | + * @return array |
|
1523 | + * |
|
1524 | + * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
1525 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1526 | + */ |
|
1527 | 1527 | public static function readLines(string $filePath, int $amount=0) : array |
1528 | 1528 | { |
1529 | 1529 | self::requireFileExists($filePath); |
@@ -1574,16 +1574,16 @@ discard block |
||
1574 | 1574 | return $result; |
1575 | 1575 | } |
1576 | 1576 | |
1577 | - /** |
|
1578 | - * Reads all content from a file. |
|
1579 | - * |
|
1580 | - * @param string $filePath |
|
1581 | - * @throws FileHelper_Exception |
|
1582 | - * @return string |
|
1583 | - * |
|
1584 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1585 | - * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
1586 | - */ |
|
1577 | + /** |
|
1578 | + * Reads all content from a file. |
|
1579 | + * |
|
1580 | + * @param string $filePath |
|
1581 | + * @throws FileHelper_Exception |
|
1582 | + * @return string |
|
1583 | + * |
|
1584 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1585 | + * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
1586 | + */ |
|
1587 | 1587 | public static function readContents(string $filePath) : string |
1588 | 1588 | { |
1589 | 1589 | self::requireFileExists($filePath); |
@@ -112,7 +112,7 @@ discard block |
||
112 | 112 | |
113 | 113 | $contents = file_get_contents($file); |
114 | 114 | |
115 | - if($contents === false) |
|
115 | + if ($contents === false) |
|
116 | 116 | { |
117 | 117 | throw new FileHelper_Exception( |
118 | 118 | 'Cannot load serialized content from file.', |
@@ -126,7 +126,7 @@ discard block |
||
126 | 126 | |
127 | 127 | $result = @unserialize($contents); |
128 | 128 | |
129 | - if($result !== false) { |
|
129 | + if ($result !== false) { |
|
130 | 130 | return $result; |
131 | 131 | } |
132 | 132 | |
@@ -142,7 +142,7 @@ discard block |
||
142 | 142 | |
143 | 143 | public static function deleteTree($rootFolder) |
144 | 144 | { |
145 | - if(!file_exists($rootFolder)) { |
|
145 | + if (!file_exists($rootFolder)) { |
|
146 | 146 | return true; |
147 | 147 | } |
148 | 148 | |
@@ -183,7 +183,7 @@ discard block |
||
183 | 183 | */ |
184 | 184 | public static function createFolder($path) |
185 | 185 | { |
186 | - if(is_dir($path) || mkdir($path, 0777, true)) { |
|
186 | + if (is_dir($path) || mkdir($path, 0777, true)) { |
|
187 | 187 | return; |
188 | 188 | } |
189 | 189 | |
@@ -218,11 +218,11 @@ discard block |
||
218 | 218 | |
219 | 219 | if ($item->isDir()) |
220 | 220 | { |
221 | - FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName); |
|
221 | + FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target.'/'.$baseName); |
|
222 | 222 | } |
223 | - else if($item->isFile()) |
|
223 | + else if ($item->isFile()) |
|
224 | 224 | { |
225 | - self::copyFile($itemPath, $target . '/' . $baseName); |
|
225 | + self::copyFile($itemPath, $target.'/'.$baseName); |
|
226 | 226 | } |
227 | 227 | } |
228 | 228 | } |
@@ -247,7 +247,7 @@ discard block |
||
247 | 247 | { |
248 | 248 | self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND); |
249 | 249 | |
250 | - if(!is_readable($sourcePath)) |
|
250 | + if (!is_readable($sourcePath)) |
|
251 | 251 | { |
252 | 252 | throw new FileHelper_Exception( |
253 | 253 | sprintf('Source file [%s] to copy is not readable.', basename($sourcePath)), |
@@ -261,11 +261,11 @@ discard block |
||
261 | 261 | |
262 | 262 | $targetFolder = dirname($targetPath); |
263 | 263 | |
264 | - if(!file_exists($targetFolder)) |
|
264 | + if (!file_exists($targetFolder)) |
|
265 | 265 | { |
266 | 266 | self::createFolder($targetFolder); |
267 | 267 | } |
268 | - else if(!is_writable($targetFolder)) |
|
268 | + else if (!is_writable($targetFolder)) |
|
269 | 269 | { |
270 | 270 | throw new FileHelper_Exception( |
271 | 271 | sprintf('Target folder [%s] is not writable.', basename($targetFolder)), |
@@ -277,7 +277,7 @@ discard block |
||
277 | 277 | ); |
278 | 278 | } |
279 | 279 | |
280 | - if(copy($sourcePath, $targetPath)) { |
|
280 | + if (copy($sourcePath, $targetPath)) { |
|
281 | 281 | return; |
282 | 282 | } |
283 | 283 | |
@@ -304,11 +304,11 @@ discard block |
||
304 | 304 | */ |
305 | 305 | public static function deleteFile(string $filePath) : void |
306 | 306 | { |
307 | - if(!file_exists($filePath)) { |
|
307 | + if (!file_exists($filePath)) { |
|
308 | 308 | return; |
309 | 309 | } |
310 | 310 | |
311 | - if(unlink($filePath)) { |
|
311 | + if (unlink($filePath)) { |
|
312 | 312 | return; |
313 | 313 | } |
314 | 314 | |
@@ -332,10 +332,10 @@ discard block |
||
332 | 332 | * @return \parseCSV |
333 | 333 | * @todo Move this to the CSV helper. |
334 | 334 | */ |
335 | - public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV |
|
335 | + public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : \parseCSV |
|
336 | 336 | { |
337 | - if($delimiter==='') { $delimiter = ';'; } |
|
338 | - if($enclosure==='') { $enclosure = '"'; } |
|
337 | + if ($delimiter === '') { $delimiter = ';'; } |
|
338 | + if ($enclosure === '') { $enclosure = '"'; } |
|
339 | 339 | |
340 | 340 | $parser = new \parseCSV(null, null, null, array()); |
341 | 341 | |
@@ -363,11 +363,11 @@ discard block |
||
363 | 363 | * @see parseCSVFile() |
364 | 364 | * @see FileHelper::ERROR_PARSING_CSV |
365 | 365 | */ |
366 | - public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
366 | + public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
367 | 367 | { |
368 | 368 | $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading); |
369 | 369 | $result = $parser->parse_string(/** @scrutinizer ignore-type */ $csv); |
370 | - if(is_array($result)) { |
|
370 | + if (is_array($result)) { |
|
371 | 371 | return $result; |
372 | 372 | } |
373 | 373 | |
@@ -395,7 +395,7 @@ discard block |
||
395 | 395 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
396 | 396 | * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
397 | 397 | */ |
398 | - public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
398 | + public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
399 | 399 | { |
400 | 400 | $content = self::readContents($filePath); |
401 | 401 | |
@@ -412,7 +412,7 @@ discard block |
||
412 | 412 | public static function detectMimeType(string $fileName) : ?string |
413 | 413 | { |
414 | 414 | $ext = self::getExtension($fileName); |
415 | - if(empty($ext)) { |
|
415 | + if (empty($ext)) { |
|
416 | 416 | return null; |
417 | 417 | } |
418 | 418 | |
@@ -433,11 +433,11 @@ discard block |
||
433 | 433 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
434 | 434 | * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE |
435 | 435 | */ |
436 | - public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true) |
|
436 | + public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true) |
|
437 | 437 | { |
438 | 438 | self::requireFileExists($filePath); |
439 | 439 | |
440 | - if(empty($fileName)) { |
|
440 | + if (empty($fileName)) { |
|
441 | 441 | $fileName = basename($filePath); |
442 | 442 | } |
443 | 443 | |
@@ -455,10 +455,10 @@ discard block |
||
455 | 455 | |
456 | 456 | header("Cache-Control: public", true); |
457 | 457 | header("Content-Description: File Transfer", true); |
458 | - header("Content-Type: " . $mime, true); |
|
458 | + header("Content-Type: ".$mime, true); |
|
459 | 459 | |
460 | 460 | $disposition = 'inline'; |
461 | - if($asAttachment) { |
|
461 | + if ($asAttachment) { |
|
462 | 462 | $disposition = 'attachment'; |
463 | 463 | } |
464 | 464 | |
@@ -484,7 +484,7 @@ discard block |
||
484 | 484 | */ |
485 | 485 | public static function downloadFile($url) |
486 | 486 | { |
487 | - if(!function_exists('curl_init')) |
|
487 | + if (!function_exists('curl_init')) |
|
488 | 488 | { |
489 | 489 | throw new FileHelper_Exception( |
490 | 490 | 'The cURL extension is not installed.', |
@@ -494,7 +494,7 @@ discard block |
||
494 | 494 | } |
495 | 495 | |
496 | 496 | $ch = curl_init(); |
497 | - if($ch === false) |
|
497 | + if ($ch === false) |
|
498 | 498 | { |
499 | 499 | throw new FileHelper_Exception( |
500 | 500 | 'Could not initialize a new cURL instance.', |
@@ -515,7 +515,7 @@ discard block |
||
515 | 515 | |
516 | 516 | $output = curl_exec($ch); |
517 | 517 | |
518 | - if($output === false) { |
|
518 | + if ($output === false) { |
|
519 | 519 | throw new FileHelper_Exception( |
520 | 520 | 'Unable to open URL', |
521 | 521 | sprintf( |
@@ -529,7 +529,7 @@ discard block |
||
529 | 529 | |
530 | 530 | curl_close($ch); |
531 | 531 | |
532 | - if(is_string($output)) |
|
532 | + if (is_string($output)) |
|
533 | 533 | { |
534 | 534 | return $output; |
535 | 535 | } |
@@ -551,7 +551,7 @@ discard block |
||
551 | 551 | */ |
552 | 552 | public static function isPHPFile($pathOrDirIterator) |
553 | 553 | { |
554 | - if(self::getExtension($pathOrDirIterator) == 'php') { |
|
554 | + if (self::getExtension($pathOrDirIterator) == 'php') { |
|
555 | 555 | return true; |
556 | 556 | } |
557 | 557 | |
@@ -568,14 +568,14 @@ discard block |
||
568 | 568 | */ |
569 | 569 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
570 | 570 | { |
571 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
571 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
572 | 572 | $filename = $pathOrDirIterator->getFilename(); |
573 | 573 | } else { |
574 | 574 | $filename = basename($pathOrDirIterator); |
575 | 575 | } |
576 | 576 | |
577 | 577 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
578 | - if($lowercase) { |
|
578 | + if ($lowercase) { |
|
579 | 579 | $ext = mb_strtolower($ext); |
580 | 580 | } |
581 | 581 | |
@@ -597,13 +597,13 @@ discard block |
||
597 | 597 | public static function getFilename($pathOrDirIterator, $extension = true) |
598 | 598 | { |
599 | 599 | $path = $pathOrDirIterator; |
600 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
600 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
601 | 601 | $path = $pathOrDirIterator->getFilename(); |
602 | 602 | } |
603 | 603 | |
604 | 604 | $path = self::normalizePath($path); |
605 | 605 | |
606 | - if(!$extension) { |
|
606 | + if (!$extension) { |
|
607 | 607 | return pathinfo($path, PATHINFO_FILENAME); |
608 | 608 | } |
609 | 609 | |
@@ -621,12 +621,12 @@ discard block |
||
621 | 621 | * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
622 | 622 | * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
623 | 623 | */ |
624 | - public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null) |
|
624 | + public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null) |
|
625 | 625 | { |
626 | 626 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
627 | 627 | |
628 | 628 | $content = file_get_contents($file); |
629 | - if(!$content) { |
|
629 | + if (!$content) { |
|
630 | 630 | throw new FileHelper_Exception( |
631 | 631 | 'Cannot get file contents', |
632 | 632 | sprintf( |
@@ -637,12 +637,12 @@ discard block |
||
637 | 637 | ); |
638 | 638 | } |
639 | 639 | |
640 | - if(isset($targetEncoding)) { |
|
640 | + if (isset($targetEncoding)) { |
|
641 | 641 | $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding); |
642 | 642 | } |
643 | 643 | |
644 | 644 | $json = json_decode($content, true); |
645 | - if($json === false || $json === NULL) { |
|
645 | + if ($json === false || $json === NULL) { |
|
646 | 646 | throw new FileHelper_Exception( |
647 | 647 | 'Cannot decode json data', |
648 | 648 | sprintf( |
@@ -682,13 +682,13 @@ discard block |
||
682 | 682 | |
683 | 683 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
684 | 684 | |
685 | - while(strstr($name, ' ')) { |
|
685 | + while (strstr($name, ' ')) { |
|
686 | 686 | $name = str_replace(' ', ' ', $name); |
687 | 687 | } |
688 | 688 | |
689 | 689 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
690 | 690 | |
691 | - while(strstr($name, '..')) { |
|
691 | + while (strstr($name, '..')) { |
|
692 | 692 | $name = str_replace('..', '.', $name); |
693 | 693 | } |
694 | 694 | |
@@ -718,7 +718,7 @@ discard block |
||
718 | 718 | * |
719 | 719 | * @todo Convert this to use the file finder. |
720 | 720 | */ |
721 | - public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
|
721 | + public static function findHTMLFiles(string $targetFolder, array $options = array()) : array |
|
722 | 722 | { |
723 | 723 | return self::findFiles($targetFolder, array('html'), $options); |
724 | 724 | } |
@@ -733,7 +733,7 @@ discard block |
||
733 | 733 | * |
734 | 734 | * @todo Convert this to use the file finder. |
735 | 735 | */ |
736 | - public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
|
736 | + public static function findPHPFiles(string $targetFolder, array $options = array()) : array |
|
737 | 737 | { |
738 | 738 | return self::findFiles($targetFolder, array('php'), $options); |
739 | 739 | } |
@@ -749,39 +749,39 @@ discard block |
||
749 | 749 | * @see FileHelper::createFileFinder() |
750 | 750 | * @todo Convert this to use the file finder. |
751 | 751 | */ |
752 | - public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array |
|
752 | + public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array |
|
753 | 753 | { |
754 | - if(!isset($options['strip-extension'])) { |
|
754 | + if (!isset($options['strip-extension'])) { |
|
755 | 755 | $options['strip-extension'] = false; |
756 | 756 | } |
757 | 757 | |
758 | - if(!isset($options['absolute-path'])) { |
|
758 | + if (!isset($options['absolute-path'])) { |
|
759 | 759 | $options['absolute-path'] = false; |
760 | 760 | } |
761 | 761 | |
762 | - if(!isset($options['relative-path'])) { |
|
762 | + if (!isset($options['relative-path'])) { |
|
763 | 763 | $options['relative-path'] = false; |
764 | 764 | } |
765 | 765 | |
766 | - if(!isset($options['recursive'])) { |
|
766 | + if (!isset($options['recursive'])) { |
|
767 | 767 | $options['recursive'] = false; |
768 | 768 | } |
769 | 769 | |
770 | - if($options['relative-path']) { |
|
770 | + if ($options['relative-path']) { |
|
771 | 771 | $options['absolute-path'] = true; |
772 | 772 | } |
773 | 773 | |
774 | - if(!isset($options['__root'])) { |
|
774 | + if (!isset($options['__root'])) { |
|
775 | 775 | $options['__root'] = self::normalizePath($targetFolder); |
776 | 776 | } |
777 | 777 | |
778 | 778 | $checkExtensions = false; |
779 | - if(!empty($extensions)) { |
|
779 | + if (!empty($extensions)) { |
|
780 | 780 | $checkExtensions = true; |
781 | 781 | $extensions = array_map('strtolower', $extensions); |
782 | 782 | } |
783 | 783 | |
784 | - if(!is_dir($targetFolder)) |
|
784 | + if (!is_dir($targetFolder)) |
|
785 | 785 | { |
786 | 786 | throw new FileHelper_Exception( |
787 | 787 | 'Target folder does not exist', |
@@ -794,32 +794,32 @@ discard block |
||
794 | 794 | } |
795 | 795 | |
796 | 796 | $d = new \DirectoryIterator($targetFolder); |
797 | - foreach($d as $item) { |
|
798 | - if($item->isDot()) { |
|
797 | + foreach ($d as $item) { |
|
798 | + if ($item->isDot()) { |
|
799 | 799 | continue; |
800 | 800 | } |
801 | 801 | |
802 | - if($item->isDir()) { |
|
803 | - if($options['recursive']) { |
|
802 | + if ($item->isDir()) { |
|
803 | + if ($options['recursive']) { |
|
804 | 804 | $files = self::findFiles($item->getPathname(), $extensions, $options, $files); |
805 | 805 | } |
806 | 806 | continue; |
807 | 807 | } |
808 | 808 | |
809 | - if($checkExtensions && !in_array(self::getExtension($item, true), $extensions)) { |
|
809 | + if ($checkExtensions && !in_array(self::getExtension($item, true), $extensions)) { |
|
810 | 810 | continue; |
811 | 811 | } |
812 | 812 | |
813 | 813 | $filename = $item->getFilename(); |
814 | - if($options['strip-extension']) { |
|
814 | + if ($options['strip-extension']) { |
|
815 | 815 | $filename = self::removeExtension($filename); |
816 | 816 | } |
817 | 817 | |
818 | - if($options['absolute-path']) { |
|
818 | + if ($options['absolute-path']) { |
|
819 | 819 | $filename = self::normalizePath($targetFolder.'/'.$filename); |
820 | 820 | } |
821 | 821 | |
822 | - if($options['relative-path']) { |
|
822 | + if ($options['relative-path']) { |
|
823 | 823 | $filename = ltrim(str_replace($options['__root'], '', $filename), '/'); |
824 | 824 | } |
825 | 825 | |
@@ -863,7 +863,7 @@ discard block |
||
863 | 863 | public static function detectUTFBom(string $filename) : ?string |
864 | 864 | { |
865 | 865 | $fp = fopen($filename, 'r'); |
866 | - if($fp === false) |
|
866 | + if ($fp === false) |
|
867 | 867 | { |
868 | 868 | throw new FileHelper_Exception( |
869 | 869 | 'Cannot open file for reading', |
@@ -878,10 +878,10 @@ discard block |
||
878 | 878 | |
879 | 879 | $boms = self::getUTFBOMs(); |
880 | 880 | |
881 | - foreach($boms as $bom => $value) |
|
881 | + foreach ($boms as $bom => $value) |
|
882 | 882 | { |
883 | 883 | $length = mb_strlen($value); |
884 | - if(mb_substr($text, 0, $length) == $value) { |
|
884 | + if (mb_substr($text, 0, $length) == $value) { |
|
885 | 885 | return $bom; |
886 | 886 | } |
887 | 887 | } |
@@ -900,13 +900,13 @@ discard block |
||
900 | 900 | */ |
901 | 901 | public static function getUTFBOMs() |
902 | 902 | { |
903 | - if(!isset(self::$utfBoms)) { |
|
903 | + if (!isset(self::$utfBoms)) { |
|
904 | 904 | self::$utfBoms = array( |
905 | - 'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF), |
|
906 | - 'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00), |
|
907 | - 'UTF16-BE' => chr(0xFE) . chr(0xFF), |
|
908 | - 'UTF16-LE' => chr(0xFF) . chr(0xFE), |
|
909 | - 'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF) |
|
905 | + 'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF), |
|
906 | + 'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00), |
|
907 | + 'UTF16-BE' => chr(0xFE).chr(0xFF), |
|
908 | + 'UTF16-LE' => chr(0xFF).chr(0xFE), |
|
909 | + 'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF) |
|
910 | 910 | ); |
911 | 911 | } |
912 | 912 | |
@@ -927,7 +927,7 @@ discard block |
||
927 | 927 | $encodings = self::getKnownUnicodeEncodings(); |
928 | 928 | |
929 | 929 | $keep = array(); |
930 | - foreach($encodings as $string) |
|
930 | + foreach ($encodings as $string) |
|
931 | 931 | { |
932 | 932 | $withHyphen = str_replace('UTF', 'UTF-', $string); |
933 | 933 | |
@@ -961,15 +961,15 @@ discard block |
||
961 | 961 | return str_replace(array('\\', '//'), array('/', '/'), $path); |
962 | 962 | } |
963 | 963 | |
964 | - public static function saveAsJSON($data, $file, $pretty=false) |
|
964 | + public static function saveAsJSON($data, $file, $pretty = false) |
|
965 | 965 | { |
966 | 966 | $options = null; |
967 | - if($pretty) { |
|
967 | + if ($pretty) { |
|
968 | 968 | $options = JSON_PRETTY_PRINT; |
969 | 969 | } |
970 | 970 | |
971 | 971 | $json = json_encode($data, $options); |
972 | - if($json===false) |
|
972 | + if ($json === false) |
|
973 | 973 | { |
974 | 974 | $errorCode = json_last_error(); |
975 | 975 | throw new FileHelper_Exception( |
@@ -979,7 +979,7 @@ discard block |
||
979 | 979 | ); |
980 | 980 | } |
981 | 981 | |
982 | - if(!file_put_contents($file, $json)) { |
|
982 | + if (!file_put_contents($file, $json)) { |
|
983 | 983 | throw new FileHelper_Exception( |
984 | 984 | sprintf('Could not write the JSON file [%s] to disk.', basename($file)), |
985 | 985 | sprintf('Full path: [%s].', $file), |
@@ -1000,12 +1000,12 @@ discard block |
||
1000 | 1000 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
1001 | 1001 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
1002 | 1002 | */ |
1003 | - public static function saveFile(string $filePath, string $content='') : void |
|
1003 | + public static function saveFile(string $filePath, string $content = '') : void |
|
1004 | 1004 | { |
1005 | 1005 | // target file already exists |
1006 | - if(file_exists($filePath)) |
|
1006 | + if (file_exists($filePath)) |
|
1007 | 1007 | { |
1008 | - if(!is_writable($filePath)) |
|
1008 | + if (!is_writable($filePath)) |
|
1009 | 1009 | { |
1010 | 1010 | throw new FileHelper_Exception( |
1011 | 1011 | sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)), |
@@ -1025,7 +1025,7 @@ discard block |
||
1025 | 1025 | // create the folder as needed |
1026 | 1026 | self::createFolder($targetFolder); |
1027 | 1027 | |
1028 | - if(!is_writable($targetFolder)) |
|
1028 | + if (!is_writable($targetFolder)) |
|
1029 | 1029 | { |
1030 | 1030 | throw new FileHelper_Exception( |
1031 | 1031 | sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)), |
@@ -1038,7 +1038,7 @@ discard block |
||
1038 | 1038 | } |
1039 | 1039 | } |
1040 | 1040 | |
1041 | - if(file_put_contents($filePath, $content) !== false) { |
|
1041 | + if (file_put_contents($filePath, $content) !== false) { |
|
1042 | 1042 | return; |
1043 | 1043 | } |
1044 | 1044 | |
@@ -1074,7 +1074,7 @@ discard block |
||
1074 | 1074 | { |
1075 | 1075 | static $checked = array(); |
1076 | 1076 | |
1077 | - if(isset($checked[$command])) { |
|
1077 | + if (isset($checked[$command])) { |
|
1078 | 1078 | return $checked[$command]; |
1079 | 1079 | } |
1080 | 1080 | |
@@ -1087,7 +1087,7 @@ discard block |
||
1087 | 1087 | |
1088 | 1088 | $os = strtolower(PHP_OS_FAMILY); |
1089 | 1089 | |
1090 | - if(!isset($osCommands[$os])) |
|
1090 | + if (!isset($osCommands[$os])) |
|
1091 | 1091 | { |
1092 | 1092 | throw new FileHelper_Exception( |
1093 | 1093 | 'Unsupported OS for CLI commands', |
@@ -1113,7 +1113,7 @@ discard block |
||
1113 | 1113 | $pipes |
1114 | 1114 | ); |
1115 | 1115 | |
1116 | - if($process === false) { |
|
1116 | + if ($process === false) { |
|
1117 | 1117 | $checked[$command] = false; |
1118 | 1118 | return false; |
1119 | 1119 | } |
@@ -1144,7 +1144,7 @@ discard block |
||
1144 | 1144 | */ |
1145 | 1145 | public static function checkPHPFileSyntax($path) |
1146 | 1146 | { |
1147 | - if(!self::canMakePHPCalls()) { |
|
1147 | + if (!self::canMakePHPCalls()) { |
|
1148 | 1148 | return true; |
1149 | 1149 | } |
1150 | 1150 | |
@@ -1155,7 +1155,7 @@ discard block |
||
1155 | 1155 | // when the validation is successful, the first entry |
1156 | 1156 | // in the array contains the success message. When it |
1157 | 1157 | // is invalid, the first entry is always empty. |
1158 | - if(!empty($output[0])) { |
|
1158 | + if (!empty($output[0])) { |
|
1159 | 1159 | return true; |
1160 | 1160 | } |
1161 | 1161 | |
@@ -1176,7 +1176,7 @@ discard block |
||
1176 | 1176 | public static function getModifiedDate($path) |
1177 | 1177 | { |
1178 | 1178 | $time = filemtime($path); |
1179 | - if($time !== false) { |
|
1179 | + if ($time !== false) { |
|
1180 | 1180 | $date = new \DateTime(); |
1181 | 1181 | $date->setTimestamp($time); |
1182 | 1182 | return $date; |
@@ -1203,7 +1203,7 @@ discard block |
||
1203 | 1203 | */ |
1204 | 1204 | public static function getSubfolders($targetFolder, $options = array()) |
1205 | 1205 | { |
1206 | - if(!is_dir($targetFolder)) |
|
1206 | + if (!is_dir($targetFolder)) |
|
1207 | 1207 | { |
1208 | 1208 | throw new FileHelper_Exception( |
1209 | 1209 | 'Target folder does not exist', |
@@ -1227,29 +1227,29 @@ discard block |
||
1227 | 1227 | |
1228 | 1228 | $d = new \DirectoryIterator($targetFolder); |
1229 | 1229 | |
1230 | - foreach($d as $item) |
|
1230 | + foreach ($d as $item) |
|
1231 | 1231 | { |
1232 | - if($item->isDir() && !$item->isDot()) |
|
1232 | + if ($item->isDir() && !$item->isDot()) |
|
1233 | 1233 | { |
1234 | 1234 | $name = $item->getFilename(); |
1235 | 1235 | |
1236 | - if(!$options['absolute-path']) { |
|
1236 | + if (!$options['absolute-path']) { |
|
1237 | 1237 | $result[] = $name; |
1238 | 1238 | } else { |
1239 | 1239 | $result[] = $targetFolder.'/'.$name; |
1240 | 1240 | } |
1241 | 1241 | |
1242 | - if(!$options['recursive']) |
|
1242 | + if (!$options['recursive']) |
|
1243 | 1243 | { |
1244 | 1244 | continue; |
1245 | 1245 | } |
1246 | 1246 | |
1247 | 1247 | $subs = self::getSubfolders($targetFolder.'/'.$name, $options); |
1248 | - foreach($subs as $sub) |
|
1248 | + foreach ($subs as $sub) |
|
1249 | 1249 | { |
1250 | 1250 | $relative = $name.'/'.$sub; |
1251 | 1251 | |
1252 | - if(!$options['absolute-path']) { |
|
1252 | + if (!$options['absolute-path']) { |
|
1253 | 1253 | $result[] = $relative; |
1254 | 1254 | } else { |
1255 | 1255 | $result[] = $targetFolder.'/'.$relative; |
@@ -1317,7 +1317,7 @@ discard block |
||
1317 | 1317 | * @param int $depth The folder depth to reduce the path to |
1318 | 1318 | * @return string |
1319 | 1319 | */ |
1320 | - public static function relativizePathByDepth(string $path, int $depth=2) : string |
|
1320 | + public static function relativizePathByDepth(string $path, int $depth = 2) : string |
|
1321 | 1321 | { |
1322 | 1322 | $path = self::normalizePath($path); |
1323 | 1323 | |
@@ -1325,17 +1325,17 @@ discard block |
||
1325 | 1325 | $tokens = array_filter($tokens); // remove empty entries (trailing slash for example) |
1326 | 1326 | $tokens = array_values($tokens); // re-index keys |
1327 | 1327 | |
1328 | - if(empty($tokens)) { |
|
1328 | + if (empty($tokens)) { |
|
1329 | 1329 | return ''; |
1330 | 1330 | } |
1331 | 1331 | |
1332 | 1332 | // remove the drive if present |
1333 | - if(strstr($tokens[0], ':')) { |
|
1333 | + if (strstr($tokens[0], ':')) { |
|
1334 | 1334 | array_shift($tokens); |
1335 | 1335 | } |
1336 | 1336 | |
1337 | 1337 | // path was only the drive |
1338 | - if(count($tokens) == 0) { |
|
1338 | + if (count($tokens) == 0) { |
|
1339 | 1339 | return ''; |
1340 | 1340 | } |
1341 | 1341 | |
@@ -1344,8 +1344,8 @@ discard block |
||
1344 | 1344 | |
1345 | 1345 | // reduce the path to the specified depth |
1346 | 1346 | $length = count($tokens); |
1347 | - if($length > $depth) { |
|
1348 | - $tokens = array_slice($tokens, $length-$depth); |
|
1347 | + if ($length > $depth) { |
|
1348 | + $tokens = array_slice($tokens, $length - $depth); |
|
1349 | 1349 | } |
1350 | 1350 | |
1351 | 1351 | // append the last element again |
@@ -1393,14 +1393,14 @@ discard block |
||
1393 | 1393 | * |
1394 | 1394 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
1395 | 1395 | */ |
1396 | - public static function requireFileExists(string $path, $errorCode=null) : string |
|
1396 | + public static function requireFileExists(string $path, $errorCode = null) : string |
|
1397 | 1397 | { |
1398 | 1398 | $result = realpath($path); |
1399 | - if($result !== false) { |
|
1399 | + if ($result !== false) { |
|
1400 | 1400 | return $result; |
1401 | 1401 | } |
1402 | 1402 | |
1403 | - if($errorCode === null) { |
|
1403 | + if ($errorCode === null) { |
|
1404 | 1404 | $errorCode = self::ERROR_FILE_DOES_NOT_EXIST; |
1405 | 1405 | } |
1406 | 1406 | |
@@ -1429,15 +1429,15 @@ discard block |
||
1429 | 1429 | |
1430 | 1430 | $file = new \SplFileObject($path); |
1431 | 1431 | |
1432 | - if($file->eof()) { |
|
1432 | + if ($file->eof()) { |
|
1433 | 1433 | return ''; |
1434 | 1434 | } |
1435 | 1435 | |
1436 | - $targetLine = $lineNumber-1; |
|
1436 | + $targetLine = $lineNumber - 1; |
|
1437 | 1437 | |
1438 | 1438 | $file->seek($targetLine); |
1439 | 1439 | |
1440 | - if($file->key() !== $targetLine) { |
|
1440 | + if ($file->key() !== $targetLine) { |
|
1441 | 1441 | return null; |
1442 | 1442 | } |
1443 | 1443 | |
@@ -1463,7 +1463,7 @@ discard block |
||
1463 | 1463 | $number = $spl->key(); |
1464 | 1464 | |
1465 | 1465 | // if seeking to the end the cursor is still at 0, there are no lines. |
1466 | - if($number === 0) |
|
1466 | + if ($number === 0) |
|
1467 | 1467 | { |
1468 | 1468 | // since it's a very small file, to get reliable results, |
1469 | 1469 | // we read its contents and use that to determine what |
@@ -1471,13 +1471,13 @@ discard block |
||
1471 | 1471 | // that this is not pactical to solve with the SplFileObject. |
1472 | 1472 | $content = file_get_contents($path); |
1473 | 1473 | |
1474 | - if(empty($content)) { |
|
1474 | + if (empty($content)) { |
|
1475 | 1475 | return 0; |
1476 | 1476 | } |
1477 | 1477 | } |
1478 | 1478 | |
1479 | 1479 | // return the line number we were able to reach + 1 (key is zero-based) |
1480 | - return $number+1; |
|
1480 | + return $number + 1; |
|
1481 | 1481 | } |
1482 | 1482 | |
1483 | 1483 | /** |
@@ -1524,13 +1524,13 @@ discard block |
||
1524 | 1524 | * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
1525 | 1525 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
1526 | 1526 | */ |
1527 | - public static function readLines(string $filePath, int $amount=0) : array |
|
1527 | + public static function readLines(string $filePath, int $amount = 0) : array |
|
1528 | 1528 | { |
1529 | 1529 | self::requireFileExists($filePath); |
1530 | 1530 | |
1531 | 1531 | $fn = fopen($filePath, "r"); |
1532 | 1532 | |
1533 | - if($fn === false) |
|
1533 | + if ($fn === false) |
|
1534 | 1534 | { |
1535 | 1535 | throw new FileHelper_Exception( |
1536 | 1536 | 'Could not open file for reading.', |
@@ -1546,25 +1546,25 @@ discard block |
||
1546 | 1546 | $counter = 0; |
1547 | 1547 | $first = true; |
1548 | 1548 | |
1549 | - while(!feof($fn)) |
|
1549 | + while (!feof($fn)) |
|
1550 | 1550 | { |
1551 | 1551 | $counter++; |
1552 | 1552 | |
1553 | 1553 | $line = fgets($fn); |
1554 | 1554 | |
1555 | 1555 | // can happen with zero length files |
1556 | - if($line === false) { |
|
1556 | + if ($line === false) { |
|
1557 | 1557 | continue; |
1558 | 1558 | } |
1559 | 1559 | |
1560 | 1560 | // the first line may contain a unicode BOM marker. |
1561 | - if($first) { |
|
1561 | + if ($first) { |
|
1562 | 1562 | $line = ConvertHelper::stripUTFBom($line); |
1563 | 1563 | } |
1564 | 1564 | |
1565 | 1565 | $result[] = $line; |
1566 | 1566 | |
1567 | - if($amount > 0 && $counter == $amount) { |
|
1567 | + if ($amount > 0 && $counter == $amount) { |
|
1568 | 1568 | break; |
1569 | 1569 | } |
1570 | 1570 | } |
@@ -1590,7 +1590,7 @@ discard block |
||
1590 | 1590 | |
1591 | 1591 | $result = file_get_contents($filePath); |
1592 | 1592 | |
1593 | - if($result !== false) { |
|
1593 | + if ($result !== false) { |
|
1594 | 1594 | return $result; |
1595 | 1595 | } |
1596 | 1596 |