Api docblock cleanup.

[civicrm-core.git] / api / v3 / Domain.php

diff --git a/api/v3/Domain.php b/api/v3/Domain.php
index 2888fa9981c018769ccf9911d86dcc11a9986e1d..baa367524ae41e35ee37731bfa6d241b9d600234 100644 (file)
--- a/api/v3/Domain.php
+++ b/api/v3/Domain.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -27,20 +26,18 @@
  */
 
 /**
- * File for the CiviCRM APIv3 domain functions
+ * This api exposes CiviCRM domain.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Domain
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $
- *
  */
 
 /**
- * Get CiviCRM domain details
- * {@getfields domain_create}
- * @example DomainGet.php
+ * Get CiviCRM domain details.
+ *
+ * @param array $params
+ *
+ * @return array
+ * @throws \API_Exception
  */
 function civicrm_api3_domain_get($params) {
 
@@ -56,14 +53,14 @@ function civicrm_api3_domain_get($params) {
     return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
   }
 
-  _civicrm_api3_dao_set_filter($bao, $params, true, 'domain');
-  $domains = _civicrm_api3_dao_to_array($bao, $params, true,'domain');
+  _civicrm_api3_dao_set_filter($bao, $params, TRUE, 'domain');
+  $domains = _civicrm_api3_dao_to_array($bao, $params, TRUE, 'domain');
 
   foreach ($domains as $domain) {
-    if(!empty($domain['contact_id'])){
+    if (!empty($domain['contact_id'])) {
       $values = array();
       $locparams = array(
-        'contact_id' => $domain['contact_id']
+        'contact_id' => $domain['contact_id'],
       );
       $values['location'] = CRM_Core_BAO_Location::getValues($locparams, TRUE);
 
@@ -73,33 +70,33 @@ function civicrm_api3_domain_get($params) {
         'geo_code_1', 'geo_code_2',
       );
 
-      if ( !empty( $values['location']['email'] ) ) {
+      if (!empty($values['location']['email'])) {
         $domain['domain_email'] = CRM_Utils_Array::value('email', $values['location']['email'][1]);
       }
 
-      if ( !empty( $values['location']['phone'] ) ) {
+      if (!empty($values['location']['phone'])) {
         $domain['domain_phone'] = array(
           'phone_type' => CRM_Core_OptionGroup::getLabel(
           'phone_type',
           CRM_Utils_Array::value(
             'phone_type_id',
           $values['location']['phone'][1]
-        )
-      ),
-        'phone' => CRM_Utils_Array::value(
+          )
+          ),
+          'phone' => CRM_Utils_Array::value(
           'phone',
-        $values['location']['phone'][1]
-        )
-    );
-    }
+          $values['location']['phone'][1]
+          ),
+        );
+      }
 
-    if ( !empty( $values['location']['address'] ) ) {
-      foreach ($address_array as $value) {
-        $domain['domain_address'][$value] = CRM_Utils_Array::value($value,
+      if (!empty($values['location']['address'])) {
+        foreach ($address_array as $value) {
+          $domain['domain_address'][$value] = CRM_Utils_Array::value($value,
           $values['location']['address'][1]
-        );
+          );
+        }
       }
-    }
 
       list($domain['from_name'],
         $domain['from_email']
@@ -108,28 +105,27 @@ function civicrm_api3_domain_get($params) {
     }
   }
 
-
   return civicrm_api3_create_success($domains, $params, 'domain', 'get', $bao);
 }
 
 /**
- * Adjust Metadata for Get action
+ * Adjust Metadata for Get action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_domain_get_spec(&$params) {
   $params['current_domain'] = array('title' => "get loaded domain");
 }
 
 /**
- * Create a new domain
+ * Create a new domain.
  *
  * @param array $params
  *
  * @return array
- * @example DomainCreate.php
- * {@getfields domain_create}
  */
 function civicrm_api3_domain_create($params) {
   $params['version'] = $params['domain_version'];
@@ -137,10 +133,12 @@ function civicrm_api3_domain_create($params) {
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_domain_create_spec(&$params) {
   $params['domain_version'] = $params['version'];
@@ -148,4 +146,3 @@ function _civicrm_api3_domain_create_spec(&$params) {
   unset($params['version']);
   $params['name']['api.required'] = 1;
 }
-