Comment fixes for CRM/Utils directory

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

diff --git a/CRM/Utils/HttpClient.php b/CRM/Utils/HttpClient.php
index 59c56eb8101879d43d29814f91fba03f26d7af03..92aed3c84245229ca9a89dd75d5f6ca20357b3eb 100644 (file)
--- a/CRM/Utils/HttpClient.php
+++ b/CRM/Utils/HttpClient.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -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 HTTP downloads
@@ -34,9 +34,7 @@
  * want to deal with that so late in the 4.3 dev cycle.
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
+ * @copyright CiviCRM LLC (c) 2004-2015
  */
 class CRM_Utils_HttpClient {
 
@@ -50,7 +48,8 @@ class CRM_Utils_HttpClient {
   protected static $singleton;
 
   /**
-   * @var int|NULL seconds; or NULL to use system default
+   * @var int|NULL
+   *   seconds; or NULL to use system default
    */
   protected $connectionTimeout;
 
@@ -114,11 +113,12 @@ class CRM_Utils_HttpClient {
   }
 
   /**
-   * Send an HTTP GET for a remote resource
+   * Send an HTTP GET for a remote resource.
    *
    * @param string $remoteFile
    *   URL of remote file.
-   * @return array array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string)
+   * @return array
+   *   array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string)
    */
   public function get($remoteFile) {
     // Download extension zip file ...
@@ -134,7 +134,7 @@ class CRM_Utils_HttpClient {
     list($ch, $caConfig) = $this->createCurl($remoteFile);
 
     if (preg_match('/^https:/', $remoteFile) && !$caConfig->isEnableSSL()) {
-      //CRM_Core_Error::fatal('Cannot install this extension - does not support SSL');
+      // CRM_Core_Error::fatal('Cannot install this extension - does not support SSL');
       return array(self::STATUS_DL_ERROR, NULL);
     }
 
@@ -151,13 +151,14 @@ class CRM_Utils_HttpClient {
   }
 
   /**
-   * Send an HTTP POST for a remote resource
+   * Send an HTTP POST for a remote resource.
    *
    * @param string $remoteFile
    *   URL of a .zip file.
    * @param array $params
    *
-   * @return array array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string)
+   * @return array
+   *   array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string)
    */
   public function post($remoteFile, $params) {
     // Download extension zip file ...
@@ -169,7 +170,7 @@ class CRM_Utils_HttpClient {
     list($ch, $caConfig) = $this->createCurl($remoteFile);
 
     if (preg_match('/^https:/', $remoteFile) && !$caConfig->isEnableSSL()) {
-      //CRM_Core_Error::fatal('Cannot install this extension - does not support SSL');
+      // CRM_Core_Error::fatal('Cannot install this extension - does not support SSL');
       return array(self::STATUS_DL_ERROR, NULL);
     }
 
@@ -190,12 +191,12 @@ class CRM_Utils_HttpClient {
 
   /**
    * @param string $remoteFile
-   * @return array (0 => resource, 1 => CA_Config_Curl)
+   * @return array
+   *   (0 => resource, 1 => CA_Config_Curl)
    */
   protected function createCurl($remoteFile) {
-    require_once 'CA/Config/Curl.php';
     $caConfig = CA_Config_Curl::probe(array(
-      'verify_peer' => (bool) CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'verifySSL', NULL, TRUE),
+      'verify_peer' => (bool) CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'verifySSL'),
     ));
 
     $ch = curl_init();