Passed
Push — master ( 189c3f...f802e2 )
by Sebastian
02:25
created
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
@@ -80,32 +80,32 @@  discard block
 block discarded – undo
80 80
     
81 81
     const ERROR_CANNOT_OPEN_FILE_TO_DETECT_BOM = 340032;
82 82
     
83
-   /**
84
-    * Opens a serialized file and returns the unserialized data.
85
-    * 
86
-    * @param string $file
87
-    * @throws FileHelper_Exception
88
-    * @return array
89
-    * @deprecated Use parseSerializedFile() instead.
90
-    * @see FileHelper::parseSerializedFile()
91
-    */
83
+    /**
84
+     * Opens a serialized file and returns the unserialized data.
85
+     * 
86
+     * @param string $file
87
+     * @throws FileHelper_Exception
88
+     * @return array
89
+     * @deprecated Use parseSerializedFile() instead.
90
+     * @see FileHelper::parseSerializedFile()
91
+     */
92 92
     public static function openUnserialized(string $file) : array
93 93
     {
94 94
         return self::parseSerializedFile($file);
95 95
     }
96 96
 
97
-   /**
98
-    * Opens a serialized file and returns the unserialized data.
99
-    *
100
-    * @param string $file
101
-    * @throws FileHelper_Exception
102
-    * @return array
103
-    * @see FileHelper::parseSerializedFile()
104
-    * 
105
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
106
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
107
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
108
-    */
97
+    /**
98
+     * Opens a serialized file and returns the unserialized data.
99
+     *
100
+     * @param string $file
101
+     * @throws FileHelper_Exception
102
+     * @return array
103
+     * @see FileHelper::parseSerializedFile()
104
+     * 
105
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
106
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
107
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
108
+     */
109 109
     public static function parseSerializedFile(string $file)
110 110
     {
111 111
         self::requireFileExists($file);
@@ -174,13 +174,13 @@  discard block
 block discarded – undo
174 174
         return rmdir($rootFolder);
175 175
     }
176 176
     
177
-   /**
178
-    * Create a folder, if it does not exist yet.
179
-    *  
180
-    * @param string $path
181
-    * @throws FileHelper_Exception
182
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
183
-    */
177
+    /**
178
+     * Create a folder, if it does not exist yet.
179
+     *  
180
+     * @param string $path
181
+     * @throws FileHelper_Exception
182
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
183
+     */
184 184
     public static function createFolder($path)
185 185
     {
186 186
         if(is_dir($path) || mkdir($path, 0777, true)) {
@@ -227,22 +227,22 @@  discard block
 block discarded – undo
227 227
         }
228 228
     }
229 229
     
230
-   /**
231
-    * Copies a file to the target location. Includes checks
232
-    * for most error sources, like the source file not being
233
-    * readable. Automatically creates the target folder if it
234
-    * does not exist yet.
235
-    * 
236
-    * @param string $sourcePath
237
-    * @param string $targetPath
238
-    * @throws FileHelper_Exception
239
-    * 
240
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
241
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
242
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
243
-    * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
244
-    * @see FileHelper::ERROR_CANNOT_COPY_FILE
245
-    */
230
+    /**
231
+     * Copies a file to the target location. Includes checks
232
+     * for most error sources, like the source file not being
233
+     * readable. Automatically creates the target folder if it
234
+     * does not exist yet.
235
+     * 
236
+     * @param string $sourcePath
237
+     * @param string $targetPath
238
+     * @throws FileHelper_Exception
239
+     * 
240
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
241
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
242
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
243
+     * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
244
+     * @see FileHelper::ERROR_CANNOT_COPY_FILE
245
+     */
246 246
     public static function copyFile($sourcePath, $targetPath)
247 247
     {
248 248
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
@@ -293,15 +293,15 @@  discard block
 block discarded – undo
293 293
         );
294 294
     }
295 295
     
296
-   /**
297
-    * Deletes the target file. Ignored if it cannot be found,
298
-    * and throws an exception if it fails.
299
-    * 
300
-    * @param string $filePath
301
-    * @throws FileHelper_Exception
302
-    * 
303
-    * @see FileHelper::ERROR_CANNOT_DELETE_FILE
304
-    */
296
+    /**
297
+     * Deletes the target file. Ignored if it cannot be found,
298
+     * and throws an exception if it fails.
299
+     * 
300
+     * @param string $filePath
301
+     * @throws FileHelper_Exception
302
+     * 
303
+     * @see FileHelper::ERROR_CANNOT_DELETE_FILE
304
+     */
305 305
     public static function deleteFile(string $filePath) : void
306 306
     {
307 307
         if(!file_exists($filePath)) {
@@ -323,15 +323,15 @@  discard block
 block discarded – undo
323 323
     }
324 324
 
325 325
     /**
326
-    * Creates a new CSV parser instance and returns it.
327
-    * 
328
-    * @param string $delimiter
329
-    * @param string $enclosure
330
-    * @param string $escape
331
-    * @param bool $heading
332
-    * @return \parseCSV
333
-    * @todo Move this to the CSV helper.
334
-    */
326
+     * Creates a new CSV parser instance and returns it.
327
+     * 
328
+     * @param string $delimiter
329
+     * @param string $enclosure
330
+     * @param string $escape
331
+     * @param bool $heading
332
+     * @return \parseCSV
333
+     * @todo Move this to the CSV helper.
334
+     */
335 335
     public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
336 336
     {
337 337
         if($delimiter==='') { $delimiter = ';'; }
@@ -346,23 +346,23 @@  discard block
 block discarded – undo
346 346
         return $parser;
347 347
     }
348 348
 
349
-   /**
350
-    * Parses all lines in the specified string and returns an
351
-    * indexed array with all csv values in each line.
352
-    *
353
-    * @param string $csv
354
-    * @param string $delimiter
355
-    * @param string $enclosure
356
-    * @param string $escape
357
-    * @param bool $heading
358
-    * @return array
359
-    * @throws FileHelper_Exception
360
-    * 
361
-    * @todo Move this to the CSVHelper.
362
-    *
363
-    * @see parseCSVFile()
364
-    * @see FileHelper::ERROR_PARSING_CSV
365
-    */
349
+    /**
350
+     * Parses all lines in the specified string and returns an
351
+     * indexed array with all csv values in each line.
352
+     *
353
+     * @param string $csv
354
+     * @param string $delimiter
355
+     * @param string $enclosure
356
+     * @param string $escape
357
+     * @param bool $heading
358
+     * @return array
359
+     * @throws FileHelper_Exception
360
+     * 
361
+     * @todo Move this to the CSVHelper.
362
+     *
363
+     * @see parseCSVFile()
364
+     * @see FileHelper::ERROR_PARSING_CSV
365
+     */
366 366
     public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
367 367
     {
368 368
         $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading);
@@ -541,31 +541,31 @@  discard block
 block discarded – undo
541 541
         );
542 542
     }
543 543
     
544
-   /**
545
-    * Verifies whether the target file is a PHP file. The path
546
-    * to the file can be a path to a file as a string, or a 
547
-    * DirectoryIterator object instance.
548
-    * 
549
-    * @param string|\DirectoryIterator $pathOrDirIterator
550
-    * @return boolean
551
-    */
544
+    /**
545
+     * Verifies whether the target file is a PHP file. The path
546
+     * to the file can be a path to a file as a string, or a 
547
+     * DirectoryIterator object instance.
548
+     * 
549
+     * @param string|\DirectoryIterator $pathOrDirIterator
550
+     * @return boolean
551
+     */
552 552
     public static function isPHPFile($pathOrDirIterator)
553 553
     {
554
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
555
-    		return true;
556
-    	}
554
+        if(self::getExtension($pathOrDirIterator) == 'php') {
555
+            return true;
556
+        }
557 557
     	
558
-    	return false;
558
+        return false;
559 559
     }
560 560
     
561
-   /**
562
-    * Retrieves the extension of the specified file. Can be a path
563
-    * to a file as a string, or a DirectoryIterator object instance.
564
-    * 
565
-    * @param string|\DirectoryIterator $pathOrDirIterator
566
-    * @param bool $lowercase
567
-    * @return string
568
-    */
561
+    /**
562
+     * Retrieves the extension of the specified file. Can be a path
563
+     * to a file as a string, or a DirectoryIterator object instance.
564
+     * 
565
+     * @param string|\DirectoryIterator $pathOrDirIterator
566
+     * @param bool $lowercase
567
+     * @return string
568
+     */
569 569
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
570 570
     {
571 571
         if($pathOrDirIterator instanceof \DirectoryIterator) {
@@ -576,51 +576,51 @@  discard block
 block discarded – undo
576 576
          
577 577
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
578 578
         if($lowercase) {
579
-        	$ext = mb_strtolower($ext);
579
+            $ext = mb_strtolower($ext);
580 580
         }
581 581
         
582 582
         return $ext;
583 583
     }
584 584
     
585
-   /**
586
-    * Retrieves the file name from a path, with or without extension.
587
-    * The path to the file can be a string, or a DirectoryIterator object
588
-    * instance.
589
-    * 
590
-    * In case of folders, behaves like the pathinfo function: returns
591
-    * the name of the folder.
592
-    * 
593
-    * @param string|\DirectoryIterator $pathOrDirIterator
594
-    * @param bool $extension
595
-    * @return string
596
-    */
585
+    /**
586
+     * Retrieves the file name from a path, with or without extension.
587
+     * The path to the file can be a string, or a DirectoryIterator object
588
+     * instance.
589
+     * 
590
+     * In case of folders, behaves like the pathinfo function: returns
591
+     * the name of the folder.
592
+     * 
593
+     * @param string|\DirectoryIterator $pathOrDirIterator
594
+     * @param bool $extension
595
+     * @return string
596
+     */
597 597
     public static function getFilename($pathOrDirIterator, $extension = true)
598 598
     {
599 599
         $path = $pathOrDirIterator;
600
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
601
-    		$path = $pathOrDirIterator->getFilename();
602
-    	}
600
+        if($pathOrDirIterator instanceof \DirectoryIterator) {
601
+            $path = $pathOrDirIterator->getFilename();
602
+        }
603 603
     	
604
-    	$path = self::normalizePath($path);
604
+        $path = self::normalizePath($path);
605 605
     	
606
-    	if(!$extension) {
607
-    	    return pathinfo($path, PATHINFO_FILENAME);
608
-    	}
606
+        if(!$extension) {
607
+            return pathinfo($path, PATHINFO_FILENAME);
608
+        }
609 609
     	
610
-    	return pathinfo($path, PATHINFO_BASENAME); 
610
+        return pathinfo($path, PATHINFO_BASENAME); 
611 611
     }
612 612
    
613
-   /**
614
-    * Tries to read the contents of the target file and
615
-    * treat it as JSON to return the decoded JSON data.
616
-    * 
617
-    * @param string $file
618
-    * @throws FileHelper_Exception
619
-    * @return array
620
-    * 
621
-    * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
622
-    * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
623
-    */ 
613
+    /**
614
+     * Tries to read the contents of the target file and
615
+     * treat it as JSON to return the decoded JSON data.
616
+     * 
617
+     * @param string $file
618
+     * @throws FileHelper_Exception
619
+     * @return array
620
+     * 
621
+     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
622
+     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
623
+     */ 
624 624
     public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
625 625
     {
626 626
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
@@ -656,16 +656,16 @@  discard block
 block discarded – undo
656 656
         return $json;
657 657
     }
658 658
     
659
-   /**
660
-    * Corrects common formatting mistakes when users enter
661
-    * file names, like too many spaces, dots and the like.
662
-    * 
663
-    * NOTE: if the file name contains a path, the path is
664
-    * stripped, leaving only the file name.
665
-    * 
666
-    * @param string $name
667
-    * @return string
668
-    */
659
+    /**
660
+     * Corrects common formatting mistakes when users enter
661
+     * file names, like too many spaces, dots and the like.
662
+     * 
663
+     * NOTE: if the file name contains a path, the path is
664
+     * stripped, leaving only the file name.
665
+     * 
666
+     * @param string $name
667
+     * @return string
668
+     */
669 669
     public static function fixFileName(string $name) : string
