Commit | Line | Data |
---|---|---|
ee93cc38 | 1 | <?php |
ee93cc38 JJ |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
ee93cc38 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
ee93cc38 JJ |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
ee93cc38 JJ |
27 | |
28 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM country. |
ee93cc38 JJ |
30 | * |
31 | * @package CiviCRM_APIv3 | |
ee93cc38 JJ |
32 | */ |
33 | ||
ee93cc38 | 34 | /** |
2e66abf8 | 35 | * Add an Country for a contact. |
ee93cc38 | 36 | * |
d0997921 | 37 | * @param array $params |
2e66abf8 EM |
38 | * Array per getfields metadata. |
39 | * | |
df76b023 EM |
40 | * @return array |
41 | * API result array | |
d0997921 | 42 | * @throws \API_Exception |
ee93cc38 JJ |
43 | */ |
44 | function civicrm_api3_country_create($params) { | |
45 | return _civicrm_api3_basic_create(_civicrm_api3_get_DAO(__FUNCTION__), $params); | |
46 | } | |
47 | ||
48 | /** | |
0aa0303c EM |
49 | * Adjust Metadata for Create action. |
50 | * | |
51 | * The metadata is used for setting defaults, documentation & validation. | |
ebf2b57b | 52 | * |
cf470720 | 53 | * @param array $params |
b081365f | 54 | * Array of parameters determined by getfields. |
ee93cc38 JJ |
55 | */ |
56 | function _civicrm_api3_country_create_spec(&$params) { | |
78abe068 | 57 | $params['name']['api.required'] = 1; |
ee93cc38 JJ |
58 | } |
59 | ||
60 | /** | |
2e66abf8 | 61 | * Deletes an existing Country. |
ee93cc38 | 62 | * |
cf470720 | 63 | * @param array $params |
ee93cc38 | 64 | * |
2e66abf8 | 65 | * @return array |
ee93cc38 JJ |
66 | */ |
67 | function civicrm_api3_country_delete($params) { | |
68 | return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params); | |
69 | } | |
70 | ||
71 | /** | |
2e66abf8 | 72 | * Retrieve one or more countryies. |
ee93cc38 | 73 | * |
cf470720 | 74 | * @param array $params |
2e66abf8 | 75 | * Array per getfields metadata. |
ee93cc38 | 76 | * |
a6c01b45 | 77 | * @return array |
72b3a70c | 78 | * api result array |
ee93cc38 JJ |
79 | */ |
80 | function civicrm_api3_country_get($params) { | |
81 | ||
82 | return _civicrm_api3_basic_get(_civicrm_api3_get_DAO(__FUNCTION__), $params); | |
83 | } |