Merge pull request #5479 from eileenmcnaughton/4.6
[civicrm-core.git] / CRM / Extension / Downloader.php
index d3f6322bb1d72ed9f7042ac92a0c79b727545d06..dfb36abcad6a5cd723541836460524e445006c48 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        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * This class handles downloads of remotely-provided extensions
@@ -57,7 +57,7 @@ class CRM_Extension_Downloader {
   }
 
   /**
-   * Determine whether downloading is supported
+   * Determine whether downloading is supported.
    *
    * @return array
    *   list of error messages; empty if OK
@@ -87,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.');
     }
@@ -96,7 +96,7 @@ 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.
@@ -114,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;
     }
 
@@ -139,7 +139,7 @@ class CRM_Extension_Downloader {
    *   URL of a .zip file.
    * @param string $localFile
    *   Path at which to store the .zip file.
-   * @return boolean
+   * @return bool
    *   Whether the download was successful.
    */
   public function fetch($remoteFile, $localFile) {
@@ -154,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();