Passed
Push — master ( 1f0193...943848 )
by Sebastian
03:12
created
src/StringBuilder.php 2 patches
Indentation   +147 added lines, -147 removed lines patch added patch discarded remove patch
@@ -33,24 +33,24 @@  discard block
 block discarded – undo
33 33
  */
34 34
 class StringBuilder implements StringBuilder_Interface
35 35
 {
36
-   /**
37
-    * @var string
38
-    */
36
+    /**
37
+     * @var string
38
+     */
39 39
     protected $separator = ' ';
40 40
 
41
-   /**
42
-    * @var string[]
43
-    */
41
+    /**
42
+     * @var string[]
43
+     */
44 44
     protected $strings = array();
45 45
 
46
-   /**
47
-    * @var string
48
-    */
46
+    /**
47
+     * @var string
48
+     */
49 49
     protected $mode = 'html';
50 50
 
51
-   /**
52
-    * @var string
53
-    */
51
+    /**
52
+     * @var string
53
+     */
54 54
     protected $noSpace = '§!§';
55 55
     
56 56
     public function __construct()
@@ -58,12 +58,12 @@  discard block
 block discarded – undo
58 58
         
59 59
     }
60 60
     
61
-   /**
62
-    * Adds a subject as a string. Is ignored if empty.
63
-    * 
64
-    * @param string|number|StringBuilder_Interface $string
65
-    * @return $this
66
-    */
61
+    /**
62
+     * Adds a subject as a string. Is ignored if empty.
63
+     * 
64
+     * @param string|number|StringBuilder_Interface $string
65
+     * @return $this
66
+     */
67 67
     public function add($string) : StringBuilder
68 68
     {
69 69
         $string = strval($string);
@@ -76,57 +76,57 @@  discard block
 block discarded – undo
76 76
         return $this;
77 77
     }
78 78
     
79
-   /**
80
-    * Adds a string without appending an automatic space.
81
-    * 
82
-    * @param string|number|StringBuilder_Interface $string
83
-    * @return $this
84
-    */
79
+    /**
80
+     * Adds a string without appending an automatic space.
81
+     * 
82
+     * @param string|number|StringBuilder_Interface $string
83
+     * @return $this
84
+     */
85 85
     public function nospace($string) : StringBuilder
86 86
     {
87 87
         return $this->add($this->noSpace.strval($string));
88 88
     }
89 89
     
90
-   /**
91
-    * Adds raw HTML code. Does not add an automatic space.
92
-    * 
93
-    * @param string|number|StringBuilder_Interface $html
94
-    * @return $this
95
-    */
90
+    /**
91
+     * Adds raw HTML code. Does not add an automatic space.
92
+     * 
93
+     * @param string|number|StringBuilder_Interface $html
94
+     * @return $this
95
+     */
96 96
     public function html($html) : StringBuilder
97 97
     {
98 98
         return $this->nospace($html);
99 99
     }
100 100
     
101
-   /**
102
-    * Adds an unordered list with the specified items.
103
-    * 
104
-    * @param array<int,string|number|StringBuilder_Interface> $items
105
-    * @return $this
106
-    */
101
+    /**
102
+     * Adds an unordered list with the specified items.
103
+     * 
104
+     * @param array<int,string|number|StringBuilder_Interface> $items
105
+     * @return $this
106
+     */
107 107
     public function ul(array $items) : StringBuilder
108 108
     {
109 109
         return $this->list('ul', $items);
110 110
     }
111 111
     
112
-   /**
113
-    * Adds an ordered list with the specified items.
114
-    * 
115
-    * @param array<int,string|number|StringBuilder_Interface> $items
116
-    * @return $this
117
-    */
112
+    /**
113
+     * Adds an ordered list with the specified items.
114
+     * 
115
+     * @param array<int,string|number|StringBuilder_Interface> $items
116
+     * @return $this
117
+     */
118 118
     public function ol(array $items) : StringBuilder
119 119
     {
120 120
         return $this->list('ol', $items);
121 121
     }
122 122
     
123
-   /**
124
-    * Creates a list tag with the items list.
125
-    * 
126
-    * @param string $type The list type, `ol` or `ul`.
127
-    * @param array<int,string|number|StringBuilder_Interface> $items
128
-    * @return $this
129
-    */
123
+    /**
124
+     * Creates a list tag with the items list.
125
+     * 
126
+     * @param string $type The list type, `ol` or `ul`.
127
+     * @param array<int,string|number|StringBuilder_Interface> $items
128
+     * @return $this
129
+     */
130 130
     protected function list(string $type, array $items) : StringBuilder
131 131
     {
132 132
         return $this->html(sprintf(
@@ -136,13 +136,13 @@  discard block
 block discarded – undo
136 136
         ));
137 137
     }
138 138
     
139
-   /**
140
-    * Add a translated string.
141
-    * 
142
-    * @param string $format The native string to translate.
143
-    * @param array<int,mixed> $arguments The variables to inject into the translated string, if any.
144
-    * @return $this
145
-    */
139
+    /**
140
+     * Add a translated string.
141
+     * 
142
+     * @param string $format The native string to translate.
143
+     * @param array<int,mixed> $arguments The variables to inject into the translated string, if any.
144
+     * @return $this
145
+     */
146 146
     public function t(string $format, ...$arguments) : StringBuilder
147 147
     {
148 148
         array_unshift($arguments, $format);
@@ -158,47 +158,47 @@  discard block
 block discarded – undo
158 158
         ));
159 159
     }
160 160
     
