Passed
Branch master (c991d8)
by Sebastian
08:15
created
src/ZIPHelper.php 2 patches
Indentation   +55 added lines, -55 removed lines patch added patch discarded remove patch
@@ -36,14 +36,14 @@  discard block
 block discarded – undo
36 36
         'WriteThreshold' => 100
37 37
     );
38 38
     
39
-   /**
40
-    * @var string
41
-    */
39
+    /**
40
+     * @var string
41
+     */
42 42
     protected $file;
43 43
     
44
-   /**
45
-    * @var \ZipArchive
46
-    */
44
+    /**
45
+     * @var \ZipArchive
46
+     */
47 47
     protected $zip;
48 48
     
49 49
     public function __construct(string $targetFile)
@@ -51,35 +51,35 @@  discard block
 block discarded – undo
51 51
         $this->file = $targetFile;
52 52
     }
53 53
     
54
-   /**
55
-    * Sets an option, among the available options:
56
-    * 
57
-    * <ul>
58
-    * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li>
59
-    * </ul>
60
-    * 
61
-    * @param string $name
62
-    * @param mixed $value
63
-    * @return ZIPHelper
64
-    */
54
+    /**
55
+     * Sets an option, among the available options:
56
+     * 
57
+     * <ul>
58
+     * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li>
59
+     * </ul>
60
+     * 
61
+     * @param string $name
62
+     * @param mixed $value
63
+     * @return ZIPHelper
64
+     */
65 65
     public function setOption(string $name, $value) : ZIPHelper
66 66
     {
67 67
         $this->options[$name] = $value;
68 68
         return $this;
69 69
     }
70 70
     
71
-   /**
72
-    * Adds a file to the zip. By default, the file is stored
73
-    * with the same name in the root of the zip. Use the optional
74
-    * parameter to change the location in the zip.
75
-    * 
76
-    * @param string $filePath
77
-    * @param string|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root.
78
-    * @throws ZIPHelper_Exception
79
-    * @return bool
80
-    * 
81
-    * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
82
-    */
71
+    /**
72
+     * Adds a file to the zip. By default, the file is stored
73
+     * with the same name in the root of the zip. Use the optional
74
+     * parameter to change the location in the zip.
75
+     * 
76
+     * @param string $filePath
77
+     * @param string|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root.
78
+     * @throws ZIPHelper_Exception
79
+     * @return bool
80
+     * 
81
+     * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
82
+     */
83 83
     public function addFile(string $filePath, ?string $zipPath=null) : bool
84 84
     {
85 85
         $this->open();
@@ -255,13 +255,13 @@  discard block
 block discarded – undo
255 255
         return $fileName;
256 256
     }
257 257
     
258
-   /**
259
-    * Like {@link ZIPHelper::download()}, but deletes the
260
-    * file after sending it to the browser.
261
-    * 
262
-    * @param string|NULL $fileName Override the ZIP's file name for the download
263
-    * @see ZIPHelper::download()
264
-    */
258
+    /**
259
+     * Like {@link ZIPHelper::download()}, but deletes the
260
+     * file after sending it to the browser.
261
+     * 
262
+     * @param string|NULL $fileName Override the ZIP's file name for the download
263
+     * @see ZIPHelper::download()
264
+     */
265 265
     public function downloadAndDelete(?string $fileName=null)
266 266
     {
267 267
         $this->download($fileName);
@@ -269,14 +269,14 @@  discard block
 block discarded – undo
269 269
         FileHelper::deleteFile($this->file);
270 270
     }
271 271
 
272
-   /**
273
-    * Extracts all files and folders from the zip to the 
274
-    * target folder. If no folder is specified, the files
275
-    * are extracted into the same folder as the zip itself.
276
-    * 
277
-    * @param string|NULL $outputFolder If no folder is specified, uses the target file's folder.
278
-    * @return boolean
279
-    */
272
+    /**
273
+     * Extracts all files and folders from the zip to the 
274
+     * target folder. If no folder is specified, the files
275
+     * are extracted into the same folder as the zip itself.
276
+     * 
277
+     * @param string|NULL $outputFolder If no folder is specified, uses the target file's folder.
278
+     * @return boolean
279
+     */
280 280
     public function extractAll(?string $outputFolder=null) : bool
