Mistralys / application-utils

src/ZIPHelper.php

Indentation +55 added lines, -55 removed lines

@@ -36,14 +36,14 @@ 
         'WriteThreshold' => 100
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $file;
     
-   /**
-    * @var \ZipArchive
-    */
+    /**
+     * @var \ZipArchive
+     */
     protected $zip;
     
     public function __construct(string $targetFile)
@@ -51,35 +51,35 @@ 
         $this->file = $targetFile;
     }
     
-   /**
-    * Sets an option, among the available options:
-    * 
-    * <ul>
-    * <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>
-    * </ul>
-    * 
-    * @param string $name
-    * @param mixed $value
-    * @return ZIPHelper
-    */
+    /**
+     * Sets an option, among the available options:
+     * 
+     * <ul>
+     * <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>
+     * </ul>
+     * 
+     * @param string $name
+     * @param mixed $value
+     * @return ZIPHelper
+     */
     public function setOption(string $name, $value) : ZIPHelper
     {
         $this->options[$name] = $value;
         return $this;
     }
     
-   /**
-    * Adds a file to the zip. By default, the file is stored
-    * with the same name in the root of the zip. Use the optional
-    * parameter to change the location in the zip.
-    * 
-    * @param string $filePath
-    * @param string|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root.
-    * @throws ZIPHelper_Exception
-    * @return bool
-    * 
-    * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Adds a file to the zip. By default, the file is stored
+     * with the same name in the root of the zip. Use the optional
+     * parameter to change the location in the zip.
+     * 
+     * @param string $filePath
+     * @param string|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root.
+     * @throws ZIPHelper_Exception
+     * @return bool
+     * 
+     * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
+     */
     public function addFile(string $filePath, ?string $zipPath=null) : bool
     {
         $this->open();
@@ -255,13 +255,13 @@ 
         return $fileName;
     }
     
-   /**
-    * Like {@link ZIPHelper::download()}, but deletes the
-    * file after sending it to the browser.
-    * 
-    * @param string|NULL $fileName Override the ZIP's file name for the download
-    * @see ZIPHelper::download()
-    */
+    /**
+     * Like {@link ZIPHelper::download()}, but deletes the
+     * file after sending it to the browser.
+     * 
+     * @param string|NULL $fileName Override the ZIP's file name for the download
+     * @see ZIPHelper::download()
+     */
     public function downloadAndDelete(?string $fileName=null)
     {
         $this->download($fileName);
@@ -269,14 +269,14 @@ 
         FileHelper::deleteFile($this->file);
     }
 