670 670
     {
671 671
         $name = trim($name);
@@ -695,60 +695,60 @@  discard block
 block discarded – undo
695 695
         return $name;
696 696
     }
697 697
     
698
-   /**
699
-    * Creates an instance of the file finder, which is an easier
700
-    * alternative to the other manual findFile methods, since all
701
-    * options can be set by chaining.
702
-    * 
703
-    * @param string $path
704
-    * @return FileHelper_FileFinder
705
-    */
698
+    /**
699
+     * Creates an instance of the file finder, which is an easier
700
+     * alternative to the other manual findFile methods, since all
701
+     * options can be set by chaining.
702
+     * 
703
+     * @param string $path
704
+     * @return FileHelper_FileFinder
705
+     */
706 706
     public static function createFileFinder(string $path) : FileHelper_FileFinder
707 707
     {
708 708
         return new FileHelper_FileFinder($path);
709 709
     }
710 710
     
711
-   /**
712
-    * Searches for all HTML files in the target folder.
713
-    * 
714
-    * @param string $targetFolder
715
-    * @param array $options
716
-    * @return array An indexed array with files.
717
-    * @see FileHelper::createFileFinder()
718
-    * 
719
-    * @todo Convert this to use the file finder.
720
-    */
711
+    /**
712
+     * Searches for all HTML files in the target folder.
713
+     * 
714
+     * @param string $targetFolder
715
+     * @param array $options
716
+     * @return array An indexed array with files.
717
+     * @see FileHelper::createFileFinder()
718
+     * 
719
+     * @todo Convert this to use the file finder.
720
+     */
721 721
     public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
722 722
     {
723 723
         return self::findFiles($targetFolder, array('html'), $options);
724 724
     }
725 725
 
726
-   /**
727
-    * Searches for all PHP files in the target folder.
728
-    * 
729
-    * @param string $targetFolder
730
-    * @param array $options
731
-    * @return array An indexed array of PHP files.
732
-    * @see FileHelper::createFileFinder()
733
-    * 
734
-    * @todo Convert this to use the file finder.
735
-    */
726
+    /**
727
+     * Searches for all PHP files in the target folder.
728
+     * 
729
+     * @param string $targetFolder
730
+     * @param array $options
731
+     * @return array An indexed array of PHP files.
732
+     * @see FileHelper::createFileFinder()
733
+     * 
734
+     * @todo Convert this to use the file finder.
735
+     */
736 736
     public static function findPHPFiles(string $targetFolder, array $options=array()) : array
737 737
     {
738 738
         return self::findFiles($targetFolder, array('php'), $options);
739 739
     }
740 740
     
741
-   /**
742
-    * 
743
-    * @param string $targetFolder
744
-    * @param array $extensions
745
-    * @param array $options
746
-    * @param array $files
747
-    * @throws FileHelper_Exception
748
-    * @return array
749
-    * @see FileHelper::createFileFinder()
750
-    * @todo Convert this to use the file finder. 
751
-    */
741
+    /**
742
+     * 
743
+     * @param string $targetFolder
744
+     * @param array $extensions
745
+     * @param array $options
746
+     * @param array $files
747
+     * @throws FileHelper_Exception
748
+     * @return array
749
+     * @see FileHelper::createFileFinder()
750
+     * @todo Convert this to use the file finder. 
751
+     */
752 752
     public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
