Merge pull request #6710 from systopia/CRM-17186
[civicrm-core.git] / api / class.api.php
index 2b378bc5074d7c62adfa9a75ed84ecc8b96952ff..177da3eaff8cbbbf8dccc2e1ee453df6d1699bc4 100644 (file)
@@ -79,6 +79,8 @@
 class civicrm_api3 {
 
   /**
+   * Class constructor.
+   *
    * @param array $config API configuration.
    */
   public function __construct($config = NULL) {
@@ -126,6 +128,8 @@ class civicrm_api3 {
   }
 
   /**
+   * Convert to string.
+   *
    * @return string
    */
   public function __toString() {
@@ -133,9 +137,11 @@ class civicrm_api3 {
   }
 
   /**
-   * Perform action
+   * Perform action.
+   *
    * @param $action
    * @param $params
+   *
    * @return bool
    */
   public function __call($action, $params) {
@@ -149,7 +155,8 @@ class civicrm_api3 {
   }
 
   /**
-   *  As of PHP 5.3.0
+   * As of PHP 5.3.0.
+   *
    * @param $name
    * @param $arguments
    */
@@ -159,18 +166,18 @@ class civicrm_api3 {
   }
 
   /**
-   * Call via rest
+   * Call via rest.
+   *
    * @param $entity
    * @param $action
    * @param array $params
+   *
    * @return \stdClass
    */
   public function remoteCall($entity, $action, $params = array()) {
     $fields = "key={$this->key}&api_key={$this->api_key}";
     $query = $this->uri . "&entity=$entity&action=$action";
-    foreach ($params as $k => $v) {
-      $fields .= "&$k=" . urlencode($v);
-    }
+    $fields .= '&' . http_build_query($params);
     if (function_exists('curl_init')) {
       // To facilitate debugging without leaking info, entity & action
       // are GET, other data is POST.
@@ -208,6 +215,8 @@ class civicrm_api3 {
   }
 
   /**
+   * Call api function.
+   *
    * @param $entity
    * @param string $action
    * @param array $params
@@ -269,15 +278,18 @@ class civicrm_api3 {
   }
 
   /**
-   * Initialize
+   * Initialize.
    */
   public function init() {
     CRM_Core_DAO::init($this->cfg->dsn);
   }
 
   /**
+   * Get attribute.
+   *
    * @param $name
    * @param null $value
+   *
    * @return $this
    */
   public function attr($name, $value = NULL) {
@@ -293,6 +305,8 @@ class civicrm_api3 {
   }
 
   /**
+   * Is this an error.
+   *
    * @return bool
    */
   public function is_error() {
@@ -300,7 +314,10 @@ class civicrm_api3 {
   }
 
   /**
+   * Check if var is set.
+   *
    * @param string $name
+   *
    * @return bool
    */
   public function is_set($name) {
@@ -308,7 +325,10 @@ class civicrm_api3 {
   }
 
   /**
-   * @param $name
+   * Get object.
+   *
+   * @param string $name
+   *
    * @return $this
    */
   public function __get($name) {
@@ -352,4 +372,5 @@ class civicrm_api3 {
   public function result() {
     return $this->lastResult;
   }
+
 }