Passed
Push — master ( b7993c...4f13bc )
by Sebastian
02:59
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.