753 753
     {
754 754
         if(!isset($options['strip-extension'])) {
@@ -829,13 +829,13 @@  discard block
 block discarded – undo
829 829
         return $files;
830 830
     }
831 831
 
832
-   /**
833
-    * Removes the extension from the specified path or file name,
834
-    * if any, and returns the name without the extension.
835
-    * 
836
-    * @param string $filename
837
-    * @return sTring
838
-    */
832
+    /**
833
+     * Removes the extension from the specified path or file name,
834
+     * if any, and returns the name without the extension.
835
+     * 
836
+     * @param string $filename
837
+     * @return sTring
838
+     */
839 839
     public static function removeExtension(string $filename) : string
840 840
     {
841 841
         // normalize paths to allow windows style slashes even on nix servers
@@ -844,22 +844,22 @@  discard block
 block discarded – undo
844 844
         return pathinfo($filename, PATHINFO_FILENAME);
845 845
     }
846 846
     
847
-   /**
848
-    * Detects the UTF BOM in the target file, if any. Returns
849
-    * the encoding matching the BOM, which can be any of the
850
-    * following:
851
-    * 
852
-    * <ul>
853
-    * <li>UTF32-BE</li>
854
-    * <li>UTF32-LE</li>
855
-    * <li>UTF16-BE</li>
856
-    * <li>UTF16-LE</li>
857
-    * <li>UTF8</li>
858
-    * </ul>
859
-    * 
860
-    * @param string $filename
861
-    * @return string|NULL
862
-    */
847
+    /**
848
+     * Detects the UTF BOM in the target file, if any. Returns
849
+     * the encoding matching the BOM, which can be any of the
850
+     * following:
851
+     * 
852
+     * <ul>
853
+     * <li>UTF32-BE</li>
854
+     * <li>UTF32-LE</li>
855
+     * <li>UTF16-BE</li>
856
+     * <li>UTF16-LE</li>
857
+     * <li>UTF8</li>
858
+     * </ul>
859
+     * 
860
+     * @param string $filename
861
+     * @return string|NULL
862
+     */
863 863
     public static function detectUTFBom(string $filename) : ?string
864 864
     {
865 865
         $fp = fopen($filename, 'r');
@@ -891,13 +891,13 @@  discard block
 block discarded – undo
891 891
     
892 892
     protected static $utfBoms;
893 893
     
894
-   /**
895
-    * Retrieves a list of all UTF byte order mark character
896
-    * sequences, as an assocative array with UTF encoding => bom sequence
897
-    * pairs.
898
-    * 
899
-    * @return array
900
-    */
894
+    /**
895
+     * Retrieves a list of all UTF byte order mark character
896
+     * sequences, as an assocative array with UTF encoding => bom sequence
897
+     * pairs.
898
+     * 
899
+     * @return array
900
+     */
901 901
     public static function getUTFBOMs()
902 902
     {
903 903
         if(!isset(self::$utfBoms)) {
@@ -913,15 +913,15 @@  discard block
 block discarded – undo
913 913
         return self::$utfBoms;
914 914
     }
915 915
     
916
-   /**
917
-    * Checks whether the specified encoding is a valid
918
-    * unicode encoding, for example "UTF16-LE" or "UTF8".
919
-    * Also accounts for alternate way to write the, like
920
-    * "UTF-8", and omitting little/big endian suffixes.
921
-    * 
922
-    * @param string $encoding
923
-    * @return boolean
924
-    */
916
+    /**
917
+     * Checks whether the specified encoding is a valid
918
+     * unicode encoding, for example "UTF16-LE" or "UTF8".
919
+     * Also accounts for alternate way to write the, like
920
+     * "UTF-8", and omitting little/big endian suffixes.
921
+     * 
922
+     * @param string $encoding
923
+     * @return boolean
924
+     */
925 925
     public static function isValidUnicodeEncoding(string $encoding) : bool
926 926
     {
927 927
         $encodings = self::getKnownUnicodeEncodings();
@@ -940,22 +940,22 @@  discard block
 block discarded – undo
940 940
         return in_array($encoding, $keep);
941 941
     }
942 942
     
943
-   /**
944
-    * Retrieves a list of all known unicode file encodings.
945
-    * @return array
946
-    */
943
+    /**
944
+     * Retrieves a list of all known unicode file encodings.
945
+     * @return array
946
+     */
947 947
     public static function getKnownUnicodeEncodings()
948 948
     {
949 949
         return array_keys(self::getUTFBOMs());
950 950
     }
951 951
     
952
-   /**
953
-    * Normalizes the slash style in a file or folder path,
954
-    * by replacing any antislashes with forward slashes.
955
-    * 
956
-    * @param string $path
957
-    * @return string
958
-    */
952
+    /**
953
+     * Normalizes the slash style in a file or folder path,
954
+     * by replacing any antislashes with forward slashes.
955
+     * 
956
+     * @param string $path
957
+     * @return string
958
+     */
959 959
     public static function normalizePath(string $path) : string
960 960
     {
961 961
         return str_replace(array('\\', '//'), array('/', '/'), $path);
@@ -988,18 +988,18 @@  discard block
 block discarded – undo
988 988
         }
989 989
     }
990 990
    
991
-   /**
992
-    * Saves the specified content to the target file, creating
993
-    * the file and the folder as necessary.
994
-    * 
995
-    * @param string $filePath
996
-    * @param string $content
997
-    * @throws FileHelper_Exception
998
-    * 
999
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
1000
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
1001
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
1002
-    */
991
+    /**
992
+     * Saves the specified content to the target file, creating
993
+     * the file and the folder as necessary.
994
+     * 
995
+     * @param string $filePath
996
+     * @param string $content
997
+     * @throws FileHelper_Exception
998
+     * 
999
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
1000
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
1001
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
1002
+     */
1003 1003
     public static function saveFile(string $filePath, string $content='') : void
1004 1004
     {
1005 1005
         // target file already exists
@@ -1052,12 +1052,12 @@  discard block
 block discarded – undo
1052 1052
         );
1053 1053
     }
1054 1054
     
1055
-   /**
1056
-    * Checks whether it is possible to run PHP command 
1057
-    * line commands.
1058
-    * 
1059
-    * @return boolean
1060
-    */
1055
+    /**
1056
+     * Checks whether it is possible to run PHP command 
1057
+     * line commands.
1058
+     * 
1059
+     * @return boolean
1060
+     */
1061 1061
     public static function canMakePHPCalls() : bool
1062 1062
     {
1063 1063
         return self::cliCommandExists('php');
@@ -1132,16 +1132,16 @@  discard block
 block discarded – undo
1132 1132
         return $result;
1133 1133
     }
1134 1134
     
1135
-   /**
1136
-    * Validates a PHP file's syntax.
1137
-    * 
1138
-    * NOTE: This will fail silently if the PHP command line
1139
-    * is not available. Use {@link FileHelper::canMakePHPCalls()}
1140
-    * to check this beforehand as needed.
1141
-    * 
1142
-    * @param string $path
1143
-    * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
1144
-    */
1135
+    /**
1136
+     * Validates a PHP file's syntax.
1137
+     * 
1138
+     * NOTE: This will fail silently if the PHP command line
1139
+     * is not available. Use {@link FileHelper::canMakePHPCalls()}
1140
+     * to check this beforehand as needed.
1141
+     * 
1142
+     * @param string $path
1143
+     * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
1144
+     */
1145 1145
     public static function checkPHPFileSyntax($path)
1146 1146
     {
1147 1147
         if(!self::canMakePHPCalls()) {
@@ -1165,14 +1165,14 @@  discard block
 block discarded – undo
1165 1165
         return $output;
1166 1166
     }
1167 1167
     
1168
-   /**
1169
-    * Retrieves the last modified date for the specified file or folder.
1170
-    * 
1171
-    * Note: If the target does not exist, returns null. 
1172
-    * 
1173
-    * @param string $path
1174
-    * @return \DateTime|NULL
1175
-    */
1168
+    /**
1169
+     * Retrieves the last modified date for the specified file or folder.
1170
+     * 
1171
+     * Note: If the target does not exist, returns null. 
1172
+     * 
1173
+     * @param string $path
1174
+     * @return \DateTime|NULL
1175
+     */
1176 1176
     public static function getModifiedDate($path)
1177 1177
     {
1178 1178
         $time = filemtime($path);
@@ -1185,22 +1185,22 @@  discard block
 block discarded – undo
1185 1185
         return null; 
1186 1186
     }
1187 1187
     
1188
-   /**
1189
-    * Retrieves the names of all subfolders in the specified path.
1190
-    * 
1191
-    * Available options:
1192
-    * 
1193
-    * - recursive: true/false
1194
-    *   Whether to search for subfolders recursively. 
1195
-    *   
1196
-    * - absolute-paths: true/false
1197
-    *   Whether to return a list of absolute paths.
1198
-    * 
1199
-    * @param string $targetFolder
1200
-    * @param array $options
1201
-    * @throws FileHelper_Exception
1202
-    * @return string[]
1203
-    */
1188
+    /**
1189
+     * Retrieves the names of all subfolders in the specified path.
1190
+     * 
1191
+     * Available options:
1192
+     * 
1193
+     * - recursive: true/false
1194
+     *   Whether to search for subfolders recursively. 
1195
+     *   
1196
+     * - absolute-paths: true/false
1197
+     *   Whether to return a list of absolute paths.
1198
+     * 
1199
+     * @param string $targetFolder
1200
+     * @param array $options
1201
+     * @throws FileHelper_Exception
1202
+     * @return string[]
1203
+     */
1204 1204
     public static function getSubfolders($targetFolder, $options = array())
1205 1205
     {
1206 1206
         if(!is_dir($targetFolder)) 
@@ -1261,16 +1261,16 @@  discard block
 block discarded – undo
1261 1261
         return $result;
1262 1262
     }
1263 1263
 
1264
-   /**
1265
-    * Retrieves the maximum allowed upload file size, in bytes.
1266
-    * Takes into account the PHP ini settings <code>post_max_size</code>
1267
-    * and <code>upload_max_filesize</code>. Since these cannot
1268
-    * be modified at runtime, they are the hard limits for uploads.
1269
-    * 
1270
-    * NOTE: Based on binary values, where 1KB = 1024 Bytes.
1271
-    * 
1272
-    * @return int Will return <code>-1</code> if no limit.
1273
-    */
1264
+    /**
1265
+     * Retrieves the maximum allowed upload file size, in bytes.
1266
+     * Takes into account the PHP ini settings <code>post_max_size</code>
1267
+     * and <code>upload_max_filesize</code>. Since these cannot
1268
+     * be modified at runtime, they are the hard limits for uploads.
1269
+     * 
1270
+     * NOTE: Based on binary values, where 1KB = 1024 Bytes.
1271
+     * 
1272
+     * @return int Will return <code>-1</code> if no limit.
1273
+     */
1274 1274
     public static function getMaxUploadFilesize() : int
1275 1275
     {
1276 1276
         static $max_size = -1;
@@ -1307,16 +1307,16 @@  discard block
 block discarded – undo
1307 1307
         return round($size);
1308 1308
     }
1309 1309
    
1310
-   /**
1311
-    * Makes a path relative using a folder depth: will reduce the
1312
-    * length of the path so that only the amount of folders defined
1313
-    * in the <code>$depth</code> attribute are shown below the actual
1314
-    * folder or file in the path.
1315
-    *  
1316
-    * @param string  $path The absolute or relative path
1317
-    * @param int $depth The folder depth to reduce the path to
1318
-    * @return string
1319
-    */
1310
+    /**
1311
+     * Makes a path relative using a folder depth: will reduce the
1312
+     * length of the path so that only the amount of folders defined
1313
+     * in the <code>$depth</code> attribute are shown below the actual
1314
+     * folder or file in the path.
1315
+     *  
1316
+     * @param string  $path The absolute or relative path
1317
+     * @param int $depth The folder depth to reduce the path to
1318
+     * @return string
1319
+     */
1320 1320
     public static function relativizePathByDepth(string $path, int $depth=2) : string
1321 1321
     {
1322 1322
         $path = self::normalizePath($path);
@@ -1354,23 +1354,23 @@  discard block
 block discarded – undo
1354 1354
         return trim(implode('/', $tokens), '/');
1355 1355
     }
1356 1356
     
1357
-   /**
1358
-    * Makes the specified path relative to another path,
1359
-    * by removing one from the other if found. Also 
1360
-    * normalizes the path to use forward slashes. 
1361
-    * 
1362
-    * Example:
1363
-    * 
1364
-    * <pre>
1365
-    * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
1366
-    * </pre>
1367
-    * 
1368
-    * Result: <code>to/file.txt</code>
1369
-    * 
1370
-    * @param string $path
1371
-    * @param string $relativeTo
1372
-    * @return string
1373
-    */
1357
+    /**
1358
+     * Makes the specified path relative to another path,
1359
+     * by removing one from the other if found. Also 
1360
+     * normalizes the path to use forward slashes. 
1361
+     * 
1362
+     * Example:
1363
+     * 
1364
+     * <pre>
1365
+     * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
1366
+     * </pre>
1367
+     * 
1368
+     * Result: <code>to/file.txt</code>
1369
+     * 
1370
+     * @param string $path
1371
+     * @param string $relativeTo
1372
+     * @return string
1373
+     */
1374 1374
     public static function relativizePath(string $path, string $relativeTo) : string
1375 1375
     {
1376 1376
         $path = self::normalizePath($path);
@@ -1382,17 +1382,17 @@  discard block
 block discarded – undo
1382 1382
         return $relative;
1383 1383
     }
1384 1384
     
1385
-   /**
1386
-    * Checks that the target file exists, and throws an exception
1387
-    * if it does not. 
1388
-    * 
1389
-    * @param string $path
1390
-    * @param int|NULL $errorCode Optional custom error code
1391
-    * @throws FileHelper_Exception
1392
-    * @return string The real path to the file
1393
-    * 
1394
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1395
-    */
1385
+    /**
1386
+     * Checks that the target file exists, and throws an exception
1387
+     * if it does not. 
1388
+     * 
1389
+     * @param string $path
1390
+     * @param int|NULL $errorCode Optional custom error code
1391
+     * @throws FileHelper_Exception
1392
+     * @return string The real path to the file
1393
+     * 
1394
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1395
+     */
1396 1396
     public static function requireFileExists(string $path, $errorCode=null) : string
1397 1397
     {
1398 1398
         $result = realpath($path);
@@ -1411,18 +1411,18 @@  discard block
 block discarded – undo
1411 1411
         );
1412 1412
     }
1413 1413
     
1414
-   /**
1415
-    * Reads a specific line number from the target file and returns its
1416
-    * contents, if the file has such a line. Does so with little memory
1417
-    * usage, as the file is not read entirely into memory.
1418
-    * 
1419
-    * @param string $path
1420
-    * @param int $lineNumber Note: 1-based; the first line is number 1.
1421
-    * @return string|NULL Will return null if the requested line does not exist.
1422
-    * @throws FileHelper_Exception
1423
-    * 
1424
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1425
-    */
1414
+    /**
1415
+     * Reads a specific line number from the target file and returns its
1416
+     * contents, if the file has such a line. Does so with little memory
1417
+     * usage, as the file is not read entirely into memory.
1418
+     * 
1419
+     * @param string $path
1420
+     * @param int $lineNumber Note: 1-based; the first line is number 1.
1421
+     * @return string|NULL Will return null if the requested line does not exist.
1422
+     * @throws FileHelper_Exception
1423
+     * 
1424
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1425
+     */
1426 1426
     public static function getLineFromFile(string $path, int $lineNumber) : ?string
1427 1427
     {
1428 1428
         self::requireFileExists($path);
@@ -1438,19 +1438,19 @@  discard block
 block discarded – undo
1438 1438
         $file->seek($targetLine);
1439 1439
         
1440 1440
         if($file->key() !== $targetLine) {
1441
-             return null;
1441
+                return null;
1442 1442
         }
1443 1443
         
1444 1444
         return $file->current(); 
1445 1445
     }
1446 1446
     
1447
-   /**
1448
-    * Retrieves the total amount of lines in the file, without 
1449
-    * reading the whole file into memory.
1450
-    * 
1451
-    * @param string $path
1452
-    * @return int
1453
-    */
1447
+    /**
1448
+     * Retrieves the total amount of lines in the file, without 
1449
+     * reading the whole file into memory.
1450
+     * 
1451
+     * @param string $path
1452
+     * @return int
1453
+     */
1454 1454
     public static function countFileLines(string $path) : int
1455 1455
     {
1456 1456
         self::requireFileExists($path);
@@ -1480,26 +1480,26 @@  discard block
 block discarded – undo
1480 1480
         return $number+1;
1481 1481
     }
1482 1482
     
1483
-   /**
1484
-    * Parses the target file to detect any PHP classes contained
1485
-    * within, and retrieve information on them. Does not use the 
1486
-    * PHP reflection API.
1487
-    * 
1488
-    * @param string $filePath
1489
-    * @return FileHelper_PHPClassInfo
1490
-    */
1483
+    /**
1484
+     * Parses the target file to detect any PHP classes contained
1485
+     * within, and retrieve information on them. Does not use the 
1486
+     * PHP reflection API.
1487
+     * 
1488
+     * @param string $filePath
1489
+     * @return FileHelper_PHPClassInfo
1490
+     */
1491 1491
     public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo
1492 1492
     {
1493 1493
         return new FileHelper_PHPClassInfo($filePath);
1494 1494
     }
1495 1495
     
1496
-   /**
1497
-    * Detects the end of line style used in the target file, if any.
1498
-    * Can be used with large files, because it only reads part of it.
1499
-    * 
1500
-    * @param string $filePath The path to the file.
1501
-    * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
1502
-    */
1496
+    /**
1497
+     * Detects the end of line style used in the target file, if any.
1498
+     * Can be used with large files, because it only reads part of it.
1499
+     * 
1500
+     * @param string $filePath The path to the file.
1501
+     * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
1502
+     */
1503 1503
     public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL
1504 1504
     {
1505 1505
         // 20 lines is enough to get a good picture of the newline style in the file.
@@ -1512,18 +1512,18 @@  discard block
 block discarded – undo
1512 1512
         return ConvertHelper::detectEOLCharacter($string);
1513 1513
     }
1514 1514
     
1515
-   /**
1516
-    * Reads the specified amount of lines from the target file.
1517
-    * Unicode BOM compatible: any byte order marker is stripped
1518
-    * from the resulting lines.
1519
-    * 
1520
-    * @param string $filePath
1521
-    * @param int $amount Set to 0 to read all lines.
1522
-    * @return array
1523
-    * 
1524
-    * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1525
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1526
-    */
1515
+    /**
1516
+     * Reads the specified amount of lines from the target file.
1517
+     * Unicode BOM compatible: any byte order marker is stripped
1518
+     * from the resulting lines.
1519
+     * 
1520
+     * @param string $filePath
1521
+     * @param int $amount Set to 0 to read all lines.
1522
+     * @return array
1523
+     * 
1524
+     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1525
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1526
+     */
1527 1527
     public static function readLines(string $filePath, int $amount=0) : array
1528 1528
     {
1529 1529
         self::requireFileExists($filePath);
@@ -1574,16 +1574,16 @@  discard block
 block discarded – undo
1574 1574
         return $result;
1575 1575
     }
1576 1576
     
1577
-   /**
1578
-    * Reads all content from a file.
1579
-    * 
1580
-    * @param string $filePath
1581
-    * @throws FileHelper_Exception
1582
-    * @return string
1583
-    * 
1584
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1585
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
1586
-    */
1577
+    /**
1578
+     * Reads all content from a file.
1579
+     * 
1580
+     * @param string $filePath
1581
+     * @throws FileHelper_Exception
1582
+     * @return string
1583
+     * 
1584
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1585
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
1586
+     */
1587 1587
     public static function readContents(string $filePath) : string
1588 1588
     {
1589 1589
         self::requireFileExists($filePath);
Please login to merge, or discard this patch.
Spacing   +112 added lines, -112 removed lines patch added patch discarded remove patch
@@ -112,7 +112,7 @@  discard block
 block discarded – undo
112 112
         
113 113
         $contents = file_get_contents($file);
114 114
         
115
-        if($contents === false) 
115
+        if ($contents === false) 
116 116
         {
117 117
             throw new FileHelper_Exception(
118 118
                 'Cannot load serialized content from file.',
@@ -126,7 +126,7 @@  discard block
 block discarded – undo
126 126
         
127 127
         $result = @unserialize($contents);
128 128
         
129
-        if($result !== false) {
129
+        if ($result !== false) {
130 130
             return $result;
131 131
         }
132 132
         
@@ -142,7 +142,7 @@  discard block
 block discarded – undo
142 142
     
143 143
     public static function deleteTree($rootFolder)
144 144
     {
145
-        if(!file_exists($rootFolder)) {
145
+        if (!file_exists($rootFolder)) {
146 146
             return true;
147 147
         }
148 148
         
@@ -183,7 +183,7 @@  discard block
 block discarded – undo
183 183
     */
184 184
     public static function createFolder($path)
185 185
     {
186
-        if(is_dir($path) || mkdir($path, 0777, true)) {
186
+        if (is_dir($path) || mkdir($path, 0777, true)) {
187 187
             return;
188 188
         }
189 189
         
@@ -218,11 +218,11 @@  discard block
 block discarded – undo
218 218
 
219 219
             if ($item->isDir()) 
220 220
             {
221
-                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName);
221
+                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target.'/'.$baseName);
222 222
             } 
223
-            else if($item->isFile()) 
223
+            else if ($item->isFile()) 
224 224
             {
225
-                self::copyFile($itemPath, $target . '/' . $baseName);
225
+                self::copyFile($itemPath, $target.'/'.$baseName);
226 226
             }
227 227
         }
228 228
     }
@@ -247,7 +247,7 @@  discard block
 block discarded – undo
247 247
     {
248 248
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
249 249
         
250
-        if(!is_readable($sourcePath))
250
+        if (!is_readable($sourcePath))
251 251
         {
252 252
             throw new FileHelper_Exception(
253 253
                 sprintf('Source file [%s] to copy is not readable.', basename($sourcePath)),
@@ -261,11 +261,11 @@  discard block
 block discarded – undo
261 261
         
262 262
         $targetFolder = dirname($targetPath);
263 263
         
264
-        if(!file_exists($targetFolder))
264
+        if (!file_exists($targetFolder))
265 265
         {
266 266
             self::createFolder($targetFolder);
267 267
         }
268
-        else if(!is_writable($targetFolder)) 
268
+        else if (!is_writable($targetFolder)) 
269 269
         {
270 270
             throw new FileHelper_Exception(
271 271
                 sprintf('Target folder [%s] is not writable.', basename($targetFolder)),
@@ -277,7 +277,7 @@  discard block
 block discarded – undo
277 277
             );
278 278
         }
279 279
         
280
-        if(copy($sourcePath, $targetPath)) {
280
+        if (copy($sourcePath, $targetPath)) {
281 281
             return;
282 282
         }
283 283
         
@@ -304,11 +304,11 @@  discard block
 block discarded – undo
304 304
     */
305 305
     public static function deleteFile(string $filePath) : void
306 306
     {
307
-        if(!file_exists($filePath)) {
307
+        if (!file_exists($filePath)) {
308 308
             return;
309 309
         }
310 310
         
311
-        if(unlink($filePath)) {
311
+        if (unlink($filePath)) {
312 312
             return;
313 313
         }
314 314
         
@@ -332,10 +332,10 @@  discard block
 block discarded – undo
332 332
     * @return \parseCSV
333 333
     * @todo Move this to the CSV helper.
334 334
     */
335
-    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
335
+    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : \parseCSV
336 336
     {
337
-        if($delimiter==='') { $delimiter = ';'; }
338
-        if($enclosure==='') { $enclosure = '"'; }
337
+        if ($delimiter === '') { $delimiter = ';'; }
338
+        if ($enclosure === '') { $enclosure = '"'; }
339 339
         
340 340
         $parser = new \parseCSV(null, null, null, array());
341 341
 
@@ -363,11 +363,11 @@  discard block
 block discarded – undo
363 363
     * @see parseCSVFile()
364 364
     * @see FileHelper::ERROR_PARSING_CSV
365 365
     */
366
-    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
366
+    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
367 367
     {
368 368
         $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading);
369 369
         $result = $parser->parse_string(/** @scrutinizer ignore-type */ $csv);
370
-        if(is_array($result)) {
370
+        if (is_array($result)) {
371 371
             return $result;
372 372
         }
373 373
         
@@ -395,7 +395,7 @@  discard block
 block discarded – undo
395 395
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
396 396
      * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
397 397
      */
398
-    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
398
+    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
399 399
     {
400 400
         $content = self::readContents($filePath);
401 401
 
@@ -412,7 +412,7 @@  discard block
 block discarded – undo
412 412
     public static function detectMimeType(string $fileName) : ?string
413 413
     {
414 414
         $ext = self::getExtension($fileName);
415
-        if(empty($ext)) {
415
+        if (empty($ext)) {
416 416
             return null;
417 417
         }
418 418
 
@@ -433,11 +433,11 @@  discard block
 block discarded – undo
433 433
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
434 434
      * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE
435 435
      */
436
-    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true)
436
+    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true)
437 437
     {
438 438
         self::requireFileExists($filePath);
439 439
         
440
-        if(empty($fileName)) {
440
+        if (empty($fileName)) {
441 441
             $fileName = basename($filePath);
442 442
         }
443 443
 
@@ -455,10 +455,10 @@  discard block
 block discarded – undo
455 455
         
456 456
         header("Cache-Control: public", true);
457 457
         header("Content-Description: File Transfer", true);
458
-        header("Content-Type: " . $mime, true);
458
+        header("Content-Type: ".$mime, true);
459 459
 
460 460
         $disposition = 'inline';
461
-        if($asAttachment) {
461
+        if ($asAttachment) {
462 462
             $disposition = 'attachment';
463 463
         }
464 464
         
@@ -484,7 +484,7 @@  discard block
 block discarded – undo
484 484
      */
485 485
     public static function downloadFile($url)
486 486
     {
487
-        if(!function_exists('curl_init')) 
487
+        if (!function_exists('curl_init')) 
488 488
         {
489 489
             throw new FileHelper_Exception(
490 490
                 'The cURL extension is not installed.',
@@ -494,7 +494,7 @@  discard block
 block discarded – undo
494 494
         }
495 495
 
496 496
         $ch = curl_init();
497
-        if($ch === false) 
497
+        if ($ch === false) 
498 498
         {
499 499
             throw new FileHelper_Exception(
500 500
                 'Could not initialize a new cURL instance.',
@@ -515,7 +515,7 @@  discard block
 block discarded – undo
515 515
         
516 516
         $output = curl_exec($ch);
517 517
 
518
-        if($output === false) {
518
+        if ($output === false) {
519 519
             throw new FileHelper_Exception(
520 520
                 'Unable to open URL',
521 521
                 sprintf(
@@ -529,7 +529,7 @@  discard block
 block discarded – undo
529 529
 
530 530
         curl_close($ch);
531 531
 
532
-        if(is_string($output)) 
532
+        if (is_string($output)) 
533 533
         {
534 534
             return $output;
535 535
         }
@@ -551,7 +551,7 @@  discard block
 block discarded – undo
551 551
     */
552 552
     public static function isPHPFile($pathOrDirIterator)
553 553
     {
554
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
554
+    	if (self::getExtension($pathOrDirIterator) == 'php') {
555 555
     		return true;
556 556
     	}
557 557
     	
@@ -568,14 +568,14 @@  discard block
 block discarded – undo
568 568
     */
569 569
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
570 570
     {
571
-        if($pathOrDirIterator instanceof \DirectoryIterator) {
571
+        if ($pathOrDirIterator instanceof \DirectoryIterator) {
572 572
             $filename = $pathOrDirIterator->getFilename();
573 573
         } else {
574 574
             $filename = basename($pathOrDirIterator);
575 575
         }
576 576
          
577 577
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
578
-        if($lowercase) {
578
+        if ($lowercase) {
579 579
         	$ext = mb_strtolower($ext);
580 580
         }
581 581
         
@@ -597,13 +597,13 @@  discard block
 block discarded – undo
597 597
     public static function getFilename($pathOrDirIterator, $extension = true)
598 598
     {
599 599
         $path = $pathOrDirIterator;
600
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
600
+    	if ($pathOrDirIterator instanceof \DirectoryIterator) {
601 601
     		$path = $pathOrDirIterator->getFilename();
602 602
     	}
603 603
     	
604 604
     	$path = self::normalizePath($path);
605 605
     	
606
-    	if(!$extension) {
606
+    	if (!$extension) {
607 607
     	    return pathinfo($path, PATHINFO_FILENAME);
608 608
     	}
609 609
     	
@@ -621,12 +621,12 @@  discard block
 block discarded – undo
621 621
     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
622 622
     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
623 623
     */ 
624
-    public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
624
+    public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null)
625 625
     {
626 626
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
627 627
         
628 628
         $content = file_get_contents($file);
629
-        if(!$content) {
629
+        if (!$content) {
630 630
             throw new FileHelper_Exception(
631 631
                 'Cannot get file contents',
632 632
                 sprintf(
@@ -637,12 +637,12 @@  discard block
 block discarded – undo
637 637
             );
638 638
         }
639 639
         
640
-        if(isset($targetEncoding)) {
640
+        if (isset($targetEncoding)) {
641 641
             $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding);
642 642
         }
643 643
         
644 644
         $json = json_decode($content, true);
645
-        if($json === false || $json === NULL) {
645
+        if ($json === false || $json === NULL) {
646 646
             throw new FileHelper_Exception(
647 647
                 'Cannot decode json data',
648 648
                 sprintf(
@@ -682,13 +682,13 @@  discard block
 block discarded – undo
682 682
         
683 683
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
684 684
         
685
-        while(strstr($name, '  ')) {
685
+        while (strstr($name, '  ')) {
686 686
             $name = str_replace('  ', ' ', $name);
687 687
         }
688 688
 
689 689
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
690 690
         
691
-        while(strstr($name, '..')) {
691
+        while (strstr($name, '..')) {
692 692
             $name = str_replace('..', '.', $name);
693 693
         }
694 694
         
@@ -718,7 +718,7 @@  discard block
 block discarded – undo
718 718
     * 
719 719
     * @todo Convert this to use the file finder.
720 720
     */
721
-    public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
721
+    public static function findHTMLFiles(string $targetFolder, array $options = array()) : array
722 722
     {
723 723
         return self::findFiles($targetFolder, array('html'), $options);
724 724
     }
@@ -733,7 +733,7 @@  discard block
 block discarded – undo
733 733
     * 
734 734
     * @todo Convert this to use the file finder.
735 735
     */
736
-    public static function findPHPFiles(string $targetFolder, array $options=array()) : array
736
+    public static function findPHPFiles(string $targetFolder, array $options = array()) : array
737 737
     {
738 738
         return self::findFiles($targetFolder, array('php'), $options);
739 739
     }
@@ -749,39 +749,39 @@  discard block
 block discarded – undo
749 749
     * @see FileHelper::createFileFinder()
750 750
     * @todo Convert this to use the file finder. 
751 751
     */
752
-    public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
752
+    public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array
753 753
     {
754
-        if(!isset($options['strip-extension'])) {
754
+        if (!isset($options['strip-extension'])) {
755 755
             $options['strip-extension'] = false;
756 756
         }
757 757
         
758
-        if(!isset($options['absolute-path'])) {
758
+        if (!isset($options['absolute-path'])) {
759 759
             $options['absolute-path'] = false;
760 760
         } 
761 761
         
762
-        if(!isset($options['relative-path'])) {
762
+        if (!isset($options['relative-path'])) {
763 763
             $options['relative-path'] = false;
764 764
         }
765 765
         
766
-        if(!isset($options['recursive'])) {
766
+        if (!isset($options['recursive'])) {
767 767
             $options['recursive'] = false;
768 768
         }
769 769
         
770
-        if($options['relative-path']) {
770
+        if ($options['relative-path']) {
771 771
             $options['absolute-path'] = true;
772 772
         }
773 773
         
774
-        if(!isset($options['__root'])) {
774
+        if (!isset($options['__root'])) {
775 775
             $options['__root'] = self::normalizePath($targetFolder);
776 776
         }
777 777
         
778 778
         $checkExtensions = false;
779
-        if(!empty($extensions)) {
779
+        if (!empty($extensions)) {
780 780
             $checkExtensions = true;
781 781
             $extensions = array_map('strtolower', $extensions);
782 782
         }
783 783
         
784
-        if(!is_dir($targetFolder)) 
784
+        if (!is_dir($targetFolder)) 
785 785
         {
786 786
             throw new FileHelper_Exception(
787 787
                 'Target folder does not exist',
@@ -794,32 +794,32 @@  discard block
 block discarded – undo
794 794
         }
795 795
         
796 796
         $d = new \DirectoryIterator($targetFolder);
797
-        foreach($d as $item) {
798
-            if($item->isDot()) {
797
+        foreach ($d as $item) {
798
+            if ($item->isDot()) {
799 799
                 continue;
800 800
             }
801 801
             
802
-            if($item->isDir()) {
803
-                if($options['recursive']) {
802
+            if ($item->isDir()) {
803
+                if ($options['recursive']) {
804 804
                     $files = self::findFiles($item->getPathname(), $extensions, $options, $files);
805 805
                 }
806 806
                 continue;
807 807
             }
808 808
             
809
-            if($checkExtensions && !in_array(self::getExtension($item, true), $extensions)) {
809
+            if ($checkExtensions && !in_array(self::getExtension($item, true), $extensions)) {
810 810
                 continue;
811 811
             }
812 812
             
813 813
             $filename = $item->getFilename();
814
-            if($options['strip-extension']) {
814
+            if ($options['strip-extension']) {
815 815
                 $filename = self::removeExtension($filename);
816 816
             }
817 817
             
818
-            if($options['absolute-path']) {
818
+            if ($options['absolute-path']) {
819 819
                 $filename = self::normalizePath($targetFolder.'/'.$filename);
820 820
             }
821 821
             
822
-            if($options['relative-path']) {
822
+            if ($options['relative-path']) {
823 823
                 $filename = ltrim(str_replace($options['__root'], '', $filename), '/');
824 824
             }
825 825
             
@@ -863,7 +863,7 @@  discard block
 block discarded – undo
863 863
     public static function detectUTFBom(string $filename) : ?string
864 864
     {
865 865
         $fp = fopen($filename, 'r');
866
-        if($fp === false) 
866
+        if ($fp === false) 
867 867
         {
868 868
             throw new FileHelper_Exception(
869 869
                 'Cannot open file for reading',
@@ -878,10 +878,10 @@  discard block
 block discarded – undo
878 878
 
879 879
         $boms = self::getUTFBOMs();
880 880
         
881
-        foreach($boms as $bom => $value) 
881
+        foreach ($boms as $bom => $value) 
882 882
         {
883 883
             $length = mb_strlen($value);
884
-            if(mb_substr($text, 0, $length) == $value) {
884
+            if (mb_substr($text, 0, $length) == $value) {
885 885
                 return $bom;
886 886
             }
887 887
         }
@@ -900,13 +900,13 @@  discard block
 block discarded – undo
900 900
     */
901 901
     public static function getUTFBOMs()
902 902
     {
903
-        if(!isset(self::$utfBoms)) {
903
+        if (!isset(self::$utfBoms)) {
904 904
             self::$utfBoms = array(
905
-                'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF),
906
-                'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00),
907
-                'UTF16-BE' => chr(0xFE) . chr(0xFF),
908
-                'UTF16-LE' => chr(0xFF) . chr(0xFE),
909
-                'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF)
905
+                'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF),
906
+                'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00),
907
+                'UTF16-BE' => chr(0xFE).chr(0xFF),
908
+                'UTF16-LE' => chr(0xFF).chr(0xFE),
909
+                'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF)
910 910
             );
911 911
         }
912 912
         
@@ -927,7 +927,7 @@  discard block
 block discarded – undo
927 927
         $encodings = self::getKnownUnicodeEncodings();
928 928
 
929 929
         $keep = array();
930
-        foreach($encodings as $string) 
930
+        foreach ($encodings as $string) 
931 931
         {
932 932
             $withHyphen = str_replace('UTF', 'UTF-', $string);
933 933
             
@@ -961,15 +961,15 @@  discard block
 block discarded – undo
961 961
         return str_replace(array('\\', '//'), array('/', '/'), $path);
962 962
     }
963 963
     
964
-    public static function saveAsJSON($data, $file, $pretty=false)
964
+    public static function saveAsJSON($data, $file, $pretty = false)
965 965
     {
966 966
         $options = null;
967
-        if($pretty) {
967
+        if ($pretty) {
968 968
             $options = JSON_PRETTY_PRINT;
969 969
         }
970 970
         
971 971
         $json = json_encode($data, $options);
972
-        if($json===false) 
972
+        if ($json === false) 
973 973
         {
974 974
             $errorCode = json_last_error();
975 975
             throw new FileHelper_Exception(
@@ -979,7 +979,7 @@  discard block
 block discarded – undo
979 979
             ); 
980 980
         }
981 981
         
982
-        if(!file_put_contents($file, $json)) {
982
+        if (!file_put_contents($file, $json)) {
983 983
             throw new FileHelper_Exception(
984 984
                 sprintf('Could not write the JSON file [%s] to disk.', basename($file)),
985 985
                 sprintf('Full path: [%s].', $file),
@@ -1000,12 +1000,12 @@  discard block
 block discarded – undo
1000 1000
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
1001 1001
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
1002 1002
     */
1003
-    public static function saveFile(string $filePath, string $content='') : void
1003
+    public static function saveFile(string $filePath, string $content = '') : void
1004 1004
     {
1005 1005
         // target file already exists
1006
-        if(file_exists($filePath))
1006
+        if (file_exists($filePath))
1007 1007
         {
1008
-            if(!is_writable($filePath))
1008
+            if (!is_writable($filePath))
1009 1009
             {
1010 1010
                 throw new FileHelper_Exception(
1011 1011
                     sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)),
@@ -1025,7 +1025,7 @@  discard block
 block discarded – undo
1025 1025
             // create the folder as needed
1026 1026
             self::createFolder($targetFolder);
1027 1027
             
1028
-            if(!is_writable($targetFolder)) 
1028
+            if (!is_writable($targetFolder)) 
1029 1029
             {
1030 1030
                 throw new FileHelper_Exception(
1031 1031
                     sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)),
@@ -1038,7 +1038,7 @@  discard block
 block discarded – undo
1038 1038
             }
1039 1039
         }
1040 1040
         
1041
-        if(file_put_contents($filePath, $content) !== false) {
1041
+        if (file_put_contents($filePath, $content) !== false) {
1042 1042
             return;
1043 1043
         }
1044 1044
         
@@ -1074,7 +1074,7 @@  discard block
 block discarded – undo
1074 1074
     {
1075 1075
         static $checked = array();
1076 1076
         
1077
-        if(isset($checked[$command])) {
1077
+        if (isset($checked[$command])) {
1078 1078
             return $checked[$command];
1079 1079
         }
1080 1080
         
@@ -1087,7 +1087,7 @@  discard block
 block discarded – undo
1087 1087
         
1088 1088
         $os = strtolower(PHP_OS_FAMILY);
1089 1089
         
1090
-        if(!isset($osCommands[$os])) 
1090
+        if (!isset($osCommands[$os])) 
1091 1091
         {
1092 1092
             throw new FileHelper_Exception(
1093 1093
                 'Unsupported OS for CLI commands',
@@ -1113,7 +1113,7 @@  discard block
 block discarded – undo
1113 1113
             $pipes
1114 1114
         );
1115 1115
         
1116
-        if($process === false) {
1116
+        if ($process === false) {
1117 1117
             $checked[$command] = false;
1118 1118
             return false;
1119 1119
         }
@@ -1144,7 +1144,7 @@  discard block
 block discarded – undo
1144 1144
     */
1145 1145
     public static function checkPHPFileSyntax($path)
1146 1146
     {
1147
-        if(!self::canMakePHPCalls()) {
1147
+        if (!self::canMakePHPCalls()) {
1148 1148
             return true;
1149 1149
         }
1150 1150
         
@@ -1155,7 +1155,7 @@  discard block
 block discarded – undo
1155 1155
         // when the validation is successful, the first entry
1156 1156
         // in the array contains the success message. When it
1157 1157
         // is invalid, the first entry is always empty.
1158
-        if(!empty($output[0])) {
1158
+        if (!empty($output[0])) {
1159 1159
             return true;
1160 1160
         }
1161 1161
         
@@ -1176,7 +1176,7 @@  discard block
 block discarded – undo
1176 1176
     public static function getModifiedDate($path)
1177 1177
     {
1178 1178
         $time = filemtime($path);
1179
-        if($time !== false) {
1179
+        if ($time !== false) {
1180 1180
             $date = new \DateTime();
1181 1181
             $date->setTimestamp($time);
1182 1182
             return $date;
@@ -1203,7 +1203,7 @@  discard block
 block discarded – undo
1203 1203
     */
1204 1204
     public static function getSubfolders($targetFolder, $options = array())
1205 1205
     {
1206
-        if(!is_dir($targetFolder)) 
1206
+        if (!is_dir($targetFolder)) 
1207 1207
         {
1208 1208
             throw new FileHelper_Exception(
1209 1209
                 'Target folder does not exist',
@@ -1227,29 +1227,29 @@  discard block
 block discarded – undo
1227 1227
         
1228 1228
         $d = new \DirectoryIterator($targetFolder);
1229 1229
         
1230
-        foreach($d as $item) 
1230
+        foreach ($d as $item) 
1231 1231
         {
1232
-            if($item->isDir() && !$item->isDot()) 
1232
+            if ($item->isDir() && !$item->isDot()) 
1233 1233
             {
1234 1234
                 $name = $item->getFilename();
1235 1235
                 
1236
-                if(!$options['absolute-path']) {
1236
+                if (!$options['absolute-path']) {
1237 1237
                     $result[] = $name;
1238 1238
                 } else {
1239 1239
                     $result[] = $targetFolder.'/'.$name;
1240 1240
                 }
1241 1241
                 
1242
-                if(!$options['recursive']) 
1242
+                if (!$options['recursive']) 
1243 1243
                 {
1244 1244
                     continue;
1245 1245
                 }
1246 1246
                 
1247 1247
                 $subs = self::getSubfolders($targetFolder.'/'.$name, $options);
1248
-                foreach($subs as $sub) 
1248
+                foreach ($subs as $sub) 
1249 1249
                 {
1250 1250
                     $relative = $name.'/'.$sub;
1251 1251
                     
1252
-                    if(!$options['absolute-path']) {
1252
+                    if (!$options['absolute-path']) {
1253 1253
                         $result[] = $relative;
1254 1254
                     } else {
1255 1255
                         $result[] = $targetFolder.'/'.$relative;
@@ -1317,7 +1317,7 @@  discard block
 block discarded – undo
1317 1317
     * @param int $depth The folder depth to reduce the path to
1318 1318
     * @return string
1319 1319
     */
1320
-    public static function relativizePathByDepth(string $path, int $depth=2) : string
1320
+    public static function relativizePathByDepth(string $path, int $depth = 2) : string
1321 1321
     {
1322 1322
         $path = self::normalizePath($path);
1323 1323
         
@@ -1325,17 +1325,17 @@  discard block
 block discarded – undo
1325 1325
         $tokens = array_filter($tokens); // remove empty entries (trailing slash for example)
1326 1326
         $tokens = array_values($tokens); // re-index keys
1327 1327
         
1328
-        if(empty($tokens)) {
1328
+        if (empty($tokens)) {
1329 1329
             return '';
1330 1330
         }
1331 1331
         
1332 1332
         // remove the drive if present
1333
-        if(strstr($tokens[0], ':')) {
1333
+        if (strstr($tokens[0], ':')) {
1334 1334
             array_shift($tokens);
1335 1335
         }
1336 1336
         
1337 1337
         // path was only the drive
1338
-        if(count($tokens) == 0) {
1338
+        if (count($tokens) == 0) {
1339 1339
             return '';
1340 1340
         }
1341 1341
 
@@ -1344,8 +1344,8 @@  discard block
 block discarded – undo
1344 1344
         
1345 1345
         // reduce the path to the specified depth
1346 1346
         $length = count($tokens);
1347
-        if($length > $depth) {
1348
-            $tokens = array_slice($tokens, $length-$depth);
1347
+        if ($length > $depth) {
1348
+            $tokens = array_slice($tokens, $length - $depth);
1349 1349
         }
1350 1350
 
1351 1351
         // append the last element again
@@ -1393,14 +1393,14 @@  discard block
 block discarded – undo
1393 1393
     * 
1394 1394
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1395 1395
     */
1396
-    public static function requireFileExists(string $path, $errorCode=null) : string
1396
+    public static function requireFileExists(string $path, $errorCode = null) : string
1397 1397
     {
1398 1398
         $result = realpath($path);
1399
-        if($result !== false) {
1399
+        if ($result !== false) {
1400 1400
             return $result;
1401 1401
         }
1402 1402
         
1403
-        if($errorCode === null) {
1403
+        if ($errorCode === null) {
1404 1404
             $errorCode = self::ERROR_FILE_DOES_NOT_EXIST;
1405 1405
         }
1406 1406
         
@@ -1429,15 +1429,15 @@  discard block
 block discarded – undo
1429 1429
         
1430 1430
         $file = new \SplFileObject($path);
1431 1431
         
1432
-        if($file->eof()) {
1432
+        if ($file->eof()) {
1433 1433
             return '';
1434 1434
         }
1435 1435
         
1436
-        $targetLine = $lineNumber-1;
1436
+        $targetLine = $lineNumber - 1;
1437 1437
         
1438 1438
         $file->seek($targetLine);
1439 1439
         
1440
-        if($file->key() !== $targetLine) {
1440
+        if ($file->key() !== $targetLine) {
1441 1441
              return null;
1442 1442
         }
1443 1443
         
@@ -1463,7 +1463,7 @@  discard block
 block discarded – undo
1463 1463
         $number = $spl->key();
1464 1464
         
1465 1465
         // if seeking to the end the cursor is still at 0, there are no lines. 
1466
-        if($number === 0) 
1466
+        if ($number === 0) 
1467 1467
         {
1468 1468
             // since it's a very small file, to get reliable results,
1469 1469
             // we read its contents and use that to determine what
@@ -1471,13 +1471,13 @@  discard block
 block discarded – undo
1471 1471
             // that this is not pactical to solve with the SplFileObject.
1472 1472
             $content = file_get_contents($path);
1473 1473
             
1474
-            if(empty($content)) {
1474
+            if (empty($content)) {
1475 1475
                 return 0;
1476 1476
             }
1477 1477
         }
1478 1478
         
1479 1479
         // return the line number we were able to reach + 1 (key is zero-based)
1480
-        return $number+1;
1480
+        return $number + 1;
1481 1481
     }
1482 1482
     
1483 1483
    /**
@@ -1524,13 +1524,13 @@  discard block
 block discarded – undo
1524 1524
     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1525 1525
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1526 1526
     */
1527
-    public static function readLines(string $filePath, int $amount=0) : array
1527
+    public static function readLines(string $filePath, int $amount = 0) : array
1528 1528
     {
1529 1529
         self::requireFileExists($filePath);
1530 1530
         
1531 1531
         $fn = fopen($filePath, "r");
1532 1532
         
1533
-        if($fn === false) 
1533
+        if ($fn === false) 
1534 1534
         {
1535 1535
             throw new FileHelper_Exception(
1536 1536
                 'Could not open file for reading.',
@@ -1546,25 +1546,25 @@  discard block
 block discarded – undo
1546 1546
         $counter = 0;
1547 1547
         $first = true;
1548 1548
         
1549
-        while(!feof($fn)) 
1549
+        while (!feof($fn)) 
1550 1550
         {
1551 1551
             $counter++;
1552 1552
             
1553 1553
             $line = fgets($fn);
1554 1554
             
1555 1555
             // can happen with zero length files
1556
-            if($line === false) {
1556
+            if ($line === false) {
1557 1557
                 continue;
1558 1558
             }
1559 1559
             
1560 1560
             // the first line may contain a unicode BOM marker.
1561
-            if($first) {
1561
+            if ($first) {
1562 1562
                 $line = ConvertHelper::stripUTFBom($line);
1563 1563
             }
1564 1564
             
1565 1565
             $result[] = $line;
1566 1566
             
1567
-            if($amount > 0 && $counter == $amount) {
1567
+            if ($amount > 0 && $counter == $amount) {
1568 1568
                 break;
1569 1569
             }
1570 1570
         }
@@ -1590,7 +1590,7 @@  discard block
 block discarded – undo
1590 1590
         
1591 1591
         $result = file_get_contents($filePath);
1592 1592
         
1593
-        if($result !== false) {
1593
+        if ($result !== false) {
1594 1594
             return $result;
1595 1595
         }
1596 1596
         
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.
src/NumberInfo.php 3 patches
Spacing   +37 added lines, -37 removed lines patch added patch discarded remove patch
@@ -84,7 +84,7 @@  discard block
 block discarded – undo
84 84
      */
85 85
     public function setValue($value) : NumberInfo
86 86
     {
87
-        if($value instanceof NumberInfo) {
87
+        if ($value instanceof NumberInfo) {
88 88
             $value = $value->getValue();
89 89
         }
90 90
         
@@ -117,7 +117,7 @@  discard block
 block discarded – undo
117 117
     
118 118
     public function isPositive() : bool
119 119
     {
120
-        if(!$this->isEmpty()) {
120
+        if (!$this->isEmpty()) {
121 121
             $number = $this->getNumber();
122 122
             return $number > 0;
123 123
         }
@@ -148,7 +148,7 @@  discard block
 block discarded – undo
148 148
      */
149 149
     public function hasValue() : bool
150 150
     {
151
-        if(!$this->isEmpty() && !$this->isZero()) {
151
+        if (!$this->isEmpty() && !$this->isZero()) {
152 152
             return true;
153 153
         }
154 154
         
@@ -221,7 +221,7 @@  discard block
 block discarded – undo
221 221
      */
222 222
     public function getUnits()
223 223
     {
224
-        if(!$this->hasUnits()) {
224
+        if (!$this->hasUnits()) {
225 225
             return 'px';
226 226
         }
227 227
         
@@ -255,15 +255,15 @@  discard block
 block discarded – undo
255 255
      */
256 256
     public function toAttribute()
257 257
     {
258
-        if($this->isEmpty()) {
258
+        if ($this->isEmpty()) {
259 259
             return null;
260 260
         }
261 261
         
262
-        if($this->isZero()) {
262
+        if ($this->isZero()) {
263 263
             return '0';
264 264
         }
265 265
         
266
-        if($this->isPercent()) {
266
+        if ($this->isPercent()) {
267 267
             return $this->getNumber().$this->getUnits();
268 268
         }
269 269
         
@@ -276,11 +276,11 @@  discard block
 block discarded – undo
276 276
      */
277 277
     public function toCSS()
278 278
     {
279
-        if($this->isEmpty()) {
279
+        if ($this->isEmpty()) {
280 280
             return null;
281 281
         }
282 282
         
283
-        if($this->isZero()) {
283
+        if ($this->isZero()) {
284 284
             return '0';
285 285
         }
286 286
         
@@ -289,7 +289,7 @@  discard block
 block discarded – undo
289 289
     
290 290
     public function __toString()
291 291
     {
292
-        if($this->isEmpty()) {
292
+        if ($this->isEmpty()) {
293 293
             return '';
294 294
         }
295 295
         
@@ -307,7 +307,7 @@  discard block
 block discarded – undo
307 307
     public function isBiggerThan($number)
308 308
     {
309 309
         $number = parseNumber($number);
310
-        if($number->getUnits() != $this->getUnits()) {
310
+        if ($number->getUnits() != $this->getUnits()) {
311 311
             return false;
312 312
         }
313 313
         
@@ -325,7 +325,7 @@  discard block
 block discarded – undo
325 325
     public function isSmallerThan($number)
326 326
     {
327 327
         $number = parseNumber($number);
328
-        if($number->getUnits() != $this->getUnits()) {
328
+        if ($number->getUnits() != $this->getUnits()) {
329 329
             return false;
330 330
         }
331 331
         
@@ -335,7 +335,7 @@  discard block
 block discarded – undo
335 335
     public function isBiggerEqual($number)
336 336
     {
337 337
         $number = parseNumber($number);
338
-        if($number->getUnits() != $this->getUnits()) {
338
+        if ($number->getUnits() != $this->getUnits()) {
339 339
             return false;
340 340
         }
341 341
         
@@ -352,14 +352,14 @@  discard block
 block discarded – undo
352 352
      */
353 353
     public function add($value)
354 354
     {
355
-        if($this->isEmpty()) {
355
+        if ($this->isEmpty()) {
356 356
             $this->setValue($value);
357 357
             return $this;
358 358
         }
359 359
         
360 360
         $number = parseNumber($value);
361 361
         
362
-        if($number->getUnits() == $this->getUnits() || !$number->hasUnits())
362
+        if ($number->getUnits() == $this->getUnits() || !$number->hasUnits())
363 363
         {
364 364
             $new = $this->getNumber() + $number->getNumber();
365 365
             $this->setValue($new.$this->getUnits());
@@ -378,14 +378,14 @@  discard block
 block discarded – undo
378 378
      */
379 379
     public function subtract($value)
380 380
     {
381
-        if($this->isEmpty()) {
381
+        if ($this->isEmpty()) {
382 382
             $this->setValue($value);
383 383
             return $this;
384 384
         }
385 385
         
386 386
         $number = parseNumber($value);
387 387
         
388
-        if($number->getUnits() == $this->getUnits() || !$number->hasUnits())
388
+        if ($number->getUnits() == $this->getUnits() || !$number->hasUnits())
389 389
         {
390 390
             $new = $this->getNumber() - $number->getNumber();
391 391
             $this->setValue($new.$this->getUnits());
@@ -412,25 +412,25 @@  discard block
 block discarded – undo
412 412
     
413 413
     protected function percentOperation($operation, $percent)
414 414
     {
415
-        if($this->isZeroOrEmpty()) {
415
+        if ($this->isZeroOrEmpty()) {
416 416
             return $this;
417 417
         }
418 418
         
419 419
         $percent = parseNumber($percent);
420
-        if($percent->hasUnits() && !$percent->isPercent()) {
420
+        if ($percent->hasUnits() && !$percent->isPercent()) {
421 421
             return $this;
422 422
         }
423 423
         
424 424
         $number = $this->getNumber();
425 425
         $value = $number * $percent->getNumber() / 100;
426 426
         
427
-        if($operation == '-') {
427
+        if ($operation == '-') {
428 428
             $number = $number - $value;
429 429
         } else {
430 430
             $number = $number + $value;
431 431
         }
432 432
         
433
-        if($this->isUnitInteger()) {
433
+        if ($this->isUnitInteger()) {
434 434
             $number = intval($number);
435 435
         }
436 436
         
@@ -479,7 +479,7 @@  discard block
 block discarded – undo
479 479
     {
480 480
         static $cache = array();
481 481
         
482
-        if(!is_string($value) && !is_numeric($value)) 
482
+        if (!is_string($value) && !is_numeric($value)) 
483 483
         {
484 484
             $value = '';
485 485
             $key = '_EMPTY_';
@@ -489,7 +489,7 @@  discard block
 block discarded – undo
489 489
             $key = (string)$value;
490 490
         }
491 491
 
492
-        if(array_key_exists($key, $cache)) {
492
+        if (array_key_exists($key, $cache)) {
493 493
             return $cache[$key];
494 494
         }
495 495
         
@@ -499,31 +499,31 @@  discard block
 block discarded – undo
499 499
             'number' => null
500 500
         );
501 501
         
502
-        if($value === '') {
502
+        if ($value === '') {
503 503
             $cache[$key]['empty'] = true;
504 504
             return $cache[$key];
505 505
         }
506 506
         
507
-        if($value === 0 || $value === '0') {
507
+        if ($value === 0 || $value === '0') {
508 508
             $cache[$key]['number'] = 0;
509 509
             $cache[$key] = $this->filterInfo($cache[$key]);
510 510
             return $cache[$key];
511 511
         }
512 512
         
513 513
         $test = trim((string)$value);
514
-        if($test === '') {
514
+        if ($test === '') {
515 515
             $cache[$key]['empty'] = true;
516 516
             return $cache[$key];
517 517
         }
518 518
         
519 519
         // replace comma notation (which is only possible if it's a string)
520
-        if(is_string($value))
520
+        if (is_string($value))
521 521
         {
522 522
             $test = $this->preProcess($test, $cache, $value);
523 523
         }
524 524
         
525 525
         // convert to a number if it's numeric
526
-        if(is_numeric($test)) {
526
+        if (is_numeric($test)) {
527 527
             $cache[$key]['number'] = $test * 1;
528 528
             $cache[$key] = $this->filterInfo($cache[$key]);
529 529
             return $cache[$key];
@@ -536,16 +536,16 @@  discard block
 block discarded – undo
536 536
         
537 537
         $vlength = strlen($test);
538 538
         $names = array_keys($this->knownUnits);
539
-        foreach($names as $unit)
539
+        foreach ($names as $unit)
540 540
         {
541 541
             $ulength = strlen($unit);
542
-            $start = $vlength-$ulength;
543
-            if($start < 0) {
542
+            $start = $vlength - $ulength;
543
+            if ($start < 0) {
544 544
                 continue;
545 545
             }
546 546
             
547 547
             $search = substr($test, $start, $ulength);
548
-            if($search==$unit) {
548
+            if ($search == $unit) {
549 549
                 $units = $unit;
550 550
                 $number = substr($test, 0, $start);
551 551
                 break;
@@ -553,12 +553,12 @@  discard block
 block discarded – undo
553 553
         }
554 554
         
555 555
         // the filters have to restore the value
556
-        if($this->postProcess)
556
+        if ($this->postProcess)
557 557
         {
558 558
             $number = $this->postProcess($number, $test);
559 559
         }
560 560
         // empty number
561
-        else if($number === '' || $number === null || is_bool($number))
561
+        else if ($number === '' || $number === null || is_bool($number))
562 562
         {
563 563
             $number = null;
564 564
             $cache[$key]['empty'] = true;
@@ -569,7 +569,7 @@  discard block
 block discarded – undo
569 569
             $number = trim($number);
570 570
             
571 571
             // may be an arbitrary string in some cases
572
-            if(!is_numeric($number))
572
+            if (!is_numeric($number))
573 573
             {
574 574
                 $number = null;
575 575
                 $cache[$key]['empty'] = true;
@@ -648,12 +648,12 @@  discard block
 block discarded – undo
648 648
     protected function filterInfo(array $info) : array
649 649
     {
650 650
         $useUnits = 'px';
651
-        if($info['units'] !== null) {
651
+        if ($info['units'] !== null) {
652 652
             $useUnits = $info['units'];
653 653
         }
654 654
         
655 655
         // the units are non-decimal: convert decimal values
656
-        if($useUnits !== null && $this->knownUnits[$useUnits] === false && !$info['empty'] && is_numeric($info['number']))
656
+        if ($useUnits !== null && $this->knownUnits[$useUnits] === false && !$info['empty'] && is_numeric($info['number']))
657 657
         {
658 658
             $info['number'] = intval($info['number']);
659 659
         }
Please login to merge, or discard this patch.
Braces   +2 added lines, -4 removed lines patch added patch discarded remove patch
@@ -483,8 +483,7 @@  discard block
 block discarded – undo
483 483
         {
484 484
             $value = '';
485 485
             $key = '_EMPTY_';
486
-        } 
487
-        else 
486
+        } else 
488 487
         {
489 488
             $key = (string)$value;
490 489
         }
@@ -573,8 +572,7 @@  discard block
 block discarded – undo
573 572
             {
574 573
                 $number = null;
575 574
                 $cache[$key]['empty'] = true;
576
-            }
577
-            else
575
+            } else
578 576
             {
579 577
                 $number = $number * 1;
580 578
             }
Please login to merge, or discard this patch.
Indentation   +59 added lines, -59 removed lines patch added patch discarded remove patch
@@ -38,24 +38,24 @@  discard block
 block discarded – undo
38 38
  */
39 39
 class NumberInfo
40 40
 {
41
-   /**
42
-    * @var mixed
43
-    */
41
+    /**
42
+     * @var mixed
43
+     */
44 44
     protected $rawValue;
45 45
     
46
-   /**
47
-    * @var array
48
-    */
46
+    /**
47
+     * @var array
48
+     */
49 49
     protected $info;
50 50
     
51
-   /**
52
-    * @var bool
53
-    */
51
+    /**
52
+     * @var bool
53
+     */
54 54
     protected $empty = false;
55 55
     
56
-   /**
57
-    * @var array
58
-    */
56
+    /**
57
+     * @var array
58
+     */
59 59
     protected $knownUnits = array(
60 60
         '%' => true,
61 61
         'rem' => true,
@@ -95,21 +95,21 @@  discard block
 block discarded – undo
95 95
         return $this;
96 96
     }
97 97
     
98
-   /**
99
-    * Retrieves the raw, internal information array resulting
100
-    * from the parsing of the number.
101
-    *  
102
-    * @return array
103
-    */
98
+    /**
99
+     * Retrieves the raw, internal information array resulting
100
+     * from the parsing of the number.
101
+     *  
102
+     * @return array
103
+     */
104 104
     public function getRawInfo() : array
105 105
     {
106 106
         return $this->info;
107 107
     }
108 108
     
109
-   /**
110
-    * Whether the number was empty (null or empty string).
111
-    * @return boolean
112
-    */
109
+    /**
110
+     * Whether the number was empty (null or empty string).
111
+     * @return boolean
112
+     */
113 113
     public function isEmpty() : bool
114 114
     {
115 115
         return $this->empty;
@@ -590,59 +590,59 @@  discard block
 block discarded – undo
590 590
     
591 591
     protected $postProcess = false;
592 592
     
593
-   /**
594
-    * Called if explicitly enabled: allows filtering the 
595
-    * number after the detection process has completed.
596
-    * 
597
-    * @param string|NULL $number The adjusted number
598
-    * @param string $originalString The original value before it was parsed
599
-    * @return mixed
600
-    */
593
+    /**
594
+     * Called if explicitly enabled: allows filtering the 
595
+     * number after the detection process has completed.
596
+     * 
597
+     * @param string|NULL $number The adjusted number
598
+     * @param string $originalString The original value before it was parsed
599
+     * @return mixed
600
+     */
601 601
     protected function postProcess(?string $number, /** @scrutinizer ignore-unused */ string $originalString)
602 602
     {
603 603
         return $number;
604 604
     }
605 605
     
606
-   /**
607
-    * Filters the value before it is parsed, but only if it is a string.
608
-    * 
609
-    * NOTE: This may be overwritten in a subclass, to allow custom filtering
610
-    * the the values. An example of a use case would be a preprocessor for
611
-    * variables in a templating system.
612
-    * 
613
-    * @param string $trimmedString The trimmed value.
614
-    * @param array $cache The internal values cache array.
615
-    * @param string $originalValue The original value that the NumberInfo was created for.
616
-    * @return string
617
-    * 
618
-    * @see NumberInfo::enablePostProcess()
619
-    */
606
+    /**
607
+     * Filters the value before it is parsed, but only if it is a string.
608
+     * 
609
+     * NOTE: This may be overwritten in a subclass, to allow custom filtering
610
+     * the the values. An example of a use case would be a preprocessor for
611
+     * variables in a templating system.
612
+     * 
613
+     * @param string $trimmedString The trimmed value.
614
+     * @param array $cache The internal values cache array.
615
+     * @param string $originalValue The original value that the NumberInfo was created for.
616
+     * @return string
617
+     * 
618
+     * @see NumberInfo::enablePostProcess()
619
+     */
620 620
     protected function preProcess(string $trimmedString, /** @scrutinizer ignore-unused */ array &$cache, /** @scrutinizer ignore-unused */ string $originalValue) : string
621 621
     {
622 622
         return str_replace(',', '.', $trimmedString);
623 623
     }
624 624
     
625
-   /**
626
-    * Enables the post processing so the postProcess method gets called.
627
-    * This should be called in the {@link NumberInfo::preProcess()}
628
-    * method as needed.
629
-    * 
630
-    * @return NumberInfo
631
-    * @see NumberInfo::postProcess()
632
-    */
625
+    /**
626
+     * Enables the post processing so the postProcess method gets called.
627
+     * This should be called in the {@link NumberInfo::preProcess()}
628
+     * method as needed.
629
+     * 
630
+     * @return NumberInfo
631
+     * @see NumberInfo::postProcess()
632
+     */
633 633
     private function enablePostProcess() : NumberInfo
634 634
     {
635 635
         $this->postProcess = true;
636 636
         return $this;
637 637
     }
638 638
     
639
-   /**
640
-    * Filters the number info array to adjust the units
641
-    * and number according to the required rules.
642
-    * 
643
-    * @param array $info
644
-    * @return array
645
-    */
639
+    /**
640
+     * Filters the number info array to adjust the units
641
+     * and number according to the required rules.
642
+     * 
643
+     * @param array $info
644
+     * @return array
645
+     */
646 646
     protected function filterInfo(array $info) : array
647 647
     {
648 648
         $useUnits = 'px';
Please login to merge, or discard this patch.
src/Traits/Optionable.php 2 patches
Indentation   +102 added lines, -102 removed lines patch added patch discarded remove patch
@@ -26,19 +26,19 @@  discard block
 block discarded – undo
26 26
  */
27 27
 trait Traits_Optionable
28 28
 {
29
-   /**
30
-    * @var array
31
-    */
29
+    /**
30
+     * @var array
31
+     */
32 32
     protected $options;
33 33
     
34
-   /**
35
-    * Sets an option to the specified value. This can be any
36
-    * kind of variable type, including objects, as needed.
37
-    * 
38
-    * @param string $name
39
-    * @param mixed $default
40
-    * @return Interface_Optionable
41
-    */
34
+    /**
35
+     * Sets an option to the specified value. This can be any
36
+     * kind of variable type, including objects, as needed.
37
+     * 
38
+     * @param string $name
39
+     * @param mixed $default
40
+     * @return Interface_Optionable
41
+     */
42 42
     public function setOption(string $name, $value)
43 43
     {
44 44
         if(!isset($this->options)) {
@@ -49,13 +49,13 @@  discard block
 block discarded – undo
49 49
         return $this;
50 50
     }
51 51
     
52
-   /**
53
-    * Sets a collection of options at once, from an
54
-    * associative array.
55
-    * 
56
-    * @param array $options
57
-    * @return Interface_Optionable
58
-    */
52
+    /**
53
+     * Sets a collection of options at once, from an
54
+     * associative array.
55
+     * 
56
+     * @param array $options
57
+     * @return Interface_Optionable
58
+     */
59 59
     public function setOptions(array $options)
60 60
     {
61 61
         foreach($options as $name => $value) {
@@ -65,16 +65,16 @@  discard block
 block discarded – undo
65 65
         return $this;
66 66
     }
67 67
     
68
-   /**
69
-    * Retrieves an option's value.
70
-    * 
71
-    * NOTE: Use the specialized type getters to ensure an option
72
-    * contains the expected type (for ex. getArrayOption()). 
73
-    * 
74
-    * @param string $name
75
-    * @param mixed $default The default value to return if the option does not exist.
76
-    * @return mixed
77
-    */
68
+    /**
69
+     * Retrieves an option's value.
70
+     * 
71
+     * NOTE: Use the specialized type getters to ensure an option
72
+     * contains the expected type (for ex. getArrayOption()). 
73
+     * 
74
+     * @param string $name
75
+     * @param mixed $default The default value to return if the option does not exist.
76
+     * @return mixed
77
+     */
78 78
     public function getOption(string $name, $default=null)
79 79
     {
80 80
         if(!isset($this->options)) {
@@ -88,16 +88,16 @@  discard block
 block discarded – undo
88 88
         return $default;
89 89
     }
90 90
     
91
-   /**
92
-    * Enforces that the option value is a string. Numbers are converted
93
-    * to string, strings are passed through, and all other types will 
94
-    * return the default value. The default value is also returned if
95
-    * the string is empty.
96
-    * 
97
-    * @param string $name
98
-    * @param string $default Used if the option does not exist, is invalid, or empty.
99
-    * @return string
100
-    */
91
+    /**
92
+     * Enforces that the option value is a string. Numbers are converted
93
+     * to string, strings are passed through, and all other types will 
94
+     * return the default value. The default value is also returned if
95
+     * the string is empty.
96
+     * 
97
+     * @param string $name
98
+     * @param string $default Used if the option does not exist, is invalid, or empty.
99
+     * @return string
100
+     */
101 101
     public function getStringOption(string $name, string $default='') : string
102 102
     {
103 103
         $value = $this->getOption($name, false);
@@ -109,15 +109,15 @@  discard block
 block discarded – undo
109 109
         return $default;
110 110
     }
111 111
     
112
-   /**
113
-    * Treats the option value as a boolean value: will return
114
-    * true if the value actually is a boolean true.
115
-    * 
116
-    * NOTE: boolean string representations are not accepted.
117
-    * 
118
-    * @param string $name
119
-    * @return bool
120
-    */
112
+    /**
113
+     * Treats the option value as a boolean value: will return
114
+     * true if the value actually is a boolean true.
115
+     * 
116
+     * NOTE: boolean string representations are not accepted.
117
+     * 
118
+     * @param string $name
119
+     * @return bool
120
+     */
121 121
     public function getBoolOption(string $name, bool $default=false) : bool
122 122
     {
123 123
         if($this->getOption($name) === true) {
@@ -127,15 +127,15 @@  discard block
 block discarded – undo
127 127
         return $default;
128 128
     }
129 129
     
130
-   /**
131
-    * Treats the option value as an integer value: will return
132
-    * valid integer values (also from integer strings), or the
133
-    * default value otherwise.
134
-    * 
135
-    * @param string $name
136
-    * @param int $default
137
-    * @return int
138
-    */
130
+    /**
131
+     * Treats the option value as an integer value: will return
132
+     * valid integer values (also from integer strings), or the
133
+     * default value otherwise.
134
+     * 
135
+     * @param string $name
136
+     * @param int $default
137
+     * @return int
138
+     */
139 139
     public function getIntOption(string $name, int $default=0) : int
140 140
     {
141 141
         $value = $this->getOption($name);
@@ -146,14 +146,14 @@  discard block
 block discarded – undo
146 146
         return $default;
147 147
     }
148 148
     
149
-   /**
150
-    * Treats an option as an array, and returns its value
151
-    * only if it contains an array - otherwise, an empty
152
-    * array is returned.
153
-    * 
154
-    * @param string $name
155
-    * @return array
156
-    */
149
+    /**
150
+     * Treats an option as an array, and returns its value
151
+     * only if it contains an array - otherwise, an empty
152
+     * array is returned.
153
+     * 
154
+     * @param string $name
155
+     * @return array
156
+     */
157 157
     public function getArrayOption(string $name) : array
158 158
     {
159 159
         $val = $this->getOption($name);
@@ -164,13 +164,13 @@  discard block
 block discarded – undo
164 164
         return array();
165 165
     }
166 166
     
167
-   /**
168
-    * Checks whether the specified option exists - even
169
-    * if it has a NULL value.
170
-    * 
171
-    * @param string $name
172
-    * @return bool
173
-    */
167
+    /**
168
+     * Checks whether the specified option exists - even
169
+     * if it has a NULL value.
170
+     * 
171
+     * @param string $name
172
+     * @return bool
173
+     */
174 174
     public function hasOption(string $name) : bool
175 175
     {
176 176
         if(!isset($this->options)) {
@@ -180,10 +180,10 @@  discard block
 block discarded – undo
180 180
         return array_key_exists($name, $this->options);
181 181
     }
182 182
     
183
-   /**
184
-    * Returns all options in one associative array.
185
-    * @return array
186
-    */
183
+    /**
184
+     * Returns all options in one associative array.
185
+     * @return array
186
+     */
187 187
     public function getOptions() : array
188 188
     {
189 189
         if(!isset($this->options)) {
@@ -193,24 +193,24 @@  discard block
 block discarded – undo
193 193
         return $this->options;
194 194
     }
195 195
     
196
-   /**
197
-    * Checks whether the option's value is the one specified.
198
-    * 
199
-    * @param string $name
200
-    * @param mixed $value
201
-    * @return bool
202
-    */
196
+    /**
197
+     * Checks whether the option's value is the one specified.
198
+     * 
199
+     * @param string $name
200
+     * @param mixed $value
201
+     * @return bool
202
+     */
203 203
     public function isOption(string $name, $value) : bool
204 204
     {
205 205
         return $this->getOption($name) === $value;
206 206
     }
207 207
     
208
-   /**
209
-    * Retrieves the default available options as an 
210
-    * associative array with option name => value pairs.
211
-    * 
212
-    * @return array
213
-    */
208
+    /**
209
+     * Retrieves the default available options as an 
210
+     * associative array with option name => value pairs.
211
+     * 
212
+     * @return array
213
+     */
214 214
     abstract public function getDefaultOptions() : array;
215 215
 }
216 216
 
@@ -228,24 +228,24 @@  discard block
 block discarded – undo
228 228
  */
229 229
 interface Interface_Optionable
230 230
 {
231
-   /**
232
-    * @param string $name
233
-    * @param mixed $value
234
-    * @return Interface_Optionable
235
-    */
231
+    /**
232
+     * @param string $name
233
+     * @param mixed $value
234
+     * @return Interface_Optionable
235
+     */
236 236
     function setOption(string $name, $value);
237 237
     
238
-   /**
239
-    * @param string $name
240
-    * @param mixed $default
241
-    * @return Interface_Optionable
242
-    */
238
+    /**
239
+     * @param string $name
240
+     * @param mixed $default
241
+     * @return Interface_Optionable
242
+     */
243 243
     function getOption(string $name, $default=null);
244 244
     
245
-   /**
246
-    * @param array $options
247
-    * @return Interface_Optionable    
248
-    */
245
+    /**
246
+     * @param array $options
247
+     * @return Interface_Optionable    
248
+     */
249 249
     function setOptions(array $options);
250 250
     function getOptions() : array;
251 251
     function isOption(string $name, $value) : bool;
Please login to merge, or discard this patch.
Spacing   +15 added lines, -15 removed lines patch added patch discarded remove patch
@@ -41,7 +41,7 @@  discard block
 block discarded – undo
41 41
     */
42 42
     public function setOption(string $name, $value)
43 43
     {
44
-        if(!isset($this->options)) {
44
+        if (!isset($this->options)) {
45 45
             $this->options = $this->getDefaultOptions();
46 46
         }
47 47
         
@@ -58,7 +58,7 @@  discard block
 block discarded – undo
58 58
     */
59 59
     public function setOptions(array $options)
60 60
     {
61
-        foreach($options as $name => $value) {
61
+        foreach ($options as $name => $value) {
62 62
             $this->setOption($name, $value);
63 63
         }
64 64
         
@@ -75,13 +75,13 @@  discard block
 block discarded – undo
75 75
     * @param mixed $default The default value to return if the option does not exist.
76 76
     * @return mixed
77 77
     */
78
-    public function getOption(string $name, $default=null)
78
+    public function getOption(string $name, $default = null)
79 79
     {
80
-        if(!isset($this->options)) {
80
+        if (!isset($this->options)) {
81 81
             $this->options = $this->getDefaultOptions();
82 82
         }
83 83
         
84
-        if(isset($this->options[$name])) {
84
+        if (isset($this->options[$name])) {
85 85
             return $this->options[$name];
86 86
         }
87 87
         
@@ -98,11 +98,11 @@  discard block
 block discarded – undo
98 98
     * @param string $default Used if the option does not exist, is invalid, or empty.
99 99
     * @return string
100 100
     */
101
-    public function getStringOption(string $name, string $default='') : string
101
+    public function getStringOption(string $name, string $default = '') : string
102 102
     {
103 103
         $value = $this->getOption($name, false);
104 104
         
105
-        if((is_string($value) || is_numeric($value)) && !empty($value)) {
105
+        if ((is_string($value) || is_numeric($value)) && !empty($value)) {
106 106
             return (string)$value;
107 107
         }
108 108
         
@@ -118,9 +118,9 @@  discard block
 block discarded – undo
118 118
     * @param string $name
119 119
     * @return bool
120 120
     */
121
-    public function getBoolOption(string $name, bool $default=false) : bool
121
+    public function getBoolOption(string $name, bool $default = false) : bool
122 122
     {
123
-        if($this->getOption($name) === true) {
123
+        if ($this->getOption($name) === true) {
124 124
             return true;
125 125
         }
126 126
         
@@ -136,10 +136,10 @@  discard block
 block discarded – undo
136 136
     * @param int $default
137 137
     * @return int
138 138
     */
139
-    public function getIntOption(string $name, int $default=0) : int
139
+    public function getIntOption(string $name, int $default = 0) : int
140 140
     {
141 141
         $value = $this->getOption($name);
142
-        if(ConvertHelper::isInteger($value)) {
142
+        if (ConvertHelper::isInteger($value)) {
143 143
             return (int)$value;
144 144
         }
145 145
         
@@ -157,7 +157,7 @@  discard block
 block discarded – undo
157 157
     public function getArrayOption(string $name) : array
158 158
     {
159 159
         $val = $this->getOption($name);
160
-        if(is_array($val)) {
160
+        if (is_array($val)) {
161 161
             return $val;
162 162
         }
163 163
         
@@ -173,7 +173,7 @@  discard block
 block discarded – undo
173 173
     */
174 174
     public function hasOption(string $name) : bool
175 175
     {
176
-        if(!isset($this->options)) {
176
+        if (!isset($this->options)) {
177 177
             $this->options = $this->getDefaultOptions();
178 178
         }
179 179
         
@@ -186,7 +186,7 @@  discard block
 block discarded – undo
186 186
     */
187 187
     public function getOptions() : array
188 188
     {
189
-        if(!isset($this->options)) {
189
+        if (!isset($this->options)) {
190 190
             $this->options = $this->getDefaultOptions();
191 191
         }
192 192
         
@@ -240,7 +240,7 @@  discard block
 block discarded – undo
240 240
     * @param mixed $default
241 241
     * @return Interface_Optionable
242 242
     */
243
-    function getOption(string $name, $default=null);
243
+    function getOption(string $name, $default = null);
244 244
     
245 245
    /**
246 246
     * @param array $options
Please login to merge, or discard this patch.