formatting fixes

[civicrm-core.git] / api / class.api.php

diff --git a/api/class.api.php b/api/class.api.php
index 93dda31ec1b2c266dfa9dd3a47616d6652d09de1..7a5f72cdec04c95a304e4a94ea056d892d2cf0ee 100644 (file)
--- a/api/class.api.php
+++ b/api/class.api.php
@@ -79,9 +79,11 @@
 class civicrm_api3 {
 
   /**
-   * @param array API configuration.
+   * Class constructor.
+   *
+   * @param array $config API configuration.
    */
-  function __construct($config = NULL) {
+  public function __construct($config = NULL) {
     $this->local      = TRUE;
     $this->input      = array();
     $this->lastResult = array();
@@ -126,14 +128,21 @@ class civicrm_api3 {
   }
 
   /**
+   * Convert to string.
    *
+   * @return string
    */
   public function __toString() {
     return json_encode($this->lastResult);
   }
 
   /**
+   * Perform action.
+   *
+   * @param $action
+   * @param $params
    *
+   * @return bool
    */
   public function __call($action, $params) {
     // @TODO Check if it's a valid action.
@@ -146,7 +155,10 @@ class civicrm_api3 {
   }
 
   /**
-   *  As of PHP 5.3.0
+   * As of PHP 5.3.0.
+   *
+   * @param $name
+   * @param $arguments
    */
   public static function __callStatic($name, $arguments) {
     // Should we implement it ?
@@ -154,9 +166,15 @@ class civicrm_api3 {
   }
 
   /**
+   * Call via rest.
    *
+   * @param $entity
+   * @param $action
+   * @param array $params
+   *
+   * @return \stdClass
    */
-  function remoteCall($entity, $action, $params = array()) {
+  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) {
@@ -173,7 +191,7 @@ class civicrm_api3 {
       $result = curl_exec($ch);
       // CiviCRM expects to get back a CiviCRM error object.
       if (curl_errno($ch)) {
-        $res = new stdClass;
+        $res = new stdClass();
         $res->is_error = 1;
         $res->error_message = curl_error($ch);
         $res->level = "cURL";
@@ -188,7 +206,7 @@ class civicrm_api3 {
       $result = file_get_contents($query . '&' . $fields);
     }
     if (!$res = json_decode($result)) {
-      $res = new stdClass;
+      $res = new stdClass();
       $res->is_error = 1;
       $res->error_message = 'Unable to parse returned JSON';
       $res->level = 'json_decode';
@@ -199,13 +217,15 @@ class civicrm_api3 {
   }
 
   /**
+   * Call api function.
+   *
    * @param $entity
    * @param string $action
    * @param array $params
    *
    * @return bool
    */
-  function call($entity, $action = 'Get', $params = array()) {
+  public function call($entity, $action = 'Get', $params = array()) {
     if (is_int($params)) {
       $params = array('id' => $params);
     }
@@ -239,7 +259,7 @@ class civicrm_api3 {
   /**
    * Helper method for long running programs (eg bots).
    */
-  function ping() {
+  public function ping() {
     global $_DB_DATAOBJECT;
     foreach ($_DB_DATAOBJECT['CONNECTIONS'] as & $c) {
       if (!$c->connection->ping()) {
@@ -253,20 +273,26 @@ class civicrm_api3 {
 
   /**
    * Return the last error message.
+   * @return string
    */
-  function errorMsg() {
+  public function errorMsg() {
     return $this->lastResult->error_message;
   }
 
   /**
-   *
+   * Initialize.
    */
-  function init() {
+  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) {
     if ($value === NULL) {
@@ -281,21 +307,31 @@ class civicrm_api3 {
   }
 
   /**
+   * Is this an error.
    *
+   * @return bool
    */
   public function is_error() {
     return (property_exists($this->lastResult, 'is_error') && $this->lastResult->is_error);
   }
 
   /**
+   * Check if var is set.
+   *
+   * @param string $name
    *
+   * @return bool
    */
   public function is_set($name) {
     return (isset($this->lastResult->$name));
   }
 
   /**
+   * Get object.
+   *
+   * @param string $name
    *
+   * @return $this
    */
   public function __get($name) {
     // @TODO Test if valid entity.
@@ -320,6 +356,7 @@ class civicrm_api3 {
 
   /**
    * Or use $api->value.
+   * @return array
    */
   public function values() {
     if (is_array($this->lastResult)) {
@@ -332,8 +369,10 @@ class civicrm_api3 {
 
   /**
    * Or use $api->result.
+   * @return array
    */
   public function result() {
     return $this->lastResult;
   }
+
 }