4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 address functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_Address
35 * @copyright CiviCRM LLC (c) 2004-2014
36 * @version $Id: Address.php 2011-02-16 ErikHommel $
40 * Add an Address for a contact
42 * Allowed @params array keys are:
43 * {@getfields address_create}
44 * {@example AddressCreate.php}
48 * @return array of newly created tag property values.
51 function civicrm_api3_address_create(&$params) {
53 * if street_parsing, street_address has to be parsed into
56 if (array_key_exists('street_parsing', $params)) {
57 if ($params['street_parsing'] == 1) {
58 if (array_key_exists('street_address', $params)) {
59 if (!empty($params['street_address'])) {
60 $parsedItems = CRM_Core_BAO_Address
::parseStreetAddress(
61 $params['street_address']
63 if (array_key_exists('street_name', $parsedItems)) {
64 $params['street_name'] = $parsedItems['street_name'];
66 if (array_key_exists('street_unit', $parsedItems)) {
67 $params['street_unit'] = $parsedItems['street_unit'];
69 if (array_key_exists('street_number', $parsedItems)) {
70 $params['street_number'] = $parsedItems['street_number'];
72 if (array_key_exists('street_number_suffix', $parsedItems)) {
73 $params['street_number_suffix'] = $parsedItems['street_number_suffix'];
81 * create array for BAO (expects address params in as an
82 * element in array 'address'
84 $addressBAO = CRM_Core_BAO_Address
::add($params, TRUE);
85 if (empty($addressBAO)) {
86 return civicrm_api3_create_error("Address is not created or updated ");
90 $values = _civicrm_api3_dao_to_array($addressBAO, $params);
91 return civicrm_api3_create_success($values, $params, 'address', $addressBAO);
96 * Adjust Metadata for Create action
98 * @param array $params array or parameters determined by getfields
100 function _civicrm_api3_address_create_spec(&$params) {
101 $params['location_type_id']['api.required'] = 1;
102 $params['contact_id']['api.required'] = 1;
103 $params['country'] = array('title' => 'Name or 2-letter abbreviation of country. Looked up in civicrm_country table');
104 $params['street_parsing'] = array('title' => 'optional param to indicate you want the street_address field parsed into individual params');
105 $params['world_region'] = array(
106 'title' => ts('World Region'),
107 'name' => 'world_region',
111 * Adjust Metadata for Get action
113 * @param array $params array or parameters determined by getfields
115 function _civicrm_api3_address_get_spec(&$params) {
116 $params['world_region'] = array(
117 'title' => ts('World Region'),
118 'name' => 'world_region',
123 * Deletes an existing Address
125 * @param array $params
127 * {@getfields address_delete}
128 * {@example AddressDelete.php 0}
130 * @return array api result array
133 function civicrm_api3_address_delete($params) {
134 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
138 * Retrieve one or more addresses on address_id, contact_id, street_name, city
139 * or a combination of those
141 * @param mixed[] (reference ) input parameters
143 * {@example AddressGet.php 0}
144 * @param array $params an associative array of name/value pairs.
146 * @return array details of found addresses else error
147 * {@getfields address_get}
150 function civicrm_api3_address_get(&$params) {
151 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, TRUE, 'Address');