161
-   /**
162
-    * Adds a "5 months ago" age since the specified date.
163
-    * 
164
-    * @param DateTime $since
165
-    * @return $this
166
-    */
161
+    /**
162
+     * Adds a "5 months ago" age since the specified date.
163
+     * 
164
+     * @param DateTime $since
165
+     * @return $this
166
+     */
167 167
     public function age(DateTime $since) : StringBuilder
168 168
     {
169 169
         return $this->add(ConvertHelper::duration2string($since));
170 170
     }
171 171
     
172
-   /**
173
-    * Adds HTML quotes around the string.
174
-    * 
175
-    * @param string|number|StringBuilder_Interface $string
176
-    * @return $this
177
-    */
172
+    /**
173
+     * Adds HTML quotes around the string.
174
+     * 
175
+     * @param string|number|StringBuilder_Interface $string
176
+     * @return $this
177
+     */
178 178
     public function quote($string)
179 179
     {
180 180
         return $this->sf('&quot;%s&quot;', strval($string));
181 181
     }
182 182
     
183
-   /**
184
-    * Adds a text that is meant as a reference to an UI element,
185
-    * like a menu item, button, etc.
186
-    * 
187
-    * @param string|number|StringBuilder_Interface $string 
188
-    * @return $this
189
-    */
183
+    /**
184
+     * Adds a text that is meant as a reference to an UI element,
185
+     * like a menu item, button, etc.
186
+     * 
187
+     * @param string|number|StringBuilder_Interface $string 
188
+     * @return $this
189
+     */
190 190
     public function reference($string) : StringBuilder
191 191
     {
192 192
         return $this->sf('"%s"', $string);
193 193
     }
194 194
 
195
-   /**
196
-    * Add a string using the `sprintf` method.
197
-    * 
198
-    * @param string $format The format string
199
-    * @param string|number|StringBuilder_Interface ...$arguments The variables to inject
200
-    * @return $this
201
-    */
195
+    /**
196
+     * Add a string using the `sprintf` method.
197
+     * 
198
+     * @param string $format The format string
199
+     * @param string|number|StringBuilder_Interface ...$arguments The variables to inject
200
+     * @return $this
201
+     */
202 202
     public function sf(string $format, ...$arguments) : StringBuilder
203 203
     {
204 204
         array_unshift($arguments, $format);
@@ -206,12 +206,12 @@  discard block
 block discarded – undo
206 206
         return $this->add(call_user_func_array('sprintf', $arguments));
207 207
     }
208 208
     
209
-   /**
210
-    * Adds a bold string.
211
-    * 
212
-    * @param string|number|StringBuilder_Interface $string
213
-    * @return $this
214
-    */
209
+    /**
210
+     * Adds a bold string.
211
+     * 
212
+     * @param string|number|StringBuilder_Interface $string
213
+     * @return $this
214
+     */
215 215
     public function bold($string) : StringBuilder
216 216
     {
217 217
         return $this->sf(
@@ -220,12 +220,12 @@  discard block
 block discarded – undo
220 220
         );
221 221
     }
222 222
     
223
-   /**
224
-    * Adds a HTML `br` tag.
225
-    * 
226
-    * @return $this
227
-    * @see StringBuilder::eol()
228
-    */
223
+    /**
224
+     * Adds a HTML `br` tag.
225
+     * 
226
+     * @return $this
227
+     * @see StringBuilder::eol()
228
+     */
229 229
     public function nl() : StringBuilder
230 230
     {
231 231
         return $this->html('<br>');
@@ -242,52 +242,52 @@  discard block
 block discarded – undo
242 242
         return $this->nospace(PHP_EOL);
243 243
     }
244 244
     
245
-   /**
246
-    * Adds the current time, in the format <code>H:i:s</code>.
247
-    * 
248
-    * @return $this
249
-    */
245
+    /**
246
+     * Adds the current time, in the format <code>H:i:s</code>.
247
+     * 
248
+     * @return $this
249
+     */
250 250
     public function time() : StringBuilder
251 251
     {
252 252
         return $this->add(date('H:i:s'));
253 253
     }
254 254
     
255
-   /**
256
-    * Adds the "Note:" text.
257
-    * 
258
-    * @return $this
259
-    */
255
+    /**
256
+     * Adds the "Note:" text.
257
+     * 
258
+     * @return $this
259
+     */
260 260
     public function note() : StringBuilder
261 261
     {
262 262
         return $this->t('Note:');
263 263
     }
264 264
     
265
-   /**
266
-    * Like `note()`, but as bold text.
267
-    * 
268
-    * @return $this
269
-    */
265
+    /**
266
+     * Like `note()`, but as bold text.
267
+     * 
268
+     * @return $this
269
+     */
270 270
     public function noteBold() : StringBuilder
271 271
     {
272 272
         return $this->bold(sb()->note());
273 273
     }
274 274
     
275
-   /**
276
-    * Adds the "Hint:" text.
277
-    * 
278
-    * @return $this
279
-    */
275
+    /**
276
+     * Adds the "Hint:" text.
277
+     * 
278
+     * @return $this
279
+     */
280 280
     public function hint() : StringBuilder
281 281
     {
282 282
         return $this->t('Hint:');
283 283
     }
284 284
     
285
-   /**
286
-    * Adds two linebreaks.
287
-    *
288
-    * @param StringBuilder_Interface|string|NULL $content
289
-    * @return $this
290
-    */
285
+    /**
286
+     * Adds two linebreaks.
287
+     *
288
+     * @param StringBuilder_Interface|string|NULL $content
289
+     * @return $this
290
+     */
291 291
     public function para($content=null) : StringBuilder