-   /**
-    * Extracts all files and folders from the zip to the 
-    * target folder. If no folder is specified, the files
-    * are extracted into the same folder as the zip itself.
-    * 
-    * @param string|NULL $outputFolder If no folder is specified, uses the target file's folder.
-    * @return boolean
-    */
+    /**
+     * Extracts all files and folders from the zip to the 
+     * target folder. If no folder is specified, the files
+     * are extracted into the same folder as the zip itself.
+     * 
+     * @param string|NULL $outputFolder If no folder is specified, uses the target file's folder.
+     * @return boolean
+     */
     public function extractAll(?string $outputFolder=null) : bool
     {
         if(empty($outputFolder)) {
@@ -289,9 +289,9 @@ 
     }
 
     
-   /**
-    * @return \ZipArchive
-    */
+    /**
+     * @return \ZipArchive
+     */
     public function getArchive() : \ZipArchive
     {
         $this->open();
@@ -299,14 +299,14 @@ 
         return $this->zip;
     }
     
-   /**
-    * JSON encodes the specified data and adds the json as
-    * a file in the ZIP archive.
-    * 
-    * @param mixed $data
-    * @param string $zipPath
-    * @return boolean
-    */
+    /**
+     * JSON encodes the specified data and adds the json as
+     * a file in the ZIP archive.
+     * 
+     * @param mixed $data
+     * @param string $zipPath
+     * @return boolean
+     */
     public function addJSON($data, $zipPath)
     {
         return $this->addString(

Spacing +17 added lines, -17 removed lines

@@ -30,7 +30,7 @@ 
     
     const ERROR_OPENING_ZIP_FILE = 338003;
     
-    const ERROR_CANNOT_SAVE_FILE_TO_DISK =338004;
+    const ERROR_CANNOT_SAVE_FILE_TO_DISK = 338004;
     
     protected $options = array(
         'WriteThreshold' => 100
@@ -80,7 +80,7 @@ 
     * 
     * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
     */
-    public function addFile(string $filePath, ?string $zipPath=null) : bool
+    public function addFile(string $filePath, ?string $zipPath = null) : bool
     {
         $this->open();
         
@@ -126,16 +126,16 @@ 
     
     protected function open()
     {
-        if($this->open) {
+        if ($this->open) {
             return;
         }
         
-        if(!isset($this->zip)) {
+        if (!isset($this->zip)) {
             $this->zip = new \ZipArchive();
         }
         
         $flag = null;
-        if(!file_exists($this->file)) {
+        if (!file_exists($this->file)) {
             $flag = \ZipArchive::CREATE;
         }
         
@@ -175,7 +175,7 @@ 
     {
         $this->fileTracker++;
 
-        if($this->options['WriteThreshold'] < 1) {
+        if ($this->options['WriteThreshold'] < 1) {
             return;
         }
         
@@ -188,7 +188,7 @@ 
     
     protected function close()
     {
-        if(!$this->open) {
+        if (!$this->open) {
             return;
         }
         
@@ -197,8 +197,8 @@ 
             throw new ZIPHelper_Exception(
                 'Could not save ZIP file to disk',
                 sprintf(
-                    'Tried saving the ZIP file [%1$s], but the write failed. This can have several causes, ' .
-                    'including adding files that do not exist on disk, trying to create an empty zip, ' .
+                    'Tried saving the ZIP file [%1$s], but the write failed. This can have several causes, '.
+                    'including adding files that do not exist on disk, trying to create an empty zip, '.
                     'or trying to save to a directory that does not exist.',
                     $this->file
                 ),
@@ -213,7 +213,7 @@ 
     {
         $this->open();
         
-        if($this->countFiles() < 1) 
+        if ($this->countFiles() < 1) 
         {
             throw new ZIPHelper_Exception(
                 'No files in the zip file',
@@ -237,17 +237,17 @@ 
      * @throws ZIPHelper_Exception
      * @return string The file name that was sent (useful in case none was specified).
      */
-    public function download(?string $fileName=null) : string
+    public function download(?string $fileName = null) : string
     {
         $this->save();
         
-        if(empty($fileName)) {
+        if (empty($fileName)) {
             $fileName = basename($this->file);
         }
         
         header('Content-type: application/zip');
-        header('Content-Disposition: attachment; filename=' . $fileName);
-        header('Content-length: ' . filesize($this->file));
+        header('Content-Disposition: attachment; filename='.$fileName);
+        header('Content-length: '.filesize($this->file));
         header('Pragma: no-cache');
         header('Expires: 0');
         readfile($this->file);
@@ -262,7 +262,7 @@ 
     * @param string|NULL $fileName Override the ZIP's file name for the download
     * @see ZIPHelper::download()
     */
-    public function downloadAndDelete(?string $fileName=null)
+    public function downloadAndDelete(?string $fileName = null)
     {
         $this->download($fileName);
         
@@ -277,9 +277,9 @@ 
     * @param string|NULL $outputFolder If no folder is specified, uses the target file's folder.
     * @return boolean
     */
-    public function extractAll(?string $outputFolder=null) : bool
+    public function extractAll(?string $outputFolder = null) : bool
     {
-        if(empty($outputFolder)) {
+        if (empty($outputFolder)) {
             $outputFolder = dirname($this->file);
         }