*/
/**
- * 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
*/
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'])) {
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]
+ ),
);
}
}
}
- 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'];
}
/**
- * 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'];