Merge pull request #5090 from colemanw/explorer
[civicrm-core.git] / CRM / Utils / Zip.php
index c445ce69033e9a28f3250e8c00b524b4bb61a592..078bab427ecb0cd0cdc5f51da3aedc0127b442c3 100644 (file)
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -93,12 +93,13 @@ class CRM_Utils_Zip {
   }
 
   /**
-   * Determine the name of the folder within a zip
+   * Determine the name of the folder within a zip.
    *
    * @param ZipArchive $zip
    * @param $expected
    *
-   * @return string or FALSE
+   * @return string
+   *   or FALSE
    */
   static public function guessBasedir(ZipArchive $zip, $expected) {
     $candidate = FALSE;
@@ -122,11 +123,11 @@ class CRM_Utils_Zip {
    * An inefficient helper for creating a ZIP file from data in memory.
    * This is only intended for building temp files for unit-testing.
    *
-   * @param $zipName
-   *   String, file name.
-   * @param $dirs
+   * @param string $zipName
+   *   file name.
+   * @param array $dirs
    *   Array, list of directory paths.
-   * @param $files
+   * @param array $files
    *   Array, keys are file names and values are file contents.
    * @return bool
    */
@@ -151,4 +152,5 @@ class CRM_Utils_Zip {
     }
     return TRUE;
   }
+
 }