projects
/
civicrm-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Checkstyle fix - one pesky whitespace
[civicrm-core.git]
/
api
/
v3
/
Country.php
diff --git
a/api/v3/Country.php
b/api/v3/Country.php
index d8edab351a796c8820fe5b1ce88aca25d3a9baac..93b3ab870fd031df081190a58955b316423cd572 100644
(file)
--- a/
api/v3/Country.php
+++ b/
api/v3/Country.php
@@
-1,11
+1,9
@@
<?php
<?php
-// $Id$
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-201
4
|
+ | Copyright CiviCRM LLC (c) 2004-201
5
|
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
@@
-28,25
+26,17
@@
*/
/**
*/
/**
- *
File for the CiviCRM APIv3 country functions
+ *
This api exposes CiviCRM country.
*
* @package CiviCRM_APIv3
*
* @package CiviCRM_APIv3
- * @subpackage API_Country
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @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:
- *
- * @example CountryCreate.php Standard Create Example
+ * Add an Country for a contact.
*
* @param array $params
*
* @param array $params
+ * Array per getfields metadata.
+ *
* @return array
* API result array
* @throws \API_Exception
* @return array
* API result array
* @throws \API_Exception
@@
-56,42
+46,36
@@
function civicrm_api3_country_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
* @param array $params
- * Array o
r
parameters determined by getfields.
+ * Array o
f
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
+ * Deletes an existing Country
.
*
* @param array $params
*
*
* @param array $params
*
- * @example CountryDelete.php Standard Delete Example
- *
- * @return bool
- * | error true if successfull, error otherwise
- * {@getfields country_delete}
+ * @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 countrys
- *
- * @example CountryGet.php Standard Get Example
+ * Retrieve one or more countryies.
*
* @param array $params
*
* @param array $params
- * A
n associative array of name/value pairs
.
+ * A
rray per getfields metadata
.
*
* @return array
* api result array
*
* @return array
* api result array
- * {@getfields country_get}
*/
function civicrm_api3_country_get($params) {
*/
function civicrm_api3_country_get($params) {