@@ -28,9 +28,9 @@ discard block |
||
28 | 28 | { |
29 | 29 | const ERROR_CANNOT_APPEND_FRAGMENT = 491001; |
30 | 30 | |
31 | - /** |
|
32 | - * @var boolean |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var boolean |
|
33 | + */ |
|
34 | 34 | private static $simulation = false; |
35 | 35 | |
36 | 36 | /** |
@@ -38,11 +38,11 @@ discard block |
||
38 | 38 | */ |
39 | 39 | private $dom; |
40 | 40 | |
41 | - /** |
|
42 | - * Creates a new XMLHelper instance. |
|
43 | - * |
|
44 | - * @return XMLHelper |
|
45 | - */ |
|
41 | + /** |
|
42 | + * Creates a new XMLHelper instance. |
|
43 | + * |
|
44 | + * @return XMLHelper |
|
45 | + */ |
|
46 | 46 | public static function create() : XMLHelper |
47 | 47 | { |
48 | 48 | $dom = new DOMDocument('1.0', 'UTF-8'); |
@@ -51,72 +51,72 @@ discard block |
||
51 | 51 | return new XMLHelper($dom); |
52 | 52 | } |
53 | 53 | |
54 | - /** |
|
55 | - * Creates a converter instance from an XML file. |
|
56 | - * @param string $xmlFile |
|
57 | - * @return XMLHelper_Converter |
|
58 | - */ |
|
54 | + /** |
|
55 | + * Creates a converter instance from an XML file. |
|
56 | + * @param string $xmlFile |
|
57 | + * @return XMLHelper_Converter |
|
58 | + */ |
|
59 | 59 | public static function convertFile(string $xmlFile) : XMLHelper_Converter |
60 | 60 | { |
61 | 61 | return XMLHelper_Converter::fromFile($xmlFile); |
62 | 62 | } |
63 | 63 | |
64 | - /** |
|
65 | - * Creates a converter from an XML string. |
|
66 | - * @param string $xmlString |
|
67 | - * @return XMLHelper_Converter |
|
68 | - */ |
|
64 | + /** |
|
65 | + * Creates a converter from an XML string. |
|
66 | + * @param string $xmlString |
|
67 | + * @return XMLHelper_Converter |
|
68 | + */ |
|
69 | 69 | public static function convertString(string $xmlString) : XMLHelper_Converter |
70 | 70 | { |
71 | 71 | return XMLHelper_Converter::fromString($xmlString); |
72 | 72 | } |
73 | 73 | |
74 | - /** |
|
75 | - * Creates a converter from a SimpleXMLElement instance. |
|
76 | - * @param SimpleXMLElement $element |
|
77 | - * @return XMLHelper_Converter |
|
78 | - */ |
|
74 | + /** |
|
75 | + * Creates a converter from a SimpleXMLElement instance. |
|
76 | + * @param SimpleXMLElement $element |
|
77 | + * @return XMLHelper_Converter |
|
78 | + */ |
|
79 | 79 | public static function convertElement(SimpleXMLElement $element) : XMLHelper_Converter |
80 | 80 | { |
81 | 81 | return XMLHelper_Converter::fromElement($element); |
82 | 82 | } |
83 | 83 | |
84 | - /** |
|
85 | - * Creates a converter from a DOMElement instance. |
|
86 | - * @param DOMElement $element |
|
87 | - * @return XMLHelper_Converter |
|
88 | - */ |
|
84 | + /** |
|
85 | + * Creates a converter from a DOMElement instance. |
|
86 | + * @param DOMElement $element |
|
87 | + * @return XMLHelper_Converter |
|
88 | + */ |
|
89 | 89 | public static function convertDOMElement(DOMElement $element) : XMLHelper_Converter |
90 | 90 | { |
91 | 91 | return XMLHelper_Converter::fromDOMElement($element); |
92 | 92 | } |
93 | 93 | |
94 | - /** |
|
95 | - * Creates a new helper using an existing DOMDocument object. |
|
96 | - * @param DOMDocument $dom |
|
97 | - */ |
|
94 | + /** |
|
95 | + * Creates a new helper using an existing DOMDocument object. |
|
96 | + * @param DOMDocument $dom |
|
97 | + */ |
|
98 | 98 | public function __construct(DOMDocument $dom) |
99 | 99 | { |
100 | 100 | $this->dom = $dom; |
101 | 101 | } |
102 | 102 | |
103 | - /** |
|
104 | - * @return DOMDocument |
|
105 | - */ |
|
103 | + /** |
|
104 | + * @return DOMDocument |
|
105 | + */ |
|
106 | 106 | public function getDOM() : DOMDocument |
107 | 107 | { |
108 | 108 | return $this->dom; |
109 | 109 | } |
110 | 110 | |
111 | - /** |
|
112 | - * Adds an attribute to an existing tag with |
|
113 | - * the specified value. |
|
114 | - * |
|
115 | - * @param DOMNode $parent |
|
116 | - * @param string $name |
|
117 | - * @param mixed $value |
|
118 | - * @return DOMNode |
|
119 | - */ |
|
111 | + /** |
|
112 | + * Adds an attribute to an existing tag with |
|
113 | + * the specified value. |
|
114 | + * |
|
115 | + * @param DOMNode $parent |
|
116 | + * @param string $name |
|
117 | + * @param mixed $value |
|
118 | + * @return DOMNode |
|
119 | + */ |
|
120 | 120 | public function addAttribute(DOMNode $parent, string $name, $value) |
121 | 121 | { |
122 | 122 | $node = $this->dom->createAttribute($name); |
@@ -126,12 +126,12 @@ discard block |
||
126 | 126 | return $parent->appendChild($node); |
127 | 127 | } |
128 | 128 | |
129 | - /** |
|
130 | - * Adds several attributes to the target node. |
|
131 | - * |
|
132 | - * @param DOMNode $parent |
|
133 | - * @param array<string,mixed> $attributes |
|
134 | - */ |
|
129 | + /** |
|
130 | + * Adds several attributes to the target node. |
|
131 | + * |
|
132 | + * @param DOMNode $parent |
|
133 | + * @param array<string,mixed> $attributes |
|
134 | + */ |
|
135 | 135 | public function addAttributes(DOMNode $parent, array $attributes) : void |
136 | 136 | { |
137 | 137 | foreach ($attributes as $name => $value) { |
@@ -139,14 +139,14 @@ discard block |
||
139 | 139 | } |
140 | 140 | } |
141 | 141 | |
142 | - /** |
|
143 | - * Adds a tag without content. |
|
144 | - * |
|
145 | - * @param DOMNode $parent |
|
146 | - * @param string $name |
|
147 | - * @param integer $indent |
|
148 | - * @return DOMNode |
|
149 | - */ |
|
142 | + /** |
|
143 | + * Adds a tag without content. |
|
144 | + * |
|
145 | + * @param DOMNode $parent |
|
146 | + * @param string $name |
|
147 | + * @param integer $indent |
|
148 | + * @return DOMNode |
|
149 | + */ |
|
150 | 150 | public function addTag(DOMNode $parent, string $name, int $indent = 0) : DOMNode |
151 | 151 | { |
152 | 152 | if ($indent > 0) { |
@@ -168,17 +168,17 @@ discard block |
||
168 | 168 | $parent->appendChild($this->dom->createTextNode(str_repeat("\t", $amount))); |
169 | 169 | } |
170 | 170 | |
171 | - /** |
|
172 | - * Adds a tag with textual content, like: |
|
173 | - * |
|
174 | - * <tagname>text</tagname> |
|
175 | - * |
|
176 | - * @param DOMNode $parent |
|
177 | - * @param string $name |
|
178 | - * @param string $text |
|
179 | - * @param integer $indent |
|
180 | - * @return DOMNode |
|
181 | - */ |
|
171 | + /** |
|
172 | + * Adds a tag with textual content, like: |
|
173 | + * |
|
174 | + * <tagname>text</tagname> |
|
175 | + * |
|
176 | + * @param DOMNode $parent |
|
177 | + * @param string $name |
|
178 | + * @param string $text |
|
179 | + * @param integer $indent |
|
180 | + * @return DOMNode |
|
181 | + */ |
|
182 | 182 | public function addTextTag(DOMNode $parent, string $name, string $text, int $indent = 0) : DOMNode |
183 | 183 | { |
184 | 184 | if ($indent > 0) { |
@@ -192,19 +192,19 @@ discard block |
||
192 | 192 | return $parent->appendChild($tag); |
193 | 193 | } |
194 | 194 | |
195 | - /** |
|
196 | - * Adds a tag with textual content, like: |
|
197 | - * |
|
198 | - * <tagname>text</tagname> |
|
199 | - * |
|
200 | - * and removes <p> tags |
|
201 | - * |
|
202 | - * @param DOMNode $parent |
|
203 | - * @param string $name |
|
204 | - * @param string $text |
|
205 | - * @param integer $indent |
|
206 | - * @return DOMNode |
|
207 | - */ |
|
195 | + /** |
|
196 | + * Adds a tag with textual content, like: |
|
197 | + * |
|
198 | + * <tagname>text</tagname> |
|
199 | + * |
|
200 | + * and removes <p> tags |
|
201 | + * |
|
202 | + * @param DOMNode $parent |
|
203 | + * @param string $name |
|
204 | + * @param string $text |
|
205 | + * @param integer $indent |
|
206 | + * @return DOMNode |
|
207 | + */ |
|
208 | 208 | public function addEscapedTag(DOMNode $parent, string $name, string $text, int $indent = 0) |
209 | 209 | { |
210 | 210 | if ($indent > 0) { |
@@ -220,19 +220,19 @@ discard block |
||
220 | 220 | return $parent->appendChild($tag); |
221 | 221 | } |
222 | 222 | |
223 | - /** |
|
224 | - * Adds a tag with HTML content, like: |
|
225 | - * |
|
226 | - * <tagname><i>text</i></tagname> |
|
227 | - * |
|
228 | - * Tags will not be escaped. |
|
229 | - * |
|
230 | - * @param DOMNode $parent |
|
231 | - * @param string $name |
|
232 | - * @param string $text |
|
233 | - * @param integer $indent |
|
234 | - * @return DOMNode |
|
235 | - */ |
|
223 | + /** |
|
224 | + * Adds a tag with HTML content, like: |
|
225 | + * |
|
226 | + * <tagname><i>text</i></tagname> |
|
227 | + * |
|
228 | + * Tags will not be escaped. |
|
229 | + * |
|
230 | + * @param DOMNode $parent |
|
231 | + * @param string $name |
|
232 | + * @param string $text |
|
233 | + * @param integer $indent |
|
234 | + * @return DOMNode |
|
235 | + */ |
|
236 | 236 | public function addFragmentTag(DOMNode $parent, string $name, string $text, int $indent = 0) |
237 | 237 | { |
238 | 238 | if ($indent > 0) { |
@@ -260,16 +260,16 @@ discard block |
||
260 | 260 | return $parent->appendChild($tag); |
261 | 261 | } |
262 | 262 | |
263 | - /** |
|
264 | - * Adds a tag with CDATA content, like: |
|
265 | - * |
|
266 | - * <tagname><![CDATA[value]]></tagname> |
|
267 | - * |
|
268 | - * @param DOMNode $parent |
|
269 | - * @param string $name |
|
270 | - * @param string $content |
|
271 | - * @return DOMNode |
|
272 | - */ |
|
263 | + /** |
|
264 | + * Adds a tag with CDATA content, like: |
|
265 | + * |
|
266 | + * <tagname><![CDATA[value]]></tagname> |
|
267 | + * |
|
268 | + * @param DOMNode $parent |
|
269 | + * @param string $name |
|
270 | + * @param string $content |
|
271 | + * @return DOMNode |
|
272 | + */ |
|
273 | 273 | public function addCDATATag(DOMNode $parent, string $name, string $content) : DOMNode |
274 | 274 | { |
275 | 275 | $tag = $this->dom->createElement($name); |
@@ -279,12 +279,12 @@ discard block |
||
279 | 279 | return $parent->appendChild($tag); |
280 | 280 | } |
281 | 281 | |
282 | - /** |
|
283 | - * Creates the root element of the document. |
|
284 | - * @param string $name |
|
285 | - * @param array<string,mixed> $attributes |
|
286 | - * @return DOMNode |
|
287 | - */ |
|
282 | + /** |
|
283 | + * Creates the root element of the document. |
|
284 | + * @param string $name |
|
285 | + * @param array<string,mixed> $attributes |
|
286 | + * @return DOMNode |
|
287 | + */ |
|
288 | 288 | public function createRoot(string $name, array $attributes=array()) |
289 | 289 | { |
290 | 290 | $root = $this->dom->appendChild($this->dom->createElement($name)); |
@@ -292,12 +292,12 @@ discard block |
||
292 | 292 | return $root; |
293 | 293 | } |
294 | 294 | |
295 | - /** |
|
296 | - * Escaped the string for use in XML. |
|
297 | - * |
|
298 | - * @param string $string |
|
299 | - * @return string |
|
300 | - */ |
|
295 | + /** |
|
296 | + * Escaped the string for use in XML. |
|
297 | + * |
|
298 | + * @param string $string |
|
299 | + * @return string |
|
300 | + */ |
|
301 | 301 | public function escape(string $string) : string |
302 | 302 | { |
303 | 303 | $string = preg_replace('#<p>(.*)</p>#isUm', '$1', $string); |
@@ -317,18 +317,18 @@ discard block |
||
317 | 317 | return $string; |
318 | 318 | } |
319 | 319 | |
320 | - /** |
|
321 | - * Sends the specified XML string to the browser with |
|
322 | - * the correct headers to trigger a download of the XML |
|
323 | - * to a local file. |
|
324 | - * |
|
325 | - * NOTE: Ensure calling exit after this is done, and to |
|
326 | - * not send additional content, which would corrupt the |
|
327 | - * download. |
|
328 | - * |
|
329 | - * @param string $xml |
|
330 | - * @param string $filename |
|
331 | - */ |
|
320 | + /** |
|
321 | + * Sends the specified XML string to the browser with |
|
322 | + * the correct headers to trigger a download of the XML |
|
323 | + * to a local file. |
|
324 | + * |
|
325 | + * NOTE: Ensure calling exit after this is done, and to |
|
326 | + * not send additional content, which would corrupt the |
|
327 | + * download. |
|
328 | + * |
|
329 | + * @param string $xml |
|
330 | + * @param string $filename |
|
331 | + */ |
|
332 | 332 | public static function downloadXML(string $xml, string $filename = 'download.xml') : void |
333 | 333 | { |
334 | 334 | if(!headers_sent() && !self::$simulation) |
@@ -339,12 +339,12 @@ discard block |
||
339 | 339 | echo $xml; |
340 | 340 | } |
341 | 341 | |
342 | - /** |
|
343 | - * Sends the specified XML string to the browser with |
|
344 | - * the correct headers and terminates the request. |
|
345 | - * |
|
346 | - * @param string $xml |
|
347 | - */ |
|
342 | + /** |
|
343 | + * Sends the specified XML string to the browser with |
|
344 | + * the correct headers and terminates the request. |
|
345 | + * |
|
346 | + * @param string $xml |
|
347 | + */ |
|
348 | 348 | public static function displayXML(string $xml) : void |
349 | 349 | { |
350 | 350 | if(!headers_sent() && !self::$simulation) |
@@ -411,23 +411,23 @@ discard block |
||
411 | 411 | return $xml->saveXML(); |
412 | 412 | } |
413 | 413 | |
414 | - /** |
|
415 | - * Creates XML markup to describe an application error |
|
416 | - * when using XML services. Creates XML with the |
|
417 | - * following structure: |
|
418 | - * |
|
419 | - * <error> |
|
420 | - * <id>99</id> |
|
421 | - * <message>Full error message text</message> |
|
422 | - * <title>Short error label</title> |
|
423 | - * </error> |
|
424 | - * |
|
425 | - * @param string|number $code |
|
426 | - * @param string $message |
|
427 | - * @param string $title |
|
428 | - * @param array<string,string> $customInfo |
|
429 | - * @return string |
|
430 | - */ |
|
414 | + /** |
|
415 | + * Creates XML markup to describe an application error |
|
416 | + * when using XML services. Creates XML with the |
|
417 | + * following structure: |
|
418 | + * |
|
419 | + * <error> |
|
420 | + * <id>99</id> |
|
421 | + * <message>Full error message text</message> |
|
422 | + * <title>Short error label</title> |
|
423 | + * </error> |
|
424 | + * |
|
425 | + * @param string|number $code |
|
426 | + * @param string $message |
|
427 | + * @param string $title |
|
428 | + * @param array<string,string> $customInfo |
|
429 | + * @return string |
|
430 | + */ |
|
431 | 431 | public static function buildErrorXML($code, string $message, string $title, array $customInfo=array()) |
432 | 432 | { |
433 | 433 | $xml = new DOMDocument('1.0', 'UTF-8'); |
@@ -460,31 +460,31 @@ discard block |
||
460 | 460 | return $this->dom->saveXML(); |
461 | 461 | } |
462 | 462 | |
463 | - /** |
|
464 | - * Creates a new SimpleXML helper instance: this |
|
465 | - * object is useful to work with loading XML strings |
|
466 | - * and files with easy access to any errors that |
|
467 | - * may occurr, since the simplexml functions can be |
|
468 | - * somewhat cryptic. |
|
469 | - * |
|
470 | - * @return XMLHelper_SimpleXML |
|
471 | - */ |
|
463 | + /** |
|
464 | + * Creates a new SimpleXML helper instance: this |
|
465 | + * object is useful to work with loading XML strings |
|
466 | + * and files with easy access to any errors that |
|
467 | + * may occurr, since the simplexml functions can be |
|
468 | + * somewhat cryptic. |
|
469 | + * |
|
470 | + * @return XMLHelper_SimpleXML |
|
471 | + */ |
|
472 | 472 | public static function createSimplexml() : XMLHelper_SimpleXML |
473 | 473 | { |
474 | 474 | return new XMLHelper_SimpleXML(); |
475 | 475 | } |
476 | 476 | |
477 | - /** |
|
478 | - * Converts a string to valid XML: can be a text only string |
|
479 | - * or an HTML string. Returns valid XML code. |
|
480 | - * |
|
481 | - * NOTE: The string may contain custom tags, which are |
|
482 | - * preserved. |
|
483 | - * |
|
484 | - * @param string $string |
|
485 | - * @throws XMLHelper_Exception |
|
486 | - * @return string |
|
487 | - */ |
|
477 | + /** |
|
478 | + * Converts a string to valid XML: can be a text only string |
|
479 | + * or an HTML string. Returns valid XML code. |
|
480 | + * |
|
481 | + * NOTE: The string may contain custom tags, which are |
|
482 | + * preserved. |
|
483 | + * |
|
484 | + * @param string $string |
|
485 | + * @throws XMLHelper_Exception |
|
486 | + * @return string |
|
487 | + */ |
|
488 | 488 | public static function string2xml(string $string) : string |
489 | 489 | { |
490 | 490 | return XMLHelper_HTMLLoader::loadFragment($string)->fragmentToXML(); |
@@ -243,7 +243,7 @@ discard block |
||
243 | 243 | |
244 | 244 | if (!empty($text)) { |
245 | 245 | $fragment = $this->dom->createDocumentFragment(); |
246 | - if(!@$fragment->appendXML($text)) { |
|
246 | + if (!@$fragment->appendXML($text)) { |
|
247 | 247 | throw new XMLHelper_Exception( |
248 | 248 | 'Cannot append XML fragment', |
249 | 249 | sprintf( |
@@ -285,7 +285,7 @@ discard block |
||
285 | 285 | * @param array<string,mixed> $attributes |
286 | 286 | * @return DOMNode |
287 | 287 | */ |
288 | - public function createRoot(string $name, array $attributes=array()) |
|
288 | + public function createRoot(string $name, array $attributes = array()) |
|
289 | 289 | { |
290 | 290 | $root = $this->dom->appendChild($this->dom->createElement($name)); |
291 | 291 | $this->addAttributes($root, $attributes); |
@@ -311,8 +311,8 @@ discard block |
||
311 | 311 | $string = str_replace('<', 'LT_ESCAPE', $string); |
312 | 312 | $string = str_replace('>', 'GT_ESCAPE', $string); |
313 | 313 | |
314 | - $string = str_replace(' ',' ', $string); |
|
315 | - $string = str_replace('&','&', $string); |
|
314 | + $string = str_replace(' ', ' ', $string); |
|
315 | + $string = str_replace('&', '&', $string); |
|
316 | 316 | |
317 | 317 | return $string; |
318 | 318 | } |
@@ -331,9 +331,9 @@ discard block |
||
331 | 331 | */ |
332 | 332 | public static function downloadXML(string $xml, string $filename = 'download.xml') : void |
333 | 333 | { |
334 | - if(!headers_sent() && !self::$simulation) |
|
334 | + if (!headers_sent() && !self::$simulation) |
|
335 | 335 | { |
336 | - header('Content-Disposition: attachment; filename="' . $filename . '"'); |
|
336 | + header('Content-Disposition: attachment; filename="'.$filename.'"'); |
|
337 | 337 | } |
338 | 338 | |
339 | 339 | echo $xml; |
@@ -347,12 +347,12 @@ discard block |
||
347 | 347 | */ |
348 | 348 | public static function displayXML(string $xml) : void |
349 | 349 | { |
350 | - if(!headers_sent() && !self::$simulation) |
|
350 | + if (!headers_sent() && !self::$simulation) |
|
351 | 351 | { |
352 | 352 | header('Content-Type:text/xml; charset=utf-8'); |
353 | 353 | } |
354 | 354 | |
355 | - if(self::$simulation) |
|
355 | + if (self::$simulation) |
|
356 | 356 | { |
357 | 357 | $xml = '<pre>'.htmlspecialchars($xml).'</pre>'; |
358 | 358 | } |
@@ -370,16 +370,16 @@ discard block |
||
370 | 370 | * @param array<string,string> $customInfo Associative array with name => value pairs for custom tags to add to the output xml |
371 | 371 | * @see buildErrorXML() |
372 | 372 | */ |
373 | - public static function displayErrorXML($code, string $message, string $title, array $customInfo=array()) |
|
373 | + public static function displayErrorXML($code, string $message, string $title, array $customInfo = array()) |
|
374 | 374 | { |
375 | - if(!headers_sent() && !self::$simulation) { |
|
376 | - header('HTTP/1.1 400 Bad Request: ' . $title, true, 400); |
|
375 | + if (!headers_sent() && !self::$simulation) { |
|
376 | + header('HTTP/1.1 400 Bad Request: '.$title, true, 400); |
|
377 | 377 | } |
378 | 378 | |
379 | 379 | self::displayXML(self::buildErrorXML($code, $message, $title, $customInfo)); |
380 | 380 | } |
381 | 381 | |
382 | - public static function setSimulation(bool $simulate=true) : void |
|
382 | + public static function setSimulation(bool $simulate = true) : void |
|
383 | 383 | { |
384 | 384 | self::$simulation = $simulate; |
385 | 385 | } |
@@ -428,7 +428,7 @@ discard block |
||
428 | 428 | * @param array<string,string> $customInfo |
429 | 429 | * @return string |
430 | 430 | */ |
431 | - public static function buildErrorXML($code, string $message, string $title, array $customInfo=array()) |
|
431 | + public static function buildErrorXML($code, string $message, string $title, array $customInfo = array()) |
|
432 | 432 | { |
433 | 433 | $xml = new DOMDocument('1.0', 'UTF-8'); |
434 | 434 | $xml->formatOutput = true; |
@@ -442,7 +442,7 @@ discard block |
||
442 | 442 | $helper->addTextTag($root, 'title', $title); |
443 | 443 | $helper->addTextTag($root, 'request_uri', $_SERVER['REQUEST_URI']); |
444 | 444 | |
445 | - foreach($customInfo as $name => $value) { |
|
445 | + foreach ($customInfo as $name => $value) { |
|
446 | 446 | $helper->addTextTag($root, $name, $value); |
447 | 447 | } |
448 | 448 |
@@ -41,71 +41,71 @@ discard block |
||
41 | 41 | */ |
42 | 42 | class Highlighter |
43 | 43 | { |
44 | - /** |
|
45 | - * Creates a new GeSHi instance from a source code string. |
|
46 | - * |
|
47 | - * @param string $sourceCode |
|
48 | - * @param string $format |
|
49 | - * @return GeSHi |
|
50 | - */ |
|
44 | + /** |
|
45 | + * Creates a new GeSHi instance from a source code string. |
|
46 | + * |
|
47 | + * @param string $sourceCode |
|
48 | + * @param string $format |
|
49 | + * @return GeSHi |
|
50 | + */ |
|
51 | 51 | public static function fromString(string $sourceCode, string $format) : GeSHi |
52 | 52 | { |
53 | 53 | return new GeSHi($sourceCode, $format); |
54 | 54 | } |
55 | 55 | |
56 | - /** |
|
57 | - * Creates a new GeSHi instance from the contents of a file. |
|
58 | - * |
|
59 | - * @param string $path |
|
60 | - * @param string $format |
|
61 | - * @return GeSHi |
|
62 | - */ |
|
56 | + /** |
|
57 | + * Creates a new GeSHi instance from the contents of a file. |
|
58 | + * |
|
59 | + * @param string $path |
|
60 | + * @param string $format |
|
61 | + * @return GeSHi |
|
62 | + */ |
|
63 | 63 | public static function fromFile(string $path, string $format) : GeSHi |
64 | 64 | { |
65 | 65 | return self::fromString(FileHelper::readContents($path), $format); |
66 | 66 | } |
67 | 67 | |
68 | - /** |
|
69 | - * Parses and highlights the target string. |
|
70 | - * |
|
71 | - * @param string $sourceCode |
|
72 | - * @param string $format |
|
73 | - * @return string |
|
74 | - */ |
|
68 | + /** |
|
69 | + * Parses and highlights the target string. |
|
70 | + * |
|
71 | + * @param string $sourceCode |
|
72 | + * @param string $format |
|
73 | + * @return string |
|
74 | + */ |
|
75 | 75 | public static function parseString(string $sourceCode, string $format) : string |
76 | 76 | { |
77 | 77 | return self::fromString($sourceCode, $format)->parse_code(); |
78 | 78 | } |
79 | 79 | |
80 | - /** |
|
81 | - * Parses and highlights the contents of the target file. |
|
82 | - * |
|
83 | - * @param string $path |
|
84 | - * @param string $format |
|
85 | - * @return string |
|
86 | - */ |
|
80 | + /** |
|
81 | + * Parses and highlights the contents of the target file. |
|
82 | + * |
|
83 | + * @param string $path |
|
84 | + * @param string $format |
|
85 | + * @return string |
|
86 | + */ |
|
87 | 87 | public static function parseFile(string $path, string $format) : string |
88 | 88 | { |
89 | 89 | return self::fromFile($path, $format)->parse_code(); |
90 | 90 | } |
91 | 91 | |
92 | - /** |
|
93 | - * Adds HTML syntax highlighting to the specified SQL string. |
|
94 | - * |
|
95 | - * @param string $sql |
|
96 | - * @return string |
|
97 | - */ |
|
92 | + /** |
|
93 | + * Adds HTML syntax highlighting to the specified SQL string. |
|
94 | + * |
|
95 | + * @param string $sql |
|
96 | + * @return string |
|
97 | + */ |
|
98 | 98 | public static function sql(string $sql) : string |
99 | 99 | { |
100 | 100 | return self::parseString($sql, 'sql'); |
101 | 101 | } |
102 | 102 | |
103 | - /** |
|
104 | - * Adds HTML syntax highlighting to a JSON string, or a data array/object. |
|
105 | - * |
|
106 | - * @param array|object|string $subject A JSON string, or data array/object to convert to JSON to highlight. |
|
107 | - * @return string |
|
108 | - */ |
|
103 | + /** |
|
104 | + * Adds HTML syntax highlighting to a JSON string, or a data array/object. |
|
105 | + * |
|
106 | + * @param array|object|string $subject A JSON string, or data array/object to convert to JSON to highlight. |
|
107 | + * @return string |
|
108 | + */ |
|
109 | 109 | public static function json($subject) : string |
110 | 110 | { |
111 | 111 | if(!is_string($subject)) |
@@ -118,13 +118,13 @@ discard block |
||
118 | 118 | return self::parseString($subject, 'javascript'); |
119 | 119 | } |
120 | 120 | |
121 | - /** |
|
122 | - * Adds HTML syntax highlighting to the specified XML code. |
|
123 | - * |
|
124 | - * @param string $xml The XML to highlight. |
|
125 | - * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
126 | - * @return string |
|
127 | - */ |
|
121 | + /** |
|
122 | + * Adds HTML syntax highlighting to the specified XML code. |
|
123 | + * |
|
124 | + * @param string $xml The XML to highlight. |
|
125 | + * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
126 | + * @return string |
|
127 | + */ |
|
128 | 128 | public static function xml(string $xml, bool $formatSource=false) : string |
129 | 129 | { |
130 | 130 | if($formatSource) |
@@ -141,13 +141,13 @@ discard block |
||
141 | 141 | return self::parseString($xml, 'xml'); |
142 | 142 | } |
143 | 143 | |
144 | - /** |
|
145 | - * Adds HTML syntax highlighting to the specified HTML code. |
|
146 | - * |
|
147 | - * @param string $html |
|
148 | - * @param bool $formatSource |
|
149 | - * @return string |
|
150 | - */ |
|
144 | + /** |
|
145 | + * Adds HTML syntax highlighting to the specified HTML code. |
|
146 | + * |
|
147 | + * @param string $html |
|
148 | + * @param bool $formatSource |
|
149 | + * @return string |
|
150 | + */ |
|
151 | 151 | public static function html(string $html, bool $formatSource=false) : string |
152 | 152 | { |
153 | 153 | if($formatSource) |
@@ -164,27 +164,27 @@ discard block |
||
164 | 164 | return self::parseString($html, 'xml'); |
165 | 165 | } |
166 | 166 | |
167 | - /** |
|
168 | - * Adds HTML syntax highlighting to a bit of PHP code. |
|
169 | - * |
|
170 | - * @param string $phpCode |
|
171 | - * @return string |
|
172 | - */ |
|
167 | + /** |
|
168 | + * Adds HTML syntax highlighting to a bit of PHP code. |
|
169 | + * |
|
170 | + * @param string $phpCode |
|
171 | + * @return string |
|
172 | + */ |
|
173 | 173 | public static function php(string $phpCode) : string |
174 | 174 | { |
175 | 175 | return self::parseString($phpCode, 'php'); |
176 | 176 | } |
177 | 177 | |
178 | - /** |
|
179 | - * Adds HTML syntax highlighting to an URL. |
|
180 | - * |
|
181 | - * NOTE: Includes the necessary CSS styles. When |
|
182 | - * highlighting several URLs in the same page, |
|
183 | - * prefer using the `parseURL` function instead. |
|
184 | - * |
|
185 | - * @param string $url |
|
186 | - * @return string |
|
187 | - */ |
|
178 | + /** |
|
179 | + * Adds HTML syntax highlighting to an URL. |
|
180 | + * |
|
181 | + * NOTE: Includes the necessary CSS styles. When |
|
182 | + * highlighting several URLs in the same page, |
|
183 | + * prefer using the `parseURL` function instead. |
|
184 | + * |
|
185 | + * @param string $url |
|
186 | + * @return string |
|
187 | + */ |
|
188 | 188 | public static function url(string $url) : string |
189 | 189 | { |
190 | 190 | $info = parseURL($url); |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | */ |
109 | 109 | public static function json($subject) : string |
110 | 110 | { |
111 | - if(!is_string($subject)) |
|
111 | + if (!is_string($subject)) |
|
112 | 112 | { |
113 | 113 | $subject = json_encode($subject, JSON_PRETTY_PRINT); |
114 | 114 | } |
@@ -125,9 +125,9 @@ discard block |
||
125 | 125 | * @param bool $formatSource Whether to format the source with indentation to make it readable. |
126 | 126 | * @return string |
127 | 127 | */ |
128 | - public static function xml(string $xml, bool $formatSource=false) : string |
|
128 | + public static function xml(string $xml, bool $formatSource = false) : string |
|
129 | 129 | { |
130 | - if($formatSource) |
|
130 | + if ($formatSource) |
|
131 | 131 | { |
132 | 132 | $dom = new DOMDocument(); |
133 | 133 | $dom->preserveWhiteSpace = false; |
@@ -148,9 +148,9 @@ discard block |
||
148 | 148 | * @param bool $formatSource |
149 | 149 | * @return string |
150 | 150 | */ |
151 | - public static function html(string $html, bool $formatSource=false) : string |
|
151 | + public static function html(string $html, bool $formatSource = false) : string |
|
152 | 152 | { |
153 | - if($formatSource) |
|
153 | + if ($formatSource) |
|
154 | 154 | { |
155 | 155 | $dom = new DOMDocument(); |
156 | 156 | $dom->preserveWhiteSpace = false; |
@@ -23,19 +23,19 @@ discard block |
||
23 | 23 | */ |
24 | 24 | class ConvertHelper_TimeConverter |
25 | 25 | { |
26 | - /** |
|
27 | - * @var float |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var float |
|
28 | + */ |
|
29 | 29 | private $seconds; |
30 | 30 | |
31 | - /** |
|
32 | - * @var array<int,array<string,string|int>> |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var array<int,array<string,string|int>> |
|
33 | + */ |
|
34 | 34 | private static $units; |
35 | 35 | |
36 | - /** |
|
37 | - * @param float $seconds |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @param float $seconds |
|
38 | + */ |
|
39 | 39 | public function __construct($seconds) |
40 | 40 | { |
41 | 41 | $this->seconds = $seconds; |
@@ -43,9 +43,9 @@ discard block |
||
43 | 43 | $this->initUnits(); |
44 | 44 | } |
45 | 45 | |
46 | - /** |
|
47 | - * Creates the list of units once per request as needed. |
|
48 | - */ |
|
46 | + /** |
|
47 | + * Creates the list of units once per request as needed. |
|
48 | + */ |
|
49 | 49 | private function initUnits() : void |
50 | 50 | { |
51 | 51 | if(isset(self::$units)) |
@@ -112,11 +112,11 @@ discard block |
||
112 | 112 | return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
113 | 113 | } |
114 | 114 | |
115 | - /** |
|
116 | - * Resolves the list of converted units. |
|
117 | - * |
|
118 | - * @return string[] |
|
119 | - */ |
|
115 | + /** |
|
116 | + * Resolves the list of converted units. |
|
117 | + * |
|
118 | + * @return string[] |
|
119 | + */ |
|
120 | 120 | private function resolveTokens() : array |
121 | 121 | { |
122 | 122 | $seconds = $this->seconds; |
@@ -48,7 +48,7 @@ discard block |
||
48 | 48 | */ |
49 | 49 | private function initUnits() : void |
50 | 50 | { |
51 | - if(isset(self::$units)) |
|
51 | + if (isset(self::$units)) |
|
52 | 52 | { |
53 | 53 | return; |
54 | 54 | } |
@@ -90,12 +90,12 @@ discard block |
||
90 | 90 | public function toString() : string |
91 | 91 | { |
92 | 92 | // specifically handle zero |
93 | - if($this->seconds <= 0) |
|
93 | + if ($this->seconds <= 0) |
|
94 | 94 | { |
95 | - return '0 ' . t('seconds'); |
|
95 | + return '0 '.t('seconds'); |
|
96 | 96 | } |
97 | 97 | |
98 | - if($this->seconds < 1) |
|
98 | + if ($this->seconds < 1) |
|
99 | 99 | { |
100 | 100 | return t('less than a second'); |
101 | 101 | } |
@@ -104,12 +104,12 @@ discard block |
||
104 | 104 | |
105 | 105 | $last = array_pop($tokens); |
106 | 106 | |
107 | - if(empty($tokens)) |
|
107 | + if (empty($tokens)) |
|
108 | 108 | { |
109 | 109 | return $last; |
110 | 110 | } |
111 | 111 | |
112 | - return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
|
112 | + return implode(', ', $tokens).' '.t('and').' '.$last; |
|
113 | 113 | } |
114 | 114 | |
115 | 115 | /** |
@@ -122,18 +122,18 @@ discard block |
||
122 | 122 | $seconds = $this->seconds; |
123 | 123 | $tokens = array(); |
124 | 124 | |
125 | - foreach(self::$units as $def) |
|
125 | + foreach (self::$units as $def) |
|
126 | 126 | { |
127 | 127 | $unitValue = intval($seconds / $def['value']); |
128 | 128 | |
129 | - if($unitValue <= 0) |
|
129 | + if ($unitValue <= 0) |
|
130 | 130 | { |
131 | 131 | continue; |
132 | 132 | } |
133 | 133 | |
134 | - $item = strval($unitValue) . ' '; |
|
134 | + $item = strval($unitValue).' '; |
|
135 | 135 | |
136 | - if(abs($unitValue) > 1) |
|
136 | + if (abs($unitValue) > 1) |
|
137 | 137 | { |
138 | 138 | $item .= $def['plural']; |
139 | 139 | } |
@@ -136,8 +136,7 @@ |
||
136 | 136 | if(abs($unitValue) > 1) |
137 | 137 | { |
138 | 138 | $item .= $def['plural']; |
139 | - } |
|
140 | - else |
|
139 | + } else |
|
141 | 140 | { |
142 | 141 | $item .= $def['singular']; |
143 | 142 | } |
@@ -191,8 +191,7 @@ discard block |
||
191 | 191 | if ($item->isDir()) |
192 | 192 | { |
193 | 193 | FileHelper::copyTree($itemPath, $target . '/' . $baseName); |
194 | - } |
|
195 | - else if($item->isFile()) |
|
194 | + } else if($item->isFile()) |
|
196 | 195 | { |
197 | 196 | self::copyFile($itemPath, $target . '/' . $baseName); |
198 | 197 | } |
@@ -225,8 +224,7 @@ discard block |
||
225 | 224 | if(!file_exists($targetFolder)) |
226 | 225 | { |
227 | 226 | self::createFolder($targetFolder); |
228 | - } |
|
229 | - else if(!is_writable($targetFolder)) |
|
227 | + } else if(!is_writable($targetFolder)) |
|
230 | 228 | { |
231 | 229 | throw new FileHelper_Exception( |
232 | 230 | sprintf('Target folder [%s] is not writable.', basename($targetFolder)), |
@@ -715,8 +713,7 @@ discard block |
||
715 | 713 | if(isset($options['relative-path']) && $options['relative-path'] === true) |
716 | 714 | { |
717 | 715 | $finder->setPathmodeRelative(); |
718 | - } |
|
719 | - else if(isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
716 | + } else if(isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
720 | 717 | { |
721 | 718 | $finder->setPathmodeAbsolute(); |
722 | 719 | } |
@@ -60,31 +60,31 @@ discard block |
||
60 | 60 | protected static $utfBoms; |
61 | 61 | |
62 | 62 | /** |
63 | - * Opens a serialized file and returns the unserialized data. |
|
64 | - * |
|
65 | - * @param string $file |
|
66 | - * @throws FileHelper_Exception |
|
67 | - * @return array |
|
68 | - * @deprecated Use parseSerializedFile() instead. |
|
69 | - * @see FileHelper::parseSerializedFile() |
|
70 | - */ |
|
63 | + * Opens a serialized file and returns the unserialized data. |
|
64 | + * |
|
65 | + * @param string $file |
|
66 | + * @throws FileHelper_Exception |
|
67 | + * @return array |
|
68 | + * @deprecated Use parseSerializedFile() instead. |
|
69 | + * @see FileHelper::parseSerializedFile() |
|
70 | + */ |
|
71 | 71 | public static function openUnserialized(string $file) : array |
72 | 72 | { |
73 | 73 | return self::parseSerializedFile($file); |
74 | 74 | } |
75 | 75 | |
76 | - /** |
|
77 | - * Opens a serialized file and returns the unserialized data. |
|
78 | - * |
|
79 | - * @param string $file |
|
80 | - * @throws FileHelper_Exception |
|
81 | - * @return array |
|
82 | - * @see FileHelper::parseSerializedFile() |
|
83 | - * |
|
84 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
85 | - * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
86 | - * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
87 | - */ |
|
76 | + /** |
|
77 | + * Opens a serialized file and returns the unserialized data. |
|
78 | + * |
|
79 | + * @param string $file |
|
80 | + * @throws FileHelper_Exception |
|
81 | + * @return array |
|
82 | + * @see FileHelper::parseSerializedFile() |
|
83 | + * |
|
84 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
85 | + * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
86 | + * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
87 | + */ |
|
88 | 88 | public static function parseSerializedFile(string $file) : array |
89 | 89 | { |
90 | 90 | self::requireFileExists($file); |
@@ -160,13 +160,13 @@ discard block |
||
160 | 160 | return rmdir($rootFolder); |
161 | 161 | } |
162 | 162 | |
163 | - /** |
|
164 | - * Create a folder, if it does not exist yet. |
|
165 | - * |
|
166 | - * @param string $path |
|
167 | - * @throws FileHelper_Exception |
|
168 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
169 | - */ |
|
163 | + /** |
|
164 | + * Create a folder, if it does not exist yet. |
|
165 | + * |
|
166 | + * @param string $path |
|
167 | + * @throws FileHelper_Exception |
|
168 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
169 | + */ |
|
170 | 170 | public static function createFolder(string $path) : void |
171 | 171 | { |
172 | 172 | if(is_dir($path) || mkdir($path, 0777, true)) { |
@@ -213,22 +213,22 @@ discard block |
||
213 | 213 | } |
214 | 214 | } |
215 | 215 | |
216 | - /** |
|
217 | - * Copies a file to the target location. Includes checks |
|
218 | - * for most error sources, like the source file not being |
|
219 | - * readable. Automatically creates the target folder if it |
|
220 | - * does not exist yet. |
|
221 | - * |
|
222 | - * @param string $sourcePath |
|
223 | - * @param string $targetPath |
|
224 | - * @throws FileHelper_Exception |
|
225 | - * |
|
226 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
227 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
228 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
229 | - * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
230 | - * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
231 | - */ |
|
216 | + /** |
|
217 | + * Copies a file to the target location. Includes checks |
|
218 | + * for most error sources, like the source file not being |
|
219 | + * readable. Automatically creates the target folder if it |
|
220 | + * does not exist yet. |
|
221 | + * |
|
222 | + * @param string $sourcePath |
|
223 | + * @param string $targetPath |
|
224 | + * @throws FileHelper_Exception |
|
225 | + * |
|
226 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
227 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
228 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
229 | + * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
230 | + * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
231 | + */ |
|
232 | 232 | public static function copyFile(string $sourcePath, string $targetPath) : void |
233 | 233 | { |
234 | 234 | self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND); |
@@ -268,15 +268,15 @@ discard block |
||
268 | 268 | ); |
269 | 269 | } |
270 | 270 | |
271 | - /** |
|
272 | - * Deletes the target file. Ignored if it cannot be found, |
|
273 | - * and throws an exception if it fails. |
|
274 | - * |
|
275 | - * @param string $filePath |
|
276 | - * @throws FileHelper_Exception |
|
277 | - * |
|
278 | - * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
279 | - */ |
|
271 | + /** |
|
272 | + * Deletes the target file. Ignored if it cannot be found, |
|
273 | + * and throws an exception if it fails. |
|
274 | + * |
|
275 | + * @param string $filePath |
|
276 | + * @throws FileHelper_Exception |
|
277 | + * |
|
278 | + * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
279 | + */ |
|
280 | 280 | public static function deleteFile(string $filePath) : void |
281 | 281 | { |
282 | 282 | if(!file_exists($filePath)) { |
@@ -298,15 +298,15 @@ discard block |
||
298 | 298 | } |
299 | 299 | |
300 | 300 | /** |
301 | - * Creates a new CSV parser instance and returns it. |
|
302 | - * |
|
303 | - * @param string $delimiter |
|
304 | - * @param string $enclosure |
|
305 | - * @param string $escape |
|
306 | - * @param bool $heading |
|
307 | - * @return Csv |
|
301 | + * Creates a new CSV parser instance and returns it. |
|
302 | + * |
|
303 | + * @param string $delimiter |
|
304 | + * @param string $enclosure |
|
305 | + * @param string $escape |
|
306 | + * @param bool $heading |
|
307 | + * @return Csv |
|
308 | 308 | * @see CSVHelper::createParser() |
309 | - */ |
|
309 | + */ |
|
310 | 310 | public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : Csv |
311 | 311 | { |
312 | 312 | if($delimiter==='') { $delimiter = ';'; } |
@@ -319,21 +319,21 @@ discard block |
||
319 | 319 | return $parser; |
320 | 320 | } |
321 | 321 | |
322 | - /** |
|
323 | - * Parses all lines in the specified string and returns an |
|
324 | - * indexed array with all csv values in each line. |
|
325 | - * |
|
326 | - * @param string $csv |
|
327 | - * @param string $delimiter |
|
328 | - * @param string $enclosure |
|
329 | - * @param string $escape |
|
330 | - * @param bool $heading |
|
331 | - * @return array |
|
332 | - * @throws FileHelper_Exception |
|
333 | - * |
|
334 | - * @see parseCSVFile() |
|
335 | - * @see FileHelper::ERROR_PARSING_CSV |
|
336 | - */ |
|
322 | + /** |
|
323 | + * Parses all lines in the specified string and returns an |
|
324 | + * indexed array with all csv values in each line. |
|
325 | + * |
|
326 | + * @param string $csv |
|
327 | + * @param string $delimiter |
|
328 | + * @param string $enclosure |
|
329 | + * @param string $escape |
|
330 | + * @param bool $heading |
|
331 | + * @return array |
|
332 | + * @throws FileHelper_Exception |
|
333 | + * |
|
334 | + * @see parseCSVFile() |
|
335 | + * @see FileHelper::ERROR_PARSING_CSV |
|
336 | + */ |
|
337 | 337 | public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
338 | 338 | { |
339 | 339 | $parser = self::createCSVParser($delimiter, $enclosure, '\\', $heading); |
@@ -521,27 +521,27 @@ discard block |
||
521 | 521 | ); |
522 | 522 | } |
523 | 523 | |
524 | - /** |
|
525 | - * Verifies whether the target file is a PHP file. The path |
|
526 | - * to the file can be a path to a file as a string, or a |
|
527 | - * DirectoryIterator object instance. |
|
528 | - * |
|
529 | - * @param string|DirectoryIterator $pathOrDirIterator |
|
530 | - * @return boolean |
|
531 | - */ |
|
524 | + /** |
|
525 | + * Verifies whether the target file is a PHP file. The path |
|
526 | + * to the file can be a path to a file as a string, or a |
|
527 | + * DirectoryIterator object instance. |
|
528 | + * |
|
529 | + * @param string|DirectoryIterator $pathOrDirIterator |
|
530 | + * @return boolean |
|
531 | + */ |
|
532 | 532 | public static function isPHPFile($pathOrDirIterator) : bool |
533 | 533 | { |
534 | - return self::getExtension($pathOrDirIterator) === 'php'; |
|
534 | + return self::getExtension($pathOrDirIterator) === 'php'; |
|
535 | 535 | } |
536 | 536 | |
537 | - /** |
|
538 | - * Retrieves the extension of the specified file. Can be a path |
|
539 | - * to a file as a string, or a DirectoryIterator object instance. |
|
540 | - * |
|
541 | - * @param string|DirectoryIterator $pathOrDirIterator |
|
542 | - * @param bool $lowercase |
|
543 | - * @return string |
|
544 | - */ |
|
537 | + /** |
|
538 | + * Retrieves the extension of the specified file. Can be a path |
|
539 | + * to a file as a string, or a DirectoryIterator object instance. |
|
540 | + * |
|
541 | + * @param string|DirectoryIterator $pathOrDirIterator |
|
542 | + * @param bool $lowercase |
|
543 | + * @return string |
|
544 | + */ |
|
545 | 545 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
546 | 546 | { |
547 | 547 | if($pathOrDirIterator instanceof DirectoryIterator) { |
@@ -552,38 +552,38 @@ discard block |
||
552 | 552 | |
553 | 553 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
554 | 554 | if($lowercase) { |
555 | - $ext = mb_strtolower($ext); |
|
555 | + $ext = mb_strtolower($ext); |
|
556 | 556 | } |
557 | 557 | |
558 | 558 | return $ext; |
559 | 559 | } |
560 | 560 | |
561 | - /** |
|
562 | - * Retrieves the file name from a path, with or without extension. |
|
563 | - * The path to the file can be a string, or a DirectoryIterator object |
|
564 | - * instance. |
|
565 | - * |
|
566 | - * In case of folders, behaves like the pathinfo function: returns |
|
567 | - * the name of the folder. |
|
568 | - * |
|
569 | - * @param string|DirectoryIterator $pathOrDirIterator |
|
570 | - * @param bool $extension |
|
571 | - * @return string |
|
572 | - */ |
|
561 | + /** |
|
562 | + * Retrieves the file name from a path, with or without extension. |
|
563 | + * The path to the file can be a string, or a DirectoryIterator object |
|
564 | + * instance. |
|
565 | + * |
|
566 | + * In case of folders, behaves like the pathinfo function: returns |
|
567 | + * the name of the folder. |
|
568 | + * |
|
569 | + * @param string|DirectoryIterator $pathOrDirIterator |
|
570 | + * @param bool $extension |
|
571 | + * @return string |
|
572 | + */ |
|
573 | 573 | public static function getFilename($pathOrDirIterator, $extension = true) : string |
574 | 574 | { |
575 | 575 | $path = strval($pathOrDirIterator); |
576 | - if($pathOrDirIterator instanceof DirectoryIterator) { |
|
577 | - $path = $pathOrDirIterator->getFilename(); |
|
578 | - } |
|
576 | + if($pathOrDirIterator instanceof DirectoryIterator) { |
|
577 | + $path = $pathOrDirIterator->getFilename(); |
|
578 | + } |
|
579 | 579 | |
580 | - $path = self::normalizePath($path); |
|
580 | + $path = self::normalizePath($path); |
|
581 | 581 | |
582 | - if(!$extension) { |
|
583 | - return pathinfo($path, PATHINFO_FILENAME); |
|
584 | - } |
|
582 | + if(!$extension) { |
|
583 | + return pathinfo($path, PATHINFO_FILENAME); |
|
584 | + } |
|
585 | 585 | |
586 | - return pathinfo($path, PATHINFO_BASENAME); |
|
586 | + return pathinfo($path, PATHINFO_BASENAME); |
|
587 | 587 | } |
588 | 588 | |
589 | 589 | /** |
@@ -624,16 +624,16 @@ discard block |
||
624 | 624 | return $json; |
625 | 625 | } |
626 | 626 | |
627 | - /** |
|
628 | - * Corrects common formatting mistakes when users enter |
|
629 | - * file names, like too many spaces, dots and the like. |
|
630 | - * |
|
631 | - * NOTE: if the file name contains a path, the path is |
|
632 | - * stripped, leaving only the file name. |
|
633 | - * |
|
634 | - * @param string $name |
|
635 | - * @return string |
|
636 | - */ |
|
627 | + /** |
|
628 | + * Corrects common formatting mistakes when users enter |
|
629 | + * file names, like too many spaces, dots and the like. |
|
630 | + * |
|
631 | + * NOTE: if the file name contains a path, the path is |
|
632 | + * stripped, leaving only the file name. |
|
633 | + * |
|
634 | + * @param string $name |
|
635 | + * @return string |
|
636 | + */ |
|
637 | 637 | public static function fixFileName(string $name) : string |
638 | 638 | { |
639 | 639 | $name = trim($name); |
@@ -715,20 +715,20 @@ discard block |
||
715 | 715 | return self::findFiles($targetFolder, array('php'), $options); |
716 | 716 | } |
717 | 717 | |
718 | - /** |
|
719 | - * Finds files according to the specified options. |
|
720 | - * |
|
721 | - * NOTE: This method only exists for backwards compatibility. |
|
722 | - * Use the `createFileFinder()` method instead, which offers |
|
723 | - * an object oriented interface that is much easier to use. |
|
724 | - * |
|
725 | - * @param string $targetFolder |
|
726 | - * @param string[] $extensions |
|
727 | - * @param array<string,mixed> $options |
|
728 | - * @throws FileHelper_Exception |
|
729 | - * @return string[] |
|
730 | - * @see FileHelper::createFileFinder() |
|
731 | - */ |
|
718 | + /** |
|
719 | + * Finds files according to the specified options. |
|
720 | + * |
|
721 | + * NOTE: This method only exists for backwards compatibility. |
|
722 | + * Use the `createFileFinder()` method instead, which offers |
|
723 | + * an object oriented interface that is much easier to use. |
|
724 | + * |
|
725 | + * @param string $targetFolder |
|
726 | + * @param string[] $extensions |
|
727 | + * @param array<string,mixed> $options |
|
728 | + * @throws FileHelper_Exception |
|
729 | + * @return string[] |
|
730 | + * @see FileHelper::createFileFinder() |
|
731 | + */ |
|
732 | 732 | public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array()) : array |
733 | 733 | { |
734 | 734 | $finder = self::createFileFinder($targetFolder); |
@@ -758,14 +758,14 @@ discard block |
||
758 | 758 | return $finder->getAll(); |
759 | 759 | } |
760 | 760 | |
761 | - /** |
|
762 | - * Removes the extension from the specified path or file name, |
|
763 | - * if any, and returns the name without the extension. |
|
764 | - * |
|
765 | - * @param string $filename |
|
766 | - * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to. |
|
767 | - * @return string |
|
768 | - */ |
|
761 | + /** |
|
762 | + * Removes the extension from the specified path or file name, |
|
763 | + * if any, and returns the name without the extension. |
|
764 | + * |
|
765 | + * @param string $filename |
|
766 | + * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to. |
|
767 | + * @return string |
|
768 | + */ |
|
769 | 769 | public static function removeExtension(string $filename, bool $keepPath=false) : string |
770 | 770 | { |
771 | 771 | // normalize paths to allow windows style slashes even on nix servers |
@@ -833,13 +833,13 @@ discard block |
||
833 | 833 | return null; |
834 | 834 | } |
835 | 835 | |
836 | - /** |
|
837 | - * Retrieves a list of all UTF byte order mark character |
|
838 | - * sequences, as an associative array with UTF encoding => bom sequence |
|
839 | - * pairs. |
|
840 | - * |
|
841 | - * @return array<string,string> |
|
842 | - */ |
|
836 | + /** |
|
837 | + * Retrieves a list of all UTF byte order mark character |
|
838 | + * sequences, as an associative array with UTF encoding => bom sequence |
|
839 | + * pairs. |
|
840 | + * |
|
841 | + * @return array<string,string> |
|
842 | + */ |
|
843 | 843 | public static function getUTFBOMs() : array |
844 | 844 | { |
845 | 845 | if(!isset(self::$utfBoms)) { |
@@ -855,15 +855,15 @@ discard block |
||
855 | 855 | return self::$utfBoms; |
856 | 856 | } |
857 | 857 | |
858 | - /** |
|
859 | - * Checks whether the specified encoding is a valid |
|
860 | - * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
861 | - * Also accounts for alternate way to write the, like |
|
862 | - * "UTF-8", and omitting little/big endian suffixes. |
|
863 | - * |
|
864 | - * @param string $encoding |
|
865 | - * @return boolean |
|
866 | - */ |
|
858 | + /** |
|
859 | + * Checks whether the specified encoding is a valid |
|
860 | + * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
861 | + * Also accounts for alternate way to write the, like |
|
862 | + * "UTF-8", and omitting little/big endian suffixes. |
|
863 | + * |
|
864 | + * @param string $encoding |
|
865 | + * @return boolean |
|
866 | + */ |
|
867 | 867 | public static function isValidUnicodeEncoding(string $encoding) : bool |
868 | 868 | { |
869 | 869 | $encodings = self::getKnownUnicodeEncodings(); |
@@ -882,40 +882,40 @@ discard block |
||
882 | 882 | return in_array($encoding, $keep); |
883 | 883 | } |
884 | 884 | |
885 | - /** |
|
886 | - * Retrieves a list of all known unicode file encodings. |
|
887 | - * @return string[] |
|
888 | - */ |
|
885 | + /** |
|
886 | + * Retrieves a list of all known unicode file encodings. |
|
887 | + * @return string[] |
|
888 | + */ |
|
889 | 889 | public static function getKnownUnicodeEncodings() : array |
890 | 890 | { |
891 | 891 | return array_keys(self::getUTFBOMs()); |
892 | 892 | } |
893 | 893 | |
894 | - /** |
|
895 | - * Normalizes the slash style in a file or folder path, |
|
896 | - * by replacing any antislashes with forward slashes. |
|
897 | - * |
|
898 | - * @param string $path |
|
899 | - * @return string |
|
900 | - */ |
|
894 | + /** |
|
895 | + * Normalizes the slash style in a file or folder path, |
|
896 | + * by replacing any antislashes with forward slashes. |
|
897 | + * |
|
898 | + * @param string $path |
|
899 | + * @return string |
|
900 | + */ |
|
901 | 901 | public static function normalizePath(string $path) : string |
902 | 902 | { |
903 | 903 | return str_replace(array('\\', '//'), array('/', '/'), $path); |
904 | 904 | } |
905 | 905 | |
906 | - /** |
|
907 | - * Saves the specified data to a file, JSON encoded. |
|
908 | - * |
|
909 | - * @param mixed $data |
|
910 | - * @param string $file |
|
911 | - * @param bool $pretty |
|
912 | - * @throws FileHelper_Exception |
|
913 | - * |
|
914 | - * @see FileHelper::ERROR_JSON_ENCODE_ERROR |
|
915 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
916 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
917 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
918 | - */ |
|
906 | + /** |
|
907 | + * Saves the specified data to a file, JSON encoded. |
|
908 | + * |
|
909 | + * @param mixed $data |
|
910 | + * @param string $file |
|
911 | + * @param bool $pretty |
|
912 | + * @throws FileHelper_Exception |
|
913 | + * |
|
914 | + * @see FileHelper::ERROR_JSON_ENCODE_ERROR |
|
915 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
916 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
917 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
918 | + */ |
|
919 | 919 | public static function saveAsJSON($data, string $file, bool $pretty=false) : void |
920 | 920 | { |
921 | 921 | $options = null; |
@@ -939,18 +939,18 @@ discard block |
||
939 | 939 | self::saveFile($file, $json); |
940 | 940 | } |
941 | 941 | |
942 | - /** |
|
943 | - * Saves the specified content to the target file, creating |
|
944 | - * the file and the folder as necessary. |
|
945 | - * |
|
946 | - * @param string $filePath |
|
947 | - * @param string $content |
|
948 | - * @throws FileHelper_Exception |
|
949 | - * |
|
950 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
951 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
952 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
953 | - */ |
|
942 | + /** |
|
943 | + * Saves the specified content to the target file, creating |
|
944 | + * the file and the folder as necessary. |
|
945 | + * |
|
946 | + * @param string $filePath |
|
947 | + * @param string $content |
|
948 | + * @throws FileHelper_Exception |
|
949 | + * |
|
950 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
951 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
952 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
953 | + */ |
|
954 | 954 | public static function saveFile(string $filePath, string $content='') : void |
955 | 955 | { |
956 | 956 | $filePath = self::normalizePath($filePath); |
@@ -1134,14 +1134,14 @@ discard block |
||
1134 | 1134 | return $output; |
1135 | 1135 | } |
1136 | 1136 | |
1137 | - /** |
|
1138 | - * Retrieves the last modified date for the specified file or folder. |
|
1139 | - * |
|
1140 | - * Note: If the target does not exist, returns null. |
|
1141 | - * |
|
1142 | - * @param string $path |
|
1143 | - * @return DateTime|NULL |
|
1144 | - */ |
|
1137 | + /** |
|
1138 | + * Retrieves the last modified date for the specified file or folder. |
|
1139 | + * |
|
1140 | + * Note: If the target does not exist, returns null. |
|
1141 | + * |
|
1142 | + * @param string $path |
|
1143 | + * @return DateTime|NULL |
|
1144 | + */ |
|
1145 | 1145 | public static function getModifiedDate(string $path) : ?DateTime |
1146 | 1146 | { |
1147 | 1147 | $time = filemtime($path); |
@@ -1154,25 +1154,25 @@ discard block |
||
1154 | 1154 | return $date; |
1155 | 1155 | } |
1156 | 1156 | |
1157 | - /** |
|
1158 | - * Retrieves the names of all subfolders in the specified path. |
|
1159 | - * |
|
1160 | - * Available options: |
|
1161 | - * |
|
1162 | - * - recursive: true/false |
|
1163 | - * Whether to search for subfolders recursively. |
|
1164 | - * |
|
1165 | - * - absolute-paths: true/false |
|
1166 | - * Whether to return a list of absolute paths. |
|
1167 | - * |
|
1168 | - * @param string|DirectoryIterator $targetFolder |
|
1169 | - * @param array $options |
|
1170 | - * @throws FileHelper_Exception |
|
1171 | - * @return string[] |
|
1172 | - * |
|
1173 | - * @see FileHelper::ERROR_FIND_SUBFOLDERS_FOLDER_DOES_NOT_EXIST |
|
1174 | - * @todo Move this to a separate class. |
|
1175 | - */ |
|
1157 | + /** |
|
1158 | + * Retrieves the names of all subfolders in the specified path. |
|
1159 | + * |
|
1160 | + * Available options: |
|
1161 | + * |
|
1162 | + * - recursive: true/false |
|
1163 | + * Whether to search for subfolders recursively. |
|
1164 | + * |
|
1165 | + * - absolute-paths: true/false |
|
1166 | + * Whether to return a list of absolute paths. |
|
1167 | + * |
|
1168 | + * @param string|DirectoryIterator $targetFolder |
|
1169 | + * @param array $options |
|
1170 | + * @throws FileHelper_Exception |
|
1171 | + * @return string[] |
|
1172 | + * |
|
1173 | + * @see FileHelper::ERROR_FIND_SUBFOLDERS_FOLDER_DOES_NOT_EXIST |
|
1174 | + * @todo Move this to a separate class. |
|
1175 | + */ |
|
1176 | 1176 | public static function getSubfolders($targetFolder, $options = array()) |
1177 | 1177 | { |
1178 | 1178 | if($targetFolder instanceof DirectoryIterator) { |
@@ -1237,16 +1237,16 @@ discard block |
||
1237 | 1237 | return $result; |
1238 | 1238 | } |
1239 | 1239 | |
1240 | - /** |
|
1241 | - * Retrieves the maximum allowed upload file size, in bytes. |
|
1242 | - * Takes into account the PHP ini settings <code>post_max_size</code> |
|
1243 | - * and <code>upload_max_filesize</code>. Since these cannot |
|
1244 | - * be modified at runtime, they are the hard limits for uploads. |
|
1245 | - * |
|
1246 | - * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
1247 | - * |
|
1248 | - * @return int Will return <code>-1</code> if no limit. |
|
1249 | - */ |
|
1240 | + /** |
|
1241 | + * Retrieves the maximum allowed upload file size, in bytes. |
|
1242 | + * Takes into account the PHP ini settings <code>post_max_size</code> |
|
1243 | + * and <code>upload_max_filesize</code>. Since these cannot |
|
1244 | + * be modified at runtime, they are the hard limits for uploads. |
|
1245 | + * |
|
1246 | + * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
1247 | + * |
|
1248 | + * @return int Will return <code>-1</code> if no limit. |
|
1249 | + */ |
|
1250 | 1250 | public static function getMaxUploadFilesize() : int |
1251 | 1251 | { |
1252 | 1252 | static $max_size = -1; |
@@ -1284,16 +1284,16 @@ discard block |
||
1284 | 1284 | return round($size); |
1285 | 1285 | } |
1286 | 1286 | |
1287 | - /** |
|
1288 | - * Makes a path relative using a folder depth: will reduce the |
|
1289 | - * length of the path so that only the amount of folders defined |
|
1290 | - * in the <code>$depth</code> attribute are shown below the actual |
|
1291 | - * folder or file in the path. |
|
1292 | - * |
|
1293 | - * @param string $path The absolute or relative path |
|
1294 | - * @param int $depth The folder depth to reduce the path to |
|
1295 | - * @return string |
|
1296 | - */ |
|
1287 | + /** |
|
1288 | + * Makes a path relative using a folder depth: will reduce the |
|
1289 | + * length of the path so that only the amount of folders defined |
|
1290 | + * in the <code>$depth</code> attribute are shown below the actual |
|
1291 | + * folder or file in the path. |
|
1292 | + * |
|
1293 | + * @param string $path The absolute or relative path |
|
1294 | + * @param int $depth The folder depth to reduce the path to |
|
1295 | + * @return string |
|
1296 | + */ |
|
1297 | 1297 | public static function relativizePathByDepth(string $path, int $depth=2) : string |
1298 | 1298 | { |
1299 | 1299 | $path = self::normalizePath($path); |
@@ -1331,23 +1331,23 @@ discard block |
||
1331 | 1331 | return trim(implode('/', $tokens), '/'); |
1332 | 1332 | } |
1333 | 1333 | |
1334 | - /** |
|
1335 | - * Makes the specified path relative to another path, |
|
1336 | - * by removing one from the other if found. Also |
|
1337 | - * normalizes the path to use forward slashes. |
|
1338 | - * |
|
1339 | - * Example: |
|
1340 | - * |
|
1341 | - * <pre> |
|
1342 | - * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
1343 | - * </pre> |
|
1344 | - * |
|
1345 | - * Result: <code>to/file.txt</code> |
|
1346 | - * |
|
1347 | - * @param string $path |
|
1348 | - * @param string $relativeTo |
|
1349 | - * @return string |
|
1350 | - */ |
|
1334 | + /** |
|
1335 | + * Makes the specified path relative to another path, |
|
1336 | + * by removing one from the other if found. Also |
|
1337 | + * normalizes the path to use forward slashes. |
|
1338 | + * |
|
1339 | + * Example: |
|
1340 | + * |
|
1341 | + * <pre> |
|
1342 | + * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
1343 | + * </pre> |
|
1344 | + * |
|
1345 | + * Result: <code>to/file.txt</code> |
|
1346 | + * |
|
1347 | + * @param string $path |
|
1348 | + * @param string $relativeTo |
|
1349 | + * @return string |
|
1350 | + */ |
|
1351 | 1351 | public static function relativizePath(string $path, string $relativeTo) : string |
1352 | 1352 | { |
1353 | 1353 | $path = self::normalizePath($path); |
@@ -1359,17 +1359,17 @@ discard block |
||
1359 | 1359 | return $relative; |
1360 | 1360 | } |
1361 | 1361 | |
1362 | - /** |
|
1363 | - * Checks that the target file exists, and throws an exception |
|
1364 | - * if it does not. |
|
1365 | - * |
|
1366 | - * @param string $path |
|
1367 | - * @param int|NULL $errorCode Optional custom error code |
|
1368 | - * @throws FileHelper_Exception |
|
1369 | - * @return string The real path to the file |
|
1370 | - * |
|
1371 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1372 | - */ |
|
1362 | + /** |
|
1363 | + * Checks that the target file exists, and throws an exception |
|
1364 | + * if it does not. |
|
1365 | + * |
|
1366 | + * @param string $path |
|
1367 | + * @param int|NULL $errorCode Optional custom error code |
|
1368 | + * @throws FileHelper_Exception |
|
1369 | + * @return string The real path to the file |
|
1370 | + * |
|
1371 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1372 | + */ |
|
1373 | 1373 | public static function requireFileExists(string $path, ?int $errorCode=null) : string |
1374 | 1374 | { |
1375 | 1375 | $result = realpath($path); |
@@ -1413,18 +1413,18 @@ discard block |
||
1413 | 1413 | ); |
1414 | 1414 | } |
1415 | 1415 | |
1416 | - /** |
|
1417 | - * Reads a specific line number from the target file and returns its |
|
1418 | - * contents, if the file has such a line. Does so with little memory |
|
1419 | - * usage, as the file is not read entirely into memory. |
|
1420 | - * |
|
1421 | - * @param string $path |
|
1422 | - * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
1423 | - * @return string|NULL Will return null if the requested line does not exist. |
|
1424 | - * @throws FileHelper_Exception |
|
1425 | - * |
|
1426 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1427 | - */ |
|
1416 | + /** |
|
1417 | + * Reads a specific line number from the target file and returns its |
|
1418 | + * contents, if the file has such a line. Does so with little memory |
|
1419 | + * usage, as the file is not read entirely into memory. |
|
1420 | + * |
|
1421 | + * @param string $path |
|
1422 | + * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
1423 | + * @return string|NULL Will return null if the requested line does not exist. |
|
1424 | + * @throws FileHelper_Exception |
|
1425 | + * |
|
1426 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1427 | + */ |
|
1428 | 1428 | public static function getLineFromFile(string $path, int $lineNumber) : ?string |
1429 | 1429 | { |
1430 | 1430 | self::requireFileExists($path); |
@@ -1440,19 +1440,19 @@ discard block |
||
1440 | 1440 | $file->seek($targetLine); |
1441 | 1441 | |
1442 | 1442 | if($file->key() !== $targetLine) { |
1443 | - return null; |
|
1443 | + return null; |
|
1444 | 1444 | } |
1445 | 1445 | |
1446 | 1446 | return $file->current(); |
1447 | 1447 | } |
1448 | 1448 | |
1449 | - /** |
|
1450 | - * Retrieves the total amount of lines in the file, without |
|
1451 | - * reading the whole file into memory. |
|
1452 | - * |
|
1453 | - * @param string $path |
|
1454 | - * @return int |
|
1455 | - */ |
|
1449 | + /** |
|
1450 | + * Retrieves the total amount of lines in the file, without |
|
1451 | + * reading the whole file into memory. |
|
1452 | + * |
|
1453 | + * @param string $path |
|
1454 | + * @return int |
|
1455 | + */ |
|
1456 | 1456 | public static function countFileLines(string $path) : int |
1457 | 1457 | { |
1458 | 1458 | self::requireFileExists($path); |
@@ -1482,26 +1482,26 @@ discard block |
||
1482 | 1482 | return $number+1; |
1483 | 1483 | } |
1484 | 1484 | |
1485 | - /** |
|
1486 | - * Parses the target file to detect any PHP classes contained |
|
1487 | - * within, and retrieve information on them. Does not use the |
|
1488 | - * PHP reflection API. |
|
1489 | - * |
|
1490 | - * @param string $filePath |
|
1491 | - * @return FileHelper_PHPClassInfo |
|
1492 | - */ |
|
1485 | + /** |
|
1486 | + * Parses the target file to detect any PHP classes contained |
|
1487 | + * within, and retrieve information on them. Does not use the |
|
1488 | + * PHP reflection API. |
|
1489 | + * |
|
1490 | + * @param string $filePath |
|
1491 | + * @return FileHelper_PHPClassInfo |
|
1492 | + */ |
|
1493 | 1493 | public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo |
1494 | 1494 | { |
1495 | 1495 | return new FileHelper_PHPClassInfo($filePath); |
1496 | 1496 | } |
1497 | 1497 | |
1498 | - /** |
|
1499 | - * Detects the end of line style used in the target file, if any. |
|
1500 | - * Can be used with large files, because it only reads part of it. |
|
1501 | - * |
|
1502 | - * @param string $filePath The path to the file. |
|
1503 | - * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
1504 | - */ |
|
1498 | + /** |
|
1499 | + * Detects the end of line style used in the target file, if any. |
|
1500 | + * Can be used with large files, because it only reads part of it. |
|
1501 | + * |
|
1502 | + * @param string $filePath The path to the file. |
|
1503 | + * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
1504 | + */ |
|
1505 | 1505 | public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL |
1506 | 1506 | { |
1507 | 1507 | // 20 lines is enough to get a good picture of the newline style in the file. |
@@ -1514,18 +1514,18 @@ discard block |
||
1514 | 1514 | return ConvertHelper::detectEOLCharacter($string); |
1515 | 1515 | } |
1516 | 1516 | |
1517 | - /** |
|
1518 | - * Reads the specified amount of lines from the target file. |
|
1519 | - * Unicode BOM compatible: any byte order marker is stripped |
|
1520 | - * from the resulting lines. |
|
1521 | - * |
|
1522 | - * @param string $filePath |
|
1523 | - * @param int $amount Set to 0 to read all lines. |
|
1524 | - * @return array |
|
1525 | - * |
|
1526 | - * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
1527 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1528 | - */ |
|
1517 | + /** |
|
1518 | + * Reads the specified amount of lines from the target file. |
|
1519 | + * Unicode BOM compatible: any byte order marker is stripped |
|
1520 | + * from the resulting lines. |
|
1521 | + * |
|
1522 | + * @param string $filePath |
|
1523 | + * @param int $amount Set to 0 to read all lines. |
|
1524 | + * @return array |
|
1525 | + * |
|
1526 | + * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
1527 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1528 | + */ |
|
1529 | 1529 | public static function readLines(string $filePath, int $amount=0) : array |
1530 | 1530 | { |
1531 | 1531 | self::requireFileExists($filePath); |
@@ -1578,16 +1578,16 @@ discard block |
||
1578 | 1578 | return $result; |
1579 | 1579 | } |
1580 | 1580 | |
1581 | - /** |
|
1582 | - * Reads all content from a file. |
|
1583 | - * |
|
1584 | - * @param string $filePath |
|
1585 | - * @throws FileHelper_Exception |
|
1586 | - * @return string |
|
1587 | - * |
|
1588 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1589 | - * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
1590 | - */ |
|
1581 | + /** |
|
1582 | + * Reads all content from a file. |
|
1583 | + * |
|
1584 | + * @param string $filePath |
|
1585 | + * @throws FileHelper_Exception |
|
1586 | + * @return string |
|
1587 | + * |
|
1588 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1589 | + * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
1590 | + */ |
|
1591 | 1591 | public static function readContents(string $filePath) : string |
1592 | 1592 | { |
1593 | 1593 | self::requireFileExists($filePath); |
@@ -1608,18 +1608,18 @@ discard block |
||
1608 | 1608 | ); |
1609 | 1609 | } |
1610 | 1610 | |
1611 | - /** |
|
1612 | - * Ensures that the target path exists on disk, and is a folder. |
|
1613 | - * |
|
1614 | - * @param string $path |
|
1615 | - * @return string The real path, with normalized slashes. |
|
1616 | - * @throws FileHelper_Exception |
|
1617 | - * |
|
1618 | - * @see FileHelper::normalizePath() |
|
1619 | - * |
|
1620 | - * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST |
|
1621 | - * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER |
|
1622 | - */ |
|
1611 | + /** |
|
1612 | + * Ensures that the target path exists on disk, and is a folder. |
|
1613 | + * |
|
1614 | + * @param string $path |
|
1615 | + * @return string The real path, with normalized slashes. |
|
1616 | + * @throws FileHelper_Exception |
|
1617 | + * |
|
1618 | + * @see FileHelper::normalizePath() |
|
1619 | + * |
|
1620 | + * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST |
|
1621 | + * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER |
|
1622 | + */ |
|
1623 | 1623 | public static function requireFolderExists(string $path) : string |
1624 | 1624 | { |
1625 | 1625 | $actual = realpath($path); |
@@ -91,7 +91,7 @@ discard block |
||
91 | 91 | |
92 | 92 | $contents = file_get_contents($file); |
93 | 93 | |
94 | - if($contents === false) |
|
94 | + if ($contents === false) |
|
95 | 95 | { |
96 | 96 | throw new FileHelper_Exception( |
97 | 97 | 'Cannot load serialized content from file.', |
@@ -105,7 +105,7 @@ discard block |
||
105 | 105 | |
106 | 106 | $result = @unserialize($contents); |
107 | 107 | |
108 | - if($result !== false) { |
|
108 | + if ($result !== false) { |
|
109 | 109 | return $result; |
110 | 110 | } |
111 | 111 | |
@@ -128,7 +128,7 @@ discard block |
||
128 | 128 | */ |
129 | 129 | public static function deleteTree(string $rootFolder) : bool |
130 | 130 | { |
131 | - if(!file_exists($rootFolder)) { |
|
131 | + if (!file_exists($rootFolder)) { |
|
132 | 132 | return true; |
133 | 133 | } |
134 | 134 | |
@@ -169,7 +169,7 @@ discard block |
||
169 | 169 | */ |
170 | 170 | public static function createFolder(string $path) : void |
171 | 171 | { |
172 | - if(is_dir($path) || mkdir($path, 0777, true)) { |
|
172 | + if (is_dir($path) || mkdir($path, 0777, true)) { |
|
173 | 173 | return; |
174 | 174 | } |
175 | 175 | |
@@ -204,11 +204,11 @@ discard block |
||
204 | 204 | |
205 | 205 | if ($item->isDir()) |
206 | 206 | { |
207 | - FileHelper::copyTree($itemPath, $target . '/' . $baseName); |
|
207 | + FileHelper::copyTree($itemPath, $target.'/'.$baseName); |
|
208 | 208 | } |
209 | - else if($item->isFile()) |
|
209 | + else if ($item->isFile()) |
|
210 | 210 | { |
211 | - self::copyFile($itemPath, $target . '/' . $baseName); |
|
211 | + self::copyFile($itemPath, $target.'/'.$baseName); |
|
212 | 212 | } |
213 | 213 | } |
214 | 214 | } |
@@ -236,11 +236,11 @@ discard block |
||
236 | 236 | |
237 | 237 | $targetFolder = dirname($targetPath); |
238 | 238 | |
239 | - if(!file_exists($targetFolder)) |
|
239 | + if (!file_exists($targetFolder)) |
|
240 | 240 | { |
241 | 241 | self::createFolder($targetFolder); |
242 | 242 | } |
243 | - else if(!is_writable($targetFolder)) |
|
243 | + else if (!is_writable($targetFolder)) |
|
244 | 244 | { |
245 | 245 | throw new FileHelper_Exception( |
246 | 246 | sprintf('Target folder [%s] is not writable.', basename($targetFolder)), |
@@ -252,7 +252,7 @@ discard block |
||
252 | 252 | ); |
253 | 253 | } |
254 | 254 | |
255 | - if(copy($sourcePath, $targetPath)) { |
|
255 | + if (copy($sourcePath, $targetPath)) { |
|
256 | 256 | return; |
257 | 257 | } |
258 | 258 | |
@@ -279,11 +279,11 @@ discard block |
||
279 | 279 | */ |
280 | 280 | public static function deleteFile(string $filePath) : void |
281 | 281 | { |
282 | - if(!file_exists($filePath)) { |
|
282 | + if (!file_exists($filePath)) { |
|
283 | 283 | return; |
284 | 284 | } |
285 | 285 | |
286 | - if(unlink($filePath)) { |
|
286 | + if (unlink($filePath)) { |
|
287 | 287 | return; |
288 | 288 | } |
289 | 289 | |
@@ -307,10 +307,10 @@ discard block |
||
307 | 307 | * @return Csv |
308 | 308 | * @see CSVHelper::createParser() |
309 | 309 | */ |
310 | - public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : Csv |
|
310 | + public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : Csv |
|
311 | 311 | { |
312 | - if($delimiter==='') { $delimiter = ';'; } |
|
313 | - if($enclosure==='') { $enclosure = '"'; } |
|
312 | + if ($delimiter === '') { $delimiter = ';'; } |
|
313 | + if ($enclosure === '') { $enclosure = '"'; } |
|
314 | 314 | |
315 | 315 | $parser = CSVHelper::createParser($delimiter); |
316 | 316 | $parser->enclosure = $enclosure; |
@@ -334,11 +334,11 @@ discard block |
||
334 | 334 | * @see parseCSVFile() |
335 | 335 | * @see FileHelper::ERROR_PARSING_CSV |
336 | 336 | */ |
337 | - public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
337 | + public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
338 | 338 | { |
339 | 339 | $parser = self::createCSVParser($delimiter, $enclosure, '\\', $heading); |
340 | 340 | |
341 | - if($parser->parse($csv)) |
|
341 | + if ($parser->parse($csv)) |
|
342 | 342 | { |
343 | 343 | return $parser->data; |
344 | 344 | } |
@@ -366,7 +366,7 @@ discard block |
||
366 | 366 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
367 | 367 | * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
368 | 368 | */ |
369 | - public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
369 | + public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
370 | 370 | { |
371 | 371 | $content = self::readContents($filePath); |
372 | 372 | |
@@ -383,7 +383,7 @@ discard block |
||
383 | 383 | public static function detectMimeType(string $fileName) : ?string |
384 | 384 | { |
385 | 385 | $ext = self::getExtension($fileName); |
386 | - if(empty($ext)) { |
|
386 | + if (empty($ext)) { |
|
387 | 387 | return null; |
388 | 388 | } |
389 | 389 | |
@@ -423,11 +423,11 @@ discard block |
||
423 | 423 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
424 | 424 | * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE |
425 | 425 | */ |
426 | - public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true) |
|
426 | + public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true) |
|
427 | 427 | { |
428 | 428 | self::requireFileExists($filePath); |
429 | 429 | |
430 | - if(empty($fileName)) { |
|
430 | + if (empty($fileName)) { |
|
431 | 431 | $fileName = basename($filePath); |
432 | 432 | } |
433 | 433 | |
@@ -445,10 +445,10 @@ discard block |
||
445 | 445 | |
446 | 446 | header("Cache-Control: public", true); |
447 | 447 | header("Content-Description: File Transfer", true); |
448 | - header("Content-Type: " . $mime, true); |
|
448 | + header("Content-Type: ".$mime, true); |
|
449 | 449 | |
450 | 450 | $disposition = 'inline'; |
451 | - if($asAttachment) { |
|
451 | + if ($asAttachment) { |
|
452 | 452 | $disposition = 'attachment'; |
453 | 453 | } |
454 | 454 | |
@@ -474,7 +474,7 @@ discard block |
||
474 | 474 | public static function downloadFile(string $url) : string |
475 | 475 | { |
476 | 476 | $ch = curl_init(); |
477 | - if(!is_resource($ch)) |
|
477 | + if (!is_resource($ch)) |
|
478 | 478 | { |
479 | 479 | throw new FileHelper_Exception( |
480 | 480 | 'Could not initialize a new cURL instance.', |
@@ -495,7 +495,7 @@ discard block |
||
495 | 495 | |
496 | 496 | $output = curl_exec($ch); |
497 | 497 | |
498 | - if($output === false) { |
|
498 | + if ($output === false) { |
|
499 | 499 | throw new FileHelper_Exception( |
500 | 500 | 'Unable to open URL', |
501 | 501 | sprintf( |
@@ -509,7 +509,7 @@ discard block |
||
509 | 509 | |
510 | 510 | curl_close($ch); |
511 | 511 | |
512 | - if(is_string($output)) |
|
512 | + if (is_string($output)) |
|
513 | 513 | { |
514 | 514 | return $output; |
515 | 515 | } |
@@ -544,14 +544,14 @@ discard block |
||
544 | 544 | */ |
545 | 545 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
546 | 546 | { |
547 | - if($pathOrDirIterator instanceof DirectoryIterator) { |
|
547 | + if ($pathOrDirIterator instanceof DirectoryIterator) { |
|
548 | 548 | $filename = $pathOrDirIterator->getFilename(); |
549 | 549 | } else { |
550 | 550 | $filename = basename(strval($pathOrDirIterator)); |
551 | 551 | } |
552 | 552 | |
553 | 553 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
554 | - if($lowercase) { |
|
554 | + if ($lowercase) { |
|
555 | 555 | $ext = mb_strtolower($ext); |
556 | 556 | } |
557 | 557 | |
@@ -573,13 +573,13 @@ discard block |
||
573 | 573 | public static function getFilename($pathOrDirIterator, $extension = true) : string |
574 | 574 | { |
575 | 575 | $path = strval($pathOrDirIterator); |
576 | - if($pathOrDirIterator instanceof DirectoryIterator) { |
|
576 | + if ($pathOrDirIterator instanceof DirectoryIterator) { |
|
577 | 577 | $path = $pathOrDirIterator->getFilename(); |
578 | 578 | } |
579 | 579 | |
580 | 580 | $path = self::normalizePath($path); |
581 | 581 | |
582 | - if(!$extension) { |
|
582 | + if (!$extension) { |
|
583 | 583 | return pathinfo($path, PATHINFO_FILENAME); |
584 | 584 | } |
585 | 585 | |
@@ -599,18 +599,18 @@ discard block |
||
599 | 599 | * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
600 | 600 | * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
601 | 601 | */ |
602 | - public static function parseJSONFile(string $file, string $targetEncoding='', $sourceEncoding=null) : array |
|
602 | + public static function parseJSONFile(string $file, string $targetEncoding = '', $sourceEncoding = null) : array |
|
603 | 603 | { |
604 | 604 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
605 | 605 | |
606 | 606 | $content = self::readContents($file); |
607 | 607 | |
608 | - if(!empty($targetEncoding)) { |
|
608 | + if (!empty($targetEncoding)) { |
|
609 | 609 | $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding); |
610 | 610 | } |
611 | 611 | |
612 | 612 | $json = json_decode($content, true); |
613 | - if($json === false || $json === NULL) { |
|
613 | + if ($json === false || $json === NULL) { |
|
614 | 614 | throw new FileHelper_Exception( |
615 | 615 | 'Cannot decode json data', |
616 | 616 | sprintf( |
@@ -650,13 +650,13 @@ discard block |
||
650 | 650 | |
651 | 651 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
652 | 652 | |
653 | - while(strstr($name, ' ')) { |
|
653 | + while (strstr($name, ' ')) { |
|
654 | 654 | $name = str_replace(' ', ' ', $name); |
655 | 655 | } |
656 | 656 | |
657 | 657 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
658 | 658 | |
659 | - while(strstr($name, '..')) { |
|
659 | + while (strstr($name, '..')) { |
|
660 | 660 | $name = str_replace('..', '.', $name); |
661 | 661 | } |
662 | 662 | |
@@ -692,7 +692,7 @@ discard block |
||
692 | 692 | * @throws FileHelper_Exception |
693 | 693 | * @see FileHelper::createFileFinder() |
694 | 694 | */ |
695 | - public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
|
695 | + public static function findHTMLFiles(string $targetFolder, array $options = array()) : array |
|
696 | 696 | { |
697 | 697 | return self::findFiles($targetFolder, array('html'), $options); |
698 | 698 | } |
@@ -710,7 +710,7 @@ discard block |
||
710 | 710 | * @throws FileHelper_Exception |
711 | 711 | * @see FileHelper::createFileFinder() |
712 | 712 | */ |
713 | - public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
|
713 | + public static function findPHPFiles(string $targetFolder, array $options = array()) : array |
|
714 | 714 | { |
715 | 715 | return self::findFiles($targetFolder, array('php'), $options); |
716 | 716 | } |
@@ -729,7 +729,7 @@ discard block |
||
729 | 729 | * @return string[] |
730 | 730 | * @see FileHelper::createFileFinder() |
731 | 731 | */ |
732 | - public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array()) : array |
|
732 | + public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array()) : array |
|
733 | 733 | { |
734 | 734 | $finder = self::createFileFinder($targetFolder); |
735 | 735 | |
@@ -739,16 +739,16 @@ discard block |
||
739 | 739 | |
740 | 740 | $finder->setPathmodeStrip(); |
741 | 741 | |
742 | - if(isset($options['relative-path']) && $options['relative-path'] === true) |
|
742 | + if (isset($options['relative-path']) && $options['relative-path'] === true) |
|
743 | 743 | { |
744 | 744 | $finder->setPathmodeRelative(); |
745 | 745 | } |
746 | - else if(isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
746 | + else if (isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
747 | 747 | { |
748 | 748 | $finder->setPathmodeAbsolute(); |
749 | 749 | } |
750 | 750 | |
751 | - if(isset($options['strip-extension'])) |
|
751 | + if (isset($options['strip-extension'])) |
|
752 | 752 | { |
753 | 753 | $finder->stripExtensions(); |
754 | 754 | } |
@@ -766,12 +766,12 @@ discard block |
||
766 | 766 | * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to. |
767 | 767 | * @return string |
768 | 768 | */ |
769 | - public static function removeExtension(string $filename, bool $keepPath=false) : string |
|
769 | + public static function removeExtension(string $filename, bool $keepPath = false) : string |
|
770 | 770 | { |
771 | 771 | // normalize paths to allow windows style slashes even on nix servers |
772 | 772 | $filename = self::normalizePath($filename); |
773 | 773 | |
774 | - if(!$keepPath) |
|
774 | + if (!$keepPath) |
|
775 | 775 | { |
776 | 776 | return pathinfo($filename, PATHINFO_FILENAME); |
777 | 777 | } |
@@ -807,7 +807,7 @@ discard block |
||
807 | 807 | public static function detectUTFBom(string $filename) : ?string |
808 | 808 | { |
809 | 809 | $fp = fopen($filename, 'r'); |
810 | - if($fp === false) |
|
810 | + if ($fp === false) |
|
811 | 811 | { |
812 | 812 | throw new FileHelper_Exception( |
813 | 813 | 'Cannot open file for reading', |
@@ -822,10 +822,10 @@ discard block |
||
822 | 822 | |
823 | 823 | $boms = self::getUTFBOMs(); |
824 | 824 | |
825 | - foreach($boms as $bom => $value) |
|
825 | + foreach ($boms as $bom => $value) |
|
826 | 826 | { |
827 | 827 | $length = mb_strlen($value); |
828 | - if(mb_substr($text, 0, $length) == $value) { |
|
828 | + if (mb_substr($text, 0, $length) == $value) { |
|
829 | 829 | return $bom; |
830 | 830 | } |
831 | 831 | } |
@@ -842,13 +842,13 @@ discard block |
||
842 | 842 | */ |
843 | 843 | public static function getUTFBOMs() : array |
844 | 844 | { |
845 | - if(!isset(self::$utfBoms)) { |
|
845 | + if (!isset(self::$utfBoms)) { |
|
846 | 846 | self::$utfBoms = array( |
847 | - 'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF), |
|
848 | - 'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00), |
|
849 | - 'UTF16-BE' => chr(0xFE) . chr(0xFF), |
|
850 | - 'UTF16-LE' => chr(0xFF) . chr(0xFE), |
|
851 | - 'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF) |
|
847 | + 'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF), |
|
848 | + 'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00), |
|
849 | + 'UTF16-BE' => chr(0xFE).chr(0xFF), |
|
850 | + 'UTF16-LE' => chr(0xFF).chr(0xFE), |
|
851 | + 'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF) |
|
852 | 852 | ); |
853 | 853 | } |
854 | 854 | |
@@ -869,7 +869,7 @@ discard block |
||
869 | 869 | $encodings = self::getKnownUnicodeEncodings(); |
870 | 870 | |
871 | 871 | $keep = array(); |
872 | - foreach($encodings as $string) |
|
872 | + foreach ($encodings as $string) |
|
873 | 873 | { |
874 | 874 | $withHyphen = str_replace('UTF', 'UTF-', $string); |
875 | 875 | |
@@ -916,16 +916,16 @@ discard block |
||
916 | 916 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
917 | 917 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
918 | 918 | */ |
919 | - public static function saveAsJSON($data, string $file, bool $pretty=false) : void |
|
919 | + public static function saveAsJSON($data, string $file, bool $pretty = false) : void |
|
920 | 920 | { |
921 | 921 | $options = null; |
922 | - if($pretty) { |
|
922 | + if ($pretty) { |
|
923 | 923 | $options = JSON_PRETTY_PRINT; |
924 | 924 | } |
925 | 925 | |
926 | 926 | $json = json_encode($data, $options); |
927 | 927 | |
928 | - if($json===false) |
|
928 | + if ($json === false) |
|
929 | 929 | { |
930 | 930 | $errorCode = json_last_error(); |
931 | 931 | |
@@ -951,14 +951,14 @@ discard block |
||
951 | 951 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
952 | 952 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
953 | 953 | */ |
954 | - public static function saveFile(string $filePath, string $content='') : void |
|
954 | + public static function saveFile(string $filePath, string $content = '') : void |
|
955 | 955 | { |
956 | 956 | $filePath = self::normalizePath($filePath); |
957 | 957 | |
958 | 958 | // target file already exists |
959 | - if(file_exists($filePath)) |
|
959 | + if (file_exists($filePath)) |
|
960 | 960 | { |
961 | - if(!is_writable($filePath)) |
|
961 | + if (!is_writable($filePath)) |
|
962 | 962 | { |
963 | 963 | throw new FileHelper_Exception( |
964 | 964 | sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)), |
@@ -978,7 +978,7 @@ discard block |
||
978 | 978 | // create the folder as needed |
979 | 979 | self::createFolder($targetFolder); |
980 | 980 | |
981 | - if(!is_writable($targetFolder)) |
|
981 | + if (!is_writable($targetFolder)) |
|
982 | 982 | { |
983 | 983 | throw new FileHelper_Exception( |
984 | 984 | sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)), |
@@ -991,7 +991,7 @@ discard block |
||
991 | 991 | } |
992 | 992 | } |
993 | 993 | |
994 | - if(is_dir($filePath)) |
|
994 | + if (is_dir($filePath)) |
|
995 | 995 | { |
996 | 996 | throw new FileHelper_Exception( |
997 | 997 | sprintf('Cannot save file: the target [%s] is a directory.', basename($filePath)), |
@@ -1003,7 +1003,7 @@ discard block |
||
1003 | 1003 | ); |
1004 | 1004 | } |
1005 | 1005 | |
1006 | - if(file_put_contents($filePath, $content) !== false) { |
|
1006 | + if (file_put_contents($filePath, $content) !== false) { |
|
1007 | 1007 | return; |
1008 | 1008 | } |
1009 | 1009 | |
@@ -1042,7 +1042,7 @@ discard block |
||
1042 | 1042 | { |
1043 | 1043 | static $checked = array(); |
1044 | 1044 | |
1045 | - if(isset($checked[$command])) { |
|
1045 | + if (isset($checked[$command])) { |
|
1046 | 1046 | return $checked[$command]; |
1047 | 1047 | } |
1048 | 1048 | |
@@ -1055,7 +1055,7 @@ discard block |
||
1055 | 1055 | |
1056 | 1056 | $os = strtolower(PHP_OS_FAMILY); |
1057 | 1057 | |
1058 | - if(!isset($osCommands[$os])) |
|
1058 | + if (!isset($osCommands[$os])) |
|
1059 | 1059 | { |
1060 | 1060 | throw new FileHelper_Exception( |
1061 | 1061 | 'Unsupported OS for CLI commands', |
@@ -1081,7 +1081,7 @@ discard block |
||
1081 | 1081 | $pipes |
1082 | 1082 | ); |
1083 | 1083 | |
1084 | - if($process === false) { |
|
1084 | + if ($process === false) { |
|
1085 | 1085 | $checked[$command] = false; |
1086 | 1086 | return false; |
1087 | 1087 | } |
@@ -1113,7 +1113,7 @@ discard block |
||
1113 | 1113 | */ |
1114 | 1114 | public static function checkPHPFileSyntax(string $path) |
1115 | 1115 | { |
1116 | - if(!self::canMakePHPCalls()) { |
|
1116 | + if (!self::canMakePHPCalls()) { |
|
1117 | 1117 | return true; |
1118 | 1118 | } |
1119 | 1119 | |
@@ -1124,7 +1124,7 @@ discard block |
||
1124 | 1124 | // when the validation is successful, the first entry |
1125 | 1125 | // in the array contains the success message. When it |
1126 | 1126 | // is invalid, the first entry is always empty. |
1127 | - if(!empty($output[0])) { |
|
1127 | + if (!empty($output[0])) { |
|
1128 | 1128 | return true; |
1129 | 1129 | } |
1130 | 1130 | |
@@ -1145,7 +1145,7 @@ discard block |
||
1145 | 1145 | public static function getModifiedDate(string $path) : ?DateTime |
1146 | 1146 | { |
1147 | 1147 | $time = filemtime($path); |
1148 | - if($time === false) { |
|
1148 | + if ($time === false) { |
|
1149 | 1149 | return null; |
1150 | 1150 | } |
1151 | 1151 | |
@@ -1175,11 +1175,11 @@ discard block |
||
1175 | 1175 | */ |
1176 | 1176 | public static function getSubfolders($targetFolder, $options = array()) |
1177 | 1177 | { |
1178 | - if($targetFolder instanceof DirectoryIterator) { |
|
1178 | + if ($targetFolder instanceof DirectoryIterator) { |
|
1179 | 1179 | $targetFolder = $targetFolder->getPathname(); |
1180 | 1180 | } |
1181 | 1181 | |
1182 | - if(!is_dir($targetFolder)) |
|
1182 | + if (!is_dir($targetFolder)) |
|
1183 | 1183 | { |
1184 | 1184 | throw new FileHelper_Exception( |
1185 | 1185 | 'Target folder does not exist', |
@@ -1203,29 +1203,29 @@ discard block |
||
1203 | 1203 | |
1204 | 1204 | $d = new DirectoryIterator($targetFolder); |
1205 | 1205 | |
1206 | - foreach($d as $item) |
|
1206 | + foreach ($d as $item) |
|
1207 | 1207 | { |
1208 | - if($item->isDir() && !$item->isDot()) |
|
1208 | + if ($item->isDir() && !$item->isDot()) |
|
1209 | 1209 | { |
1210 | 1210 | $name = $item->getFilename(); |
1211 | 1211 | |
1212 | - if(!$options['absolute-path']) { |
|
1212 | + if (!$options['absolute-path']) { |
|
1213 | 1213 | $result[] = $name; |
1214 | 1214 | } else { |
1215 | 1215 | $result[] = $targetFolder.'/'.$name; |
1216 | 1216 | } |
1217 | 1217 | |
1218 | - if(!$options['recursive']) |
|
1218 | + if (!$options['recursive']) |
|
1219 | 1219 | { |
1220 | 1220 | continue; |
1221 | 1221 | } |
1222 | 1222 | |
1223 | 1223 | $subs = self::getSubfolders($targetFolder.'/'.$name, $options); |
1224 | - foreach($subs as $sub) |
|
1224 | + foreach ($subs as $sub) |
|
1225 | 1225 | { |
1226 | 1226 | $relative = $name.'/'.$sub; |
1227 | 1227 | |
1228 | - if(!$options['absolute-path']) { |
|
1228 | + if (!$options['absolute-path']) { |
|
1229 | 1229 | $result[] = $relative; |
1230 | 1230 | } else { |
1231 | 1231 | $result[] = $targetFolder.'/'.$relative; |
@@ -1275,7 +1275,7 @@ discard block |
||
1275 | 1275 | $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size. |
1276 | 1276 | $size = floatval(preg_replace('/[^0-9\.]/', '', $size)); // Remove the non-numeric characters from the size. |
1277 | 1277 | |
1278 | - if($unit) |
|
1278 | + if ($unit) |
|
1279 | 1279 | { |
1280 | 1280 | // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by. |
1281 | 1281 | return round($size * pow(1024, stripos('bkmgtpezy', $unit[0]))); |
@@ -1294,7 +1294,7 @@ discard block |
||
1294 | 1294 | * @param int $depth The folder depth to reduce the path to |
1295 | 1295 | * @return string |
1296 | 1296 | */ |
1297 | - public static function relativizePathByDepth(string $path, int $depth=2) : string |
|
1297 | + public static function relativizePathByDepth(string $path, int $depth = 2) : string |
|
1298 | 1298 | { |
1299 | 1299 | $path = self::normalizePath($path); |
1300 | 1300 | |
@@ -1302,17 +1302,17 @@ discard block |
||
1302 | 1302 | $tokens = array_filter($tokens); // remove empty entries (trailing slash for example) |
1303 | 1303 | $tokens = array_values($tokens); // re-index keys |
1304 | 1304 | |
1305 | - if(empty($tokens)) { |
|
1305 | + if (empty($tokens)) { |
|
1306 | 1306 | return ''; |
1307 | 1307 | } |
1308 | 1308 | |
1309 | 1309 | // remove the drive if present |
1310 | - if(strstr($tokens[0], ':')) { |
|
1310 | + if (strstr($tokens[0], ':')) { |
|
1311 | 1311 | array_shift($tokens); |
1312 | 1312 | } |
1313 | 1313 | |
1314 | 1314 | // path was only the drive |
1315 | - if(count($tokens) == 0) { |
|
1315 | + if (count($tokens) == 0) { |
|
1316 | 1316 | return ''; |
1317 | 1317 | } |
1318 | 1318 | |
@@ -1321,8 +1321,8 @@ discard block |
||
1321 | 1321 | |
1322 | 1322 | // reduce the path to the specified depth |
1323 | 1323 | $length = count($tokens); |
1324 | - if($length > $depth) { |
|
1325 | - $tokens = array_slice($tokens, $length-$depth); |
|
1324 | + if ($length > $depth) { |
|
1325 | + $tokens = array_slice($tokens, $length - $depth); |
|
1326 | 1326 | } |
1327 | 1327 | |
1328 | 1328 | // append the last element again |
@@ -1370,14 +1370,14 @@ discard block |
||
1370 | 1370 | * |
1371 | 1371 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
1372 | 1372 | */ |
1373 | - public static function requireFileExists(string $path, ?int $errorCode=null) : string |
|
1373 | + public static function requireFileExists(string $path, ?int $errorCode = null) : string |
|
1374 | 1374 | { |
1375 | 1375 | $result = realpath($path); |
1376 | - if($result !== false) { |
|
1376 | + if ($result !== false) { |
|
1377 | 1377 | return $result; |
1378 | 1378 | } |
1379 | 1379 | |
1380 | - if($errorCode === null) { |
|
1380 | + if ($errorCode === null) { |
|
1381 | 1381 | $errorCode = self::ERROR_FILE_DOES_NOT_EXIST; |
1382 | 1382 | } |
1383 | 1383 | |
@@ -1394,15 +1394,15 @@ discard block |
||
1394 | 1394 | * @return string |
1395 | 1395 | * @throws FileHelper_Exception |
1396 | 1396 | */ |
1397 | - public static function requireFileReadable(string $path, ?int $errorCode=null) : string |
|
1397 | + public static function requireFileReadable(string $path, ?int $errorCode = null) : string |
|
1398 | 1398 | { |
1399 | 1399 | $path = self::requireFileExists($path, $errorCode); |
1400 | 1400 | |
1401 | - if(is_readable($path)) { |
|
1401 | + if (is_readable($path)) { |
|
1402 | 1402 | return $path; |
1403 | 1403 | } |
1404 | 1404 | |
1405 | - if($errorCode === null) { |
|
1405 | + if ($errorCode === null) { |
|
1406 | 1406 | $errorCode = self::ERROR_FILE_NOT_READABLE; |
1407 | 1407 | } |
1408 | 1408 | |
@@ -1431,15 +1431,15 @@ discard block |
||
1431 | 1431 | |
1432 | 1432 | $file = new \SplFileObject($path); |
1433 | 1433 | |
1434 | - if($file->eof()) { |
|
1434 | + if ($file->eof()) { |
|
1435 | 1435 | return ''; |
1436 | 1436 | } |
1437 | 1437 | |
1438 | - $targetLine = $lineNumber-1; |
|
1438 | + $targetLine = $lineNumber - 1; |
|
1439 | 1439 | |
1440 | 1440 | $file->seek($targetLine); |
1441 | 1441 | |
1442 | - if($file->key() !== $targetLine) { |
|
1442 | + if ($file->key() !== $targetLine) { |
|
1443 | 1443 | return null; |
1444 | 1444 | } |
1445 | 1445 | |
@@ -1465,7 +1465,7 @@ discard block |
||
1465 | 1465 | $number = $spl->key(); |
1466 | 1466 | |
1467 | 1467 | // if seeking to the end the cursor is still at 0, there are no lines. |
1468 | - if($number === 0) |
|
1468 | + if ($number === 0) |
|
1469 | 1469 | { |
1470 | 1470 | // since it's a very small file, to get reliable results, |
1471 | 1471 | // we read its contents and use that to determine what |
@@ -1473,13 +1473,13 @@ discard block |
||
1473 | 1473 | // that this is not pactical to solve with the SplFileObject. |
1474 | 1474 | $content = file_get_contents($path); |
1475 | 1475 | |
1476 | - if(empty($content)) { |
|
1476 | + if (empty($content)) { |
|
1477 | 1477 | return 0; |
1478 | 1478 | } |
1479 | 1479 | } |
1480 | 1480 | |
1481 | 1481 | // return the line number we were able to reach + 1 (key is zero-based) |
1482 | - return $number+1; |
|
1482 | + return $number + 1; |
|
1483 | 1483 | } |
1484 | 1484 | |
1485 | 1485 | /** |
@@ -1526,13 +1526,13 @@ discard block |
||
1526 | 1526 | * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
1527 | 1527 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
1528 | 1528 | */ |
1529 | - public static function readLines(string $filePath, int $amount=0) : array |
|
1529 | + public static function readLines(string $filePath, int $amount = 0) : array |
|
1530 | 1530 | { |
1531 | 1531 | self::requireFileExists($filePath); |
1532 | 1532 | |
1533 | 1533 | $fn = fopen($filePath, "r"); |
1534 | 1534 | |
1535 | - if($fn === false) |
|
1535 | + if ($fn === false) |
|
1536 | 1536 | { |
1537 | 1537 | throw new FileHelper_Exception( |
1538 | 1538 | 'Could not open file for reading.', |
@@ -1548,19 +1548,19 @@ discard block |
||
1548 | 1548 | $counter = 0; |
1549 | 1549 | $first = true; |
1550 | 1550 | |
1551 | - while(!feof($fn)) |
|
1551 | + while (!feof($fn)) |
|
1552 | 1552 | { |
1553 | 1553 | $counter++; |
1554 | 1554 | |
1555 | 1555 | $line = fgets($fn); |
1556 | 1556 | |
1557 | 1557 | // can happen with zero length files |
1558 | - if($line === false) { |
|
1558 | + if ($line === false) { |
|
1559 | 1559 | continue; |
1560 | 1560 | } |
1561 | 1561 | |
1562 | 1562 | // the first line may contain a unicode BOM marker. |
1563 | - if($first) |
|
1563 | + if ($first) |
|
1564 | 1564 | { |
1565 | 1565 | $line = ConvertHelper::stripUTFBom($line); |
1566 | 1566 | $first = false; |
@@ -1568,7 +1568,7 @@ discard block |
||
1568 | 1568 | |
1569 | 1569 | $result[] = $line; |
1570 | 1570 | |
1571 | - if($amount > 0 && $counter == $amount) { |
|
1571 | + if ($amount > 0 && $counter == $amount) { |
|
1572 | 1572 | break; |
1573 | 1573 | } |
1574 | 1574 | } |
@@ -1594,7 +1594,7 @@ discard block |
||
1594 | 1594 | |
1595 | 1595 | $result = file_get_contents($filePath); |
1596 | 1596 | |
1597 | - if($result !== false) { |
|
1597 | + if ($result !== false) { |
|
1598 | 1598 | return $result; |
1599 | 1599 | } |
1600 | 1600 | |
@@ -1624,7 +1624,7 @@ discard block |
||
1624 | 1624 | { |
1625 | 1625 | $actual = realpath($path); |
1626 | 1626 | |
1627 | - if($actual === false) |
|
1627 | + if ($actual === false) |
|
1628 | 1628 | { |
1629 | 1629 | throw new FileHelper_Exception( |
1630 | 1630 | 'Folder does not exist', |
@@ -1636,7 +1636,7 @@ discard block |
||
1636 | 1636 | ); |
1637 | 1637 | } |
1638 | 1638 | |
1639 | - if(is_dir($path)) |
|
1639 | + if (is_dir($path)) |
|
1640 | 1640 | { |
1641 | 1641 | return self::normalizePath($actual); |
1642 | 1642 | } |
@@ -1658,7 +1658,7 @@ discard block |
||
1658 | 1658 | * @param string[] $paths |
1659 | 1659 | * @return FileHelper_PathsReducer |
1660 | 1660 | */ |
1661 | - public static function createPathsReducer(array $paths=array()) : FileHelper_PathsReducer |
|
1661 | + public static function createPathsReducer(array $paths = array()) : FileHelper_PathsReducer |
|
1662 | 1662 | { |
1663 | 1663 | return new FileHelper_PathsReducer(); |
1664 | 1664 | } |
@@ -15,7 +15,7 @@ |
||
15 | 15 | $autoload = $root.'/vendor/autoload.php'; |
16 | 16 | |
17 | 17 | // we need the autoloader to be present |
18 | - if($autoload === false) |
|
18 | + if ($autoload === false) |
|
19 | 19 | { |
20 | 20 | die('<b>ERROR:</b> Autoloader not present. Run composer update first.'); |
21 | 21 | } |
@@ -29,7 +29,7 @@ |
||
29 | 29 | |
30 | 30 | // In the case of tel URLs, we convert the syntax to use double |
31 | 31 | // slashes to make them parsable. |
32 | - if(strstr($url, 'tel:') !== false && strstr($url, 'tel://') === false) { |
|
32 | + if (strstr($url, 'tel:') !== false && strstr($url, 'tel://') === false) { |
|
33 | 33 | $url = str_replace('tel:', 'tel://', $url); |
34 | 34 | } |
35 | 35 |
@@ -15,9 +15,9 @@ discard block |
||
15 | 15 | */ |
16 | 16 | public static function removeKeys(array &$sourceArray, array $keys) : void |
17 | 17 | { |
18 | - foreach($keys as $key) |
|
18 | + foreach ($keys as $key) |
|
19 | 19 | { |
20 | - if(array_key_exists($key, $sourceArray)) { |
|
20 | + if (array_key_exists($key, $sourceArray)) { |
|
21 | 21 | unset($sourceArray[$key]); |
22 | 22 | } |
23 | 23 | } |
@@ -30,18 +30,18 @@ discard block |
||
30 | 30 | * @param bool $keepKeys Whether to maintain index association |
31 | 31 | * @return array |
32 | 32 | */ |
33 | - public static function removeValues(array $sourceArray, array $values, bool $keepKeys=false) : array |
|
33 | + public static function removeValues(array $sourceArray, array $values, bool $keepKeys = false) : array |
|
34 | 34 | { |
35 | 35 | $result = array(); |
36 | 36 | $values = array_values($values); |
37 | 37 | |
38 | - foreach($sourceArray as $key => $value) |
|
38 | + foreach ($sourceArray as $key => $value) |
|
39 | 39 | { |
40 | - if(in_array($value, $values, true)) { |
|
40 | + if (in_array($value, $values, true)) { |
|
41 | 41 | continue; |
42 | 42 | } |
43 | 43 | |
44 | - if($keepKeys) { |
|
44 | + if ($keepKeys) { |
|
45 | 45 | $result[$key] = $value; |
46 | 46 | continue; |
47 | 47 | } |
@@ -74,7 +74,7 @@ discard block |
||
74 | 74 | public static function toStyleString(array $subject) : string |
75 | 75 | { |
76 | 76 | $tokens = array(); |
77 | - foreach($subject as $name => $value) { |
|
77 | + foreach ($subject as $name => $value) { |
|
78 | 78 | $tokens[] = $name.':'.strval($value); |
79 | 79 | } |
80 | 80 | |
@@ -103,18 +103,18 @@ discard block |
||
103 | 103 | public static function toAttributeString(array $array) : string |
104 | 104 | { |
105 | 105 | $tokens = array(); |
106 | - foreach($array as $attr => $value) |
|
106 | + foreach ($array as $attr => $value) |
|
107 | 107 | { |
108 | 108 | $value = strval($value); |
109 | 109 | |
110 | - if($value === '') { |
|
110 | + if ($value === '') { |
|
111 | 111 | continue; |
112 | 112 | } |
113 | 113 | |
114 | 114 | $tokens[] = $attr.'="'.htmlspecialchars($value, ENT_QUOTES, 'UTF-8').'"'; |
115 | 115 | } |
116 | 116 | |
117 | - if(empty($tokens)) { |
|
117 | + if (empty($tokens)) { |
|
118 | 118 | return ''; |
119 | 119 | } |
120 | 120 | |
@@ -135,17 +135,17 @@ discard block |
||
135 | 135 | */ |
136 | 136 | public static function implodeWithAnd(array $list, string $sep = ', ', string $conjunction = '') : string |
137 | 137 | { |
138 | - if(empty($list)) { |
|
138 | + if (empty($list)) { |
|
139 | 139 | return ''; |
140 | 140 | } |
141 | 141 | |
142 | - if(empty($conjunction)) { |
|
142 | + if (empty($conjunction)) { |
|
143 | 143 | $conjunction = ' '.t('and').' '; |
144 | 144 | } |
145 | 145 | |
146 | 146 | $last = array_pop($list); |
147 | - if($list) { |
|
148 | - return implode($sep, $list) . $conjunction . $last; |
|
147 | + if ($list) { |
|
148 | + return implode($sep, $list).$conjunction.$last; |
|
149 | 149 | } |
150 | 150 | |
151 | 151 | return $last; |
@@ -29,17 +29,17 @@ discard block |
||
29 | 29 | */ |
30 | 30 | public static function fromString($string) : bool |
31 | 31 | { |
32 | - if($string === '' || $string === null || !is_scalar($string)) |
|
32 | + if ($string === '' || $string === null || !is_scalar($string)) |
|
33 | 33 | { |
34 | 34 | return false; |
35 | 35 | } |
36 | 36 | |
37 | - if(is_bool($string)) |
|
37 | + if (is_bool($string)) |
|
38 | 38 | { |
39 | 39 | return $string; |
40 | 40 | } |
41 | 41 | |
42 | - if(array_key_exists($string, self::$booleanStrings)) |
|
42 | + if (array_key_exists($string, self::$booleanStrings)) |
|
43 | 43 | { |
44 | 44 | return self::$booleanStrings[$string]; |
45 | 45 | } |
@@ -67,7 +67,7 @@ discard block |
||
67 | 67 | public static function toString($boolean, bool $yesno = false) : string |
68 | 68 | { |
69 | 69 | // allow 'yes', 'true', 'no', 'false' string notations as well |
70 | - if(!is_bool($boolean)) { |
|
70 | + if (!is_bool($boolean)) { |
|
71 | 71 | $boolean = self::fromString($boolean); |
72 | 72 | } |
73 | 73 | |
@@ -97,11 +97,11 @@ discard block |
||
97 | 97 | */ |
98 | 98 | public static function isBoolean($value) : bool |
99 | 99 | { |
100 | - if(is_bool($value)) { |
|
100 | + if (is_bool($value)) { |
|
101 | 101 | return true; |
102 | 102 | } |
103 | 103 | |
104 | - if(!is_scalar($value)) { |
|
104 | + if (!is_scalar($value)) { |
|
105 | 105 | return false; |
106 | 106 | } |
107 | 107 |
@@ -54,13 +54,13 @@ discard block |
||
54 | 54 | return ConvertHelper_String::tabs2spaces($string, $tabSize); |
55 | 55 | } |
56 | 56 | |
57 | - /** |
|
58 | - * Converts spaces to tabs in the specified string. |
|
59 | - * |
|
60 | - * @param string $string |
|
61 | - * @param int $tabSize The amount of spaces per tab in the source string. |
|
62 | - * @return string |
|
63 | - */ |
|
57 | + /** |
|
58 | + * Converts spaces to tabs in the specified string. |
|
59 | + * |
|
60 | + * @param string $string |
|
61 | + * @param int $tabSize The amount of spaces per tab in the source string. |
|
62 | + * @return string |
|
63 | + */ |
|
64 | 64 | public static function spaces2tabs(string $string, int $tabSize=4) : string |
65 | 65 | { |
66 | 66 | return ConvertHelper_String::spaces2tabs($string, $tabSize); |
@@ -78,133 +78,133 @@ discard block |
||
78 | 78 | return ConvertHelper_String::hidden2visible($string); |
79 | 79 | } |
80 | 80 | |
81 | - /** |
|
82 | - * Converts the specified amount of seconds into |
|
83 | - * a human readable string split in months, weeks, |
|
84 | - * days, hours, minutes and seconds. |
|
85 | - * |
|
86 | - * @param float $seconds |
|
87 | - * @return string |
|
88 | - */ |
|
81 | + /** |
|
82 | + * Converts the specified amount of seconds into |
|
83 | + * a human readable string split in months, weeks, |
|
84 | + * days, hours, minutes and seconds. |
|
85 | + * |
|
86 | + * @param float $seconds |
|
87 | + * @return string |
|
88 | + */ |
|
89 | 89 | public static function time2string($seconds) : string |
90 | 90 | { |
91 | 91 | $converter = new ConvertHelper_TimeConverter($seconds); |
92 | 92 | return $converter->toString(); |
93 | 93 | } |
94 | 94 | |
95 | - /** |
|
96 | - * Converts a timestamp into an easily understandable |
|
97 | - * format, e.g. "2 hours", "1 day", "3 months" |
|
98 | - * |
|
99 | - * If you set the date to parameter, the difference |
|
100 | - * will be calculated between the two dates and not |
|
101 | - * the current time. |
|
102 | - * |
|
103 | - * @param integer|DateTime $datefrom |
|
104 | - * @param integer|DateTime $dateto |
|
105 | - * @return string |
|
106 | - */ |
|
95 | + /** |
|
96 | + * Converts a timestamp into an easily understandable |
|
97 | + * format, e.g. "2 hours", "1 day", "3 months" |
|
98 | + * |
|
99 | + * If you set the date to parameter, the difference |
|
100 | + * will be calculated between the two dates and not |
|
101 | + * the current time. |
|
102 | + * |
|
103 | + * @param integer|DateTime $datefrom |
|
104 | + * @param integer|DateTime $dateto |
|
105 | + * @return string |
|
106 | + */ |
|
107 | 107 | public static function duration2string($datefrom, $dateto = -1) : string |
108 | 108 | { |
109 | - $converter = new ConvertHelper_DurationConverter(); |
|
109 | + $converter = new ConvertHelper_DurationConverter(); |
|
110 | 110 | |
111 | - if($datefrom instanceof DateTime) |
|
112 | - { |
|
113 | - $converter->setDateFrom($datefrom); |
|
114 | - } |
|
115 | - else |
|
116 | - { |
|
117 | - $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
118 | - } |
|
111 | + if($datefrom instanceof DateTime) |
|
112 | + { |
|
113 | + $converter->setDateFrom($datefrom); |
|
114 | + } |
|
115 | + else |
|
116 | + { |
|
117 | + $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
118 | + } |
|
119 | 119 | |
120 | - if($dateto instanceof DateTime) |
|
121 | - { |
|
122 | - $converter->setDateTo($dateto); |
|
123 | - } |
|
124 | - else if($dateto > 0) |
|
125 | - { |
|
126 | - $converter->setDateTo(self::timestamp2date($dateto)); |
|
127 | - } |
|
120 | + if($dateto instanceof DateTime) |
|
121 | + { |
|
122 | + $converter->setDateTo($dateto); |
|
123 | + } |
|
124 | + else if($dateto > 0) |
|
125 | + { |
|
126 | + $converter->setDateTo(self::timestamp2date($dateto)); |
|
127 | + } |
|
128 | 128 | |
129 | - return $converter->convert(); |
|
129 | + return $converter->convert(); |
|
130 | 130 | } |
131 | 131 | |
132 | - /** |
|
133 | - * Adds HTML syntax highlighting to the specified SQL string. |
|
134 | - * |
|
135 | - * @param string $sql |
|
136 | - * @return string |
|
137 | - * @deprecated Use the Highlighter class directly instead. |
|
138 | - * @see Highlighter::sql() |
|
139 | - */ |
|
132 | + /** |
|
133 | + * Adds HTML syntax highlighting to the specified SQL string. |
|
134 | + * |
|
135 | + * @param string $sql |
|
136 | + * @return string |
|
137 | + * @deprecated Use the Highlighter class directly instead. |
|
138 | + * @see Highlighter::sql() |
|
139 | + */ |
|
140 | 140 | public static function highlight_sql(string $sql) : string |
141 | 141 | { |
142 | 142 | return Highlighter::sql($sql); |
143 | 143 | } |
144 | 144 | |
145 | - /** |
|
146 | - * Adds HTML syntax highlighting to the specified XML code. |
|
147 | - * |
|
148 | - * @param string $xml The XML to highlight. |
|
149 | - * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
150 | - * @return string |
|
151 | - * @deprecated Use the Highlighter class directly instead. |
|
152 | - * @see Highlighter::xml() |
|
153 | - */ |
|
145 | + /** |
|
146 | + * Adds HTML syntax highlighting to the specified XML code. |
|
147 | + * |
|
148 | + * @param string $xml The XML to highlight. |
|
149 | + * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
150 | + * @return string |
|
151 | + * @deprecated Use the Highlighter class directly instead. |
|
152 | + * @see Highlighter::xml() |
|
153 | + */ |
|
154 | 154 | public static function highlight_xml(string $xml, bool $formatSource=false) : string |
155 | 155 | { |
156 | 156 | return Highlighter::xml($xml, $formatSource); |
157 | 157 | } |
158 | 158 | |
159 | - /** |
|
160 | - * @param string $phpCode |
|
161 | - * @return string |
|
162 | - * @deprecated Use the Highlighter class directly instead. |
|
163 | - * @see Highlighter::php() |
|
164 | - */ |
|
159 | + /** |
|
160 | + * @param string $phpCode |
|
161 | + * @return string |
|
162 | + * @deprecated Use the Highlighter class directly instead. |
|
163 | + * @see Highlighter::php() |
|
164 | + */ |
|
165 | 165 | public static function highlight_php(string $phpCode) : string |
166 | 166 | { |
167 | 167 | return Highlighter::php($phpCode); |
168 | 168 | } |
169 | 169 | |
170 | - /** |
|
171 | - * Converts a number of bytes to a human readable form, |
|
172 | - * e.g. xx Kb / xx Mb / xx Gb |
|
173 | - * |
|
174 | - * @param int $bytes The amount of bytes to convert. |
|
175 | - * @param int $precision The amount of decimals |
|
176 | - * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB). |
|
177 | - * @return string |
|
178 | - * |
|
179 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
180 | - */ |
|
170 | + /** |
|
171 | + * Converts a number of bytes to a human readable form, |
|
172 | + * e.g. xx Kb / xx Mb / xx Gb |
|
173 | + * |
|
174 | + * @param int $bytes The amount of bytes to convert. |
|
175 | + * @param int $precision The amount of decimals |
|
176 | + * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB). |
|
177 | + * @return string |
|
178 | + * |
|
179 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
180 | + */ |
|
181 | 181 | public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string |
182 | 182 | { |
183 | 183 | return self::parseBytes($bytes)->toString($precision, $base); |
184 | 184 | } |
185 | 185 | |
186 | - /** |
|
187 | - * Parses a number of bytes, and creates a converter instance which |
|
188 | - * allows doing common operations with it. |
|
189 | - * |
|
190 | - * @param int $bytes |
|
191 | - * @return ConvertHelper_ByteConverter |
|
192 | - */ |
|
186 | + /** |
|
187 | + * Parses a number of bytes, and creates a converter instance which |
|
188 | + * allows doing common operations with it. |
|
189 | + * |
|
190 | + * @param int $bytes |
|
191 | + * @return ConvertHelper_ByteConverter |
|
192 | + */ |
|
193 | 193 | public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter |
194 | 194 | { |
195 | 195 | return new ConvertHelper_ByteConverter($bytes); |
196 | 196 | } |
197 | 197 | |
198 | - /** |
|
199 | - * Cuts a text to the specified length if it is longer than the |
|
200 | - * target length. Appends a text to signify it has been cut at |
|
201 | - * the end of the string. |
|
202 | - * |
|
203 | - * @param string $text |
|
204 | - * @param int $targetLength |
|
205 | - * @param string $append |
|
206 | - * @return string |
|
207 | - */ |
|
198 | + /** |
|
199 | + * Cuts a text to the specified length if it is longer than the |
|
200 | + * target length. Appends a text to signify it has been cut at |
|
201 | + * the end of the string. |
|
202 | + * |
|
203 | + * @param string $text |
|
204 | + * @param int $targetLength |
|
205 | + * @param string $append |
|
206 | + * @return string |
|
207 | + */ |
|
208 | 208 | public static function text_cut(string $text, int $targetLength, string $append = '...') : string |
209 | 209 | { |
210 | 210 | return ConvertHelper_String::cutText($text, $targetLength, $append); |
@@ -221,14 +221,14 @@ discard block |
||
221 | 221 | return $info->toString(); |
222 | 222 | } |
223 | 223 | |
224 | - /** |
|
225 | - * Pretty print_r. |
|
226 | - * |
|
227 | - * @param mixed $var The variable to dump. |
|
228 | - * @param bool $return Whether to return the dumped code. |
|
229 | - * @param bool $html Whether to style the dump as HTML. |
|
230 | - * @return string |
|
231 | - */ |
|
224 | + /** |
|
225 | + * Pretty print_r. |
|
226 | + * |
|
227 | + * @param mixed $var The variable to dump. |
|
228 | + * @param bool $return Whether to return the dumped code. |
|
229 | + * @param bool $html Whether to style the dump as HTML. |
|
230 | + * @return string |
|
231 | + */ |
|
232 | 232 | public static function print_r($var, bool $return=false, bool $html=true) : string |
233 | 233 | { |
234 | 234 | $result = parseVariable($var)->enableType()->toString(); |
@@ -249,41 +249,41 @@ discard block |
||
249 | 249 | return $result; |
250 | 250 | } |
251 | 251 | |
252 | - /** |
|
253 | - * Converts a string, number or boolean value to a boolean value. |
|
254 | - * |
|
255 | - * @param mixed $string |
|
256 | - * @throws ConvertHelper_Exception |
|
257 | - * @return bool |
|
258 | - * |
|
259 | - * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
260 | - */ |
|
252 | + /** |
|
253 | + * Converts a string, number or boolean value to a boolean value. |
|
254 | + * |
|
255 | + * @param mixed $string |
|
256 | + * @throws ConvertHelper_Exception |
|
257 | + * @return bool |
|
258 | + * |
|
259 | + * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
260 | + */ |
|
261 | 261 | public static function string2bool($string) : bool |
262 | 262 | { |
263 | 263 | return ConvertHelper_Bool::fromString($string); |
264 | 264 | } |
265 | 265 | |
266 | - /** |
|
267 | - * Whether the specified string is a boolean string or boolean value. |
|
268 | - * Alias for {@link ConvertHelper::isBoolean()}. |
|
269 | - * |
|
270 | - * @param mixed $string |
|
271 | - * @return bool |
|
272 | - * @deprecated |
|
273 | - * @see ConvertHelper::isBoolean() |
|
274 | - */ |
|
266 | + /** |
|
267 | + * Whether the specified string is a boolean string or boolean value. |
|
268 | + * Alias for {@link ConvertHelper::isBoolean()}. |
|
269 | + * |
|
270 | + * @param mixed $string |
|
271 | + * @return bool |
|
272 | + * @deprecated |
|
273 | + * @see ConvertHelper::isBoolean() |
|
274 | + */ |
|
275 | 275 | public static function isBooleanString($string) : bool |
276 | 276 | { |
277 | 277 | return self::isBoolean($string); |
278 | 278 | } |
279 | 279 | |
280 | - /** |
|
281 | - * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
282 | - * |
|
283 | - * @param string $text |
|
284 | - * @return string |
|
285 | - * @deprecated |
|
286 | - */ |
|
280 | + /** |
|
281 | + * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
282 | + * |
|
283 | + * @param string $text |
|
284 | + * @return string |
|
285 | + * @deprecated |
|
286 | + */ |
|
287 | 287 | public static function text_makeXMLCompliant($text) |
288 | 288 | { |
289 | 289 | return XMLHelper::string2xml($text); |
@@ -379,36 +379,36 @@ discard block |
||
379 | 379 | return ConvertHelper_String::transliterate($string, $spaceChar, $lowercase); |
380 | 380 | } |
381 | 381 | |
382 | - /** |
|
383 | - * Retrieves the HEX character codes for all control |
|
384 | - * characters that the {@link stripControlCharacters()} |
|
385 | - * method will remove. |
|
386 | - * |
|
387 | - * @return string[] |
|
388 | - */ |
|
382 | + /** |
|
383 | + * Retrieves the HEX character codes for all control |
|
384 | + * characters that the {@link stripControlCharacters()} |
|
385 | + * method will remove. |
|
386 | + * |
|
387 | + * @return string[] |
|
388 | + */ |
|
389 | 389 | public static function getControlCharactersAsHex() |
390 | 390 | { |
391 | 391 | return self::createControlCharacters()->getCharsAsHex(); |
392 | 392 | } |
393 | 393 | |
394 | - /** |
|
395 | - * Retrieves an array of all control characters that |
|
396 | - * the {@link stripControlCharacters()} method will |
|
397 | - * remove, as the actual UTF-8 characters. |
|
398 | - * |
|
399 | - * @return string[] |
|
400 | - */ |
|
394 | + /** |
|
395 | + * Retrieves an array of all control characters that |
|
396 | + * the {@link stripControlCharacters()} method will |
|
397 | + * remove, as the actual UTF-8 characters. |
|
398 | + * |
|
399 | + * @return string[] |
|
400 | + */ |
|
401 | 401 | public static function getControlCharactersAsUTF8() |
402 | 402 | { |
403 | 403 | return self::createControlCharacters()->getCharsAsUTF8(); |
404 | 404 | } |
405 | 405 | |
406 | - /** |
|
407 | - * Retrieves all control characters as JSON encoded |
|
408 | - * characters, e.g. "\u200b". |
|
409 | - * |
|
410 | - * @return string[] |
|
411 | - */ |
|
406 | + /** |
|
407 | + * Retrieves all control characters as JSON encoded |
|
408 | + * characters, e.g. "\u200b". |
|
409 | + * |
|
410 | + * @return string[] |
|
411 | + */ |
|
412 | 412 | public static function getControlCharactersAsJSON() |
413 | 413 | { |
414 | 414 | return self::createControlCharacters()->getCharsAsJSON(); |
@@ -429,31 +429,31 @@ discard block |
||
429 | 429 | return self::createControlCharacters()->stripControlCharacters($string); |
430 | 430 | } |
431 | 431 | |
432 | - /** |
|
433 | - * Creates the control characters class, used to |
|
434 | - * work with control characters in strings. |
|
435 | - * |
|
436 | - * @return ConvertHelper_ControlCharacters |
|
437 | - */ |
|
432 | + /** |
|
433 | + * Creates the control characters class, used to |
|
434 | + * work with control characters in strings. |
|
435 | + * |
|
436 | + * @return ConvertHelper_ControlCharacters |
|
437 | + */ |
|
438 | 438 | public static function createControlCharacters() : ConvertHelper_ControlCharacters |
439 | 439 | { |
440 | 440 | return new ConvertHelper_ControlCharacters(); |
441 | 441 | } |
442 | 442 | |
443 | - /** |
|
444 | - * Converts a unicode character to the PHPO notation. |
|
445 | - * |
|
446 | - * Example: |
|
447 | - * |
|
448 | - * <pre>unicodeChar2php('"\u0000"')</pre> |
|
449 | - * |
|
450 | - * Returns |
|
451 | - * |
|
452 | - * <pre>\x0</pre> |
|
453 | - * |
|
454 | - * @param string $unicodeChar |
|
455 | - * @return string |
|
456 | - */ |
|
443 | + /** |
|
444 | + * Converts a unicode character to the PHPO notation. |
|
445 | + * |
|
446 | + * Example: |
|
447 | + * |
|
448 | + * <pre>unicodeChar2php('"\u0000"')</pre> |
|
449 | + * |
|
450 | + * Returns |
|
451 | + * |
|
452 | + * <pre>\x0</pre> |
|
453 | + * |
|
454 | + * @param string $unicodeChar |
|
455 | + * @return string |
|
456 | + */ |
|
457 | 457 | public static function unicodeChar2php(string $unicodeChar) : string |
458 | 458 | { |
459 | 459 | $unicodeChar = json_decode($unicodeChar); |
@@ -563,87 +563,87 @@ discard block |
||
563 | 563 | return ConvertHelper_Bool::toString($boolean, $yesno); |
564 | 564 | } |
565 | 565 | |
566 | - /** |
|
567 | - * Converts an associative array with attribute name > value pairs |
|
568 | - * to an attribute string that can be used in an HTML tag. Empty |
|
569 | - * attribute values are ignored. |
|
570 | - * |
|
571 | - * Example: |
|
572 | - * |
|
573 | - * array2attributeString(array( |
|
574 | - * 'id' => 45, |
|
575 | - * 'href' => 'http://www.mistralys.com' |
|
576 | - * )); |
|
577 | - * |
|
578 | - * Result: |
|
579 | - * |
|
580 | - * id="45" href="http://www.mistralys.com" |
|
581 | - * |
|
582 | - * @param array<string,mixed> $array |
|
583 | - * @return string |
|
584 | - */ |
|
566 | + /** |
|
567 | + * Converts an associative array with attribute name > value pairs |
|
568 | + * to an attribute string that can be used in an HTML tag. Empty |
|
569 | + * attribute values are ignored. |
|
570 | + * |
|
571 | + * Example: |
|
572 | + * |
|
573 | + * array2attributeString(array( |
|
574 | + * 'id' => 45, |
|
575 | + * 'href' => 'http://www.mistralys.com' |
|
576 | + * )); |
|
577 | + * |
|
578 | + * Result: |
|
579 | + * |
|
580 | + * id="45" href="http://www.mistralys.com" |
|
581 | + * |
|
582 | + * @param array<string,mixed> $array |
|
583 | + * @return string |
|
584 | + */ |
|
585 | 585 | public static function array2attributeString(array $array) : string |
586 | 586 | { |
587 | 587 | return ConvertHelper_Array::toAttributeString($array); |
588 | 588 | } |
589 | 589 | |
590 | - /** |
|
591 | - * Converts a string so it can safely be used in a javascript |
|
592 | - * statement in an HTML tag: uses single quotes around the string |
|
593 | - * and encodes all special characters as needed. |
|
594 | - * |
|
595 | - * @param string $string |
|
596 | - * @return string |
|
597 | - * @deprecated Use the JSHelper class instead. |
|
598 | - * @see JSHelper::phpVariable2AttributeJS() |
|
599 | - */ |
|
590 | + /** |
|
591 | + * Converts a string so it can safely be used in a javascript |
|
592 | + * statement in an HTML tag: uses single quotes around the string |
|
593 | + * and encodes all special characters as needed. |
|
594 | + * |
|
595 | + * @param string $string |
|
596 | + * @return string |
|
597 | + * @deprecated Use the JSHelper class instead. |
|
598 | + * @see JSHelper::phpVariable2AttributeJS() |
|
599 | + */ |
|
600 | 600 | public static function string2attributeJS(string $string) : string |
601 | 601 | { |
602 | 602 | return JSHelper::phpVariable2AttributeJS($string); |
603 | 603 | } |
604 | 604 | |
605 | - /** |
|
606 | - * Checks if the specified string is a boolean value, which |
|
607 | - * includes string representations of boolean values, like |
|
608 | - * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
609 | - * or <code>false</code>. |
|
610 | - * |
|
611 | - * @param mixed $value |
|
612 | - * @return boolean |
|
613 | - */ |
|
605 | + /** |
|
606 | + * Checks if the specified string is a boolean value, which |
|
607 | + * includes string representations of boolean values, like |
|
608 | + * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
609 | + * or <code>false</code>. |
|
610 | + * |
|
611 | + * @param mixed $value |
|
612 | + * @return boolean |
|
613 | + */ |
|
614 | 614 | public static function isBoolean($value) : bool |
615 | 615 | { |
616 | 616 | return ConvertHelper_Bool::isBoolean($value); |
617 | 617 | } |
618 | 618 | |
619 | - /** |
|
620 | - * Converts an associative array to an HTML style attribute value string. |
|
621 | - * |
|
622 | - * @param array<string,mixed> $subject |
|
623 | - * @return string |
|
624 | - */ |
|
619 | + /** |
|
620 | + * Converts an associative array to an HTML style attribute value string. |
|
621 | + * |
|
622 | + * @param array<string,mixed> $subject |
|
623 | + * @return string |
|
624 | + */ |
|
625 | 625 | public static function array2styleString(array $subject) : string |
626 | 626 | { |
627 | 627 | return ConvertHelper_Array::toStyleString($subject); |
628 | 628 | } |
629 | 629 | |
630 | - /** |
|
631 | - * Converts a DateTime object to a timestamp, which |
|
632 | - * is PHP 5.2 compatible. |
|
633 | - * |
|
634 | - * @param DateTime $date |
|
635 | - * @return integer |
|
636 | - */ |
|
630 | + /** |
|
631 | + * Converts a DateTime object to a timestamp, which |
|
632 | + * is PHP 5.2 compatible. |
|
633 | + * |
|
634 | + * @param DateTime $date |
|
635 | + * @return integer |
|
636 | + */ |
|
637 | 637 | public static function date2timestamp(DateTime $date) : int |
638 | 638 | { |
639 | 639 | return (int)$date->format('U'); |
640 | 640 | } |
641 | 641 | |
642 | - /** |
|
643 | - * Converts a timestamp into a DateTime instance. |
|
644 | - * @param int $timestamp |
|
645 | - * @return DateTime |
|
646 | - */ |
|
642 | + /** |
|
643 | + * Converts a timestamp into a DateTime instance. |
|
644 | + * @param int $timestamp |
|
645 | + * @return DateTime |
|
646 | + */ |
|
647 | 647 | public static function timestamp2date(int $timestamp) : DateTime |
648 | 648 | { |
649 | 649 | $date = new DateTime(); |
@@ -651,50 +651,50 @@ discard block |
||
651 | 651 | return $date; |
652 | 652 | } |
653 | 653 | |
654 | - /** |
|
655 | - * Strips an absolute path to a file within the application |
|
656 | - * to make the path relative to the application root path. |
|
657 | - * |
|
658 | - * @param string $path |
|
659 | - * @return string |
|
660 | - * |
|
661 | - * @see FileHelper::relativizePath() |
|
662 | - * @see FileHelper::relativizePathByDepth() |
|
663 | - */ |
|
654 | + /** |
|
655 | + * Strips an absolute path to a file within the application |
|
656 | + * to make the path relative to the application root path. |
|
657 | + * |
|
658 | + * @param string $path |
|
659 | + * @return string |
|
660 | + * |
|
661 | + * @see FileHelper::relativizePath() |
|
662 | + * @see FileHelper::relativizePathByDepth() |
|
663 | + */ |
|
664 | 664 | public static function fileRelativize(string $path) : string |
665 | 665 | { |
666 | 666 | return FileHelper::relativizePathByDepth($path); |
667 | 667 | } |
668 | 668 | |
669 | 669 | /** |
670 | - * Converts a PHP regex to a javascript RegExp object statement. |
|
671 | - * |
|
672 | - * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
673 | - * More details are available on its usage there. |
|
674 | - * |
|
675 | - * @param string $regex A PHP preg regex |
|
676 | - * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
677 | - * @return array|string Depending on the specified return type. |
|
678 | - * |
|
679 | - * @see JSHelper::buildRegexStatement() |
|
680 | - */ |
|
670 | + * Converts a PHP regex to a javascript RegExp object statement. |
|
671 | + * |
|
672 | + * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
673 | + * More details are available on its usage there. |
|
674 | + * |
|
675 | + * @param string $regex A PHP preg regex |
|
676 | + * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
677 | + * @return array|string Depending on the specified return type. |
|
678 | + * |
|
679 | + * @see JSHelper::buildRegexStatement() |
|
680 | + */ |
|
681 | 681 | public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
682 | 682 | { |
683 | 683 | return JSHelper::buildRegexStatement($regex, $statementType); |
684 | 684 | } |
685 | 685 | |
686 | - /** |
|
687 | - * Converts the specified variable to JSON. Works just |
|
688 | - * like the native `json_encode` method, except that it |
|
689 | - * will trigger an exception on failure, which has the |
|
690 | - * json error details included in its developer details. |
|
691 | - * |
|
692 | - * @param mixed $variable |
|
693 | - * @param int $options JSON encode options. |
|
694 | - * @param int $depth |
|
695 | - * @throws ConvertHelper_Exception |
|
696 | - * @return string |
|
697 | - */ |
|
686 | + /** |
|
687 | + * Converts the specified variable to JSON. Works just |
|
688 | + * like the native `json_encode` method, except that it |
|
689 | + * will trigger an exception on failure, which has the |
|
690 | + * json error details included in its developer details. |
|
691 | + * |
|
692 | + * @param mixed $variable |
|
693 | + * @param int $options JSON encode options. |
|
694 | + * @param int $depth |
|
695 | + * @throws ConvertHelper_Exception |
|
696 | + * @return string |
|
697 | + */ |
|
698 | 698 | public static function var2json($variable, int $options=0, int $depth=512) : string |
699 | 699 | { |
700 | 700 | $result = json_encode($variable, $options, $depth); |
@@ -715,12 +715,12 @@ discard block |
||
715 | 715 | ); |
716 | 716 | } |
717 | 717 | |
718 | - /** |
|
719 | - * Strips all known UTF byte order marks from the specified string. |
|
720 | - * |
|
721 | - * @param string $string |
|
722 | - * @return string |
|
723 | - */ |
|
718 | + /** |
|
719 | + * Strips all known UTF byte order marks from the specified string. |
|
720 | + * |
|
721 | + * @param string $string |
|
722 | + * @return string |
|
723 | + */ |
|
724 | 724 | public static function stripUTFBom($string) |
725 | 725 | { |
726 | 726 | $boms = FileHelper::getUTFBOMs(); |
@@ -735,65 +735,65 @@ discard block |
||
735 | 735 | return $string; |
736 | 736 | } |
737 | 737 | |
738 | - /** |
|
739 | - * Converts a string to valid utf8, regardless |
|
740 | - * of the string's encoding(s). |
|
741 | - * |
|
742 | - * @param string $string |
|
743 | - * @return string |
|
744 | - */ |
|
738 | + /** |
|
739 | + * Converts a string to valid utf8, regardless |
|
740 | + * of the string's encoding(s). |
|
741 | + * |
|
742 | + * @param string $string |
|
743 | + * @return string |
|
744 | + */ |
|
745 | 745 | public static function string2utf8(string $string) : string |
746 | 746 | { |
747 | 747 | return ConvertHelper_String::toUtf8($string); |
748 | 748 | } |
749 | 749 | |
750 | - /** |
|
751 | - * Checks whether the specified string is an ASCII |
|
752 | - * string, without any special or UTF8 characters. |
|
753 | - * Note: empty strings and NULL are considered ASCII. |
|
754 | - * Any variable types other than strings are not. |
|
755 | - * |
|
756 | - * @param string|float|int|NULL $string |
|
757 | - * @return boolean |
|
758 | - */ |
|
750 | + /** |
|
751 | + * Checks whether the specified string is an ASCII |
|
752 | + * string, without any special or UTF8 characters. |
|
753 | + * Note: empty strings and NULL are considered ASCII. |
|
754 | + * Any variable types other than strings are not. |
|
755 | + * |
|
756 | + * @param string|float|int|NULL $string |
|
757 | + * @return boolean |
|
758 | + */ |
|
759 | 759 | public static function isStringASCII($string) : bool |
760 | 760 | { |
761 | 761 | return ConvertHelper_String::isASCII(strval($string)); |
762 | 762 | } |
763 | 763 | |
764 | - /** |
|
765 | - * Adds HTML syntax highlighting to an URL. |
|
766 | - * |
|
767 | - * NOTE: Includes the necessary CSS styles. When |
|
768 | - * highlighting several URLs in the same page, |
|
769 | - * prefer using the `parseURL` function instead. |
|
770 | - * |
|
771 | - * @param string $url |
|
772 | - * @return string |
|
773 | - * @deprecated Use the Highlighter class directly instead. |
|
774 | - * @see Highlighter |
|
775 | - */ |
|
764 | + /** |
|
765 | + * Adds HTML syntax highlighting to an URL. |
|
766 | + * |
|
767 | + * NOTE: Includes the necessary CSS styles. When |
|
768 | + * highlighting several URLs in the same page, |
|
769 | + * prefer using the `parseURL` function instead. |
|
770 | + * |
|
771 | + * @param string $url |
|
772 | + * @return string |
|
773 | + * @deprecated Use the Highlighter class directly instead. |
|
774 | + * @see Highlighter |
|
775 | + */ |
|
776 | 776 | public static function highlight_url(string $url) : string |
777 | 777 | { |
778 | 778 | return Highlighter::url($url); |
779 | 779 | } |
780 | 780 | |
781 | - /** |
|
782 | - * Calculates a percentage match of the source string with the target string. |
|
783 | - * |
|
784 | - * Options are: |
|
785 | - * |
|
786 | - * - maxLevenshtein, default: 10 |
|
787 | - * Any levenshtein results above this value are ignored. |
|
788 | - * |
|
789 | - * - precision, default: 1 |
|
790 | - * The precision of the percentage float value |
|
791 | - * |
|
792 | - * @param string $source |
|
793 | - * @param string $target |
|
794 | - * @param array $options |
|
795 | - * @return float |
|
796 | - */ |
|
781 | + /** |
|
782 | + * Calculates a percentage match of the source string with the target string. |
|
783 | + * |
|
784 | + * Options are: |
|
785 | + * |
|
786 | + * - maxLevenshtein, default: 10 |
|
787 | + * Any levenshtein results above this value are ignored. |
|
788 | + * |
|
789 | + * - precision, default: 1 |
|
790 | + * The precision of the percentage float value |
|
791 | + * |
|
792 | + * @param string $source |
|
793 | + * @param string $target |
|
794 | + * @param array $options |
|
795 | + * @return float |
|
796 | + */ |
|
797 | 797 | public static function matchString($source, $target, $options=array()) |
798 | 798 | { |
799 | 799 | $defaults = array( |
@@ -817,14 +817,14 @@ discard block |
||
817 | 817 | return round(100 - $percent, $options['precision']); |
818 | 818 | } |
819 | 819 | |
820 | - /** |
|
821 | - * Converts a date interval to a human readable string with |
|
822 | - * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
823 | - * |
|
824 | - * @param \DateInterval $interval |
|
825 | - * @return string |
|
826 | - * @see ConvertHelper_IntervalConverter |
|
827 | - */ |
|
820 | + /** |
|
821 | + * Converts a date interval to a human readable string with |
|
822 | + * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
823 | + * |
|
824 | + * @param \DateInterval $interval |
|
825 | + * @return string |
|
826 | + * @see ConvertHelper_IntervalConverter |
|
827 | + */ |
|
828 | 828 | public static function interval2string(\DateInterval $interval) : string |
829 | 829 | { |
830 | 830 | $converter = new ConvertHelper_IntervalConverter(); |
@@ -839,60 +839,60 @@ discard block |
||
839 | 839 | |
840 | 840 | const INTERVAL_SECONDS = 'seconds'; |
841 | 841 | |
842 | - /** |
|
843 | - * Converts an interval to its total amount of days. |
|
844 | - * @param \DateInterval $interval |
|
845 | - * @return int |
|
846 | - */ |
|
842 | + /** |
|
843 | + * Converts an interval to its total amount of days. |
|
844 | + * @param \DateInterval $interval |
|
845 | + * @return int |
|
846 | + */ |
|
847 | 847 | public static function interval2days(\DateInterval $interval) : int |
848 | 848 | { |
849 | 849 | return self::interval2total($interval, self::INTERVAL_DAYS); |
850 | 850 | } |
851 | 851 | |
852 | - /** |
|
853 | - * Converts an interval to its total amount of hours. |
|
854 | - * @param \DateInterval $interval |
|
855 | - * @return int |
|
856 | - */ |
|
852 | + /** |
|
853 | + * Converts an interval to its total amount of hours. |
|
854 | + * @param \DateInterval $interval |
|
855 | + * @return int |
|
856 | + */ |
|
857 | 857 | public static function interval2hours(\DateInterval $interval) : int |
858 | 858 | { |
859 | 859 | return self::interval2total($interval, self::INTERVAL_HOURS); |
860 | 860 | } |
861 | 861 | |
862 | - /** |
|
863 | - * Converts an interval to its total amount of minutes. |
|
864 | - * @param \DateInterval $interval |
|
865 | - * @return int |
|
866 | - */ |
|
862 | + /** |
|
863 | + * Converts an interval to its total amount of minutes. |
|
864 | + * @param \DateInterval $interval |
|
865 | + * @return int |
|
866 | + */ |
|
867 | 867 | public static function interval2minutes(\DateInterval $interval) : int |
868 | 868 | { |
869 | 869 | return self::interval2total($interval, self::INTERVAL_MINUTES); |
870 | 870 | } |
871 | 871 | |
872 | - /** |
|
873 | - * Converts an interval to its total amount of seconds. |
|
874 | - * @param \DateInterval $interval |
|
875 | - * @return int |
|
876 | - */ |
|
872 | + /** |
|
873 | + * Converts an interval to its total amount of seconds. |
|
874 | + * @param \DateInterval $interval |
|
875 | + * @return int |
|
876 | + */ |
|
877 | 877 | public static function interval2seconds(\DateInterval $interval) : int |
878 | 878 | { |
879 | 879 | return self::interval2total($interval, self::INTERVAL_SECONDS); |
880 | 880 | } |
881 | 881 | |
882 | - /** |
|
883 | - * Calculates the total amount of days / hours / minutes or seconds |
|
884 | - * of a date interval object (depending in the specified units), and |
|
885 | - * returns the total amount. |
|
886 | - * |
|
887 | - * @param \DateInterval $interval |
|
888 | - * @param string $unit What total value to calculate. |
|
889 | - * @return integer |
|
890 | - * |
|
891 | - * @see ConvertHelper::INTERVAL_SECONDS |
|
892 | - * @see ConvertHelper::INTERVAL_MINUTES |
|
893 | - * @see ConvertHelper::INTERVAL_HOURS |
|
894 | - * @see ConvertHelper::INTERVAL_DAYS |
|
895 | - */ |
|
882 | + /** |
|
883 | + * Calculates the total amount of days / hours / minutes or seconds |
|
884 | + * of a date interval object (depending in the specified units), and |
|
885 | + * returns the total amount. |
|
886 | + * |
|
887 | + * @param \DateInterval $interval |
|
888 | + * @param string $unit What total value to calculate. |
|
889 | + * @return integer |
|
890 | + * |
|
891 | + * @see ConvertHelper::INTERVAL_SECONDS |
|
892 | + * @see ConvertHelper::INTERVAL_MINUTES |
|
893 | + * @see ConvertHelper::INTERVAL_HOURS |
|
894 | + * @see ConvertHelper::INTERVAL_DAYS |
|
895 | + */ |
|
896 | 896 | public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
897 | 897 | { |
898 | 898 | $total = (int)$interval->format('%a'); |
@@ -932,13 +932,13 @@ discard block |
||
932 | 932 | 'Sunday' |
933 | 933 | ); |
934 | 934 | |
935 | - /** |
|
936 | - * Converts a date to the corresponding day name. |
|
937 | - * |
|
938 | - * @param DateTime $date |
|
939 | - * @param bool $short |
|
940 | - * @return string|NULL |
|
941 | - */ |
|
935 | + /** |
|
936 | + * Converts a date to the corresponding day name. |
|
937 | + * |
|
938 | + * @param DateTime $date |
|
939 | + * @param bool $short |
|
940 | + * @return string|NULL |
|
941 | + */ |
|
942 | 942 | public static function date2dayName(DateTime $date, bool $short=false) |
943 | 943 | { |
944 | 944 | $day = $date->format('l'); |
@@ -953,21 +953,21 @@ discard block |
||
953 | 953 | return null; |
954 | 954 | } |
955 | 955 | |
956 | - /** |
|
957 | - * Retrieves a list of english day names. |
|
958 | - * @return string[] |
|
959 | - */ |
|
956 | + /** |
|
957 | + * Retrieves a list of english day names. |
|
958 | + * @return string[] |
|
959 | + */ |
|
960 | 960 | public static function getDayNamesInvariant() |
961 | 961 | { |
962 | 962 | return self::$daysInvariant; |
963 | 963 | } |
964 | 964 | |
965 | - /** |
|
966 | - * Retrieves the day names list for the current locale. |
|
967 | - * |
|
968 | - * @param bool $short |
|
969 | - * @return array |
|
970 | - */ |
|
965 | + /** |
|
966 | + * Retrieves the day names list for the current locale. |
|
967 | + * |
|
968 | + * @param bool $short |
|
969 | + * @return array |
|
970 | + */ |
|
971 | 971 | public static function getDayNames(bool $short=false) : array |
972 | 972 | { |
973 | 973 | if($short) { |
@@ -1014,68 +1014,68 @@ discard block |
||
1014 | 1014 | return ConvertHelper_Array::implodeWithAnd($list, $sep, $conjunction); |
1015 | 1015 | } |
1016 | 1016 | |
1017 | - /** |
|
1018 | - * Splits a string into an array of all characters it is composed of. |
|
1019 | - * Unicode character safe. |
|
1020 | - * |
|
1021 | - * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1022 | - * characters. |
|
1023 | - * |
|
1024 | - * @param string $string |
|
1025 | - * @return string[] |
|
1026 | - */ |
|
1017 | + /** |
|
1018 | + * Splits a string into an array of all characters it is composed of. |
|
1019 | + * Unicode character safe. |
|
1020 | + * |
|
1021 | + * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1022 | + * characters. |
|
1023 | + * |
|
1024 | + * @param string $string |
|
1025 | + * @return string[] |
|
1026 | + */ |
|
1027 | 1027 | public static function string2array(string $string) : array |
1028 | 1028 | { |
1029 | 1029 | return ConvertHelper_String::toArray($string); |
1030 | 1030 | } |
1031 | 1031 | |
1032 | - /** |
|
1033 | - * Checks whether the specified string contains HTML code. |
|
1034 | - * |
|
1035 | - * @param string $string |
|
1036 | - * @return boolean |
|
1037 | - */ |
|
1032 | + /** |
|
1033 | + * Checks whether the specified string contains HTML code. |
|
1034 | + * |
|
1035 | + * @param string $string |
|
1036 | + * @return boolean |
|
1037 | + */ |
|
1038 | 1038 | public static function isStringHTML(string $string) : bool |
1039 | 1039 | { |
1040 | 1040 | return ConvertHelper_String::isHTML($string); |
1041 | 1041 | } |
1042 | 1042 | |
1043 | - /** |
|
1044 | - * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1045 | - * PHP function but compatible with UTF8. Otherwise the lengths |
|
1046 | - * are not calculated correctly. |
|
1047 | - * |
|
1048 | - * @param string $str |
|
1049 | - * @param int $width |
|
1050 | - * @param string $break |
|
1051 | - * @param bool $cut |
|
1052 | - * @return string |
|
1053 | - */ |
|
1043 | + /** |
|
1044 | + * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1045 | + * PHP function but compatible with UTF8. Otherwise the lengths |
|
1046 | + * are not calculated correctly. |
|
1047 | + * |
|
1048 | + * @param string $str |
|
1049 | + * @param int $width |
|
1050 | + * @param string $break |
|
1051 | + * @param bool $cut |
|
1052 | + * @return string |
|
1053 | + */ |
|
1054 | 1054 | public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string |
1055 | 1055 | { |
1056 | 1056 | return ConvertHelper_String::wordwrap($str, $width, $break, $cut); |
1057 | 1057 | } |
1058 | 1058 | |
1059 | - /** |
|
1060 | - * Calculates the byte length of a string, taking into |
|
1061 | - * account any unicode characters. |
|
1062 | - * |
|
1063 | - * @param string $string |
|
1064 | - * @return int |
|
1065 | - */ |
|
1059 | + /** |
|
1060 | + * Calculates the byte length of a string, taking into |
|
1061 | + * account any unicode characters. |
|
1062 | + * |
|
1063 | + * @param string $string |
|
1064 | + * @return int |
|
1065 | + */ |
|
1066 | 1066 | public static function string2bytes(string $string): int |
1067 | 1067 | { |
1068 | 1068 | return ConvertHelper_String::toBytes($string); |
1069 | 1069 | } |
1070 | 1070 | |
1071 | - /** |
|
1072 | - * Creates a short, 8-character long hash for the specified string. |
|
1073 | - * |
|
1074 | - * WARNING: Not cryptographically safe. |
|
1075 | - * |
|
1076 | - * @param string $string |
|
1077 | - * @return string |
|
1078 | - */ |
|
1071 | + /** |
|
1072 | + * Creates a short, 8-character long hash for the specified string. |
|
1073 | + * |
|
1074 | + * WARNING: Not cryptographically safe. |
|
1075 | + * |
|
1076 | + * @param string $string |
|
1077 | + * @return string |
|
1078 | + */ |
|
1079 | 1079 | public static function string2shortHash(string $string) : string |
1080 | 1080 | { |
1081 | 1081 | return ConvertHelper_String::toShortHash($string); |
@@ -1107,88 +1107,88 @@ discard block |
||
1107 | 1107 | return ConvertHelper_ThrowableInfo::fromThrowable($e); |
1108 | 1108 | } |
1109 | 1109 | |
1110 | - /** |
|
1111 | - * Parses the specified query string like the native |
|
1112 | - * function <code>parse_str</code>, without the key |
|
1113 | - * naming limitations. |
|
1114 | - * |
|
1115 | - * Using parse_str, dots or spaces in key names are |
|
1116 | - * replaced by underscores. This method keeps all names |
|
1117 | - * intact. |
|
1118 | - * |
|
1119 | - * It still uses the parse_str implementation as it |
|
1120 | - * is tested and tried, but fixes the parameter names |
|
1121 | - * after parsing, as needed. |
|
1122 | - * |
|
1123 | - * @param string $queryString |
|
1124 | - * @return array |
|
1125 | - * @see ConvertHelper_QueryParser |
|
1126 | - */ |
|
1110 | + /** |
|
1111 | + * Parses the specified query string like the native |
|
1112 | + * function <code>parse_str</code>, without the key |
|
1113 | + * naming limitations. |
|
1114 | + * |
|
1115 | + * Using parse_str, dots or spaces in key names are |
|
1116 | + * replaced by underscores. This method keeps all names |
|
1117 | + * intact. |
|
1118 | + * |
|
1119 | + * It still uses the parse_str implementation as it |
|
1120 | + * is tested and tried, but fixes the parameter names |
|
1121 | + * after parsing, as needed. |
|
1122 | + * |
|
1123 | + * @param string $queryString |
|
1124 | + * @return array |
|
1125 | + * @see ConvertHelper_QueryParser |
|
1126 | + */ |
|
1127 | 1127 | public static function parseQueryString(string $queryString) : array |
1128 | 1128 | { |
1129 | 1129 | $parser = new ConvertHelper_QueryParser(); |
1130 | 1130 | return $parser->parse($queryString); |
1131 | 1131 | } |
1132 | 1132 | |
1133 | - /** |
|
1134 | - * Searches for needle in the specified string, and returns a list |
|
1135 | - * of all occurrences, including the matched string. The matched |
|
1136 | - * string is useful when doing a case insensitive search, as it |
|
1137 | - * shows the exact matched case of needle. |
|
1138 | - * |
|
1139 | - * @param string $needle |
|
1140 | - * @param string $haystack |
|
1141 | - * @param bool $caseInsensitive |
|
1142 | - * @return ConvertHelper_StringMatch[] |
|
1143 | - */ |
|
1133 | + /** |
|
1134 | + * Searches for needle in the specified string, and returns a list |
|
1135 | + * of all occurrences, including the matched string. The matched |
|
1136 | + * string is useful when doing a case insensitive search, as it |
|
1137 | + * shows the exact matched case of needle. |
|
1138 | + * |
|
1139 | + * @param string $needle |
|
1140 | + * @param string $haystack |
|
1141 | + * @param bool $caseInsensitive |
|
1142 | + * @return ConvertHelper_StringMatch[] |
|
1143 | + */ |
|
1144 | 1144 | public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array |
1145 | 1145 | { |
1146 | 1146 | return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive); |
1147 | 1147 | } |
1148 | 1148 | |
1149 | - /** |
|
1150 | - * Like explode, but trims all entries, and removes |
|
1151 | - * empty entries from the resulting array. |
|
1152 | - * |
|
1153 | - * @param string $delimiter |
|
1154 | - * @param string $string |
|
1155 | - * @return string[] |
|
1156 | - */ |
|
1149 | + /** |
|
1150 | + * Like explode, but trims all entries, and removes |
|
1151 | + * empty entries from the resulting array. |
|
1152 | + * |
|
1153 | + * @param string $delimiter |
|
1154 | + * @param string $string |
|
1155 | + * @return string[] |
|
1156 | + */ |
|
1157 | 1157 | public static function explodeTrim(string $delimiter, string $string) : array |
1158 | 1158 | { |
1159 | 1159 | return ConvertHelper_String::explodeTrim($delimiter, $string); |
1160 | 1160 | } |
1161 | 1161 | |
1162 | - /** |
|
1163 | - * Detects the most used end-of-line character in the subject string. |
|
1164 | - * |
|
1165 | - * @param string $subjectString The string to check. |
|
1166 | - * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1167 | - */ |
|
1162 | + /** |
|
1163 | + * Detects the most used end-of-line character in the subject string. |
|
1164 | + * |
|
1165 | + * @param string $subjectString The string to check. |
|
1166 | + * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1167 | + */ |
|
1168 | 1168 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1169 | 1169 | { |
1170 | 1170 | return ConvertHelper_EOL::detect($subjectString); |
1171 | 1171 | } |
1172 | 1172 | |
1173 | - /** |
|
1174 | - * Removes the specified keys from the target array, |
|
1175 | - * if they exist. |
|
1176 | - * |
|
1177 | - * @param array $array |
|
1178 | - * @param array $keys |
|
1179 | - */ |
|
1173 | + /** |
|
1174 | + * Removes the specified keys from the target array, |
|
1175 | + * if they exist. |
|
1176 | + * |
|
1177 | + * @param array $array |
|
1178 | + * @param array $keys |
|
1179 | + */ |
|
1180 | 1180 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1181 | 1181 | { |
1182 | 1182 | ConvertHelper_Array::removeKeys($array, $keys); |
1183 | 1183 | } |
1184 | 1184 | |
1185 | - /** |
|
1186 | - * Checks if the specified variable is an integer or a string containing an integer. |
|
1187 | - * Accepts both positive and negative integers. |
|
1188 | - * |
|
1189 | - * @param mixed $value |
|
1190 | - * @return bool |
|
1191 | - */ |
|
1185 | + /** |
|
1186 | + * Checks if the specified variable is an integer or a string containing an integer. |
|
1187 | + * Accepts both positive and negative integers. |
|
1188 | + * |
|
1189 | + * @param mixed $value |
|
1190 | + * @return bool |
|
1191 | + */ |
|
1192 | 1192 | public static function isInteger($value) : bool |
1193 | 1193 | { |
1194 | 1194 | if(is_int($value)) { |
@@ -1208,52 +1208,52 @@ discard block |
||
1208 | 1208 | return false; |
1209 | 1209 | } |
1210 | 1210 | |
1211 | - /** |
|
1212 | - * Converts an amount of seconds to a DateInterval object. |
|
1213 | - * |
|
1214 | - * @param int $seconds |
|
1215 | - * @return \DateInterval |
|
1216 | - * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1217 | - * |
|
1218 | - * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1219 | - */ |
|
1211 | + /** |
|
1212 | + * Converts an amount of seconds to a DateInterval object. |
|
1213 | + * |
|
1214 | + * @param int $seconds |
|
1215 | + * @return \DateInterval |
|
1216 | + * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1217 | + * |
|
1218 | + * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1219 | + */ |
|
1220 | 1220 | public static function seconds2interval(int $seconds) : \DateInterval |
1221 | 1221 | { |
1222 | 1222 | return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval(); |
1223 | 1223 | } |
1224 | 1224 | |
1225 | - /** |
|
1226 | - * Converts a size string like "50 MB" to the corresponding byte size. |
|
1227 | - * It is case insensitive, ignores spaces, and supports both traditional |
|
1228 | - * "MB" and "MiB" notations. |
|
1229 | - * |
|
1230 | - * @param string $size |
|
1231 | - * @return int |
|
1232 | - */ |
|
1225 | + /** |
|
1226 | + * Converts a size string like "50 MB" to the corresponding byte size. |
|
1227 | + * It is case insensitive, ignores spaces, and supports both traditional |
|
1228 | + * "MB" and "MiB" notations. |
|
1229 | + * |
|
1230 | + * @param string $size |
|
1231 | + * @return int |
|
1232 | + */ |
|
1233 | 1233 | public static function size2bytes(string $size) : int |
1234 | 1234 | { |
1235 | 1235 | return self::parseSize($size)->toBytes(); |
1236 | 1236 | } |
1237 | 1237 | |
1238 | - /** |
|
1239 | - * Parses a size string like "50 MB" and returns a size notation instance |
|
1240 | - * that has utility methods to access information on it, and convert it. |
|
1241 | - * |
|
1242 | - * @param string $size |
|
1243 | - * @return ConvertHelper_SizeNotation |
|
1244 | - */ |
|
1238 | + /** |
|
1239 | + * Parses a size string like "50 MB" and returns a size notation instance |
|
1240 | + * that has utility methods to access information on it, and convert it. |
|
1241 | + * |
|
1242 | + * @param string $size |
|
1243 | + * @return ConvertHelper_SizeNotation |
|
1244 | + */ |
|
1245 | 1245 | public static function parseSize(string $size) : ConvertHelper_SizeNotation |
1246 | 1246 | { |
1247 | 1247 | return new ConvertHelper_SizeNotation($size); |
1248 | 1248 | } |
1249 | 1249 | |
1250 | - /** |
|
1251 | - * Creates a URL finder instance, which can be used to find |
|
1252 | - * URLs in a string - be it plain text, or HTML. |
|
1253 | - * |
|
1254 | - * @param string $subject |
|
1255 | - * @return ConvertHelper_URLFinder |
|
1256 | - */ |
|
1250 | + /** |
|
1251 | + * Creates a URL finder instance, which can be used to find |
|
1252 | + * URLs in a string - be it plain text, or HTML. |
|
1253 | + * |
|
1254 | + * @param string $subject |
|
1255 | + * @return ConvertHelper_URLFinder |
|
1256 | + */ |
|
1257 | 1257 | public static function createURLFinder(string $subject) : ConvertHelper_URLFinder |
1258 | 1258 | { |
1259 | 1259 | return new ConvertHelper_URLFinder($subject); |
@@ -49,7 +49,7 @@ discard block |
||
49 | 49 | * @param int $tabSize The amount of spaces per tab. |
50 | 50 | * @return string |
51 | 51 | */ |
52 | - public static function tabs2spaces(string $string, int $tabSize=4) : string |
|
52 | + public static function tabs2spaces(string $string, int $tabSize = 4) : string |
|
53 | 53 | { |
54 | 54 | return ConvertHelper_String::tabs2spaces($string, $tabSize); |
55 | 55 | } |
@@ -61,7 +61,7 @@ discard block |
||
61 | 61 | * @param int $tabSize The amount of spaces per tab in the source string. |
62 | 62 | * @return string |
63 | 63 | */ |
64 | - public static function spaces2tabs(string $string, int $tabSize=4) : string |
|
64 | + public static function spaces2tabs(string $string, int $tabSize = 4) : string |
|
65 | 65 | { |
66 | 66 | return ConvertHelper_String::spaces2tabs($string, $tabSize); |
67 | 67 | } |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | { |
109 | 109 | $converter = new ConvertHelper_DurationConverter(); |
110 | 110 | |
111 | - if($datefrom instanceof DateTime) |
|
111 | + if ($datefrom instanceof DateTime) |
|
112 | 112 | { |
113 | 113 | $converter->setDateFrom($datefrom); |
114 | 114 | } |
@@ -117,11 +117,11 @@ discard block |
||
117 | 117 | $converter->setDateFrom(self::timestamp2date($datefrom)); |
118 | 118 | } |
119 | 119 | |
120 | - if($dateto instanceof DateTime) |
|
120 | + if ($dateto instanceof DateTime) |
|
121 | 121 | { |
122 | 122 | $converter->setDateTo($dateto); |
123 | 123 | } |
124 | - else if($dateto > 0) |
|
124 | + else if ($dateto > 0) |
|
125 | 125 | { |
126 | 126 | $converter->setDateTo(self::timestamp2date($dateto)); |
127 | 127 | } |
@@ -151,7 +151,7 @@ discard block |
||
151 | 151 | * @deprecated Use the Highlighter class directly instead. |
152 | 152 | * @see Highlighter::xml() |
153 | 153 | */ |
154 | - public static function highlight_xml(string $xml, bool $formatSource=false) : string |
|
154 | + public static function highlight_xml(string $xml, bool $formatSource = false) : string |
|
155 | 155 | { |
156 | 156 | return Highlighter::xml($xml, $formatSource); |
157 | 157 | } |
@@ -210,11 +210,11 @@ discard block |
||
210 | 210 | return ConvertHelper_String::cutText($text, $targetLength, $append); |
211 | 211 | } |
212 | 212 | |
213 | - public static function var_dump($var, $html=true) : string |
|
213 | + public static function var_dump($var, $html = true) : string |
|
214 | 214 | { |
215 | 215 | $info = parseVariable($var); |
216 | 216 | |
217 | - if($html) { |
|
217 | + if ($html) { |
|
218 | 218 | return $info->toHTML(); |
219 | 219 | } |
220 | 220 | |
@@ -229,11 +229,11 @@ discard block |
||
229 | 229 | * @param bool $html Whether to style the dump as HTML. |
230 | 230 | * @return string |
231 | 231 | */ |
232 | - public static function print_r($var, bool $return=false, bool $html=true) : string |
|
232 | + public static function print_r($var, bool $return = false, bool $html = true) : string |
|
233 | 233 | { |
234 | 234 | $result = parseVariable($var)->enableType()->toString(); |
235 | 235 | |
236 | - if($html) |
|
236 | + if ($html) |
|
237 | 237 | { |
238 | 238 | $result = |
239 | 239 | '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'. |
@@ -241,7 +241,7 @@ discard block |
||
241 | 241 | '</pre>'; |
242 | 242 | } |
243 | 243 | |
244 | - if(!$return) |
|
244 | + if (!$return) |
|
245 | 245 | { |
246 | 246 | echo $result; |
247 | 247 | } |
@@ -303,10 +303,10 @@ discard block |
||
303 | 303 | public static function date2listLabel(DateTime $date, $includeTime = false, $shortMonth = false) |
304 | 304 | { |
305 | 305 | $today = new DateTime(); |
306 | - if($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
306 | + if ($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
307 | 307 | $label = t('Today'); |
308 | 308 | } else { |
309 | - $label = $date->format('d') . '. ' . self::month2string((int)$date->format('m'), $shortMonth) . ' '; |
|
309 | + $label = $date->format('d').'. '.self::month2string((int)$date->format('m'), $shortMonth).' '; |
|
310 | 310 | if ($date->format('Y') != date('Y')) { |
311 | 311 | $label .= $date->format('Y'); |
312 | 312 | } |
@@ -461,12 +461,12 @@ discard block |
||
461 | 461 | $output = ''; |
462 | 462 | $split = str_split($unicodeChar); |
463 | 463 | |
464 | - foreach($split as $octet) |
|
464 | + foreach ($split as $octet) |
|
465 | 465 | { |
466 | 466 | $ordInt = ord($octet); |
467 | 467 | // Convert from int (base 10) to hex (base 16), for PHP \x syntax |
468 | 468 | $ordHex = base_convert((string)$ordInt, 10, 16); |
469 | - $output .= '\x' . $ordHex; |
|
469 | + $output .= '\x'.$ordHex; |
|
470 | 470 | } |
471 | 471 | |
472 | 472 | return $output; |
@@ -499,19 +499,19 @@ discard block |
||
499 | 499 | |
500 | 500 | protected static function convertScalarForComparison($scalar) |
501 | 501 | { |
502 | - if($scalar === '' || is_null($scalar)) { |
|
502 | + if ($scalar === '' || is_null($scalar)) { |
|
503 | 503 | return null; |
504 | 504 | } |
505 | 505 | |
506 | - if(is_bool($scalar)) { |
|
506 | + if (is_bool($scalar)) { |
|
507 | 507 | return self::bool2string($scalar); |
508 | 508 | } |
509 | 509 | |
510 | - if(is_array($scalar)) { |
|
510 | + if (is_array($scalar)) { |
|
511 | 511 | $scalar = md5(serialize($scalar)); |
512 | 512 | } |
513 | 513 | |
514 | - if($scalar !== null && !is_scalar($scalar)) { |
|
514 | + if ($scalar !== null && !is_scalar($scalar)) { |
|
515 | 515 | throw new ConvertHelper_Exception( |
516 | 516 | 'Not a scalar value in comparison', |
517 | 517 | null, |
@@ -678,7 +678,7 @@ discard block |
||
678 | 678 | * |
679 | 679 | * @see JSHelper::buildRegexStatement() |
680 | 680 | */ |
681 | - public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
|
681 | + public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) |
|
682 | 682 | { |
683 | 683 | return JSHelper::buildRegexStatement($regex, $statementType); |
684 | 684 | } |
@@ -695,11 +695,11 @@ discard block |
||
695 | 695 | * @throws ConvertHelper_Exception |
696 | 696 | * @return string |
697 | 697 | */ |
698 | - public static function var2json($variable, int $options=0, int $depth=512) : string |
|
698 | + public static function var2json($variable, int $options = 0, int $depth = 512) : string |
|
699 | 699 | { |
700 | 700 | $result = json_encode($variable, $options, $depth); |
701 | 701 | |
702 | - if($result !== false) { |
|
702 | + if ($result !== false) { |
|
703 | 703 | return $result; |
704 | 704 | } |
705 | 705 | |
@@ -724,10 +724,10 @@ discard block |
||
724 | 724 | public static function stripUTFBom($string) |
725 | 725 | { |
726 | 726 | $boms = FileHelper::getUTFBOMs(); |
727 | - foreach($boms as $bomChars) { |
|
727 | + foreach ($boms as $bomChars) { |
|
728 | 728 | $length = mb_strlen($bomChars); |
729 | 729 | $text = mb_substr($string, 0, $length); |
730 | - if($text==$bomChars) { |
|
730 | + if ($text == $bomChars) { |
|
731 | 731 | return mb_substr($string, $length); |
732 | 732 | } |
733 | 733 | } |
@@ -794,7 +794,7 @@ discard block |
||
794 | 794 | * @param array $options |
795 | 795 | * @return float |
796 | 796 | */ |
797 | - public static function matchString($source, $target, $options=array()) |
|
797 | + public static function matchString($source, $target, $options = array()) |
|
798 | 798 | { |
799 | 799 | $defaults = array( |
800 | 800 | 'maxLevenshtein' => 10, |
@@ -804,12 +804,12 @@ discard block |
||
804 | 804 | $options = array_merge($defaults, $options); |
805 | 805 | |
806 | 806 | // avoid doing this via levenshtein |
807 | - if($source == $target) { |
|
807 | + if ($source == $target) { |
|
808 | 808 | return 100; |
809 | 809 | } |
810 | 810 | |
811 | 811 | $diff = levenshtein($source, $target); |
812 | - if($diff > $options['maxLevenshtein']) { |
|
812 | + if ($diff > $options['maxLevenshtein']) { |
|
813 | 813 | return 0; |
814 | 814 | } |
815 | 815 | |
@@ -893,24 +893,24 @@ discard block |
||
893 | 893 | * @see ConvertHelper::INTERVAL_HOURS |
894 | 894 | * @see ConvertHelper::INTERVAL_DAYS |
895 | 895 | */ |
896 | - public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
|
896 | + public static function interval2total(\DateInterval $interval, $unit = self::INTERVAL_SECONDS) : int |
|
897 | 897 | { |
898 | 898 | $total = (int)$interval->format('%a'); |
899 | 899 | if ($unit == self::INTERVAL_DAYS) { |
900 | 900 | return $total; |
901 | 901 | } |
902 | 902 | |
903 | - $total = ($total * 24) + ((int)$interval->h ); |
|
903 | + $total = ($total * 24) + ((int)$interval->h); |
|
904 | 904 | if ($unit == self::INTERVAL_HOURS) { |
905 | 905 | return $total; |
906 | 906 | } |
907 | 907 | |
908 | - $total = ($total * 60) + ((int)$interval->i ); |
|
908 | + $total = ($total * 60) + ((int)$interval->i); |
|
909 | 909 | if ($unit == self::INTERVAL_MINUTES) { |
910 | 910 | return $total; |
911 | 911 | } |
912 | 912 | |
913 | - $total = ($total * 60) + ((int)$interval->s ); |
|
913 | + $total = ($total * 60) + ((int)$interval->s); |
|
914 | 914 | if ($unit == self::INTERVAL_SECONDS) { |
915 | 915 | return $total; |
916 | 916 | } |
@@ -939,13 +939,13 @@ discard block |
||
939 | 939 | * @param bool $short |
940 | 940 | * @return string|NULL |
941 | 941 | */ |
942 | - public static function date2dayName(DateTime $date, bool $short=false) |
|
942 | + public static function date2dayName(DateTime $date, bool $short = false) |
|
943 | 943 | { |
944 | 944 | $day = $date->format('l'); |
945 | 945 | $invariant = self::getDayNamesInvariant(); |
946 | 946 | |
947 | 947 | $idx = array_search($day, $invariant); |
948 | - if($idx !== false) { |
|
948 | + if ($idx !== false) { |
|
949 | 949 | $localized = self::getDayNames($short); |
950 | 950 | return $localized[$idx]; |
951 | 951 | } |
@@ -968,10 +968,10 @@ discard block |
||
968 | 968 | * @param bool $short |
969 | 969 | * @return array |
970 | 970 | */ |
971 | - public static function getDayNames(bool $short=false) : array |
|
971 | + public static function getDayNames(bool $short = false) : array |
|
972 | 972 | { |
973 | - if($short) { |
|
974 | - if(!isset(self::$daysShort)) { |
|
973 | + if ($short) { |
|
974 | + if (!isset(self::$daysShort)) { |
|
975 | 975 | self::$daysShort = array( |
976 | 976 | t('Mon'), |
977 | 977 | t('Tue'), |
@@ -986,7 +986,7 @@ discard block |
||
986 | 986 | return self::$daysShort; |
987 | 987 | } |
988 | 988 | |
989 | - if(!isset(self::$days)) { |
|
989 | + if (!isset(self::$days)) { |
|
990 | 990 | self::$days = array( |
991 | 991 | t('Monday'), |
992 | 992 | t('Tuesday'), |
@@ -1141,7 +1141,7 @@ discard block |
||
1141 | 1141 | * @param bool $caseInsensitive |
1142 | 1142 | * @return ConvertHelper_StringMatch[] |
1143 | 1143 | */ |
1144 | - public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array |
|
1144 | + public static function findString(string $needle, string $haystack, bool $caseInsensitive = false): array |
|
1145 | 1145 | { |
1146 | 1146 | return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive); |
1147 | 1147 | } |
@@ -1191,17 +1191,17 @@ discard block |
||
1191 | 1191 | */ |
1192 | 1192 | public static function isInteger($value) : bool |
1193 | 1193 | { |
1194 | - if(is_int($value)) { |
|
1194 | + if (is_int($value)) { |
|
1195 | 1195 | return true; |
1196 | 1196 | } |
1197 | 1197 | |
1198 | 1198 | // booleans get converted to numbers, so they would |
1199 | 1199 | // actually match the regex. |
1200 | - if(is_bool($value)) { |
|
1200 | + if (is_bool($value)) { |
|
1201 | 1201 | return false; |
1202 | 1202 | } |
1203 | 1203 | |
1204 | - if(is_string($value) && $value !== '') { |
|
1204 | + if (is_string($value) && $value !== '') { |
|
1205 | 1205 | return preg_match('/\A-?\d+\z/', $value) === 1; |
1206 | 1206 | } |
1207 | 1207 | |
@@ -1259,7 +1259,7 @@ discard block |
||
1259 | 1259 | return new ConvertHelper_URLFinder($subject); |
1260 | 1260 | } |
1261 | 1261 | |
1262 | - public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys=false) : array |
|
1262 | + public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys = false) : array |
|
1263 | 1263 | { |
1264 | 1264 | return ConvertHelper_Array::removeValues($sourceArray, $values, $keepKeys); |
1265 | 1265 | } |
@@ -111,8 +111,7 @@ discard block |
||
111 | 111 | if($datefrom instanceof DateTime) |
112 | 112 | { |
113 | 113 | $converter->setDateFrom($datefrom); |
114 | - } |
|
115 | - else |
|
114 | + } else |
|
116 | 115 | { |
117 | 116 | $converter->setDateFrom(self::timestamp2date($datefrom)); |
118 | 117 | } |
@@ -120,8 +119,7 @@ discard block |
||
120 | 119 | if($dateto instanceof DateTime) |
121 | 120 | { |
122 | 121 | $converter->setDateTo($dateto); |
123 | - } |
|
124 | - else if($dateto > 0) |
|
122 | + } else if($dateto > 0) |
|
125 | 123 | { |
126 | 124 | $converter->setDateTo(self::timestamp2date($dateto)); |
127 | 125 | } |