Merge pull request #4621 from atif-shaikh/CRM-15589

[civicrm-core.git] / CRM / Utils / Zip.php

diff --git a/CRM/Utils/Zip.php b/CRM/Utils/Zip.php
index 6a8bddd07a412b7cbbde9545f3ad2d5fbee5ed70..38213520a250d716181d9f06739504828c23c195 100644 (file)
--- a/CRM/Utils/Zip.php
+++ b/CRM/Utils/Zip.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -41,6 +41,8 @@ class CRM_Utils_Zip {
   /**
    * Given a zip file which contains a single root directory, determine the root's name.
    *
+   * @param ZipArchive $zip
+   *
    * @return mixed; FALSE if #root level items !=1; otherwise, the name of base dir
    */
   static public function findBaseDirName(ZipArchive $zip) {
@@ -69,6 +71,8 @@ class CRM_Utils_Zip {
   /**
    * Given a zip file, find all directory names in the root
    *
+   * @param ZipArchive $zip
+   *
    * @return array(string), no trailing /
    */
   static public function findBaseDirs(ZipArchive $zip) {
@@ -89,6 +93,9 @@ class CRM_Utils_Zip {
   /**
    * Determine the name of the folder within a zip
    *
+   * @param ZipArchive $zip
+   * @param $expected
+   *
    * @return string or FALSE
    */
   static public function guessBasedir(ZipArchive $zip, $expected) {