Passed
Push — master ( cff939...bc9af2 )
by Sebastian
02:31
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
-    * @deprecated Will be replaced by the file finder in the future.
750
-    * @see FileHelper::createFileFinder()
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
+     * @deprecated Will be replaced by the file finder in the future.
750
+     * @see FileHelper::createFileFinder()
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
     * @deprecated Will be replaced by the file finder in the future.
750 750
     * @see FileHelper::createFileFinder()
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/ConvertHelper.php 3 patches
Braces   +1 added lines, -2 removed lines patch added patch discarded remove patch
@@ -1492,8 +1492,7 @@
 block discarded – undo
1492 1492
                 if (mb_strlen($actual.$word) <= $width) 
1493 1493
                 {
1494 1494
                     $actual .= $word.' ';
1495
-                } 
1496
-                else 
1495
+                } else 
1497 1496
                 {
1498 1497
                     if ($actual != '') {
1499 1498
                         $line .= rtrim($actual).$break;
Please login to merge, or discard this patch.
Indentation   +374 added lines, -374 removed lines patch added patch discarded remove patch
@@ -432,16 +432,16 @@  discard block
 block discarded – undo
432 432
         return $bytes . ' ' . t('B');
433 433
     }
434 434
 
435
-   /**
436
-    * Cuts a text to the specified length if it is longer than the
437
-    * target length. Appends a text to signify it has been cut at 
438
-    * the end of the string.
439
-    * 
440
-    * @param string $text
441
-    * @param int $targetLength
442
-    * @param string $append
443
-    * @return string
444
-    */
435
+    /**
436
+     * Cuts a text to the specified length if it is longer than the
437
+     * target length. Appends a text to signify it has been cut at 
438
+     * the end of the string.
439
+     * 
440
+     * @param string $text
441
+     * @param int $targetLength
442
+     * @param string $append
443
+     * @return string
444
+     */
445 445
     public static function text_cut(string $text, int $targetLength, string $append = '...') : string
446 446
     {
447 447
         $length = mb_strlen($text);
@@ -511,27 +511,27 @@  discard block
 block discarded – undo
511 511
         return self::$booleanStrings[$string];
512 512
     }
513 513
     
514
-   /**
515
-    * Whether the specified string is a boolean string or boolean value.
516
-    * Alias for {@link ConvertHelper::isBoolean()}.
517
-    * 
518
-    * @param mixed $string
519
-    * @return bool
520
-    * @deprecated
521
-    * @see ConvertHelper::isBoolean()
522
-    */
514
+    /**
515
+     * Whether the specified string is a boolean string or boolean value.
516
+     * Alias for {@link ConvertHelper::isBoolean()}.
517
+     * 
518
+     * @param mixed $string
519
+     * @return bool
520
+     * @deprecated
521
+     * @see ConvertHelper::isBoolean()
522
+     */
523 523
     public static function isBooleanString($string) : bool
524 524
     {
525 525
         return self::isBoolean($string);
526 526
     }
527 527
 
528
-   /**
529
-    * Alias for the {@\AppUtils\XMLHelper::string2xml()} method.
530
-    * 
531
-    * @param string $text
532
-    * @return string
533
-    * @deprecated
534
-    */
528
+    /**
529
+     * Alias for the {@\AppUtils\XMLHelper::string2xml()} method.
530
+     * 
531
+     * @param string $text
532
+     * @return string
533
+     * @deprecated
534
+     */
535 535
     public static function text_makeXMLCompliant($text)
536 536
     {
537 537
         return XMLHelper::string2xml($text);
@@ -633,13 +633,13 @@  discard block
 block discarded – undo
633 633
         return $translit->convert($string);
634 634
     }
635 635
     
636
-   /**
637
-    * Retrieves the HEX character codes for all control
638
-    * characters that the {@link stripControlCharacters()} 
639
-    * method will remove.
640
-    * 
641
-    * @return string[]
642
-    */
636
+    /**
637
+     * Retrieves the HEX character codes for all control
638
+     * characters that the {@link stripControlCharacters()} 
639
+     * method will remove.
640
+     * 
641
+     * @return string[]
642
+     */
643 643
     public static function getControlCharactersAsHex()
644 644
     {
645 645
         $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F');
@@ -675,13 +675,13 @@  discard block
 block discarded – undo
675 675
         return $stack;
676 676
     }
677 677
     
678
-   /**
679
-    * Retrieves an array of all control characters that
680
-    * the {@link stripControlCharacters()} method will 
681
-    * remove, as the actual UTF-8 characters.
682
-    * 
683
-    * @return string[]
684
-    */
678
+    /**
679
+     * Retrieves an array of all control characters that
680
+     * the {@link stripControlCharacters()} method will 
681
+     * remove, as the actual UTF-8 characters.
682
+     * 
683
+     * @return string[]
684
+     */
685 685
     public static function getControlCharactersAsUTF8()
686 686
     {
687 687
         $chars = self::getControlCharactersAsHex();
@@ -694,12 +694,12 @@  discard block
 block discarded – undo
694 694
         return $result;
695 695
     }
696 696
     
697
-   /**
698
-    * Retrieves all control characters as JSON encoded
699
-    * characters, e.g. "\u200b".
700
-    * 
701
-    * @return string[]
702
-    */
697
+    /**
698
+     * Retrieves all control characters as JSON encoded
699
+     * characters, e.g. "\u200b".
700
+     * 
701
+     * @return string[]
702
+     */
703 703
     public static function getControlCharactersAsJSON()
704 704
     {
705 705
         $chars = self::getControlCharactersAsHex();
@@ -756,20 +756,20 @@  discard block
 block discarded – undo
756 756
         return preg_replace(self::$controlCharsRegex, '', $string);
757 757
     }
758 758
 
759
-   /**
760
-    * Converts a unicode character to the PHPO notation.
761
-    * 
762
-    * Example:
763
-    * 
764
-    * <pre>unicodeChar2php('"\u0000"')</pre>
765
-    * 
766
-    * Returns
767
-    * 
768
-    * <pre>\x0</pre>
769
-    * 
770
-    * @param string $unicodeChar
771
-    * @return string
772
-    */
759
+    /**
760
+     * Converts a unicode character to the PHPO notation.
761
+     * 
762
+     * Example:
763
+     * 
764
+     * <pre>unicodeChar2php('"\u0000"')</pre>
765
+     * 
766
+     * Returns
767
+     * 
768
+     * <pre>\x0</pre>
769
+     * 
770
+     * @param string $unicodeChar
771
+     * @return string
772
+     */
773 773
     public static function unicodeChar2php($unicodeChar) 
774 774
     {
775 775
         $unicodeChar = json_decode($unicodeChar);
@@ -892,25 +892,25 @@  discard block
 block discarded – undo
892 892
         return 'false';
893 893
     }
894 894
     
895
-   /**
896
-    * Converts an associative array with attribute name > value pairs
897
-    * to an attribute string that can be used in an HTML tag. Empty 
898
-    * attribute values are ignored.
899
-    * 
900
-    * Example:
901
-    * 
902
-    * array2attributeString(array(
903
-    *     'id' => 45,
904
-    *     'href' => 'http://www.mistralys.com'
905
-    * ));
906
-    * 
907
-    * Result:
908
-    * 
909
-    * id="45" href="http://www.mistralys.com"
910
-    * 
911
-    * @param array $array
912
-    * @return string
913
-    */
895
+    /**
896
+     * Converts an associative array with attribute name > value pairs
897
+     * to an attribute string that can be used in an HTML tag. Empty 
898
+     * attribute values are ignored.
899
+     * 
900
+     * Example:
901
+     * 
902
+     * array2attributeString(array(
903
+     *     'id' => 45,
904
+     *     'href' => 'http://www.mistralys.com'
905
+     * ));
906
+     * 
907
+     * Result:
908
+     * 
909
+     * id="45" href="http://www.mistralys.com"
910
+     * 
911
+     * @param array $array
912
+     * @return string
913
+     */
914 914
     public static function array2attributeString($array)
915 915
     {
916 916
         $tokens = array();
@@ -929,14 +929,14 @@  discard block
 block discarded – undo
929 929
         return ' '.implode(' ', $tokens);
930 930
     }
931 931
     
932
-   /**
933
-    * Converts a string so it can safely be used in a javascript
934
-    * statement in an HTML tag: uses single quotes around the string
935
-    * and encodes all special characters as needed.
936
-    * 
937
-    * @param string $string
938
-    * @return string
939
-    */
932
+    /**
933
+     * Converts a string so it can safely be used in a javascript
934
+     * statement in an HTML tag: uses single quotes around the string
935
+     * and encodes all special characters as needed.
936
+     * 
937
+     * @param string $string
938
+     * @return string
939
+     */
940 940
     public static function string2attributeJS($string, $quoted=true)
941 941
     {
942 942
         $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8'));
@@ -947,15 +947,15 @@  discard block
 block discarded – undo
947 947
         return $converted;
948 948
     }
949 949
     
950
-   /**
951
-    * Checks if the specified string is a boolean value, which
952
-    * includes string representations of boolean values, like 
953
-    * <code>yes</code> or <code>no</code>, and <code>true</code>
954
-    * or <code>false</code>.
955
-    * 
956
-    * @param mixed $value
957
-    * @return boolean
958
-    */
950
+    /**
951
+     * Checks if the specified string is a boolean value, which
952
+     * includes string representations of boolean values, like 
953
+     * <code>yes</code> or <code>no</code>, and <code>true</code>
954
+     * or <code>false</code>.
955
+     * 
956
+     * @param mixed $value
957
+     * @return boolean
958
+     */
959 959
     public static function isBoolean($value) : bool
960 960
     {
961 961
         if(is_bool($value)) {
@@ -969,12 +969,12 @@  discard block
 block discarded – undo
969 969
         return array_key_exists($value, self::$booleanStrings);
970 970
     }
971 971
     
972
-   /**
973
-    * Converts an associative array to an HTML style attribute value string.
974
-    * 
975
-    * @param array $subject
976
-    * @return string
977
-    */
972
+    /**
973
+     * Converts an associative array to an HTML style attribute value string.
974
+     * 
975
+     * @param array $subject
976
+     * @return string
977
+     */
978 978
     public static function array2styleString(array $subject) : string
979 979
     {
980 980
         $tokens = array();
@@ -985,23 +985,23 @@  discard block
 block discarded – undo
985 985
         return implode(';', $tokens);
986 986
     }
987 987
     
988
-   /**
989
-    * Converts a DateTime object to a timestamp, which
990
-    * is PHP 5.2 compatible.
991
-    * 
992
-    * @param \DateTime $date
993
-    * @return integer
994
-    */
988
+    /**
989
+     * Converts a DateTime object to a timestamp, which
990
+     * is PHP 5.2 compatible.
991
+     * 
992
+     * @param \DateTime $date
993
+     * @return integer
994
+     */
995 995
     public static function date2timestamp(\DateTime $date) : int
996 996
     {
997 997
         return (int)$date->format('U');
998 998
     }
999 999
     
1000
-   /**
1001
-    * Converts a timestamp into a DateTime instance.
1002
-    * @param int $timestamp
1003
-    * @return \DateTime
1004
-    */
1000
+    /**
1001
+     * Converts a timestamp into a DateTime instance.
1002
+     * @param int $timestamp
1003
+     * @return \DateTime
1004
+     */
1005 1005
     public static function timestamp2date(int $timestamp) : \DateTime
1006 1006
     {
1007 1007
         $date = new \DateTime();
@@ -1009,50 +1009,50 @@  discard block
 block discarded – undo
1009 1009
         return $date;
1010 1010
     }
1011 1011
     
1012
-   /**
1013
-    * Strips an absolute path to a file within the application
1014
-    * to make the path relative to the application root path.
1015
-    * 
1016
-    * @param string $path
1017
-    * @return string
1018
-    * 
1019
-    * @see FileHelper::relativizePath()
1020
-    * @see FileHelper::relativizePathByDepth()
1021
-    */
1012
+    /**
1013
+     * Strips an absolute path to a file within the application
1014
+     * to make the path relative to the application root path.
1015
+     * 
1016
+     * @param string $path
1017
+     * @return string
1018
+     * 
1019
+     * @see FileHelper::relativizePath()
1020
+     * @see FileHelper::relativizePathByDepth()
1021
+     */
1022 1022
     public static function fileRelativize(string $path) : string
1023 1023
     {
1024 1024
         return FileHelper::relativizePathByDepth($path);
1025 1025
     }
1026 1026
     
1027 1027
     /**
1028
-    * Converts a PHP regex to a javascript RegExp object statement.
1029
-    * 
1030
-    * NOTE: This is an alias for the JSHelper's `convertRegex` method. 
1031
-    * More details are available on its usage there.
1032
-    *
1033
-    * @param string $regex A PHP preg regex
1034
-    * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object.
1035
-    * @return array|string Depending on the specified return type.
1036
-    * 
1037
-    * @see JSHelper::buildRegexStatement()
1038
-    */
1028
+     * Converts a PHP regex to a javascript RegExp object statement.
1029
+     * 
1030
+     * NOTE: This is an alias for the JSHelper's `convertRegex` method. 
1031
+     * More details are available on its usage there.
1032
+     *
1033
+     * @param string $regex A PHP preg regex
1034
+     * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object.
1035
+     * @return array|string Depending on the specified return type.
1036
+     * 
1037
+     * @see JSHelper::buildRegexStatement()
1038
+     */
1039 1039
     public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT)
1040 1040
     {
1041 1041
         return JSHelper::buildRegexStatement($regex, $statementType);
1042 1042
     }
1043 1043
     
1044
-   /**
1045
-    * Converts the specified variable to JSON. Works just
1046
-    * like the native `json_encode` method, except that it
1047
-    * will trigger an exception on failure, which has the 
1048
-    * json error details included in its developer details.
1049
-    * 
1050
-    * @param mixed $variable
1051
-    * @param int|NULL $options JSON encode options.
1052
-    * @param int|NULL $depth 
1053
-    * @throws ConvertHelper_Exception
1054
-    * @return string
1055
-    */
1044
+    /**
1045
+     * Converts the specified variable to JSON. Works just
1046
+     * like the native `json_encode` method, except that it
1047
+     * will trigger an exception on failure, which has the 
1048
+     * json error details included in its developer details.
1049
+     * 
1050
+     * @param mixed $variable
1051
+     * @param int|NULL $options JSON encode options.
1052
+     * @param int|NULL $depth 
1053
+     * @throws ConvertHelper_Exception
1054
+     * @return string
1055
+     */
1056 1056
     public static function var2json($variable, int $options=0, int $depth=512) : string
1057 1057
     {
1058 1058
         $result = json_encode($variable, $options, $depth);
@@ -1073,12 +1073,12 @@  discard block
 block discarded – undo
1073 1073
         );
1074 1074
     }
