Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
a30c801b | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
a30c801b TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
244bbdd8 | 13 | * This api exposes CiviCRM Address records. |
6a488035 TO |
14 | * |
15 | * @package CiviCRM_APIv3 | |
6a488035 TO |
16 | */ |
17 | ||
6a488035 | 18 | /** |
22242c87 | 19 | * Add an Address for a contact. |
6a488035 | 20 | * |
db83e3a3 CW |
21 | * FIXME: Should be using basic_create util |
22 | * | |
c490a46a | 23 | * @param array $params |
2e66abf8 | 24 | * Array per getfields metadata. |
77b97be7 | 25 | * |
a6c01b45 | 26 | * @return array |
00f8641b | 27 | * API result array |
6a488035 | 28 | */ |
1c31aa41 | 29 | function civicrm_api3_address_create($params) { |
db83e3a3 | 30 | _civicrm_api3_check_edit_permissions('CRM_Core_BAO_Address', $params); |
6a488035 | 31 | /** |
100fef9d | 32 | * If street_parsing, street_address has to be parsed into |
6a488035 TO |
33 | * separate parts |
34 | */ | |
35 | if (array_key_exists('street_parsing', $params)) { | |
36 | if ($params['street_parsing'] == 1) { | |
37 | if (array_key_exists('street_address', $params)) { | |
38 | if (!empty($params['street_address'])) { | |
39 | $parsedItems = CRM_Core_BAO_Address::parseStreetAddress( | |
40 | $params['street_address'] | |
41 | ); | |
42 | if (array_key_exists('street_name', $parsedItems)) { | |
43 | $params['street_name'] = $parsedItems['street_name']; | |
44 | } | |
45 | if (array_key_exists('street_unit', $parsedItems)) { | |
46 | $params['street_unit'] = $parsedItems['street_unit']; | |
47 | } | |
48 | if (array_key_exists('street_number', $parsedItems)) { | |
49 | $params['street_number'] = $parsedItems['street_number']; | |
50 | } | |
51 | if (array_key_exists('street_number_suffix', $parsedItems)) { | |
52 | $params['street_number_suffix'] = $parsedItems['street_number_suffix']; | |
53 | } | |
54 | } | |
55 | } | |
56 | } | |
57 | } | |
58 | ||
e9ff5391 | 59 | if (!isset($params['check_permissions'])) { |
60 | $params['check_permissions'] = 0; | |
61 | } | |
62 | ||
0b04b86f EE |
63 | if (!isset($params['fix_address'])) { |
64 | $params['fix_address'] = TRUE; | |
65 | } | |
66 | ||
6a488035 | 67 | /** |
c490a46a CW |
68 | * Create array for BAO (expects address params in as an |
69 | * element in array 'address' | |
70 | */ | |
0b04b86f | 71 | $addressBAO = CRM_Core_BAO_Address::add($params, $params['fix_address']); |
6a488035 TO |
72 | if (empty($addressBAO)) { |
73 | return civicrm_api3_create_error("Address is not created or updated "); | |
74 | } | |
75 | else { | |
6a488035 | 76 | $values = _civicrm_api3_dao_to_array($addressBAO, $params); |
244bbdd8 | 77 | return civicrm_api3_create_success($values, $params, 'Address', $addressBAO); |
6a488035 TO |
78 | } |
79 | } | |
80 | ||
11e09c59 | 81 | /** |
0aa0303c | 82 | * Adjust Metadata for Create action. |
6a488035 | 83 | * |
cf470720 | 84 | * @param array $params |
b081365f | 85 | * Array of parameters determined by getfields. |
6a488035 TO |
86 | */ |
87 | function _civicrm_api3_address_create_spec(&$params) { | |
88 | $params['location_type_id']['api.required'] = 1; | |
89 | $params['contact_id']['api.required'] = 1; | |
cf8f0fff | 90 | $params['street_parsing'] = [ |
b2ed8e73 CW |
91 | 'title' => 'Street Address Parsing', |
92 | 'description' => 'Optional param to indicate you want the street_address field parsed into individual params', | |
d142432b | 93 | 'type' => CRM_Utils_Type::T_BOOLEAN, |
cf8f0fff CW |
94 | ]; |
95 | $params['skip_geocode'] = [ | |
ef804737 WDC |
96 | 'title' => 'Skip geocode', |
97 | 'description' => 'Optional param to indicate you want to skip geocoding (useful when importing a lot of addresses | |
98 | at once, the job \'Geocode and Parse Addresses\' can execute this task after the import)', | |
99 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
cf8f0fff CW |
100 | ]; |
101 | $params['fix_address'] = [ | |
0b04b86f EE |
102 | 'title' => ts('Fix address'), |
103 | 'description' => ts('When true, apply various fixes to the address before insert. Default true.'), | |
104 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
105 | 'api.default' => TRUE, | |
cf8f0fff CW |
106 | ]; |
107 | $params['world_region'] = [ | |
c7130c3e CW |
108 | 'title' => ts('World Region'), |
109 | 'name' => 'world_region', | |
b8326bd2 | 110 | 'type' => CRM_Utils_Type::T_TEXT, |
cf8f0fff | 111 | ]; |
0e70279a AS |
112 | $defaultLocation = CRM_Core_BAO_LocationType::getDefault(); |
113 | if ($defaultLocation) { | |
114 | $params['location_type_id']['api.default'] = $defaultLocation->id; | |
115 | } | |
c7130c3e | 116 | } |
210737b6 | 117 | |
c7130c3e | 118 | /** |
2e66abf8 | 119 | * Adjust Metadata for Get action. |
c7130c3e | 120 | * |
cf470720 | 121 | * @param array $params |
2e66abf8 | 122 | * Array of parameters determined by getfields. |
c7130c3e CW |
123 | */ |
124 | function _civicrm_api3_address_get_spec(&$params) { | |
cf8f0fff | 125 | $params['world_region'] = [ |
c7130c3e CW |
126 | 'title' => ts('World Region'), |
127 | 'name' => 'world_region', | |
b8326bd2 | 128 | 'type' => CRM_Utils_Type::T_TEXT, |
cf8f0fff | 129 | ]; |
6a488035 TO |
130 | } |
131 | ||
132 | /** | |
2e66abf8 | 133 | * Delete an existing Address. |
6a488035 | 134 | * |
cf470720 | 135 | * @param array $params |
2e66abf8 | 136 | * Array per getfields metadata. |
6a488035 | 137 | * |
a6c01b45 | 138 | * @return array |
00f8641b | 139 | * API result array |
6a488035 | 140 | */ |
7c285037 | 141 | function civicrm_api3_address_delete($params) { |
6a488035 TO |
142 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
143 | } | |
144 | ||
145 | /** | |
2e66abf8 | 146 | * Retrieve one or more addresses. |
6a488035 | 147 | * |
cf470720 | 148 | * @param array $params |
2e66abf8 | 149 | * Array per getfields metadata. |
6a488035 | 150 | * |
a6c01b45 | 151 | * @return array |
00f8641b | 152 | * API result array |
6a488035 | 153 | */ |
1c31aa41 | 154 | function civicrm_api3_address_get($params) { |
6a488035 TO |
155 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Address'); |
156 | } |