292 292
     {
293 293
         if($content !== null) {
@@ -297,14 +297,14 @@  discard block
 block discarded – undo
297 297
         return $this->nl()->nl();
298 298
     }
299 299
     
300
-   /**
301
-    * Adds an anchor HTML tag.
302
-    * 
303
-    * @param string $label
304
-    * @param string $url
305
-    * @param bool $newTab
306
-    * @return $this
307
-    */
300
+    /**
301
+     * Adds an anchor HTML tag.
302
+     * 
303
+     * @param string $label
304
+     * @param string $url
305
+     * @param bool $newTab
306
+     * @return $this
307
+     */
308 308
     public function link(string $label, string $url, bool $newTab=false) : StringBuilder
309 309
     {
310 310
         $target = '';
@@ -320,12 +320,12 @@  discard block
 block discarded – undo
320 320
         );
321 321
     }
322 322
     
323
-   /**
324
-    * Wraps the string in a `code` tag.
325
-    * 
326
-    * @param string|number|StringBuilder_Interface $string
327
-    * @return $this
328
-    */
323
+    /**
324
+     * Wraps the string in a `code` tag.
325
+     * 
326
+     * @param string|number|StringBuilder_Interface $string
327
+     * @return $this
328
+     */
329 329
     public function code($string) : StringBuilder
330 330
     {
331 331
         return $this->sf(
@@ -334,24 +334,24 @@  discard block
 block discarded – undo
334 334
         );
335 335
     }
336 336
     
337
-   /**
338
-    * Wraps the string in a `pre` tag.
339
-    * 
340
-    * @param string|number|StringBuilder_Interface $string
341
-    * @return $this
342
-    */
337
+    /**
338
+     * Wraps the string in a `pre` tag.
339
+     * 
340
+     * @param string|number|StringBuilder_Interface $string
341
+     * @return $this
342
+     */
343 343
     public function pre($string) : StringBuilder
344 344
     {
345 345
         return $this->sf('<pre>%s</pre>', strval($string));
346 346
     }
347 347
     
348
-   /**
349
-    * Wraps the text in a `span` tag with the specified classes.
350
-    * 
351
-    * @param string|number|StringBuilder_Interface $string
352
-    * @param string|string[] $classes
353
-    * @return $this
354
-    */
348
+    /**
349
+     * Wraps the text in a `span` tag with the specified classes.
350
+     * 
351
+     * @param string|number|StringBuilder_Interface $string
352
+     * @param string|string[] $classes
353
+     * @return $this
354
+     */
355 355
     protected function spanned($string, $classes) : StringBuilder
