Commit | Line | Data |
---|---|---|
ee93cc38 JJ |
1 | <?php |
2 | // $Id$ | |
3 | ||
4 | /* | |
5 | +--------------------------------------------------------------------+ | |
39de6fd5 | 6 | | CiviCRM version 4.6 | |
ee93cc38 | 7 | +--------------------------------------------------------------------+ |
39de6fd5 | 8 | | Copyright CiviCRM LLC (c) 2004-2014 | |
ee93cc38 JJ |
9 | +--------------------------------------------------------------------+ |
10 | | This file is a part of CiviCRM. | | |
11 | | | | |
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. | | |
15 | | | | |
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. | | |
20 | | | | |
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 | +--------------------------------------------------------------------+ | |
28 | */ | |
29 | ||
30 | /** | |
31 | * File for the CiviCRM APIv3 country functions | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | * @subpackage API_Country | |
35 | * | |
39de6fd5 | 36 | * @copyright CiviCRM LLC (c) 2004-2014 |
ee93cc38 JJ |
37 | * @version $Id: Country.php 2011-02-16 ErikHommel $ |
38 | */ | |
39 | ||
40 | require_once 'CRM/Core/DAO/Country.php'; | |
41 | ||
42 | /** | |
43 | * Add an Country for a contact | |
44 | * | |
45 | * Allowed @params array keys are: | |
46 | * | |
47 | * @example CountryCreate.php Standard Create Example | |
48 | * | |
d0997921 EM |
49 | * @param array $params |
50 | * @return array API result array | |
51 | * API result array | |
52 | * @throws \API_Exception | |
ee93cc38 JJ |
53 | * @access public |
54 | */ | |
55 | function civicrm_api3_country_create($params) { | |
56 | return _civicrm_api3_basic_create(_civicrm_api3_get_DAO(__FUNCTION__), $params); | |
57 | } | |
58 | ||
59 | /** | |
60 | * Adjust Metadata for Create action | |
ebf2b57b | 61 | * |
ee93cc38 | 62 | * The metadata is used for setting defaults, documentation & validation |
cf470720 TO |
63 | * @param array $params |
64 | * Array or parameters determined by getfields. | |
ee93cc38 JJ |
65 | */ |
66 | function _civicrm_api3_country_create_spec(&$params) { | |
78abe068 | 67 | $params['name']['api.required'] = 1; |
ee93cc38 JJ |
68 | } |
69 | ||
70 | /** | |
71 | * Deletes an existing Country | |
72 | * | |
cf470720 | 73 | * @param array $params |
ee93cc38 JJ |
74 | * |
75 | * @example CountryDelete.php Standard Delete Example | |
76 | * | |
a6c01b45 | 77 | * @return boolean |
72b3a70c | 78 | * | error true if successfull, error otherwise |
ee93cc38 JJ |
79 | * {@getfields country_delete} |
80 | * @access public | |
81 | */ | |
82 | function civicrm_api3_country_delete($params) { | |
83 | return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params); | |
84 | } | |
85 | ||
86 | /** | |
87 | * Retrieve one or more countrys | |
88 | * | |
cf470720 | 89 | * @param array input parameters |
ee93cc38 JJ |
90 | * |
91 | * | |
92 | * @example CountryGet.php Standard Get Example | |
93 | * | |
cf470720 TO |
94 | * @param array $params |
95 | * An associative array of name/value pairs. | |
ee93cc38 | 96 | * |
a6c01b45 | 97 | * @return array |
72b3a70c | 98 | * api result array |
ee93cc38 JJ |
99 | * {@getfields country_get} |
100 | * @access public | |
101 | */ | |
102 | function civicrm_api3_country_get($params) { | |
103 | ||
104 | return _civicrm_api3_basic_get(_civicrm_api3_get_DAO(__FUNCTION__), $params); | |
105 | } |