1075 1075
     
1076
-   /**
1077
-    * Strips all known UTF byte order marks from the specified string.
1078
-    * 
1079
-    * @param string $string
1080
-    * @return string
1081
-    */
1076
+    /**
1077
+     * Strips all known UTF byte order marks from the specified string.
1078
+     * 
1079
+     * @param string $string
1080
+     * @return string
1081
+     */
1082 1082
     public static function stripUTFBom($string)
1083 1083
     {
1084 1084
         $boms = FileHelper::getUTFBOMs();
@@ -1093,13 +1093,13 @@  discard block
 block discarded – undo
1093 1093
         return $string;
1094 1094
     }
1095 1095
 
1096
-   /**
1097
-    * Converts a string to valid utf8, regardless
1098
-    * of the string's encoding(s).
1099
-    * 
1100
-    * @param string $string
1101
-    * @return string
1102
-    */
1096
+    /**
1097
+     * Converts a string to valid utf8, regardless
1098
+     * of the string's encoding(s).
1099
+     * 
1100
+     * @param string $string
1101
+     * @return string
1102
+     */
1103 1103
     public static function string2utf8($string)
1104 1104
     {
1105 1105
         if(!self::isStringASCII($string)) {
@@ -1109,15 +1109,15 @@  discard block
 block discarded – undo
1109 1109
         return $string;
1110 1110
     }
1111 1111
     
1112
-   /**
1113
-    * Checks whether the specified string is an ASCII
1114
-    * string, without any special or UTF8 characters.
1115
-    * Note: empty strings and NULL are considered ASCII.
1116
-    * Any variable types other than strings are not.
1117
-    * 
1118
-    * @param mixed $string
1119
-    * @return boolean
1120
-    */
1112
+    /**
1113
+     * Checks whether the specified string is an ASCII
1114
+     * string, without any special or UTF8 characters.
1115
+     * Note: empty strings and NULL are considered ASCII.
1116
+     * Any variable types other than strings are not.
1117
+     * 
1118
+     * @param mixed $string
1119
+     * @return boolean
1120
+     */
1121 1121
     public static function isStringASCII($string) : bool
1122 1122
     {
1123 1123
         if($string === '' || $string === NULL) {
@@ -1142,22 +1142,22 @@  discard block
 block discarded – undo
1142 1142
         return $url;
1143 1143
     }
1144 1144
 
1145
-   /**
1146
-    * Calculates a percentage match of the source string with the target string.
1147
-    * 
1148
-    * Options are:
1149
-    * 
1150
-    * - maxLevenshtein, default: 10
1151
-    *   Any levenshtein results above this value are ignored.
1152
-    *   
1153
-    * - precision, default: 1
1154
-    *   The precision of the percentage float value
1155
-    * 
1156
-    * @param string $source
1157
-    * @param string $target
1158
-    * @param array $options
1159
-    * @return float
1160
-    */
1145
+    /**
1146
+     * Calculates a percentage match of the source string with the target string.
1147
+     * 
1148
+     * Options are:
1149
+     * 
1150
+     * - maxLevenshtein, default: 10
1151
+     *   Any levenshtein results above this value are ignored.
1152
+     *   
1153
+     * - precision, default: 1
1154
+     *   The precision of the percentage float value
1155
+     * 
1156
+     * @param string $source
1157
+     * @param string $target
1158
+     * @param array $options
1159
+     * @return float
1160
+     */
1161 1161
     public static function matchString($source, $target, $options=array())
1162 1162
     {
1163 1163
         $defaults = array(
@@ -1241,60 +1241,60 @@  discard block
 block discarded – undo
1241 1241
     
1242 1242
     const INTERVAL_SECONDS = 'seconds';
1243 1243
     
1244
-   /**
1245
-    * Converts an interval to its total amount of days.
1246
-    * @param \DateInterval $interval
1247
-    * @return int
1248
-    */
1244
+    /**
1245
+     * Converts an interval to its total amount of days.
1246
+     * @param \DateInterval $interval
1247
+     * @return int
1248
+     */
1249 1249
     public static function interval2days(\DateInterval $interval) : int
1250 1250
     {
1251 1251
         return self::interval2total($interval, self::INTERVAL_DAYS);
1252 1252
     }
1253 1253
 
1254
-   /**
1255
-    * Converts an interval to its total amount of hours.
1256
-    * @param \DateInterval $interval
1257
-    * @return int
1258
-    */
1254
+    /**
1255
+     * Converts an interval to its total amount of hours.
1256
+     * @param \DateInterval $interval
1257
+     * @return int
1258
+     */
1259 1259
     public static function interval2hours(\DateInterval $interval) : int
1260 1260
     {
1261 1261
         return self::interval2total($interval, self::INTERVAL_HOURS);
1262 1262
     }
1263 1263
     
1264
-   /**
1265
-    * Converts an interval to its total amount of minutes. 
1266
-    * @param \DateInterval $interval
1267
-    * @return int
1268
-    */
1264
+    /**
1265
+     * Converts an interval to its total amount of minutes. 
1266
+     * @param \DateInterval $interval
1267
+     * @return int
1268
+     */
1269 1269
     public static function interval2minutes(\DateInterval $interval) : int
1270 1270
     {
1271 1271
         return self::interval2total($interval, self::INTERVAL_MINUTES);
1272 1272
     }
1273 1273
     
1274
-   /**
1275
-    * Converts an interval to its total amount of seconds.
1276
-    * @param \DateInterval $interval
1277
-    * @return int
1278
-    */    
1274
+    /**
1275
+     * Converts an interval to its total amount of seconds.
1276
+     * @param \DateInterval $interval
1277
+     * @return int
1278
+     */    
1279 1279
     public static function interval2seconds(\DateInterval $interval) : int
1280 1280
     {
1281 1281
         return self::interval2total($interval, self::INTERVAL_SECONDS);
1282 1282
     }
1283 1283
     
1284
-   /**
1285
-    * Calculates the total amount of days / hours / minutes or seconds
1286
-    * of a date interval object (depending in the specified units), and 
1287
-    * returns the total amount.
1288
-    * 
1289
-    * @param \DateInterval $interval
1290
-    * @param string $unit What total value to calculate.
1291
-    * @return integer
1292
-    * 
1293
-    * @see ConvertHelper::INTERVAL_SECONDS
1294
-    * @see ConvertHelper::INTERVAL_MINUTES
1295
-    * @see ConvertHelper::INTERVAL_HOURS
1296
-    * @see ConvertHelper::INTERVAL_DAYS
1297
-    */
1284
+    /**
1285
+     * Calculates the total amount of days / hours / minutes or seconds
1286
+     * of a date interval object (depending in the specified units), and 
1287
+     * returns the total amount.
1288
+     * 
1289
+     * @param \DateInterval $interval
1290
+     * @param string $unit What total value to calculate.
1291
+     * @return integer
1292
+     * 
1293
+     * @see ConvertHelper::INTERVAL_SECONDS
1294
+     * @see ConvertHelper::INTERVAL_MINUTES
1295
+     * @see ConvertHelper::INTERVAL_HOURS
1296
+     * @see ConvertHelper::INTERVAL_DAYS
1297
+     */
1298 1298
     public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int
1299 1299
     {
1300 1300
         $total = $interval->format('%a');
@@ -1334,13 +1334,13 @@  discard block
 block discarded – undo
1334 1334
         'Sunday'
1335 1335
     );
1336 1336
     
1337
-   /**
1338
-    * Converts a date to the corresponding day name.
1339
-    * 
1340
-    * @param \DateTime $date
1341
-    * @param string $short
1342
-    * @return string|NULL
1343
-    */
1337
+    /**
1338
+     * Converts a date to the corresponding day name.
1339
+     * 
1340
+     * @param \DateTime $date
1341
+     * @param string $short
1342
+     * @return string|NULL
1343
+     */
1344 1344
     public static function date2dayName(\DateTime $date, $short=false)
1345 1345
     {
1346 1346
         $day = $date->format('l');
@@ -1355,21 +1355,21 @@  discard block
 block discarded – undo
1355 1355
         return null;
1356 1356
     }
1357 1357
     
1358
-   /**
1359
-    * Retrieves a list of english day names.
1360
-    * @return string[]
1361
-    */
1358
+    /**
1359
+     * Retrieves a list of english day names.
1360
+     * @return string[]
1361
+     */
1362 1362
     public static function getDayNamesInvariant()
1363 1363
     {
1364 1364
         return self::$daysInvariant;
1365 1365
     }
1366 1366
     
1367
-   /**
1368
-    * Retrieves the day names list for the current locale.
1369
-    * 
1370
-    * @param string $short
1371
-    * @return string[]
1372
-    */
1367
+    /**
1368
+     * Retrieves the day names list for the current locale.
1369
+     * 
1370
+     * @param string $short
1371
+     * @return string[]
1372
+     */
1373 1373
     public static function getDayNames($short=false)
1374 1374
     {
1375 1375
         if($short) {
@@ -1429,16 +1429,16 @@  discard block
 block discarded – undo
1429 1429
         return $last;
1430 1430
     }
1431 1431
     
1432
-   /**
1433
-    * Splits a string into an array of all characters it is composed of.
1434
-    * Unicode character safe.
1435
-    * 
1436
-    * NOTE: Spaces and newlines (both \r and \n) are also considered single
1437
-    * characters.
1438
-    * 
1439
-    * @param string $string
1440
-    * @return array
1441
-    */
1432
+    /**
1433
+     * Splits a string into an array of all characters it is composed of.
1434
+     * Unicode character safe.
1435
+     * 
1436
+     * NOTE: Spaces and newlines (both \r and \n) are also considered single
1437
+     * characters.
1438
+     * 
1439
+     * @param string $string
1440
+     * @return array
1441
+     */
1442 1442
     public static function string2array(string $string) : array
1443 1443
     {
1444 1444
         $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY);
@@ -1449,12 +1449,12 @@  discard block
 block discarded – undo
1449 1449
         return array();
1450 1450
     }
1451 1451
     
1452
-   /**
1453
-    * Checks whether the specified string contains HTML code.
1454
-    * 
1455
-    * @param string $string
1456
-    * @return boolean
1457
-    */
1452
+    /**
1453
+     * Checks whether the specified string contains HTML code.
1454
+     * 
1455
+     * @param string $string
1456
+     * @return boolean
1457
+     */
1458 1458
     public static function isStringHTML(string $string) : bool
1459 1459
     {
1460 1460
         if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) {
@@ -1469,18 +1469,18 @@  discard block
 block discarded – undo
1469 1469
         return false;
1470 1470
     }
1471 1471
     
1472
-   /**
1473
-    * UTF8-safe wordwrap method: works like the regular wordwrap
1474
-    * PHP function but compatible with UTF8. Otherwise the lengths
1475
-    * are no calculated correctly.
1476
-    * 
1477
-    * @param string $str
1478
-    * @param int $width
1479
-    * @param string $break
1480
-    * @param bool $cut
1481
-    * @return string
1482
-    * @see https://stackoverflow.com/a/4988494/2298192
1483
-    */
1472
+    /**
1473
+     * UTF8-safe wordwrap method: works like the regular wordwrap
1474
+     * PHP function but compatible with UTF8. Otherwise the lengths
1475
+     * are no calculated correctly.
1476
+     * 
1477
+     * @param string $str
1478
+     * @param int $width
1479
+     * @param string $break
1480
+     * @param bool $cut
1481
+     * @return string
1482
+     * @see https://stackoverflow.com/a/4988494/2298192
1483
+     */
1484 1484
     public static function wordwrap($str, $width = 75, $break = "\n", $cut = false) 
1485 1485
     {
1486 1486
         $lines = explode($break, $str);
@@ -1526,27 +1526,27 @@  discard block
 block discarded – undo
1526 1526
         return implode($break, $lines);
1527 1527
     }
1528 1528
     
1529
-   /**
1530
-    * Calculates the byte length of a string, taking into 
1531
-    * account any unicode characters.
1532
-    * 
1533
-    * @param string $string
1534
-    * @return int
1535
-    * @see https://stackoverflow.com/a/9718273/2298192
1536
-    */
1529
+    /**
1530
+     * Calculates the byte length of a string, taking into 
1531
+     * account any unicode characters.
1532
+     * 
1533
+     * @param string $string
1534
+     * @return int
1535
+     * @see https://stackoverflow.com/a/9718273/2298192
1536
+     */
1537 1537
     public static function string2bytes($string)
1538 1538
     {
1539 1539
         return mb_strlen($string, '8bit');
1540 1540
     }
1541 1541
     
1542
-   /**
1543
-    * Creates a short, 8-character long hash for the specified string.
1544
-    * 
1545
-    * WARNING: Not cryptographically safe.
1546
-    * 
1547
-    * @param string $string
1548
-    * @return string
1549
-    */
1542
+    /**
1543
+     * Creates a short, 8-character long hash for the specified string.
1544
+     * 
1545
+     * WARNING: Not cryptographically safe.
1546
+     * 
1547
+     * @param string $string
1548
+     * @return string
1549
+     */
1550 1550
     public static function string2shortHash($string)
1551 1551
     {
1552 1552
         return hash('crc32', $string, false);
@@ -1572,23 +1572,23 @@  discard block
 block discarded – undo
1572 1572
         return ConvertHelper_ThrowableInfo::fromThrowable($e);
1573 1573
     }
1574 1574
     
1575
-   /**
1576
-    * Parses the specified query string like the native 
1577
-    * function <code>parse_str</code>, without the key
1578
-    * naming limitations.
1579
-    * 
1580
-    * Using parse_str, dots or spaces in key names are 
1581
-    * replaced by underscores. This method keeps all names
1582
-    * intact.
1583
-    * 
1584
-    * It still uses the parse_str implementation as it 
1585
-    * is tested and tried, but fixes the parameter names
1586
-    * after parsing, as needed.
1587
-    * 
1588
-    * @param string $queryString
1589
-    * @return array
1590
-    * @see https://www.php.net/manual/en/function.parse-str.php
1591
-    */
1575
+    /**
1576
+     * Parses the specified query string like the native 
1577
+     * function <code>parse_str</code>, without the key
1578
+     * naming limitations.
1579
+     * 
1580
+     * Using parse_str, dots or spaces in key names are 
1581
+     * replaced by underscores. This method keeps all names
1582
+     * intact.
1583
+     * 
1584
+     * It still uses the parse_str implementation as it 
1585
+     * is tested and tried, but fixes the parameter names
1586
+     * after parsing, as needed.
1587
+     * 
1588
+     * @param string $queryString
1589
+     * @return array
1590
+     * @see https://www.php.net/manual/en/function.parse-str.php
1591
+     */
1592 1592
     public static function parseQueryString(string $queryString) : array
1593 1593
     {
1594 1594
         // allow HTML entities notation
@@ -1628,16 +1628,16 @@  discard block
 block discarded – undo
1628 1628
             $placeholders = array();
1629 1629
             foreach($paramNames as $paramName)
1630 1630
             {
1631
-                 // create a unique placeholder name
1632
-                 $placeholder = '__PLACEHOLDER'.$counter.'__';
1631
+                    // create a unique placeholder name
1632
+                    $placeholder = '__PLACEHOLDER'.$counter.'__';
1633 1633
                  
1634
-                 // store the placeholder name to replace later
1635
-                 $table[$placeholder] = $paramName;
1634
+                    // store the placeholder name to replace later
1635
+                    $table[$placeholder] = $paramName;
1636 1636
                  
1637
-                 // add the placeholder to replace in the query string before parsing
1638
-                 $placeholders[$paramName.'='] = $placeholder.'=';
1637
+                    // add the placeholder to replace in the query string before parsing
1638
+                    $placeholders[$paramName.'='] = $placeholder.'=';
1639 1639
                  
1640
-                 $counter++;
1640
+                    $counter++;
1641 1641
             }
1642 1642
             
1643 1643
             // next challenge: replacing the parameter names by placeholders
@@ -1664,23 +1664,23 @@  discard block
 block discarded – undo
1664 1664
         
1665 1665
         foreach($parsed as $name => $value)
1666 1666
         {
1667
-             $keep[$table[$name]] = $value;
1667
+                $keep[$table[$name]] = $value;
1668 1668
         }
1669 1669
         
1670 1670
         return $keep;
1671 1671
     }
1672 1672
 
1673
-   /**
1674
-    * Searches for needle in the specified string, and returns a list
1675
-    * of all occurrences, including the matched string. The matched 
1676
-    * string is useful when doing a case insensitive search, as it 
1677
-    * shows the exact matched case of needle.
1678
-    *   
1679
-    * @param string $needle
1680
-    * @param string $haystack
1681
-    * @param bool $caseInsensitive
1682
-    * @return ConvertHelper_StringMatch[]
1683
-    */
1673
+    /**
1674
+     * Searches for needle in the specified string, and returns a list
1675
+     * of all occurrences, including the matched string. The matched 
1676
+     * string is useful when doing a case insensitive search, as it 
1677
+     * shows the exact matched case of needle.
1678
+     *   
1679
+     * @param string $needle
1680
+     * @param string $haystack
1681
+     * @param bool $caseInsensitive
1682
+     * @return ConvertHelper_StringMatch[]
1683
+     */
1684 1684
     public static function findString(string $needle, string $haystack, bool $caseInsensitive=false)
1685 1685
     {
1686 1686
         if($needle === '') {
@@ -1706,14 +1706,14 @@  discard block
 block discarded – undo
1706 1706
         return $positions;
1707 1707
     }
1708 1708
     
1709
-   /**
1710
-    * Like explode, but trims all entries, and removes 
1711
-    * empty entries from the resulting array.
1712
-    * 
1713
-    * @param string $delimiter
1714
-    * @param string $string
1715
-    * @return string[]
1716
-    */
1709
+    /**
1710
+     * Like explode, but trims all entries, and removes 
1711
+     * empty entries from the resulting array.
1712
+     * 
1713
+     * @param string $delimiter
1714
+     * @param string $string
1715
+     * @return string[]
1716
+     */
1717 1717
     public static function explodeTrim(string $delimiter, string $string) : array
1718 1718
     {
1719 1719
         if(empty($string) || empty($delimiter)) {
@@ -1735,12 +1735,12 @@  discard block
 block discarded – undo
1735 1735
     
1736 1736
     protected static $eolChars;
1737 1737
 
1738
-   /**
1739
-    * Detects the most used end-of-line character in the subject string.
1740
-    * 
1741
-    * @param string $str The string to check.
1742
-    * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected.
1743
-    */
1738
+    /**
1739
+     * Detects the most used end-of-line character in the subject string.
1740
+     * 
1741
+     * @param string $str The string to check.
1742
+     * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected.
1743
+     */
1744 1744
     public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL
1745 1745
     {
1746 1746
         if(empty($subjectString)) {
@@ -1752,27 +1752,27 @@  discard block
 block discarded – undo
1752 1752
             $cr = chr((int)hexdec('0d'));
1753 1753
             $lf = chr((int)hexdec('0a'));
1754 1754
             
1755
-           self::$eolChars = array(
1756
-               array(
1757
-                   'char' => $cr.$lf,
1758
-                   'type' => ConvertHelper_EOL::TYPE_CRLF,
1759
-                   'description' => t('Carriage return followed by a line feed'),
1760
-               ),
1761
-               array(
1762
-                   'char' => $lf.$cr,
1763
-                   'type' => ConvertHelper_EOL::TYPE_LFCR,
1764
-                   'description' => t('Line feed followed by a carriage return'),
1765
-               ),
1766
-               array(
1767
-                  'char' => $lf,
1768
-                  'type' => ConvertHelper_EOL::TYPE_LF,
1769
-                  'description' => t('Line feed'),
1770
-               ),
1771
-               array(
1772
-                  'char' => $cr,
1773
-                  'type' => ConvertHelper_EOL::TYPE_CR,
1774
-                  'description' => t('Carriage Return'),
1775
-               ),
1755
+            self::$eolChars = array(
1756
+                array(
1757
+                    'char' => $cr.$lf,
1758
+                    'type' => ConvertHelper_EOL::TYPE_CRLF,
1759
+                    'description' => t('Carriage return followed by a line feed'),
1760
+                ),
1761
+                array(
1762
+                    'char' => $lf.$cr,
1763
+                    'type' => ConvertHelper_EOL::TYPE_LFCR,
1764
+                    'description' => t('Line feed followed by a carriage return'),
1765
+                ),
1766
+                array(
1767
+                    'char' => $lf,
1768
+                    'type' => ConvertHelper_EOL::TYPE_LF,
1769
+                    'description' => t('Line feed'),
1770
+                ),
1771
+                array(
1772
+                    'char' => $cr,
1773
+                    'type' => ConvertHelper_EOL::TYPE_CR,
1774
+                    'description' => t('Carriage Return'),
1775
+                ),
1776 1776
             );
1777 1777
         }
1778 1778
         
@@ -1800,13 +1800,13 @@  discard block
 block discarded – undo
1800 1800
         );
1801 1801
     }
1802 1802
 
1803
-   /**
1804
-    * Removes the specified keys from the target array,
1805
-    * if they exist.
1806
-    * 
1807
-    * @param array $array
1808
-    * @param array $keys
1809
-    */
1803
+    /**
1804
+     * Removes the specified keys from the target array,
1805
+     * if they exist.
1806
+     * 
1807
+     * @param array $array
1808
+     * @param array $keys
1809
+     */
1810 1810
     public static function arrayRemoveKeys(array &$array, array $keys) : void
1811 1811
     {
1812 1812
         foreach($keys as $key) 
@@ -1817,13 +1817,13 @@  discard block
 block discarded – undo
1817 1817
         }
1818 1818
     }
1819 1819
     
1820
-   /**
1821
-    * Checks if the specified variable is an integer or a string containing an integer.
1822
-    * Accepts both positive and negative integers.
1823
-    * 
1824
-    * @param mixed $value
1825
-    * @return bool
1826
-    */
1820
+    /**
1821
+     * Checks if the specified variable is an integer or a string containing an integer.
1822
+     * Accepts both positive and negative integers.
1823
+     * 
1824
+     * @param mixed $value
1825
+     * @return bool
1826
+     */
1827 1827
     public static function isInteger($value) : bool
1828 1828
     {
1829 1829
         if(is_int($value)) {
@@ -1843,15 +1843,15 @@  discard block
 block discarded – undo
1843 1843
         return false;    
1844 1844
     }
1845 1845
     
1846
-   /**
1847
-    * Converts an amount of seconds to a DateInterval object.
1848
-    * 
1849
-    * @param int $seconds
1850
-    * @return \DateInterval
1851
-    * @throws ConvertHelper_Exception If the date interval cannot be created.
1852
-    * 
1853
-    * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF
1854
-    */
1846
+    /**
1847
+     * Converts an amount of seconds to a DateInterval object.
1848
+     * 
1849
+     * @param int $seconds
1850
+     * @return \DateInterval
1851
+     * @throws ConvertHelper_Exception If the date interval cannot be created.
1852
+     * 
1853
+     * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF
1854
+     */
1855 1855
     public static function seconds2interval(int $seconds) : \DateInterval
1856 1856
     {
1857 1857
         // The DateInterval::format() method does not recalculate carry 
Please login to merge, or discard this patch.
Spacing   +118 added lines, -118 removed lines patch added patch discarded remove patch
@@ -59,7 +59,7 @@  discard block
 block discarded – undo
59 59
             $amount = substr_count($line, "\t") - $min;
60 60
             $line = trim($line);
61 61
             if ($amount >= 1) {
62
-                $line = str_repeat("\t", $amount) . $line;
62
+                $line = str_repeat("\t", $amount).$line;
63 63
             }
64 64
 
65 65
             $converted[] = $line;
@@ -131,10 +131,10 @@  discard block
 block discarded – undo
131 131
 
132 132
         // specifically handle zero
133 133
         if ($seconds <= 0) {
134
-            return '0 ' . t('seconds');
134
+            return '0 '.t('seconds');
135 135
         }
136 136
         
137
-        if($seconds < 1) {
137
+        if ($seconds < 1) {
138 138
             return t('less than a second');
139 139
         }
140 140
 
@@ -142,7 +142,7 @@  discard block
 block discarded – undo
142 142
         foreach ($units as $def) {
143 143
             $quot = intval($seconds / $def['value']);
144 144
             if ($quot) {
145
-                $item = $quot . ' ';
145
+                $item = $quot.' ';
146 146
                 if (abs($quot) > 1) {
147 147
                     $item .= $def['plural'];
148 148
                 } else {
@@ -159,7 +159,7 @@  discard block
 block discarded – undo
159 159
             return $last;
160 160
         }
161 161
 
162
-        return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last;
162
+        return implode(', ', $tokens).' '.t('and').' '.$last;
163 163
     }
164 164
 
165 165
     /**
@@ -177,13 +177,13 @@  discard block
 block discarded – undo
177 177
      */
178 178
     public static function duration2string($datefrom, $dateto = -1) : string
179 179
     {
180
-        if($datefrom instanceof \DateTime) {
180
+        if ($datefrom instanceof \DateTime) {
181 181
             $datefrom = ConvertHelper::date2timestamp($datefrom);
182 182
         } else {
183 183
             $datefrom = intval($datefrom);
184 184
         }
185 185
         
186
-        if($dateto instanceof \DateTime) {
186
+        if ($dateto instanceof \DateTime) {
187 187
             $dateto = ConvertHelper::date2timestamp($dateto);
188 188
         } else {
189 189
             $dateto = intval($dateto);
@@ -192,11 +192,11 @@  discard block
 block discarded – undo
192 192
         // Defaults and assume if 0 is passed in that
193 193
         // its an error rather than the epoch
194 194
 
195
-        if($datefrom <= 0) {
195
+        if ($datefrom <= 0) {
196 196
             return t('A long time ago');
197 197
         }
198 198
         
199
-        if($dateto == -1) {
199
+        if ($dateto == -1) {
200 200
             $dateto = time();
201 201
         }
202 202
 
@@ -207,7 +207,7 @@  discard block
 block discarded – undo
207 207
         $interval = "";
208 208
         
209 209
         $future = false;
210
-        if($difference < 0) {
210
+        if ($difference < 0) {
211 211
             $difference = $difference * -1;
212 212
             $future = true;
213 213
         }
@@ -282,7 +282,7 @@  discard block
 block discarded – undo
282 282
                 $day = (int)date("j", $dateto);
283 283
                 $year = (int)date("Y", $datefrom);
284 284
                 
285
-                while(mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $dateto) 
285
+                while (mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $dateto) 
286 286
                 {
287 287
                     $months_difference++;
288 288
                 }
@@ -297,7 +297,7 @@  discard block
 block discarded – undo
297 297
                     $datediff--;
298 298
                 }
299 299
 
300
-                if($future) {
300
+                if ($future) {
301 301
                     $result = ($datediff == 1) ? t('In one month', $datediff) : t('In %1s months', $datediff);
302 302
                 } else {
303 303
                     $result = ($datediff == 1) ? t('One month ago', $datediff) : t('%1s months ago', $datediff);
@@ -306,7 +306,7 @@  discard block
 block discarded – undo
306 306
 
307 307
             case "y":
308 308
                 $datediff = floor($difference / 60 / 60 / 24 / 365);
309
-                if($future) {
309
+                if ($future) {
310 310
                     $result = ($datediff == 1) ? t('In one year', $datediff) : t('In %1s years', $datediff);
311 311
                 } else {
312 312
                     $result = ($datediff == 1) ? t('One year ago', $datediff) : t('%1s years ago', $datediff);
@@ -315,7 +315,7 @@  discard block
 block discarded – undo
315 315
 
316 316
             case "d":
317 317
                 $datediff = floor($difference / 60 / 60 / 24);
318
-                if($future) {
318
+                if ($future) {
319 319
                     $result = ($datediff == 1) ? t('In one day', $datediff) : t('In %1s days', $datediff);
320 320
                 } else {
321 321
                     $result = ($datediff == 1) ? t('One day ago', $datediff) : t('%1s days ago', $datediff);
@@ -324,7 +324,7 @@  discard block
 block discarded – undo
324 324
 
325 325
             case "ww":
326 326
                 $datediff = floor($difference / 60 / 60 / 24 / 7);
327
-                if($future) {
327
+                if ($future) {
328 328
                     $result = ($datediff == 1) ? t('In one week', $datediff) : t('In %1s weeks', $datediff);
329 329
                 } else {
330 330
                     $result = ($datediff == 1) ? t('One week ago', $datediff) : t('%1s weeks ago', $datediff);
@@ -333,7 +333,7 @@  discard block
 block discarded – undo
333 333
 
334 334
             case "h":
335 335
                 $datediff = floor($difference / 60 / 60);
336
-                if($future) {
336
+                if ($future) {
337 337
                     $result = ($datediff == 1) ? t('In one hour', $datediff) : t('In %1s hours', $datediff);
338 338
                 } else {
339 339
                     $result = ($datediff == 1) ? t('One hour ago', $datediff) : t('%1s hours ago', $datediff);
@@ -342,7 +342,7 @@  discard block
 block discarded – undo
342 342
 
343 343
             case "n":
344 344
                 $datediff = floor($difference / 60);
345
-                if($future) {
345
+                if ($future) {
346 346
                     $result = ($datediff == 1) ? t('In one minute', $datediff) : t('In %1s minutes', $datediff);
347 347
                 } else {
348 348
                     $result = ($datediff == 1) ? t('One minute ago', $datediff) : t('%1s minutes ago', $datediff);
@@ -351,7 +351,7 @@  discard block
 block discarded – undo
351 351
 
352 352
             case "s":
353 353
                 $datediff = $difference;
354
-                if($future) {
354
+                if ($future) {
355 355
                     $result = ($datediff == 1) ? t('In one second', $datediff) : t('In %1s seconds', $datediff);
356 356
                 } else {
357 357
                     $result = ($datediff == 1) ? t('One second ago', $datediff) : t('%1s seconds ago', $datediff);
@@ -374,9 +374,9 @@  discard block
 block discarded – undo
374 374
         return $geshi->parse_code();
375 375
     }
376 376
     
377
-    public static function highlight_xml($xml, $formatSource=false)
377
+    public static function highlight_xml($xml, $formatSource = false)
378 378
     {
379
-        if($formatSource) 
379
+        if ($formatSource) 
380 380
         {
381 381
             $dom = new \DOMDocument();
382 382
             $dom->loadXML($xml);
@@ -414,22 +414,22 @@  discard block
 block discarded – undo
414 414
         $terabyte = $gigabyte * 1024;
415 415
 
416 416
         if (($bytes >= 0) && ($bytes < $kilobyte)) {
417
-            return $bytes . ' ' . t('B');
417
+            return $bytes.' '.t('B');
418 418
 
419 419
         } elseif (($bytes >= $kilobyte) && ($bytes < $megabyte)) {
420
-            return round($bytes / $kilobyte, $precision) . ' ' . t('Kb');
420
+            return round($bytes / $kilobyte, $precision).' '.t('Kb');
421 421
 
422 422
         } elseif (($bytes >= $megabyte) && ($bytes < $gigabyte)) {
423
-            return round($bytes / $megabyte, $precision) . ' ' . t('Mb');
423
+            return round($bytes / $megabyte, $precision).' '.t('Mb');
424 424
 
425 425
         } elseif (($bytes >= $gigabyte) && ($bytes < $terabyte)) {
426
-            return round($bytes / $gigabyte, $precision) . ' ' . t('Gb');
426
+            return round($bytes / $gigabyte, $precision).' '.t('Gb');
427 427
 
428 428
         } elseif ($bytes >= $terabyte) {
429
-            return round($bytes / $gigabyte, $precision) . ' ' . t('Tb');
429
+            return round($bytes / $gigabyte, $precision).' '.t('Tb');
430 430
         }
431 431
 
432
-        return $bytes . ' ' . t('B');
432
+        return $bytes.' '.t('B');
433 433
     }
434 434
 
435 435
    /**
@@ -449,34 +449,34 @@  discard block
 block discarded – undo
449 449
             return $text;
450 450
         }
451 451
 
452
-        $text = trim(mb_substr($text, 0, $targetLength)) . $append;
452
+        $text = trim(mb_substr($text, 0, $targetLength)).$append;
453 453
 
454 454
         return $text;
455 455
     }
456 456
 
457
-    public static function var_dump($var, $html=true)
457
+    public static function var_dump($var, $html = true)
458 458
     {
459 459
         $info = parseVariable($var);
460 460
         
461
-        if($html) {
461
+        if ($html) {
462 462
             return $info->toHTML();
463 463
         }
464 464
         
465 465
         return $info->toString();
466 466
     }
467 467
     
468
-    public static function print_r($var, $return=false, $html=true)
468
+    public static function print_r($var, $return = false, $html = true)
469 469
     {
470 470
         $result = self::var_dump($var, $html);
471 471
         
472
-        if($html) {
472
+        if ($html) {
473 473
             $result = 
474 474
             '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'.
475 475
                 $result.
476 476
             '</pre>';
477 477
         }
478 478
         
479
-        if($return) {
479
+        if ($return) {
480 480
             return $result;
481 481
         }
482 482
         
@@ -496,7 +496,7 @@  discard block
 block discarded – undo
496 496
 
497 497
     public static function string2bool($string)
498 498
     {
499
-        if($string === '' || $string === null) {
499
+        if ($string === '' || $string === null) {
500 500
             return false;
501 501
         }
502 502
         
@@ -551,10 +551,10 @@  discard block
 block discarded – undo
551 551
     public static function date2listLabel(\DateTime $date, $includeTime = false, $shortMonth = false)
552 552
     {
553 553
         $today = new \DateTime();
554
-        if($date->format('d.m.Y') == $today->format('d.m.Y')) {
554
+        if ($date->format('d.m.Y') == $today->format('d.m.Y')) {
555 555
             $label = t('Today');
556 556
         } else {
557
-            $label = $date->format('d') . '. ' . self::month2string((int)$date->format('m'), $shortMonth) . ' ';
557
+            $label = $date->format('d').'. '.self::month2string((int)$date->format('m'), $shortMonth).' ';
558 558
             if ($date->format('Y') != date('Y')) {
559 559
                 $label .= $date->format('Y');
560 560
             }
@@ -645,28 +645,28 @@  discard block
 block discarded – undo
645 645
         $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F');
646 646
         
647 647
         $stack = array();
648
-        foreach(self::$controlChars as $char)
648
+        foreach (self::$controlChars as $char)
649 649
         {
650 650
             $tokens = explode('-', $char);
651 651
             $start = $tokens[0];
652 652
             $end = $tokens[1];
653 653
             $prefix = substr($start, 0, 3);
654 654
             $range = array();
655
-            foreach($hexAlphabet as $number) {
655
+            foreach ($hexAlphabet as $number) {
656 656
                 $range[] = $prefix.$number;
657 657
             }
658 658
             
659 659
             $use = false;
660
-            foreach($range as $number) {
661
-                if($number == $start) {
660
+            foreach ($range as $number) {
661
+                if ($number == $start) {
662 662
                     $use = true;
663 663
                 }
664 664
                 
665
-                if($use) {
665
+                if ($use) {
666 666
                     $stack[] = $number;
667 667
                 }
668 668
                 
669
-                if($number == $end) {
669
+                if ($number == $end) {
670 670
                     break;
671 671
                 }
672 672
             }
@@ -687,7 +687,7 @@  discard block
 block discarded – undo
687 687
         $chars = self::getControlCharactersAsHex();
688 688
         
689 689
         $result = array();
690
-        foreach($chars as $char) {
690
+        foreach ($chars as $char) {
691 691
             $result[] = hex2bin($char);
692 692
         }
693 693
         
@@ -705,14 +705,14 @@  discard block
 block discarded – undo
705 705
         $chars = self::getControlCharactersAsHex();
706 706
         
707 707
         $result = array();
708
-        foreach($chars as $char) {
708
+        foreach ($chars as $char) {
709 709
             $result[] = '\u'.strtolower($char);
710 710
         }
711 711
         
712 712
         return $result;
713 713
     }
714 714
     
715
-    protected static $controlChars =  array(
715
+    protected static $controlChars = array(
716 716
         '0000-0008', // control chars
717 717
         '000E-000F', // control chars
718 718
         '0010-001F', // control chars
@@ -734,19 +734,19 @@  discard block
 block discarded – undo
734 734
      */
735 735
     public static function stripControlCharacters(string $string) : string
736 736
     {
737
-        if(empty($string)) {
737
+        if (empty($string)) {
738 738
             return $string;
739 739
         }
740 740
         
741 741
         // create the regex from the unicode characters list
742
-        if(!isset(self::$controlCharsRegex)) 
742
+        if (!isset(self::$controlCharsRegex)) 
743 743
         {
744 744
             $chars = self::getControlCharactersAsHex();
745 745
 
746 746
             // we use the notation \x{0000} to specify the unicode character key
747 747
             // in the regular expression.
748 748
             $stack = array();
749
-            foreach($chars as $char) {
749
+            foreach ($chars as $char) {
750 750
                 $stack[] = '\x{'.$char.'}';
751 751
             }
752 752
             
@@ -780,7 +780,7 @@  discard block
 block discarded – undo
780 780
             $ordInt = ord($octet);
781 781
             // Convert from int (base 10) to hex (base 16), for PHP \x syntax
782 782
             $ordHex = base_convert($ordInt, 10, 16);
783
-            $output .= '\x' . $ordHex;
783
+            $output .= '\x'.$ordHex;
784 784
         }
785 785
         return $output;
786 786
     }
@@ -812,19 +812,19 @@  discard block
 block discarded – undo
812 812
     
813 813
     protected static function convertScalarForComparison($scalar)
814 814
     {
815
-        if($scalar === '' || is_null($scalar)) {
815
+        if ($scalar === '' || is_null($scalar)) {
816 816
             return null;
817 817
         }
818 818
         
819
-        if(is_bool($scalar)) {
819
+        if (is_bool($scalar)) {
820 820
             return self::bool2string($scalar);
821 821
         }
822 822
         
823
-        if(is_array($scalar)) {
823
+        if (is_array($scalar)) {
824 824
             $scalar = md5(serialize($scalar));
825 825
         }
826 826
         
827
-        if($scalar !== null && !is_scalar($scalar)) {
827
+        if ($scalar !== null && !is_scalar($scalar)) {
828 828
             throw new ConvertHelper_Exception(
829 829
                 'Not a scalar value in comparison',
830 830
                 null,
@@ -873,7 +873,7 @@  discard block
 block discarded – undo
873 873
     public static function bool2string($boolean, bool $yesno = false) : string
874 874
     {
875 875
         // allow 'yes', 'true', 'no', 'false' string notations as well
876
-        if(!is_bool($boolean)) {
876
+        if (!is_bool($boolean)) {
877 877
             $boolean = self::string2bool($boolean);
878 878
         }
879 879
         
@@ -914,15 +914,15 @@  discard block
 block discarded – undo
914 914
     public static function array2attributeString($array)
915 915
     {
916 916
         $tokens = array();
917
-        foreach($array as $attr => $value) {
918
-            if($value == '' || $value == null) {
917
+        foreach ($array as $attr => $value) {
918
+            if ($value == '' || $value == null) {
919 919
                 continue;
920 920
             }
921 921
             
922 922
             $tokens[] = $attr.'="'.$value.'"';
923 923
         }
924 924
         
925
-        if(empty($tokens)) {
925
+        if (empty($tokens)) {
926 926
             return '';
927 927
         }
928 928
         
@@ -937,10 +937,10 @@  discard block
 block discarded – undo
937 937
     * @param string $string
938 938
     * @return string
939 939
     */
940
-    public static function string2attributeJS($string, $quoted=true)
940
+    public static function string2attributeJS($string, $quoted = true)
941 941
     {
942 942
         $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8'));
943
-        if($quoted) {
943
+        if ($quoted) {
944 944
             $converted = "'".$converted."'";
945 945
         } 
946 946
         
@@ -958,11 +958,11 @@  discard block
 block discarded – undo
958 958
     */
959 959
     public static function isBoolean($value) : bool
960 960
     {
961
-        if(is_bool($value)) {
961
+        if (is_bool($value)) {
962 962
             return true;
963 963
         }
964 964
         
965
-        if(!is_scalar($value)) {
965
+        if (!is_scalar($value)) {
966 966
             return false;
967 967
         }
968 968
         
@@ -978,7 +978,7 @@  discard block
 block discarded – undo
978 978
     public static function array2styleString(array $subject) : string
979 979
     {
980 980
         $tokens = array();
981
-        foreach($subject as $name => $value) {
981
+        foreach ($subject as $name => $value) {
982 982
             $tokens[] = $name.':'.$value;
983 983
         }
984 984
         
@@ -1036,7 +1036,7 @@  discard block
 block discarded – undo
1036 1036
     * 
1037 1037
     * @see JSHelper::buildRegexStatement()
1038 1038
     */
1039
-    public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT)
1039
+    public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT)
1040 1040
     {
1041 1041
         return JSHelper::buildRegexStatement($regex, $statementType);
1042 1042
     }
@@ -1053,11 +1053,11 @@  discard block
 block discarded – undo
1053 1053
     * @throws ConvertHelper_Exception
1054 1054
     * @return string
1055 1055
     */
1056
-    public static function var2json($variable, int $options=0, int $depth=512) : string
1056
+    public static function var2json($variable, int $options = 0, int $depth = 512) : string
1057 1057
     {
1058 1058
         $result = json_encode($variable, $options, $depth);
1059 1059
         
1060
-        if($result !== false) {
1060
+        if ($result !== false) {
1061 1061
             return $result;
1062 1062
         }
1063 1063
         
@@ -1082,10 +1082,10 @@  discard block
 block discarded – undo
1082 1082
     public static function stripUTFBom($string)
1083 1083
     {
1084 1084
         $boms = FileHelper::getUTFBOMs();
1085
-        foreach($boms as $bomChars) {
1085
+        foreach ($boms as $bomChars) {
1086 1086
             $length = mb_strlen($bomChars);
1087 1087
             $text = mb_substr($string, 0, $length);
1088
-            if($text==$bomChars) {
1088
+            if ($text == $bomChars) {
1089 1089
                 return mb_substr($string, $length);
1090 1090
             }
1091 1091
         }
@@ -1102,7 +1102,7 @@  discard block
 block discarded – undo
1102 1102
     */
1103 1103
     public static function string2utf8($string)
1104 1104
     {
1105
-        if(!self::isStringASCII($string)) {
1105
+        if (!self::isStringASCII($string)) {
1106 1106
             return \ForceUTF8\Encoding::toUTF8($string);
1107 1107
         }
1108 1108
         
@@ -1120,11 +1120,11 @@  discard block
 block discarded – undo
1120 1120
     */
1121 1121
     public static function isStringASCII($string) : bool
1122 1122
     {
1123
-        if($string === '' || $string === NULL) {
1123
+        if ($string === '' || $string === NULL) {
1124 1124
             return true;
1125 1125
         }
1126 1126
         
1127
-        if(!is_string($string)) {
1127
+        if (!is_string($string)) {
1128 1128
             return false;
1129 1129
         }
1130 1130
         
@@ -1158,7 +1158,7 @@  discard block
 block discarded – undo
1158 1158
     * @param array $options
1159 1159
     * @return float
1160 1160
     */
1161
-    public static function matchString($source, $target, $options=array())
1161
+    public static function matchString($source, $target, $options = array())
1162 1162
     {
1163 1163
         $defaults = array(
1164 1164
             'maxLevenshtein' => 10,
@@ -1168,12 +1168,12 @@  discard block
 block discarded – undo
1168 1168
         $options = array_merge($defaults, $options);
1169 1169
         
1170 1170
         // avoid doing this via levenshtein
1171
-        if($source == $target) {
1171
+        if ($source == $target) {
1172 1172
             return 100;
1173 1173
         }
1174 1174
         
1175 1175
         $diff = levenshtein($source, $target);
1176
-        if($diff > $options['maxLevenshtein']) {
1176
+        if ($diff > $options['maxLevenshtein']) {
1177 1177
             return 0;
1178 1178
         }
1179 1179
         
@@ -1187,8 +1187,8 @@  discard block
 block discarded – undo
1187 1187
         
1188 1188
         $offset = 0;
1189 1189
         $keep = array();
1190
-        foreach($tokens as $token) {
1191
-            if($interval->$token > 0) {
1190
+        foreach ($tokens as $token) {
1191
+            if ($interval->$token > 0) {
1192 1192
                 $keep = array_slice($tokens, $offset);
1193 1193
                 break;
1194 1194
             }
@@ -1197,16 +1197,16 @@  discard block
 block discarded – undo
1197 1197
         }
1198 1198
         
1199 1199
         $parts = array();
1200
-        foreach($keep as $token) 
1200
+        foreach ($keep as $token) 
1201 1201
         {
1202 1202
             $value = $interval->$token;
1203 1203
             $label = '';
1204 1204
             
1205 1205
             $suffix = 'p';
1206
-            if($value == 1) { $suffix = 's'; }
1206
+            if ($value == 1) { $suffix = 's'; }
1207 1207
             $token .= $suffix;
1208 1208
             
1209
-            switch($token) {
1209
+            switch ($token) {
1210 1210
                 case 'ys': $label = t('1 year'); break;
1211 1211
                 case 'yp': $label = t('%1$s years', $value); break;
1212 1212
                 case 'ms': $label = t('1 month'); break;
@@ -1224,7 +1224,7 @@  discard block
 block discarded – undo
1224 1224
             $parts[] = $label;
1225 1225
         }
1226 1226
         
1227
-        if(count($parts) == 1) {
1227
+        if (count($parts) == 1) {
1228 1228
             return $parts[0];
1229 1229
         } 
1230 1230
         
@@ -1295,24 +1295,24 @@  discard block
 block discarded – undo
1295 1295
     * @see ConvertHelper::INTERVAL_HOURS
1296 1296
     * @see ConvertHelper::INTERVAL_DAYS
1297 1297
     */
1298
-    public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int
1298
+    public static function interval2total(\DateInterval $interval, $unit = self::INTERVAL_SECONDS) : int
1299 1299
     {
1300 1300
         $total = $interval->format('%a');
1301 1301
         if ($unit == self::INTERVAL_DAYS) {
1302 1302
             return (int)$total;
1303 1303
         }
1304 1304
         
1305
-        $total = ($total * 24) + ($interval->h );
1305
+        $total = ($total * 24) + ($interval->h);
1306 1306
         if ($unit == self::INTERVAL_HOURS) {
1307 1307
             return (int)$total;
1308 1308
         }
1309 1309
     
1310
-        $total = ($total * 60) + ($interval->i );
1310
+        $total = ($total * 60) + ($interval->i);
1311 1311
         if ($unit == self::INTERVAL_MINUTES) {
1312 1312
             return (int)$total;
1313 1313
         }
1314 1314
 
1315
-        $total = ($total * 60) + ($interval->s );
1315
+        $total = ($total * 60) + ($interval->s);
1316 1316
         if ($unit == self::INTERVAL_SECONDS) {
1317 1317
             return (int)$total;
1318 1318
         }
@@ -1341,13 +1341,13 @@  discard block
 block discarded – undo
1341 1341
     * @param string $short
1342 1342
     * @return string|NULL
1343 1343
     */
1344
-    public static function date2dayName(\DateTime $date, $short=false)
1344
+    public static function date2dayName(\DateTime $date, $short = false)
1345 1345
     {
1346 1346
         $day = $date->format('l');
1347 1347
         $invariant = self::getDayNamesInvariant();
1348 1348
         
1349 1349
         $idx = array_search($day, $invariant);
1350
-        if($idx !== false) {
1350
+        if ($idx !== false) {
1351 1351
             $localized = self::getDayNames($short);
1352 1352
             return $localized[$idx];
1353 1353
         }
@@ -1370,10 +1370,10 @@  discard block
 block discarded – undo
1370 1370
     * @param string $short
1371 1371
     * @return string[]
1372 1372
     */
1373
-    public static function getDayNames($short=false)
1373
+    public static function getDayNames($short = false)
1374 1374
     {
1375
-        if($short) {
1376
-            if(!isset(self::$daysShort)) {
1375
+        if ($short) {
1376
+            if (!isset(self::$daysShort)) {
1377 1377
                 self::$daysShort = array(
1378 1378
                     t('Mon'),
1379 1379
                     t('Tue'),
@@ -1388,7 +1388,7 @@  discard block
 block discarded – undo
1388 1388
             return self::$daysShort;
1389 1389
         }
1390 1390
         
1391
-        if(!isset(self::$days)) {
1391
+        if (!isset(self::$days)) {
1392 1392
             self::$days = array(
1393 1393
                 t('Monday'),
1394 1394
                 t('Tuesday'),
@@ -1413,17 +1413,17 @@  discard block
 block discarded – undo
1413 1413
      */
1414 1414
     public static function implodeWithAnd(array $list, $sep = ', ', $conjunction = null)
1415 1415
     {
1416
-        if(empty($list)) {
1416
+        if (empty($list)) {
1417 1417
             return '';
1418 1418
         }
1419 1419
         
1420
-        if(empty($conjunction)) {
1420
+        if (empty($conjunction)) {
1421 1421
             $conjunction = t('and');
1422 1422
         }
1423 1423
         
1424 1424
         $last = array_pop($list);
1425
-        if($list) {
1426
-            return implode($sep, $list) . $conjunction . ' ' . $last;
1425
+        if ($list) {
1426
+            return implode($sep, $list).$conjunction.' '.$last;
1427 1427
         }
1428 1428
         
1429 1429
         return $last;
@@ -1442,7 +1442,7 @@  discard block
 block discarded – undo
1442 1442
     public static function string2array(string $string) : array
1443 1443
     {
1444 1444
         $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY);
1445
-        if($result !== false) {
1445
+        if ($result !== false) {
1446 1446
             return $result;
1447 1447
         }
1448 1448
         
@@ -1457,12 +1457,12 @@  discard block
 block discarded – undo
1457 1457
     */
1458 1458
     public static function isStringHTML(string $string) : bool
1459 1459
     {
1460
-        if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) {
1460
+        if (preg_match('%<[a-z/][\s\S]*>%siU', $string)) {
1461 1461
             return true;
1462 1462
         }
1463 1463
         
1464 1464
         $decoded = html_entity_decode($string);
1465
-        if($decoded !== $string) {
1465
+        if ($decoded !== $string) {
1466 1466
             return true;
1467 1467
         }
1468 1468
         
@@ -1599,7 +1599,7 @@  discard block
 block discarded – undo
1599 1599
         // extract parameter names from the query string
1600 1600
         $result = array();
1601 1601
         preg_match_all('/&?([^&]+)=.*/sixU', $queryString, $result, PREG_PATTERN_ORDER);
1602
-        if(isset($result[1])) {
1602
+        if (isset($result[1])) {
1603 1603
             $paramNames = $result[1];
1604 1604
         }
1605 1605
         
@@ -1622,11 +1622,11 @@  discard block
 block discarded – undo
1622 1622
         // possible naming conflicts like having both parameters "foo.bar" 
1623 1623
         // and "foo_bar" in the query string: since "foo.bar" would be converted
1624 1624
         // to "foo_bar", one of the two would be replaced.
1625
-        if($fixRequired) 
1625
+        if ($fixRequired) 
1626 1626
         {
1627 1627
             $counter = 1;
1628 1628
             $placeholders = array();
1629
-            foreach($paramNames as $paramName)
1629
+            foreach ($paramNames as $paramName)
1630 1630
             {
1631 1631
                  // create a unique placeholder name
1632 1632
                  $placeholder = '__PLACEHOLDER'.$counter.'__';
@@ -1656,13 +1656,13 @@  discard block
 block discarded – undo
1656 1656
         parse_str($queryString, $parsed);
1657 1657
         
1658 1658
         // do any of the parameter names need to be fixed?
1659
-        if(!$fixRequired) {
1659
+        if (!$fixRequired) {
1660 1660
             return $parsed;
1661 1661
         }
1662 1662
         
1663 1663
         $keep = array();
1664 1664
         
1665
-        foreach($parsed as $name => $value)
1665
+        foreach ($parsed as $name => $value)
1666 1666
         {
1667 1667
              $keep[$table[$name]] = $value;
1668 1668
         }
@@ -1681,14 +1681,14 @@  discard block
 block discarded – undo
1681 1681
     * @param bool $caseInsensitive
1682 1682
     * @return ConvertHelper_StringMatch[]
1683 1683
     */
1684
-    public static function findString(string $needle, string $haystack, bool $caseInsensitive=false)
1684
+    public static function findString(string $needle, string $haystack, bool $caseInsensitive = false)
1685 1685
     {
1686
-        if($needle === '') {
1686
+        if ($needle === '') {
1687 1687
             return array();
1688 1688
         }
1689 1689
         
1690 1690
         $function = 'mb_strpos';
1691
-        if($caseInsensitive) {
1691
+        if ($caseInsensitive) {
1692 1692
             $function = 'mb_stripos';
1693 1693
         }
1694 1694
         
@@ -1696,7 +1696,7 @@  discard block
 block discarded – undo
1696 1696
         $positions = array();
1697 1697
         $length = mb_strlen($needle);
1698 1698
         
1699
-        while( ($pos = $function($haystack, $needle, $pos)) !== false) 
1699
+        while (($pos = $function($haystack, $needle, $pos)) !== false) 
1700 1700
         {
1701 1701
             $match = mb_substr($haystack, $pos, $length);
1702 1702
             $positions[] = new ConvertHelper_StringMatch($pos, $match);
@@ -1716,7 +1716,7 @@  discard block
 block discarded – undo
1716 1716
     */
1717 1717
     public static function explodeTrim(string $delimiter, string $string) : array
1718 1718
     {
1719
-        if(empty($string) || empty($delimiter)) {
1719
+        if (empty($string) || empty($delimiter)) {
1720 1720
             return array();
1721 1721
         }
1722 1722
         
@@ -1724,8 +1724,8 @@  discard block
 block discarded – undo
1724 1724
         $tokens = array_map('trim', $tokens);
1725 1725
         
1726 1726
         $keep = array();
1727
-        foreach($tokens as $token) {
1728
-            if($token !== '') {
1727
+        foreach ($tokens as $token) {
1728
+            if ($token !== '') {
1729 1729
                 $keep[] = $token;
1730 1730
             }
1731 1731
         }
@@ -1743,11 +1743,11 @@  discard block
 block discarded – undo
1743 1743
     */
1744 1744
     public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL
1745 1745
     {
1746
-        if(empty($subjectString)) {
1746
+        if (empty($subjectString)) {
1747 1747
             return null;
1748 1748
         }
1749 1749
         
1750
-        if(!isset(self::$eolChars))
1750
+        if (!isset(self::$eolChars))
1751 1751
         {
1752 1752
             $cr = chr((int)hexdec('0d'));
1753 1753
             $lf = chr((int)hexdec('0a'));
@@ -1778,18 +1778,18 @@  discard block
 block discarded – undo
1778 1778
         
1779 1779
         $max = 0;
1780 1780
         $results = array();
1781
-        foreach(self::$eolChars as $def) 
1781
+        foreach (self::$eolChars as $def) 
1782 1782
         {
1783 1783
             $amount = substr_count($subjectString, $def['char']);
1784 1784
             
1785
-            if($amount > $max)
1785
+            if ($amount > $max)
1786 1786
             {
1787 1787
                 $max = $amount;
1788 1788
                 $results[] = $def;
1789 1789
             }
1790 1790
         }
1791 1791
         
1792
-        if(empty($results)) {
1792
+        if (empty($results)) {
1793 1793
             return null;
1794 1794
         }
1795 1795
         
@@ -1809,9 +1809,9 @@  discard block
 block discarded – undo
1809 1809
     */
1810 1810
     public static function arrayRemoveKeys(array &$array, array $keys) : void
1811 1811
     {
1812
-        foreach($keys as $key) 
1812
+        foreach ($keys as $key) 
1813 1813
         {
1814
-            if(array_key_exists($key, $array)) {
1814
+            if (array_key_exists($key, $array)) {
1815 1815
                 unset($array[$key]); 
1816 1816
             }
1817 1817
         }
@@ -1826,17 +1826,17 @@  discard block
 block discarded – undo
1826 1826
     */
1827 1827
     public static function isInteger($value) : bool
1828 1828
     {
1829
-        if(is_int($value)) {
1829
+        if (is_int($value)) {
1830 1830
             return true;
1831 1831
         }
1832 1832
         
1833 1833
         // booleans get converted to numbers, so they would
1834 1834
         // actually match the regex.
1835
-        if(is_bool($value)) {
1835
+        if (is_bool($value)) {
1836 1836
             return false;
1837 1837
         }
1838 1838
         
1839
-        if(is_string($value) && $value !== '') {
1839
+        if (is_string($value) && $value !== '') {
1840 1840
             return preg_match('/\A-?\d+\z/', $value) === 1;
1841 1841
         }
1842 1842
         
@@ -1863,7 +1863,7 @@  discard block
 block discarded – undo
1863 1863
         $d2->add(new \DateInterval('PT'.$seconds.'S'));
1864 1864
         
1865 1865
         $result = $d2->diff($d1);
1866
-        if($result !== false) {
1866
+        if ($result !== false) {
1867 1867
             return $result;
1868 1868
         }
1869 1869
         
Please login to merge, or discard this patch.