@@ -20,43 +20,43 @@ discard block |
||
20 | 20 | */ |
21 | 21 | class ConvertHelper_TabsNormalizer |
22 | 22 | { |
23 | - /** |
|
24 | - * @var integer |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var integer |
|
25 | + */ |
|
26 | 26 | protected $max = 0; |
27 | 27 | |
28 | - /** |
|
29 | - * @var integer |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var integer |
|
30 | + */ |
|
31 | 31 | protected $min = PHP_INT_MAX; |
32 | 32 | |
33 | - /** |
|
34 | - * @var bool |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var bool |
|
35 | + */ |
|
36 | 36 | protected $tabs2spaces = false; |
37 | 37 | |
38 | - /** |
|
39 | - * @var string[] |
|
40 | - */ |
|
38 | + /** |
|
39 | + * @var string[] |
|
40 | + */ |
|
41 | 41 | protected $lines = array(); |
42 | 42 | |
43 | - /** |
|
44 | - * @var string |
|
45 | - */ |
|
43 | + /** |
|
44 | + * @var string |
|
45 | + */ |
|
46 | 46 | protected $eol = ''; |
47 | 47 | |
48 | - /** |
|
49 | - * @var integer |
|
50 | - */ |
|
48 | + /** |
|
49 | + * @var integer |
|
50 | + */ |
|
51 | 51 | protected $tabSize = 4; |
52 | 52 | |
53 | - /** |
|
54 | - * Whether to enable or disable the conversion |
|
55 | - * of tabs to spaces. |
|
56 | - * |
|
57 | - * @param bool $enable |
|
58 | - * @return ConvertHelper_TabsNormalizer |
|
59 | - */ |
|
53 | + /** |
|
54 | + * Whether to enable or disable the conversion |
|
55 | + * of tabs to spaces. |
|
56 | + * |
|
57 | + * @param bool $enable |
|
58 | + * @return ConvertHelper_TabsNormalizer |
|
59 | + */ |
|
60 | 60 | public function convertTabsToSpaces(bool $enable=true) : ConvertHelper_TabsNormalizer |
61 | 61 | { |
62 | 62 | $this->tabs2spaces = $enable; |
@@ -64,13 +64,13 @@ discard block |
||
64 | 64 | return $this; |
65 | 65 | } |
66 | 66 | |
67 | - /** |
|
68 | - * Sets the size of a tab, in spaces. Used to convert tabs |
|
69 | - * from spaces and the other way around. Defaults to 4. |
|
70 | - * |
|
71 | - * @param int $amountSpaces |
|
72 | - * @return ConvertHelper_TabsNormalizer |
|
73 | - */ |
|
67 | + /** |
|
68 | + * Sets the size of a tab, in spaces. Used to convert tabs |
|
69 | + * from spaces and the other way around. Defaults to 4. |
|
70 | + * |
|
71 | + * @param int $amountSpaces |
|
72 | + * @return ConvertHelper_TabsNormalizer |
|
73 | + */ |
|
74 | 74 | public function setTabSize(int $amountSpaces) : ConvertHelper_TabsNormalizer |
75 | 75 | { |
76 | 76 | $this->tabSize = $amountSpaces; |
@@ -78,15 +78,15 @@ discard block |
||
78 | 78 | return $this; |
79 | 79 | } |
80 | 80 | |
81 | - /** |
|
82 | - * Normalizes tabs in the specified string by indenting everything |
|
83 | - * back to the minimum tab distance. With the second parameter, |
|
84 | - * tabs can optionally be converted to spaces as well (recommended |
|
85 | - * for HTML output). |
|
86 | - * |
|
87 | - * @param string $string |
|
88 | - * @return string |
|
89 | - */ |
|
81 | + /** |
|
82 | + * Normalizes tabs in the specified string by indenting everything |
|
83 | + * back to the minimum tab distance. With the second parameter, |
|
84 | + * tabs can optionally be converted to spaces as well (recommended |
|
85 | + * for HTML output). |
|
86 | + * |
|
87 | + * @param string $string |
|
88 | + * @return string |
|
89 | + */ |
|
90 | 90 | public function normalize(string $string) : string |
91 | 91 | { |
92 | 92 | $this->splitLines($string); |
@@ -143,10 +143,10 @@ discard block |
||
143 | 143 | return implode($this->eol, $converted); |
144 | 144 | } |
145 | 145 | |
146 | - /** |
|
147 | - * Finds out the minimum and maximum amount of |
|
148 | - * tabs in the string. |
|
149 | - */ |
|
146 | + /** |
|
147 | + * Finds out the minimum and maximum amount of |
|
148 | + * tabs in the string. |
|
149 | + */ |
|
150 | 150 | protected function countOccurrences() : void |
151 | 151 | { |
152 | 152 | foreach($this->lines as $line) |
@@ -18,49 +18,49 @@ discard block |
||
18 | 18 | const CONTEXT_COMMAND_LINE = 'cli'; |
19 | 19 | const CONTEXT_WEB = 'web'; |
20 | 20 | |
21 | - /** |
|
22 | - * @var Throwable |
|
23 | - */ |
|
21 | + /** |
|
22 | + * @var Throwable |
|
23 | + */ |
|
24 | 24 | protected $exception; |
25 | 25 | |
26 | - /** |
|
27 | - * @var ConvertHelper_ThrowableInfo_Call[] |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var ConvertHelper_ThrowableInfo_Call[] |
|
28 | + */ |
|
29 | 29 | protected $calls = array(); |
30 | 30 | |
31 | - /** |
|
32 | - * @var integer |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var integer |
|
33 | + */ |
|
34 | 34 | protected $code; |
35 | 35 | |
36 | - /** |
|
37 | - * @var string |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @var string |
|
38 | + */ |
|
39 | 39 | protected $message; |
40 | 40 | |
41 | - /** |
|
42 | - * @var integer |
|
43 | - */ |
|
41 | + /** |
|
42 | + * @var integer |
|
43 | + */ |
|
44 | 44 | protected $callsCount = 0; |
45 | 45 | |
46 | - /** |
|
47 | - * @var ConvertHelper_ThrowableInfo |
|
48 | - */ |
|
46 | + /** |
|
47 | + * @var ConvertHelper_ThrowableInfo |
|
48 | + */ |
|
49 | 49 | protected $previous; |
50 | 50 | |
51 | - /** |
|
52 | - * @var string |
|
53 | - */ |
|
51 | + /** |
|
52 | + * @var string |
|
53 | + */ |
|
54 | 54 | protected $referer = ''; |
55 | 55 | |
56 | - /** |
|
57 | - * @var DateTime |
|
58 | - */ |
|
56 | + /** |
|
57 | + * @var DateTime |
|
58 | + */ |
|
59 | 59 | protected $date; |
60 | 60 | |
61 | - /** |
|
62 | - * @var string |
|
63 | - */ |
|
61 | + /** |
|
62 | + * @var string |
|
63 | + */ |
|
64 | 64 | protected $context = self::CONTEXT_WEB; |
65 | 65 | |
66 | 66 | /** |
@@ -114,16 +114,16 @@ discard block |
||
114 | 114 | return isset($this->previous); |
115 | 115 | } |
116 | 116 | |
117 | - /** |
|
118 | - * Retrieves the information on the previous exception. |
|
119 | - * |
|
120 | - * NOTE: Throws an exception if there is no previous |
|
121 | - * exception. Use hasPrevious() first to avoid this. |
|
122 | - * |
|
123 | - * @throws ConvertHelper_Exception |
|
124 | - * @return ConvertHelper_ThrowableInfo |
|
125 | - * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION |
|
126 | - */ |
|
117 | + /** |
|
118 | + * Retrieves the information on the previous exception. |
|
119 | + * |
|
120 | + * NOTE: Throws an exception if there is no previous |
|
121 | + * exception. Use hasPrevious() first to avoid this. |
|
122 | + * |
|
123 | + * @throws ConvertHelper_Exception |
|
124 | + * @return ConvertHelper_ThrowableInfo |
|
125 | + * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION |
|
126 | + */ |
|
127 | 127 | public function getPrevious() : ConvertHelper_ThrowableInfo |
128 | 128 | { |
129 | 129 | if(isset($this->previous)) { |
@@ -142,9 +142,9 @@ discard block |
||
142 | 142 | return !empty($this->code); |
143 | 143 | } |
144 | 144 | |
145 | - /** |
|
146 | - * Improved textonly exception trace. |
|
147 | - */ |
|
145 | + /** |
|
146 | + * Improved textonly exception trace. |
|
147 | + */ |
|
148 | 148 | public function toString() : string |
149 | 149 | { |
150 | 150 | $calls = $this->getCalls(); |
@@ -172,73 +172,73 @@ discard block |
||
172 | 172 | return $string; |
173 | 173 | } |
174 | 174 | |
175 | - /** |
|
176 | - * Retrieves the URL of the page in which the exception |
|
177 | - * was thrown, if applicable: in CLI context, this will |
|
178 | - * return an empty string. |
|
179 | - * |
|
180 | - * @return string |
|
181 | - */ |
|
175 | + /** |
|
176 | + * Retrieves the URL of the page in which the exception |
|
177 | + * was thrown, if applicable: in CLI context, this will |
|
178 | + * return an empty string. |
|
179 | + * |
|
180 | + * @return string |
|
181 | + */ |
|
182 | 182 | public function getReferer() : string |
183 | 183 | { |
184 | 184 | return $this->referer; |
185 | 185 | } |
186 | 186 | |
187 | - /** |
|
188 | - * Whether the exception occurred in a command line context. |
|
189 | - * @return bool |
|
190 | - */ |
|
187 | + /** |
|
188 | + * Whether the exception occurred in a command line context. |
|
189 | + * @return bool |
|
190 | + */ |
|
191 | 191 | public function isCommandLine() : bool |
192 | 192 | { |
193 | 193 | return $this->getContext() === self::CONTEXT_COMMAND_LINE; |
194 | 194 | } |
195 | 195 | |
196 | - /** |
|
197 | - * Whether the exception occurred during an http request. |
|
198 | - * @return bool |
|
199 | - */ |
|
196 | + /** |
|
197 | + * Whether the exception occurred during an http request. |
|
198 | + * @return bool |
|
199 | + */ |
|
200 | 200 | public function isWebRequest() : bool |
201 | 201 | { |
202 | 202 | return $this->getContext() === self::CONTEXT_WEB; |
203 | 203 | } |
204 | 204 | |
205 | - /** |
|
206 | - * Retrieves the context identifier, i.e. if the exception |
|
207 | - * occurred in a command line context or regular web request. |
|
208 | - * |
|
209 | - * @return string |
|
210 | - * |
|
211 | - * @see ConvertHelper_ThrowableInfo::isCommandLine() |
|
212 | - * @see ConvertHelper_ThrowableInfo::isWebRequest() |
|
213 | - * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE |
|
214 | - * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB |
|
215 | - */ |
|
205 | + /** |
|
206 | + * Retrieves the context identifier, i.e. if the exception |
|
207 | + * occurred in a command line context or regular web request. |
|
208 | + * |
|
209 | + * @return string |
|
210 | + * |
|
211 | + * @see ConvertHelper_ThrowableInfo::isCommandLine() |
|
212 | + * @see ConvertHelper_ThrowableInfo::isWebRequest() |
|
213 | + * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE |
|
214 | + * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB |
|
215 | + */ |
|
216 | 216 | public function getContext() : string |
217 | 217 | { |
218 | 218 | return $this->context; |
219 | 219 | } |
220 | 220 | |
221 | - /** |
|
222 | - * Retrieves the date of the exception, and approximate time: |
|
223 | - * since exceptions do not store time, this is captured the |
|
224 | - * moment the ThrowableInfo is created. |
|
225 | - * |
|
226 | - * @return DateTime |
|
227 | - */ |
|
221 | + /** |
|
222 | + * Retrieves the date of the exception, and approximate time: |
|
223 | + * since exceptions do not store time, this is captured the |
|
224 | + * moment the ThrowableInfo is created. |
|
225 | + * |
|
226 | + * @return DateTime |
|
227 | + */ |
|
228 | 228 | public function getDate() : DateTime |
229 | 229 | { |
230 | 230 | return $this->date; |
231 | 231 | } |
232 | 232 | |
233 | - /** |
|
234 | - * Serializes all information on the exception to an |
|
235 | - * associative array. This can be saved (file, database, |
|
236 | - * session...), and later be restored into a throwable |
|
237 | - * info instance using the fromSerialized() method. |
|
238 | - * |
|
239 | - * @return array<string,mixed> |
|
240 | - * @see ConvertHelper_ThrowableInfo::fromSerialized() |
|
241 | - */ |
|
233 | + /** |
|
234 | + * Serializes all information on the exception to an |
|
235 | + * associative array. This can be saved (file, database, |
|
236 | + * session...), and later be restored into a throwable |
|
237 | + * info instance using the fromSerialized() method. |
|
238 | + * |
|
239 | + * @return array<string,mixed> |
|
240 | + * @see ConvertHelper_ThrowableInfo::fromSerialized() |
|
241 | + */ |
|
242 | 242 | public function serialize() : array |
243 | 243 | { |
244 | 244 | $result = array( |
@@ -265,24 +265,24 @@ discard block |
||
265 | 265 | return $result; |
266 | 266 | } |
267 | 267 | |
268 | - /** |
|
269 | - * Sets the maximum folder depth to show in the |
|
270 | - * file paths, to avoid them being too long. |
|
271 | - * |
|
272 | - * @param int $depth |
|
273 | - * @return ConvertHelper_ThrowableInfo |
|
274 | - */ |
|
268 | + /** |
|
269 | + * Sets the maximum folder depth to show in the |
|
270 | + * file paths, to avoid them being too long. |
|
271 | + * |
|
272 | + * @param int $depth |
|
273 | + * @return ConvertHelper_ThrowableInfo |
|
274 | + */ |
|
275 | 275 | public function setFolderDepth(int $depth) : ConvertHelper_ThrowableInfo |
276 | 276 | { |
277 | 277 | return $this->setOption('folder-depth', $depth); |
278 | 278 | } |
279 | 279 | |
280 | - /** |
|
281 | - * Retrieves the current folder depth option value. |
|
282 | - * |
|
283 | - * @return int |
|
284 | - * @see ConvertHelper_ThrowableInfo::setFolderDepth() |
|
285 | - */ |
|
280 | + /** |
|
281 | + * Retrieves the current folder depth option value. |
|
282 | + * |
|
283 | + * @return int |
|
284 | + * @see ConvertHelper_ThrowableInfo::setFolderDepth() |
|
285 | + */ |
|
286 | 286 | public function getFolderDepth() : int |
287 | 287 | { |
288 | 288 | $depth = $this->getOption('folder-depth'); |
@@ -293,19 +293,19 @@ discard block |
||
293 | 293 | return 2; |
294 | 294 | } |
295 | 295 | |
296 | - /** |
|
297 | - * Retrieves all function calls that led to the error. |
|
298 | - * @return ConvertHelper_ThrowableInfo_Call[] |
|
299 | - */ |
|
296 | + /** |
|
297 | + * Retrieves all function calls that led to the error. |
|
298 | + * @return ConvertHelper_ThrowableInfo_Call[] |
|
299 | + */ |
|
300 | 300 | public function getCalls() |
301 | 301 | { |
302 | 302 | return $this->calls; |
303 | 303 | } |
304 | 304 | |
305 | - /** |
|
306 | - * Returns the amount of function and method calls in the stack trace. |
|
307 | - * @return int |
|
308 | - */ |
|
305 | + /** |
|
306 | + * Returns the amount of function and method calls in the stack trace. |
|
307 | + * @return int |
|
308 | + */ |
|
309 | 309 | public function countCalls() : int |
310 | 310 | { |
311 | 311 | return $this->callsCount; |
@@ -68,7 +68,7 @@ discard block |
||
68 | 68 | */ |
69 | 69 | protected function __construct($subject) |
70 | 70 | { |
71 | - if(is_array($subject)) |
|
71 | + if (is_array($subject)) |
|
72 | 72 | { |
73 | 73 | $this->parseSerialized($subject); |
74 | 74 | } |
@@ -126,7 +126,7 @@ discard block |
||
126 | 126 | */ |
127 | 127 | public function getPrevious() : ConvertHelper_ThrowableInfo |
128 | 128 | { |
129 | - if(isset($this->previous)) { |
|
129 | + if (isset($this->previous)) { |
|
130 | 130 | return $this->previous; |
131 | 131 | } |
132 | 132 | |
@@ -151,18 +151,18 @@ discard block |
||
151 | 151 | |
152 | 152 | $string = 'Exception'; |
153 | 153 | |
154 | - if($this->hasCode()) { |
|
154 | + if ($this->hasCode()) { |
|
155 | 155 | $string .= ' #'.$this->code; |
156 | 156 | } |
157 | 157 | |
158 | 158 | $string .= ': '.$this->getMessage().PHP_EOL; |
159 | 159 | |
160 | - foreach($calls as $call) |
|
160 | + foreach ($calls as $call) |
|
161 | 161 | { |
162 | 162 | $string .= $call->toString().PHP_EOL; |
163 | 163 | } |
164 | 164 | |
165 | - if($this->hasPrevious()) |
|
165 | + if ($this->hasPrevious()) |
|
166 | 166 | { |
167 | 167 | $string .= PHP_EOL.PHP_EOL. |
168 | 168 | 'Previous error:'.PHP_EOL.PHP_EOL. |
@@ -253,11 +253,11 @@ discard block |
||
253 | 253 | 'previous' => null, |
254 | 254 | ); |
255 | 255 | |
256 | - if($this->hasPrevious()) { |
|
257 | - $result['previous'] = $this->previous->serialize(); |
|
256 | + if ($this->hasPrevious()) { |
|
257 | + $result['previous'] = $this->previous->serialize(); |
|
258 | 258 | } |
259 | 259 | |
260 | - foreach($this->calls as $call) |
|
260 | + foreach ($this->calls as $call) |
|
261 | 261 | { |
262 | 262 | $result['calls'][] = $call->serialize(); |
263 | 263 | } |
@@ -286,7 +286,7 @@ discard block |
||
286 | 286 | public function getFolderDepth() : int |
287 | 287 | { |
288 | 288 | $depth = $this->getOption('folder-depth'); |
289 | - if(!empty($depth)) { |
|
289 | + if (!empty($depth)) { |
|
290 | 290 | return $depth; |
291 | 291 | } |
292 | 292 | |
@@ -327,12 +327,12 @@ discard block |
||
327 | 327 | |
328 | 328 | $this->setOptions($serialized['options']); |
329 | 329 | |
330 | - if(!empty($serialized['previous'])) |
|
330 | + if (!empty($serialized['previous'])) |
|
331 | 331 | { |
332 | 332 | $this->previous = ConvertHelper_ThrowableInfo::fromSerialized($serialized['previous']); |
333 | 333 | } |
334 | 334 | |
335 | - foreach($serialized['calls'] as $def) |
|
335 | + foreach ($serialized['calls'] as $def) |
|
336 | 336 | { |
337 | 337 | $this->calls[] = ConvertHelper_ThrowableInfo_Call::fromSerialized($this, $def); |
338 | 338 | } |
@@ -344,16 +344,16 @@ discard block |
||
344 | 344 | $this->message = $e->getMessage(); |
345 | 345 | $this->code = $e->getCode(); |
346 | 346 | |
347 | - if(!isset($_REQUEST['REQUEST_URI'])) { |
|
347 | + if (!isset($_REQUEST['REQUEST_URI'])) { |
|
348 | 348 | $this->context = self::CONTEXT_COMMAND_LINE; |
349 | 349 | } |
350 | 350 | |
351 | 351 | $previous = $e->getPrevious(); |
352 | - if(!empty($previous)) { |
|
352 | + if (!empty($previous)) { |
|
353 | 353 | $this->previous = ConvertHelper::throwable2info($previous); |
354 | 354 | } |
355 | 355 | |
356 | - if(isset($_SERVER['REQUEST_URI'])) { |
|
356 | + if (isset($_SERVER['REQUEST_URI'])) { |
|
357 | 357 | $this->referer = $_SERVER['REQUEST_URI']; |
358 | 358 | } |
359 | 359 | |
@@ -367,7 +367,7 @@ discard block |
||
367 | 367 | |
368 | 368 | $idx = 1; |
369 | 369 | |
370 | - foreach($trace as $entry) |
|
370 | + foreach ($trace as $entry) |
|
371 | 371 | { |
372 | 372 | $this->calls[] = ConvertHelper_ThrowableInfo_Call::fromTrace($this, $idx, $entry); |
373 | 373 |
@@ -71,9 +71,9 @@ discard block |
||
71 | 71 | ) |
72 | 72 | ); |
73 | 73 | |
74 | - /** |
|
75 | - * @var string[] |
|
76 | - */ |
|
74 | + /** |
|
75 | + * @var string[] |
|
76 | + */ |
|
77 | 77 | protected $selected = array(); |
78 | 78 | |
79 | 79 | public function convert(string $string) : string |
@@ -83,16 +83,16 @@ discard block |
||
83 | 83 | return str_replace(array_keys($chars), array_values($chars), $string); |
84 | 84 | } |
85 | 85 | |
86 | - /** |
|
87 | - * Selects a character set to replace. Can be called |
|
88 | - * several times to add additional sets to the collection. |
|
89 | - * |
|
90 | - * @param string $type See the <code>CHAR_XXX</code> constants. |
|
91 | - * @return ConvertHelper_HiddenConverter |
|
92 | - * |
|
93 | - * @see ConvertHelper_HiddenConverter::CHARS_CONTROL |
|
94 | - * @see ConvertHelper_HiddenConverter::CHARS_WHITESPACE |
|
95 | - */ |
|
86 | + /** |
|
87 | + * Selects a character set to replace. Can be called |
|
88 | + * several times to add additional sets to the collection. |
|
89 | + * |
|
90 | + * @param string $type See the <code>CHAR_XXX</code> constants. |
|
91 | + * @return ConvertHelper_HiddenConverter |
|
92 | + * |
|
93 | + * @see ConvertHelper_HiddenConverter::CHARS_CONTROL |
|
94 | + * @see ConvertHelper_HiddenConverter::CHARS_WHITESPACE |
|
95 | + */ |
|
96 | 96 | public function selectCharacters(string $type) : ConvertHelper_HiddenConverter |
97 | 97 | { |
98 | 98 | if(!in_array($type, $this->selected)) { |
@@ -102,11 +102,11 @@ discard block |
||
102 | 102 | return $this; |
103 | 103 | } |
104 | 104 | |
105 | - /** |
|
106 | - * Resolves the list of characters to make visible. |
|
107 | - * |
|
108 | - * @return string[] |
|
109 | - */ |
|
105 | + /** |
|
106 | + * Resolves the list of characters to make visible. |
|
107 | + * |
|
108 | + * @return string[] |
|
109 | + */ |
|
110 | 110 | protected function resolveSelection() : array |
111 | 111 | { |
112 | 112 | $selected = $this->selected; |
@@ -30,17 +30,17 @@ discard block |
||
30 | 30 | const BASE_10 = 1000; |
31 | 31 | const BASE_2 = 1024; |
32 | 32 | |
33 | - /** |
|
34 | - * @var array<string,ConvertHelper_StorageSizeEnum_Size> |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var array<string,ConvertHelper_StorageSizeEnum_Size> |
|
35 | + */ |
|
36 | 36 | protected static $sizes = array(); |
37 | 37 | |
38 | - /** |
|
39 | - * Initializes the supported unit notations, and |
|
40 | - * how they are supposed to be calculated. |
|
41 | - * |
|
42 | - * @see ConvertHelper_SizeNotation::parseSize() |
|
43 | - */ |
|
38 | + /** |
|
39 | + * Initializes the supported unit notations, and |
|
40 | + * how they are supposed to be calculated. |
|
41 | + * |
|
42 | + * @see ConvertHelper_SizeNotation::parseSize() |
|
43 | + */ |
|
44 | 44 | protected static function init() : void |
45 | 45 | { |
46 | 46 | if(!empty(self::$sizes)) { |
@@ -67,28 +67,28 @@ discard block |
||
67 | 67 | } |
68 | 68 | } |
69 | 69 | |
70 | - /** |
|
71 | - * Called whenever the application locale is changed, |
|
72 | - * to reset the size definitions so the labels get |
|
73 | - * translated to the new locale. |
|
74 | - */ |
|
70 | + /** |
|
71 | + * Called whenever the application locale is changed, |
|
72 | + * to reset the size definitions so the labels get |
|
73 | + * translated to the new locale. |
|
74 | + */ |
|
75 | 75 | public static function handle_localeChanged() : void |
76 | 76 | { |
77 | 77 | self::$sizes = array(); |
78 | 78 | } |
79 | 79 | |
80 | - /** |
|
81 | - * Adds a storage size to the internal collection. |
|
82 | - * |
|
83 | - * @param string $name The lowercase size name, e.g. "kb", "mib" |
|
84 | - * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details. |
|
85 | - * @param int $exponent The multiplier of the base to get the byte value |
|
86 | - * @param string $suffix The localized short suffix, e.g. "KB", "MiB" |
|
87 | - * @param string $singular The localized singular label of the size, e.g. "Kilobyte". |
|
88 | - * @param string $plural The localized plural label of the size, e.g. "Kilobytes". |
|
89 | - * |
|
90 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
91 | - */ |
|
80 | + /** |
|
81 | + * Adds a storage size to the internal collection. |
|
82 | + * |
|
83 | + * @param string $name The lowercase size name, e.g. "kb", "mib" |
|
84 | + * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details. |
|
85 | + * @param int $exponent The multiplier of the base to get the byte value |
|
86 | + * @param string $suffix The localized short suffix, e.g. "KB", "MiB" |
|
87 | + * @param string $singular The localized singular label of the size, e.g. "Kilobyte". |
|
88 | + * @param string $plural The localized plural label of the size, e.g. "Kilobytes". |
|
89 | + * |
|
90 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
91 | + */ |
|
92 | 92 | protected static function addSize(string $name, int $base, int $exponent, string $suffix, string $singular, string $plural) : void |
93 | 93 | { |
94 | 94 | self::$sizes[$name] = new ConvertHelper_StorageSizeEnum_Size( |
@@ -101,11 +101,11 @@ discard block |
||
101 | 101 | ); |
102 | 102 | } |
103 | 103 | |
104 | - /** |
|
105 | - * Retrieves all known sizes. |
|
106 | - * |
|
107 | - * @return ConvertHelper_StorageSizeEnum_Size[] |
|
108 | - */ |
|
104 | + /** |
|
105 | + * Retrieves all known sizes. |
|
106 | + * |
|
107 | + * @return ConvertHelper_StorageSizeEnum_Size[] |
|
108 | + */ |
|
109 | 109 | public static function getSizes() : array |
110 | 110 | { |
111 | 111 | self::init(); |
@@ -113,15 +113,15 @@ discard block |
||
113 | 113 | return array_values(self::$sizes); |
114 | 114 | } |
115 | 115 | |
116 | - /** |
|
117 | - * Retrieves a size definition instance by its name. |
|
118 | - * |
|
119 | - * @param string $name Case-insensitive. For example "kb", "MiB"... |
|
120 | - * @throws ConvertHelper_Exception |
|
121 | - * @return ConvertHelper_StorageSizeEnum_Size |
|
122 | - * |
|
123 | - * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME |
|
124 | - */ |
|
116 | + /** |
|
117 | + * Retrieves a size definition instance by its name. |
|
118 | + * |
|
119 | + * @param string $name Case-insensitive. For example "kb", "MiB"... |
|
120 | + * @throws ConvertHelper_Exception |
|
121 | + * @return ConvertHelper_StorageSizeEnum_Size |
|
122 | + * |
|
123 | + * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME |
|
124 | + */ |
|
125 | 125 | public static function getSizeByName(string $name) : ConvertHelper_StorageSizeEnum_Size |
126 | 126 | { |
127 | 127 | self::init(); |
@@ -143,10 +143,10 @@ discard block |
||
143 | 143 | ); |
144 | 144 | } |
145 | 145 | |
146 | - /** |
|
147 | - * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase). |
|
148 | - * @return string[] |
|
149 | - */ |
|
146 | + /** |
|
147 | + * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase). |
|
148 | + * @return string[] |
|
149 | + */ |
|
150 | 150 | public static function getSizeNames() : array |
151 | 151 | { |
152 | 152 | self::init(); |
@@ -154,16 +154,16 @@ discard block |
||
154 | 154 | return array_keys(self::$sizes); |
155 | 155 | } |
156 | 156 | |
157 | - /** |
|
158 | - * Retrieves all available storage sizes for the specified |
|
159 | - * base value. |
|
160 | - * |
|
161 | - * @param int $base |
|
162 | - * @return ConvertHelper_StorageSizeEnum_Size[] |
|
163 | - * |
|
164 | - * @see ConvertHelper_StorageSizeEnum::BASE_10 |
|
165 | - * @see ConvertHelper_StorageSizeEnum::BASE_2 |
|
166 | - */ |
|
157 | + /** |
|
158 | + * Retrieves all available storage sizes for the specified |
|
159 | + * base value. |
|
160 | + * |
|
161 | + * @param int $base |
|
162 | + * @return ConvertHelper_StorageSizeEnum_Size[] |
|
163 | + * |
|
164 | + * @see ConvertHelper_StorageSizeEnum::BASE_10 |
|
165 | + * @see ConvertHelper_StorageSizeEnum::BASE_2 |
|
166 | + */ |
|
167 | 167 | public static function getSizesByBase(int $base) : array |
168 | 168 | { |
169 | 169 | self::init(); |
@@ -17,21 +17,20 @@ discard block |
||
17 | 17 | * @package Application Utils |
18 | 18 | * @subpackage ConvertHelper |
19 | 19 | * @author Sebastian Mordziol <[email protected]> |
20 | - |
|
21 | 20 | * @see ConvertHelper::interval2string() |
22 | 21 | */ |
23 | 22 | class ConvertHelper_IntervalConverter |
24 | 23 | { |
25 | 24 | const ERROR_MISSING_TRANSLATION = 43501; |
26 | 25 | |
27 | - /** |
|
28 | - * @var array<string,string>|NULL |
|
29 | - */ |
|
26 | + /** |
|
27 | + * @var array<string,string>|NULL |
|
28 | + */ |
|
30 | 29 | protected static $texts = null; |
31 | 30 | |
32 | - /** |
|
33 | - * @var string[] |
|
34 | - */ |
|
31 | + /** |
|
32 | + * @var string[] |
|
33 | + */ |
|
35 | 34 | protected $tokens = array('y', 'm', 'd', 'h', 'i', 's'); |
36 | 35 | |
37 | 36 | public function __construct() |
@@ -41,25 +40,25 @@ discard block |
||
41 | 40 | } |
42 | 41 | } |
43 | 42 | |
44 | - /** |
|
45 | - * Called whenever the application locale has changed, |
|
46 | - * to reset the internal translation cache. |
|
47 | - */ |
|
43 | + /** |
|
44 | + * Called whenever the application locale has changed, |
|
45 | + * to reset the internal translation cache. |
|
46 | + */ |
|
48 | 47 | public function handle_localeChanged() : void |
49 | 48 | { |
50 | 49 | self::$texts = null; |
51 | 50 | } |
52 | 51 | |
53 | - /** |
|
54 | - * Converts the specified interval to a human-readable |
|
55 | - * string, e.g. "2 hours and 4 minutes". |
|
56 | - * |
|
57 | - * @param \DateInterval $interval |
|
58 | - * @return string |
|
59 | - * @throws ConvertHelper_Exception |
|
60 | - * |
|
61 | - * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION |
|
62 | - */ |
|
52 | + /** |
|
53 | + * Converts the specified interval to a human-readable |
|
54 | + * string, e.g. "2 hours and 4 minutes". |
|
55 | + * |
|
56 | + * @param \DateInterval $interval |
|
57 | + * @return string |
|
58 | + * @throws ConvertHelper_Exception |
|
59 | + * |
|
60 | + * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION |
|
61 | + */ |
|
63 | 62 | public function toString(\DateInterval $interval) : string |
64 | 63 | { |
65 | 64 | $this->initTexts(); |
@@ -88,14 +87,14 @@ discard block |
||
88 | 87 | return t('%1$s and %2$s', implode(', ', $parts), $last); |
89 | 88 | } |
90 | 89 | |
91 | - /** |
|
92 | - * Translates the selected time token, e.g. "y" (for year). |
|
93 | - * |
|
94 | - * @param string $token |
|
95 | - * @param ConvertHelper_DateInterval $interval |
|
96 | - * @throws ConvertHelper_Exception |
|
97 | - * @return string |
|
98 | - */ |
|
90 | + /** |
|
91 | + * Translates the selected time token, e.g. "y" (for year). |
|
92 | + * |
|
93 | + * @param string $token |
|
94 | + * @param ConvertHelper_DateInterval $interval |
|
95 | + * @throws ConvertHelper_Exception |
|
96 | + * @return string |
|
97 | + */ |
|
99 | 98 | protected function translateToken(string $token, ConvertHelper_DateInterval $interval) : string |
100 | 99 | { |
101 | 100 | $value = $interval->getToken($token); |
@@ -123,13 +122,13 @@ discard block |
||
123 | 122 | ); |
124 | 123 | } |
125 | 124 | |
126 | - /** |
|
127 | - * Resolves all time tokens that need to be translated in |
|
128 | - * the subject interval, depending on its length. |
|
129 | - * |
|
130 | - * @param ConvertHelper_DateInterval $interval |
|
131 | - * @return string[] |
|
132 | - */ |
|
125 | + /** |
|
126 | + * Resolves all time tokens that need to be translated in |
|
127 | + * the subject interval, depending on its length. |
|
128 | + * |
|
129 | + * @param ConvertHelper_DateInterval $interval |
|
130 | + * @return string[] |
|
131 | + */ |
|
133 | 132 | protected function resolveTokens(ConvertHelper_DateInterval $interval) : array |
134 | 133 | { |
135 | 134 | $offset = 0; |
@@ -147,9 +146,9 @@ discard block |
||
147 | 146 | return array(); |
148 | 147 | } |
149 | 148 | |
150 | - /** |
|
151 | - * Initializes the translateable strings. |
|
152 | - */ |
|
149 | + /** |
|
150 | + * Initializes the translateable strings. |
|
151 | + */ |
|
153 | 152 | protected function initTexts() : void |
154 | 153 | { |
155 | 154 | if(isset(self::$texts)) { |
@@ -34,39 +34,39 @@ discard block |
||
34 | 34 | const SECONDS_PER_MONTH_APPROX = 2505600; // imprecise - for 29 days, only for approximations. |
35 | 35 | const SECONDS_PER_YEAR = 31536000; |
36 | 36 | |
37 | - /** |
|
38 | - * @var int |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var int |
|
39 | + */ |
|
40 | 40 | protected $dateFrom; |
41 | 41 | |
42 | - /** |
|
43 | - * @var int |
|
44 | - */ |
|
42 | + /** |
|
43 | + * @var int |
|
44 | + */ |
|
45 | 45 | protected $dateTo; |
46 | 46 | |
47 | - /** |
|
48 | - * @var bool |
|
49 | - */ |
|
47 | + /** |
|
48 | + * @var bool |
|
49 | + */ |
|
50 | 50 | protected $future = false; |
51 | 51 | |
52 | - /** |
|
53 | - * @var string |
|
54 | - */ |
|
52 | + /** |
|
53 | + * @var string |
|
54 | + */ |
|
55 | 55 | protected $interval = ''; |
56 | 56 | |
57 | - /** |
|
58 | - * @var int |
|
59 | - */ |
|
57 | + /** |
|
58 | + * @var int |
|
59 | + */ |
|
60 | 60 | protected $difference = 0; |
61 | 61 | |
62 | - /** |
|
63 | - * @var int |
|
64 | - */ |
|
62 | + /** |
|
63 | + * @var int |
|
64 | + */ |
|
65 | 65 | protected $dateDiff = 0; |
66 | 66 | |
67 | - /** |
|
68 | - * @var array<string,array<string,string>>|NULL |
|
69 | - */ |
|
67 | + /** |
|
68 | + * @var array<string,array<string,string>>|NULL |
|
69 | + */ |
|
70 | 70 | protected static $texts = null; |
71 | 71 | |
72 | 72 | public function __construct() |
@@ -86,17 +86,17 @@ discard block |
||
86 | 86 | self::$texts = null; |
87 | 87 | } |
88 | 88 | |
89 | - /** |
|
90 | - * Sets the origin date to calculate from. |
|
91 | - * |
|
92 | - * NOTE: if this is further in the future than |
|
93 | - * the to: date, it will be considered as a |
|
94 | - * calculation for something to come, i.e. |
|
95 | - * "In two days". |
|
96 | - * |
|
97 | - * @param DateTime $date |
|
98 | - * @return ConvertHelper_DurationConverter |
|
99 | - */ |
|
89 | + /** |
|
90 | + * Sets the origin date to calculate from. |
|
91 | + * |
|
92 | + * NOTE: if this is further in the future than |
|
93 | + * the to: date, it will be considered as a |
|
94 | + * calculation for something to come, i.e. |
|
95 | + * "In two days". |
|
96 | + * |
|
97 | + * @param DateTime $date |
|
98 | + * @return ConvertHelper_DurationConverter |
|
99 | + */ |
|
100 | 100 | public function setDateFrom(DateTime $date) : ConvertHelper_DurationConverter |
101 | 101 | { |
102 | 102 | $this->dateFrom = ConvertHelper::date2timestamp($date); |
@@ -104,13 +104,13 @@ discard block |
||
104 | 104 | return $this; |
105 | 105 | } |
106 | 106 | |
107 | - /** |
|
108 | - * Sets the date to calculate to. Defaults to |
|
109 | - * the current time if not set. |
|
110 | - * |
|
111 | - * @param DateTime $date |
|
112 | - * @return ConvertHelper_DurationConverter |
|
113 | - */ |
|
107 | + /** |
|
108 | + * Sets the date to calculate to. Defaults to |
|
109 | + * the current time if not set. |
|
110 | + * |
|
111 | + * @param DateTime $date |
|
112 | + * @return ConvertHelper_DurationConverter |
|
113 | + */ |
|
114 | 114 | public function setDateTo(DateTime $date) : ConvertHelper_DurationConverter |
115 | 115 | { |
116 | 116 | $this->dateTo = ConvertHelper::date2timestamp($date); |
@@ -118,14 +118,14 @@ discard block |
||
118 | 118 | return $this; |
119 | 119 | } |
120 | 120 | |
121 | - /** |
|
122 | - * Converts the specified dates to a human-readable string. |
|
123 | - * |
|
124 | - * @throws ConvertHelper_Exception |
|
125 | - * @return string |
|
126 | - * |
|
127 | - * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
128 | - */ |
|
121 | + /** |
|
122 | + * Converts the specified dates to a human-readable string. |
|
123 | + * |
|
124 | + * @throws ConvertHelper_Exception |
|
125 | + * @return string |
|
126 | + * |
|
127 | + * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
128 | + */ |
|
129 | 129 | public function convert() : string |
130 | 130 | { |
131 | 131 | $this->initTexts(); |
@@ -71,7 +71,7 @@ discard block |
||
71 | 71 | |
72 | 72 | public function __construct() |
73 | 73 | { |
74 | - if(class_exists('\AppLocalize\Localization')) { |
|
74 | + if (class_exists('\AppLocalize\Localization')) { |
|
75 | 75 | \AppLocalize\Localization::onLocaleChanged(array($this, 'handle_localeChanged')); |
76 | 76 | } |
77 | 77 | } |
@@ -133,11 +133,11 @@ discard block |
||
133 | 133 | |
134 | 134 | $epoch = 'past'; |
135 | 135 | $key = 'singular'; |
136 | - if($this->dateDiff > 1) { |
|
136 | + if ($this->dateDiff > 1) { |
|
137 | 137 | $key = 'plural'; |
138 | 138 | } |
139 | 139 | |
140 | - if($this->future) { |
|
140 | + if ($this->future) { |
|
141 | 141 | $epoch = 'future'; |
142 | 142 | } |
143 | 143 | |
@@ -150,7 +150,7 @@ discard block |
||
150 | 150 | |
151 | 151 | protected function initTexts() : void |
152 | 152 | { |
153 | - if(isset(self::$texts)) { |
|
153 | + if (isset(self::$texts)) { |
|
154 | 154 | return; |
155 | 155 | } |
156 | 156 | |
@@ -236,7 +236,7 @@ discard block |
||
236 | 236 | $day = (int)date("j", $this->dateTo); |
237 | 237 | $year = (int)date("Y", $this->dateFrom); |
238 | 238 | |
239 | - while(mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $this->dateTo) |
|
239 | + while (mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $this->dateTo) |
|
240 | 240 | { |
241 | 241 | $months_difference++; |
242 | 242 | } |
@@ -256,7 +256,7 @@ discard block |
||
256 | 256 | |
257 | 257 | protected function resolveCalculations() : void |
258 | 258 | { |
259 | - if(!isset($this->dateFrom)) |
|
259 | + if (!isset($this->dateFrom)) |
|
260 | 260 | { |
261 | 261 | throw new ConvertHelper_Exception( |
262 | 262 | 'No date from has been specified.', |
@@ -266,7 +266,7 @@ discard block |
||
266 | 266 | } |
267 | 267 | |
268 | 268 | // no date to set? Assume we want to use today. |
269 | - if(!isset($this->dateTo)) |
|
269 | + if (!isset($this->dateTo)) |
|
270 | 270 | { |
271 | 271 | $this->dateTo = time(); |
272 | 272 | } |
@@ -333,7 +333,7 @@ discard block |
||
333 | 333 | |
334 | 334 | $difference = $this->dateTo - $this->dateFrom; |
335 | 335 | |
336 | - if($difference < 0) |
|
336 | + if ($difference < 0) |
|
337 | 337 | { |
338 | 338 | $difference = $difference * -1; |
339 | 339 | $this->future = true; |
@@ -395,7 +395,7 @@ discard block |
||
395 | 395 | { |
396 | 396 | $converter = new ConvertHelper_DurationConverter(); |
397 | 397 | |
398 | - if($datefrom instanceof DateTime) |
|
398 | + if ($datefrom instanceof DateTime) |
|
399 | 399 | { |
400 | 400 | $converter->setDateFrom($datefrom); |
401 | 401 | } |
@@ -404,11 +404,11 @@ discard block |
||
404 | 404 | $converter->setDateFrom(ConvertHelper_Date::fromTimestamp($datefrom)); |
405 | 405 | } |
406 | 406 | |
407 | - if($dateto instanceof DateTime) |
|
407 | + if ($dateto instanceof DateTime) |
|
408 | 408 | { |
409 | 409 | $converter->setDateTo($dateto); |
410 | 410 | } |
411 | - else if($dateto > 0) |
|
411 | + else if ($dateto > 0) |
|
412 | 412 | { |
413 | 413 | $converter->setDateTo(ConvertHelper_Date::fromTimestamp($dateto)); |
414 | 414 | } |
@@ -10,45 +10,45 @@ discard block |
||
10 | 10 | const TYPE_METHOD_CALL = 'method'; |
11 | 11 | const TYPE_SCRIPT_START = 'start'; |
12 | 12 | |
13 | - /** |
|
14 | - * @var ConvertHelper_ThrowableInfo |
|
15 | - */ |
|
13 | + /** |
|
14 | + * @var ConvertHelper_ThrowableInfo |
|
15 | + */ |
|
16 | 16 | protected $info; |
17 | 17 | |
18 | - /** |
|
19 | - * @var VariableInfo[] |
|
20 | - */ |
|
18 | + /** |
|
19 | + * @var VariableInfo[] |
|
20 | + */ |
|
21 | 21 | protected $args = array(); |
22 | 22 | |
23 | - /** |
|
24 | - * The source file, if any |
|
25 | - * @var string |
|
26 | - */ |
|
23 | + /** |
|
24 | + * The source file, if any |
|
25 | + * @var string |
|
26 | + */ |
|
27 | 27 | protected $file = ''; |
28 | 28 | |
29 | - /** |
|
30 | - * @var string |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var string |
|
31 | + */ |
|
32 | 32 | protected $class = ''; |
33 | 33 | |
34 | - /** |
|
35 | - * @var integer |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var integer |
|
36 | + */ |
|
37 | 37 | protected $line = 0; |
38 | 38 | |
39 | - /** |
|
40 | - * @var int |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var int |
|
41 | + */ |
|
42 | 42 | protected $position = 1; |
43 | 43 | |
44 | - /** |
|
45 | - * @var string |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var string |
|
46 | + */ |
|
47 | 47 | protected $function = ''; |
48 | 48 | |
49 | - /** |
|
50 | - * @var string |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var string |
|
51 | + */ |
|
52 | 52 | protected $type = self::TYPE_SCRIPT_START; |
53 | 53 | |
54 | 54 | /** |
@@ -79,10 +79,10 @@ discard block |
||
79 | 79 | } |
80 | 80 | } |
81 | 81 | |
82 | - /** |
|
83 | - * 1-based position of the call in the calls list. |
|
84 | - * @return int |
|
85 | - */ |
|
82 | + /** |
|
83 | + * 1-based position of the call in the calls list. |
|
84 | + * @return int |
|
85 | + */ |
|
86 | 86 | public function getPosition() : int |
87 | 87 | { |
88 | 88 | return $this->position; |
@@ -93,18 +93,18 @@ discard block |
||
93 | 93 | return $this->line; |
94 | 94 | } |
95 | 95 | |
96 | - /** |
|
97 | - * Whether the call had any arguments. |
|
98 | - * @return bool |
|
99 | - */ |
|
96 | + /** |
|
97 | + * Whether the call had any arguments. |
|
98 | + * @return bool |
|
99 | + */ |
|
100 | 100 | public function hasArguments() : bool |
101 | 101 | { |
102 | 102 | return !empty($this->args); |
103 | 103 | } |
104 | 104 | |
105 | - /** |
|
106 | - * @return VariableInfo[] |
|
107 | - */ |
|
105 | + /** |
|
106 | + * @return VariableInfo[] |
|
107 | + */ |
|
108 | 108 | public function getArguments() |
109 | 109 | { |
110 | 110 | return $this->args; |
@@ -244,31 +244,31 @@ discard block |
||
244 | 244 | return implode(', ', $tokens); |
245 | 245 | } |
246 | 246 | |
247 | - /** |
|
248 | - * Retrieves the type of call: typically a function |
|
249 | - * call, or a method call of an object. Note that the |
|
250 | - * first call in a script does not have either. |
|
251 | - * |
|
252 | - * @return string |
|
253 | - * |
|
254 | - * @see ConvertHelper_ThrowableInfo_Call::TYPE_FUNCTION_CALL |
|
255 | - * @see ConvertHelper_ThrowableInfo_Call::TYPE_METHOD_CALL |
|
256 | - * @see ConvertHelper_ThrowableInfo_Call::TYPE_SCRIPT_START |
|
257 | - * @see ConvertHelper_ThrowableInfo_Call::hasFunction() |
|
258 | - * @see ConvertHelper_ThrowableInfo_Call::hasClass() |
|
259 | - */ |
|
247 | + /** |
|
248 | + * Retrieves the type of call: typically a function |
|
249 | + * call, or a method call of an object. Note that the |
|
250 | + * first call in a script does not have either. |
|
251 | + * |
|
252 | + * @return string |
|
253 | + * |
|
254 | + * @see ConvertHelper_ThrowableInfo_Call::TYPE_FUNCTION_CALL |
|
255 | + * @see ConvertHelper_ThrowableInfo_Call::TYPE_METHOD_CALL |
|
256 | + * @see ConvertHelper_ThrowableInfo_Call::TYPE_SCRIPT_START |
|
257 | + * @see ConvertHelper_ThrowableInfo_Call::hasFunction() |
|
258 | + * @see ConvertHelper_ThrowableInfo_Call::hasClass() |
|
259 | + */ |
|
260 | 260 | public function getType() : string |
261 | 261 | { |
262 | 262 | return $this->type; |
263 | 263 | } |
264 | 264 | |
265 | - /** |
|
266 | - * Serializes the call to an array, with all |
|
267 | - * necessary information. Can be used to restore |
|
268 | - * the call later using {@link ConvertHelper_ThrowableInfo_Call::fromSerialized()}. |
|
269 | - * |
|
270 | - * @return array<string,mixed> |
|
271 | - */ |
|
265 | + /** |
|
266 | + * Serializes the call to an array, with all |
|
267 | + * necessary information. Can be used to restore |
|
268 | + * the call later using {@link ConvertHelper_ThrowableInfo_Call::fromSerialized()}. |
|
269 | + * |
|
270 | + * @return array<string,mixed> |
|
271 | + */ |
|
272 | 272 | public function serialize() : array |
273 | 273 | { |
274 | 274 | $result = array( |
@@ -59,7 +59,7 @@ discard block |
||
59 | 59 | { |
60 | 60 | $this->info = $info; |
61 | 61 | |
62 | - if(isset($data['serialized'])) |
|
62 | + if (isset($data['serialized'])) |
|
63 | 63 | { |
64 | 64 | $this->parseSerialized($data['serialized']); |
65 | 65 | } |
@@ -69,11 +69,11 @@ discard block |
||
69 | 69 | $this->position = $data['position']; |
70 | 70 | } |
71 | 71 | |
72 | - if($this->hasClass()) |
|
72 | + if ($this->hasClass()) |
|
73 | 73 | { |
74 | 74 | $this->type = self::TYPE_METHOD_CALL; |
75 | 75 | } |
76 | - else if($this->hasFunction()) |
|
76 | + else if ($this->hasFunction()) |
|
77 | 77 | { |
78 | 78 | $this->type = self::TYPE_FUNCTION_CALL; |
79 | 79 | } |
@@ -132,7 +132,7 @@ discard block |
||
132 | 132 | |
133 | 133 | public function getFileName() : string |
134 | 134 | { |
135 | - if($this->hasFile()) { |
|
135 | + if ($this->hasFile()) { |
|
136 | 136 | return basename($this->file); |
137 | 137 | } |
138 | 138 | |
@@ -141,7 +141,7 @@ discard block |
||
141 | 141 | |
142 | 142 | public function getFileRelative() : string |
143 | 143 | { |
144 | - if($this->hasFile()) { |
|
144 | + if ($this->hasFile()) { |
|
145 | 145 | return FileHelper::relativizePathByDepth($this->file, $this->info->getFolderDepth()); |
146 | 146 | } |
147 | 147 | |
@@ -171,7 +171,7 @@ discard block |
||
171 | 171 | $this->class = $data['class']; |
172 | 172 | $this->position = $data['position']; |
173 | 173 | |
174 | - foreach($data['arguments'] as $arg) |
|
174 | + foreach ($data['arguments'] as $arg) |
|
175 | 175 | { |
176 | 176 | $this->args[] = VariableInfo::fromSerialized($arg); |
177 | 177 | } |
@@ -182,29 +182,29 @@ discard block |
||
182 | 182 | */ |
183 | 183 | protected function parseTrace(array $trace) : void |
184 | 184 | { |
185 | - if(isset($trace['line'])) |
|
185 | + if (isset($trace['line'])) |
|
186 | 186 | { |
187 | 187 | $this->line = intval($trace['line']); |
188 | 188 | } |
189 | 189 | |
190 | - if(isset($trace['function'])) |
|
190 | + if (isset($trace['function'])) |
|
191 | 191 | { |
192 | 192 | $this->function = $trace['function']; |
193 | 193 | } |
194 | 194 | |
195 | - if(isset($trace['file'])) |
|
195 | + if (isset($trace['file'])) |
|
196 | 196 | { |
197 | 197 | $this->file = FileHelper::normalizePath($trace['file']); |
198 | 198 | } |
199 | 199 | |
200 | - if(isset($trace['class'])) |
|
200 | + if (isset($trace['class'])) |
|
201 | 201 | { |
202 | 202 | $this->class = $trace['class']; |
203 | 203 | } |
204 | 204 | |
205 | - if(isset($trace['args']) && !empty($trace['args'])) |
|
205 | + if (isset($trace['args']) && !empty($trace['args'])) |
|
206 | 206 | { |
207 | - foreach($trace['args'] as $arg) |
|
207 | + foreach ($trace['args'] as $arg) |
|
208 | 208 | { |
209 | 209 | $this->args[] = parseVariable($arg); |
210 | 210 | } |
@@ -219,13 +219,13 @@ discard block |
||
219 | 219 | |
220 | 220 | $tokens[] = '#'.sprintf('%0'.$padLength.'d', $this->getPosition()).' '; |
221 | 221 | |
222 | - if($this->hasFile()) { |
|
222 | + if ($this->hasFile()) { |
|
223 | 223 | $tokens[] = $this->getFileRelative().':'.$this->getLine(); |
224 | 224 | } |
225 | 225 | |
226 | - if($this->hasClass()) { |
|
226 | + if ($this->hasClass()) { |
|
227 | 227 | $tokens[] = $this->getClass().'::'.$this->getFunction().'('.$this->argumentsToString().')'; |
228 | - } else if($this->hasFunction()) { |
|
228 | + } else if ($this->hasFunction()) { |
|
229 | 229 | $tokens[] = $this->getFunction().'('.$this->argumentsToString().')'; |
230 | 230 | } |
231 | 231 | |
@@ -236,7 +236,7 @@ discard block |
||
236 | 236 | { |
237 | 237 | $tokens = array(); |
238 | 238 | |
239 | - foreach($this->args as $arg) |
|
239 | + foreach ($this->args as $arg) |
|
240 | 240 | { |
241 | 241 | $tokens[] = $arg->toString(); |
242 | 242 | } |
@@ -281,7 +281,7 @@ discard block |
||
281 | 281 | 'arguments' => array() |
282 | 282 | ); |
283 | 283 | |
284 | - foreach($this->args as $argument) |
|
284 | + foreach ($this->args as $argument) |
|
285 | 285 | { |
286 | 286 | $result['arguments'][] = $argument->serialize(); |
287 | 287 | } |
@@ -27,16 +27,16 @@ |
||
27 | 27 | |
28 | 28 | } |
29 | 29 | |
30 | - /** |
|
31 | - * We parse the query string ourselves, because the PHP implementation |
|
32 | - * of parse_str has limitations that do not apply to query strings. This |
|
33 | - * is due to the fact that parse_str has to create PHP-compatible variable |
|
34 | - * names from the parameters. URL parameters simply allow way more things |
|
35 | - * than PHP variable names. |
|
36 | - * |
|
37 | - * @param string $queryString |
|
38 | - * @return array<string,string> |
|
39 | - */ |
|
30 | + /** |
|
31 | + * We parse the query string ourselves, because the PHP implementation |
|
32 | + * of parse_str has limitations that do not apply to query strings. This |
|
33 | + * is due to the fact that parse_str has to create PHP-compatible variable |
|
34 | + * names from the parameters. URL parameters simply allow way more things |
|
35 | + * than PHP variable names. |
|
36 | + * |
|
37 | + * @param string $queryString |
|
38 | + * @return array<string,string> |
|
39 | + */ |
|
40 | 40 | public function parse(string $queryString) : array |
41 | 41 | { |
42 | 42 | // allow HTML entities notation |
@@ -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<int|string,mixed> |
|
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<int|string,mixed> |
|
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<int|string,mixed> |
|
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<int|string,mixed> |
|
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<int,array<string,string>> |
|
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<int,array<string,string>> |
|
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 sub-folders in the specified path. |
|
1159 | - * |
|
1160 | - * Available options: |
|
1161 | - * |
|
1162 | - * - recursive: true/false |
|
1163 | - * Whether to search for sub-folders 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<string,mixed> $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 sub-folders in the specified path. |
|
1159 | + * |
|
1160 | + * Available options: |
|
1161 | + * |
|
1162 | + * - recursive: true/false |
|
1163 | + * Whether to search for sub-folders 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<string,mixed> $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, array $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. |
@@ -1579,16 +1579,16 @@ discard block |
||
1579 | 1579 | return $result; |
1580 | 1580 | } |
1581 | 1581 | |
1582 | - /** |
|
1583 | - * Reads all content from a file. |
|
1584 | - * |
|
1585 | - * @param string $filePath |
|
1586 | - * @throws FileHelper_Exception |
|
1587 | - * @return string |
|
1588 | - * |
|
1589 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1590 | - * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
1591 | - */ |
|
1582 | + /** |
|
1583 | + * Reads all content from a file. |
|
1584 | + * |
|
1585 | + * @param string $filePath |
|
1586 | + * @throws FileHelper_Exception |
|
1587 | + * @return string |
|
1588 | + * |
|
1589 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1590 | + * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
1591 | + */ |
|
1592 | 1592 | public static function readContents(string $filePath) : string |
1593 | 1593 | { |
1594 | 1594 | self::requireFileExists($filePath); |
@@ -1609,18 +1609,18 @@ discard block |
||
1609 | 1609 | ); |
1610 | 1610 | } |
1611 | 1611 | |
1612 | - /** |
|
1613 | - * Ensures that the target path exists on disk, and is a folder. |
|
1614 | - * |
|
1615 | - * @param string $path |
|
1616 | - * @return string The real path, with normalized slashes. |
|
1617 | - * @throws FileHelper_Exception |
|
1618 | - * |
|
1619 | - * @see FileHelper::normalizePath() |
|
1620 | - * |
|
1621 | - * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST |
|
1622 | - * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER |
|
1623 | - */ |
|
1612 | + /** |
|
1613 | + * Ensures that the target path exists on disk, and is a folder. |
|
1614 | + * |
|
1615 | + * @param string $path |
|
1616 | + * @return string The real path, with normalized slashes. |
|
1617 | + * @throws FileHelper_Exception |
|
1618 | + * |
|
1619 | + * @see FileHelper::normalizePath() |
|
1620 | + * |
|
1621 | + * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST |
|
1622 | + * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER |
|
1623 | + */ |
|
1624 | 1624 | public static function requireFolderExists(string $path) : string |
1625 | 1625 | { |
1626 | 1626 | $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, ?string $fileName = null, bool $asAttachment=true) : void |
|
426 | + public static function sendFile(string $filePath, ?string $fileName = null, bool $asAttachment = true) : void |
|
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, array $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 | /** |
@@ -1527,13 +1527,13 @@ discard block |
||
1527 | 1527 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
1528 | 1528 | * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
1529 | 1529 | */ |
1530 | - public static function readLines(string $filePath, int $amount=0) : array |
|
1530 | + public static function readLines(string $filePath, int $amount = 0) : array |
|
1531 | 1531 | { |
1532 | 1532 | self::requireFileExists($filePath); |
1533 | 1533 | |
1534 | 1534 | $fn = fopen($filePath, "r"); |
1535 | 1535 | |
1536 | - if($fn === false) |
|
1536 | + if ($fn === false) |
|
1537 | 1537 | { |
1538 | 1538 | throw new FileHelper_Exception( |
1539 | 1539 | 'Could not open file for reading.', |
@@ -1549,19 +1549,19 @@ discard block |
||
1549 | 1549 | $counter = 0; |
1550 | 1550 | $first = true; |
1551 | 1551 | |
1552 | - while(!feof($fn)) |
|
1552 | + while (!feof($fn)) |
|
1553 | 1553 | { |
1554 | 1554 | $counter++; |
1555 | 1555 | |
1556 | 1556 | $line = fgets($fn); |
1557 | 1557 | |
1558 | 1558 | // can happen with zero length files |
1559 | - if($line === false) { |
|
1559 | + if ($line === false) { |
|
1560 | 1560 | continue; |
1561 | 1561 | } |
1562 | 1562 | |
1563 | 1563 | // the first line may contain a unicode BOM marker. |
1564 | - if($first) |
|
1564 | + if ($first) |
|
1565 | 1565 | { |
1566 | 1566 | $line = ConvertHelper::stripUTFBom($line); |
1567 | 1567 | $first = false; |
@@ -1569,7 +1569,7 @@ discard block |
||
1569 | 1569 | |
1570 | 1570 | $result[] = $line; |
1571 | 1571 | |
1572 | - if($amount > 0 && $counter == $amount) { |
|
1572 | + if ($amount > 0 && $counter == $amount) { |
|
1573 | 1573 | break; |
1574 | 1574 | } |
1575 | 1575 | } |
@@ -1595,7 +1595,7 @@ discard block |
||
1595 | 1595 | |
1596 | 1596 | $result = file_get_contents($filePath); |
1597 | 1597 | |
1598 | - if($result !== false) { |
|
1598 | + if ($result !== false) { |
|
1599 | 1599 | return $result; |
1600 | 1600 | } |
1601 | 1601 | |
@@ -1625,7 +1625,7 @@ discard block |
||
1625 | 1625 | { |
1626 | 1626 | $actual = realpath($path); |
1627 | 1627 | |
1628 | - if($actual === false) |
|
1628 | + if ($actual === false) |
|
1629 | 1629 | { |
1630 | 1630 | throw new FileHelper_Exception( |
1631 | 1631 | 'Folder does not exist', |
@@ -1637,7 +1637,7 @@ discard block |
||
1637 | 1637 | ); |
1638 | 1638 | } |
1639 | 1639 | |
1640 | - if(is_dir($path)) |
|
1640 | + if (is_dir($path)) |
|
1641 | 1641 | { |
1642 | 1642 | return self::normalizePath($actual); |
1643 | 1643 | } |
@@ -1659,7 +1659,7 @@ discard block |
||
1659 | 1659 | * @param string[] $paths |
1660 | 1660 | * @return FileHelper_PathsReducer |
1661 | 1661 | */ |
1662 | - public static function createPathsReducer(array $paths=array()) : FileHelper_PathsReducer |
|
1662 | + public static function createPathsReducer(array $paths = array()) : FileHelper_PathsReducer |
|
1663 | 1663 | { |
1664 | 1664 | return new FileHelper_PathsReducer(); |
1665 | 1665 | } |