/*
+--------------------------------------------------------------------+
- | 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. |
| |
* @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 $
*/
*
* @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);
* 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;
/**
* Deletes an existing Country
*
- * @param array $params
+ * @param array $params
*
* @example CountryDelete.php Standard Delete Example
*
- * @return boolean | error true if successfull, error otherwise
+ * @return boolean
+ * | error true if successfull, error otherwise
* {@getfields country_delete}
- * @access public
*/
function civicrm_api3_country_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params);
/**
* Retrieve one or more countrys
*
- * @param array input parameters
+ * @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
+ * @return array
+ * api result array
* {@getfields country_get}
- * @access public
*/
function civicrm_api3_country_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_DAO(__FUNCTION__), $params);
}
-