X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FDomain.php;h=baa367524ae41e35ee37731bfa6d241b9d600234;hb=00cb6250d344a4de5ecd69c2253785a0767c4b38;hp=e06da4281125f6164e5d0d9cf367c7915af5e38c;hpb=266a559f66f8242321969f8181b9c0f8c1ef5799;p=civicrm-core.git diff --git a/api/v3/Domain.php b/api/v3/Domain.php index e06da42811..baa367524a 100644 --- a/api/v3/Domain.php +++ b/api/v3/Domain.php @@ -26,21 +26,16 @@ */ /** - * 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 */ @@ -86,11 +81,11 @@ function civicrm_api3_domain_get($params) { CRM_Utils_Array::value( 'phone_type_id', $values['location']['phone'][1] - ) + ) ), 'phone' => CRM_Utils_Array::value( 'phone', - $values['location']['phone'][1] + $values['location']['phone'][1] ), ); } @@ -114,24 +109,23 @@ function civicrm_api3_domain_get($params) { } /** - * 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"); } /** - * 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']; @@ -139,11 +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. + * Array of parameters determined by getfields. */ function _civicrm_api3_domain_create_spec(&$params) { $params['domain_version'] = $params['version'];