X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FDomain.php;h=6c38c1073106291d5d8b7bd550364e20ea5f3cee;hb=b013dfbf9cee859c0a9d2ca34d854f6b10eca086;hp=dea29583509e036456d210dcb4767c3ae7ed0183;hpb=7d86179d7d8e91160bbb5e6643fa265198a99a2d;p=civicrm-core.git

diff --git a/api/v3/Domain.php b/api/v3/Domain.php
index dea2958350..6c38c10731 100644
--- a/api/v3/Domain.php
+++ b/api/v3/Domain.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -27,20 +26,18 @@
  */
 
 /**
- * File for the CiviCRM APIv3 domain functions
+ * This api exposes CiviCRM Domain configuration settings.
  *
  * @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,8 +53,8 @@ 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);
+  $domains = _civicrm_api3_dao_to_array($bao, $params, TRUE, 'Domain');
 
   foreach ($domains as $domain) {
     if (!empty($domain['contact_id'])) {
@@ -84,12 +81,12 @@ function civicrm_api3_domain_get($params) {
           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]
+          ),
         );
       }
 
@@ -108,28 +105,30 @@ function civicrm_api3_domain_get($params) {
     }
   }
 
-  return civicrm_api3_create_success($domains, $params, 'domain', 'get', $bao);
+  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.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_domain_get_spec(&$params) {
-  $params['current_domain'] = array('title' => "get loaded domain");
+  $params['current_domain'] = array(
+    'title' => "Current Domain",
+    'description' => "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,11 +136,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.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_domain_create_spec(&$params) {
   $params['domain_version'] = $params['version'];