X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FCountry.php;h=647e8aa717001420c88b1da288b225f9b9923cbd;hb=79d7553f54ee92645478d09cf794a539ebb15856;hp=f1954810bb9a921b20684a7bf7df10abf3794508;hpb=192e8d1a947814993aa699e47ac1669ac17b1045;p=civicrm-core.git diff --git a/api/v3/Country.php b/api/v3/Country.php index f1954810bb..647e8aa717 100644 --- a/api/v3/Country.php +++ b/api/v3/Country.php @@ -3,9 +3,9 @@ /* +--------------------------------------------------------------------+ - | CiviCRM version 4.3 | + | CiviCRM version 4.6 | +--------------------------------------------------------------------+ - | Copyright CiviCRM LLC (c) 2004-2013 | + | Copyright CiviCRM LLC (c) 2004-2014 | +--------------------------------------------------------------------+ | This file is a part of CiviCRM. | | | @@ -33,7 +33,7 @@ * @package CiviCRM_APIv3 * @subpackage API_Country * - * @copyright CiviCRM LLC (c) 2004-2013 + * @copyright CiviCRM LLC (c) 2004-2014 * @version $Id: Country.php 2011-02-16 ErikHommel $ */ @@ -46,9 +46,10 @@ require_once 'CRM/Core/DAO/Country.php'; * * @example CountryCreate.php Standard Create Example * - * @return array API result array - * {@getfields country_create} - * @access public + * @param array $params + * @return array + * API result array + * @throws \API_Exception */ function civicrm_api3_country_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_DAO(__FUNCTION__), $params); @@ -56,9 +57,10 @@ function civicrm_api3_country_create($params) { /** * Adjust Metadata for Create action - * + * * The metadata is used for setting defaults, documentation & validation - * @param array $params array or parameters determined by getfields + * @param array $params + * Array or parameters determined by getfields. */ function _civicrm_api3_country_create_spec(&$params) { $params['name']['api.required'] = 1; @@ -67,13 +69,13 @@ function _civicrm_api3_country_create_spec(&$params) { /** * Deletes an existing Country * - * @param array $params + * @param array $params * * @example CountryDelete.php Standard Delete Example * - * @return boolean | error true if successfull, error otherwise - * {@getfields country_delete} - * @access public + * @return bool + * | error true if successfull, error otherwise + * {@getfields country_delete} */ function civicrm_api3_country_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params); @@ -82,19 +84,16 @@ function civicrm_api3_country_delete($params) { /** * Retrieve one or more countrys * - * @param array input parameters - * - * * @example CountryGet.php Standard Get Example * - * @param array $params an associative array of name/value pairs. + * @param array $params + * An associative array of name/value pairs. * - * @return array api result array - * {@getfields country_get} - * @access public + * @return array + * api result array + * {@getfields country_get} */ function civicrm_api3_country_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_DAO(__FUNCTION__), $params); } -