more tidy ups

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

diff --git a/api/class.api.php b/api/class.api.php
index 04032c876961affcc1babd7799c62ff94551bb0a..f2350ccba0da87a0ba0643970356f389c40fdc12 100644 (file)
--- a/api/class.api.php
+++ b/api/class.api.php
@@ -79,7 +79,7 @@
 class civicrm_api3 {
 
   /**
-   * @param array API configuration.
+   * @param array $config API configuration.
    */
   function __construct($config = NULL) {
     $this->local      = TRUE;
@@ -126,14 +126,17 @@ class civicrm_api3 {
   }
 
   /**
-   *
+   * @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.
@@ -147,6 +150,8 @@ class civicrm_api3 {
 
   /**
    *  As of PHP 5.3.0
+   * @param $name
+   * @param $arguments
    */
   public static function __callStatic($name, $arguments) {
     // Should we implement it ?
@@ -154,7 +159,11 @@ class civicrm_api3 {
   }
 
   /**
-   *
+   * Call via rest
+   * @param $entity
+   * @param $action
+   * @param array $params
+   * @return \stdClass
    */
   function remoteCall($entity, $action, $params = array()) {
     $fields = "key={$this->key}&api_key={$this->api_key}";
@@ -198,6 +207,13 @@ class civicrm_api3 {
     return $res;
   }
 
+  /**
+   * @param $entity
+   * @param string $action
+   * @param array $params
+   *
+   * @return bool
+   */
   function call($entity, $action = 'Get', $params = array()) {
     if (is_int($params)) {
       $params = array('id' => $params);
@@ -246,20 +262,23 @@ class civicrm_api3 {
 
   /**
    * Return the last error message.
+   * @return string
    */
   function errorMsg() {
     return $this->lastResult->error_message;
   }
 
   /**
-   *
+   * Initialize
    */
   function init() {
     CRM_Core_DAO::init($this->cfg->dsn);
   }
 
   /**
-   *
+   * @param $name
+   * @param null $value
+   * @return $this
    */
   public function attr($name, $value = NULL) {
     if ($value === NULL) {
@@ -274,21 +293,23 @@ class civicrm_api3 {
   }
 
   /**
-   *
+   * @return bool
    */
   public function is_error() {
     return (property_exists($this->lastResult, 'is_error') && $this->lastResult->is_error);
   }
 
   /**
-   *
+   * @param string $name
+   * @return bool
    */
   public function is_set($name) {
     return (isset($this->lastResult->$name));
   }
 
   /**
-   *
+   * @param $name
+   * @return $this
    */
   public function __get($name) {
     // @TODO Test if valid entity.
@@ -313,6 +334,7 @@ class civicrm_api3 {
 
   /**
    * Or use $api->value.
+   * @return array
    */
   public function values() {
     if (is_array($this->lastResult)) {
@@ -325,6 +347,7 @@ class civicrm_api3 {
 
   /**
    * Or use $api->result.
+   * @return array
    */
   public function result() {
     return $this->lastResult;