3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * File for the CiviCRM APIv3 address functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Address
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: Address.php 2011-02-16 ErikHommel $
39 * Add an Address for a contact.
41 * @param array $params
42 * Array per getfields metadata.
45 * Array of newly created tag property values.
47 function civicrm_api3_address_create(&$params) {
49 * If street_parsing, street_address has to be parsed into
52 if (array_key_exists('street_parsing', $params)) {
53 if ($params['street_parsing'] == 1) {
54 if (array_key_exists('street_address', $params)) {
55 if (!empty($params['street_address'])) {
56 $parsedItems = CRM_Core_BAO_Address
::parseStreetAddress(
57 $params['street_address']
59 if (array_key_exists('street_name', $parsedItems)) {
60 $params['street_name'] = $parsedItems['street_name'];
62 if (array_key_exists('street_unit', $parsedItems)) {
63 $params['street_unit'] = $parsedItems['street_unit'];
65 if (array_key_exists('street_number', $parsedItems)) {
66 $params['street_number'] = $parsedItems['street_number'];
68 if (array_key_exists('street_number_suffix', $parsedItems)) {
69 $params['street_number_suffix'] = $parsedItems['street_number_suffix'];
77 * Create array for BAO (expects address params in as an
78 * element in array 'address'
80 $addressBAO = CRM_Core_BAO_Address
::add($params, TRUE);
81 if (empty($addressBAO)) {
82 return civicrm_api3_create_error("Address is not created or updated ");
85 $values = _civicrm_api3_dao_to_array($addressBAO, $params);
86 return civicrm_api3_create_success($values, $params, 'address', $addressBAO);
91 * Adjust Metadata for Create action.
93 * @param array $params
94 * Array or parameters determined by getfields.
96 function _civicrm_api3_address_create_spec(&$params) {
97 $params['location_type_id']['api.required'] = 1;
98 $params['contact_id']['api.required'] = 1;
99 $params['country'] = array('title' => 'Name or 2-letter abbreviation of country. Looked up in civicrm_country table');
100 $params['street_parsing'] = array('title' => 'optional param to indicate you want the street_address field parsed into individual params');
101 $params['world_region'] = array(
102 'title' => ts('World Region'),
103 'name' => 'world_region',
104 'type' => CRM_Utils_Type
::T_TEXT
,
108 * Adjust Metadata for Get action.
110 * @param array $params
111 * Array of parameters determined by getfields.
113 function _civicrm_api3_address_get_spec(&$params) {
114 $params['world_region'] = array(
115 'title' => ts('World Region'),
116 'name' => 'world_region',
117 'type' => CRM_Utils_Type
::T_TEXT
,
122 * Delete an existing Address.
124 * @param array $params
125 * Array per getfields metadata.
130 function civicrm_api3_address_delete($params) {
131 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
135 * Retrieve one or more addresses.
137 * @param array $params
138 * Array per getfields metadata.
141 * details of found addresses else error
143 function civicrm_api3_address_get(&$params) {
144 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, TRUE, 'Address');