Merge pull request #5479 from eileenmcnaughton/4.6

[civicrm-core.git] / CRM / Extension / Downloader.php

diff --git a/CRM/Extension/Downloader.php b/CRM/Extension/Downloader.php
index a9698a52877283f5f9c27602a2b7382f54842261..dfb36abcad6a5cd723541836460524e445006c48 100644 (file)
--- a/CRM/Extension/Downloader.php
+++ b/CRM/Extension/Downloader.php
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * This class handles downloads of remotely-provided extensions
@@ -57,9 +57,10 @@ class CRM_Extension_Downloader {
   }
 
   /**
-   * Determine whether downloading is supported
+   * Determine whether downloading is supported.
    *
-   * @return array list of error messages; empty if OK
+   * @return array
+   *   list of error messages; empty if OK
    */
   public function checkRequirements() {
     $errors = array();
@@ -75,7 +76,7 @@ class CRM_Extension_Downloader {
             //1 => $this->containerDir,
             1 => $url,
           )
-        )
+        ),
       );
     }
 
@@ -86,7 +87,7 @@ class CRM_Extension_Downloader {
       );
     }
 
-    if (empty($errors) && ! CRM_Utils_HttpClient::singleton()->isRedirectSupported()) {
+    if (empty($errors) && !CRM_Utils_HttpClient::singleton()->isRedirectSupported()) {
       CRM_Core_Session::setStatus(ts('WARNING: The downloader may be unable to download files which require HTTP redirection. This may be a configuration issue with PHP\'s open_basedir or safe_mode.'));
       CRM_Core_Error::debug_log_message('WARNING: The downloader may be unable to download files which require HTTP redirection. This may be a configuration issue with PHP\'s open_basedir or safe_mode.');
     }
@@ -95,13 +96,14 @@ class CRM_Extension_Downloader {
   }
 
   /**
-   * Install or upgrade an extension from a remote URL
+   * Install or upgrade an extension from a remote URL.
    *
    * @param string $key
    *   The name of the extension being installed.
    * @param string $downloadUrl
    *   URL of a .zip file.
-   * @return bool TRUE for success
+   * @return bool
+   *   TRUE for success
    * @throws CRM_Extension_Exception
    */
   public function download($key, $downloadUrl) {
@@ -112,16 +114,16 @@ class CRM_Extension_Downloader {
       CRM_Core_Error::fatal('Cannot install this extension - downloadUrl is not set!');
     }
 
-    if (! $this->fetch($downloadUrl, $filename)) {
+    if (!$this->fetch($downloadUrl, $filename)) {
       return FALSE;
     }
 
     $extractedZipPath = $this->extractFiles($key, $filename);
-    if (! $extractedZipPath) {
+    if (!$extractedZipPath) {
       return FALSE;
     }
 
-    if (! $this->validateFiles($key, $extractedZipPath)) {
+    if (!$this->validateFiles($key, $extractedZipPath)) {
       return FALSE;
     }
 
@@ -137,7 +139,8 @@ class CRM_Extension_Downloader {
    *   URL of a .zip file.
    * @param string $localFile
    *   Path at which to store the .zip file.
-   * @return boolean Whether the download was successful.
+   * @return bool
+   *   Whether the download was successful.
    */
   public function fetch($remoteFile, $localFile) {
     $result = CRM_Utils_HttpClient::singleton()->fetch($remoteFile, $localFile);
@@ -151,13 +154,14 @@ class CRM_Extension_Downloader {
   }
 
   /**
-   * Extract an extension from a zip file
+   * Extract an extension from a zip file.
    *
    * @param string $key
    *   The name of the extension being installed; this usually matches the basedir in the .zip.
    * @param string $zipFile
    *   The local path to a .zip file.
-   * @return string|FALSE zip file path
+   * @return string|FALSE
+   *   zip file path
    */
   public function extractFiles($key, $zipFile) {
     $config = CRM_Core_Config::singleton();