5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.3 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2013 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * File for the CiviCRM APIv3 address functions
33 * @package CiviCRM_APIv3
34 * @subpackage API_Address
36 * @copyright CiviCRM LLC (c) 2004-2013
37 * @version $Id: Address.php 2011-02-16 ErikHommel $
40 require_once 'CRM/Core/BAO/Address.php';
43 * Add an Address for a contact
45 * Allowed @params array keys are:
46 * {@getfields address_create}
47 * {@example AddressCreate.php}
49 * @return array of newly created tag property values.
52 function civicrm_api3_address_create(&$params) {
54 * if street_parsing, street_address has to be parsed into
57 if (array_key_exists('street_parsing', $params)) {
58 if ($params['street_parsing'] == 1) {
59 if (array_key_exists('street_address', $params)) {
60 if (!empty($params['street_address'])) {
61 $parsedItems = CRM_Core_BAO_Address
::parseStreetAddress(
62 $params['street_address']
64 if (array_key_exists('street_name', $parsedItems)) {
65 $params['street_name'] = $parsedItems['street_name'];
67 if (array_key_exists('street_unit', $parsedItems)) {
68 $params['street_unit'] = $parsedItems['street_unit'];
70 if (array_key_exists('street_number', $parsedItems)) {
71 $params['street_number'] = $parsedItems['street_number'];
73 if (array_key_exists('street_number_suffix', $parsedItems)) {
74 $params['street_number_suffix'] = $parsedItems['street_number_suffix'];
82 * create array for BAO (expects address params in as an
83 * element in array 'address'
85 $addressBAO = CRM_Core_BAO_Address
::add($params, TRUE);
86 if (empty($addressBAO)) {
87 return civicrm_api3_create_error("Address is not created or updated ");
91 $values = _civicrm_api3_dao_to_array($addressBAO, $params);
92 return civicrm_api3_create_success($values, $params, 'address', $addressBAO);
97 * Adjust Metadata for Create action
99 * @param array $params array or parameters determined by getfields
101 function _civicrm_api3_address_create_spec(&$params) {
102 $params['location_type_id']['api.required'] = 1;
103 $params['contact_id']['api.required'] = 1;
104 $params['country'] = array('title' => 'Name or 2-letter abbreviation of country. Looked up in civicrm_country table');
105 $params['street_parsing'] = array('title' => 'optional param to indicate you want the street_address field parsed into individual params');
109 * Deletes an existing Address
111 * @param array $params
113 * {@getfields address_delete}
114 * {@example AddressDelete.php 0}
116 * @return boolean | error true if successfull, error otherwise
119 function civicrm_api3_address_delete(&$params) {
120 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
124 * Retrieve one or more addresses on address_id, contact_id, street_name, city
125 * or a combination of those
127 * @param mixed[] (reference ) input parameters
129 * {@example AddressGet.php 0}
130 * @param array $params an associative array of name/value pairs.
132 * @return array details of found addresses else error
133 * {@getfields address_get}
136 function civicrm_api3_address_get(&$params) {
137 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, TRUE, 'Address');