281 281
     {
282 282
         if(empty($outputFolder)) {
@@ -289,9 +289,9 @@  discard block
 block discarded – undo
289 289
     }
290 290
 
291 291
     
292
-   /**
293
-    * @return \ZipArchive
294
-    */
292
+    /**
293
+     * @return \ZipArchive
294
+     */
295 295
     public function getArchive() : \ZipArchive
296 296
     {
297 297
         $this->open();
@@ -299,14 +299,14 @@  discard block
 block discarded – undo
299 299
         return $this->zip;
300 300
     }
301 301
     
302
-   /**
303
-    * JSON encodes the specified data and adds the json as
304
-    * a file in the ZIP archive.
305
-    * 
306
-    * @param mixed $data
307
-    * @param string $zipPath
308
-    * @return boolean
309
-    */
302
+    /**
303
+     * JSON encodes the specified data and adds the json as
304
+     * a file in the ZIP archive.
305
+     * 
306
+     * @param mixed $data
307
+     * @param string $zipPath
308
+     * @return boolean
309
+     */
310 310
     public function addJSON($data, $zipPath)
311 311
     {
312 312
         return $this->addString(
Please login to merge, or discard this patch.
Spacing   +17 added lines, -17 removed lines patch added patch discarded remove patch
@@ -30,7 +30,7 @@  discard block
 block discarded – undo
30 30
     
31 31
     const ERROR_OPENING_ZIP_FILE = 338003;
32 32
     
33
-    const ERROR_CANNOT_SAVE_FILE_TO_DISK =338004;
33
+    const ERROR_CANNOT_SAVE_FILE_TO_DISK = 338004;
34 34
     
35 35
     protected $options = array(
36 36
         'WriteThreshold' => 100
@@ -80,7 +80,7 @@  discard block
 block discarded – undo
80 80
     * 
81 81
     * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
82 82
     */
83
-    public function addFile(string $filePath, ?string $zipPath=null) : bool
83
+    public function addFile(string $filePath, ?string $zipPath = null) : bool
84 84
     {
85 85
         $this->open();
86 86
         
@@ -126,16 +126,16 @@  discard block
 block discarded – undo
126 126
     
127 127
     protected function open()
128 128
     {
129
-        if($this->open) {
129
+        if ($this->open) {
130 130
             return;
131 131
         }
132 132
         
133
-        if(!isset($this->zip)) {
133
+        if (!isset($this->zip)) {
134 134
             $this->zip = new \ZipArchive();
135 135
         }
136 136
         
137 137
         $flag = null;
138
-        if(!file_exists($this->file)) {
138
+        if (!file_exists($this->file)) {
139 139
             $flag = \ZipArchive::CREATE;
140 140
         }
141 141
         
@@ -175,7 +175,7 @@  discard block
 block discarded – undo
175 175
     {
176 176
         $this->fileTracker++;
177 177
 
178
-        if($this->options['WriteThreshold'] < 1) {
178
+        if ($this->options['WriteThreshold'] < 1) {
179 179
             return;
180 180
         }
181 181
         
@@ -188,7 +188,7 @@  discard block
 block discarded – undo
188 188
     
189 189
     protected function close()
190 190
     {
191
-        if(!$this->open) {
191
+        if (!$this->open) {
192 192
             return;
193 193
         }
194 194
         
@@ -197,8 +197,8 @@  discard block
 block discarded – undo
197 197
             throw new ZIPHelper_Exception(
198 198
                 'Could not save ZIP file to disk',
199 199
                 sprintf(
200
-                    'Tried saving the ZIP file [%1$s], but the write failed. This can have several causes, ' .
201
-                    'including adding files that do not exist on disk, trying to create an empty zip, ' .
200
+                    'Tried saving the ZIP file [%1$s], but the write failed. This can have several causes, '.
201
+                    'including adding files that do not exist on disk, trying to create an empty zip, '.
202 202
                     'or trying to save to a directory that does not exist.',
203 203
                     $this->file
204 204
                 ),
@@ -213,7 +213,7 @@  discard block
 block discarded – undo
213 213
     {
214 214
         $this->open();
215 215
         
216
-        if($this->countFiles() < 1) 
216
+        if ($this->countFiles() < 1) 
217 217
         {
218 218
             throw new ZIPHelper_Exception(
219 219
                 'No files in the zip file',
@@ -237,17 +237,17 @@  discard block
 block discarded – undo
237 237
      * @throws ZIPHelper_Exception
238 238
      * @return string The file name that was sent (useful in case none was specified).
239 239
      */
240
-    public function download(?string $fileName=null) : string
240
+    public function download(?string $fileName = null) : string
241 241
     {
242 242
         $this->save();
243 243
         
244
-        if(empty($fileName)) {
244
+        if (empty($fileName)) {
245 245
             $fileName = basename($this->file);
246 246
         }
247 247
         
248 248
         header('Content-type: application/zip');
249
-        header('Content-Disposition: attachment; filename=' . $fileName);
250
-        header('Content-length: ' . filesize($this->file));
249
+        header('Content-Disposition: attachment; filename='.$fileName);
250
+        header('Content-length: '.filesize($this->file));
251 251
         header('Pragma: no-cache');
252 252
         header('Expires: 0');
253 253
         readfile($this->file);
@@ -262,7 +262,7 @@  discard block
 block discarded – undo
262 262
     * @param string|NULL $fileName Override the ZIP's file name for the download
263 263
     * @see ZIPHelper::download()
264 264
     */
265
-    public function downloadAndDelete(?string $fileName=null)
265
+    public function downloadAndDelete(?string $fileName = null)
266 266
     {
267 267
         $this->download($fileName);
268 268
         
@@ -277,9 +277,9 @@  discard block
 block discarded – undo
277 277
     * @param string|NULL $outputFolder If no folder is specified, uses the target file's folder.
278 278
     * @return boolean
279 279
     */
280
-    public function extractAll(?string $outputFolder=null) : bool
280
+    public function extractAll(?string $outputFolder = null) : bool
281 281
     {
282
-        if(empty($outputFolder)) {
282
+        if (empty($outputFolder)) {
283 283
             $outputFolder = dirname($this->file);
284 284
         }
285 285
         
Please login to merge, or discard this patch.
src/SVNHelper/CommandResult.php 2 patches
Indentation   +27 added lines, -27 removed lines patch added patch discarded remove patch
@@ -4,37 +4,37 @@  discard block
 block discarded – undo
4 4
 
5 5
 class SVNHelper_CommandResult
6 6
 {
7
-   /**
8
-    * @var SVNHelper_Command
9
-    */
7
+    /**
8
+     * @var SVNHelper_Command
9
+     */
10 10
     protected $command;
11 11
     
12
-   /**
13
-    * @var string[]
14
-    */
12
+    /**
13
+     * @var string[]
14
+     */
15 15
     protected $output;
16 16
     
17
-   /**
18
-    * @var SVNHelper_CommandError[]
19
-    */
17
+    /**
18
+     * @var SVNHelper_CommandError[]
19
+     */
20 20
     protected $errors = array();
21 21
     
22
-   /**
23
-    * @var SVNHelper_CommandError[]
24
-    */
22
+    /**
23
+     * @var SVNHelper_CommandError[]
24
+     */
25 25
     protected $warnings = array();
26 26
     
27
-   /**
28
-    * The actual command that has been executed
29
-    * @var string
30
-    */
27
+    /**
28
+     * The actual command that has been executed
29
+     * @var string
30
+     */
31 31
     protected $commandLine;
32 32
     
33
-   /**
34
-    * @param SVNHelper_Command $command
35
-    * @param string[] $output
36
-    * @param SVNHelper_CommandError[] $errors
37
-    */
33
+    /**
34
+     * @param SVNHelper_Command $command
35
+     * @param string[] $output
36
+     * @param SVNHelper_CommandError[] $errors
37
+     */
38 38
     public function __construct(SVNHelper_Command $command, $commandLine, $output, $errors)
39 39
     {
40 40
         $this->command = $command;
@@ -86,12 +86,12 @@  discard block
 block discarded – undo
86 86
         return $this->command;
87 87
     }
88 88
     
89
-   /**
90
-    * Retrieves all error messages.
91
-    * 
92
-    * @param bool $asString
93
-    * @return string|string[]
94
-    */
89
+    /**
90
+     * Retrieves all error messages.
91
+     * 
92
+     * @param bool $asString
93
+     * @return string|string[]
94
+     */
95 95
     public function getErrorMessages(bool $asString=false)
96 96
     {
97 97
         if($asString) {
Please login to merge, or discard this patch.
Spacing   +15 added lines, -15 removed lines patch added patch discarded remove patch
@@ -41,8 +41,8 @@  discard block
 block discarded – undo
41 41
         $this->commandLine = $commandLine;
42 42
         $this->output = $output;
43 43
         
44
-        foreach($errors as $error) {
45
-            if($error->isError()) {
44
+        foreach ($errors as $error) {
45
+            if ($error->isError()) {
46 46
                 $this->errors[] = $error;
47 47
             } else {
48 48
                 $this->warnings[] = $error;
@@ -62,8 +62,8 @@  discard block
 block discarded – undo
62 62
     
63 63
     public function hasErrorCode($code)
64 64
     {
65
-        foreach($this->errors as $error) {
66
-            if($error->getCode() == $code) {
65
+        foreach ($this->errors as $error) {
66
+            if ($error->getCode() == $code) {
67 67
                 return true;
68 68
             }
69 69
         }
@@ -92,11 +92,11 @@  discard block
 block discarded – undo
92 92
     * @param bool $asString
93 93
     * @return string|string[]
94 94
     */
95
-    public function getErrorMessages(bool $asString=false)
95
+    public function getErrorMessages(bool $asString = false)
96 96
     {
97
-        if($asString) {
97
+        if ($asString) {
98 98
             $lines = array();
99
-            foreach($this->errors as $error) {
99
+            foreach ($this->errors as $error) {
100 100
                 $lines[] = (string)$error;
101 101
             }
102 102
             
@@ -104,7 +104,7 @@  discard block
 block discarded – undo
104 104
         }
105 105
         
106 106
         $messages = array();
107
-        foreach($this->errors as $error) {
107
+        foreach ($this->errors as $error) {
108 108
             $messages[] = (string)$error;
109 109
         }
110 110
         
@@ -123,7 +123,7 @@  discard block
 block discarded – undo
123 123
     
124 124
     public function getLastLine()
125 125
     {
126
-        return $this->output[count($this->output)-1];
126
+        return $this->output[count($this->output) - 1];
127 127
     }
128 128
     
129 129
     public function getFirstLine()
@@ -138,8 +138,8 @@  discard block
 block discarded – undo
138 138
     
139 139
     public function isConnectionFailed()
140 140
     {
141
-        foreach($this->errors as $error) {
142
-            if($error->isConnectionFailed()) {
141
+        foreach ($this->errors as $error) {
142
+            if ($error->isConnectionFailed()) {
143 143
                 return true;
144 144
             }
145 145
         }
@@ -149,8 +149,8 @@  discard block
 block discarded – undo
149 149
     
150 150
     public function hasConflicts()
151 151
     {
152
-        foreach($this->errors as $error) {
153
-            if($error->isConflict()) {
152
+        foreach ($this->errors as $error) {
153
+            if ($error->isConflict()) {
154 154
                 return true;
155 155
             }
156 156
         }
@@ -160,8 +160,8 @@  discard block
 block discarded – undo
160 160
     
161 161
     public function hasLocks()
162 162
     {
163
-        foreach($this->errors as $error) {
164
-            if($error->isLock()) {
163
+        foreach ($this->errors as $error) {
164
+            if ($error->isLock()) {
165 165
                 return true;
166 166
             }
167 167
         }
Please login to merge, or discard this patch.
src/Transliteration.php 1 patch
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -60,7 +60,7 @@  discard block
 block discarded – undo
60 60
      * The converted string will be all lowercase.
61 61
      * @return Transliteration
62 62
      */
63
-    public function setLowercase(bool $lowercase=true) : Transliteration
63
+    public function setLowercase(bool $lowercase = true) : Transliteration
64 64
     {
65 65
         $this->setOption('lowercase', $lowercase);
66 66
 
@@ -97,8 +97,8 @@  discard block
 block discarded – undo
97 97
 
98 98
         $result = implode('', $keep);
99 99
 
100
-        while (strstr($result, $space . $space)) {
101
-            $result = str_replace($space . $space, $space, $result);
100
+        while (strstr($result, $space.$space)) {
101
+            $result = str_replace($space.$space, $space, $result);
102 102
         }
103 103
 
104 104
         $result = trim($result, $space);
Please login to merge, or discard this patch.
src/ConvertHelper/ByteConverter.php 2 patches
Indentation   +63 added lines, -63 removed lines patch added patch discarded remove patch
@@ -23,9 +23,9 @@  discard block
 block discarded – undo
23 23
  */
24 24
 class ConvertHelper_ByteConverter
25 25
 {
26
-   /**
27
-    * @var int
28
-    */
26
+    /**
27
+     * @var int
28
+     */
29 29
     protected $bytes;
30 30
     
31 31
     public function __construct(int $bytes)
@@ -39,12 +39,12 @@  discard block
 block discarded – undo
39 39
         }
40 40
     }
41 41
     
42
-   /**
43
-    * Detects the size matching the byte value for the specified base.
44
-    * 
45
-    * @param int $base
46
-    * @return ConvertHelper_StorageSizeEnum_Size
47
-    */
42
+    /**
43
+     * Detects the size matching the byte value for the specified base.
44
+     * 
45
+     * @param int $base
46
+     * @return ConvertHelper_StorageSizeEnum_Size
47
+     */
48 48
     protected function detectSize(int $base) : ConvertHelper_StorageSizeEnum_Size
49 49
     {
50 50
         $sizes = $this->getSizesSorted($base);   
@@ -70,13 +70,13 @@  discard block
 block discarded – undo
70 70
         return ConvertHelper_StorageSizeEnum::getSizeByName('b');
71 71
     }
72 72
     
73
-   /**
74
-    * Retrieves all storage sizes for the specified base, 
75
-    * sorted from smallest byte size to highest.
76
-    * 
77
-    * @param int $base
78
-    * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[]
79
-    */
73
+    /**
74
+     * Retrieves all storage sizes for the specified base, 
75
+     * sorted from smallest byte size to highest.
76
+     * 
77
+     * @param int $base
78
+     * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[]
79
+     */
80 80
     protected function getSizesSorted(int $base)
81 81
     {
82 82
         $sizes = ConvertHelper_StorageSizeEnum::getSizesByBase($base);
@@ -89,16 +89,16 @@  discard block
 block discarded – undo
89 89
         return $sizes;
90 90
     }
91 91
     
92
-   /**
93
-    * Converts the byte value to a human readable string, e.g. "5 KB", "140 MB".
94
-    * 
95
-    * @param int $precision The amount of decimals (rounded up)
96
-    * @param int $base The base to calculate bytes with.
97
-    * @return string
98
-    * 
99
-    * @see ConvertHelper_StorageSizeEnum::BASE_10
100
-    * @see ConvertHelper_StorageSizeEnum::BASE_2
101
-    */
92
+    /**
93
+     * Converts the byte value to a human readable string, e.g. "5 KB", "140 MB".
94
+     * 
95
+     * @param int $precision The amount of decimals (rounded up)
96
+     * @param int $base The base to calculate bytes with.
97
+     * @return string
98
+     * 
99
+     * @see ConvertHelper_StorageSizeEnum::BASE_10
100
+     * @see ConvertHelper_StorageSizeEnum::BASE_2
101
+     */
102 102
     public function toString(int $precision, int $base=ConvertHelper_StorageSizeEnum::BASE_10) : string
103 103
     {
104 104
         $size = $this->detectSize($base);
@@ -106,13 +106,13 @@  discard block
 block discarded – undo
106 106
         return round($this->bytes / $size->getBytes(), $precision) . ' ' . $size->getSuffix();
107 107
     }
108 108
     
109
-   /**
110
-    * Converts the byte value to the amount of the corresponding units (KB, MB...).
111
-    * 
112
-    * @param int $precision The amount of decimals (rounded up)
113
-    * @param string $sizeName The lowercase storage size name (e.g. "kb", "kib")
114
-    * @return float
115
-    */
109
+    /**
110
+     * Converts the byte value to the amount of the corresponding units (KB, MB...).
111
+     * 
112
+     * @param int $precision The amount of decimals (rounded up)
113
+     * @param string $sizeName The lowercase storage size name (e.g. "kb", "kib")
114
+     * @return float
115
+     */
116 116
     public function toNumber(int $precision, string $sizeName) : float
117 117
     {
118 118
         $size = ConvertHelper_StorageSizeEnum::getSizeByName($sizeName);
@@ -120,56 +120,56 @@  discard block
 block discarded – undo
120 120
         return round($this->bytes / $size->getBytes(), $precision);
121 121
     }
122 122
     
123
-   /**
124
-    * Converts the bytes to Kilobytes.
125
-    * 
126
-    * @param int $precision Amount of decimals (rounded up)
127
-    * @return float
128
-    */
123
+    /**
124
+     * Converts the bytes to Kilobytes.
125
+     * 
126
+     * @param int $precision Amount of decimals (rounded up)
127
+     * @return float
128
+     */
129 129
     public function toKilobytes(int $precision=1) : float
130 130
     {
131 131
         return $this->toNumber($precision, 'kb');
132 132
     }
133 133
     
134
-   /**
135
-    * Converts the bytes to Megabytes.
136
-    *
137
-    * @param int $precision Amount of decimals (rounded up)
138
-    * @return float
139
-    */
134
+    /**
135
+     * Converts the bytes to Megabytes.
136
+     *
137
+     * @param int $precision Amount of decimals (rounded up)
138
+     * @return float
139
+     */
140 140
     public function toMegabytes(int $precision=1) : float
141 141
     {
142 142
         return $this->toNumber($precision, 'mb');
143 143
     }
144 144
 
145
-   /**
146
-    * Converts the bytes to Gigabytes.
147
-    *
148
-    * @param int $precision Amount of decimals (rounded up)
149
-    * @return float
150
-    */
145
+    /**
146
+     * Converts the bytes to Gigabytes.
147
+     *
148
+     * @param int $precision Amount of decimals (rounded up)
149
+     * @return float
150
+     */
151 151
     public function toGigabytes(int $precision=1) : float
152 152
     {
153 153
         return $this->toNumber($precision, 'gb');
154 154
     }
155 155
 
156
-   /**
157
-    * Converts the bytes to Terabytes.
158
-    *
159
-    * @param int $precision Amount of decimals (rounded up)
160
-    * @return float
161
-    */
156
+    /**
157
+     * Converts the bytes to Terabytes.
158
+     *
159
+     * @param int $precision Amount of decimals (rounded up)
160
+     * @return float
161
+     */
162 162
     public function toTerabytes(int $precision=1) : float
163 163
     {
164 164
         return $this->toNumber($precision, 'tb');
165 165
     }
166 166
     
167
-   /**
168
-    * Converts the bytes to Petabytes.
169
-    *
170
-    * @param int $precision Amount of decimals (rounded up)
171
-    * @return float
172
-    */
167
+    /**
168
+     * Converts the bytes to Petabytes.
169
+     *
170
+     * @param int $precision Amount of decimals (rounded up)
171
+     * @return float
172
+     */
173 173
     public function toPetabytes(int $precision=1) : float
174 174
     {
175 175
         return $this->toNumber($precision, 'pb');
Please login to merge, or discard this patch.
Spacing   +17 added lines, -17 removed lines patch added patch discarded remove patch
@@ -33,7 +33,7 @@  discard block
 block discarded – undo
33 33
         $this->bytes = $bytes;
34 34
         
35 35
         // correct negative values
36
-        if($this->bytes < 0) 
36
+        if ($this->bytes < 0) 
37 37
         {
38 38
             $this->bytes = 0;
39 39
         }
@@ -49,19 +49,19 @@  discard block
 block discarded – undo
49 49
     {
50 50
         $sizes = $this->getSizesSorted($base);   
51 51
 
52
-        if($this->bytes >= $sizes[0]->getBytes()) 
52
+        if ($this->bytes >= $sizes[0]->getBytes()) 
53 53
         {
54 54
             $total = count($sizes);
55 55
             
56
-            for($i=0; $i < $total; $i++)
56
+            for ($i = 0; $i < $total; $i++)
57 57
             {
58 58
                 $size = $sizes[$i];
59 59
                 
60
-                if(!isset($sizes[($i+1)])) {
60
+                if (!isset($sizes[($i + 1)])) {
61 61
                     return $size;
62 62
                 }
63 63
                 
64
-                if($this->bytes >= $size->getBytes() && $this->bytes < $sizes[($i+1)]->getBytes()) {
64
+                if ($this->bytes >= $size->getBytes() && $this->bytes < $sizes[($i + 1)]->getBytes()) {
65 65
                     return $size;
66 66
                 }
67 67
             }
@@ -99,11 +99,11 @@  discard block
 block discarded – undo
99 99
     * @see ConvertHelper_StorageSizeEnum::BASE_10
100 100
     * @see ConvertHelper_StorageSizeEnum::BASE_2
101 101
     */
102
-    public function toString(int $precision, int $base=ConvertHelper_StorageSizeEnum::BASE_10) : string
102
+    public function toString(int $precision, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string
103 103
     {
104 104
         $size = $this->detectSize($base);
105 105
         
106
-        return round($this->bytes / $size->getBytes(), $precision) . ' ' . $size->getSuffix();
106
+        return round($this->bytes / $size->getBytes(), $precision).' '.$size->getSuffix();
107 107
     }
108 108
     
109 109
    /**
@@ -126,7 +126,7 @@  discard block
 block discarded – undo
126 126
     * @param int $precision Amount of decimals (rounded up)
127 127
     * @return float
128 128
     */
129
-    public function toKilobytes(int $precision=1) : float
129
+    public function toKilobytes(int $precision = 1) : float
130 130
     {
131 131
         return $this->toNumber($precision, 'kb');
132 132
     }
@@ -137,7 +137,7 @@  discard block
 block discarded – undo
137 137
     * @param int $precision Amount of decimals (rounded up)
138 138
     * @return float
139 139
     */
140
-    public function toMegabytes(int $precision=1) : float
140
+    public function toMegabytes(int $precision = 1) : float
141 141
     {
142 142
         return $this->toNumber($precision, 'mb');
143 143
     }
@@ -148,7 +148,7 @@  discard block
 block discarded – undo
148 148
     * @param int $precision Amount of decimals (rounded up)
149 149
     * @return float
150 150
     */
151
-    public function toGigabytes(int $precision=1) : float
151
+    public function toGigabytes(int $precision = 1) : float
152 152
     {
153 153
         return $this->toNumber($precision, 'gb');
154 154
     }
@@ -159,7 +159,7 @@  discard block
 block discarded – undo
159 159
     * @param int $precision Amount of decimals (rounded up)
160 160
     * @return float
161 161
     */
162
-    public function toTerabytes(int $precision=1) : float
162
+    public function toTerabytes(int $precision = 1) : float
163 163
     {
164 164
         return $this->toNumber($precision, 'tb');
165 165
     }
@@ -170,7 +170,7 @@  discard block
 block discarded – undo
170 170
     * @param int $precision Amount of decimals (rounded up)
171 171
     * @return float
172 172
     */
173
-    public function toPetabytes(int $precision=1) : float
173
+    public function toPetabytes(int $precision = 1) : float
174 174
     {
175 175
         return $this->toNumber($precision, 'pb');
176 176
     }
@@ -181,7 +181,7 @@  discard block
 block discarded – undo
181 181
      * @param int $precision Amount of decimals (rounded up)
182 182
      * @return float
183 183
      */
184
-    public function toKibibytes(int $precision=1) : float
184
+    public function toKibibytes(int $precision = 1) : float
185 185
     {
186 186
         return $this->toNumber($precision, 'kib');
187 187
     }
@@ -192,7 +192,7 @@  discard block
 block discarded – undo
192 192
      * @param int $precision Amount of decimals (rounded up)
193 193
      * @return float
194 194
      */
195
-    public function toMebibytes(int $precision=1) : float
195
+    public function toMebibytes(int $precision = 1) : float
196 196
     {
197 197
         return $this->toNumber($precision, 'mib');
198 198
     }
@@ -203,7 +203,7 @@  discard block
 block discarded – undo
203 203
      * @param int $precision Amount of decimals (rounded up)
204 204
      * @return float
205 205
      */
206
-    public function toGibibytes(int $precision=1) : float
206
+    public function toGibibytes(int $precision = 1) : float
207 207
     {
208 208
         return $this->toNumber($precision, 'gib');
209 209
     }
@@ -214,7 +214,7 @@  discard block
 block discarded – undo
214 214
      * @param int $precision Amount of decimals (rounded up)
215 215
      * @return float
216 216
      */
217
-    public function toTebibytes(int $precision=1) : float
217
+    public function toTebibytes(int $precision = 1) : float
218 218
     {
219 219
         return $this->toNumber($precision, 'tib');
220 220
     }
@@ -225,7 +225,7 @@  discard block
 block discarded – undo
225 225
      * @param int $precision Amount of decimals (rounded up)
226 226
      * @return float
227 227
      */
228
-    public function toPebibytes(int $precision=1) : float
228
+    public function toPebibytes(int $precision = 1) : float
229 229
     {
230 230
         return $this->toNumber($precision, 'pib');
231 231
     }
Please login to merge, or discard this patch.
src/ConvertHelper/StorageSizeEnum/Size.php 1 patch
Indentation   +18 added lines, -18 removed lines patch added patch discarded remove patch
@@ -25,34 +25,34 @@
 block discarded – undo
25 25
  */
26 26
 class ConvertHelper_StorageSizeEnum_Size
27 27
 {
28
-   /**
29
-    * @var string
30
-    */
28
+    /**
29
+     * @var string
30
+     */
31 31
     protected $name;
32 32
     
33
-   /**
34
-    * @var int
35
-    */
33
+    /**
34
+     * @var int
35
+     */
36 36
     protected $base;
37 37
     
38
-   /**
39
-    * @var int
40
-    */
38
+    /**
39
+     * @var int
40
+     */
41 41
     protected $exponent;
42 42
     
43
-   /**
44
-    * @var string
45
-    */
43
+    /**
44
+     * @var string
45
+     */
46 46
     protected $singular;
47 47
     
48
-   /**
49
-    * @var string
50
-    */
48
+    /**
49
+     * @var string
50
+     */
51 51
     protected $plural;
52 52
     
53
-   /**
54
-    * @var string
55
-    */
53
+    /**
54
+     * @var string
55
+     */
56 56
     protected $suffix;
57 57
     
58 58
     public function __construct(string $name, int $base, int $exponent, string $suffix, string $singular, string $plural)
Please login to merge, or discard this patch.
src/ConvertHelper/SizeNotation.php 2 patches
Indentation   +86 added lines, -86 removed lines patch added patch discarded remove patch
@@ -31,9 +31,9 @@  discard block
 block discarded – undo
31 31
     
32 32
     const VALIDATION_ERROR_NEGATIVE_VALUE = 43803;
33 33
     
34
-   /**
35
-    * @var string
36
-    */
34
+    /**
35
+     * @var string
36
+     */
37 37
     protected $sizeString;
38 38
 
39 39
     /**
@@ -41,41 +41,41 @@  discard block
 block discarded – undo
41 41
      */
42 42
     protected $sizeDefinition;
43 43
     
44
-   /**
45
-    * @var integer
46
-    */
44
+    /**
45
+     * @var integer
46
+     */
47 47
     protected $bytes = 0;
48 48
     
49
-   /**
50
-    * @var bool
51
-    */
49
+    /**
50
+     * @var bool
51
+     */
52 52
     protected $valid = true;
53 53
     
54
-   /**
55
-    * @var string
56
-    */
54
+    /**
55
+     * @var string
56
+     */
57 57
     protected $units = null;
58 58
     
59
-   /**
60
-    * @var string
61
-    */
59
+    /**
60
+     * @var string
61
+     */
62 62
     protected $number = '';
63 63
     
64
-   /**
65
-    * @var string
66
-    */
64
+    /**
65
+     * @var string
66
+     */
67 67
     protected $errorMessage = '';
68 68
     
69
-   /**
70
-    * @var int
71
-    */
69
+    /**
70
+     * @var int
71
+     */
72 72
     protected $errorCode = 0;
73 73
     
74
-   /**
75
-    * Create a new instance for the specified size string.
76
-    * 
77
-    * @param string $sizeString A size notation in the format "50 MB", or a number of bytes without units. Spaces are ignored, so "50MB" = "50 MB" = "  50   MB   ". Floating point values are accepted, both with dot and comma notation ("50.5" = "50,5"). To use Base 2 values, ose appropriate units, e.g. "50 MiB", "1.5 GiB". The units are case insensitive, so "50 MB" = "50 mb". 
78
-    */
74
+    /**
75
+     * Create a new instance for the specified size string.
76
+     * 
77
+     * @param string $sizeString A size notation in the format "50 MB", or a number of bytes without units. Spaces are ignored, so "50MB" = "50 MB" = "  50   MB   ". Floating point values are accepted, both with dot and comma notation ("50.5" = "50,5"). To use Base 2 values, ose appropriate units, e.g. "50 MiB", "1.5 GiB". The units are case insensitive, so "50 MB" = "50 mb". 
78
+     */
79 79
     public function __construct(string $sizeString)
80 80
     {
81 81
         $this->sizeString = $this->cleanString($sizeString);
@@ -83,31 +83,31 @@  discard block
 block discarded – undo
83 83
         $this->convert();
84 84
     }
85 85
     
86
-   /**
87
-    * Gets the amount of bytes contained in the size notation.
88
-    * @return int
89
-    */
86
+    /**
87
+     * Gets the amount of bytes contained in the size notation.
88
+     * @return int
89
+     */
90 90
     public function toBytes() : int
91 91
     {
92 92
         return $this->bytes;
93 93
     }
94 94
     
95
-   /**
96
-    * Converts the size notation to a human readable string, e.g. "50 MB".
97
-    * 
98
-    * @param int $precision
99
-    * @return string
100
-    * @see ConvertHelper::bytes2readable()
101
-    */
95
+    /**
96
+     * Converts the size notation to a human readable string, e.g. "50 MB".
97
+     * 
98
+     * @param int $precision
99
+     * @return string
100
+     * @see ConvertHelper::bytes2readable()
101
+     */
102 102
     public function toString(int $precision=1) : string
103 103
     {
104 104
         return ConvertHelper::bytes2readable($this->bytes, $precision, $this->getBase());
105 105
     }
106 106
     
107
-   /**
108
-    * Retrieves the detected number's base.
109
-    * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid.
110
-    */
107
+    /**
108
+     * Retrieves the detected number's base.
109
+     * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid.
110
+     */
111 111
     public function getBase() : int
112 112
     {
113 113
         if($this->isValid()) {
@@ -117,13 +117,13 @@  discard block
 block discarded – undo
117 117
         return 0;
118 118
     }
119 119
     
120
-   /**
121
-    * Retrieves the detected storage size instance, if 
122
-    * the size string is valid.
123
-    * 
124
-    * @return ConvertHelper_StorageSizeEnum_Size|NULL
125
-    * @see ConvertHelper_StorageSizeEnum_Size
126
-    */
120
+    /**
121
+     * Retrieves the detected storage size instance, if 
122
+     * the size string is valid.
123
+     * 
124
+     * @return ConvertHelper_StorageSizeEnum_Size|NULL
125
+     * @see ConvertHelper_StorageSizeEnum_Size
126
+     */
127 127
     public function getSizeDefinition() : ?ConvertHelper_StorageSizeEnum_Size
128 128
     {
129 129
         if($this->isValid()) {
@@ -133,27 +133,27 @@  discard block
 block discarded – undo
133 133
         return null;
134 134
     }
135 135
     
136
-   /**
137
-    * Checks whether the size notation was valid and could be parsed
138
-    * into a meaningful byte value. If this returns `false`, it is 
139
-    * possible to use the `getErrorXXX` methods to retrieve information
140
-    * on what went wrong. 
141
-    * 
142
-    * @return bool
143
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
144
-    * @see ConvertHelper_SizeNotation::getErrorCode()
145
-    */
136
+    /**
137
+     * Checks whether the size notation was valid and could be parsed
138
+     * into a meaningful byte value. If this returns `false`, it is 
139
+     * possible to use the `getErrorXXX` methods to retrieve information
140
+     * on what went wrong. 
141
+     * 
142
+     * @return bool
143
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
144
+     * @see ConvertHelper_SizeNotation::getErrorCode()
145
+     */
146 146
     public function isValid() : bool
147 147
     {
148 148
         return $this->valid;
149 149
     }
150 150
     
151
-   /**
152
-    * Retrieves the error message if the size notation validation failed.
153
-    * 
154
-    * @return string
155
-    * @see ConvertHelper_SizeNotation::getErrorCode()
156
-    */
151
+    /**
152
+     * Retrieves the error message if the size notation validation failed.
153
+     * 
154
+     * @return string
155
+     * @see ConvertHelper_SizeNotation::getErrorCode()
156
+     */
157 157
     public function getErrorMessage() : string
158 158
     {
159 159
         return $this->errorMessage;
@@ -200,12 +200,12 @@  discard block
 block discarded – undo
200 200
         );
201 201
     }
202 202
     
203
-   /**
204
-    * Detects the units and the number in the size notation string.
205
-    * Populates the `units` and `number` properties.
206
-    * 
207
-    * @return bool Whether the string could be parsed successfully.
208
-    */
203
+    /**
204
+     * Detects the units and the number in the size notation string.
205
+     * Populates the `units` and `number` properties.
206
+     * 
207
+     * @return bool Whether the string could be parsed successfully.
208
+     */
209 209
     protected function detectParts() : bool
210 210
     {
211 211
         $units = ConvertHelper_StorageSizeEnum::getSizeNames();
@@ -241,16 +241,16 @@  discard block
 block discarded – undo
241 241
         return true;
242 242
     }
243 243
     
244
-   /**
245
-    * If the validation fails, this is used to store the reason for retrieval later.
246
-    *  
247
-    * @param string $message
248
-    * @param int $code
249
-    * 
250
-    * @see ConvertHelper_SizeNotation::isValid()
251
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
252
-    * @see ConvertHelper_SizeNotation::getErrorCode()
253
-    */
244
+    /**
245
+     * If the validation fails, this is used to store the reason for retrieval later.
246
+     *  
247
+     * @param string $message
248
+     * @param int $code
249
+     * 
250
+     * @see ConvertHelper_SizeNotation::isValid()
251
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
252
+     * @see ConvertHelper_SizeNotation::getErrorCode()
253
+     */
254 254
     protected function setError(string $message, int $code) : void
255 255
     {
256 256
         $this->valid = false;
@@ -258,12 +258,12 @@  discard block
 block discarded – undo
258 258
         $this->errorCode = $code;
259 259
     }
260 260
     
261
-   /**
262
-    * Retrieves the error code, if the size notation validation failed.
263
-    * 
264
-    * @return int
265
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
266
-    */
261
+    /**
262
+     * Retrieves the error code, if the size notation validation failed.
263
+     * 
264
+     * @return int
265
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
266
+     */
267 267
     public function getErrorCode() : int
268 268
     {
269 269
         return $this->errorCode;
Please login to merge, or discard this patch.
Spacing   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -99,7 +99,7 @@  discard block
 block discarded – undo
99 99
     * @return string
100 100
     * @see ConvertHelper::bytes2readable()
101 101
     */
102
-    public function toString(int $precision=1) : string
102
+    public function toString(int $precision = 1) : string
103 103
     {
104 104
         return ConvertHelper::bytes2readable($this->bytes, $precision, $this->getBase());
105 105
     }
@@ -110,7 +110,7 @@  discard block
 block discarded – undo
110 110
     */
111 111
     public function getBase() : int
112 112
     {
113
-        if($this->isValid()) {
113
+        if ($this->isValid()) {
114 114
             return $this->sizeDefinition->getBase(); 
115 115
         }
116 116
         
@@ -126,7 +126,7 @@  discard block
 block discarded – undo
126 126
     */
127 127
     public function getSizeDefinition() : ?ConvertHelper_StorageSizeEnum_Size
128 128
     {
129
-        if($this->isValid()) {
129
+        if ($this->isValid()) {
130 130
             return $this->sizeDefinition;
131 131
         }
132 132
         
@@ -175,18 +175,18 @@  discard block
 block discarded – undo
175 175
     
176 176
     protected function parseSize() : void
177 177
     {
178
-        if(!$this->detectParts()) {
178
+        if (!$this->detectParts()) {
179 179
             return;
180 180
         }
181 181
         
182 182
         // we detected units in the string: all good.
183
-        if($this->units !== null)
183
+        if ($this->units !== null)
184 184
         {
185 185
             return;
186 186
         }
187 187
         
188 188
         // just a numeric value: we assume this means we're dealing with bytes.
189
-        if(is_numeric($this->number)) 
189
+        if (is_numeric($this->number)) 
190 190
         {
191 191
             $this->units = 'b';
192 192
             return;
@@ -212,12 +212,12 @@  discard block
 block discarded – undo
212 212
         
213 213
         $number = $this->sizeString;
214 214
         
215
-        foreach($units as $unit)
215
+        foreach ($units as $unit)
216 216
         {
217
-            if(stristr($number, $unit))
217
+            if (stristr($number, $unit))
218 218
             {
219 219
                 // there are more than 1 unit defined in the string
220
-                if($this->units !== null)
220
+                if ($this->units !== null)
221 221
                 {
222 222
                     $this->setError(
223 223
                         t(
@@ -273,14 +273,14 @@  discard block
 block discarded – undo
273 273
     {
274 274
         $this->parseSize();
275 275
         
276
-        if(!$this->valid) {
276
+        if (!$this->valid) {
277 277
             return;
278 278
         }
279 279
         
280 280
         $int = intval($this->number);
281 281
         
282 282
         // negative values
283
-        if($int < 0) 
283
+        if ($int < 0) 
284 284
         {
285 285
             $this->setError(
286 286
                 t('Negative values cannot be used as size.'),
Please login to merge, or discard this patch.
src/Request.php 2 patches
Indentation   +122 added lines, -122 removed lines patch added patch discarded remove patch
@@ -39,9 +39,9 @@  discard block
 block discarded – undo
39 39
      */
40 40
     protected static $instance;
41 41
     
42
-   /**
43
-    * @var string
44
-    */
42
+    /**
43
+     * @var string
44
+     */
45 45
     protected $baseURL = '';
46 46
     
47 47
     public function __construct()
@@ -51,10 +51,10 @@  discard block
 block discarded – undo
51 51
         $this->init();
52 52
     }
53 53
     
54
-   /**
55
-    * Can be extended in a subclass, to avoid
56
-    * redefining the constructor.
57
-    */
54
+    /**
55
+     * Can be extended in a subclass, to avoid
56
+     * redefining the constructor.
57
+     */
58 58
     protected function init()
59 59
     {
60 60
         
@@ -124,12 +124,12 @@  discard block
 block discarded – undo
124 124
         return $this->buildURL($params, $dispatcher);
125 125
     }
126 126
     
127
-   /**
128
-    * Retrieves the name of the current dispatcher script / page.
129
-    * This is made to be extended and implemented in a subclass.
130
-    * 
131
-    * @return string
132
-    */
127
+    /**
128
+     * Retrieves the name of the current dispatcher script / page.
129
+     * This is made to be extended and implemented in a subclass.
130
+     * 
131
+     * @return string
132
+     */
133 133
     public function getDispatcher() : string
134 134
     {
135 135
         return '';
@@ -198,10 +198,10 @@  discard block
 block discarded – undo
198 198
         return $url;
199 199
     }
200 200
     
201
-   /**
202
-    * Retrieves the base URL of the application.
203
-    * @return string
204
-    */
201
+    /**
202
+     * Retrieves the base URL of the application.
203
+     * @return string
204
+     */
205 205
     public function getBaseURL() : string
206 206
     {
207 207
         return $this->baseURL;
@@ -231,13 +231,13 @@  discard block
 block discarded – undo
231 231
         return $this->knownParams[$name];
232 232
     }
233 233
     
234
-   /**
235
-    * Retrieves a previously registered parameter instance.
236
-    * 
237
-    * @param string $name
238
-    * @throws Request_Exception
239
-    * @return Request_Param
240
-    */
234
+    /**
235
+     * Retrieves a previously registered parameter instance.
236
+     * 
237
+     * @param string $name
238
+     * @throws Request_Exception
239
+     * @return Request_Param
240
+     */
241 241
     public function getRegisteredParam(string $name) : Request_Param
242 242
     {
243 243
         if(isset($this->knownParams[$name])) {
@@ -254,48 +254,48 @@  discard block
 block discarded – undo
254 254
         );
255 255
     }
256 256
     
257
-   /**
258
-    * Checks whether a parameter with the specified name 
259
-    * has been registered.
260
-    * 
261
-    * @param string $name
262
-    * @return bool
263
-    */
257
+    /**
258
+     * Checks whether a parameter with the specified name 
259
+     * has been registered.
260
+     * 
261
+     * @param string $name
262
+     * @return bool
263
+     */
264 264
     public function hasRegisteredParam(string $name) : bool
265 265
     {
266 266
         return isset($this->knownParams[$name]);
267 267
     }
268 268
     
269
-   /**
270
-    * Retrieves an indexed array with accept mime types
271
-    * that the client sent, in the order of preference
272
-    * the client specified.
273
-    *
274
-    * Example:
275
-    *
276
-    * array(
277
-    *     'text/html',
278
-    *     'application/xhtml+xml',
279
-    *     'image/webp'
280
-    *     ...
281
-    * )
282
-    * 
283
-    * @return array
284
-    * @see Request::parseAcceptHeaders()
285
-    */
269
+    /**
270
+     * Retrieves an indexed array with accept mime types
271
+     * that the client sent, in the order of preference
272
+     * the client specified.
273
+     *
274
+     * Example:
275
+     *
276
+     * array(
277
+     *     'text/html',
278
+     *     'application/xhtml+xml',
279
+     *     'image/webp'
280
+     *     ...
281
+     * )
282
+     * 
283
+     * @return array
284
+     * @see Request::parseAcceptHeaders()
285
+     */
286 286
     public static function getAcceptHeaders() : array
287 287
     {
288 288
         return self::parseAcceptHeaders()->getMimeStrings();
289 289
     }
290 290
     
291
-   /**
292
-    * Returns an instance of the accept headers parser,
293
-    * to access information on the browser's accepted
294
-    * mime types.
295
-    *  
296
-    * @return Request_AcceptHeaders
297
-    * @see Request::getAcceptHeaders()
298
-    */
291
+    /**
292
+     * Returns an instance of the accept headers parser,
293
+     * to access information on the browser's accepted
294
+     * mime types.
295
+     *  
296
+     * @return Request_AcceptHeaders
297
+     * @see Request::getAcceptHeaders()
298
+     */
299 299
     public static function parseAcceptHeaders() : Request_AcceptHeaders
300 300
     {
301 301
         static $accept;
@@ -343,14 +343,14 @@  discard block
 block discarded – undo
343 343
         return false;
344 344
     }
345 345
     
346
-   /**
347
-    * Removes a single parameter from the request.
348
-    * If the parameter has been registered, also
349
-    * removes the registration info.
350
-    * 
351
-    * @param string $name
352
-    * @return Request
353
-    */
346
+    /**
347
+     * Removes a single parameter from the request.
348
+     * If the parameter has been registered, also
349
+     * removes the registration info.
350
+     * 
351
+     * @param string $name
352
+     * @return Request
353
+     */
354 354
     public function removeParam(string $name) : Request
355 355
     {
356 356
         if(isset($_REQUEST[$name])) {
@@ -364,12 +364,12 @@  discard block
 block discarded – undo
364 364
         return $this;
365 365
     }
366 366
     
367
-   /**
368
-    * Removes several parameters from the request.
369
-    * 
370
-    * @param string[] $names
371
-    * @return Request
372
-    */
367
+    /**
368
+     * Removes several parameters from the request.
369
+     * 
370
+     * @param string[] $names
371
+     * @return Request
372
+     */
373 373
     public function removeParams(array $names) : Request
374 374
     {
375 375
         foreach($names as $name) {
@@ -434,18 +434,18 @@  discard block
 block discarded – undo
434 434
         return $val;
435 435
     }
436 436
     
437
-   /**
438
-    * Treats the request parameter as a JSON string, and
439
-    * if it exists and contains valid JSON, returns the
440
-    * decoded JSON value as an array (default).
441
-    *
442
-    * @param string $name
443
-    * @param bool $assoc
444
-    * @return array|object
445
-    * 
446
-    * @see Request::getJSONAssoc()
447
-    * @see Request::getJSONObject()
448
-    */
437
+    /**
438
+     * Treats the request parameter as a JSON string, and
439
+     * if it exists and contains valid JSON, returns the
440
+     * decoded JSON value as an array (default).
441
+     *
442
+     * @param string $name
443
+     * @param bool $assoc
444
+     * @return array|object
445
+     * 
446
+     * @see Request::getJSONAssoc()
447
+     * @see Request::getJSONObject()
448
+     */
449 449
     public function getJSON(string $name, bool $assoc=true)
450 450
     {
451 451
         $value = $this->getParam($name);
@@ -470,13 +470,13 @@  discard block
 block discarded – undo
470 470
         return new \stdClass();
471 471
     }
472 472
     
473
-   /**
474
-    * Like {@link Request::getJSON()}, but omitting the second
475
-    * parameter. Use this for more readable code.
476
-    * 
477
-    * @param string $name
478
-    * @return array
479
-    */
473
+    /**
474
+     * Like {@link Request::getJSON()}, but omitting the second
475
+     * parameter. Use this for more readable code.
476
+     * 
477
+     * @param string $name
478
+     * @return array
479
+     */
480 480
     public function getJSONAssoc(string $name) : array
481 481
     {
482 482
         $result = $this->getJSON($name);
@@ -487,13 +487,13 @@  discard block
 block discarded – undo
487 487
         return array();
488 488
     }
489 489
     
490
-   /**
491
-    * Like {@link Request::getJSON()}, but omitting the second
492
-    * parameter. Use this for more readable code.
493
-    *
494
-    * @param string $name
495
-    * @return object
496
-    */
490
+    /**
491
+     * Like {@link Request::getJSON()}, but omitting the second
492
+     * parameter. Use this for more readable code.
493
+     *
494
+     * @param string $name
495
+     * @return object
496
+     */
497 497
     public function getJSONObject(string $name) : object
498 498
     {
499 499
         $result = $this->getJSON($name, false);
@@ -504,12 +504,12 @@  discard block
 block discarded – undo
504 504
         return new \stdClass();
505 505
     }
506 506
     
507
-   /**
508
-    * Sends a JSON response with the correct headers.
509
-    *
510
-    * @param array|string $data
511
-    * @param bool $exit Whether to exit the script afterwards.
512
-    */
507
+    /**
508
+     * Sends a JSON response with the correct headers.
509
+     *
510
+     * @param array|string $data
511
+     * @param bool $exit Whether to exit the script afterwards.
512
+     */
513 513
     public static function sendJSON($data, bool $exit=true)
514 514
     {
515 515
         $payload = $data;
@@ -529,12 +529,12 @@  discard block
 block discarded – undo
529 529
         }
530 530
     }
531 531
     
532
-   /**
533
-    * Sends HTML to the browser with the correct headers.
534
-    * 
535
-    * @param string $html
536
-    * @param bool $exit Whether to exit the script afterwards.
537
-    */
532
+    /**
533
+     * Sends HTML to the browser with the correct headers.
534
+     * 
535
+     * @param string $html
536
+     * @param bool $exit Whether to exit the script afterwards.
537
+     */
538 538
     public static function sendHTML(string $html, bool $exit=true)
539 539
     {
540 540
         header('Cache-Control: no-cache, must-revalidate');
@@ -549,16 +549,16 @@  discard block
 block discarded – undo
549 549
         }
550 550
     }
551 551
     
552
-   /**
553
-    * Creates a new instance of the URL comparer, which can check 
554
-    * whether the specified URLs match, regardless of the order in 
555
-    * which the query parameters are, if any.
556
-    * 
557
-    * @param string $sourceURL
558
-    * @param string $targetURL
559
-    * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
560
-    * @return Request_URLComparer
561
-    */
552
+    /**
553
+     * Creates a new instance of the URL comparer, which can check 
554
+     * whether the specified URLs match, regardless of the order in 
555
+     * which the query parameters are, if any.
556
+     * 
557
+     * @param string $sourceURL
558
+     * @param string $targetURL
559
+     * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
560
+     * @return Request_URLComparer
561
+     */
562 562
     public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer
563 563
     {
564 564
         $comparer = new Request_URLComparer($this, $sourceURL, $targetURL);
@@ -567,10 +567,10 @@  discard block
 block discarded – undo
567 567
         return $comparer;
568 568
     }
569 569
     
570
-   /**
571
-    * Retrieves the full URL that was used to access the current page.
572
-    * @return string
573
-    */
570
+    /**
571
+     * Retrieves the full URL that was used to access the current page.
572
+     * @return string
573
+     */
574 574
     public function getCurrentURL() : string
575 575
     {
576 576
         return $_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'];
Please login to merge, or discard this patch.
Spacing   +35 added lines, -35 removed lines patch added patch discarded remove patch
@@ -90,11 +90,11 @@  discard block
 block discarded – undo
90 90
     public function getParam($name, $default = null)
91 91
     {
92 92
         $value = $default;
93
-        if(isset($_REQUEST[$name])) {
93
+        if (isset($_REQUEST[$name])) {
94 94
             $value = $_REQUEST[$name];
95 95
         }
96 96
         
97
-        if(isset($this->knownParams[$name])) {
97
+        if (isset($this->knownParams[$name])) {
98 98
             $value = $this->knownParams[$name]->validate($value);
99 99
         }
100 100
         
@@ -143,9 +143,9 @@  discard block
 block discarded – undo
143 143
         
144 144
         $exclude = array_merge($exclude, $this->getExcludeParams());
145 145
         
146
-        foreach($exclude as $name) 
146
+        foreach ($exclude as $name) 
147 147
         {
148
-            if(isset($vars[$name])) 
148
+            if (isset($vars[$name])) 
149 149
             {
150 150
                 unset($vars[$name]);
151 151
             }
@@ -156,9 +156,9 @@  discard block
 block discarded – undo
156 156
         // remove the HTML_QuickForm2 form variable if present, to 
157 157
         // avoid redirect loops when using the refresh URL in
158 158
         // a page in which a form has been submitted.
159
-        foreach($names as $name) 
159
+        foreach ($names as $name) 
160 160
         {
161
-            if(strstr($name, '_qf__')) 
161
+            if (strstr($name, '_qf__')) 
162 162
             {
163 163
                 unset($vars[$name]);
164 164
                 break;
@@ -186,13 +186,13 @@  discard block
 block discarded – undo
186 186
      * @param string $dispatcher Relative path to script to use for the URL. Append trailing slash if needed.
187 187
      * @return string
188 188
      */
189
-    public function buildURL($params = array(), string $dispatcher='')
189
+    public function buildURL($params = array(), string $dispatcher = '')
190 190
     {
191
-        $url = rtrim($this->getBaseURL(), '/') . '/' . $dispatcher;
191
+        $url = rtrim($this->getBaseURL(), '/').'/'.$dispatcher;
192 192
         
193 193
         // append any leftover parameters to the end of the URL
194 194
         if (!empty($params)) {
195
-            $url .= '?' . http_build_query($params, '', '&amp;');
195
+            $url .= '?'.http_build_query($params, '', '&amp;');
196 196
         }
197 197
         
198 198
         return $url;
@@ -223,7 +223,7 @@  discard block
 block discarded – undo
223 223
      */
224 224
     public function registerParam($name)
225 225
     {
226
-        if(!isset($this->knownParams[$name])) {
226
+        if (!isset($this->knownParams[$name])) {
227 227
             $param = new Request_Param($this, $name);
228 228
             $this->knownParams[$name] = $param;
229 229
         }
@@ -240,7 +240,7 @@  discard block
 block discarded – undo
240 240
     */
241 241
     public function getRegisteredParam(string $name) : Request_Param
242 242
     {
243
-        if(isset($this->knownParams[$name])) {
243
+        if (isset($this->knownParams[$name])) {
244 244
             return $this->knownParams[$name];
245 245
         }
246 246
         
@@ -300,7 +300,7 @@  discard block
 block discarded – undo
300 300
     {
301 301
         static $accept;
302 302
         
303
-        if(!isset($accept)) {
303
+        if (!isset($accept)) {
304 304
             $accept = new Request_AcceptHeaders();
305 305
         }
306 306
         
@@ -319,7 +319,7 @@  discard block
 block discarded – undo
319 319
     {
320 320
         $_REQUEST[$name] = $value;
321 321
         
322
-        if(isset($this->knownParams[$name])) {
322
+        if (isset($this->knownParams[$name])) {
323 323
             unset($this->knownParams[$name]);
324 324
         }
325 325
         
@@ -353,11 +353,11 @@  discard block
 block discarded – undo
353 353
     */
354 354
     public function removeParam(string $name) : Request
355 355
     {
356
-        if(isset($_REQUEST[$name])) {
356
+        if (isset($_REQUEST[$name])) {
357 357
             unset($_REQUEST[$name]);
358 358
         }
359 359
         
360
-        if(isset($this->knownParams[$name])) {
360
+        if (isset($this->knownParams[$name])) {
361 361
             unset($this->knownParams[$name]);
362 362
         }
363 363
         
@@ -372,7 +372,7 @@  discard block
 block discarded – undo
372 372
     */
373 373
     public function removeParams(array $names) : Request
374 374
     {
375
-        foreach($names as $name) {
375
+        foreach ($names as $name) {
376 376
             $this->removeParam($name);
377 377
         }
378 378
         
@@ -388,10 +388,10 @@  discard block
 block discarded – undo
388 388
      * @param string $name
389 389
      * @return bool
390 390
      */
391
-    public function getBool($name, $default=false)
391
+    public function getBool($name, $default = false)
392 392
     {
393 393
         $value = $this->getParam($name, $default);
394
-        if(ConvertHelper::isBoolean($value)) {
394
+        if (ConvertHelper::isBoolean($value)) {
395 395
             return ConvertHelper::string2bool($value);
396 396
         }
397 397
         
@@ -400,11 +400,11 @@  discard block
 block discarded – undo
400 400
     
401 401
     public function validate()
402 402
     {
403
-        foreach($this->knownParams as $param) 
403
+        foreach ($this->knownParams as $param) 
404 404
         {
405 405
             $name = $param->getName();
406 406
             
407
-            if($param->isRequired() && !$this->hasParam($name)) 
407
+            if ($param->isRequired() && !$this->hasParam($name)) 
408 408
             {
409 409
                 throw new Request_Exception(
410 410
                     'Missing request parameter '.$name,
@@ -426,10 +426,10 @@  discard block
 block discarded – undo
426 426
      * @param mixed $default
427 427
      * @return string
428 428
      */
429
-    public function getFilteredParam($name, $default=null)
429
+    public function getFilteredParam($name, $default = null)
430 430
     {
431 431
         $val = $this->getParam($name, $default);
432
-        if(is_string($val)) {
432
+        if (is_string($val)) {
433 433
             $val = htmlspecialchars(trim(strip_tags($val)), ENT_QUOTES, 'UTF-8');
434 434
         }
435 435
         
@@ -448,24 +448,24 @@  discard block
 block discarded – undo
448 448
     * @see Request::getJSONAssoc()
449 449
     * @see Request::getJSONObject()
450 450
     */
451
-    public function getJSON(string $name, bool $assoc=true)
451
+    public function getJSON(string $name, bool $assoc = true)
452 452
     {
453 453
         $value = $this->getParam($name);
454 454
         
455
-        if(!empty($value) && is_string($value)) 
455
+        if (!empty($value) && is_string($value)) 
456 456
         {
457 457
             $data = json_decode($value, $assoc);
458 458
             
459
-            if($assoc && is_array($data)) {
459
+            if ($assoc && is_array($data)) {
460 460
                 return $data;
461 461
             }
462 462
             
463
-            if(is_object($data)) {
463
+            if (is_object($data)) {
464 464
                 return $data;
465 465
             }
466 466
         }
467 467
         
468
-        if($assoc) {
468
+        if ($assoc) {
469 469
             return array();
470 470
         }
471 471
         
@@ -482,7 +482,7 @@  discard block
 block discarded – undo
482 482
     public function getJSONAssoc(string $name) : array
483 483
     {
484 484
         $result = $this->getJSON($name);
485
-        if(is_array($result)) {
485
+        if (is_array($result)) {
486 486
             return $result;
487 487
         }
488 488
         
@@ -499,7 +499,7 @@  discard block
 block discarded – undo
499 499
     public function getJSONObject(string $name) : object
500 500
     {
501 501
         $result = $this->getJSON($name, false);
502
-        if(is_object($result)) {
502
+        if (is_object($result)) {
503 503
             return $result;
504 504
         }
505 505
         
@@ -512,10 +512,10 @@  discard block
 block discarded – undo
512 512
     * @param array|string $data
513 513
     * @param bool $exit Whether to exit the script afterwards.
514 514
     */
515
-    public static function sendJSON($data, bool $exit=true)
515
+    public static function sendJSON($data, bool $exit = true)
516 516
     {
517 517
         $payload = $data;
518
-        if(!is_string($payload)) {
518
+        if (!is_string($payload)) {
519 519
             $payload = json_encode($payload);
520 520
         }
521 521
         
@@ -525,7 +525,7 @@  discard block
 block discarded – undo
525 525
         
526 526
         echo $payload;
527 527
         
528
-        if($exit) 
528
+        if ($exit) 
529 529
         {
530 530
             exit;
531 531
         }
@@ -537,7 +537,7 @@  discard block
 block discarded – undo
537 537
     * @param string $html
538 538
     * @param bool $exit Whether to exit the script afterwards.
539 539
     */
540
-    public static function sendHTML(string $html, bool $exit=true)
540
+    public static function sendHTML(string $html, bool $exit = true)
541 541
     {
542 542
         header('Cache-Control: no-cache, must-revalidate');
543 543
         header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
@@ -545,7 +545,7 @@  discard block
 block discarded – undo
545 545
         
546 546
         echo $html;
547 547
         
548
-        if($exit)
548
+        if ($exit)
549 549
         {
550 550
             exit;
551 551
         }
@@ -561,7 +561,7 @@  discard block
 block discarded – undo
561 561
     * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
562 562
     * @return Request_URLComparer
563 563
     */
564
-    public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer
564
+    public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams = array()) : Request_URLComparer
565 565
     {
566 566
         $comparer = new Request_URLComparer($this, $sourceURL, $targetURL);
567 567
         $comparer->addLimitParams($limitParams);
Please login to merge, or discard this patch.
src/Request/AcceptHeaders.php 3 patches
Indentation   +37 added lines, -37 removed lines patch added patch discarded remove patch
@@ -28,20 +28,20 @@  discard block
 block discarded – undo
28 28
         $this->parse();
29 29
     }
30 30
     
31
-   /**
32
-    * Retrieves an indexed array with accept mime types
33
-    * that the client sent, in the order of preference
34
-    * the client specified.
35
-    *
36
-    * Example:
37
-    *
38
-    * array(
39
-    *     'text/html',
40
-    *     'application/xhtml+xml',
41
-    *     'image/webp'
42
-    *     ...
43
-    * )
44
-    */
31
+    /**
32
+     * Retrieves an indexed array with accept mime types
33
+     * that the client sent, in the order of preference
34
+     * the client specified.
35
+     *
36
+     * Example:
37
+     *
38
+     * array(
39
+     *     'text/html',
40
+     *     'application/xhtml+xml',
41
+     *     'image/webp'
42
+     *     ...
43
+     * )
44
+     */
45 45
     public function getMimeStrings() : array
46 46
     {
47 47
         $result = array();
@@ -54,9 +54,9 @@  discard block
 block discarded – undo
54 54
         return $result;
55 55
     }
56 56
     
57
-   /**
58
-    * Checks that an accept header string exists, and tries to parse it.
59
-    */
57
+    /**
58
+     * Checks that an accept header string exists, and tries to parse it.
59
+     */
60 60
     protected function parse() : void
61 61
     {
62 62
         // we may be in a CLI environment where the headers
@@ -68,11 +68,11 @@  discard block
 block discarded – undo
68 68
         $this->headers = $this->parseHeader($_SERVER['HTTP_ACCEPT']);
69 69
     }
70 70
     
71
-   /**
72
-    * Splits the accept header string and parses the mime types.
73
-    *  
74
-    * @param string $acceptHeader 
75
-    */
71
+    /**
72
+     * Splits the accept header string and parses the mime types.
73
+     *  
74
+     * @param string $acceptHeader 
75
+     */
76 76
     protected function parseHeader(string $acceptHeader) : array
77 77
     {
78 78
         $tokens = preg_split('/\s*,\s*/', $acceptHeader);
@@ -89,13 +89,13 @@  discard block
 block discarded – undo
89 89
         return $accept;
90 90
     }
91 91
     
92
-   /**
93
-    * Parses a single mime type entry.
94
-    * 
95
-    * @param int $i The position in the accept string
96
-    * @param string $mime The mime type
97
-    * @return array
98
-    */
92
+    /**
93
+     * Parses a single mime type entry.
94
+     * 
95
+     * @param int $i The position in the accept string
96
+     * @param string $mime The mime type
97
+     * @return array
98
+     */
99 99
     protected function parseEntry(int $i, string $mime) : array
100 100
     {
101 101
         $entry = array(
@@ -125,14 +125,14 @@  discard block
 block discarded – undo
125 125
         return $entry;
126 126
     }
127 127
     
128
-   /**
129
-    * Sorts the mime types collection, first by quality
130
-    * and then by position in the list.
131
-    * 
132
-    * @param array $a
133
-    * @param array $b
134
-    * @return number
135
-    */
128
+    /**
129
+     * Sorts the mime types collection, first by quality
130
+     * and then by position in the list.
131
+     * 
132
+     * @param array $a
133
+     * @param array $b
134
+     * @return number
135
+     */
136 136
     protected function sortMimeTypes(array $a, array $b)
137 137
     {
138 138
         /* first tier: highest q factor wins */
Please login to merge, or discard this patch.
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -46,7 +46,7 @@  discard block
 block discarded – undo
46 46
     {
47 47
         $result = array();
48 48
         
49
-        foreach($this->headers as $header)
49
+        foreach ($this->headers as $header)
50 50
         {
51 51
             $result[] = $header['type'];
52 52
         }
@@ -61,7 +61,7 @@  discard block
 block discarded – undo
61 61
     {
62 62
         // we may be in a CLI environment where the headers
63 63
         // are not populated.
64
-        if(!isset($_SERVER['HTTP_ACCEPT'])) {
64
+        if (!isset($_SERVER['HTTP_ACCEPT'])) {
65 65
             return;
66 66
         }
67 67
         
@@ -79,7 +79,7 @@  discard block
 block discarded – undo
79 79
         
80 80
         $accept = array();
81 81
         
82
-        foreach($tokens as $i => $term)
82
+        foreach ($tokens as $i => $term)
83 83
         {
84 84
             $accept[] = $this->parseEntry($i, $term);
85 85
         }
@@ -105,7 +105,7 @@  discard block
 block discarded – undo
105 105
             'type' => null
106 106
         );
107 107
         
108
-        if(strstr($mime, ';'))
108
+        if (strstr($mime, ';'))
109 109
         {
110 110
             $parts = explode(';', $mime);
111 111
             $mime = array_shift($parts);
@@ -114,7 +114,7 @@  discard block
 block discarded – undo
114 114
             // like an URL query string if separated by ampersands;
115 115
             $entry['params'] = ConvertHelper::parseQueryString(implode('&', $parts));
116 116
                 
117
-            if(isset($entry['params']['q'])) 
117
+            if (isset($entry['params']['q'])) 
118 118
             {
119 119
                 $entry['quality'] = (double)$entry['params']['q'];
120 120
             } 
Please login to merge, or discard this patch.
Braces   +2 added lines, -4 removed lines patch added patch discarded remove patch
@@ -141,14 +141,12 @@
 block discarded – undo
141 141
         if ($diff > 0) 
142 142
         {
143 143
             $diff = 1;
144
-        } 
145
-        else 
144
+        } else 
146 145
         {
147 146
             if ($diff < 0) 
148 147
             {
149 148
                 $diff = -1;
150
-            } 
151
-            else 
149
+            } else 
152 150
             {
153 151
                 /* tie-breaker: first listed item wins */
154 152
                 $diff = $a['pos'] - $b['pos'];
Please login to merge, or discard this patch.
src/FileHelper.php 3 patches
Braces   +3 added lines, -6 removed lines patch added patch discarded remove patch
@@ -215,8 +215,7 @@  discard block
 block discarded – undo
215 215
             if ($item->isDir()) 
216 216
             {
217 217
                 FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName);
218
-            } 
219
-            else if($item->isFile()) 
218
+            } else if($item->isFile()) 
220 219
             {
221 220
                 self::copyFile($itemPath, $target . '/' . $baseName);
222 221
             }
@@ -260,8 +259,7 @@  discard block
 block discarded – undo
260 259
         if(!file_exists($targetFolder))
261 260
         {
262 261
             self::createFolder($targetFolder);
263
-        }
264
-        else if(!is_writable($targetFolder)) 
262
+        } else if(!is_writable($targetFolder)) 
265 263
         {
266 264
             throw new FileHelper_Exception(
267 265
                 sprintf('Target folder [%s] is not writable.', basename($targetFolder)),
@@ -760,8 +758,7 @@  discard block
 block discarded – undo
760 758
         if(isset($options['relative-path']) && $options['relative-path'] === true) 
761 759
         {
762 760
             $finder->setPathmodeRelative();
763
-        } 
764
-        else if(isset($options['absolute-path']) && $options['absolute-path'] === true)
761
+        } else if(isset($options['absolute-path']) && $options['absolute-path'] === true)
765 762
         {
766 763
             $finder->setPathmodeAbsolute();
767 764
         }
Please login to merge, or discard this patch.
Indentation   +423 added lines, -423 removed lines patch added patch discarded remove patch
@@ -78,32 +78,32 @@  discard block
 block discarded – undo
78 78
     
79 79
     const ERROR_PATH_IS_NOT_A_FOLDER = 340034;
80 80
     
81
-   /**
82
-    * Opens a serialized file and returns the unserialized data.
83
-    * 
84
-    * @param string $file
85
-    * @throws FileHelper_Exception
86
-    * @return array
87
-    * @deprecated Use parseSerializedFile() instead.
88
-    * @see FileHelper::parseSerializedFile()
89
-    */
81
+    /**
82
+     * Opens a serialized file and returns the unserialized data.
83
+     * 
84
+     * @param string $file
85
+     * @throws FileHelper_Exception
86
+     * @return array
87
+     * @deprecated Use parseSerializedFile() instead.
88
+     * @see FileHelper::parseSerializedFile()
89
+     */
90 90
     public static function openUnserialized(string $file) : array
91 91
     {
92 92
         return self::parseSerializedFile($file);
93 93
     }
94 94
 
95
-   /**
96
-    * Opens a serialized file and returns the unserialized data.
97
-    *
98
-    * @param string $file
99
-    * @throws FileHelper_Exception
100
-    * @return array
101
-    * @see FileHelper::parseSerializedFile()
102
-    * 
103
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
104
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
105
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
106
-    */
95
+    /**
96
+     * Opens a serialized file and returns the unserialized data.
97
+     *
98
+     * @param string $file
99
+     * @throws FileHelper_Exception
100
+     * @return array
101
+     * @see FileHelper::parseSerializedFile()
102
+     * 
103
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
104
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
105
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
106
+     */
107 107
     public static function parseSerializedFile(string $file)
108 108
     {
109 109
         self::requireFileExists($file);
@@ -172,13 +172,13 @@  discard block
 block discarded – undo
172 172
         return rmdir($rootFolder);
173 173
     }
174 174
     
175
-   /**
176
-    * Create a folder, if it does not exist yet.
177
-    *  
178
-    * @param string $path
179
-    * @throws FileHelper_Exception
180
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
181
-    */
175
+    /**
176
+     * Create a folder, if it does not exist yet.
177
+     *  
178
+     * @param string $path
179
+     * @throws FileHelper_Exception
180
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
181
+     */
182 182
     public static function createFolder($path)
183 183
     {
184 184
         if(is_dir($path) || mkdir($path, 0777, true)) {
@@ -225,22 +225,22 @@  discard block
 block discarded – undo
225 225
         }
226 226
     }
227 227
     
228
-   /**
229
-    * Copies a file to the target location. Includes checks
230
-    * for most error sources, like the source file not being
231
-    * readable. Automatically creates the target folder if it
232
-    * does not exist yet.
233
-    * 
234
-    * @param string $sourcePath
235
-    * @param string $targetPath
236
-    * @throws FileHelper_Exception
237
-    * 
238
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
239
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
240
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
241
-    * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
242
-    * @see FileHelper::ERROR_CANNOT_COPY_FILE
243
-    */
228
+    /**
229
+     * Copies a file to the target location. Includes checks
230
+     * for most error sources, like the source file not being
231
+     * readable. Automatically creates the target folder if it
232
+     * does not exist yet.
233
+     * 
234
+     * @param string $sourcePath
235
+     * @param string $targetPath
236
+     * @throws FileHelper_Exception
237
+     * 
238
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
239
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
240
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
241
+     * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
242
+     * @see FileHelper::ERROR_CANNOT_COPY_FILE
243
+     */
244 244
     public static function copyFile($sourcePath, $targetPath)
245 245
     {
246 246
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
@@ -291,15 +291,15 @@  discard block
 block discarded – undo
291 291
         );
292 292
     }
293 293
     
294
-   /**
295
-    * Deletes the target file. Ignored if it cannot be found,
296
-    * and throws an exception if it fails.
297
-    * 
298
-    * @param string $filePath
299
-    * @throws FileHelper_Exception
300
-    * 
301
-    * @see FileHelper::ERROR_CANNOT_DELETE_FILE
302
-    */
294
+    /**
295
+     * Deletes the target file. Ignored if it cannot be found,
296
+     * and throws an exception if it fails.
297
+     * 
298
+     * @param string $filePath
299
+     * @throws FileHelper_Exception
300
+     * 
301
+     * @see FileHelper::ERROR_CANNOT_DELETE_FILE
302
+     */
303 303
     public static function deleteFile(string $filePath) : void
304 304
     {
305 305
         if(!file_exists($filePath)) {
@@ -321,15 +321,15 @@  discard block
 block discarded – undo
321 321
     }
322 322
 
323 323
     /**
324
-    * Creates a new CSV parser instance and returns it.
325
-    * 
326
-    * @param string $delimiter
327
-    * @param string $enclosure
328
-    * @param string $escape
329
-    * @param bool $heading
330
-    * @return \parseCSV
331
-    * @todo Move this to the CSV helper.
332
-    */
324
+     * Creates a new CSV parser instance and returns it.
325
+     * 
326
+     * @param string $delimiter
327
+     * @param string $enclosure
328
+     * @param string $escape
329
+     * @param bool $heading
330
+     * @return \parseCSV
331
+     * @todo Move this to the CSV helper.
332
+     */
333 333
     public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
334 334
     {
335 335
         if($delimiter==='') { $delimiter = ';'; }
@@ -344,23 +344,23 @@  discard block
 block discarded – undo
344 344
         return $parser;
345 345
     }
346 346
 
347
-   /**
348
-    * Parses all lines in the specified string and returns an
349
-    * indexed array with all csv values in each line.
350
-    *
351
-    * @param string $csv
352
-    * @param string $delimiter
353
-    * @param string $enclosure
354
-    * @param string $escape
355
-    * @param bool $heading
356
-    * @return array
357
-    * @throws FileHelper_Exception
358
-    * 
359
-    * @todo Move this to the CSVHelper.
360
-    *
361
-    * @see parseCSVFile()
362
-    * @see FileHelper::ERROR_PARSING_CSV
363
-    */
347
+    /**
348
+     * Parses all lines in the specified string and returns an
349
+     * indexed array with all csv values in each line.
350
+     *
351
+     * @param string $csv
352
+     * @param string $delimiter
353
+     * @param string $enclosure
354
+     * @param string $escape
355
+     * @param bool $heading
356
+     * @return array
357
+     * @throws FileHelper_Exception
358
+     * 
359
+     * @todo Move this to the CSVHelper.
360
+     *
361
+     * @see parseCSVFile()
362
+     * @see FileHelper::ERROR_PARSING_CSV
363
+     */
364 364
     public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
365 365
     {
366 366
         $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading);
@@ -532,31 +532,31 @@  discard block
 block discarded – undo
532 532
         );
533 533
     }
534 534
     
535
-   /**
536
-    * Verifies whether the target file is a PHP file. The path
537
-    * to the file can be a path to a file as a string, or a 
538
-    * DirectoryIterator object instance.
539
-    * 
540
-    * @param string|\DirectoryIterator $pathOrDirIterator
541
-    * @return boolean
542
-    */
535
+    /**
536
+     * Verifies whether the target file is a PHP file. The path
537
+     * to the file can be a path to a file as a string, or a 
538
+     * DirectoryIterator object instance.
539
+     * 
540
+     * @param string|\DirectoryIterator $pathOrDirIterator
541
+     * @return boolean
542
+     */
543 543
     public static function isPHPFile($pathOrDirIterator)
544 544
     {
545
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
546
-    		return true;
547
-    	}
545
+        if(self::getExtension($pathOrDirIterator) == 'php') {
546
+            return true;
547
+        }
548 548
     	
549
-    	return false;
549
+        return false;
550 550
     }
551 551
     
552
-   /**
553
-    * Retrieves the extension of the specified file. Can be a path
554
-    * to a file as a string, or a DirectoryIterator object instance.
555
-    * 
556
-    * @param string|\DirectoryIterator $pathOrDirIterator
557
-    * @param bool $lowercase
558
-    * @return string
559
-    */
552
+    /**
553
+     * Retrieves the extension of the specified file. Can be a path
554
+     * to a file as a string, or a DirectoryIterator object instance.
555
+     * 
556
+     * @param string|\DirectoryIterator $pathOrDirIterator
557
+     * @param bool $lowercase
558
+     * @return string
559
+     */
560 560
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
561 561
     {
562 562
         if($pathOrDirIterator instanceof \DirectoryIterator) {
@@ -567,51 +567,51 @@  discard block
 block discarded – undo
567 567
          
568 568
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
569 569
         if($lowercase) {
570
-        	$ext = mb_strtolower($ext);
570
+            $ext = mb_strtolower($ext);
571 571
         }
572 572
         
573 573
         return $ext;
574 574
     }
575 575
     
576
-   /**
577
-    * Retrieves the file name from a path, with or without extension.
578
-    * The path to the file can be a string, or a DirectoryIterator object
579
-    * instance.
580
-    * 
581
-    * In case of folders, behaves like the pathinfo function: returns
582
-    * the name of the folder.
583
-    * 
584
-    * @param string|\DirectoryIterator $pathOrDirIterator
585
-    * @param bool $extension
586
-    * @return string
587
-    */
576
+    /**
577
+     * Retrieves the file name from a path, with or without extension.
578
+     * The path to the file can be a string, or a DirectoryIterator object
579
+     * instance.
580
+     * 
581
+     * In case of folders, behaves like the pathinfo function: returns
582
+     * the name of the folder.
583
+     * 
584
+     * @param string|\DirectoryIterator $pathOrDirIterator
585
+     * @param bool $extension
586
+     * @return string
587
+     */
588 588
     public static function getFilename($pathOrDirIterator, $extension = true)
589 589
     {
590 590
         $path = $pathOrDirIterator;
591
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
592
-    		$path = $pathOrDirIterator->getFilename();
593
-    	}
591
+        if($pathOrDirIterator instanceof \DirectoryIterator) {
592
+            $path = $pathOrDirIterator->getFilename();
593
+        }
594 594
     	
595
-    	$path = self::normalizePath($path);
595
+        $path = self::normalizePath($path);
596 596
     	
597
-    	if(!$extension) {
598
-    	    return pathinfo($path, PATHINFO_FILENAME);
599
-    	}
597
+        if(!$extension) {
598
+            return pathinfo($path, PATHINFO_FILENAME);
599
+        }
600 600
     	
601
-    	return pathinfo($path, PATHINFO_BASENAME); 
601
+        return pathinfo($path, PATHINFO_BASENAME); 
602 602
     }
603 603
    
604
-   /**
605
-    * Tries to read the contents of the target file and
606
-    * treat it as JSON to return the decoded JSON data.
607
-    * 
608
-    * @param string $file
609
-    * @throws FileHelper_Exception
610
-    * @return array
611
-    * 
612
-    * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
613
-    * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
614
-    */ 
604
+    /**
605
+     * Tries to read the contents of the target file and
606
+     * treat it as JSON to return the decoded JSON data.
607
+     * 
608
+     * @param string $file
609
+     * @throws FileHelper_Exception
610
+     * @return array
611
+     * 
612
+     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
613
+     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
614
+     */ 
615 615
     public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
616 616
     {
617 617
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
@@ -647,16 +647,16 @@  discard block
 block discarded – undo
647 647
         return $json;
648 648
     }
649 649
     
650
-   /**
651
-    * Corrects common formatting mistakes when users enter
652
-    * file names, like too many spaces, dots and the like.
653
-    * 
654
-    * NOTE: if the file name contains a path, the path is
655
-    * stripped, leaving only the file name.
656
-    * 
657
-    * @param string $name
658
-    * @return string
659
-    */
650
+    /**
651
+     * Corrects common formatting mistakes when users enter
652
+     * file names, like too many spaces, dots and the like.
653
+     * 
654
+     * NOTE: if the file name contains a path, the path is
655
+     * stripped, leaving only the file name.
656
+     * 
657
+     * @param string $name
658
+     * @return string
659
+     */
660 660
     public static function fixFileName(string $name) : string
661 661
     {
662 662
         $name = trim($name);
@@ -686,68 +686,68 @@  discard block
 block discarded – undo
686 686
         return $name;
687 687
     }
688 688
     
689
-   /**
690
-    * Creates an instance of the file finder, which is an easier
691
-    * alternative to the other manual findFile methods, since all
692
-    * options can be set by chaining.
693
-    * 
694
-    * @param string $path
695
-    * @return FileHelper_FileFinder
696
-    */
689
+    /**
690
+     * Creates an instance of the file finder, which is an easier
691
+     * alternative to the other manual findFile methods, since all
692
+     * options can be set by chaining.
693
+     * 
694
+     * @param string $path
695
+     * @return FileHelper_FileFinder
696
+     */
697 697
     public static function createFileFinder(string $path) : FileHelper_FileFinder
698 698
     {
699 699
         return new FileHelper_FileFinder($path);
700 700
     }
701 701
     
702
-   /**
703
-    * Searches for all HTML files in the target folder.
704
-    * 
705
-    * NOTE: This method only exists for backwards compatibility.
706
-    * Use the `createFileFinder()` method instead, which offers
707
-    * an object oriented interface that is much easier to use.
708
-    * 
709
-    * @param string $targetFolder
710
-    * @param array $options
711
-    * @return array An indexed array with files.
712
-    * @see FileHelper::createFileFinder()
713
-    */
702
+    /**
703
+     * Searches for all HTML files in the target folder.
704
+     * 
705
+     * NOTE: This method only exists for backwards compatibility.
706
+     * Use the `createFileFinder()` method instead, which offers
707
+     * an object oriented interface that is much easier to use.
708
+     * 
709
+     * @param string $targetFolder
710
+     * @param array $options
711
+     * @return array An indexed array with files.
712
+     * @see FileHelper::createFileFinder()
713
+     */
714 714
     public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
715 715
     {
716 716
         return self::findFiles($targetFolder, array('html'), $options);
717 717
     }
718 718
 
719
-   /**
720
-    * Searches for all PHP files in the target folder.
721
-    * 
722
-    * NOTE: This method only exists for backwards compatibility.
723
-    * Use the `createFileFinder()` method instead, which offers
724
-    * an object oriented interface that is much easier to use.
725
-    * 
726
-    * @param string $targetFolder
727
-    * @param array $options
728
-    * @return array An indexed array of PHP files.
729
-    * @see FileHelper::createFileFinder()
730
-    */
719
+    /**
720
+     * Searches for all PHP files in the target folder.
721
+     * 
722
+     * NOTE: This method only exists for backwards compatibility.
723
+     * Use the `createFileFinder()` method instead, which offers
724
+     * an object oriented interface that is much easier to use.
725
+     * 
726
+     * @param string $targetFolder
727
+     * @param array $options
728
+     * @return array An indexed array of PHP files.
729
+     * @see FileHelper::createFileFinder()
730
+     */
731 731
     public static function findPHPFiles(string $targetFolder, array $options=array()) : array
732 732
     {
733 733
         return self::findFiles($targetFolder, array('php'), $options);
734 734
     }
735 735
     
736
-   /**
737
-    * Finds files according to the specified options.
738
-    * 
739
-    * NOTE: This method only exists for backwards compatibility.
740
-    * Use the `createFileFinder()` method instead, which offers
741
-    * an object oriented interface that is much easier to use.
742
-    *  
743
-    * @param string $targetFolder
744
-    * @param array $extensions
745
-    * @param array $options
746
-    * @param array $files
747
-    * @throws FileHelper_Exception
748
-    * @return array
749
-    * @see FileHelper::createFileFinder()
750
-    */
736
+    /**
737
+     * Finds files according to the specified options.
738
+     * 
739
+     * NOTE: This method only exists for backwards compatibility.
740
+     * Use the `createFileFinder()` method instead, which offers
741
+     * an object oriented interface that is much easier to use.
742
+     *  
743
+     * @param string $targetFolder
744
+     * @param array $extensions
745
+     * @param array $options
746
+     * @param array $files
747
+     * @throws FileHelper_Exception
748
+     * @return array
749
+     * @see FileHelper::createFileFinder()
750
+     */
751 751
     public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
752 752
     {
753 753
         $finder = self::createFileFinder($targetFolder);
@@ -773,14 +773,14 @@  discard block
 block discarded – undo
773 773
         return $finder->getAll();
774 774
     }
775 775
 
776
-   /**
777
-    * Removes the extension from the specified path or file name,
778
-    * if any, and returns the name without the extension.
779
-    * 
780
-    * @param string $filename
781
-    * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to.
782
-    * @return string
783
-    */
776
+    /**
777
+     * Removes the extension from the specified path or file name,
778
+     * if any, and returns the name without the extension.
779
+     * 
780
+     * @param string $filename
781
+     * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to.
782
+     * @return string
783
+     */
784 784
     public static function removeExtension(string $filename, bool $keepPath=false) : string
785 785
     {
786 786
         // normalize paths to allow windows style slashes even on nix servers
@@ -800,22 +800,22 @@  discard block
 block discarded – undo
800 800
         return implode('/', $parts);
801 801
     }
802 802
     
803
-   /**
804
-    * Detects the UTF BOM in the target file, if any. Returns
805
-    * the encoding matching the BOM, which can be any of the
806
-    * following:
807
-    * 
808
-    * <ul>
809
-    * <li>UTF32-BE</li>
810
-    * <li>UTF32-LE</li>
811
-    * <li>UTF16-BE</li>
812
-    * <li>UTF16-LE</li>
813
-    * <li>UTF8</li>
814
-    * </ul>
815
-    * 
816
-    * @param string $filename
817
-    * @return string|NULL
818
-    */
803
+    /**
804
+     * Detects the UTF BOM in the target file, if any. Returns
805
+     * the encoding matching the BOM, which can be any of the
806
+     * following:
807
+     * 
808
+     * <ul>
809
+     * <li>UTF32-BE</li>
810
+     * <li>UTF32-LE</li>
811
+     * <li>UTF16-BE</li>
812
+     * <li>UTF16-LE</li>
813
+     * <li>UTF8</li>
814
+     * </ul>
815
+     * 
816
+     * @param string $filename
817
+     * @return string|NULL
818
+     */
819 819
     public static function detectUTFBom(string $filename) : ?string
820 820
     {
821 821
         $fp = fopen($filename, 'r');
@@ -847,13 +847,13 @@  discard block
 block discarded – undo
847 847
     
848 848
     protected static $utfBoms;
849 849
     
850
-   /**
851
-    * Retrieves a list of all UTF byte order mark character
852
-    * sequences, as an assocative array with UTF encoding => bom sequence
853
-    * pairs.
854
-    * 
855
-    * @return array
856
-    */
850
+    /**
851
+     * Retrieves a list of all UTF byte order mark character
852
+     * sequences, as an assocative array with UTF encoding => bom sequence
853
+     * pairs.
854
+     * 
855
+     * @return array
856
+     */
857 857
     public static function getUTFBOMs()
858 858
     {
859 859
         if(!isset(self::$utfBoms)) {
@@ -869,15 +869,15 @@  discard block
 block discarded – undo
869 869
         return self::$utfBoms;
870 870
     }
871 871
     
872
-   /**
873
-    * Checks whether the specified encoding is a valid
874
-    * unicode encoding, for example "UTF16-LE" or "UTF8".
875
-    * Also accounts for alternate way to write the, like
876
-    * "UTF-8", and omitting little/big endian suffixes.
877
-    * 
878
-    * @param string $encoding
879
-    * @return boolean
880
-    */
872
+    /**
873
+     * Checks whether the specified encoding is a valid
874
+     * unicode encoding, for example "UTF16-LE" or "UTF8".
875
+     * Also accounts for alternate way to write the, like
876
+     * "UTF-8", and omitting little/big endian suffixes.
877
+     * 
878
+     * @param string $encoding
879
+     * @return boolean
880
+     */
881 881
     public static function isValidUnicodeEncoding(string $encoding) : bool
882 882
     {
883 883
         $encodings = self::getKnownUnicodeEncodings();
@@ -896,40 +896,40 @@  discard block
 block discarded – undo
896 896
         return in_array($encoding, $keep);
897 897
     }
898 898
     
899
-   /**
900
-    * Retrieves a list of all known unicode file encodings.
901
-    * @return array
902
-    */
899
+    /**
900
+     * Retrieves a list of all known unicode file encodings.
901
+     * @return array
902
+     */
903 903
     public static function getKnownUnicodeEncodings()
904 904
     {
905 905
         return array_keys(self::getUTFBOMs());
906 906
     }
907 907
     
908
-   /**
909
-    * Normalizes the slash style in a file or folder path,
910
-    * by replacing any antislashes with forward slashes.
911
-    * 
912
-    * @param string $path
913
-    * @return string
914
-    */
908
+    /**
909
+     * Normalizes the slash style in a file or folder path,
910
+     * by replacing any antislashes with forward slashes.
911
+     * 
912
+     * @param string $path
913
+     * @return string
914
+     */
915 915
     public static function normalizePath(string $path) : string
916 916
     {
917 917
         return str_replace(array('\\', '//'), array('/', '/'), $path);
918 918
     }
919 919
     
920
-   /**
921
-    * Saves the specified data to a file, JSON encoded.
922
-    * 
923
-    * @param mixed $data
924
-    * @param string $file
925
-    * @param bool $pretty
926
-    * @throws FileHelper_Exception
927
-    * 
928
-    * @see FileHelper::ERROR_JSON_ENCODE_ERROR
929
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
930
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
931
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
932
-    */
920
+    /**
921
+     * Saves the specified data to a file, JSON encoded.
922
+     * 
923
+     * @param mixed $data
924
+     * @param string $file
925
+     * @param bool $pretty
926
+     * @throws FileHelper_Exception
927
+     * 
928
+     * @see FileHelper::ERROR_JSON_ENCODE_ERROR
929
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
930
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
931
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
932
+     */
933 933
     public static function saveAsJSON($data, string $file, bool $pretty=false)
934 934
     {
935 935
         $options = null;
@@ -953,18 +953,18 @@  discard block
 block discarded – undo
953 953
         self::saveFile($file, $json);
954 954
     }
955 955
    
956
-   /**
957
-    * Saves the specified content to the target file, creating
958
-    * the file and the folder as necessary.
959
-    * 
960
-    * @param string $filePath
961
-    * @param string $content
962
-    * @throws FileHelper_Exception
963
-    * 
964
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
965
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
966
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
967
-    */
956
+    /**
957
+     * Saves the specified content to the target file, creating
958
+     * the file and the folder as necessary.
959
+     * 
960
+     * @param string $filePath
961
+     * @param string $content
962
+     * @throws FileHelper_Exception
963
+     * 
964
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
965
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
966
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
967
+     */
968 968
     public static function saveFile(string $filePath, string $content='') : void
969 969
     {
970 970
         // target file already exists
@@ -1017,12 +1017,12 @@  discard block
 block discarded – undo
1017 1017
         );
1018 1018
     }
1019 1019
     
1020
-   /**
1021
-    * Checks whether it is possible to run PHP command 
1022
-    * line commands.
1023
-    * 
1024
-    * @return boolean
1025
-    */
1020
+    /**
1021
+     * Checks whether it is possible to run PHP command 
1022
+     * line commands.
1023
+     * 
1024
+     * @return boolean
1025
+     */
1026 1026
     public static function canMakePHPCalls() : bool
1027 1027
     {
1028 1028
         return self::cliCommandExists('php');
@@ -1099,16 +1099,16 @@  discard block
 block discarded – undo
1099 1099
         return $result;
1100 1100
     }
1101 1101
     
1102
-   /**
1103
-    * Validates a PHP file's syntax.
1104
-    * 
1105
-    * NOTE: This will fail silently if the PHP command line
1106
-    * is not available. Use {@link FileHelper::canMakePHPCalls()}
1107
-    * to check this beforehand as needed.
1108
-    * 
1109
-    * @param string $path
1110
-    * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
1111
-    */
1102
+    /**
1103
+     * Validates a PHP file's syntax.
1104
+     * 
1105
+     * NOTE: This will fail silently if the PHP command line
1106
+     * is not available. Use {@link FileHelper::canMakePHPCalls()}
1107
+     * to check this beforehand as needed.
1108
+     * 
1109
+     * @param string $path
1110
+     * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
1111
+     */
1112 1112
     public static function checkPHPFileSyntax($path)
1113 1113
     {
1114 1114
         if(!self::canMakePHPCalls()) {
@@ -1132,14 +1132,14 @@  discard block
 block discarded – undo
1132 1132
         return $output;
1133 1133
     }
1134 1134
     
1135
-   /**
1136
-    * Retrieves the last modified date for the specified file or folder.
1137
-    * 
1138
-    * Note: If the target does not exist, returns null. 
1139
-    * 
1140
-    * @param string $path
1141
-    * @return \DateTime|NULL
1142
-    */
1135
+    /**
1136
+     * Retrieves the last modified date for the specified file or folder.
1137
+     * 
1138
+     * Note: If the target does not exist, returns null. 
1139
+     * 
1140
+     * @param string $path
1141
+     * @return \DateTime|NULL
1142
+     */
1143 1143
     public static function getModifiedDate($path)
1144 1144
     {
1145 1145
         $time = filemtime($path);
@@ -1152,24 +1152,24 @@  discard block
 block discarded – undo
1152 1152
         return null; 
1153 1153
     }
1154 1154
     
1155
-   /**
1156
-    * Retrieves the names of all subfolders in the specified path.
1157
-    * 
1158
-    * Available options:
1159
-    * 
1160
-    * - recursive: true/false
1161
-    *   Whether to search for subfolders recursively. 
1162
-    *   
1163
-    * - absolute-paths: true/false
1164
-    *   Whether to return a list of absolute paths.
1165
-    * 
1166
-    * @param string $targetFolder
1167
-    * @param array $options
1168
-    * @throws FileHelper_Exception
1169
-    * @return string[]
1170
-    * 
1171
-    * @todo Move this to a separate class.
1172
-    */
1155
+    /**
1156
+     * Retrieves the names of all subfolders in the specified path.
1157
+     * 
1158
+     * Available options:
1159
+     * 
1160
+     * - recursive: true/false
1161
+     *   Whether to search for subfolders recursively. 
1162
+     *   
1163
+     * - absolute-paths: true/false
1164
+     *   Whether to return a list of absolute paths.
1165
+     * 
1166
+     * @param string $targetFolder
1167
+     * @param array $options
1168
+     * @throws FileHelper_Exception
1169
+     * @return string[]
1170
+     * 
1171
+     * @todo Move this to a separate class.
1172
+     */
1173 1173
     public static function getSubfolders($targetFolder, $options = array())
1174 1174
     {
1175 1175
         if(!is_dir($targetFolder)) 
@@ -1230,16 +1230,16 @@  discard block
 block discarded – undo
1230 1230
         return $result;
1231 1231
     }
1232 1232
 
1233
-   /**
1234
-    * Retrieves the maximum allowed upload file size, in bytes.
1235
-    * Takes into account the PHP ini settings <code>post_max_size</code>
1236
-    * and <code>upload_max_filesize</code>. Since these cannot
1237
-    * be modified at runtime, they are the hard limits for uploads.
1238
-    * 
1239
-    * NOTE: Based on binary values, where 1KB = 1024 Bytes.
1240
-    * 
1241
-    * @return int Will return <code>-1</code> if no limit.
1242
-    */
1233
+    /**
1234
+     * Retrieves the maximum allowed upload file size, in bytes.
1235
+     * Takes into account the PHP ini settings <code>post_max_size</code>
1236
+     * and <code>upload_max_filesize</code>. Since these cannot
1237
+     * be modified at runtime, they are the hard limits for uploads.
1238
+     * 
1239
+     * NOTE: Based on binary values, where 1KB = 1024 Bytes.
1240
+     * 
1241
+     * @return int Will return <code>-1</code> if no limit.
1242
+     */
1243 1243
     public static function getMaxUploadFilesize() : int
1244 1244
     {
1245 1245
         static $max_size = -1;
@@ -1277,16 +1277,16 @@  discard block
 block discarded – undo
1277 1277
         return round($size);
1278 1278
     }
1279 1279
    
1280
-   /**
1281
-    * Makes a path relative using a folder depth: will reduce the
1282
-    * length of the path so that only the amount of folders defined
1283
-    * in the <code>$depth</code> attribute are shown below the actual
1284
-    * folder or file in the path.
1285
-    *  
1286
-    * @param string  $path The absolute or relative path
1287
-    * @param int $depth The folder depth to reduce the path to
1288
-    * @return string
1289
-    */
1280
+    /**
1281
+     * Makes a path relative using a folder depth: will reduce the
1282
+     * length of the path so that only the amount of folders defined
1283
+     * in the <code>$depth</code> attribute are shown below the actual
1284
+     * folder or file in the path.
1285
+     *  
1286
+     * @param string  $path The absolute or relative path
1287
+     * @param int $depth The folder depth to reduce the path to
1288
+     * @return string
1289
+     */
1290 1290
     public static function relativizePathByDepth(string $path, int $depth=2) : string
1291 1291
     {
1292 1292
         $path = self::normalizePath($path);
@@ -1324,23 +1324,23 @@  discard block
 block discarded – undo
1324 1324
         return trim(implode('/', $tokens), '/');
1325 1325
     }
1326 1326
     
1327
-   /**
1328
-    * Makes the specified path relative to another path,
1329
-    * by removing one from the other if found. Also 
1330
-    * normalizes the path to use forward slashes. 
1331
-    * 
1332
-    * Example:
1333
-    * 
1334
-    * <pre>
1335
-    * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
1336
-    * </pre>
1337
-    * 
1338
-    * Result: <code>to/file.txt</code>
1339
-    * 
1340
-    * @param string $path
1341
-    * @param string $relativeTo
1342
-    * @return string
1343
-    */
1327
+    /**
1328
+     * Makes the specified path relative to another path,
1329
+     * by removing one from the other if found. Also 
1330
+     * normalizes the path to use forward slashes. 
1331
+     * 
1332
+     * Example:
1333
+     * 
1334
+     * <pre>
1335
+     * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
1336
+     * </pre>
1337
+     * 
1338
+     * Result: <code>to/file.txt</code>
1339
+     * 
1340
+     * @param string $path
1341
+     * @param string $relativeTo
1342
+     * @return string
1343
+     */
1344 1344
     public static function relativizePath(string $path, string $relativeTo) : string
1345 1345
     {
1346 1346
         $path = self::normalizePath($path);
@@ -1352,17 +1352,17 @@  discard block
 block discarded – undo
1352 1352
         return $relative;
1353 1353
     }
1354 1354
     
1355
-   /**
1356
-    * Checks that the target file exists, and throws an exception
1357
-    * if it does not. 
1358
-    * 
1359
-    * @param string $path
1360
-    * @param int|NULL $errorCode Optional custom error code
1361
-    * @throws FileHelper_Exception
1362
-    * @return string The real path to the file
1363
-    * 
1364
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1365
-    */
1355
+    /**
1356
+     * Checks that the target file exists, and throws an exception
1357
+     * if it does not. 
1358
+     * 
1359
+     * @param string $path
1360
+     * @param int|NULL $errorCode Optional custom error code
1361
+     * @throws FileHelper_Exception
1362
+     * @return string The real path to the file
1363
+     * 
1364
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1365
+     */
1366 1366
     public static function requireFileExists(string $path, $errorCode=null) : string
1367 1367
     {
1368 1368
         $result = realpath($path);
@@ -1381,18 +1381,18 @@  discard block
 block discarded – undo
1381 1381
         );
1382 1382
     }
1383 1383
     
1384
-   /**
1385
-    * Reads a specific line number from the target file and returns its
1386
-    * contents, if the file has such a line. Does so with little memory
1387
-    * usage, as the file is not read entirely into memory.
1388
-    * 
1389
-    * @param string $path
1390
-    * @param int $lineNumber Note: 1-based; the first line is number 1.
1391
-    * @return string|NULL Will return null if the requested line does not exist.
1392
-    * @throws FileHelper_Exception
1393
-    * 
1394
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1395
-    */
1384
+    /**
1385
+     * Reads a specific line number from the target file and returns its
1386
+     * contents, if the file has such a line. Does so with little memory
1387
+     * usage, as the file is not read entirely into memory.
1388
+     * 
1389
+     * @param string $path
1390
+     * @param int $lineNumber Note: 1-based; the first line is number 1.
1391
+     * @return string|NULL Will return null if the requested line does not exist.
1392
+     * @throws FileHelper_Exception
1393
+     * 
1394
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1395
+     */
1396 1396
     public static function getLineFromFile(string $path, int $lineNumber) : ?string
1397 1397
     {
1398 1398
         self::requireFileExists($path);
@@ -1408,19 +1408,19 @@  discard block
 block discarded – undo
1408 1408
         $file->seek($targetLine);
1409 1409
         
1410 1410
         if($file->key() !== $targetLine) {
1411
-             return null;
1411
+                return null;
1412 1412
         }
1413 1413
         
1414 1414
         return $file->current(); 
1415 1415
     }
1416 1416
     
1417
-   /**
1418
-    * Retrieves the total amount of lines in the file, without 
1419
-    * reading the whole file into memory.
1420
-    * 
1421
-    * @param string $path
1422
-    * @return int
1423
-    */
1417
+    /**
1418
+     * Retrieves the total amount of lines in the file, without 
1419
+     * reading the whole file into memory.
1420
+     * 
1421
+     * @param string $path
1422
+     * @return int
1423
+     */
1424 1424
     public static function countFileLines(string $path) : int
1425 1425
     {
1426 1426
         self::requireFileExists($path);
@@ -1450,26 +1450,26 @@  discard block
 block discarded – undo
1450 1450
         return $number+1;
1451 1451
     }
1452 1452
     
1453
-   /**
1454
-    * Parses the target file to detect any PHP classes contained
1455
-    * within, and retrieve information on them. Does not use the 
1456
-    * PHP reflection API.
1457
-    * 
1458
-    * @param string $filePath
1459
-    * @return FileHelper_PHPClassInfo
1460
-    */
1453
+    /**
1454
+     * Parses the target file to detect any PHP classes contained
1455
+     * within, and retrieve information on them. Does not use the 
1456
+     * PHP reflection API.
1457
+     * 
1458
+     * @param string $filePath
1459
+     * @return FileHelper_PHPClassInfo
1460
+     */
1461 1461
     public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo
1462 1462
     {
1463 1463
         return new FileHelper_PHPClassInfo($filePath);
1464 1464
     }
1465 1465
     
1466
-   /**
1467
-    * Detects the end of line style used in the target file, if any.
1468
-    * Can be used with large files, because it only reads part of it.
1469
-    * 
1470
-    * @param string $filePath The path to the file.
1471
-    * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
1472
-    */
1466
+    /**
1467
+     * Detects the end of line style used in the target file, if any.
1468
+     * Can be used with large files, because it only reads part of it.
1469
+     * 
1470
+     * @param string $filePath The path to the file.
1471
+     * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
1472
+     */
1473 1473
     public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL
1474 1474
     {
1475 1475
         // 20 lines is enough to get a good picture of the newline style in the file.
@@ -1482,18 +1482,18 @@  discard block
 block discarded – undo
1482 1482
         return ConvertHelper::detectEOLCharacter($string);
1483 1483
     }
1484 1484
     
1485
-   /**
1486
-    * Reads the specified amount of lines from the target file.
1487
-    * Unicode BOM compatible: any byte order marker is stripped
1488
-    * from the resulting lines.
1489
-    * 
1490
-    * @param string $filePath
1491
-    * @param int $amount Set to 0 to read all lines.
1492
-    * @return array
1493
-    * 
1494
-    * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1495
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1496
-    */
1485
+    /**
1486
+     * Reads the specified amount of lines from the target file.
1487
+     * Unicode BOM compatible: any byte order marker is stripped
1488
+     * from the resulting lines.
1489
+     * 
1490
+     * @param string $filePath
1491
+     * @param int $amount Set to 0 to read all lines.
1492
+     * @return array
1493
+     * 
1494
+     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1495
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1496
+     */
1497 1497
     public static function readLines(string $filePath, int $amount=0) : array
1498 1498
     {
1499 1499
         self::requireFileExists($filePath);
@@ -1546,16 +1546,16 @@  discard block
 block discarded – undo
1546 1546
         return $result;
1547 1547
     }
1548 1548
     
1549
-   /**
1550
-    * Reads all content from a file.
1551
-    * 
1552
-    * @param string $filePath
1553
-    * @throws FileHelper_Exception
1554
-    * @return string
1555
-    * 
1556
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1557
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
1558
-    */
1549
+    /**
1550
+     * Reads all content from a file.
1551
+     * 
1552
+     * @param string $filePath
1553
+     * @throws FileHelper_Exception
1554
+     * @return string
1555
+     * 
1556
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1557
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
1558
+     */
1559 1559
     public static function readContents(string $filePath) : string
1560 1560
     {
1561 1561
         self::requireFileExists($filePath);
@@ -1576,18 +1576,18 @@  discard block
 block discarded – undo
1576 1576
         );
1577 1577
     }
1578 1578
 
1579
-   /**
1580
-    * Ensures that the target path exists on disk, and is a folder.
1581
-    * 
1582
-    * @param string $path
1583
-    * @return string The real path, with normalized slashes.
1584
-    * @throws FileHelper_Exception
1585
-    * 
1586
-    * @see FileHelper::normalizePath()
1587
-    * 
1588
-    * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
1589
-    * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
1590
-    */
1579
+    /**
1580
+     * Ensures that the target path exists on disk, and is a folder.
1581
+     * 
1582
+     * @param string $path
1583
+     * @return string The real path, with normalized slashes.
1584
+     * @throws FileHelper_Exception
1585
+     * 
1586
+     * @see FileHelper::normalizePath()
1587
+     * 
1588
+     * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
1589
+     * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
1590
+     */
1591 1591
     public static function requireFolderExists(string $path) : string
1592 1592
     {
1593 1593
         $actual = realpath($path);
Please login to merge, or discard this patch.
Spacing   +102 added lines, -102 removed lines patch added patch discarded remove patch
@@ -110,7 +110,7 @@  discard block
 block discarded – undo
110 110
         
111 111
         $contents = file_get_contents($file);
112 112
         
113
-        if($contents === false) 
113
+        if ($contents === false) 
114 114
         {
115 115
             throw new FileHelper_Exception(
116 116
                 'Cannot load serialized content from file.',
@@ -124,7 +124,7 @@  discard block
 block discarded – undo
124 124
         
125 125
         $result = @unserialize($contents);
126 126
         
127
-        if($result !== false) {
127
+        if ($result !== false) {
128 128
             return $result;
129 129
         }
130 130
         
@@ -140,7 +140,7 @@  discard block
 block discarded – undo
140 140
     
141 141
     public static function deleteTree($rootFolder)
142 142
     {
143
-        if(!file_exists($rootFolder)) {
143
+        if (!file_exists($rootFolder)) {
144 144
             return true;
145 145
         }
146 146
         
@@ -181,7 +181,7 @@  discard block
 block discarded – undo
181 181
     */
182 182
     public static function createFolder($path)
183 183
     {
184
-        if(is_dir($path) || mkdir($path, 0777, true)) {
184
+        if (is_dir($path) || mkdir($path, 0777, true)) {
185 185
             return;
186 186
         }
187 187
         
@@ -216,11 +216,11 @@  discard block
 block discarded – undo
216 216
 
217 217
             if ($item->isDir()) 
218 218
             {
219
-                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName);
219
+                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target.'/'.$baseName);
220 220
             } 
221
-            else if($item->isFile()) 
221
+            else if ($item->isFile()) 
222 222
             {
223
-                self::copyFile($itemPath, $target . '/' . $baseName);
223
+                self::copyFile($itemPath, $target.'/'.$baseName);
224 224
             }
225 225
         }
226 226
     }
@@ -245,7 +245,7 @@  discard block
 block discarded – undo
245 245
     {
246 246
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
247 247
         
248
-        if(!is_readable($sourcePath))
248
+        if (!is_readable($sourcePath))
249 249
         {
250 250
             throw new FileHelper_Exception(
251 251
                 sprintf('Source file [%s] to copy is not readable.', basename($sourcePath)),
@@ -259,11 +259,11 @@  discard block
 block discarded – undo
259 259
         
260 260
         $targetFolder = dirname($targetPath);
261 261
         
262
-        if(!file_exists($targetFolder))
262
+        if (!file_exists($targetFolder))
263 263
         {
264 264
             self::createFolder($targetFolder);
265 265
         }
266
-        else if(!is_writable($targetFolder)) 
266
+        else if (!is_writable($targetFolder)) 
267 267
         {
268 268
             throw new FileHelper_Exception(
269 269
                 sprintf('Target folder [%s] is not writable.', basename($targetFolder)),
@@ -275,7 +275,7 @@  discard block
 block discarded – undo
275 275
             );
276 276
         }
277 277
         
278
-        if(copy($sourcePath, $targetPath)) {
278
+        if (copy($sourcePath, $targetPath)) {
279 279
             return;
280 280
         }
281 281
         
@@ -302,11 +302,11 @@  discard block
 block discarded – undo
302 302
     */
303 303
     public static function deleteFile(string $filePath) : void
304 304
     {
305
-        if(!file_exists($filePath)) {
305
+        if (!file_exists($filePath)) {
306 306
             return;
307 307
         }
308 308
         
309
-        if(unlink($filePath)) {
309
+        if (unlink($filePath)) {
310 310
             return;
311 311
         }
312 312
         
@@ -330,10 +330,10 @@  discard block
 block discarded – undo
330 330
     * @return \parseCSV
331 331
     * @todo Move this to the CSV helper.
332 332
     */
333
-    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
333
+    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : \parseCSV
334 334
     {
335
-        if($delimiter==='') { $delimiter = ';'; }
336
-        if($enclosure==='') { $enclosure = '"'; }
335
+        if ($delimiter === '') { $delimiter = ';'; }
336
+        if ($enclosure === '') { $enclosure = '"'; }
337 337
         
338 338
         $parser = new \parseCSV(null, null, null, array());
339 339
 
@@ -361,11 +361,11 @@  discard block
 block discarded – undo
361 361
     * @see parseCSVFile()
362 362
     * @see FileHelper::ERROR_PARSING_CSV
363 363
     */
364
-    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
364
+    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
365 365
     {
366 366
         $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading);
367 367
         $result = $parser->parse_string(/** @scrutinizer ignore-type */ $csv);
368
-        if(is_array($result)) {
368
+        if (is_array($result)) {
369 369
             return $result;
370 370
         }
371 371
         
@@ -394,7 +394,7 @@  discard block
 block discarded – undo
394 394
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
395 395
      * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
396 396
      */
397
-    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
397
+    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
398 398
     {
399 399
         $content = self::readContents($filePath);
400 400
 
@@ -411,7 +411,7 @@  discard block
 block discarded – undo
411 411
     public static function detectMimeType(string $fileName) : ?string
412 412
     {
413 413
         $ext = self::getExtension($fileName);
414
-        if(empty($ext)) {
414
+        if (empty($ext)) {
415 415
             return null;
416 416
         }
417 417
 
@@ -432,11 +432,11 @@  discard block
 block discarded – undo
432 432
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
433 433
      * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE
434 434
      */
435
-    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true)
435
+    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true)
436 436
     {
437 437
         self::requireFileExists($filePath);
438 438
         
439
-        if(empty($fileName)) {
439
+        if (empty($fileName)) {
440 440
             $fileName = basename($filePath);
441 441
         }
442 442
 
@@ -454,10 +454,10 @@  discard block
 block discarded – undo
454 454
         
455 455
         header("Cache-Control: public", true);
456 456
         header("Content-Description: File Transfer", true);
457
-        header("Content-Type: " . $mime, true);
457
+        header("Content-Type: ".$mime, true);
458 458
 
459 459
         $disposition = 'inline';
460
-        if($asAttachment) {
460
+        if ($asAttachment) {
461 461
             $disposition = 'attachment';
462 462
         }
463 463
         
@@ -485,7 +485,7 @@  discard block
 block discarded – undo
485 485
         requireCURL();
486 486
         
487 487
         $ch = curl_init();
488
-        if(!is_resource($ch)) 
488
+        if (!is_resource($ch)) 
489 489
         {
490 490
             throw new FileHelper_Exception(
491 491
                 'Could not initialize a new cURL instance.',
@@ -506,7 +506,7 @@  discard block
 block discarded – undo
506 506
         
507 507
         $output = curl_exec($ch);
508 508
 
509
-        if($output === false) {
509
+        if ($output === false) {
510 510
             throw new FileHelper_Exception(
511 511
                 'Unable to open URL',
512 512
                 sprintf(
@@ -520,7 +520,7 @@  discard block
 block discarded – undo
520 520
 
521 521
         curl_close($ch);
522 522
 
523
-        if(is_string($output)) 
523
+        if (is_string($output)) 
524 524
         {
525 525
             return $output;
526 526
         }
@@ -542,7 +542,7 @@  discard block
 block discarded – undo
542 542
     */
543 543
     public static function isPHPFile($pathOrDirIterator)
544 544
     {
545
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
545
+    	if (self::getExtension($pathOrDirIterator) == 'php') {
546 546
     		return true;
547 547
     	}
548 548
     	
@@ -559,14 +559,14 @@  discard block
 block discarded – undo
559 559
     */
560 560
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
561 561
     {
562
-        if($pathOrDirIterator instanceof \DirectoryIterator) {
562
+        if ($pathOrDirIterator instanceof \DirectoryIterator) {
563 563
             $filename = $pathOrDirIterator->getFilename();
564 564
         } else {
565 565
             $filename = basename($pathOrDirIterator);
566 566
         }
567 567
          
568 568
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
569
-        if($lowercase) {
569
+        if ($lowercase) {
570 570
         	$ext = mb_strtolower($ext);
571 571
         }
572 572
         
@@ -588,13 +588,13 @@  discard block
 block discarded – undo
588 588
     public static function getFilename($pathOrDirIterator, $extension = true)
589 589
     {
590 590
         $path = $pathOrDirIterator;
591
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
591
+    	if ($pathOrDirIterator instanceof \DirectoryIterator) {
592 592
     		$path = $pathOrDirIterator->getFilename();
593 593
     	}
594 594
     	
595 595
     	$path = self::normalizePath($path);
596 596
     	
597
-    	if(!$extension) {
597
+    	if (!$extension) {
598 598
     	    return pathinfo($path, PATHINFO_FILENAME);
599 599
     	}
600 600
     	
@@ -612,12 +612,12 @@  discard block
 block discarded – undo
612 612
     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
613 613
     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
614 614
     */ 
615
-    public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
615
+    public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null)
616 616
     {
617 617
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
618 618
         
619 619
         $content = file_get_contents($file);
620
-        if(!$content) {
620
+        if (!$content) {
621 621
             throw new FileHelper_Exception(
622 622
                 'Cannot get file contents',
623 623
                 sprintf(
@@ -628,12 +628,12 @@  discard block
 block discarded – undo
628 628
             );
629 629
         }
630 630
         
631
-        if(isset($targetEncoding)) {
631
+        if (isset($targetEncoding)) {
632 632
             $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding);
633 633
         }
634 634
         
635 635
         $json = json_decode($content, true);
636
-        if($json === false || $json === NULL) {
636
+        if ($json === false || $json === NULL) {
637 637
             throw new FileHelper_Exception(
638 638
                 'Cannot decode json data',
639 639
                 sprintf(
@@ -673,13 +673,13 @@  discard block
 block discarded – undo
673 673
         
674 674
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
675 675
         
676
-        while(strstr($name, '  ')) {
676
+        while (strstr($name, '  ')) {
677 677
             $name = str_replace('  ', ' ', $name);
678 678
         }
679 679
 
680 680
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
681 681
         
682
-        while(strstr($name, '..')) {
682
+        while (strstr($name, '..')) {
683 683
             $name = str_replace('..', '.', $name);
684 684
         }
685 685
         
@@ -711,7 +711,7 @@  discard block
 block discarded – undo
711 711
     * @return array An indexed array with files.
712 712
     * @see FileHelper::createFileFinder()
713 713
     */
714
-    public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
714
+    public static function findHTMLFiles(string $targetFolder, array $options = array()) : array
715 715
     {
716 716
         return self::findFiles($targetFolder, array('html'), $options);
717 717
     }
@@ -728,7 +728,7 @@  discard block
 block discarded – undo
728 728
     * @return array An indexed array of PHP files.
729 729
     * @see FileHelper::createFileFinder()
730 730
     */
731
-    public static function findPHPFiles(string $targetFolder, array $options=array()) : array
731
+    public static function findPHPFiles(string $targetFolder, array $options = array()) : array
732 732
     {
733 733
         return self::findFiles($targetFolder, array('php'), $options);
734 734
     }
@@ -748,22 +748,22 @@  discard block
 block discarded – undo
748 748
     * @return array
749 749
     * @see FileHelper::createFileFinder()
750 750
     */
751
-    public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
751
+    public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array
752 752
     {
753 753
         $finder = self::createFileFinder($targetFolder);
754 754
 
755 755
         $finder->setPathmodeStrip();
756 756
         
757
-        if(isset($options['relative-path']) && $options['relative-path'] === true) 
757
+        if (isset($options['relative-path']) && $options['relative-path'] === true) 
758 758
         {
759 759
             $finder->setPathmodeRelative();
760 760
         } 
761
-        else if(isset($options['absolute-path']) && $options['absolute-path'] === true)
761
+        else if (isset($options['absolute-path']) && $options['absolute-path'] === true)
762 762
         {
763 763
             $finder->setPathmodeAbsolute();
764 764
         }
765 765
         
766
-        if(isset($options['strip-extension'])) 
766
+        if (isset($options['strip-extension'])) 
767 767
         {
768 768
             $finder->stripExtensions();
769 769
         }
@@ -781,12 +781,12 @@  discard block
 block discarded – undo
781 781
     * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to.
782 782
     * @return string
783 783
     */
784
-    public static function removeExtension(string $filename, bool $keepPath=false) : string
784
+    public static function removeExtension(string $filename, bool $keepPath = false) : string
785 785
     {
786 786
         // normalize paths to allow windows style slashes even on nix servers
787 787
         $filename = self::normalizePath($filename);
788 788
         
789
-        if(!$keepPath) 
789
+        if (!$keepPath) 
790 790
         {
791 791
             return pathinfo($filename, PATHINFO_FILENAME);
792 792
         }
@@ -819,7 +819,7 @@  discard block
 block discarded – undo
819 819
     public static function detectUTFBom(string $filename) : ?string
820 820
     {
821 821
         $fp = fopen($filename, 'r');
822
-        if($fp === false) 
822
+        if ($fp === false) 
823 823
         {
824 824
             throw new FileHelper_Exception(
825 825
                 'Cannot open file for reading',
@@ -834,10 +834,10 @@  discard block
 block discarded – undo
834 834
 
835 835
         $boms = self::getUTFBOMs();
836 836
         
837
-        foreach($boms as $bom => $value) 
837
+        foreach ($boms as $bom => $value) 
838 838
         {
839 839
             $length = mb_strlen($value);
840
-            if(mb_substr($text, 0, $length) == $value) {
840
+            if (mb_substr($text, 0, $length) == $value) {
841 841
                 return $bom;
842 842
             }
843 843
         }
@@ -856,13 +856,13 @@  discard block
 block discarded – undo
856 856
     */
857 857
     public static function getUTFBOMs()
858 858
     {
859
-        if(!isset(self::$utfBoms)) {
859
+        if (!isset(self::$utfBoms)) {
860 860
             self::$utfBoms = array(
861
-                'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF),
862
-                'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00),
863
-                'UTF16-BE' => chr(0xFE) . chr(0xFF),
864
-                'UTF16-LE' => chr(0xFF) . chr(0xFE),
865
-                'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF)
861
+                'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF),
862
+                'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00),
863
+                'UTF16-BE' => chr(0xFE).chr(0xFF),
864
+                'UTF16-LE' => chr(0xFF).chr(0xFE),
865
+                'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF)
866 866
             );
867 867
         }
868 868
         
@@ -883,7 +883,7 @@  discard block
 block discarded – undo
883 883
         $encodings = self::getKnownUnicodeEncodings();
884 884
 
885 885
         $keep = array();
886
-        foreach($encodings as $string) 
886
+        foreach ($encodings as $string) 
887 887
         {
888 888
             $withHyphen = str_replace('UTF', 'UTF-', $string);
889 889
             
@@ -930,16 +930,16 @@  discard block
 block discarded – undo
930 930
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
931 931
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
932 932
     */
933
-    public static function saveAsJSON($data, string $file, bool $pretty=false)
933
+    public static function saveAsJSON($data, string $file, bool $pretty = false)
934 934
     {
935 935
         $options = null;
936
-        if($pretty) {
936
+        if ($pretty) {
937 937
             $options = JSON_PRETTY_PRINT;
938 938
         }
939 939
         
940 940
         $json = json_encode($data, $options);
941 941
         
942
-        if($json===false) 
942
+        if ($json === false) 
943 943
         {
944 944
             $errorCode = json_last_error();
945 945
             
@@ -965,12 +965,12 @@  discard block
 block discarded – undo
965 965
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
966 966
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
967 967
     */
968
-    public static function saveFile(string $filePath, string $content='') : void
968
+    public static function saveFile(string $filePath, string $content = '') : void
969 969
     {
970 970
         // target file already exists
971
-        if(file_exists($filePath))
971
+        if (file_exists($filePath))
972 972
         {
973
-            if(!is_writable($filePath))
973
+            if (!is_writable($filePath))
974 974
             {
975 975
                 throw new FileHelper_Exception(
976 976
                     sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)),
@@ -990,7 +990,7 @@  discard block
 block discarded – undo
990 990
             // create the folder as needed
991 991
             self::createFolder($targetFolder);
992 992
             
993
-            if(!is_writable($targetFolder)) 
993
+            if (!is_writable($targetFolder)) 
994 994
             {
995 995
                 throw new FileHelper_Exception(
996 996
                     sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)),
@@ -1003,7 +1003,7 @@  discard block
 block discarded – undo
1003 1003
             }
1004 1004
         }
1005 1005
         
1006
-        if(file_put_contents($filePath, $content) !== false) {
1006
+        if (file_put_contents($filePath, $content) !== false) {
1007 1007
             return;
1008 1008
         }
1009 1009
         
@@ -1041,7 +1041,7 @@  discard block
 block discarded – undo
1041 1041
     {
1042 1042
         static $checked = array();
1043 1043
         
1044
-        if(isset($checked[$command])) {
1044
+        if (isset($checked[$command])) {
1045 1045
             return $checked[$command];
1046 1046
         }
1047 1047
         
@@ -1054,7 +1054,7 @@  discard block
 block discarded – undo
1054 1054
         
1055 1055
         $os = strtolower(PHP_OS_FAMILY);
1056 1056
         
1057
-        if(!isset($osCommands[$os])) 
1057
+        if (!isset($osCommands[$os])) 
1058 1058
         {
1059 1059
             throw new FileHelper_Exception(
1060 1060
                 'Unsupported OS for CLI commands',
@@ -1080,7 +1080,7 @@  discard block
 block discarded – undo
1080 1080
             $pipes
1081 1081
         );
1082 1082
         
1083
-        if($process === false) {
1083
+        if ($process === false) {
1084 1084
             $checked[$command] = false;
1085 1085
             return false;
1086 1086
         }
@@ -1111,7 +1111,7 @@  discard block
 block discarded – undo
1111 1111
     */
1112 1112
     public static function checkPHPFileSyntax($path)
1113 1113
     {
1114
-        if(!self::canMakePHPCalls()) {
1114
+        if (!self::canMakePHPCalls()) {
1115 1115
             return true;
1116 1116
         }
1117 1117
         
@@ -1122,7 +1122,7 @@  discard block
 block discarded – undo
1122 1122
         // when the validation is successful, the first entry
1123 1123
         // in the array contains the success message. When it
1124 1124
         // is invalid, the first entry is always empty.
1125
-        if(!empty($output[0])) {
1125
+        if (!empty($output[0])) {
1126 1126
             return true;
1127 1127
         }
1128 1128
         
@@ -1143,7 +1143,7 @@  discard block
 block discarded – undo
1143 1143
     public static function getModifiedDate($path)
1144 1144
     {
1145 1145
         $time = filemtime($path);
1146
-        if($time !== false) {
1146
+        if ($time !== false) {
1147 1147
             $date = new \DateTime();
1148 1148
             $date->setTimestamp($time);
1149 1149
             return $date;
@@ -1172,7 +1172,7 @@  discard block
 block discarded – undo
1172 1172
     */
1173 1173
     public static function getSubfolders($targetFolder, $options = array())
1174 1174
     {
1175
-        if(!is_dir($targetFolder)) 
1175
+        if (!is_dir($targetFolder)) 
1176 1176
         {
1177 1177
             throw new FileHelper_Exception(
1178 1178
                 'Target folder does not exist',
@@ -1196,29 +1196,29 @@  discard block
 block discarded – undo
1196 1196
         
1197 1197
         $d = new \DirectoryIterator($targetFolder);
1198 1198
         
1199
-        foreach($d as $item) 
1199
+        foreach ($d as $item) 
1200 1200
         {
1201
-            if($item->isDir() && !$item->isDot()) 
1201
+            if ($item->isDir() && !$item->isDot()) 
1202 1202
             {
1203 1203
                 $name = $item->getFilename();
1204 1204
                 
1205
-                if(!$options['absolute-path']) {
1205
+                if (!$options['absolute-path']) {
1206 1206
                     $result[] = $name;
1207 1207
                 } else {
1208 1208
                     $result[] = $targetFolder.'/'.$name;
1209 1209
                 }
1210 1210
                 
1211
-                if(!$options['recursive']) 
1211
+                if (!$options['recursive']) 
1212 1212
                 {
1213 1213
                     continue;
1214 1214
                 }
1215 1215
                 
1216 1216
                 $subs = self::getSubfolders($targetFolder.'/'.$name, $options);
1217
-                foreach($subs as $sub) 
1217
+                foreach ($subs as $sub) 
1218 1218
                 {
1219 1219
                     $relative = $name.'/'.$sub;
1220 1220
                     
1221
-                    if(!$options['absolute-path']) {
1221
+                    if (!$options['absolute-path']) {
1222 1222
                         $result[] = $relative;
1223 1223
                     } else {
1224 1224
                         $result[] = $targetFolder.'/'.$relative;
@@ -1268,7 +1268,7 @@  discard block
 block discarded – undo
1268 1268
         $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size.
1269 1269
         $size = floatval(preg_replace('/[^0-9\.]/', '', $size)); // Remove the non-numeric characters from the size.
1270 1270
         
1271
-        if($unit) 
1271
+        if ($unit) 
1272 1272
         {
1273 1273
             // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by.
1274 1274
             return round($size * pow(1024, stripos('bkmgtpezy', $unit[0])));
@@ -1287,7 +1287,7 @@  discard block
 block discarded – undo
1287 1287
     * @param int $depth The folder depth to reduce the path to
1288 1288
     * @return string
1289 1289
     */
1290
-    public static function relativizePathByDepth(string $path, int $depth=2) : string
1290
+    public static function relativizePathByDepth(string $path, int $depth = 2) : string
1291 1291
     {
1292 1292
         $path = self::normalizePath($path);
1293 1293
         
@@ -1295,17 +1295,17 @@  discard block
 block discarded – undo
1295 1295
         $tokens = array_filter($tokens); // remove empty entries (trailing slash for example)
1296 1296
         $tokens = array_values($tokens); // re-index keys
1297 1297
         
1298
-        if(empty($tokens)) {
1298
+        if (empty($tokens)) {
1299 1299
             return '';
1300 1300
         }
1301 1301
         
1302 1302
         // remove the drive if present
1303
-        if(strstr($tokens[0], ':')) {
1303
+        if (strstr($tokens[0], ':')) {
1304 1304
             array_shift($tokens);
1305 1305
         }
1306 1306
         
1307 1307
         // path was only the drive
1308
-        if(count($tokens) == 0) {
1308
+        if (count($tokens) == 0) {
1309 1309
             return '';
1310 1310
         }
1311 1311
 
@@ -1314,8 +1314,8 @@  discard block
 block discarded – undo
1314 1314
         
1315 1315
         // reduce the path to the specified depth
1316 1316
         $length = count($tokens);
1317
-        if($length > $depth) {
1318
-            $tokens = array_slice($tokens, $length-$depth);
1317
+        if ($length > $depth) {
1318
+            $tokens = array_slice($tokens, $length - $depth);
1319 1319
         }
1320 1320
 
1321 1321
         // append the last element again
@@ -1363,14 +1363,14 @@  discard block
 block discarded – undo
1363 1363
     * 
1364 1364
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1365 1365
     */
1366
-    public static function requireFileExists(string $path, $errorCode=null) : string
1366
+    public static function requireFileExists(string $path, $errorCode = null) : string
1367 1367
     {
1368 1368
         $result = realpath($path);
1369
-        if($result !== false) {
1369
+        if ($result !== false) {
1370 1370
             return $result;
1371 1371
         }
1372 1372
         
1373
-        if($errorCode === null) {
1373
+        if ($errorCode === null) {
1374 1374
             $errorCode = self::ERROR_FILE_DOES_NOT_EXIST;
1375 1375
         }
1376 1376
         
@@ -1399,15 +1399,15 @@  discard block
 block discarded – undo
1399 1399
         
1400 1400
         $file = new \SplFileObject($path);
1401 1401
         
1402
-        if($file->eof()) {
1402
+        if ($file->eof()) {
1403 1403
             return '';
1404 1404
         }
1405 1405
         
1406
-        $targetLine = $lineNumber-1;
1406
+        $targetLine = $lineNumber - 1;
1407 1407
         
1408 1408
         $file->seek($targetLine);
1409 1409
         
1410
-        if($file->key() !== $targetLine) {
1410
+        if ($file->key() !== $targetLine) {
1411 1411
              return null;
1412 1412
         }
1413 1413
         
@@ -1433,7 +1433,7 @@  discard block
 block discarded – undo
1433 1433
         $number = $spl->key();
1434 1434
         
1435 1435
         // if seeking to the end the cursor is still at 0, there are no lines. 
1436
-        if($number === 0) 
1436
+        if ($number === 0) 
1437 1437
         {
1438 1438
             // since it's a very small file, to get reliable results,
1439 1439
             // we read its contents and use that to determine what
@@ -1441,13 +1441,13 @@  discard block
 block discarded – undo
1441 1441
             // that this is not pactical to solve with the SplFileObject.
1442 1442
             $content = file_get_contents($path);
1443 1443
             
1444
-            if(empty($content)) {
1444
+            if (empty($content)) {
1445 1445
                 return 0;
1446 1446
             }
1447 1447
         }
1448 1448
         
1449 1449
         // return the line number we were able to reach + 1 (key is zero-based)
1450
-        return $number+1;
1450
+        return $number + 1;
1451 1451
     }
1452 1452
     
1453 1453
    /**
@@ -1494,13 +1494,13 @@  discard block
 block discarded – undo
1494 1494
     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1495 1495
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1496 1496
     */
1497
-    public static function readLines(string $filePath, int $amount=0) : array
1497
+    public static function readLines(string $filePath, int $amount = 0) : array
1498 1498
     {
1499 1499
         self::requireFileExists($filePath);
1500 1500
         
1501 1501
         $fn = fopen($filePath, "r");
1502 1502
         
1503
-        if($fn === false) 
1503
+        if ($fn === false) 
1504 1504
         {
1505 1505
             throw new FileHelper_Exception(
1506 1506
                 'Could not open file for reading.',
@@ -1516,19 +1516,19 @@  discard block
 block discarded – undo
1516 1516
         $counter = 0;
1517 1517
         $first = true;
1518 1518
         
1519
-        while(!feof($fn)) 
1519
+        while (!feof($fn)) 
1520 1520
         {
1521 1521
             $counter++;
1522 1522
             
1523 1523
             $line = fgets($fn);
1524 1524
             
1525 1525
             // can happen with zero length files
1526
-            if($line === false) {
1526
+            if ($line === false) {
1527 1527
                 continue;
1528 1528
             }
1529 1529
             
1530 1530
             // the first line may contain a unicode BOM marker.
1531
-            if($first) 
1531
+            if ($first) 
1532 1532
             {
1533 1533
                 $line = ConvertHelper::stripUTFBom($line);
1534 1534
                 $first = false;
@@ -1536,7 +1536,7 @@  discard block
 block discarded – undo
1536 1536
             
1537 1537
             $result[] = $line;
1538 1538
             
1539
-            if($amount > 0 && $counter == $amount) {
1539
+            if ($amount > 0 && $counter == $amount) {
1540 1540
                 break;
1541 1541
             }
1542 1542
         }
@@ -1562,7 +1562,7 @@  discard block
 block discarded – undo
1562 1562
         
1563 1563
         $result = file_get_contents($filePath);
1564 1564
         
1565
-        if($result !== false) {
1565
+        if ($result !== false) {
1566 1566
             return $result;
1567 1567
         }
1568 1568
         
@@ -1592,7 +1592,7 @@  discard block
 block discarded – undo
1592 1592
     {
1593 1593
         $actual = realpath($path);
1594 1594
         
1595
-        if($actual === false) 
1595
+        if ($actual === false) 
1596 1596
         {
1597 1597
             throw new FileHelper_Exception(
1598 1598
                 'Folder does not exist',
@@ -1604,7 +1604,7 @@  discard block
 block discarded – undo
1604 1604
             );
1605 1605
         }
1606 1606
         
1607
-        if(is_dir($path)) 
1607
+        if (is_dir($path)) 
1608 1608
         {
1609 1609
             return self::normalizePath($actual);
1610 1610
         }
Please login to merge, or discard this patch.