projects
/
civicrm-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
More comment fixes
[civicrm-core.git]
/
api
/
v3
/
Country.php
diff --git
a/api/v3/Country.php
b/api/v3/Country.php
index ec6c40f22c89cf0b21a7eb2a524bbe157fbae3c1..5683691ebf73e50eddaa7129fbe75bab38ebf2c1 100644
(file)
--- a/
api/v3/Country.php
+++ b/
api/v3/Country.php
@@
-25,7
+25,7
@@
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+
*/
/**
* File for the CiviCRM APIv3 country functions
/**
* File for the CiviCRM APIv3 country functions
@@
-37,64
+37,53
@@
* @version $Id: Country.php 2011-02-16 ErikHommel $
*/
* @version $Id: Country.php 2011-02-16 ErikHommel $
*/
-require_once 'CRM/Core/DAO/Country.php';
-
/**
/**
- * Add an Country for a contact
- *
- * Allowed @params array keys are:
+ * Add an Country for a contact.
*
*
- * @example CountryCreate.php Standard Create Example
+ * @param array $params
+ * Array per getfields metadata.
*
*
- * @return array
API result array
- *
{@getfields country_create}
- * @
access public
+ * @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);
}
/**
*/
function civicrm_api3_country_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_DAO(__FUNCTION__), $params);
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action
.
*
*
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * The metadata is used for setting defaults, documentation & validation.
+ *
+ * @param array $params
+ * Array or parameters determined by getfields.
*/
function _civicrm_api3_country_create_spec(&$params) {
$params['name']['api.required'] = 1;
}
/**
*/
function _civicrm_api3_country_create_spec(&$params) {
$params['name']['api.required'] = 1;
}
/**
- * Deletes an existing Country
- *
- * @param array $params
+ * Deletes an existing Country.
*
*
- * @
example CountryDelete.php Standard Delete Example
+ * @
param array $params
*
*
- * @return boolean | error true if successfull, error otherwise
- * {@getfields country_delete}
- * @access public
+ * @return array
*/
function civicrm_api3_country_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params);
}
/**
*/
function civicrm_api3_country_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params);
}
/**
- * Retrieve one or more country
s
+ * Retrieve one or more country
ies.
*
*
- * @param array input parameters
+ * @param array $params
+ * Array per getfields metadata.
*
*
- *
- * @example CountryGet.php Standard Get Example
- *
- * @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
*/
function civicrm_api3_country_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_DAO(__FUNCTION__), $params);
}
*/
function civicrm_api3_country_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_DAO(__FUNCTION__), $params);
}
-