356 356
     {
357 357
         if(!is_array($classes)) 
Please login to merge, or discard this patch.
Spacing   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -68,7 +68,7 @@  discard block
 block discarded – undo
68 68
     {
69 69
         $string = strval($string);
70 70
         
71
-        if(!empty($string)) 
71
+        if (!empty($string)) 
72 72
         {
73 73
             $this->strings[] = $string;
74 74
         }
@@ -147,7 +147,7 @@  discard block
 block discarded – undo
147 147
     {
148 148
         array_unshift($arguments, $format);
149 149
         
150
-        if(!class_exists('\AppLocalize\Localization'))
150
+        if (!class_exists('\AppLocalize\Localization'))
151 151
         {
152 152
             return $this->sf(...$arguments);
153 153
         }
@@ -288,9 +288,9 @@  discard block
 block discarded – undo
288 288
     * @param StringBuilder_Interface|string|NULL $content
289 289
     * @return $this
290 290
     */
291
-    public function para($content=null) : StringBuilder
291
+    public function para($content = null) : StringBuilder
292 292
     {
293
-        if($content !== null) {
293
+        if ($content !== null) {
294 294
             return $this->html('<p>')->nospace($content)->html('</p>');
295 295
         }
296 296
 
@@ -305,10 +305,10 @@  discard block
 block discarded – undo
305 305
     * @param bool $newTab
306 306
     * @return $this
307 307
     */
308
-    public function link(string $label, string $url, bool $newTab=false) : StringBuilder
308
+    public function link(string $label, string $url, bool $newTab = false) : StringBuilder
309 309
     {
310 310
         $target = '';
311
-        if($newTab) {
311
+        if ($newTab) {
312 312
             $target = ' target="_blank"';
313 313
         }
314 314
        
@@ -354,7 +354,7 @@  discard block
 block discarded – undo
354 354
     */
355 355
     protected function spanned($string, $classes) : StringBuilder
356 356
     {
357
-        if(!is_array($classes)) 
357
+        if (!is_array($classes)) 
358 358
         {
359 359
             $classes = array(strval($classes));
360 360
         }
Please login to merge, or discard this patch.
src/FileHelper/FileFinder.php 1 patch
Indentation   +137 added lines, -137 removed lines patch added patch discarded remove patch
@@ -33,24 +33,24 @@  discard block
 block discarded – undo
33 33
     
34 34
     const PATH_MODE_STRIP = 'strip';
35 35
     
36
-   /**
37
-    * @var string
38
-    */
36
+    /**
37
+     * @var string
38
+     */
39 39
     protected $path;
40 40
     
41
-   /**
42
-    * @var array
43
-    */
41
+    /**
42
+     * @var array
43
+     */
44 44
     protected $found;
45 45
     
46
-   /**
47
-    * The path must exist when the class is instantiated: its
48
-    * real path will be determined to work with.
49
-    * 
50
-    * @param string $path The absolute path to the target folder.
51
-    * @throws FileHelper_Exception
52
-    * @see FileHelper_FileFinder::ERROR_PATH_DOES_NOT_EXIST
53
-    */
46
+    /**
47
+     * The path must exist when the class is instantiated: its
48
+     * real path will be determined to work with.
49
+     * 
50
+     * @param string $path The absolute path to the target folder.
51
+     * @throws FileHelper_Exception
52
+     * @see FileHelper_FileFinder::ERROR_PATH_DOES_NOT_EXIST
53
+     */
54 54
     public function __construct(string $path)
55 55
     {
56 56
         $real = realpath($path);
@@ -82,66 +82,66 @@  discard block
 block discarded – undo
82 82
         );
83 83
     }
84 84
     
85
-   /**
86
-    * Enables extension stripping, to return file names without extension.
87
-    * 
88
-    * @return FileHelper_FileFinder
89
-    */
85
+    /**
86
+     * Enables extension stripping, to return file names without extension.
87
+     * 
88
+     * @return FileHelper_FileFinder
89
+     */
90 90
     public function stripExtensions() : FileHelper_FileFinder
91 91
     {
92 92
         return $this->setOption('strip-extensions', true);
93 93
     }
94 94
     
95
-   /**
96
-    * Enables recursing into subfolders.
97
-    * 
98
-    * @return FileHelper_FileFinder
99
-    */
95
+    /**
96
+     * Enables recursing into subfolders.
97
+     * 
98
+     * @return FileHelper_FileFinder
99
+     */
100 100
     public function makeRecursive() : FileHelper_FileFinder
101 101
     {
102 102
         return $this->setOption('recursive', true);
103 103
     }
104 104
     
105
-   /**
106
-    * Retrieves all extensions that were added to
107
-    * the include list.
108
-    * 
109
-    * @return string[]
110
-    */
105
+    /**
106
+     * Retrieves all extensions that were added to
107
+     * the include list.
108
+     * 
109
+     * @return string[]
110
+     */
111 111
     public function getIncludeExtensions() : array
112 112
     {
113 113
         return $this->getArrayOption('include-extensions');
114 114
     }
115 115
     
116
-   /**
117
-    * Includes a single extension in the file search: only
118
-    * files with this extension will be used in the results.
119
-    * 
120
-    * NOTE: Included extensions take precedence before excluded
121
-    * extensions. If any excluded extensions are specified, they
122
-    * will be ignored.
123
-    * 
124
-    * @param string $extension Extension name, without dot (`php` for example).
125
-    * @return FileHelper_FileFinder
126
-    * @see FileHelper_FileFinder::includeExtensions()
127
-    */
116
+    /**
117
+     * Includes a single extension in the file search: only
118
+     * files with this extension will be used in the results.
119
+     * 
120
+     * NOTE: Included extensions take precedence before excluded
121
+     * extensions. If any excluded extensions are specified, they
122
+     * will be ignored.
123
+     * 
124
+     * @param string $extension Extension name, without dot (`php` for example).
125
+     * @return FileHelper_FileFinder
126
+     * @see FileHelper_FileFinder::includeExtensions()
127
+     */
128 128
     public function includeExtension(string $extension) : FileHelper_FileFinder
129 129
     {
130 130
         return $this->includeExtensions(array($extension));
131 131
     }
132 132
     
133
-   /**
134
-    * Includes several extensions in the file search: only
135
-    * files with these extensions wil be used in the results.
136
-    * 
137
-    * NOTE: Included extensions take precedence before excluded
138
-    * extensions. If any excluded extensions are specified, they
139
-    * will be ignored.
140
-    * 
141
-    * @param array $extensions Extension names, without dot (`php` for example).
142
-    * @return FileHelper_FileFinder
143
-    * @see FileHelper_FileFinder::includeExtension()
144
-    */
133
+    /**
134
+     * Includes several extensions in the file search: only
135
+     * files with these extensions wil be used in the results.
136
+     * 
137
+     * NOTE: Included extensions take precedence before excluded
138
+     * extensions. If any excluded extensions are specified, they
139
+     * will be ignored.
140
+     * 
141
+     * @param array $extensions Extension names, without dot (`php` for example).
142
+     * @return FileHelper_FileFinder
143
+     * @see FileHelper_FileFinder::includeExtension()
144
+     */
145 145
     public function includeExtensions(array $extensions) : FileHelper_FileFinder
146 146
     {
147 147
         $items = $this->getIncludeExtensions();
@@ -152,37 +152,37 @@  discard block
 block discarded – undo
152 152
         return $this;
153 153
     }
154 154
 
155
-   /**
156
-    * Retrieves a list of all extensions currently set as 
157
-    * excluded from the search.
158
-    * 
159
-    * @return string[]
160
-    */
155
+    /**
156
+     * Retrieves a list of all extensions currently set as 
157
+     * excluded from the search.
158
+     * 
159
+     * @return string[]
160
+     */
161 161
     public function getExcludeExtensions() : array
162 162
     {
163 163
         return $this->getArrayOption('exclude-extensions');
164 164
     }
165 165
     
166
-   /**
167
-    * Excludes a single extension from the search.
168
-    * 
169
-    * @param string $extension Extension name, without dot (`php` for example).
170
-    * @return FileHelper_FileFinder
171
-    * @see FileHelper_FileFinder::excludeExtensions()
172
-    */
166
+    /**
167
+     * Excludes a single extension from the search.
168
+     * 
169
+     * @param string $extension Extension name, without dot (`php` for example).
170
+     * @return FileHelper_FileFinder
171
+     * @see FileHelper_FileFinder::excludeExtensions()
172
+     */
173 173
     public function excludeExtension(string $extension) : FileHelper_FileFinder
174 174
     {
175 175
         return $this->excludeExtensions(array($extension));
176 176
     }
177 177
 
178
-   /**
179
-    * Add several extensions to the list of extensions to
180
-    * exclude from the file search.
181
-    *  
182
-    * @param array $extensions Extension names, without dot (`php` for example).
183
-    * @return FileHelper_FileFinder
184
-    * @see FileHelper_FileFinder::excludeExtension()
185
-    */
178
+    /**
179
+     * Add several extensions to the list of extensions to
180
+     * exclude from the file search.
181
+     *  
182
+     * @param array $extensions Extension names, without dot (`php` for example).
183
+     * @return FileHelper_FileFinder
184
+     * @see FileHelper_FileFinder::excludeExtension()
185
+     */
186 186
     public function excludeExtensions(array $extensions) : FileHelper_FileFinder
187 187
     {
188 188
         $items = $this->getExcludeExtensions();
@@ -193,52 +193,52 @@  discard block
 block discarded – undo
193 193
         return $this;
194 194
     }
195 195
     
196
-   /**
197
-    * In this mode, the entire path to the file will be stripped,
198
-    * leaving only the file name in the files list.
199
-    * 
200
-    * @return FileHelper_FileFinder
201
-    */
196
+    /**
197
+     * In this mode, the entire path to the file will be stripped,
198
+     * leaving only the file name in the files list.
199
+     * 
200
+     * @return FileHelper_FileFinder
201
+     */
202 202
     public function setPathmodeStrip() : FileHelper_FileFinder
203 203
     {
204 204
         return $this->setPathmode(self::PATH_MODE_STRIP);
205 205
     }
206 206
     
207
-   /**
208
-    * In this mode, only the path relative to the source folder
209
-    * will be included in the files list.
210
-    * 
211
-    * @return FileHelper_FileFinder
212
-    */
207
+    /**
208
+     * In this mode, only the path relative to the source folder
209
+     * will be included in the files list.
210
+     * 
211
+     * @return FileHelper_FileFinder
212
+     */
213 213
     public function setPathmodeRelative() : FileHelper_FileFinder
214 214
     {
215 215
         return $this->setPathmode(self::PATH_MODE_RELATIVE);
216 216
     }
217 217
     
218
-   /**
219
-    * In this mode, the full, absolute paths to the files will
220
-    * be included in the files list.
221
-    * 
222
-    * @return FileHelper_FileFinder
223
-    */
218
+    /**
219
+     * In this mode, the full, absolute paths to the files will
220
+     * be included in the files list.
221
+     * 
222
+     * @return FileHelper_FileFinder
223
+     */
224 224
     public function setPathmodeAbsolute() : FileHelper_FileFinder
225 225
     {
226 226
         return $this->setPathmode(self::PATH_MODE_ABSOLUTE);
227 227
     }
228 228
     
229
-   /**
230
-    * This sets a character or string to replace the slashes
231
-    * in the paths with. 
232
-    * 
233
-    * This is used for example in the `getPHPClassNames()` 
234
-    * method, to return files from subfolders as class names
235
-    * using the "_" character:
236
-    * 
237
-    * Subfolder/To/File.php => Subfolder_To_File.php
238
-    * 
239
-    * @param string $character
240
-    * @return FileHelper_FileFinder
241
-    */
229
+    /**
230
+     * This sets a character or string to replace the slashes
231
+     * in the paths with. 
232
+     * 
233
+     * This is used for example in the `getPHPClassNames()` 
234
+     * method, to return files from subfolders as class names
235
+     * using the "_" character:
236
+     * 
237
+     * Subfolder/To/File.php => Subfolder_To_File.php
238
+     * 
239
+     * @param string $character
240
+     * @return FileHelper_FileFinder
241
+     */
242 242
     public function setSlashReplacement(string $character) : FileHelper_FileFinder
243 243
     {
244 244
         return $this->setOption('slash-replacement', $character);
@@ -249,12 +249,12 @@  discard block
 block discarded – undo
249 249
         return $this->setOption('pathmode', $mode);
250 250
     }
251 251
     
252
-   /**
253
-    * Retrieves a list of all matching file names/paths,
254
-    * depending on the selected options.
255
-    * 
256
-    * @return string[]
257
-    */
252
+    /**
253
+     * Retrieves a list of all matching file names/paths,
254
+     * depending on the selected options.
255
+     * 
256
+     * @return string[]
257
+     */
258 258
     public function getAll() : array
259 259
     {
260 260
         $this->find($this->path, true);
@@ -262,24 +262,24 @@  discard block
 block discarded – undo
262 262
         return $this->found;
263 263
     }
264 264
     
265
-   /**
266
-    * Retrieves only PHP files. Can be combined with other
267
-    * options like enabling recursion into subfolders.
268
-    * 
269
-    * @return string[]
270
-    */
265
+    /**
266
+     * Retrieves only PHP files. Can be combined with other
267
+     * options like enabling recursion into subfolders.
268
+     * 
269
+     * @return string[]
270
+     */
271 271
     public function getPHPFiles() : array
272 272
     {
273 273
         $this->includeExtensions(array('php'));
274 274
         return $this->getAll();
275 275
     }
276 276
     
277
-   /**
278
-    * Generates PHP class names from file paths: it replaces
279
-    * slashes with underscores, and removes file extensions.
280
-    * 
281
-    * @return string[] An array of PHP file names without extension.
282
-    */
277
+    /**
278
+     * Generates PHP class names from file paths: it replaces
279
+     * slashes with underscores, and removes file extensions.
280
+     * 
281
+     * @return string[] An array of PHP file names without extension.
282
+     */
283 283
     public function getPHPClassNames() : array
284 284
     {
285 285
         $this->includeExtensions(array('php'));
@@ -350,13 +350,13 @@  discard block
 block discarded – undo
350 350
         return $path;
351 351
     }
352 352
     
353
-   /**
354
-    * Checks whether the specified extension is allowed 
355
-    * with the current settings.
356
-    * 
357
-    * @param string $extension
358
-    * @return bool
359
-    */
353
+    /**
354
+     * Checks whether the specified extension is allowed 
355
+     * with the current settings.
356
+     * 
357
+     * @param string $extension
358
+     * @return bool
359
+     */
360 360
     protected function filterExclusion(string $extension) : bool
361 361
     {
362 362
         $include = $this->getOption('include-extensions');
@@ -378,12 +378,12 @@  discard block
 block discarded – undo
378 378
         return true;
379 379
     }
380 380
     
381
-   /**
382
-    * Adjusts the path according to the selected path mode.
383
-    * 
384
-    * @param string $path
385
-    * @return string
386
-    */
381
+    /**
382
+     * Adjusts the path according to the selected path mode.
383
+     * 
384
+     * @param string $path
385
+     * @return string
386
+     */
387 387
     protected function filterPath(string $path) : string
388 388
     {
389 389
         switch($this->getStringOption('pathmode'))
Please login to merge, or discard this patch.
src/FileHelper/MimeTypes.php 1 patch
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -288,9 +288,9 @@
 block discarded – undo
288 288
      * @param string $extension
289 289
      * @return string|NULL
290 290
      */
291
-    public static function getMime(string $extension) :?string
291
+    public static function getMime(string $extension) : ?string
292 292
     {
293
-        if(isset(self::$mimeTypes[$extension])) {
293
+        if (isset(self::$mimeTypes[$extension])) {
294 294
             return self::$mimeTypes[$extension];
295 295
         }
296 296
 
Please login to merge, or discard this patch.
src/FileHelper.php 2 patches
Indentation   +341 added lines, -341 removed lines patch added patch discarded remove patch
@@ -60,31 +60,31 @@  discard block
 block discarded – undo
60 60
     protected static $utfBoms;
61 61
 
62 62
     /**
63
-    * Opens a serialized file and returns the unserialized data.
64
-    * 
65
-    * @param string $file
66
-    * @throws FileHelper_Exception
67
-    * @return array
68
-    * @deprecated Use parseSerializedFile() instead.
69
-    * @see FileHelper::parseSerializedFile()
70
-    */
63
+     * Opens a serialized file and returns the unserialized data.
64
+     * 
65
+     * @param string $file
66
+     * @throws FileHelper_Exception
67
+     * @return array
68
+     * @deprecated Use parseSerializedFile() instead.
69
+     * @see FileHelper::parseSerializedFile()
70
+     */
71 71
     public static function openUnserialized(string $file) : array
72 72
     {
73 73
         return self::parseSerializedFile($file);
74 74
     }
75 75
 
76
-   /**
77
-    * Opens a serialized file and returns the unserialized data.
78
-    *
79
-    * @param string $file
80
-    * @throws FileHelper_Exception
81
-    * @return array
82
-    * @see FileHelper::parseSerializedFile()
83
-    * 
84
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
85
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
86
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
87
-    */
76
+    /**
77
+     * Opens a serialized file and returns the unserialized data.
78
+     *
79
+     * @param string $file
80
+     * @throws FileHelper_Exception
81
+     * @return array
82
+     * @see FileHelper::parseSerializedFile()
83
+     * 
84
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
85
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
86
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
87
+     */
88 88
     public static function parseSerializedFile(string $file) : array
89 89
     {
90 90
         self::requireFileExists($file);
@@ -160,13 +160,13 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
319 319
         return $parser;
320 320
     }
321 321
 
322
-   /**
323
-    * Parses all lines in the specified string and returns an
324
-    * indexed array with all csv values in each line.
325
-    *
326
-    * @param string $csv
327
-    * @param string $delimiter
328
-    * @param string $enclosure
329
-    * @param string $escape
330
-    * @param bool $heading
331
-    * @return array
332
-    * @throws FileHelper_Exception
333
-    * 
334
-    * @see parseCSVFile()
335
-    * @see FileHelper::ERROR_PARSING_CSV
336
-    */
322
+    /**
323
+     * Parses all lines in the specified string and returns an
324
+     * indexed array with all csv values in each line.
325
+     *
326
+     * @param string $csv
327
+     * @param string $delimiter
328
+     * @param string $enclosure
329
+     * @param string $escape
330
+     * @param bool $heading
331
+     * @return array
332
+     * @throws FileHelper_Exception
333
+     * 
334
+     * @see parseCSVFile()
335
+     * @see FileHelper::ERROR_PARSING_CSV
336
+     */
337 337
     public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
338 338
     {
339 339
         $parser = self::createCSVParser($delimiter, $enclosure, '\\', $heading);
@@ -521,27 +521,27 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
1154 1154
         return $date;
1155 1155
     }
1156 1156
     
1157
-   /**
1158
-    * Retrieves the names of all subfolders in the specified path.
1159
-    * 
1160
-    * Available options:
1161
-    * 
1162
-    * - recursive: true/false
1163
-    *   Whether to search for subfolders recursively. 
1164
-    *   
1165
-    * - absolute-paths: true/false
1166
-    *   Whether to return a list of absolute paths.
1167
-    * 
1168
-    * @param string|DirectoryIterator $targetFolder
1169
-    * @param array $options
1170
-    * @throws FileHelper_Exception
1171
-    * @return string[]
1172
-    *
1173
-    * @see FileHelper::ERROR_FIND_SUBFOLDERS_FOLDER_DOES_NOT_EXIST
1174
-    * @todo Move this to a separate class.
1175
-    */
1157
+    /**
1158
+     * Retrieves the names of all subfolders in the specified path.
1159
+     * 
1160
+     * Available options:
1161
+     * 
1162
+     * - recursive: true/false
1163
+     *   Whether to search for subfolders recursively. 
1164
+     *   
1165
+     * - absolute-paths: true/false
1166
+     *   Whether to return a list of absolute paths.
1167
+     * 
1168
+     * @param string|DirectoryIterator $targetFolder
1169
+     * @param array $options
1170
+     * @throws FileHelper_Exception
1171
+     * @return string[]
1172
+     *
1173
+     * @see FileHelper::ERROR_FIND_SUBFOLDERS_FOLDER_DOES_NOT_EXIST
1174
+     * @todo Move this to a separate class.
1175
+     */
1176 1176
     public static function getSubfolders($targetFolder, $options = array())
1177 1177
     {
1178 1178
         if($targetFolder instanceof DirectoryIterator) {
@@ -1237,16 +1237,16 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
1482 1482
         return $number+1;
1483 1483
     }
1484 1484
     
1485
-   /**
1486
-    * Parses the target file to detect any PHP classes contained
1487
-    * within, and retrieve information on them. Does not use the 
1488
-    * PHP reflection API.
1489
-    * 
1490
-    * @param string $filePath
1491
-    * @return FileHelper_PHPClassInfo
1492
-    */
1485
+    /**
1486
+     * Parses the target file to detect any PHP classes contained
1487
+     * within, and retrieve information on them. Does not use the 
1488
+     * PHP reflection API.
1489
+     * 
1490
+     * @param string $filePath
1491
+     * @return FileHelper_PHPClassInfo
1492
+     */
1493 1493
     public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo
1494 1494
     {
1495 1495
         return new FileHelper_PHPClassInfo($filePath);
1496 1496
     }
1497 1497
     
1498
-   /**
1499
-    * Detects the end of line style used in the target file, if any.
1500
-    * Can be used with large files, because it only reads part of it.
1501
-    * 
1502
-    * @param string $filePath The path to the file.
1503
-    * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
1504
-    */
1498
+    /**
1499
+     * Detects the end of line style used in the target file, if any.
1500
+     * Can be used with large files, because it only reads part of it.
1501
+     * 
1502
+     * @param string $filePath The path to the file.
1503
+     * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
1504
+     */
1505 1505
     public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL
1506 1506
     {
1507 1507
         // 20 lines is enough to get a good picture of the newline style in the file.
@@ -1514,18 +1514,18 @@  discard block
 block discarded – undo
1514 1514
         return ConvertHelper::detectEOLCharacter($string);
1515 1515
     }
1516 1516
     
1517
-   /**
1518
-    * Reads the specified amount of lines from the target file.
1519
-    * Unicode BOM compatible: any byte order marker is stripped
1520
-    * from the resulting lines.
1521
-    * 
1522
-    * @param string $filePath
1523
-    * @param int $amount Set to 0 to read all lines.
1524
-    * @return array
1525
-    * 
1526
-    * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1527
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1528
-    */
1517
+    /**
1518
+     * Reads the specified amount of lines from the target file.
1519
+     * Unicode BOM compatible: any byte order marker is stripped
1520
+     * from the resulting lines.
1521
+     * 
1522
+     * @param string $filePath
1523
+     * @param int $amount Set to 0 to read all lines.
1524
+     * @return array
1525
+     * 
1526
+     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1527
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1528
+     */
1529 1529
     public static function readLines(string $filePath, int $amount=0) : array
1530 1530
     {
1531 1531
         self::requireFileExists($filePath);
@@ -1578,16 +1578,16 @@  discard block
 block discarded – undo
1578 1578
         return $result;
1579 1579
     }
1580 1580
     
1581
-   /**
1582
-    * Reads all content from a file.
1583
-    * 
1584
-    * @param string $filePath
1585
-    * @throws FileHelper_Exception
1586
-    * @return string
1587
-    * 
1588
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1589
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
1590
-    */
1581
+    /**
1582
+     * Reads all content from a file.
1583
+     * 
1584
+     * @param string $filePath
1585
+     * @throws FileHelper_Exception
1586
+     * @return string
1587
+     * 
1588
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1589
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
1590
+     */
1591 1591
     public static function readContents(string $filePath) : string
1592 1592
     {
1593 1593
         self::requireFileExists($filePath);
@@ -1608,18 +1608,18 @@  discard block
 block discarded – undo
1608 1608
         );
1609 1609
     }
1610 1610
 
1611
-   /**
1612
-    * Ensures that the target path exists on disk, and is a folder.
1613
-    * 
1614
-    * @param string $path
1615
-    * @return string The real path, with normalized slashes.
1616
-    * @throws FileHelper_Exception
1617
-    * 
1618
-    * @see FileHelper::normalizePath()
1619
-    * 
1620
-    * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
1621
-    * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
1622
-    */
1611
+    /**
1612
+     * Ensures that the target path exists on disk, and is a folder.
1613
+     * 
1614
+     * @param string $path
1615
+     * @return string The real path, with normalized slashes.
1616
+     * @throws FileHelper_Exception
1617
+     * 
1618
+     * @see FileHelper::normalizePath()
1619
+     * 
1620
+     * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
1621
+     * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
1622
+     */
1623 1623
     public static function requireFolderExists(string $path) : string
1624 1624
     {
1625 1625
         $actual = realpath($path);
Please login to merge, or discard this patch.
Spacing   +105 added lines, -105 removed lines patch added patch discarded remove patch
@@ -91,7 +91,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
423 423
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
424 424
      * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE
425 425
      */
426
-    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true)
426
+    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true)
427 427
     {
428 428
         self::requireFileExists($filePath);
429 429
         
430
-        if(empty($fileName)) {
430
+        if (empty($fileName)) {
431 431
             $fileName = basename($filePath);
432 432
         }
433 433
 
@@ -445,10 +445,10 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
1175 1175
     */
1176 1176
     public static function getSubfolders($targetFolder, $options = array())
1177 1177
     {
1178
-        if($targetFolder instanceof DirectoryIterator) {
1178
+        if ($targetFolder instanceof DirectoryIterator) {
1179 1179
             $targetFolder = $targetFolder->getPathname();
1180 1180
         }
1181 1181
 
1182
-        if(!is_dir($targetFolder)) 
1182
+        if (!is_dir($targetFolder)) 
1183 1183
         {
1184 1184
             throw new FileHelper_Exception(
1185 1185
                 'Target folder does not exist',
@@ -1203,29 +1203,29 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
1473 1473
             // that this is not pactical to solve with the SplFileObject.
1474 1474
             $content = file_get_contents($path);
1475 1475
             
1476
-            if(empty($content)) {
1476
+            if (empty($content)) {
1477 1477
                 return 0;
1478 1478
             }
1479 1479
         }
1480 1480
         
1481 1481
         // return the line number we were able to reach + 1 (key is zero-based)
1482
-        return $number+1;
1482
+        return $number + 1;
1483 1483
     }
1484 1484
     
1485 1485
    /**
@@ -1526,13 +1526,13 @@  discard block
 block discarded – undo
1526 1526
     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1527 1527
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1528 1528
     */
1529
-    public static function readLines(string $filePath, int $amount=0) : array
1529
+    public static function readLines(string $filePath, int $amount = 0) : array
1530 1530
     {
1531 1531
         self::requireFileExists($filePath);
1532 1532
         
1533 1533
         $fn = fopen($filePath, "r");
1534 1534
         
1535
-        if($fn === false) 
1535
+        if ($fn === false) 
1536 1536
         {
1537 1537
             throw new FileHelper_Exception(
1538 1538
                 'Could not open file for reading.',
@@ -1548,19 +1548,19 @@  discard block
 block discarded – undo
1548 1548
         $counter = 0;
1549 1549
         $first = true;
1550 1550
         
1551
-        while(!feof($fn)) 
1551
+        while (!feof($fn)) 
1552 1552
         {
1553 1553
             $counter++;
1554 1554
             
1555 1555
             $line = fgets($fn);
1556 1556
             
1557 1557
             // can happen with zero length files
1558
-            if($line === false) {
1558
+            if ($line === false) {
1559 1559
                 continue;
1560 1560
             }
1561 1561
             
1562 1562
             // the first line may contain a unicode BOM marker.
1563
-            if($first) 
1563
+            if ($first) 
1564 1564
             {
1565 1565
                 $line = ConvertHelper::stripUTFBom($line);
1566 1566
                 $first = false;
@@ -1568,7 +1568,7 @@  discard block
 block discarded – undo
1568 1568
             
1569 1569
             $result[] = $line;
1570 1570
             
1571
-            if($amount > 0 && $counter == $amount) {
1571
+            if ($amount > 0 && $counter == $amount) {
1572 1572
                 break;
1573 1573
             }
1574 1574
         }
@@ -1594,7 +1594,7 @@  discard block
 block discarded – undo
1594 1594
         
1595 1595
         $result = file_get_contents($filePath);
1596 1596
         
1597
-        if($result !== false) {
1597
+        if ($result !== false) {
1598 1598
             return $result;
1599 1599
         }
1600 1600
         
@@ -1624,7 +1624,7 @@  discard block
 block discarded – undo
1624 1624
     {
1625 1625
         $actual = realpath($path);
1626 1626
         
1627
-        if($actual === false) 
1627
+        if ($actual === false) 
1628 1628
         {
1629 1629
             throw new FileHelper_Exception(
1630 1630
                 'Folder does not exist',
@@ -1636,7 +1636,7 @@  discard block
 block discarded – undo
1636 1636
             );
1637 1637
         }
1638 1638
         
1639
-        if(is_dir($path)) 
1639
+        if (is_dir($path)) 
1640 1640
         {
1641 1641
             return self::normalizePath($actual);
1642 1642
         }
@@ -1658,7 +1658,7 @@  discard block
 block discarded – undo
1658 1658
      * @param string[] $paths
1659 1659
      * @return FileHelper_PathsReducer
1660 1660
      */
1661
-    public static function createPathsReducer(array $paths=array()) : FileHelper_PathsReducer
1661
+    public static function createPathsReducer(array $paths = array()) : FileHelper_PathsReducer
1662 1662
     {
1663 1663
         return new FileHelper_PathsReducer();
1664 1664
     }
Please login to merge, or discard this patch.