@@ -36,40 +36,40 @@ discard block |
||
36 | 36 | const TYPE_PHONE = 'phone'; |
37 | 37 | const TYPE_URL = 'url'; |
38 | 38 | |
39 | - /** |
|
40 | - * The original URL that was passed to the constructor. |
|
41 | - * @var string |
|
42 | - */ |
|
39 | + /** |
|
40 | + * The original URL that was passed to the constructor. |
|
41 | + * @var string |
|
42 | + */ |
|
43 | 43 | protected $rawURL; |
44 | 44 | |
45 | - /** |
|
46 | - * @var array |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var array |
|
47 | + */ |
|
48 | 48 | protected $info; |
49 | 49 | |
50 | - /** |
|
51 | - * @var bool |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var bool |
|
52 | + */ |
|
53 | 53 | protected $isEmail = false; |
54 | 54 | |
55 | - /** |
|
56 | - * @var bool |
|
57 | - */ |
|
55 | + /** |
|
56 | + * @var bool |
|
57 | + */ |
|
58 | 58 | protected $isFragment = false; |
59 | 59 | |
60 | - /** |
|
61 | - * @var bool |
|
62 | - */ |
|
60 | + /** |
|
61 | + * @var bool |
|
62 | + */ |
|
63 | 63 | protected $isValid = true; |
64 | 64 | |
65 | - /** |
|
66 | - * @var bool |
|
67 | - */ |
|
65 | + /** |
|
66 | + * @var bool |
|
67 | + */ |
|
68 | 68 | protected $isPhone = false; |
69 | 69 | |
70 | - /** |
|
71 | - * @var array |
|
72 | - */ |
|
70 | + /** |
|
71 | + * @var array |
|
72 | + */ |
|
73 | 73 | protected $knownSchemes = array( |
74 | 74 | 'ftp', |
75 | 75 | 'http', |
@@ -80,41 +80,41 @@ discard block |
||
80 | 80 | 'file' |
81 | 81 | ); |
82 | 82 | |
83 | - /** |
|
84 | - * @var array |
|
85 | - */ |
|
83 | + /** |
|
84 | + * @var array |
|
85 | + */ |
|
86 | 86 | protected $error; |
87 | 87 | |
88 | - /** |
|
89 | - * @var array |
|
90 | - */ |
|
88 | + /** |
|
89 | + * @var array |
|
90 | + */ |
|
91 | 91 | protected $params = array(); |
92 | 92 | |
93 | - /** |
|
94 | - * @var string[] |
|
95 | - */ |
|
93 | + /** |
|
94 | + * @var string[] |
|
95 | + */ |
|
96 | 96 | protected $excludedParams = array(); |
97 | 97 | |
98 | - /** |
|
99 | - * @var bool |
|
100 | - * @see URLInfo::setParamExclusion() |
|
101 | - */ |
|
98 | + /** |
|
99 | + * @var bool |
|
100 | + * @see URLInfo::setParamExclusion() |
|
101 | + */ |
|
102 | 102 | protected $paramExclusion = false; |
103 | 103 | |
104 | - /** |
|
105 | - * @var array |
|
106 | - * @see URLInfo::getTypeLabel() |
|
107 | - */ |
|
104 | + /** |
|
105 | + * @var array |
|
106 | + * @see URLInfo::getTypeLabel() |
|
107 | + */ |
|
108 | 108 | protected static $typeLabels; |
109 | 109 | |
110 | - /** |
|
111 | - * @var bool |
|
112 | - */ |
|
110 | + /** |
|
111 | + * @var bool |
|
112 | + */ |
|
113 | 113 | protected $highlightExcluded = false; |
114 | 114 | |
115 | - /** |
|
116 | - * @var array |
|
117 | - */ |
|
115 | + /** |
|
116 | + * @var array |
|
117 | + */ |
|
118 | 118 | protected $infoKeys = array( |
119 | 119 | 'scheme', |
120 | 120 | 'host', |
@@ -126,9 +126,9 @@ discard block |
||
126 | 126 | 'fragment' |
127 | 127 | ); |
128 | 128 | |
129 | - /** |
|
130 | - * @var string |
|
131 | - */ |
|
129 | + /** |
|
130 | + * @var string |
|
131 | + */ |
|
132 | 132 | protected $url; |
133 | 133 | |
134 | 134 | public function __construct(string $url) |
@@ -214,13 +214,13 @@ discard block |
||
214 | 214 | $this->isValid = true; |
215 | 215 | } |
216 | 216 | |
217 | - /** |
|
218 | - * Filters an URL: removes control characters and the |
|
219 | - * like to have a clean URL to work with. |
|
220 | - * |
|
221 | - * @param string $url |
|
222 | - * @return string |
|
223 | - */ |
|
217 | + /** |
|
218 | + * Filters an URL: removes control characters and the |
|
219 | + * like to have a clean URL to work with. |
|
220 | + * |
|
221 | + * @param string $url |
|
222 | + * @return string |
|
223 | + */ |
|
224 | 224 | public static function filterURL(string $url) |
225 | 225 | { |
226 | 226 | // fix ampersands if it comes from HTML |
@@ -243,11 +243,11 @@ discard block |
||
243 | 243 | return $url; |
244 | 244 | } |
245 | 245 | |
246 | - /** |
|
247 | - * Goes through all information in the parse_url result |
|
248 | - * array, and attempts to fix any user errors in formatting |
|
249 | - * that can be recovered from, mostly regarding stray spaces. |
|
250 | - */ |
|
246 | + /** |
|
247 | + * Goes through all information in the parse_url result |
|
248 | + * array, and attempts to fix any user errors in formatting |
|
249 | + * that can be recovered from, mostly regarding stray spaces. |
|
250 | + */ |
|
251 | 251 | protected function filterParsed() |
252 | 252 | { |
253 | 253 | foreach($this->info as $key => $val) |
@@ -331,12 +331,12 @@ discard block |
||
331 | 331 | return $this->isPhone; |
332 | 332 | } |
333 | 333 | |
334 | - /** |
|
335 | - * Whether the URL is a regular URL, not one of the |
|
336 | - * other types like a phone number or email address. |
|
337 | - * |
|
338 | - * @return bool |
|
339 | - */ |
|
334 | + /** |
|
335 | + * Whether the URL is a regular URL, not one of the |
|
336 | + * other types like a phone number or email address. |
|
337 | + * |
|
338 | + * @return bool |
|
339 | + */ |
|
340 | 340 | public function isURL() : bool |
341 | 341 | { |
342 | 342 | $host = $this->getHost(); |
@@ -348,20 +348,20 @@ discard block |
||
348 | 348 | return $this->isValid; |
349 | 349 | } |
350 | 350 | |
351 | - /** |
|
352 | - * Retrieves the host name, or an empty string if none is present. |
|
353 | - * |
|
354 | - * @return string |
|
355 | - */ |
|
351 | + /** |
|
352 | + * Retrieves the host name, or an empty string if none is present. |
|
353 | + * |
|
354 | + * @return string |
|
355 | + */ |
|
356 | 356 | public function getHost() : string |
357 | 357 | { |
358 | 358 | return $this->getInfoKey('host'); |
359 | 359 | } |
360 | 360 | |
361 | - /** |
|
362 | - * Retrieves the path, or an empty string if none is present. |
|
363 | - * @return string |
|
364 | - */ |
|
361 | + /** |
|
362 | + * Retrieves the path, or an empty string if none is present. |
|
363 | + * @return string |
|
364 | + */ |
|
365 | 365 | public function getPath() : string |
366 | 366 | { |
367 | 367 | return $this->getInfoKey('path'); |
@@ -377,10 +377,10 @@ discard block |
||
377 | 377 | return $this->getInfoKey('scheme'); |
378 | 378 | } |
379 | 379 | |
380 | - /** |
|
381 | - * Retrieves the port specified in the URL, or -1 if none is preseent. |
|
382 | - * @return int |
|
383 | - */ |
|
380 | + /** |
|
381 | + * Retrieves the port specified in the URL, or -1 if none is preseent. |
|
382 | + * @return int |
|
383 | + */ |
|
384 | 384 | public function getPort() : int |
385 | 385 | { |
386 | 386 | $port = $this->getInfoKey('port'); |
@@ -391,13 +391,13 @@ discard block |
||
391 | 391 | return -1; |
392 | 392 | } |
393 | 393 | |
394 | - /** |
|
395 | - * Retrieves the raw query string, or an empty string if none is present. |
|
396 | - * |
|
397 | - * @return string |
|
398 | - * |
|
399 | - * @see URLInfo::getParams() |
|
400 | - */ |
|
394 | + /** |
|
395 | + * Retrieves the raw query string, or an empty string if none is present. |
|
396 | + * |
|
397 | + * @return string |
|
398 | + * |
|
399 | + * @see URLInfo::getParams() |
|
400 | + */ |
|
401 | 401 | public function getQuery() : string |
402 | 402 | { |
403 | 403 | return $this->getInfoKey('query'); |
@@ -413,20 +413,20 @@ discard block |
||
413 | 413 | return $this->getInfoKey('pass'); |
414 | 414 | } |
415 | 415 | |
416 | - /** |
|
417 | - * Whether the URL contains a port number. |
|
418 | - * @return bool |
|
419 | - */ |
|
416 | + /** |
|
417 | + * Whether the URL contains a port number. |
|
418 | + * @return bool |
|
419 | + */ |
|
420 | 420 | public function hasPort() : bool |
421 | 421 | { |
422 | 422 | return $this->getPort() !== -1; |
423 | 423 | } |
424 | 424 | |
425 | - /** |
|
426 | - * Alias for the hasParams() method. |
|
427 | - * @return bool |
|
428 | - * @see URLInfo::hasParams() |
|
429 | - */ |
|
425 | + /** |
|
426 | + * Alias for the hasParams() method. |
|
427 | + * @return bool |
|
428 | + * @see URLInfo::hasParams() |
|
429 | + */ |
|
430 | 430 | public function hasQuery() : bool |
431 | 431 | { |
432 | 432 | return $this->hasParams(); |
@@ -507,25 +507,25 @@ discard block |
||
507 | 507 | return $normalized; |
508 | 508 | } |
509 | 509 | |
510 | - /** |
|
511 | - * Creates a hash of the URL, which can be used for comparisons. |
|
512 | - * Since any parameters in the URL's query are sorted alphabetically, |
|
513 | - * the same links with a different parameter order will have the |
|
514 | - * same hash. |
|
515 | - * |
|
516 | - * @return string |
|
517 | - */ |
|
510 | + /** |
|
511 | + * Creates a hash of the URL, which can be used for comparisons. |
|
512 | + * Since any parameters in the URL's query are sorted alphabetically, |
|
513 | + * the same links with a different parameter order will have the |
|
514 | + * same hash. |
|
515 | + * |
|
516 | + * @return string |
|
517 | + */ |
|
518 | 518 | public function getHash() |
519 | 519 | { |
520 | 520 | return \AppUtils\ConvertHelper::string2shortHash($this->getNormalized()); |
521 | 521 | } |
522 | 522 | |
523 | - /** |
|
524 | - * Highlights the URL using HTML tags with specific highlighting |
|
525 | - * class names. |
|
526 | - * |
|
527 | - * @return string Will return an empty string if the URL is not valid. |
|
528 | - */ |
|
523 | + /** |
|
524 | + * Highlights the URL using HTML tags with specific highlighting |
|
525 | + * class names. |
|
526 | + * |
|
527 | + * @return string Will return an empty string if the URL is not valid. |
|
528 | + */ |
|
529 | 529 | public function getHighlighted() : string |
530 | 530 | { |
531 | 531 | if(!$this->isValid) { |
@@ -709,15 +709,15 @@ discard block |
||
709 | 709 | return count($params); |
710 | 710 | } |
711 | 711 | |
712 | - /** |
|
713 | - * Retrieves all parameters specified in the url, |
|
714 | - * if any, as an associative array. |
|
715 | - * |
|
716 | - * NOTE: Ignores parameters that have been added |
|
717 | - * to the excluded parameters list. |
|
718 | - * |
|
719 | - * @return array |
|
720 | - */ |
|
712 | + /** |
|
713 | + * Retrieves all parameters specified in the url, |
|
714 | + * if any, as an associative array. |
|
715 | + * |
|
716 | + * NOTE: Ignores parameters that have been added |
|
717 | + * to the excluded parameters list. |
|
718 | + * |
|
719 | + * @return array |
|
720 | + */ |
|
721 | 721 | public function getParams() : array |
722 | 722 | { |
723 | 723 | if(!$this->paramExclusion || empty($this->excludedParams)) { |
@@ -734,26 +734,26 @@ discard block |
||
734 | 734 | return $keep; |
735 | 735 | } |
736 | 736 | |
737 | - /** |
|
738 | - * Retrieves the names of all parameters present in the URL, if any. |
|
739 | - * @return string[] |
|
740 | - */ |
|
737 | + /** |
|
738 | + * Retrieves the names of all parameters present in the URL, if any. |
|
739 | + * @return string[] |
|
740 | + */ |
|
741 | 741 | public function getParamNames() : array |
742 | 742 | { |
743 | 743 | $params = $this->getParams(); |
744 | 744 | return array_keys($params); |
745 | 745 | } |
746 | 746 | |
747 | - /** |
|
748 | - * Excludes an URL parameter entirely if present: |
|
749 | - * the parser will act as if the parameter was not |
|
750 | - * even present in the source URL, effectively |
|
751 | - * stripping it. |
|
752 | - * |
|
753 | - * @param string $name |
|
754 | - * @param string $reason A human readable explanation why this is excluded - used when highlighting links. |
|
755 | - * @return URLInfo |
|
756 | - */ |
|
747 | + /** |
|
748 | + * Excludes an URL parameter entirely if present: |
|
749 | + * the parser will act as if the parameter was not |
|
750 | + * even present in the source URL, effectively |
|
751 | + * stripping it. |
|
752 | + * |
|
753 | + * @param string $name |
|
754 | + * @param string $reason A human readable explanation why this is excluded - used when highlighting links. |
|
755 | + * @return URLInfo |
|
756 | + */ |
|
757 | 757 | public function excludeParam(string $name, string $reason) : URLInfo |
758 | 758 | { |
759 | 759 | if(!isset($this->excludedParams[$name])) |
@@ -818,25 +818,25 @@ discard block |
||
818 | 818 | return self::$typeLabels[$this->getType()]; |
819 | 819 | } |
820 | 820 | |
821 | - /** |
|
822 | - * Whether excluded parameters should be highlighted in |
|
823 | - * a different color in the URL when using the |
|
824 | - * {@link URLInfo::getHighlighted()} method. |
|
825 | - * |
|
826 | - * @param bool $highlight |
|
827 | - * @return URLInfo |
|
828 | - */ |
|
821 | + /** |
|
822 | + * Whether excluded parameters should be highlighted in |
|
823 | + * a different color in the URL when using the |
|
824 | + * {@link URLInfo::getHighlighted()} method. |
|
825 | + * |
|
826 | + * @param bool $highlight |
|
827 | + * @return URLInfo |
|
828 | + */ |
|
829 | 829 | public function setHighlightExcluded(bool $highlight=true) : URLInfo |
830 | 830 | { |
831 | 831 | $this->highlightExcluded = $highlight; |
832 | 832 | return $this; |
833 | 833 | } |
834 | 834 | |
835 | - /** |
|
836 | - * Returns an array with all relevant URL information. |
|
837 | - * |
|
838 | - * @return array |
|
839 | - */ |
|
835 | + /** |
|
836 | + * Returns an array with all relevant URL information. |
|
837 | + * |
|
838 | + * @return array |
|
839 | + */ |
|
840 | 840 | public function toArray() : array |
841 | 841 | { |
842 | 842 | return array( |
@@ -880,24 +880,24 @@ discard block |
||
880 | 880 | return $this; |
881 | 881 | } |
882 | 882 | |
883 | - /** |
|
884 | - * Whether the parameter exclusion mode is enabled: |
|
885 | - * In this case, if any parameters have been added to the |
|
886 | - * exclusion list, all relevant methods will exclude these. |
|
887 | - * |
|
888 | - * @return bool |
|
889 | - */ |
|
883 | + /** |
|
884 | + * Whether the parameter exclusion mode is enabled: |
|
885 | + * In this case, if any parameters have been added to the |
|
886 | + * exclusion list, all relevant methods will exclude these. |
|
887 | + * |
|
888 | + * @return bool |
|
889 | + */ |
|
890 | 890 | public function isParamExclusionEnabled() : bool |
891 | 891 | { |
892 | 892 | return $this->paramExclusion; |
893 | 893 | } |
894 | 894 | |
895 | - /** |
|
896 | - * Checks whether the link contains any parameters that |
|
897 | - * are on the list of excluded parameters. |
|
898 | - * |
|
899 | - * @return bool |
|
900 | - */ |
|
895 | + /** |
|
896 | + * Checks whether the link contains any parameters that |
|
897 | + * are on the list of excluded parameters. |
|
898 | + * |
|
899 | + * @return bool |
|
900 | + */ |
|
901 | 901 | public function containsExcludedParams() : bool |
902 | 902 | { |
903 | 903 | if(empty($this->excludedParams)) { |
@@ -154,26 +154,26 @@ discard block |
||
154 | 154 | |
155 | 155 | $this->filterParsed(); |
156 | 156 | |
157 | - if($this->detectEmail()) { |
|
157 | + if ($this->detectEmail()) { |
|
158 | 158 | return; |
159 | 159 | } |
160 | 160 | |
161 | - if($this->detectFragmentLink()) { |
|
161 | + if ($this->detectFragmentLink()) { |
|
162 | 162 | return; |
163 | 163 | } |
164 | 164 | |
165 | - if($this->detectPhoneLink()) { |
|
165 | + if ($this->detectPhoneLink()) { |
|
166 | 166 | return; |
167 | 167 | } |
168 | 168 | |
169 | - if(!$this->isValid) { |
|
169 | + if (!$this->isValid) { |
|
170 | 170 | return; |
171 | 171 | } |
172 | 172 | |
173 | 173 | // no scheme found: it may be an email address without the mailto: |
174 | 174 | // It can't be a variable, since without the scheme it would already |
175 | 175 | // have been recognized as a vaiable only link. |
176 | - if(!isset($this->info['scheme'])) { |
|
176 | + if (!isset($this->info['scheme'])) { |
|
177 | 177 | $this->setError( |
178 | 178 | self::ERROR_MISSING_SCHEME, |
179 | 179 | t('Cannot determine the link\'s scheme, e.g. %1$s.', 'http') |
@@ -182,10 +182,10 @@ discard block |
||
182 | 182 | return; |
183 | 183 | } |
184 | 184 | |
185 | - if(!in_array($this->info['scheme'], $this->knownSchemes)) { |
|
185 | + if (!in_array($this->info['scheme'], $this->knownSchemes)) { |
|
186 | 186 | $this->setError( |
187 | 187 | self::ERROR_INVALID_SCHEME, |
188 | - t('The scheme %1$s is not supported for links.', $this->info['scheme']) . ' ' . |
|
188 | + t('The scheme %1$s is not supported for links.', $this->info['scheme']).' '. |
|
189 | 189 | t('Valid schemes are: %1$s.', implode(', ', $this->knownSchemes)) |
190 | 190 | ); |
191 | 191 | $this->isValid = false; |
@@ -195,17 +195,17 @@ discard block |
||
195 | 195 | // every link needs a host. This case can happen for ex, if |
196 | 196 | // the link starts with a typo with only one slash, like: |
197 | 197 | // "http:/hostname" |
198 | - if(!isset($this->info['host'])) { |
|
198 | + if (!isset($this->info['host'])) { |
|
199 | 199 | $this->setError( |
200 | 200 | self::ERROR_MISSING_HOST, |
201 | - t('Cannot determine the link\'s host name.') . ' ' . |
|
201 | + t('Cannot determine the link\'s host name.').' '. |
|
202 | 202 | t('This usually happens when there\'s a typo somewhere.') |
203 | 203 | ); |
204 | 204 | $this->isValid = false; |
205 | 205 | return; |
206 | 206 | } |
207 | 207 | |
208 | - if(!empty($this->info['query'])) |
|
208 | + if (!empty($this->info['query'])) |
|
209 | 209 | { |
210 | 210 | $this->params = \AppUtils\ConvertHelper::parseQueryString($this->info['query']); |
211 | 211 | ksort($this->params); |
@@ -250,30 +250,30 @@ discard block |
||
250 | 250 | */ |
251 | 251 | protected function filterParsed() |
252 | 252 | { |
253 | - foreach($this->info as $key => $val) |
|
253 | + foreach ($this->info as $key => $val) |
|
254 | 254 | { |
255 | - if(is_string($val)) { |
|
255 | + if (is_string($val)) { |
|
256 | 256 | $this->info[$key] = trim($val); |
257 | 257 | } |
258 | 258 | } |
259 | 259 | |
260 | - if(isset($this->info['host'])) { |
|
260 | + if (isset($this->info['host'])) { |
|
261 | 261 | $this->info['host'] = str_replace(' ', '', $this->info['host']); |
262 | 262 | } |
263 | 263 | |
264 | - if(isset($this->info['path'])) { |
|
264 | + if (isset($this->info['path'])) { |
|
265 | 265 | $this->info['path'] = str_replace(' ', '', $this->info['path']); |
266 | 266 | } |
267 | 267 | } |
268 | 268 | |
269 | 269 | protected function detectEmail() |
270 | 270 | { |
271 | - if(isset($this->info['scheme']) && $this->info['scheme'] == 'mailto') { |
|
271 | + if (isset($this->info['scheme']) && $this->info['scheme'] == 'mailto') { |
|
272 | 272 | $this->isEmail = true; |
273 | 273 | return true; |
274 | 274 | } |
275 | 275 | |
276 | - if(isset($this->info['path']) && preg_match(\AppUtils\RegexHelper::REGEX_EMAIL, $this->info['path'])) |
|
276 | + if (isset($this->info['path']) && preg_match(\AppUtils\RegexHelper::REGEX_EMAIL, $this->info['path'])) |
|
277 | 277 | { |
278 | 278 | $this->info['scheme'] = 'email'; |
279 | 279 | $this->isEmail = true; |
@@ -285,7 +285,7 @@ discard block |
||
285 | 285 | |
286 | 286 | protected function detectFragmentLink() |
287 | 287 | { |
288 | - if(isset($this->info['fragment']) && !isset($this->info['scheme'])) { |
|
288 | + if (isset($this->info['fragment']) && !isset($this->info['scheme'])) { |
|
289 | 289 | $this->isFragment = true; |
290 | 290 | return true; |
291 | 291 | } |
@@ -295,7 +295,7 @@ discard block |
||
295 | 295 | |
296 | 296 | protected function detectPhoneLink() |
297 | 297 | { |
298 | - if(isset($this->info['scheme']) && $this->info['scheme'] == 'tel') { |
|
298 | + if (isset($this->info['scheme']) && $this->info['scheme'] == 'tel') { |
|
299 | 299 | $this->isPhone = true; |
300 | 300 | return true; |
301 | 301 | } |
@@ -309,7 +309,7 @@ discard block |
||
309 | 309 | */ |
310 | 310 | public function isSecure() |
311 | 311 | { |
312 | - if(isset($this->info['scheme']) && $this->info['scheme']=='https') { |
|
312 | + if (isset($this->info['scheme']) && $this->info['scheme'] == 'https') { |
|
313 | 313 | return true; |
314 | 314 | } |
315 | 315 | |
@@ -384,7 +384,7 @@ discard block |
||
384 | 384 | public function getPort() : int |
385 | 385 | { |
386 | 386 | $port = $this->getInfoKey('port'); |
387 | - if(!empty($port)) { |
|
387 | + if (!empty($port)) { |
|
388 | 388 | return (int)$port; |
389 | 389 | } |
390 | 390 | |
@@ -464,7 +464,7 @@ discard block |
||
464 | 464 | |
465 | 465 | protected function getInfoKey(string $name) : string |
466 | 466 | { |
467 | - if(isset($this->info[$name])) { |
|
467 | + if (isset($this->info[$name])) { |
|
468 | 468 | return (string)$this->info[$name]; |
469 | 469 | } |
470 | 470 | |
@@ -473,34 +473,34 @@ discard block |
||
473 | 473 | |
474 | 474 | public function getNormalized() : string |
475 | 475 | { |
476 | - if(!$this->isValid) { |
|
476 | + if (!$this->isValid) { |
|
477 | 477 | return ''; |
478 | 478 | } |
479 | 479 | |
480 | - if($this->isFragment === true) |
|
480 | + if ($this->isFragment === true) |
|
481 | 481 | { |
482 | 482 | return '#'.$this->getFragment(); |
483 | 483 | } |
484 | - else if($this->isPhone === true) |
|
484 | + else if ($this->isPhone === true) |
|
485 | 485 | { |
486 | 486 | return 'tel://'.$this->getHost(); |
487 | 487 | } |
488 | - else if($this->isEmail === true) |
|
488 | + else if ($this->isEmail === true) |
|
489 | 489 | { |
490 | 490 | return 'mailto:'.$this->getPath(); |
491 | 491 | } |
492 | 492 | |
493 | 493 | $normalized = $this->info['scheme'].'://'.$this->info['host']; |
494 | - if(isset($this->info['path'])) { |
|
494 | + if (isset($this->info['path'])) { |
|
495 | 495 | $normalized .= $this->info['path']; |
496 | 496 | } |
497 | 497 | |
498 | 498 | $params = $this->getParams(); |
499 | - if(!empty($params)) { |
|
499 | + if (!empty($params)) { |
|
500 | 500 | $normalized .= '?'.http_build_query($params); |
501 | 501 | } |
502 | 502 | |
503 | - if(isset($this->info['fragment'])) { |
|
503 | + if (isset($this->info['fragment'])) { |
|
504 | 504 | $normalized .= '#'.$this->info['fragment']; |
505 | 505 | } |
506 | 506 | |
@@ -528,11 +528,11 @@ discard block |
||
528 | 528 | */ |
529 | 529 | public function getHighlighted() : string |
530 | 530 | { |
531 | - if(!$this->isValid) { |
|
531 | + if (!$this->isValid) { |
|
532 | 532 | return ''; |
533 | 533 | } |
534 | 534 | |
535 | - if($this->isEmail) { |
|
535 | + if ($this->isEmail) { |
|
536 | 536 | return sprintf( |
537 | 537 | '<span class="link-scheme scheme-mailto">mailto:</span>'. |
538 | 538 | '<span class="link-host">%s</span>', |
@@ -540,7 +540,7 @@ discard block |
||
540 | 540 | ); |
541 | 541 | } |
542 | 542 | |
543 | - if($this->isFragment) { |
|
543 | + if ($this->isFragment) { |
|
544 | 544 | return sprintf( |
545 | 545 | '<span class="link-fragment-sign">#</span>'. |
546 | 546 | '<span class="link-fragment-value">%s</span>', |
@@ -550,7 +550,7 @@ discard block |
||
550 | 550 | |
551 | 551 | $result = ''; |
552 | 552 | |
553 | - if($this->hasScheme()) |
|
553 | + if ($this->hasScheme()) |
|
554 | 554 | { |
555 | 555 | $result = sprintf( |
556 | 556 | '<span class="link-scheme scheme-%1$s">'. |
@@ -562,7 +562,7 @@ discard block |
||
562 | 562 | |
563 | 563 | $result .= '<span class="link-component double-slashes">//</span>'; |
564 | 564 | |
565 | - if($this->hasUsername()) |
|
565 | + if ($this->hasUsername()) |
|
566 | 566 | { |
567 | 567 | $result .= sprintf( |
568 | 568 | '<span class="link-credentials">%s</span>'. |
@@ -574,7 +574,7 @@ discard block |
||
574 | 574 | ); |
575 | 575 | } |
576 | 576 | |
577 | - if($this->hasHost()) |
|
577 | + if ($this->hasHost()) |
|
578 | 578 | { |
579 | 579 | $result .= |
580 | 580 | sprintf( |
@@ -583,7 +583,7 @@ discard block |
||
583 | 583 | ); |
584 | 584 | } |
585 | 585 | |
586 | - if($this->hasPort()) |
|
586 | + if ($this->hasPort()) |
|
587 | 587 | { |
588 | 588 | $result .= sprintf( |
589 | 589 | '<span class="link-component port-separator">:</span>'. |
@@ -592,7 +592,7 @@ discard block |
||
592 | 592 | ); |
593 | 593 | } |
594 | 594 | |
595 | - if($this->hasPath()) |
|
595 | + if ($this->hasPath()) |
|
596 | 596 | { |
597 | 597 | $path = str_replace(array(';', '='), array(';<wbr>', '=<wbr>'), $this->getPath()); |
598 | 598 | $tokens = explode('/', $path); |
@@ -603,11 +603,11 @@ discard block |
||
603 | 603 | ); |
604 | 604 | } |
605 | 605 | |
606 | - if(!empty($this->params)) |
|
606 | + if (!empty($this->params)) |
|
607 | 607 | { |
608 | 608 | $tokens = array(); |
609 | 609 | |
610 | - foreach($this->params as $param => $value) |
|
610 | + foreach ($this->params as $param => $value) |
|
611 | 611 | { |
612 | 612 | $parts = sprintf( |
613 | 613 | '<span class="link-param-name">%s</span>'. |
@@ -625,10 +625,10 @@ discard block |
||
625 | 625 | $tag = ''; |
626 | 626 | |
627 | 627 | // is parameter exclusion enabled, and is this an excluded parameter? |
628 | - if($this->paramExclusion && isset($this->excludedParams[$param])) |
|
628 | + if ($this->paramExclusion && isset($this->excludedParams[$param])) |
|
629 | 629 | { |
630 | 630 | // display the excluded parameter, but highlight it |
631 | - if($this->highlightExcluded) |
|
631 | + if ($this->highlightExcluded) |
|
632 | 632 | { |
633 | 633 | $tooltip = $this->excludedParams[$param]; |
634 | 634 | |
@@ -658,7 +658,7 @@ discard block |
||
658 | 658 | '<span class="link-component query-sign">?</span>'.implode('<span class="link-component param-separator">&</span>', $tokens); |
659 | 659 | } |
660 | 660 | |
661 | - if(isset($this->info['fragment'])) { |
|
661 | + if (isset($this->info['fragment'])) { |
|
662 | 662 | $result .= sprintf( |
663 | 663 | '<span class="link-fragment-sign">#</span>'. |
664 | 664 | '<span class="link-fragment">%s</span>', |
@@ -681,7 +681,7 @@ discard block |
||
681 | 681 | |
682 | 682 | public function getErrorMessage() : string |
683 | 683 | { |
684 | - if(isset($this->error)) { |
|
684 | + if (isset($this->error)) { |
|
685 | 685 | return $this->error['message']; |
686 | 686 | } |
687 | 687 | |
@@ -690,7 +690,7 @@ discard block |
||
690 | 690 | |
691 | 691 | public function getErrorCode() : int |
692 | 692 | { |
693 | - if(isset($this->error)) { |
|
693 | + if (isset($this->error)) { |
|
694 | 694 | return $this->error['code']; |
695 | 695 | } |
696 | 696 | |
@@ -720,13 +720,13 @@ discard block |
||
720 | 720 | */ |
721 | 721 | public function getParams() : array |
722 | 722 | { |
723 | - if(!$this->paramExclusion || empty($this->excludedParams)) { |
|
723 | + if (!$this->paramExclusion || empty($this->excludedParams)) { |
|
724 | 724 | return $this->params; |
725 | 725 | } |
726 | 726 | |
727 | 727 | $keep = array(); |
728 | - foreach($this->params as $name => $value) { |
|
729 | - if(!isset($this->excludedParams[$name])) { |
|
728 | + foreach ($this->params as $name => $value) { |
|
729 | + if (!isset($this->excludedParams[$name])) { |
|
730 | 730 | $keep[$name] = $value; |
731 | 731 | } |
732 | 732 | } |
@@ -756,7 +756,7 @@ discard block |
||
756 | 756 | */ |
757 | 757 | public function excludeParam(string $name, string $reason) : URLInfo |
758 | 758 | { |
759 | - if(!isset($this->excludedParams[$name])) |
|
759 | + if (!isset($this->excludedParams[$name])) |
|
760 | 760 | { |
761 | 761 | $this->excludedParams[$name] = $reason; |
762 | 762 | $this->setParamExclusion(); |
@@ -777,15 +777,15 @@ discard block |
||
777 | 777 | */ |
778 | 778 | public function getType() : string |
779 | 779 | { |
780 | - if($this->isEmail) { |
|
780 | + if ($this->isEmail) { |
|
781 | 781 | return self::TYPE_EMAIL; |
782 | 782 | } |
783 | 783 | |
784 | - if($this->isFragment) { |
|
784 | + if ($this->isFragment) { |
|
785 | 785 | return self::TYPE_FRAGMENT; |
786 | 786 | } |
787 | 787 | |
788 | - if($this->isPhone) { |
|
788 | + if ($this->isPhone) { |
|
789 | 789 | return self::TYPE_PHONE; |
790 | 790 | } |
791 | 791 | |
@@ -794,7 +794,7 @@ discard block |
||
794 | 794 | |
795 | 795 | public function getTypeLabel() : string |
796 | 796 | { |
797 | - if(!isset(self::$typeLabels)) |
|
797 | + if (!isset(self::$typeLabels)) |
|
798 | 798 | { |
799 | 799 | self::$typeLabels = array( |
800 | 800 | self::TYPE_EMAIL => t('Email'), |
@@ -806,7 +806,7 @@ discard block |
||
806 | 806 | |
807 | 807 | $type = $this->getType(); |
808 | 808 | |
809 | - if(!isset(self::$typeLabels[$type])) |
|
809 | + if (!isset(self::$typeLabels[$type])) |
|
810 | 810 | { |
811 | 811 | throw new BaseException( |
812 | 812 | sprintf('Unknown URL type label for type [%s].', $type), |
@@ -826,7 +826,7 @@ discard block |
||
826 | 826 | * @param bool $highlight |
827 | 827 | * @return URLInfo |
828 | 828 | */ |
829 | - public function setHighlightExcluded(bool $highlight=true) : URLInfo |
|
829 | + public function setHighlightExcluded(bool $highlight = true) : URLInfo |
|
830 | 830 | { |
831 | 831 | $this->highlightExcluded = $highlight; |
832 | 832 | return $this; |
@@ -874,7 +874,7 @@ discard block |
||
874 | 874 | * @see URLInfo::isParamExclusionEnabled() |
875 | 875 | * @see URLInfo::setHighlightExcluded() |
876 | 876 | */ |
877 | - public function setParamExclusion(bool $enabled=true) : URLInfo |
|
877 | + public function setParamExclusion(bool $enabled = true) : URLInfo |
|
878 | 878 | { |
879 | 879 | $this->paramExclusion = $enabled; |
880 | 880 | return $this; |
@@ -900,13 +900,13 @@ discard block |
||
900 | 900 | */ |
901 | 901 | public function containsExcludedParams() : bool |
902 | 902 | { |
903 | - if(empty($this->excludedParams)) { |
|
903 | + if (empty($this->excludedParams)) { |
|
904 | 904 | return false; |
905 | 905 | } |
906 | 906 | |
907 | 907 | $names = array_keys($this->params); |
908 | - foreach($names as $name) { |
|
909 | - if(isset($this->excludedParams[$name])) { |
|
908 | + foreach ($names as $name) { |
|
909 | + if (isset($this->excludedParams[$name])) { |
|
910 | 910 | return true; |
911 | 911 | } |
912 | 912 | } |
@@ -922,7 +922,7 @@ discard block |
||
922 | 922 | |
923 | 923 | public function offsetSet($offset, $value) |
924 | 924 | { |
925 | - if(in_array($offset, $this->infoKeys)) { |
|
925 | + if (in_array($offset, $this->infoKeys)) { |
|
926 | 926 | $this->info[$offset] = $value; |
927 | 927 | } |
928 | 928 | } |
@@ -939,11 +939,11 @@ discard block |
||
939 | 939 | |
940 | 940 | public function offsetGet($offset) |
941 | 941 | { |
942 | - if($offset === 'port') { |
|
942 | + if ($offset === 'port') { |
|
943 | 943 | return $this->getPort(); |
944 | 944 | } |
945 | 945 | |
946 | - if(in_array($offset, $this->infoKeys)) { |
|
946 | + if (in_array($offset, $this->infoKeys)) { |
|
947 | 947 | return $this->getInfoKey($offset); |
948 | 948 | } |
949 | 949 | |
@@ -954,7 +954,7 @@ discard block |
||
954 | 954 | { |
955 | 955 | $cssFolder = realpath(__DIR__.'/../css'); |
956 | 956 | |
957 | - if($cssFolder === false) { |
|
957 | + if ($cssFolder === false) { |
|
958 | 958 | throw new BaseException( |
959 | 959 | 'Cannot find package CSS folder.', |
960 | 960 | null, |
@@ -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 | - * @deprecated Will be replaced by the file finder in the future. |
|
750 | - * @see FileHelper::createFileFinder() |
|
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 | + * @deprecated Will be replaced by the file finder in the future. |
|
750 | + * @see FileHelper::createFileFinder() |
|
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 | * @deprecated Will be replaced by the file finder in the future. |
750 | 750 | * @see FileHelper::createFileFinder() |
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 |