5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.6 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2014 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
12 | CiviCRM is free software; you can copy, modify, and distribute it |
13 | under the terms of the GNU Affero General Public License |
14 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
16 | CiviCRM is distributed in the hope that it will be useful, but |
17 | WITHOUT ANY WARRANTY; without even the implied warranty of |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
19 | See the GNU Affero General Public License for more details. |
21 | You should have received a copy of the GNU Affero General Public |
22 | License and the CiviCRM Licensing Exception along |
23 | with this program; if not, contact CiviCRM LLC |
24 | at info[AT]civicrm[DOT]org. If you have questions about the |
25 | GNU Affero General Public License or the licensing of CiviCRM, |
26 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
27 +--------------------------------------------------------------------+
31 * File for the CiviCRM APIv3 country functions
33 * @package CiviCRM_APIv3
34 * @subpackage API_Country
36 * @copyright CiviCRM LLC (c) 2004-2014
37 * @version $Id: Country.php 2011-02-16 ErikHommel $
40 require_once 'CRM/Core/DAO/Country.php';
43 * Add an Country for a contact
45 * Allowed @params array keys are:
47 * @example CountryCreate.php Standard Create Example
49 * @param array $params
52 * @throws \API_Exception
54 function civicrm_api3_country_create($params) {
55 return _civicrm_api3_basic_create(_civicrm_api3_get_DAO(__FUNCTION__
), $params);
59 * Adjust Metadata for Create action
61 * The metadata is used for setting defaults, documentation & validation
62 * @param array $params
63 * Array or parameters determined by getfields.
65 function _civicrm_api3_country_create_spec(&$params) {
66 $params['name']['api.required'] = 1;
70 * Deletes an existing Country
72 * @param array $params
74 * @example CountryDelete.php Standard Delete Example
77 * | error true if successfull, error otherwise
78 * {@getfields country_delete}
80 function civicrm_api3_country_delete($params) {
81 return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__
), $params);
85 * Retrieve one or more countrys
87 * @param array input parameters
90 * @example CountryGet.php Standard Get Example
92 * @param array $params
93 * An associative array of name/value pairs.
97 * {@getfields country_get}
99 function civicrm_api3_country_get($params) {
101 return _civicrm_api3_basic_get(_civicrm_api3_get_DAO(__FUNCTION__
), $params);