Passed
Push — master ( 428f46...c925bb )
by Sebastian
02:32
created
src/FileHelper/FileFinder.php 3 patches
Braces   +2 added lines, -4 removed lines patch added patch discarded remove patch
@@ -147,8 +147,7 @@  discard block
 block discarded – undo
147 147
                 if($this->getOption('recursive') === true && !$item->isDot()) {
148 148
                     $this->find($item->getPathname());
149 149
                 }
150
-            }
151
-            else
150
+            } else
152 151
             {
153 152
                 $file = $this->filterFile($item->getPathname());
154 153
                 if($file) {
@@ -172,8 +171,7 @@  discard block
 block discarded – undo
172 171
             if(!in_array($info['extension'], $include)) {
173 172
                 return false;
174 173
             }
175
-        }
176
-        else if(!empty($exclude))
174
+        } else if(!empty($exclude))
177 175
         {
178 176
             if(in_array($info['extension'], $exclude)) {
179 177
                 return false;
Please login to merge, or discard this patch.
Indentation   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -31,9 +31,9 @@
 block discarded – undo
31 31
     
32 32
     const PATH_MODE_STRIP = 'strip';
33 33
     
34
-   /**
35
-    * @var string
36
-    */
34
+    /**
35
+     * @var string
36
+     */
37 37
     protected $path;
38 38
     
39 39
     public function __construct(string $path)
Please login to merge, or discard this patch.
Spacing   +15 added lines, -15 removed lines patch added patch discarded remove patch
@@ -7,7 +7,7 @@  discard block
 block discarded – undo
7 7
  * @see FileHelper_FileFinder
8 8
  */
9 9
 
10
-declare(strict_types = 1);
10
+declare(strict_types=1);
11 11
 
12 12
 namespace AppUtils;
13 13
 
@@ -125,7 +125,7 @@  discard block
 block discarded – undo
125 125
     
126 126
     public function getAll() : array
127 127
     {
128
-        if(!isset($this->found)) {
128
+        if (!isset($this->found)) {
129 129
             $this->find($this->path, true);
130 130
         }
131 131
         
@@ -150,25 +150,25 @@  discard block
 block discarded – undo
150 150
     
151 151
     protected $found;
152 152
     
153
-    protected function find($path, $isRoot=false)
153
+    protected function find($path, $isRoot = false)
154 154
     {
155
-        if($isRoot) {
155
+        if ($isRoot) {
156 156
             $this->found = array();
157 157
         }
158 158
         
159 159
         $d = new \DirectoryIterator($path);
160
-        foreach($d as $item)
160
+        foreach ($d as $item)
161 161
         {
162
-            if($item->isDir())
162
+            if ($item->isDir())
163 163
             {
164
-                if($this->getOption('recursive') === true && !$item->isDot()) {
164
+                if ($this->getOption('recursive') === true && !$item->isDot()) {
165 165
                     $this->find($item->getPathname());
166 166
                 }
167 167
             }
168 168
             else
169 169
             {
170 170
                 $file = $this->filterFile($item->getPathname());
171
-                if($file) {
171
+                if ($file) {
172 172
                     $this->found[] = $file;
173 173
                 }
174 174
             }
@@ -184,20 +184,20 @@  discard block
 block discarded – undo
184 184
         $include = $this->getOption('include-extensions');
185 185
         $exclude = $this->getOption('exclude-extensions');
186 186
         
187
-        if(!empty($include))
187
+        if (!empty($include))
188 188
         {
189
-            if(!in_array($info['extension'], $include)) {
189
+            if (!in_array($info['extension'], $include)) {
190 190
                 return false;
191 191
             }
192 192
         }
193
-        else if(!empty($exclude))
193
+        else if (!empty($exclude))
194 194
         {
195
-            if(in_array($info['extension'], $exclude)) {
195
+            if (in_array($info['extension'], $exclude)) {
196 196
                 return false;
197 197
             }
198 198
         }
199 199
         
200
-        switch($this->getOption('pathmode'))
200
+        switch ($this->getOption('pathmode'))
201 201
         {
202 202
             case self::PATH_MODE_STRIP:
203 203
                 $path = basename($path);
@@ -213,13 +213,13 @@  discard block
 block discarded – undo
213 213
                 break;
214 214
         }
215 215
         
216
-        if($this->getOption('strip-extensions') === true)
216
+        if ($this->getOption('strip-extensions') === true)
217 217
         {
218 218
             $path = str_replace('.'.$info['extension'], '', $path);
219 219
         }
220 220
         
221 221
         $replace = $this->getOption('slash-replacement');
222
-        if(!empty($replace)) {
222
+        if (!empty($replace)) {
223 223
             $path = str_replace('/', $replace, $path);
224 224
         }
225 225
         
Please login to merge, or discard this patch.
src/FileHelper/MimeTypes.php 1 patch
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -221,7 +221,7 @@
 block discarded – undo
221 221
      */
222 222
     public static function getMime($extension)
223 223
     {
224
-        if(isset(self::$mimeTypes[$extension])) {
224
+        if (isset(self::$mimeTypes[$extension])) {
225 225
             return self::$mimeTypes[$extension];
226 226
         }
227 227
 
Please login to merge, or discard this patch.
src/FileHelper/PHPClassInfo/Class.php 2 patches
Indentation   +70 added lines, -70 removed lines patch added patch discarded remove patch
@@ -22,51 +22,51 @@  discard block
 block discarded – undo
22 22
  */
23 23
 class FileHelper_PHPClassInfo_Class 
24 24
 {
25
-   /**
26
-    * @var FileHelper_PHPClassInfo
27
-    */
25
+    /**
26
+     * @var FileHelper_PHPClassInfo
27
+     */
28 28
     protected $info;
29 29
 
30
-   /**
31
-    * @var bool
32
-    */
30
+    /**
31
+     * @var bool
32
+     */
33 33
     protected $abstract = false;
34 34
     
35
-   /**
36
-    * @var bool
37
-    */
35
+    /**
36
+     * @var bool
37
+     */
38 38
     protected $final = false;
39 39
     
40
-   /**
41
-    * @var string
42
-    */
40
+    /**
41
+     * @var string
42
+     */
43 43
     protected $extends = '';
44 44
     
45
-   /**
46
-    * @var string[]
47
-    */
45
+    /**
46
+     * @var string[]
47
+     */
48 48
     protected $implements = array();
49 49
     
50
-   /**
51
-    * @var string
52
-    */
50
+    /**
51
+     * @var string
52
+     */
53 53
     protected $name;
54 54
     
55
-   /**
56
-    * @var string
57
-    */
55
+    /**
56
+     * @var string
57
+     */
58 58
     protected $declaration;
59 59
     
60
-   /**
61
-    * @var string
62
-    */
60
+    /**
61
+     * @var string
62
+     */
63 63
     protected $keyword;
64 64
     
65
-   /**
66
-    * @param FileHelper_PHPClassInfo $info The class info instance.
67
-    * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass".
68
-    * @param string $keyword The class keyword, if any, i.e. "abstract" or "final".
69
-    */
65
+    /**
66
+     * @param FileHelper_PHPClassInfo $info The class info instance.
67
+     * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass".
68
+     * @param string $keyword The class keyword, if any, i.e. "abstract" or "final".
69
+     */
70 70
     public function __construct(FileHelper_PHPClassInfo $info, string $declaration, string $keyword)
71 71
     {
72 72
         $this->info = $info;
@@ -76,31 +76,31 @@  discard block
 block discarded – undo
76 76
         $this->analyzeCode();
77 77
     }
78 78
     
79
-   /**
80
-    * Check if this class is a subclass of the specified
81
-    * class name.
82
-    * 
83
-    * @param string $className
84
-    * @return bool
85
-    */
79
+    /**
80
+     * Check if this class is a subclass of the specified
81
+     * class name.
82
+     * 
83
+     * @param string $className
84
+     * @return bool
85
+     */
86 86
     public function isSublassOf(string $className) : bool
87 87
     {
88 88
         return is_subclass_of($this->getNameNS(), $className);
89 89
     }
90 90
     
91
-   /**
92
-    * The class name without namespace.
93
-    * @return string
94
-    */
91
+    /**
92
+     * The class name without namespace.
93
+     * @return string
94
+     */
95 95
     public function getName() : string
96 96
     {
97 97
         return $this->name;
98 98
     }
99 99
     
100
-   /**
101
-    * The absolute class name with namespace (if any).
102
-    * @return string
103
-    */
100
+    /**
101
+     * The absolute class name with namespace (if any).
102
+     * @return string
103
+     */
104 104
     public function getNameNS() : string
105 105
     {
106 106
         $name = $this->getName();
@@ -112,48 +112,48 @@  discard block
 block discarded – undo
112 112
         return $name;
113 113
     }
114 114
     
115
-   /**
116
-    * Whether it is an abstract class.
117
-    * @return bool
118
-    */
115
+    /**
116
+     * Whether it is an abstract class.
117
+     * @return bool
118
+     */
119 119
     public function isAbstract() : bool
120 120
     {
121 121
         return $this->abstract;
122 122
     }
123 123
     
124
-   /**
125
-    * Whether it is a final class.
126
-    * @return bool
127
-    */
124
+    /**
125
+     * Whether it is a final class.
126
+     * @return bool
127
+     */
128 128
     public function isFinal() : bool
129 129
     {
130 130
         return $this->final;
131 131
     }
132 132
 
133
-   /**
134
-    * The name of the class that this class extends (with namespace, if specified).
135
-    * @return string
136
-    */
133
+    /**
134
+     * The name of the class that this class extends (with namespace, if specified).
135
+     * @return string
136
+     */
137 137
     public function getExtends() : string
138 138
     {
139 139
         return $this->extends;
140 140
     }
141 141
     
142
-   /**
143
-    * A list of interfaces the class implements, if any.
144
-    * @return array
145
-    */
142
+    /**
143
+     * A list of interfaces the class implements, if any.
144
+     * @return array
145
+     */
146 146
     public function getImplements() : array
147 147
     {
148 148
         return $this->implements;
149 149
     }
150 150
     
151
-   /**
152
-    * The class declaration string, with normalized spaces and sorted interface names.
153
-    * NOTE: does not include the keyword "abstract" or "final".
154
-    * 
155
-    * @return string
156
-    */
151
+    /**
152
+     * The class declaration string, with normalized spaces and sorted interface names.
153
+     * NOTE: does not include the keyword "abstract" or "final".
154
+     * 
155
+     * @return string
156
+     */
157 157
     public function getDeclaration() : string
158 158
     {
159 159
         $parts = array();
@@ -173,10 +173,10 @@  discard block
 block discarded – undo
173 173
         return implode(' ', $parts);
174 174
     }
175 175
     
176
-   /**
177
-    * The keyword before "class", e.g. "abstract".
178
-    * @return string
179
-    */
176
+    /**
177
+     * The keyword before "class", e.g. "abstract".
178
+     * @return string
179
+     */
180 180
     public function getKeyword() : string
181 181
     {
182 182
         return $this->keyword;
Please login to merge, or discard this patch.
Spacing   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -105,7 +105,7 @@  discard block
 block discarded – undo
105 105
     {
106 106
         $name = $this->getName();
107 107
         
108
-        if($this->info->hasNamespace()) {
108
+        if ($this->info->hasNamespace()) {
109 109
             $name = $this->info->getNamespace().'\\'.$this->name;
110 110
         }
111 111
         
@@ -160,12 +160,12 @@  discard block
 block discarded – undo
160 160
         $parts[] = 'class';
161 161
         $parts[] = $this->getName();
162 162
         
163
-        if(!empty($this->extends)) {
163
+        if (!empty($this->extends)) {
164 164
             $parts[] = 'extends';
165 165
             $parts[] = $this->extends;
166 166
         }
167 167
         
168
-        if(!empty($this->implements)) {
168
+        if (!empty($this->implements)) {
169 169
             $parts[] = 'implements';
170 170
             $parts[] = implode(', ', $this->implements);
171 171
         }
@@ -184,9 +184,9 @@  discard block
 block discarded – undo
184 184
     
185 185
     protected function analyzeCode()
186 186
     {
187
-        if($this->keyword == 'abstract') {
187
+        if ($this->keyword == 'abstract') {
188 188
             $this->abstract = true;
189
-        } else if($this->keyword == 'final') {
189
+        } else if ($this->keyword == 'final') {
190 190
             $this->final = true;
191 191
         }
192 192
         
@@ -203,16 +203,16 @@  discard block
 block discarded – undo
203 203
         
204 204
         $tokenName = 'none';
205 205
         
206
-        foreach($parts as $part)
206
+        foreach ($parts as $part)
207 207
         {
208 208
             $part = str_replace(',', '', $part);
209 209
             $part = trim($part);
210
-            if(empty($part)) {
210
+            if (empty($part)) {
211 211
                 continue;
212 212
             }
213 213
             
214 214
             $name = strtolower($part);
215
-            if($name == 'extends' || $name == 'implements') {
215
+            if ($name == 'extends' || $name == 'implements') {
216 216
                 $tokenName = $name;
217 217
                 continue;
218 218
             }
@@ -222,13 +222,13 @@  discard block
 block discarded – undo
222 222
         
223 223
         $this->implements = $tokens['implements'];
224 224
         
225
-        if(!empty($this->implements)) {
225
+        if (!empty($this->implements)) {
226 226
             usort($this->implements, function(string $a, string $b) {
227 227
                 return strnatcasecmp($a, $b);
228 228
             });
229 229
         }
230 230
         
231
-        if(!empty($tokens['extends'])) {
231
+        if (!empty($tokens['extends'])) {
232 232
             $this->extends = $tokens['extends'][0];
233 233
         }
234 234
     }
Please login to merge, or discard this patch.
src/ImageHelper/Size.php 1 patch
Spacing   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -18,23 +18,23 @@  discard block
 block discarded – undo
18 18
     
19 19
     public function __construct(array $size)
20 20
     {
21
-        if(!isset($size['width'])) {
21
+        if (!isset($size['width'])) {
22 22
             $size['width'] = $size[0];
23 23
         }
24 24
         
25
-        if(!isset($size['height'])) {
25
+        if (!isset($size['height'])) {
26 26
             $size['height'] = $size[1];
27 27
         }
28 28
         
29
-        if(!isset($size[0])) {
29
+        if (!isset($size[0])) {
30 30
             $size[0] = $size['width'];
31 31
         }
32 32
         
33
-        if(!isset($size[1])) {
33
+        if (!isset($size[1])) {
34 34
             $size[1] = $size['height'];
35 35
         }
36 36
         
37
-        if(!isset($size['channels'])) {
37
+        if (!isset($size['channels'])) {
38 38
             $size['channels'] = 1;
39 39
         }
40 40
         
@@ -68,7 +68,7 @@  discard block
 block discarded – undo
68 68
     
69 69
     public function offsetGet($offset)
70 70
     {
71
-        if(isset($this->size[$offset])) {
71
+        if (isset($this->size[$offset])) {
72 72
             return $this->size[$offset];
73 73
         }
74 74
         
@@ -77,7 +77,7 @@  discard block
 block discarded – undo
77 77
     
78 78
     public function offsetSet($offset, $value)
79 79
     {
80
-        if(is_null($offset)) {
80
+        if (is_null($offset)) {
81 81
             $this->size[] = $value;
82 82
         } else {
83 83
             $this->size[$offset] = $value;
Please login to merge, or discard this patch.
src/FileHelper.php 3 patches
Braces   +2 added lines, -4 removed lines patch added patch discarded remove patch
@@ -197,8 +197,7 @@  discard block
 block discarded – undo
197 197
             if ($item->isDir()) 
198 198
             {
199 199
                 FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName);
200
-            } 
201
-            else if($item->isFile()) 
200
+            } else if($item->isFile()) 
202 201
             {
203 202
                 self::copyFile($itemPath, $target . '/' . $baseName);
204 203
             }
@@ -242,8 +241,7 @@  discard block
 block discarded – undo
242 241
         if(!file_exists($targetFolder))
243 242
         {
244 243
             self::createFolder($targetFolder);
245
-        }
246
-        else if(!is_writable($targetFolder)) 
244
+        } else if(!is_writable($targetFolder)) 
247 245
         {
248 246
             throw new FileHelper_Exception(
249 247
                 sprintf('Target folder [%s] is not writable.', basename($targetFolder)),
Please login to merge, or discard this patch.
Indentation   +387 added lines, -387 removed lines patch added patch discarded remove patch
@@ -78,32 +78,32 @@  discard block
 block discarded – undo
78 78
     
79 79
     const ERROR_CURL_OUTPUT_NOT_STRING = 340031;
80 80
     
81
-   /**
82
-    * Opens a serialized file and returns the unserialized data.
83
-    * 
84
-    * @param string $file
85
-    * @throws FileHelper_Exception
86
-    * @return array
87
-    * @deprecated Use parseSerializedFile() instead.
88
-    * @see FileHelper::parseSerializedFile()
89
-    */
81
+    /**
82
+     * Opens a serialized file and returns the unserialized data.
83
+     * 
84
+     * @param string $file
85
+     * @throws FileHelper_Exception
86
+     * @return array
87
+     * @deprecated Use parseSerializedFile() instead.
88
+     * @see FileHelper::parseSerializedFile()
89
+     */
90 90
     public static function openUnserialized(string $file) : array
91 91
     {
92 92
         return self::parseSerializedFile($file);
93 93
     }
94 94
 
95
-   /**
96
-    * Opens a serialized file and returns the unserialized data.
97
-    *
98
-    * @param string $file
99
-    * @throws FileHelper_Exception
100
-    * @return array
101
-    * @see FileHelper::parseSerializedFile()
102
-    * 
103
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
104
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
105
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
106
-    */
95
+    /**
96
+     * Opens a serialized file and returns the unserialized data.
97
+     *
98
+     * @param string $file
99
+     * @throws FileHelper_Exception
100
+     * @return array
101
+     * @see FileHelper::parseSerializedFile()
102
+     * 
103
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
104
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
105
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
106
+     */
107 107
     public static function parseSerializedFile(string $file)
108 108
     {
109 109
         self::requireFileExists($file);
@@ -172,13 +172,13 @@  discard block
 block discarded – undo
172 172
         return rmdir($rootFolder);
173 173
     }
174 174
     
175
-   /**
176
-    * Create a folder, if it does not exist yet.
177
-    *  
178
-    * @param string $path
179
-    * @throws FileHelper_Exception
180
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
181
-    */
175
+    /**
176
+     * Create a folder, if it does not exist yet.
177
+     *  
178
+     * @param string $path
179
+     * @throws FileHelper_Exception
180
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
181
+     */
182 182
     public static function createFolder($path)
183 183
     {
184 184
         if(is_dir($path) || mkdir($path, 0777, true)) {
@@ -225,22 +225,22 @@  discard block
 block discarded – undo
225 225
         }
226 226
     }
227 227
     
228
-   /**
229
-    * Copies a file to the target location. Includes checks
230
-    * for most error sources, like the source file not being
231
-    * readable. Automatically creates the target folder if it
232
-    * does not exist yet.
233
-    * 
234
-    * @param string $sourcePath
235
-    * @param string $targetPath
236
-    * @throws FileHelper_Exception
237
-    * 
238
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
239
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
240
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
241
-    * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
242
-    * @see FileHelper::ERROR_CANNOT_COPY_FILE
243
-    */
228
+    /**
229
+     * Copies a file to the target location. Includes checks
230
+     * for most error sources, like the source file not being
231
+     * readable. Automatically creates the target folder if it
232
+     * does not exist yet.
233
+     * 
234
+     * @param string $sourcePath
235
+     * @param string $targetPath
236
+     * @throws FileHelper_Exception
237
+     * 
238
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
239
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
240
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
241
+     * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
242
+     * @see FileHelper::ERROR_CANNOT_COPY_FILE
243
+     */
244 244
     public static function copyFile($sourcePath, $targetPath)
245 245
     {
246 246
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
@@ -291,15 +291,15 @@  discard block
 block discarded – undo
291 291
         );
292 292
     }
293 293
     
294
-   /**
295
-    * Deletes the target file. Ignored if it cannot be found,
296
-    * and throws an exception if it fails.
297
-    * 
298
-    * @param string $filePath
299
-    * @throws FileHelper_Exception
300
-    * 
301
-    * @see FileHelper::ERROR_CANNOT_DELETE_FILE
302
-    */
294
+    /**
295
+     * Deletes the target file. Ignored if it cannot be found,
296
+     * and throws an exception if it fails.
297
+     * 
298
+     * @param string $filePath
299
+     * @throws FileHelper_Exception
300
+     * 
301
+     * @see FileHelper::ERROR_CANNOT_DELETE_FILE
302
+     */
303 303
     public static function deleteFile(string $filePath) : void
304 304
     {
305 305
         if(!file_exists($filePath)) {
@@ -321,15 +321,15 @@  discard block
 block discarded – undo
321 321
     }
322 322
 
323 323
     /**
324
-    * Creates a new CSV parser instance and returns it.
325
-    * 
326
-    * @param string $delimiter
327
-    * @param string $enclosure
328
-    * @param string $escape
329
-    * @param bool $heading
330
-    * @return \parseCSV
331
-    * @todo Move this to the CSV helper.
332
-    */
324
+     * Creates a new CSV parser instance and returns it.
325
+     * 
326
+     * @param string $delimiter
327
+     * @param string $enclosure
328
+     * @param string $escape
329
+     * @param bool $heading
330
+     * @return \parseCSV
331
+     * @todo Move this to the CSV helper.
332
+     */
333 333
     public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
334 334
     {
335 335
         if($delimiter==='') { $delimiter = ';'; }
@@ -344,23 +344,23 @@  discard block
 block discarded – undo
344 344
         return $parser;
345 345
     }
346 346
 
347
-   /**
348
-    * Parses all lines in the specified string and returns an
349
-    * indexed array with all csv values in each line.
350
-    *
351
-    * @param string $csv
352
-    * @param string $delimiter
353
-    * @param string $enclosure
354
-    * @param string $escape
355
-    * @param bool $heading
356
-    * @return array
357
-    * @throws FileHelper_Exception
358
-    * 
359
-    * @todo Move this to the CSVHelper.
360
-    *
361
-    * @see parseCSVFile()
362
-    * @see FileHelper::ERROR_PARSING_CSV
363
-    */
347
+    /**
348
+     * Parses all lines in the specified string and returns an
349
+     * indexed array with all csv values in each line.
350
+     *
351
+     * @param string $csv
352
+     * @param string $delimiter
353
+     * @param string $enclosure
354
+     * @param string $escape
355
+     * @param bool $heading
356
+     * @return array
357
+     * @throws FileHelper_Exception
358
+     * 
359
+     * @todo Move this to the CSVHelper.
360
+     *
361
+     * @see parseCSVFile()
362
+     * @see FileHelper::ERROR_PARSING_CSV
363
+     */
364 364
     public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
365 365
     {
366 366
         $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading);
@@ -547,31 +547,31 @@  discard block
 block discarded – undo
547 547
         );
548 548
     }
549 549
     
550
-   /**
551
-    * Verifies whether the target file is a PHP file. The path
552
-    * to the file can be a path to a file as a string, or a 
553
-    * DirectoryIterator object instance.
554
-    * 
555
-    * @param string|\DirectoryIterator $pathOrDirIterator
556
-    * @return boolean
557
-    */
550
+    /**
551
+     * Verifies whether the target file is a PHP file. The path
552
+     * to the file can be a path to a file as a string, or a 
553
+     * DirectoryIterator object instance.
554
+     * 
555
+     * @param string|\DirectoryIterator $pathOrDirIterator
556
+     * @return boolean
557
+     */
558 558
     public static function isPHPFile($pathOrDirIterator)
559 559
     {
560
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
561
-    		return true;
562
-    	}
560
+        if(self::getExtension($pathOrDirIterator) == 'php') {
561
+            return true;
562
+        }
563 563
     	
564
-    	return false;
564
+        return false;
565 565
     }
566 566
     
567
-   /**
568
-    * Retrieves the extension of the specified file. Can be a path
569
-    * to a file as a string, or a DirectoryIterator object instance.
570
-    * 
571
-    * @param string|\DirectoryIterator $pathOrDirIterator
572
-    * @param bool $lowercase
573
-    * @return string
574
-    */
567
+    /**
568
+     * Retrieves the extension of the specified file. Can be a path
569
+     * to a file as a string, or a DirectoryIterator object instance.
570
+     * 
571
+     * @param string|\DirectoryIterator $pathOrDirIterator
572
+     * @param bool $lowercase
573
+     * @return string
574
+     */
575 575
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
576 576
     {
577 577
         if($pathOrDirIterator instanceof \DirectoryIterator) {
@@ -582,51 +582,51 @@  discard block
 block discarded – undo
582 582
          
583 583
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
584 584
         if($lowercase) {
585
-        	$ext = mb_strtolower($ext);
585
+            $ext = mb_strtolower($ext);
586 586
         }
587 587
         
588 588
         return $ext;
589 589
     }
590 590
     
591
-   /**
592
-    * Retrieves the file name from a path, with or without extension.
593
-    * The path to the file can be a string, or a DirectoryIterator object
594
-    * instance.
595
-    * 
596
-    * In case of folders, behaves like the pathinfo function: returns
597
-    * the name of the folder.
598
-    * 
599
-    * @param string|\DirectoryIterator $pathOrDirIterator
600
-    * @param bool $extension
601
-    * @return string
602
-    */
591
+    /**
592
+     * Retrieves the file name from a path, with or without extension.
593
+     * The path to the file can be a string, or a DirectoryIterator object
594
+     * instance.
595
+     * 
596
+     * In case of folders, behaves like the pathinfo function: returns
597
+     * the name of the folder.
598
+     * 
599
+     * @param string|\DirectoryIterator $pathOrDirIterator
600
+     * @param bool $extension
601
+     * @return string
602
+     */
603 603
     public static function getFilename($pathOrDirIterator, $extension = true)
604 604
     {
605 605
         $path = $pathOrDirIterator;
606
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
607
-    		$path = $pathOrDirIterator->getFilename();
608
-    	}
606
+        if($pathOrDirIterator instanceof \DirectoryIterator) {
607
+            $path = $pathOrDirIterator->getFilename();
608
+        }
609 609
     	
610
-    	$path = self::normalizePath($path);
610
+        $path = self::normalizePath($path);
611 611
     	
612
-    	if(!$extension) {
613
-    	    return pathinfo($path, PATHINFO_FILENAME);
614
-    	}
612
+        if(!$extension) {
613
+            return pathinfo($path, PATHINFO_FILENAME);
614
+        }
615 615
     	
616
-    	return pathinfo($path, PATHINFO_BASENAME); 
616
+        return pathinfo($path, PATHINFO_BASENAME); 
617 617
     }
618 618
    
619
-   /**
620
-    * Tries to read the contents of the target file and
621
-    * treat it as JSON to return the decoded JSON data.
622
-    * 
623
-    * @param string $file
624
-    * @throws FileHelper_Exception
625
-    * @return array
626
-    * 
627
-    * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
628
-    * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
629
-    */ 
619
+    /**
620
+     * Tries to read the contents of the target file and
621
+     * treat it as JSON to return the decoded JSON data.
622
+     * 
623
+     * @param string $file
624
+     * @throws FileHelper_Exception
625
+     * @return array
626
+     * 
627
+     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
628
+     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
629
+     */ 
630 630
     public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
631 631
     {
632 632
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
@@ -662,16 +662,16 @@  discard block
 block discarded – undo
662 662
         return $json;
663 663
     }
664 664
     
665
-   /**
666
-    * Corrects common formatting mistakes when users enter
667
-    * file names, like too many spaces, dots and the like.
668
-    * 
669
-    * NOTE: if the file name contains a path, the path is
670
-    * stripped, leaving only the file name.
671
-    * 
672
-    * @param string $name
673
-    * @return string
674
-    */
665
+    /**
666
+     * Corrects common formatting mistakes when users enter
667
+     * file names, like too many spaces, dots and the like.
668
+     * 
669
+     * NOTE: if the file name contains a path, the path is
670
+     * stripped, leaving only the file name.
671
+     * 
672
+     * @param string $name
673
+     * @return string
674
+     */
675 675
     public static function fixFileName(string $name) : string
676 676
     {
677 677
         $name = trim($name);
@@ -701,60 +701,60 @@  discard block
 block discarded – undo
701 701
         return $name;
702 702
     }
703 703
     
704
-   /**
705
-    * Creates an instance of the file finder, which is an easier
706
-    * alternative to the other manual findFile methods, since all
707
-    * options can be set by chaining.
708
-    * 
709
-    * @param string $path
710
-    * @return FileHelper_FileFinder
711
-    */
704
+    /**
705
+     * Creates an instance of the file finder, which is an easier
706
+     * alternative to the other manual findFile methods, since all
707
+     * options can be set by chaining.
708
+     * 
709
+     * @param string $path
710
+     * @return FileHelper_FileFinder
711
+     */
712 712
     public static function createFileFinder(string $path) : FileHelper_FileFinder
713 713
     {
714 714
         return new FileHelper_FileFinder($path);
715 715
     }
716 716
     
717
-   /**
718
-    * Searches for all HTML files in the target folder.
719
-    * 
720
-    * @param string $targetFolder
721
-    * @param array $options
722
-    * @return array An indexed array with files.
723
-    * @see FileHelper::createFileFinder()
724
-    * 
725
-    * @todo Convert this to use the file finder.
726
-    */
717
+    /**
718
+     * Searches for all HTML files in the target folder.
719
+     * 
720
+     * @param string $targetFolder
721
+     * @param array $options
722
+     * @return array An indexed array with files.
723
+     * @see FileHelper::createFileFinder()
724
+     * 
725
+     * @todo Convert this to use the file finder.
726
+     */
727 727
     public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
728 728
     {
729 729
         return self::findFiles($targetFolder, array('html'), $options);
730 730
     }
731 731
 
732
-   /**
733
-    * Searches for all PHP files in the target folder.
734
-    * 
735
-    * @param string $targetFolder
736
-    * @param array $options
737
-    * @return array An indexed array of PHP files.
738
-    * @see FileHelper::createFileFinder()
739
-    * 
740
-    * @todo Convert this to use the file finder.
741
-    */
732
+    /**
733
+     * Searches for all PHP files in the target folder.
734
+     * 
735
+     * @param string $targetFolder
736
+     * @param array $options
737
+     * @return array An indexed array of PHP files.
738
+     * @see FileHelper::createFileFinder()
739
+     * 
740
+     * @todo Convert this to use the file finder.
741
+     */
742 742
     public static function findPHPFiles(string $targetFolder, array $options=array()) : array
743 743
     {
744 744
         return self::findFiles($targetFolder, array('php'), $options);
745 745
     }
746 746
     
747
-   /**
748
-    * 
749
-    * @param string $targetFolder
750
-    * @param array $extensions
751
-    * @param array $options
752
-    * @param array $files
753
-    * @throws FileHelper_Exception
754
-    * @return array
755
-    * @deprecated Will be replaced by the file finder in the future.
756
-    * @see FileHelper::createFileFinder()
757
-    */
747
+    /**
748
+     * 
749
+     * @param string $targetFolder
750
+     * @param array $extensions
751
+     * @param array $options
752
+     * @param array $files
753
+     * @throws FileHelper_Exception
754
+     * @return array
755
+     * @deprecated Will be replaced by the file finder in the future.
756
+     * @see FileHelper::createFileFinder()
757
+     */
758 758
     public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
759 759
     {
760 760
         if(!isset($options['strip-extension'])) {
@@ -835,13 +835,13 @@  discard block
 block discarded – undo
835 835
         return $files;
836 836
     }
837 837
 
838
-   /**
839
-    * Removes the extension from the specified path or file name,
840
-    * if any, and returns the name without the extension.
841
-    * 
842
-    * @param string $filename
843
-    * @return sTring
844
-    */
838
+    /**
839
+     * Removes the extension from the specified path or file name,
840
+     * if any, and returns the name without the extension.
841
+     * 
842
+     * @param string $filename
843
+     * @return sTring
844
+     */
845 845
     public static function removeExtension(string $filename) : string
846 846
     {
847 847
         // normalize paths to allow windows style slashes even on nix servers
@@ -850,22 +850,22 @@  discard block
 block discarded – undo
850 850
         return pathinfo($filename, PATHINFO_FILENAME);
851 851
     }
852 852
     
853
-   /**
854
-    * Detects the UTF BOM in the target file, if any. Returns
855
-    * the encoding matching the BOM, which can be any of the
856
-    * following:
857
-    * 
858
-    * <ul>
859
-    * <li>UTF32-BE</li>
860
-    * <li>UTF32-LE</li>
861
-    * <li>UTF16-BE</li>
862
-    * <li>UTF16-LE</li>
863
-    * <li>UTF8</li>
864
-    * </ul>
865
-    * 
866
-    * @param string $filename
867
-    * @return string|NULL
868
-    */
853
+    /**
854
+     * Detects the UTF BOM in the target file, if any. Returns
855
+     * the encoding matching the BOM, which can be any of the
856
+     * following:
857
+     * 
858
+     * <ul>
859
+     * <li>UTF32-BE</li>
860
+     * <li>UTF32-LE</li>
861
+     * <li>UTF16-BE</li>
862
+     * <li>UTF16-LE</li>
863
+     * <li>UTF8</li>
864
+     * </ul>
865
+     * 
866
+     * @param string $filename
867
+     * @return string|NULL
868
+     */
869 869
     public static function detectUTFBom(string $filename) 
870 870
     {
871 871
         $fp = fopen($filename, 'r');
@@ -885,13 +885,13 @@  discard block
 block discarded – undo
885 885
     
886 886
     protected static $utfBoms;
887 887
     
888
-   /**
889
-    * Retrieves a list of all UTF byte order mark character
890
-    * sequences, as an assocative array with UTF encoding => bom sequence
891
-    * pairs.
892
-    * 
893
-    * @return array
894
-    */
888
+    /**
889
+     * Retrieves a list of all UTF byte order mark character
890
+     * sequences, as an assocative array with UTF encoding => bom sequence
891
+     * pairs.
892
+     * 
893
+     * @return array
894
+     */
895 895
     public static function getUTFBOMs()
896 896
     {
897 897
         if(!isset(self::$utfBoms)) {
@@ -907,15 +907,15 @@  discard block
 block discarded – undo
907 907
         return self::$utfBoms;
908 908
     }
909 909
     
910
-   /**
911
-    * Checks whether the specified encoding is a valid
912
-    * unicode encoding, for example "UTF16-LE" or "UTF8".
913
-    * Also accounts for alternate way to write the, like
914
-    * "UTF-8", and omitting little/big endian suffixes.
915
-    * 
916
-    * @param string $encoding
917
-    * @return boolean
918
-    */
910
+    /**
911
+     * Checks whether the specified encoding is a valid
912
+     * unicode encoding, for example "UTF16-LE" or "UTF8".
913
+     * Also accounts for alternate way to write the, like
914
+     * "UTF-8", and omitting little/big endian suffixes.
915
+     * 
916
+     * @param string $encoding
917
+     * @return boolean
918
+     */
919 919
     public static function isValidUnicodeEncoding(string $encoding) : bool
920 920
     {
921 921
         $encodings = self::getKnownUnicodeEncodings();
@@ -934,22 +934,22 @@  discard block
 block discarded – undo
934 934
         return in_array($encoding, $keep);
935 935
     }
936 936
     
937
-   /**
938
-    * Retrieves a list of all known unicode file encodings.
939
-    * @return array
940
-    */
937
+    /**
938
+     * Retrieves a list of all known unicode file encodings.
939
+     * @return array
940
+     */
941 941
     public static function getKnownUnicodeEncodings()
942 942
     {
943 943
         return array_keys(self::getUTFBOMs());
944 944
     }
945 945
     
946
-   /**
947
-    * Normalizes the slash style in a file or folder path,
948
-    * by replacing any antislashes with forward slashes.
949
-    * 
950
-    * @param string $path
951
-    * @return string
952
-    */
946
+    /**
947
+     * Normalizes the slash style in a file or folder path,
948
+     * by replacing any antislashes with forward slashes.
949
+     * 
950
+     * @param string $path
951
+     * @return string
952
+     */
953 953
     public static function normalizePath(string $path) : string
954 954
     {
955 955
         return str_replace(array('\\', '//'), array('/', '/'), $path);
@@ -982,18 +982,18 @@  discard block
 block discarded – undo
982 982
         }
983 983
     }
984 984
    
985
-   /**
986
-    * Saves the specified content to the target file, creating
987
-    * the file and the folder as necessary.
988
-    * 
989
-    * @param string $filePath
990
-    * @param string $content
991
-    * @throws FileHelper_Exception
992
-    * 
993
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
994
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
995
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
996
-    */
985
+    /**
986
+     * Saves the specified content to the target file, creating
987
+     * the file and the folder as necessary.
988
+     * 
989
+     * @param string $filePath
990
+     * @param string $content
991
+     * @throws FileHelper_Exception
992
+     * 
993
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
994
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
995
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
996
+     */
997 997
     public static function saveFile(string $filePath, string $content='') : void
998 998
     {
999 999
         // target file already exists
@@ -1046,12 +1046,12 @@  discard block
 block discarded – undo
1046 1046
         );
1047 1047
     }
1048 1048
     
1049
-   /**
1050
-    * Checks whether it is possible to run PHP command 
1051
-    * line commands.
1052
-    * 
1053
-    * @return boolean
1054
-    */
1049
+    /**
1050
+     * Checks whether it is possible to run PHP command 
1051
+     * line commands.
1052
+     * 
1053
+     * @return boolean
1054
+     */
1055 1055
     public static function canMakePHPCalls() : bool
1056 1056
     {
1057 1057
         return self::cliCommandExists('php');
@@ -1126,16 +1126,16 @@  discard block
 block discarded – undo
1126 1126
         return $result;
1127 1127
     }
1128 1128
     
1129
-   /**
1130
-    * Validates a PHP file's syntax.
1131
-    * 
1132
-    * NOTE: This will fail silently if the PHP command line
1133
-    * is not available. Use {@link FileHelper::canMakePHPCalls()}
1134
-    * to check this beforehand as needed.
1135
-    * 
1136
-    * @param string $path
1137
-    * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
1138
-    */
1129
+    /**
1130
+     * Validates a PHP file's syntax.
1131
+     * 
1132
+     * NOTE: This will fail silently if the PHP command line
1133
+     * is not available. Use {@link FileHelper::canMakePHPCalls()}
1134
+     * to check this beforehand as needed.
1135
+     * 
1136
+     * @param string $path
1137
+     * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
1138
+     */
1139 1139
     public static function checkPHPFileSyntax($path)
1140 1140
     {
1141 1141
         if(!self::canMakePHPCalls()) {
@@ -1159,14 +1159,14 @@  discard block
 block discarded – undo
1159 1159
         return $output;
1160 1160
     }
1161 1161
     
1162
-   /**
1163
-    * Retrieves the last modified date for the specified file or folder.
1164
-    * 
1165
-    * Note: If the target does not exist, returns null. 
1166
-    * 
1167
-    * @param string $path
1168
-    * @return \DateTime|NULL
1169
-    */
1162
+    /**
1163
+     * Retrieves the last modified date for the specified file or folder.
1164
+     * 
1165
+     * Note: If the target does not exist, returns null. 
1166
+     * 
1167
+     * @param string $path
1168
+     * @return \DateTime|NULL
1169
+     */
1170 1170
     public static function getModifiedDate($path)
1171 1171
     {
1172 1172
         $time = filemtime($path);
@@ -1179,22 +1179,22 @@  discard block
 block discarded – undo
1179 1179
         return null; 
1180 1180
     }
1181 1181
     
1182
-   /**
1183
-    * Retrieves the names of all subfolders in the specified path.
1184
-    * 
1185
-    * Available options:
1186
-    * 
1187
-    * - recursive: true/false
1188
-    *   Whether to search for subfolders recursively. 
1189
-    *   
1190
-    * - absolute-paths: true/false
1191
-    *   Whether to return a list of absolute paths.
1192
-    * 
1193
-    * @param string $targetFolder
1194
-    * @param array $options
1195
-    * @throws FileHelper_Exception
1196
-    * @return string[]
1197
-    */
1182
+    /**
1183
+     * Retrieves the names of all subfolders in the specified path.
1184
+     * 
1185
+     * Available options:
1186
+     * 
1187
+     * - recursive: true/false
1188
+     *   Whether to search for subfolders recursively. 
1189
+     *   
1190
+     * - absolute-paths: true/false
1191
+     *   Whether to return a list of absolute paths.
1192
+     * 
1193
+     * @param string $targetFolder
1194
+     * @param array $options
1195
+     * @throws FileHelper_Exception
1196
+     * @return string[]
1197
+     */
1198 1198
     public static function getSubfolders($targetFolder, $options = array())
1199 1199
     {
1200 1200
         if(!is_dir($targetFolder)) 
@@ -1255,16 +1255,16 @@  discard block
 block discarded – undo
1255 1255
         return $result;
1256 1256
     }
1257 1257
 
1258
-   /**
1259
-    * Retrieves the maximum allowed upload file size, in bytes.
1260
-    * Takes into account the PHP ini settings <code>post_max_size</code>
1261
-    * and <code>upload_max_filesize</code>. Since these cannot
1262
-    * be modified at runtime, they are the hard limits for uploads.
1263
-    * 
1264
-    * NOTE: Based on binary values, where 1KB = 1024 Bytes.
1265
-    * 
1266
-    * @return int Will return <code>-1</code> if no limit.
1267
-    */
1258
+    /**
1259
+     * Retrieves the maximum allowed upload file size, in bytes.
1260
+     * Takes into account the PHP ini settings <code>post_max_size</code>
1261
+     * and <code>upload_max_filesize</code>. Since these cannot
1262
+     * be modified at runtime, they are the hard limits for uploads.
1263
+     * 
1264
+     * NOTE: Based on binary values, where 1KB = 1024 Bytes.
1265
+     * 
1266
+     * @return int Will return <code>-1</code> if no limit.
1267
+     */
1268 1268
     public static function getMaxUploadFilesize() : int
1269 1269
     {
1270 1270
         static $max_size = -1;
@@ -1301,16 +1301,16 @@  discard block
 block discarded – undo
1301 1301
         return round($size);
1302 1302
     }
1303 1303
    
1304
-   /**
1305
-    * Makes a path relative using a folder depth: will reduce the
1306
-    * length of the path so that only the amount of folders defined
1307
-    * in the <code>$depth</code> attribute are shown below the actual
1308
-    * folder or file in the path.
1309
-    *  
1310
-    * @param string  $path The absolute or relative path
1311
-    * @param int $depth The folder depth to reduce the path to
1312
-    * @return string
1313
-    */
1304
+    /**
1305
+     * Makes a path relative using a folder depth: will reduce the
1306
+     * length of the path so that only the amount of folders defined
1307
+     * in the <code>$depth</code> attribute are shown below the actual
1308
+     * folder or file in the path.
1309
+     *  
1310
+     * @param string  $path The absolute or relative path
1311
+     * @param int $depth The folder depth to reduce the path to
1312
+     * @return string
1313
+     */
1314 1314
     public static function relativizePathByDepth(string $path, int $depth=2) : string
1315 1315
     {
1316 1316
         $path = self::normalizePath($path);
@@ -1348,23 +1348,23 @@  discard block
 block discarded – undo
1348 1348
         return trim(implode('/', $tokens), '/');
1349 1349
     }
1350 1350
     
1351
-   /**
1352
-    * Makes the specified path relative to another path,
1353
-    * by removing one from the other if found. Also 
1354
-    * normalizes the path to use forward slashes. 
1355
-    * 
1356
-    * Example:
1357
-    * 
1358
-    * <pre>
1359
-    * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
1360
-    * </pre>
1361
-    * 
1362
-    * Result: <code>to/file.txt</code>
1363
-    * 
1364
-    * @param string $path
1365
-    * @param string $relativeTo
1366
-    * @return string
1367
-    */
1351
+    /**
1352
+     * Makes the specified path relative to another path,
1353
+     * by removing one from the other if found. Also 
1354
+     * normalizes the path to use forward slashes. 
1355
+     * 
1356
+     * Example:
1357
+     * 
1358
+     * <pre>
1359
+     * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
1360
+     * </pre>
1361
+     * 
1362
+     * Result: <code>to/file.txt</code>
1363
+     * 
1364
+     * @param string $path
1365
+     * @param string $relativeTo
1366
+     * @return string
1367
+     */
1368 1368
     public static function relativizePath(string $path, string $relativeTo) : string
1369 1369
     {
1370 1370
         $path = self::normalizePath($path);
@@ -1376,17 +1376,17 @@  discard block
 block discarded – undo
1376 1376
         return $relative;
1377 1377
     }
1378 1378
     
1379
-   /**
1380
-    * Checks that the target file exists, and throws an exception
1381
-    * if it does not. 
1382
-    * 
1383
-    * @param string $path
1384
-    * @param int|NULL $errorCode Optional custom error code
1385
-    * @throws FileHelper_Exception
1386
-    * @return string The real path to the file
1387
-    * 
1388
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1389
-    */
1379
+    /**
1380
+     * Checks that the target file exists, and throws an exception
1381
+     * if it does not. 
1382
+     * 
1383
+     * @param string $path
1384
+     * @param int|NULL $errorCode Optional custom error code
1385
+     * @throws FileHelper_Exception
1386
+     * @return string The real path to the file
1387
+     * 
1388
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1389
+     */
1390 1390
     public static function requireFileExists(string $path, $errorCode=null) : string
1391 1391
     {
1392 1392
         $result = realpath($path);
@@ -1405,18 +1405,18 @@  discard block
 block discarded – undo
1405 1405
         );
1406 1406
     }
1407 1407
     
1408
-   /**
1409
-    * Reads a specific line number from the target file and returns its
1410
-    * contents, if the file has such a line. Does so with little memory
1411
-    * usage, as the file is not read entirely into memory.
1412
-    * 
1413
-    * @param string $path
1414
-    * @param int $lineNumber Note: 1-based; the first line is number 1.
1415
-    * @return string|NULL Will return null if the requested line does not exist.
1416
-    * @throws FileHelper_Exception
1417
-    * 
1418
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1419
-    */
1408
+    /**
1409
+     * Reads a specific line number from the target file and returns its
1410
+     * contents, if the file has such a line. Does so with little memory
1411
+     * usage, as the file is not read entirely into memory.
1412
+     * 
1413
+     * @param string $path
1414
+     * @param int $lineNumber Note: 1-based; the first line is number 1.
1415
+     * @return string|NULL Will return null if the requested line does not exist.
1416
+     * @throws FileHelper_Exception
1417
+     * 
1418
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1419
+     */
1420 1420
     public static function getLineFromFile(string $path, int $lineNumber) : ?string
1421 1421
     {
1422 1422
         self::requireFileExists($path);
@@ -1432,19 +1432,19 @@  discard block
 block discarded – undo
1432 1432
         $file->seek($targetLine);
1433 1433
         
1434 1434
         if($file->key() !== $targetLine) {
1435
-             return null;
1435
+                return null;
1436 1436
         }
1437 1437
         
1438 1438
         return $file->current(); 
1439 1439
     }
1440 1440
     
1441
-   /**
1442
-    * Retrieves the total amount of lines in the file, without 
1443
-    * reading the whole file into memory.
1444
-    * 
1445
-    * @param string $path
1446
-    * @return int
1447
-    */
1441
+    /**
1442
+     * Retrieves the total amount of lines in the file, without 
1443
+     * reading the whole file into memory.
1444
+     * 
1445
+     * @param string $path
1446
+     * @return int
1447
+     */
1448 1448
     public static function countFileLines(string $path) : int
1449 1449
     {
1450 1450
         self::requireFileExists($path);
@@ -1474,26 +1474,26 @@  discard block
 block discarded – undo
1474 1474
         return $number+1;
1475 1475
     }
1476 1476
     
1477
-   /**
1478
-    * Parses the target file to detect any PHP classes contained
1479
-    * within, and retrieve information on them. Does not use the 
1480
-    * PHP reflection API.
1481
-    * 
1482
-    * @param string $filePath
1483
-    * @return FileHelper_PHPClassInfo
1484
-    */
1477
+    /**
1478
+     * Parses the target file to detect any PHP classes contained
1479
+     * within, and retrieve information on them. Does not use the 
1480
+     * PHP reflection API.
1481
+     * 
1482
+     * @param string $filePath
1483
+     * @return FileHelper_PHPClassInfo
1484
+     */
1485 1485
     public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo
1486 1486
     {
1487 1487
         return new FileHelper_PHPClassInfo($filePath);
1488 1488
     }
1489 1489
     
1490
-   /**
1491
-    * Detects the end of line style used in the target file, if any.
1492
-    * Can be used with large files, because it only reads part of it.
1493
-    * 
1494
-    * @param string $filePath The path to the file.
1495
-    * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
1496
-    */
1490
+    /**
1491
+     * Detects the end of line style used in the target file, if any.
1492
+     * Can be used with large files, because it only reads part of it.
1493
+     * 
1494
+     * @param string $filePath The path to the file.
1495
+     * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
1496
+     */
1497 1497
     public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL
1498 1498
     {
1499 1499
         // 20 lines is enough to get a good picture of the newline style in the file.
@@ -1506,18 +1506,18 @@  discard block
 block discarded – undo
1506 1506
         return ConvertHelper::detectEOLCharacter($string);
1507 1507
     }
1508 1508
     
1509
-   /**
1510
-    * Reads the specified amount of lines from the target file.
1511
-    * Unicode BOM compatible: any byte order marker is stripped
1512
-    * from the resulting lines.
1513
-    * 
1514
-    * @param string $filePath
1515
-    * @param int $amount Set to 0 to read all lines.
1516
-    * @return array
1517
-    * 
1518
-    * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1519
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1520
-    */
1509
+    /**
1510
+     * Reads the specified amount of lines from the target file.
1511
+     * Unicode BOM compatible: any byte order marker is stripped
1512
+     * from the resulting lines.
1513
+     * 
1514
+     * @param string $filePath
1515
+     * @param int $amount Set to 0 to read all lines.
1516
+     * @return array
1517
+     * 
1518
+     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1519
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1520
+     */
1521 1521
     public static function readLines(string $filePath, int $amount=0) : array
1522 1522
     {
1523 1523
         self::requireFileExists($filePath);
@@ -1568,16 +1568,16 @@  discard block
 block discarded – undo
1568 1568
         return $result;
1569 1569
     }
1570 1570
     
1571
-   /**
1572
-    * Reads all content from a file.
1573
-    * 
1574
-    * @param string $filePath
1575
-    * @throws FileHelper_Exception
1576
-    * @return string
1577
-    * 
1578
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1579
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
1580
-    */
1571
+    /**
1572
+     * Reads all content from a file.
1573
+     * 
1574
+     * @param string $filePath
1575
+     * @throws FileHelper_Exception
1576
+     * @return string
1577
+     * 
1578
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1579
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
1580
+     */
1581 1581
     public static function readContents(string $filePath) : string
1582 1582
     {
1583 1583
         self::requireFileExists($filePath);
Please login to merge, or discard this patch.
Spacing   +112 added lines, -112 removed lines patch added patch discarded remove patch
@@ -110,7 +110,7 @@  discard block
 block discarded – undo
110 110
         
111 111
         $contents = file_get_contents($file);
112 112
         
113
-        if($contents === false) 
113
+        if ($contents === false) 
114 114
         {
115 115
             throw new FileHelper_Exception(
116 116
                 'Cannot load serialized content from file.',
@@ -124,7 +124,7 @@  discard block
 block discarded – undo
124 124
         
125 125
         $result = @unserialize($contents);
126 126
         
127
-        if($result !== false) {
127
+        if ($result !== false) {
128 128
             return $result;
129 129
         }
130 130
         
@@ -140,7 +140,7 @@  discard block
 block discarded – undo
140 140
     
141 141
     public static function deleteTree($rootFolder)
142 142
     {
143
-        if(!file_exists($rootFolder)) {
143
+        if (!file_exists($rootFolder)) {
144 144
             return true;
145 145
         }
146 146
         
@@ -181,7 +181,7 @@  discard block
 block discarded – undo
181 181
     */
182 182
     public static function createFolder($path)
183 183
     {
184
-        if(is_dir($path) || mkdir($path, 0777, true)) {
184
+        if (is_dir($path) || mkdir($path, 0777, true)) {
185 185
             return;
186 186
         }
187 187
         
@@ -216,11 +216,11 @@  discard block
 block discarded – undo
216 216
 
217 217
             if ($item->isDir()) 
218 218
             {
219
-                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName);
219
+                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target.'/'.$baseName);
220 220
             } 
221
-            else if($item->isFile()) 
221
+            else if ($item->isFile()) 
222 222
             {
223
-                self::copyFile($itemPath, $target . '/' . $baseName);
223
+                self::copyFile($itemPath, $target.'/'.$baseName);
224 224
             }
225 225
         }
226 226
     }
@@ -245,7 +245,7 @@  discard block
 block discarded – undo
245 245
     {
246 246
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
247 247
         
248
-        if(!is_readable($sourcePath))
248
+        if (!is_readable($sourcePath))
249 249
         {
250 250
             throw new FileHelper_Exception(
251 251
                 sprintf('Source file [%s] to copy is not readable.', basename($sourcePath)),
@@ -259,11 +259,11 @@  discard block
 block discarded – undo
259 259
         
260 260
         $targetFolder = dirname($targetPath);
261 261
         
262
-        if(!file_exists($targetFolder))
262
+        if (!file_exists($targetFolder))
263 263
         {
264 264
             self::createFolder($targetFolder);
265 265
         }
266
-        else if(!is_writable($targetFolder)) 
266
+        else if (!is_writable($targetFolder)) 
267 267
         {
268 268
             throw new FileHelper_Exception(
269 269
                 sprintf('Target folder [%s] is not writable.', basename($targetFolder)),
@@ -275,7 +275,7 @@  discard block
 block discarded – undo
275 275
             );
276 276
         }
277 277
         
278
-        if(copy($sourcePath, $targetPath)) {
278
+        if (copy($sourcePath, $targetPath)) {
279 279
             return;
280 280
         }
281 281
         
@@ -302,11 +302,11 @@  discard block
 block discarded – undo
302 302
     */
303 303
     public static function deleteFile(string $filePath) : void
304 304
     {
305
-        if(!file_exists($filePath)) {
305
+        if (!file_exists($filePath)) {
306 306
             return;
307 307
         }
308 308
         
309
-        if(unlink($filePath)) {
309
+        if (unlink($filePath)) {
310 310
             return;
311 311
         }
312 312
         
@@ -330,10 +330,10 @@  discard block
 block discarded – undo
330 330
     * @return \parseCSV
331 331
     * @todo Move this to the CSV helper.
332 332
     */
333
-    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
333
+    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : \parseCSV
334 334
     {
335
-        if($delimiter==='') { $delimiter = ';'; }
336
-        if($enclosure==='') { $enclosure = '"'; }
335
+        if ($delimiter === '') { $delimiter = ';'; }
336
+        if ($enclosure === '') { $enclosure = '"'; }
337 337
         
338 338
         $parser = new \parseCSV(null, null, null, array());
339 339
 
@@ -361,11 +361,11 @@  discard block
 block discarded – undo
361 361
     * @see parseCSVFile()
362 362
     * @see FileHelper::ERROR_PARSING_CSV
363 363
     */
364
-    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
364
+    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
365 365
     {
366 366
         $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading);
367 367
         $result = $parser->parse_string(/** @scrutinizer ignore-type */ $csv);
368
-        if(is_array($result)) {
368
+        if (is_array($result)) {
369 369
             return $result;
370 370
         }
371 371
         
@@ -393,7 +393,7 @@  discard block
 block discarded – undo
393 393
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
394 394
      * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
395 395
      */
396
-    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
396
+    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
397 397
     {
398 398
         $content = self::readContents($filePath);
399 399
 
@@ -410,7 +410,7 @@  discard block
 block discarded – undo
410 410
     public static function detectMimeType(string $fileName) : ?string
411 411
     {
412 412
         $ext = self::getExtension($fileName);
413
-        if(empty($ext)) {
413
+        if (empty($ext)) {
414 414
             return null;
415 415
         }
416 416
 
@@ -434,11 +434,11 @@  discard block
 block discarded – undo
434 434
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
435 435
      * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE
436 436
      */
437
-    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true, bool $exit=true)
437
+    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true, bool $exit = true)
438 438
     {
439 439
         self::requireFileExists($filePath);
440 440
         
441
-        if(empty($fileName)) {
441
+        if (empty($fileName)) {
442 442
             $fileName = basename($filePath);
443 443
         }
444 444
 
@@ -456,10 +456,10 @@  discard block
 block discarded – undo
456 456
         
457 457
         header("Cache-Control: public", true);
458 458
         header("Content-Description: File Transfer", true);
459
-        header("Content-Type: " . $mime, true);
459
+        header("Content-Type: ".$mime, true);
460 460
 
461 461
         $disposition = 'inline';
462
-        if($asAttachment) {
462
+        if ($asAttachment) {
463 463
             $disposition = 'attachment';
464 464
         }
465 465
         
@@ -471,7 +471,7 @@  discard block
 block discarded – undo
471 471
         
472 472
         readfile($filePath);
473 473
         
474
-        if($exit) 
474
+        if ($exit) 
475 475
         {
476 476
             exit;
477 477
         }
@@ -490,7 +490,7 @@  discard block
 block discarded – undo
490 490
      */
491 491
     public static function downloadFile($url)
492 492
     {
493
-        if(!function_exists('curl_init')) 
493
+        if (!function_exists('curl_init')) 
494 494
         {
495 495
             throw new FileHelper_Exception(
496 496
                 'The cURL extension is not installed.',
@@ -500,7 +500,7 @@  discard block
 block discarded – undo
500 500
         }
501 501
 
502 502
         $ch = curl_init();
503
-        if($ch === false) 
503
+        if ($ch === false) 
504 504
         {
505 505
             throw new FileHelper_Exception(
506 506
                 'Could not initialize a new cURL instance.',
@@ -521,7 +521,7 @@  discard block
 block discarded – undo
521 521
         
522 522
         $output = curl_exec($ch);
523 523
 
524
-        if($output === false) {
524
+        if ($output === false) {
525 525
             throw new FileHelper_Exception(
526 526
                 'Unable to open URL',
527 527
                 sprintf(
@@ -535,7 +535,7 @@  discard block
 block discarded – undo
535 535
 
536 536
         curl_close($ch);
537 537
 
538
-        if(is_string($output)) 
538
+        if (is_string($output)) 
539 539
         {
540 540
             return $output;
541 541
         }
@@ -557,7 +557,7 @@  discard block
 block discarded – undo
557 557
     */
558 558
     public static function isPHPFile($pathOrDirIterator)
559 559
     {
560
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
560
+    	if (self::getExtension($pathOrDirIterator) == 'php') {
561 561
     		return true;
562 562
     	}
563 563
     	
@@ -574,14 +574,14 @@  discard block
 block discarded – undo
574 574
     */
575 575
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
576 576
     {
577
-        if($pathOrDirIterator instanceof \DirectoryIterator) {
577
+        if ($pathOrDirIterator instanceof \DirectoryIterator) {
578 578
             $filename = $pathOrDirIterator->getFilename();
579 579
         } else {
580 580
             $filename = basename($pathOrDirIterator);
581 581
         }
582 582
          
583 583
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
584
-        if($lowercase) {
584
+        if ($lowercase) {
585 585
         	$ext = mb_strtolower($ext);
586 586
         }
587 587
         
@@ -603,13 +603,13 @@  discard block
 block discarded – undo
603 603
     public static function getFilename($pathOrDirIterator, $extension = true)
604 604
     {
605 605
         $path = $pathOrDirIterator;
606
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
606
+    	if ($pathOrDirIterator instanceof \DirectoryIterator) {
607 607
     		$path = $pathOrDirIterator->getFilename();
608 608
     	}
609 609
     	
610 610
     	$path = self::normalizePath($path);
611 611
     	
612
-    	if(!$extension) {
612
+    	if (!$extension) {
613 613
     	    return pathinfo($path, PATHINFO_FILENAME);
614 614
     	}
615 615
     	
@@ -627,12 +627,12 @@  discard block
 block discarded – undo
627 627
     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
628 628
     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
629 629
     */ 
630
-    public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
630
+    public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null)
631 631
     {
632 632
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
633 633
         
634 634
         $content = file_get_contents($file);
635
-        if(!$content) {
635
+        if (!$content) {
636 636
             throw new FileHelper_Exception(
637 637
                 'Cannot get file contents',
638 638
                 sprintf(
@@ -643,12 +643,12 @@  discard block
 block discarded – undo
643 643
             );
644 644
         }
645 645
         
646
-        if(isset($targetEncoding)) {
646
+        if (isset($targetEncoding)) {
647 647
             $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding);
648 648
         }
649 649
         
650 650
         $json = json_decode($content, true);
651
-        if($json === false || $json === NULL) {
651
+        if ($json === false || $json === NULL) {
652 652
             throw new FileHelper_Exception(
653 653
                 'Cannot decode json data',
654 654
                 sprintf(
@@ -688,13 +688,13 @@  discard block
 block discarded – undo
688 688
         
689 689
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
690 690
         
691
-        while(strstr($name, '  ')) {
691
+        while (strstr($name, '  ')) {
692 692
             $name = str_replace('  ', ' ', $name);
693 693
         }
694 694
 
695 695
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
696 696
         
697
-        while(strstr($name, '..')) {
697
+        while (strstr($name, '..')) {
698 698
             $name = str_replace('..', '.', $name);
699 699
         }
700 700
         
@@ -724,7 +724,7 @@  discard block
 block discarded – undo
724 724
     * 
725 725
     * @todo Convert this to use the file finder.
726 726
     */
727
-    public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
727
+    public static function findHTMLFiles(string $targetFolder, array $options = array()) : array
728 728
     {
729 729
         return self::findFiles($targetFolder, array('html'), $options);
730 730
     }
@@ -739,7 +739,7 @@  discard block
 block discarded – undo
739 739
     * 
740 740
     * @todo Convert this to use the file finder.
741 741
     */
742
-    public static function findPHPFiles(string $targetFolder, array $options=array()) : array
742
+    public static function findPHPFiles(string $targetFolder, array $options = array()) : array
743 743
     {
744 744
         return self::findFiles($targetFolder, array('php'), $options);
745 745
     }
@@ -755,39 +755,39 @@  discard block
 block discarded – undo
755 755
     * @deprecated Will be replaced by the file finder in the future.
756 756
     * @see FileHelper::createFileFinder()
757 757
     */
758
-    public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
758
+    public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array
759 759
     {
760
-        if(!isset($options['strip-extension'])) {
760
+        if (!isset($options['strip-extension'])) {
761 761
             $options['strip-extension'] = false;
762 762
         }
763 763
         
764
-        if(!isset($options['absolute-path'])) {
764
+        if (!isset($options['absolute-path'])) {
765 765
             $options['absolute-path'] = false;
766 766
         } 
767 767
         
768
-        if(!isset($options['relative-path'])) {
768
+        if (!isset($options['relative-path'])) {
769 769
             $options['relative-path'] = false;
770 770
         }
771 771
         
772
-        if(!isset($options['recursive'])) {
772
+        if (!isset($options['recursive'])) {
773 773
             $options['recursive'] = false;
774 774
         }
775 775
         
776
-        if($options['relative-path']) {
776
+        if ($options['relative-path']) {
777 777
             $options['absolute-path'] = true;
778 778
         }
779 779
         
780
-        if(!isset($options['__root'])) {
780
+        if (!isset($options['__root'])) {
781 781
             $options['__root'] = self::normalizePath($targetFolder);
782 782
         }
783 783
         
784 784
         $checkExtensions = false;
785
-        if(!empty($extensions)) {
785
+        if (!empty($extensions)) {
786 786
             $checkExtensions = true;
787 787
             $extensions = array_map('strtolower', $extensions);
788 788
         }
789 789
         
790
-        if(!is_dir($targetFolder)) 
790
+        if (!is_dir($targetFolder)) 
791 791
         {
792 792
             throw new FileHelper_Exception(
793 793
                 'Target folder does not exist',
@@ -800,32 +800,32 @@  discard block
 block discarded – undo
800 800
         }
801 801
         
802 802
         $d = new \DirectoryIterator($targetFolder);
803
-        foreach($d as $item) {
804
-            if($item->isDot()) {
803
+        foreach ($d as $item) {
804
+            if ($item->isDot()) {
805 805
                 continue;
806 806
             }
807 807
             
808
-            if($item->isDir()) {
809
-                if($options['recursive']) {
808
+            if ($item->isDir()) {
809
+                if ($options['recursive']) {
810 810
                     $files = self::findFiles($item->getPathname(), $extensions, $options, $files);
811 811
                 }
812 812
                 continue;
813 813
             }
814 814
             
815
-            if($checkExtensions && !in_array(self::getExtension($item, true), $extensions)) {
815
+            if ($checkExtensions && !in_array(self::getExtension($item, true), $extensions)) {
816 816
                 continue;
817 817
             }
818 818
             
819 819
             $filename = $item->getFilename();
820
-            if($options['strip-extension']) {
820
+            if ($options['strip-extension']) {
821 821
                 $filename = self::removeExtension($filename);
822 822
             }
823 823
             
824
-            if($options['absolute-path']) {
824
+            if ($options['absolute-path']) {
825 825
                 $filename = self::normalizePath($targetFolder.'/'.$filename);
826 826
             }
827 827
             
828
-            if($options['relative-path']) {
828
+            if ($options['relative-path']) {
829 829
                 $filename = ltrim(str_replace($options['__root'], '', $filename), '/');
830 830
             }
831 831
             
@@ -873,9 +873,9 @@  discard block
 block discarded – undo
873 873
         fclose($fp);
874 874
 
875 875
         $boms = self::getUTFBOMs();
876
-        foreach($boms as $bom => $value) {
876
+        foreach ($boms as $bom => $value) {
877 877
             $length = mb_strlen($value);
878
-            if(mb_substr($text, 0, $length) == $value) {
878
+            if (mb_substr($text, 0, $length) == $value) {
879 879
                 return $bom;
880 880
             }
881 881
         }
@@ -894,13 +894,13 @@  discard block
 block discarded – undo
894 894
     */
895 895
     public static function getUTFBOMs()
896 896
     {
897
-        if(!isset(self::$utfBoms)) {
897
+        if (!isset(self::$utfBoms)) {
898 898
             self::$utfBoms = array(
899
-                'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF),
900
-                'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00),
901
-                'UTF16-BE' => chr(0xFE) . chr(0xFF),
902
-                'UTF16-LE' => chr(0xFF) . chr(0xFE),
903
-                'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF)
899
+                'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF),
900
+                'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00),
901
+                'UTF16-BE' => chr(0xFE).chr(0xFF),
902
+                'UTF16-LE' => chr(0xFF).chr(0xFE),
903
+                'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF)
904 904
             );
905 905
         }
906 906
         
@@ -921,7 +921,7 @@  discard block
 block discarded – undo
921 921
         $encodings = self::getKnownUnicodeEncodings();
922 922
 
923 923
         $keep = array();
924
-        foreach($encodings as $string) 
924
+        foreach ($encodings as $string) 
925 925
         {
926 926
             $withHyphen = str_replace('UTF', 'UTF-', $string);
927 927
             
@@ -955,15 +955,15 @@  discard block
 block discarded – undo
955 955
         return str_replace(array('\\', '//'), array('/', '/'), $path);
956 956
     }
957 957
     
958
-    public static function saveAsJSON($data, $file, $pretty=false)
958
+    public static function saveAsJSON($data, $file, $pretty = false)
959 959
     {
960 960
         $options = null;
961
-        if($pretty) {
961
+        if ($pretty) {
962 962
             $options = JSON_PRETTY_PRINT;
963 963
         }
964 964
         
965 965
         $json = json_encode($data, $options);
966
-        if($json===false) 
966
+        if ($json === false) 
967 967
         {
968 968
             $errorCode = json_last_error();
969 969
             throw new FileHelper_Exception(
@@ -973,7 +973,7 @@  discard block
 block discarded – undo
973 973
             ); 
974 974
         }
975 975
         
976
-        if(!file_put_contents($file, $json)) {
976
+        if (!file_put_contents($file, $json)) {
977 977
             throw new FileHelper_Exception(
978 978
                 sprintf('Could not write the JSON file [%s] to disk.', basename($file)),
979 979
                 sprintf('Full path: [%s].', $file),
@@ -994,12 +994,12 @@  discard block
 block discarded – undo
994 994
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
995 995
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
996 996
     */
997
-    public static function saveFile(string $filePath, string $content='') : void
997
+    public static function saveFile(string $filePath, string $content = '') : void
998 998
     {
999 999
         // target file already exists
1000
-        if(file_exists($filePath))
1000
+        if (file_exists($filePath))
1001 1001
         {
1002
-            if(!is_writable($filePath))
1002
+            if (!is_writable($filePath))
1003 1003
             {
1004 1004
                 throw new FileHelper_Exception(
1005 1005
                     sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)),
@@ -1019,7 +1019,7 @@  discard block
 block discarded – undo
1019 1019
             // create the folder as needed
1020 1020
             self::createFolder($targetFolder);
1021 1021
             
1022
-            if(!is_writable($targetFolder)) 
1022
+            if (!is_writable($targetFolder)) 
1023 1023
             {
1024 1024
                 throw new FileHelper_Exception(
1025 1025
                     sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)),
@@ -1032,7 +1032,7 @@  discard block
 block discarded – undo
1032 1032
             }
1033 1033
         }
1034 1034
         
1035
-        if(file_put_contents($filePath, $content) !== false) {
1035
+        if (file_put_contents($filePath, $content) !== false) {
1036 1036
             return;
1037 1037
         }
1038 1038
         
@@ -1068,7 +1068,7 @@  discard block
 block discarded – undo
1068 1068
     {
1069 1069
         static $checked = array();
1070 1070
         
1071
-        if(isset($checked[$command])) {
1071
+        if (isset($checked[$command])) {
1072 1072
             return $checked[$command];
1073 1073
         }
1074 1074
         
@@ -1081,7 +1081,7 @@  discard block
 block discarded – undo
1081 1081
         
1082 1082
         $os = strtolower(PHP_OS_FAMILY);
1083 1083
         
1084
-        if(!isset($osCommands[$os])) 
1084
+        if (!isset($osCommands[$os])) 
1085 1085
         {
1086 1086
             throw new FileHelper_Exception(
1087 1087
                 'Unsupported OS for CLI commands',
@@ -1107,7 +1107,7 @@  discard block
 block discarded – undo
1107 1107
             $pipes
1108 1108
         );
1109 1109
         
1110
-        if($process === false) {
1110
+        if ($process === false) {
1111 1111
             $checked[$command] = false;
1112 1112
             return false;
1113 1113
         }
@@ -1138,7 +1138,7 @@  discard block
 block discarded – undo
1138 1138
     */
1139 1139
     public static function checkPHPFileSyntax($path)
1140 1140
     {
1141
-        if(!self::canMakePHPCalls()) {
1141
+        if (!self::canMakePHPCalls()) {
1142 1142
             return true;
1143 1143
         }
1144 1144
         
@@ -1149,7 +1149,7 @@  discard block
 block discarded – undo
1149 1149
         // when the validation is successful, the first entry
1150 1150
         // in the array contains the success message. When it
1151 1151
         // is invalid, the first entry is always empty.
1152
-        if(!empty($output[0])) {
1152
+        if (!empty($output[0])) {
1153 1153
             return true;
1154 1154
         }
1155 1155
         
@@ -1170,7 +1170,7 @@  discard block
 block discarded – undo
1170 1170
     public static function getModifiedDate($path)
1171 1171
     {
1172 1172
         $time = filemtime($path);
1173
-        if($time !== false) {
1173
+        if ($time !== false) {
1174 1174
             $date = new \DateTime();
1175 1175
             $date->setTimestamp($time);
1176 1176
             return $date;
@@ -1197,7 +1197,7 @@  discard block
 block discarded – undo
1197 1197
     */
1198 1198
     public static function getSubfolders($targetFolder, $options = array())
1199 1199
     {
1200
-        if(!is_dir($targetFolder)) 
1200
+        if (!is_dir($targetFolder)) 
1201 1201
         {
1202 1202
             throw new FileHelper_Exception(
1203 1203
                 'Target folder does not exist',
@@ -1221,29 +1221,29 @@  discard block
 block discarded – undo
1221 1221
         
1222 1222
         $d = new \DirectoryIterator($targetFolder);
1223 1223
         
1224
-        foreach($d as $item) 
1224
+        foreach ($d as $item) 
1225 1225
         {
1226
-            if($item->isDir() && !$item->isDot()) 
1226
+            if ($item->isDir() && !$item->isDot()) 
1227 1227
             {
1228 1228
                 $name = $item->getFilename();
1229 1229
                 
1230
-                if(!$options['absolute-path']) {
1230
+                if (!$options['absolute-path']) {
1231 1231
                     $result[] = $name;
1232 1232
                 } else {
1233 1233
                     $result[] = $targetFolder.'/'.$name;
1234 1234
                 }
1235 1235
                 
1236
-                if(!$options['recursive']) 
1236
+                if (!$options['recursive']) 
1237 1237
                 {
1238 1238
                     continue;
1239 1239
                 }
1240 1240
                 
1241 1241
                 $subs = self::getSubfolders($targetFolder.'/'.$name, $options);
1242
-                foreach($subs as $sub) 
1242
+                foreach ($subs as $sub) 
1243 1243
                 {
1244 1244
                     $relative = $name.'/'.$sub;
1245 1245
                     
1246
-                    if(!$options['absolute-path']) {
1246
+                    if (!$options['absolute-path']) {
1247 1247
                         $result[] = $relative;
1248 1248
                     } else {
1249 1249
                         $result[] = $targetFolder.'/'.$relative;
@@ -1311,7 +1311,7 @@  discard block
 block discarded – undo
1311 1311
     * @param int $depth The folder depth to reduce the path to
1312 1312
     * @return string
1313 1313
     */
1314
-    public static function relativizePathByDepth(string $path, int $depth=2) : string
1314
+    public static function relativizePathByDepth(string $path, int $depth = 2) : string
1315 1315
     {
1316 1316
         $path = self::normalizePath($path);
1317 1317
         
@@ -1319,17 +1319,17 @@  discard block
 block discarded – undo
1319 1319
         $tokens = array_filter($tokens); // remove empty entries (trailing slash for example)
1320 1320
         $tokens = array_values($tokens); // re-index keys
1321 1321
         
1322
-        if(empty($tokens)) {
1322
+        if (empty($tokens)) {
1323 1323
             return '';
1324 1324
         }
1325 1325
         
1326 1326
         // remove the drive if present
1327
-        if(strstr($tokens[0], ':')) {
1327
+        if (strstr($tokens[0], ':')) {
1328 1328
             array_shift($tokens);
1329 1329
         }
1330 1330
         
1331 1331
         // path was only the drive
1332
-        if(count($tokens) == 0) {
1332
+        if (count($tokens) == 0) {
1333 1333
             return '';
1334 1334
         }
1335 1335
 
@@ -1338,8 +1338,8 @@  discard block
 block discarded – undo
1338 1338
         
1339 1339
         // reduce the path to the specified depth
1340 1340
         $length = count($tokens);
1341
-        if($length > $depth) {
1342
-            $tokens = array_slice($tokens, $length-$depth);
1341
+        if ($length > $depth) {
1342
+            $tokens = array_slice($tokens, $length - $depth);
1343 1343
         }
1344 1344
 
1345 1345
         // append the last element again
@@ -1387,14 +1387,14 @@  discard block
 block discarded – undo
1387 1387
     * 
1388 1388
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1389 1389
     */
1390
-    public static function requireFileExists(string $path, $errorCode=null) : string
1390
+    public static function requireFileExists(string $path, $errorCode = null) : string
1391 1391
     {
1392 1392
         $result = realpath($path);
1393
-        if($result !== false) {
1393
+        if ($result !== false) {
1394 1394
             return $result;
1395 1395
         }
1396 1396
         
1397
-        if($errorCode === null) {
1397
+        if ($errorCode === null) {
1398 1398
             $errorCode = self::ERROR_FILE_DOES_NOT_EXIST;
1399 1399
         }
1400 1400
         
@@ -1423,15 +1423,15 @@  discard block
 block discarded – undo
1423 1423
         
1424 1424
         $file = new \SplFileObject($path);
1425 1425
         
1426
-        if($file->eof()) {
1426
+        if ($file->eof()) {
1427 1427
             return '';
1428 1428
         }
1429 1429
         
1430
-        $targetLine = $lineNumber-1;
1430
+        $targetLine = $lineNumber - 1;
1431 1431
         
1432 1432
         $file->seek($targetLine);
1433 1433
         
1434
-        if($file->key() !== $targetLine) {
1434
+        if ($file->key() !== $targetLine) {
1435 1435
              return null;
1436 1436
         }
1437 1437
         
@@ -1457,7 +1457,7 @@  discard block
 block discarded – undo
1457 1457
         $number = $spl->key();
1458 1458
         
1459 1459
         // if seeking to the end the cursor is still at 0, there are no lines. 
1460
-        if($number === 0) 
1460
+        if ($number === 0) 
1461 1461
         {
1462 1462
             // since it's a very small file, to get reliable results,
1463 1463
             // we read its contents and use that to determine what
@@ -1465,13 +1465,13 @@  discard block
 block discarded – undo
1465 1465
             // that this is not pactical to solve with the SplFileObject.
1466 1466
             $content = file_get_contents($path);
1467 1467
             
1468
-            if(empty($content)) {
1468
+            if (empty($content)) {
1469 1469
                 return 0;
1470 1470
             }
1471 1471
         }
1472 1472
         
1473 1473
         // return the line number we were able to reach + 1 (key is zero-based)
1474
-        return $number+1;
1474
+        return $number + 1;
1475 1475
     }
1476 1476
     
1477 1477
    /**
@@ -1518,13 +1518,13 @@  discard block
 block discarded – undo
1518 1518
     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1519 1519
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1520 1520
     */
1521
-    public static function readLines(string $filePath, int $amount=0) : array
1521
+    public static function readLines(string $filePath, int $amount = 0) : array
1522 1522
     {
1523 1523
         self::requireFileExists($filePath);
1524 1524
         
1525 1525
         $fn = fopen($filePath, "r");
1526 1526
         
1527
-        if($fn === false) 
1527
+        if ($fn === false) 
1528 1528
         {
1529 1529
             throw new FileHelper_Exception(
1530 1530
                 'Could not open file for reading.',
@@ -1540,25 +1540,25 @@  discard block
 block discarded – undo
1540 1540
         $counter = 0;
1541 1541
         $first = true;
1542 1542
         
1543
-        while(!feof($fn)) 
1543
+        while (!feof($fn)) 
1544 1544
         {
1545 1545
             $counter++;
1546 1546
             
1547 1547
             $line = fgets($fn);
1548 1548
             
1549 1549
             // can happen with zero length files
1550
-            if($line === false) {
1550
+            if ($line === false) {
1551 1551
                 continue;
1552 1552
             }
1553 1553
             
1554 1554
             // the first line may contain a unicode BOM marker.
1555
-            if($first) {
1555
+            if ($first) {
1556 1556
                 $line = ConvertHelper::stripUTFBom($line);
1557 1557
             }
1558 1558
             
1559 1559
             $result[] = $line;
1560 1560
             
1561
-            if($amount > 0 && $counter == $amount) {
1561
+            if ($amount > 0 && $counter == $amount) {
1562 1562
                 break;
1563 1563
             }
1564 1564
         }
@@ -1584,7 +1584,7 @@  discard block
 block discarded – undo
1584 1584
         
1585 1585
         $result = file_get_contents($filePath);
1586 1586
         
1587
-        if($result !== false) {
1587
+        if ($result !== false) {
1588 1588
             return $result;
1589 1589
         }
1590 1590
         
Please login to merge, or discard this patch.
examples/URLInfo/highlighting.php 2 patches
Indentation   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -7,9 +7,9 @@
 block discarded – undo
7 7
  * @author Sebastian Mordziol <[email protected]>
8 8
  */
9 9
 
10
-   /**
11
-    * Examples environment config
12
-    */
10
+    /**
11
+     * Examples environment config
12
+     */
13 13
     require_once '../prepend.php';
14 14
 
15 15
     use function AppUtils\parseURL;
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -42,7 +42,7 @@
 block discarded – undo
42 42
 		<br>
43 43
         <?php
44 44
         
45
-            foreach($urls as $url)
45
+            foreach ($urls as $url)
46 46
             {
47 47
                 $info = parseURL($url);
48 48
                 
Please login to merge, or discard this patch.
examples/prepend.php 2 patches
Indentation   +15 added lines, -15 removed lines patch added patch discarded remove patch
@@ -17,33 +17,33 @@
 block discarded – undo
17 17
         die('<b>ERROR:</b> Autoloader not present. Run composer update first.');
18 18
     }
19 19
     
20
-   /**
21
-    * The composer autoloader
22
-    */
20
+    /**
21
+     * The composer autoloader
22
+     */
23 23
     require_once $autoload;
24 24
 
25
-   /**
26
-    * Translation global function.
27
-    * @return string
28
-    */
25
+    /**
26
+     * Translation global function.
27
+     * @return string
28
+     */
29 29
     function t()
30 30
     {
31 31
         return call_user_func_array('\AppLocalize\t', func_get_args());
32 32
     }
33 33
     
34
-   /**
35
-    * Translation global function.
36
-    * @return string
37
-    */
34
+    /**
35
+     * Translation global function.
36
+     * @return string
37
+     */
38 38
     function pt()
39 39
     {
40 40
         return call_user_func_array('\AppLocalize\pt', func_get_args());
41 41
     }
42 42
     
43
-   /**
44
-    * Translation global function.
45
-    * @return string
46
-    */
43
+    /**
44
+     * Translation global function.
45
+     * @return string
46
+     */
47 47
     function pts()
48 48
     {
49 49
         return call_user_func_array('\AppLocalize\pts', func_get_args());
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -12,7 +12,7 @@
 block discarded – undo
12 12
     $autoload = realpath($root.'/../vendor/autoload.php');
13 13
     
14 14
     // we need the autoloader to be present
15
-    if($autoload === false) 
15
+    if ($autoload === false) 
16 16
     {
17 17
         die('<b>ERROR:</b> Autoloader not present. Run composer update first.');
18 18
     }
Please login to merge, or discard this patch.
src/CSVHelper.php 2 patches
Indentation   +130 added lines, -130 removed lines patch added patch discarded remove patch
@@ -50,20 +50,20 @@  discard block
 block discarded – undo
50 50
         
51 51
     }
52 52
 
53
-   /**
54
-    * Creates and returns a new instance of the CSV builder which
55
-    * can be used to build CSV from scratch.
56
-    * 
57
-    * @return CSVHelper_Builder
58
-    */
53
+    /**
54
+     * Creates and returns a new instance of the CSV builder which
55
+     * can be used to build CSV from scratch.
56
+     * 
57
+     * @return CSVHelper_Builder
58
+     */
59 59
     public static function createBuilder()
60 60
     {
61 61
         return new CSVHelper_Builder();
62 62
     }
63 63
 
64
-   /**
65
-    * @var string
66
-    */
64
+    /**
65
+     * @var string
66
+     */
67 67
     protected $csv = '';
68 68
     
69 69
     protected $data = array();
@@ -72,16 +72,16 @@  discard block
 block discarded – undo
72 72
     
73 73
     protected $headersPosition = self::HEADERS_NONE;
74 74
     
75
-   /**
76
-    * Loads CSV data from a string. 
77
-    * 
78
-    * Note: Use the {@link hasErrors()} method to 
79
-    * check if the string could be parsed correctly
80
-    * afterwards.
81
-    * 
82
-    * @param string $string
83
-    * @return CSVHelper
84
-    */
75
+    /**
76
+     * Loads CSV data from a string. 
77
+     * 
78
+     * Note: Use the {@link hasErrors()} method to 
79
+     * check if the string could be parsed correctly
80
+     * afterwards.
81
+     * 
82
+     * @param string $string
83
+     * @return CSVHelper
84
+     */
85 85
     public function loadString($string)
86 86
     {
87 87
         // remove any UTF byte order marks that may still be present in the string
@@ -95,20 +95,20 @@  discard block
 block discarded – undo
95 95
         return $this;
96 96
     }
97 97
     
98
-   /**
99
-    * Loads CSV data from a file.
100
-    * 
101
-    * Note: Use the {@link hasErrors()} method to 
102
-    * check if the string could be parsed correctly
103
-    * afterwards.
104
-    * 
105
-    * @param string $file
106
-    * @throws FileHelper_Exception
107
-    * @return CSVHelper
108
-    * 
109
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
110
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
111
-    */
98
+    /**
99
+     * Loads CSV data from a file.
100
+     * 
101
+     * Note: Use the {@link hasErrors()} method to 
102
+     * check if the string could be parsed correctly
103
+     * afterwards.
104
+     * 
105
+     * @param string $file
106
+     * @throws FileHelper_Exception
107
+     * @return CSVHelper
108
+     * 
109
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
110
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
111
+     */
112 112
     public function loadFile(string $file) : CSVHelper
113 113
     {
114 114
         $csv = FileHelper::readContents($file);
@@ -122,28 +122,28 @@  discard block
 block discarded – undo
122 122
     
123 123
     protected $rowCount = 0;
124 124
     
125
-   /**
126
-    * Specifies that headers are positioned on top, horizontally.
127
-    * @return CSVHelper
128
-    */
125
+    /**
126
+     * Specifies that headers are positioned on top, horizontally.
127
+     * @return CSVHelper
128
+     */
129 129
     public function setHeadersTop()
130 130
     {
131 131
         return $this->setHeadersPosition(self::HEADERS_TOP);
132 132
     }
133 133
     
134
-   /**
135
-    * Specifies that headers are positioned on the left, vertically.
136
-    * @return CSVHelper
137
-    */
134
+    /**
135
+     * Specifies that headers are positioned on the left, vertically.
136
+     * @return CSVHelper
137
+     */
138 138
     public function setHeadersLeft()
139 139
     {
140 140
         return $this->setHeadersPosition(self::HEADERS_LEFT);
141 141
     }
142 142
     
143
-   /**
144
-    * Specifies that there are no headers in the file (default).
145
-    * @return CSVHelper
146
-    */
143
+    /**
144
+     * Specifies that there are no headers in the file (default).
145
+     * @return CSVHelper
146
+     */
147 147
     public function setHeadersNone()
148 148
     {
149 149
         return $this->setHeadersPosition(self::HEADERS_NONE);
@@ -173,18 +173,18 @@  discard block
 block discarded – undo
173 173
         return false;
174 174
     }
175 175
     
176
-   /**
177
-    * Specifies where the headers are positioned in the
178
-    * CSV, or turns them off entirely. Use the class constants
179
-    * to ensure the value is correct.
180
-    * 
181
-    * @param string $position
182
-    * @throws CSVHelper_Exception
183
-    * @return CSVHelper
184
-    * @see CSVHelper::HEADERS_LEFT
185
-    * @see CSVHelper::HEADERS_TOP
186
-    * @see CSVHelper::HEADERS_NONE
187
-    */
176
+    /**
177
+     * Specifies where the headers are positioned in the
178
+     * CSV, or turns them off entirely. Use the class constants
179
+     * to ensure the value is correct.
180
+     * 
181
+     * @param string $position
182
+     * @throws CSVHelper_Exception
183
+     * @return CSVHelper
184
+     * @see CSVHelper::HEADERS_LEFT
185
+     * @see CSVHelper::HEADERS_TOP
186
+     * @see CSVHelper::HEADERS_NONE
187
+     */
188 188
     public function setHeadersPosition($position)
189 189
     {
190 190
         $validPositions = array(
@@ -211,13 +211,13 @@  discard block
 block discarded – undo
211 211
         return $this;
212 212
     }
213 213
     
214
-   /**
215
-    * Resets all internal data, allowing to start entirely anew
216
-    * with a new file, or to start building a new CSV file from
217
-    * scratch.
218
-    * 
219
-    * @return CSVHelper
220
-    */
214
+    /**
215
+     * Resets all internal data, allowing to start entirely anew
216
+     * with a new file, or to start building a new CSV file from
217
+     * scratch.
218
+     * 
219
+     * @return CSVHelper
220
+     */
221 221
     public function reset()
222 222
     {
223 223
         $this->data = array();
@@ -234,19 +234,19 @@  discard block
 block discarded – undo
234 234
         return $this->data;
235 235
     }
236 236
     
237
-   /**
238
-    * Retrieves the row at the specified index.
239
-    * If there is no data at the index, this will
240
-    * return an array populated with empty strings
241
-    * for all available columns.
242
-    * 
243
-    * Tip: Use the {@link rowExists()} method to check
244
-    * whether the specified row exists.
245
-    * 
246
-    * @param integer $index
247
-    * @return array()
248
-    * @see rowExists()
249
-    */
237
+    /**
238
+     * Retrieves the row at the specified index.
239
+     * If there is no data at the index, this will
240
+     * return an array populated with empty strings
241
+     * for all available columns.
242
+     * 
243
+     * Tip: Use the {@link rowExists()} method to check
244
+     * whether the specified row exists.
245
+     * 
246
+     * @param integer $index
247
+     * @return array()
248
+     * @see rowExists()
249
+     */
250 250
     public function getRow($index)
251 251
     {
252 252
         if(isset($this->data[$index])) {
@@ -256,63 +256,63 @@  discard block
 block discarded – undo
256 256
         return array_fill(0, $this->rowCount, '');
257 257
     }
258 258
     
259
-   /**
260
-    * Checks whether the specified row exists in the data set.
261
-    * @param integer $index
262
-    * @return boolean
263
-    */
259
+    /**
260
+     * Checks whether the specified row exists in the data set.
261
+     * @param integer $index
262
+     * @return boolean
263
+     */
264 264
     public function rowExists($index)
265 265
     {
266 266
         return isset($this->data[$index]);
267 267
     }
268 268
     
269
-   /**
270
-    * Counts the amount of rows in the parsed CSV,
271
-    * excluding the headers if any, depending on 
272
-    * their position.
273
-    * 
274
-    * @return integer
275
-    */
269
+    /**
270
+     * Counts the amount of rows in the parsed CSV,
271
+     * excluding the headers if any, depending on 
272
+     * their position.
273
+     * 
274
+     * @return integer
275
+     */
276 276
     public function countRows()
277 277
     {
278 278
         return $this->rowCount;
279 279
     }
280 280
     
281
-   /**
282
-    * Counts the amount of rows in the parsed CSV, 
283
-    * excluding the headers if any, depending on
284
-    * their position.
285
-    * 
286
-    * @return integer
287
-    */
281
+    /**
282
+     * Counts the amount of rows in the parsed CSV, 
283
+     * excluding the headers if any, depending on
284
+     * their position.
285
+     * 
286
+     * @return integer
287
+     */
288 288
     public function countColumns()
289 289
     {
290 290
         return $this->columnCount;
291 291
     }
292 292
     
293
-   /**
294
-    * Retrieves the headers, if any. Specify the position of the
295
-    * headers first to ensure this works correctly.
296
-    * 
297
-    * @return array Indexed array with header names.
298
-    */
293
+    /**
294
+     * Retrieves the headers, if any. Specify the position of the
295
+     * headers first to ensure this works correctly.
296
+     * 
297
+     * @return array Indexed array with header names.
298
+     */
299 299
     public function getHeaders()
300 300
     {
301 301
         return $this->headers;
302 302
     }
303 303
     
304
-   /**
305
-    * Retrieves the column at the specified index. If there
306
-    * is no column at the index, this returns an array
307
-    * populated with empty strings.
308
-    * 
309
-    * Tip: Use the {@link columnExists()} method to check
310
-    * whether a column exists.
311
-    * 
312
-    * @param integer $index
313
-    * @return string[]
314
-    * @see columnExists()
315
-    */
304
+    /**
305
+     * Retrieves the column at the specified index. If there
306
+     * is no column at the index, this returns an array
307
+     * populated with empty strings.
308
+     * 
309
+     * Tip: Use the {@link columnExists()} method to check
310
+     * whether a column exists.
311
+     * 
312
+     * @param integer $index
313
+     * @return string[]
314
+     * @see columnExists()
315
+     */
316 316
     public function getColumn($index)
317 317
     {
318 318
         $data = array();
@@ -328,11 +328,11 @@  discard block
 block discarded – undo
328 328
         return $data;
329 329
     }
330 330
     
331
-   /**
332
-    * Checks whether the specified column exists in the data set.
333
-    * @param integer $index
334
-    * @return boolean
335
-    */
331
+    /**
332
+     * Checks whether the specified column exists in the data set.
333
+     * @param integer $index
334
+     * @return boolean
335
+     */
336 336
     public function columnExists($index)
337 337
     {
338 338
         if($index < $this->columnCount) {
@@ -396,22 +396,22 @@  discard block
 block discarded – undo
396 396
         }
397 397
     }
398 398
     
399
-   /**
400
-    * Checks whether any errors have been encountered
401
-    * while parsing the CSV.
402
-    * 
403
-    * @return boolean
404
-    * @see getErrorMessages()
405
-    */
399
+    /**
400
+     * Checks whether any errors have been encountered
401
+     * while parsing the CSV.
402
+     * 
403
+     * @return boolean
404
+     * @see getErrorMessages()
405
+     */
406 406
     public function hasErrors()
407 407
     {
408 408
         return !empty($this->errors);
409 409
     }
410 410
     
411
-   /**
412
-    * Retrieves all error messages.
413
-    * @return array
414
-    */
411
+    /**
412
+     * Retrieves all error messages.
413
+     * @return array
414
+     */
415 415
     public function getErrorMessages()
416 416
     {
417 417
         return $this->errors;
Please login to merge, or discard this patch.
Spacing   +14 added lines, -14 removed lines patch added patch discarded remove patch
@@ -166,7 +166,7 @@  discard block
 block discarded – undo
166 166
     
167 167
     public function isHeadersPosition($position)
168 168
     {
169
-        if($this->headersPosition === $position) {
169
+        if ($this->headersPosition === $position) {
170 170
             return true;
171 171
         }
172 172
         
@@ -193,7 +193,7 @@  discard block
 block discarded – undo
193 193
             self::HEADERS_TOP
194 194
         );
195 195
         
196
-        if(!in_array($position, $validPositions)) {
196
+        if (!in_array($position, $validPositions)) {
197 197
             throw new CSVHelper_Exception(
198 198
                 'Invalid headers position',
199 199
                 sprintf(
@@ -249,7 +249,7 @@  discard block
 block discarded – undo
249 249
     */
250 250
     public function getRow($index)
251 251
     {
252
-        if(isset($this->data[$index])) {
252
+        if (isset($this->data[$index])) {
253 253
             return $this->data[$index];
254 254
         }
255 255
         
@@ -316,9 +316,9 @@  discard block
 block discarded – undo
316 316
     public function getColumn($index)
317 317
     {
318 318
         $data = array();
319
-        for($i=0; $i < $this->rowCount; $i++) {
319
+        for ($i = 0; $i < $this->rowCount; $i++) {
320 320
             $value = '';
321
-            if(isset($this->data[$i][$index])) {
321
+            if (isset($this->data[$i][$index])) {
322 322
                 $value = $this->data[$i][$index];
323 323
             }
324 324
             
@@ -335,7 +335,7 @@  discard block
 block discarded – undo
335 335
     */
336 336
     public function columnExists($index)
337 337
     {
338
-        if($index < $this->columnCount) {
338
+        if ($index < $this->columnCount) {
339 339
             return true;
340 340
         }
341 341
         
@@ -346,7 +346,7 @@  discard block
 block discarded – undo
346 346
     {
347 347
         $this->reset();
348 348
         
349
-        if(empty(trim($this->csv))) {
349
+        if (empty(trim($this->csv))) {
350 350
             $this->addError('Tried to parse an empty CSV string.');
351 351
             return;
352 352
         }
@@ -361,12 +361,12 @@  discard block
 block discarded – undo
361 361
         $parser->delimiter = $this->detectSeparator();
362 362
         
363 363
         $result = $parser->parse_string(/** @scrutinizer ignore-type */ $this->csv);
364
-        if(!$result) {
364
+        if (!$result) {
365 365
             $this->addError('The CSV string could not be parsed.');
366 366
             return;
367 367
         }
368 368
         
369
-        switch($this->headersPosition)
369
+        switch ($this->headersPosition)
370 370
         {
371 371
             case self::HEADERS_TOP:
372 372
                 $this->headers = array_shift($result);
@@ -375,7 +375,7 @@  discard block
 block discarded – undo
375 375
             case self::HEADERS_LEFT:
376 376
                 $keep = array();
377 377
                 $total = count($result);
378
-                for($i=0; $i < $total; $i++) {
378
+                for ($i = 0; $i < $total; $i++) {
379 379
                     $row = $result[$i];
380 380
                     $this->headers[] = array_shift($row);
381 381
                     $keep[] = $row;
@@ -388,9 +388,9 @@  discard block
 block discarded – undo
388 388
         $this->data = $result;
389 389
         $this->rowCount = count($this->data);
390 390
         
391
-        for($i=0; $i < $this->rowCount; $i++) {
391
+        for ($i = 0; $i < $this->rowCount; $i++) {
392 392
             $amount = count($this->data[$i]);
393
-            if($amount > $this->columnCount) {
393
+            if ($amount > $this->columnCount) {
394 394
                 $this->columnCount = $amount;
395 395
             }
396 396
         }
@@ -434,8 +434,8 @@  discard block
 block discarded – undo
434 434
             ',,' => ','
435 435
         );
436 436
         
437
-        foreach($search as $char => $separator) {
438
-            if(strstr($this->csv, $char)) {
437
+        foreach ($search as $char => $separator) {
438
+            if (strstr($this->csv, $char)) {
439 439
                 return $separator;
440 440
             }
441 441
         }
Please login to merge, or discard this patch.
src/ConvertHelper/EOL.php 1 patch
Indentation   +26 added lines, -26 removed lines patch added patch discarded remove patch
@@ -29,19 +29,19 @@  discard block
 block discarded – undo
29 29
     const TYPE_LF = 'LF';
30 30
     const TYPE_CR = 'CR';
31 31
     
32
-   /**
33
-    * @var string
34
-    */
32
+    /**
33
+     * @var string
34
+     */
35 35
     protected $char;
36 36
     
37
-   /**
38
-    * @var string
39
-    */
37
+    /**
38
+     * @var string
39
+     */
40 40
     protected $type;
41 41
     
42
-   /**
43
-    * @var string
44
-    */
42
+    /**
43
+     * @var string
44
+     */
45 45
     protected $description;
46 46
     
47 47
     public function __construct(string $char, string $type, string $description)
@@ -51,33 +51,33 @@  discard block
 block discarded – undo
51 51
         $this->description = $description;
52 52
     }
53 53
     
54
-   /**
55
-    * The actual EOL character.
56
-    * @return string
57
-    */
54
+    /**
55
+     * The actual EOL character.
56
+     * @return string
57
+     */
58 58
     public function getCharacter() : string
59 59
     {
60 60
         return $this->char;
61 61
     }
62 62
     
63
-   /**
64
-    * A more detailed, human readable description of the character.
65
-    * @return string
66
-    */
63
+    /**
64
+     * A more detailed, human readable description of the character.
65
+     * @return string
66
+     */
67 67
     public function getDescription() : string
68 68
     {
69 69
         return $this->description;
70 70
     }
71 71
     
72
-   /**
73
-    * The EOL character type, e.g. "CR+LF", "CR"...
74
-    * @return string
75
-    * 
76
-    * @see ConvertHelper_EOL::TYPE_CR
77
-    * @see ConvertHelper_EOL::TYPE_CRLF
78
-    * @see ConvertHelper_EOL::TYPE_LF
79
-    * @see ConvertHelper_EOL::TYPE_LFCR
80
-    */
72
+    /**
73
+     * The EOL character type, e.g. "CR+LF", "CR"...
74
+     * @return string
75
+     * 
76
+     * @see ConvertHelper_EOL::TYPE_CR
77
+     * @see ConvertHelper_EOL::TYPE_CRLF
78
+     * @see ConvertHelper_EOL::TYPE_LF
79
+     * @see ConvertHelper_EOL::TYPE_LFCR
80
+     */
81 81
     public function getType() : string
82 82
     {
83 83
         return $this->type;
Please login to merge, or discard this patch.