X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fclass.api.php;h=7a5f72cdec04c95a304e4a94ea056d892d2cf0ee;hb=4c12c9b771bde931077f56685b632bd34504b238;hp=c2ae50b8c73dca3c0baa14ed481581a0caccf787;hpb=96025800fa500fbbd71288fa1b0bc459f17c5bcc;p=civicrm-core.git diff --git a/api/class.api.php b/api/class.api.php index c2ae50b8c7..7a5f72cdec 100644 --- a/api/class.api.php +++ b/api/class.api.php @@ -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,10 +166,12 @@ 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()) { @@ -208,6 +217,8 @@ class civicrm_api3 { } /** + * Call api function. + * * @param $entity * @param string $action * @param array $params @@ -269,15 +280,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 +307,8 @@ class civicrm_api3 { } /** + * Is this an error. + * * @return bool */ public function is_error() { @@ -300,7 +316,10 @@ class civicrm_api3 { } /** + * Check if var is set. + * * @param string $name + * * @return bool */ public function is_set($name) { @@ -308,7 +327,10 @@ class civicrm_api3 { } /** - * @param $name + * Get object. + * + * @param string $name + * * @return $this */ public function __get($name) {