Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | // $Id$ | |
3 | ||
4 | /* | |
5 | +--------------------------------------------------------------------+ | |
6 | | CiviCRM version 4.3 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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 | * new version of civicrm apis. See blog post at | |
32 | * http://civicrm.org/node/131 | |
33 | * @todo Write sth | |
34 | * | |
35 | * @package CiviCRM_APIv3 | |
36 | * @subpackage API_Contact | |
37 | * @copyright CiviCRM LLC (c) 2004-2013 | |
38 | * $Id: Contact.php 30879 2010-11-22 15:45:55Z shot $ | |
39 | * | |
40 | */ | |
41 | ||
42 | /** | |
43 | * Create or update a contact (note you should always call this via civicrm_api() & never directly) | |
44 | * | |
45 | * @param array $params input parameters | |
46 | * | |
47 | * Allowed @params array keys are: | |
48 | * {@getfields contact_create} | |
49 | * | |
50 | * | |
51 | * @example ContactCreate.php Example of Create Call | |
52 | * | |
53 | * @return array API Result Array | |
54 | * | |
55 | * @static void | |
56 | * @access public | |
57 | */ | |
58 | function civicrm_api3_contact_create($params) { | |
59 | ||
60 | $contactID = CRM_Utils_Array::value('contact_id', $params, CRM_Utils_Array::value('id', $params)); | |
61 | $dupeCheck = CRM_Utils_Array::value('dupe_check', $params, FALSE); | |
62 | $values = _civicrm_api3_contact_check_params($params, $dupeCheck); | |
63 | if ($values) { | |
64 | return $values; | |
65 | } | |
66 | ||
67 | if (!$contactID) { | |
68 | // If we get here, we're ready to create a new contact | |
69 | if (($email = CRM_Utils_Array::value('email', $params)) && !is_array($params['email'])) { | |
70 | $defLocType = CRM_Core_BAO_LocationType::getDefault(); | |
71 | $params['email'] = array( | |
72 | 1 => array('email' => $email, | |
73 | 'is_primary' => 1, | |
74 | 'location_type_id' => ($defLocType->id) ? $defLocType->id : 1, | |
75 | ), | |
76 | ); | |
77 | } | |
78 | } | |
79 | ||
80 | if (!empty($params['home_url'])) { | |
cbf48754 | 81 | $websiteTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id'); |
6a488035 TO |
82 | $params['website'] = array(1 => array('website_type_id' => key($websiteTypes), |
83 | 'url' => $params['home_url'], | |
84 | ), | |
85 | ); | |
86 | } | |
87 | ||
88 | if (isset($params['suffix_id']) && !(is_numeric($params['suffix_id']))) { | |
e6c4755b | 89 | $params['suffix_id'] = array_search($params['suffix_id'], CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'suffix_id')); |
6a488035 TO |
90 | } |
91 | ||
92 | if (isset($params['prefix_id']) && !(is_numeric($params['prefix_id']))) { | |
e6c4755b | 93 | $params['prefix_id'] = array_search($params['prefix_id'], CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id')); |
6a488035 TO |
94 | } |
95 | ||
96 | if (isset($params['gender_id']) && !(is_numeric($params['gender_id']))) { | |
26cf88b5 | 97 | $params['gender_id'] = array_search($params['gender_id'], CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id')); |
6a488035 TO |
98 | } |
99 | ||
100 | $error = _civicrm_api3_greeting_format_params($params); | |
101 | if (civicrm_error($error)) { | |
102 | return $error; | |
103 | } | |
104 | ||
105 | $values = array(); | |
106 | $entityId = $contactID; | |
107 | ||
108 | if (empty($params['contact_type']) && $entityId) { | |
109 | $params['contact_type'] = CRM_Contact_BAO_Contact::getContactType($entityId); | |
110 | } | |
111 | ||
112 | if (!isset($params['contact_sub_type']) && $entityId) { | |
113 | $params['contact_sub_type'] = CRM_Contact_BAO_Contact::getContactSubType($entityId); | |
114 | } | |
115 | ||
116 | _civicrm_api3_custom_format_params($params, $values, $params['contact_type'], $entityId); | |
117 | ||
118 | $params = array_merge($params, $values); | |
119 | ||
120 | $contact = _civicrm_api3_contact_update($params, $contactID); | |
121 | ||
122 | if (is_a($contact, 'CRM_Core_Error')) { | |
123 | return civicrm_api3_create_error($contact->_errors[0]['message']); | |
124 | } | |
125 | else { | |
126 | $values = array(); | |
127 | _civicrm_api3_object_to_array_unique_fields($contact, $values[$contact->id]); | |
128 | } | |
129 | ||
130 | return civicrm_api3_create_success($values, $params, 'Contact', 'create'); | |
131 | } | |
132 | ||
11e09c59 | 133 | /** |
6a488035 TO |
134 | * Adjust Metadata for Create action |
135 | * | |
136 | * @param array $params array or parameters determined by getfields | |
137 | */ | |
138 | function _civicrm_api3_contact_create_spec(&$params) { | |
139 | $params['contact_type']['api.required'] = 1; | |
140 | $params['id']['api.aliases'] = array('contact_id'); | |
141 | $params['current_employer'] = array( | |
142 | 'title' => 'Current Employer', | |
143 | 'description' => 'Name of Current Employer', | |
144 | ); | |
0391dc25 | 145 | $params['dupe_check'] = array( |
146 | 'title' => 'Check for Duplicates', | |
147 | 'description' => 'Throw error if contact create matches dedupe rule', | |
148 | ); | |
6a488035 TO |
149 | } |
150 | ||
151 | /** | |
152 | * Retrieve one or more contacts, given a set of search params | |
153 | * | |
154 | * @param array input parameters | |
155 | * | |
156 | * @return array API Result Array | |
157 | * (@getfields contact_get} | |
158 | * @static void | |
159 | * @access public | |
160 | * | |
161 | * @example ContactGet.php Standard GET example | |
162 | * | |
163 | */ | |
164 | function civicrm_api3_contact_get($params) { | |
165 | $options = array(); | |
166 | _civicrm_api3_contact_get_supportanomalies($params, $options); | |
167 | $contacts = _civicrm_api3_get_using_query_object('contact', $params, $options); | |
168 | ||
169 | // CRM-7929 Quick fix by colemanw | |
170 | // TODO: Figure out what function is responsible for prepending 'individual_' to these keys | |
171 | // and sort it out there rather than going to all this trouble here. | |
172 | // Eileen's note - not sure anymore if we went the right path stripping the 'individual' here | |
173 | // as is arguable whether it makes more sense now I think it would make more sense to rename the table field or uniquefield to have | |
174 | // the individual prefix but we are stuck with it now for apiv3 series. | |
175 | $returnContacts = array(); | |
176 | if (is_array($contacts)) { | |
177 | foreach ($contacts as $cid => $contact) { | |
178 | if (is_array($contact)) { | |
179 | $returnContacts[$cid] = array(); | |
180 | foreach ($contact as $key => $value) { | |
181 | $key = str_replace(array('individual_prefix', 'individual_suffix'), array('prefix', 'suffix'), $key); | |
182 | $returnContacts[$cid][$key] = $value; | |
183 | } | |
184 | } | |
185 | } | |
186 | } | |
187 | return civicrm_api3_create_success($returnContacts, $params, 'contact'); | |
188 | } | |
189 | ||
190 | function civicrm_api3_contact_getcount($params) { | |
191 | $options = array(); | |
192 | _civicrm_api3_contact_get_supportanomalies($params, $options); | |
193 | $count = _civicrm_api3_get_using_query_object('contact', $params, $options,1); | |
194 | return $count; | |
195 | } | |
11e09c59 TO |
196 | |
197 | /** | |
6a488035 TO |
198 | * Adjust Metadata for Get action |
199 | * | |
200 | * @param array $params array or parameters determined by getfields | |
201 | */ | |
202 | function _civicrm_api3_contact_get_spec(&$params) { | |
203 | $params['contact_is_deleted']['api.default'] = 0; | |
204 | ||
205 | //we declare all these pseudofields as there are other undocumented fields accessible | |
206 | // via the api - but if check permissions is set we only allow declared fields | |
207 | $params['address_id']['title'] = 'Primary Address ID'; | |
208 | $params['street_address']['title'] = 'Primary Address Street Address'; | |
209 | $params['supplemental_address_1']['title'] = 'Primary Address Supplemental Address 1'; | |
210 | $params['supplemental_address_2']['title'] = 'Primary Address Supplemental Address 2'; | |
211 | $params['city']['title'] = 'Primary Address City'; | |
212 | $params['postal_code_suffix']['title'] = 'Primary Address Post Code Suffix'; | |
213 | $params['postal_code']['title'] = 'Primary Address Post Code'; | |
214 | $params['geo_code_1']['title'] = 'Primary Address Latitude'; | |
215 | $params['geo_code_2']['title'] = 'Primary Address Longitude'; | |
216 | $params['state_province_id']['title'] = 'Primary Address State Province ID'; | |
217 | $params['state_province_name']['title'] = 'Primary Address State Province Name'; | |
218 | $params['state_province']['title'] = 'Primary Address State Province'; | |
219 | $params['country_id']['title'] = 'Primary Address State Province ID'; | |
220 | $params['country']['title'] = 'Primary Address country'; | |
221 | $params['worldregion_id']['title'] = 'Primary Address World Region ID'; | |
222 | $params['worldregion']['title'] = 'Primary Address World Region'; | |
223 | $params['phone_id']['title'] = 'Primary Phone ID'; | |
224 | $params['phone_type_id']['title'] = 'Primary Phone Type ID'; | |
225 | $params['provider_id']['title'] = 'Primary Phone Provider ID'; | |
226 | $params['email_id']['title'] = 'Primary Email ID'; | |
227 | $params['email']['title'] = 'Primary Email'; | |
228 | $params['on_hold']['title'] = 'Primary Email On Hold'; | |
229 | $params['im']['title'] = 'Primary Instant Messanger'; | |
230 | $params['im_id']['title'] = 'Primary Instant Messanger ID'; | |
231 | $params['group_id']['title'] = 'Group Memberships (filter)'; | |
232 | $params['group']['title'] = 'Group Memberships (filter, array)'; | |
233 | $params['tag']['title'] = 'Assigned tags (filter, array)'; | |
234 | } | |
235 | ||
11e09c59 | 236 | /** |
6a488035 TO |
237 | * We are supporting 'showAll' = 'all', 'trash' or 'active' for contact get |
238 | * and for getcount | |
239 | * - hopefully some day we'll come up with a std syntax for the 3-way-boolean of | |
240 | * 0, 1 or not set | |
241 | * | |
242 | * We also support 'filter_group_id' & 'filter.group_id' | |
243 | * | |
244 | * @param array $params as passed into api get or getcount function | |
245 | * @param array $options array of options (so we can modify the filter) | |
246 | */ | |
247 | function _civicrm_api3_contact_get_supportanomalies(&$params, &$options) { | |
248 | if (isset($params['showAll'])) { | |
249 | if (strtolower($params['showAll']) == "active") { | |
250 | $params['contact_is_deleted'] = 0; | |
251 | } | |
252 | if (strtolower($params['showAll']) == "trash") { | |
253 | $params['contact_is_deleted'] = 1; | |
254 | } | |
255 | if (strtolower($params['showAll']) == "all" && isset($params['contact_is_deleted'])) { | |
256 | unset($params['contact_is_deleted']); | |
257 | } | |
258 | } | |
259 | // support for group filters | |
260 | if (array_key_exists('filter_group_id', $params)) { | |
261 | $params['filter.group_id'] = $params['filter_group_id']; | |
262 | unset($params['filter_group_id']); | |
263 | } | |
264 | // filter.group_id works both for 1,2,3 and array (1,2,3) | |
265 | if (array_key_exists('filter.group_id', $params)) { | |
266 | if (is_array($params['filter.group_id'])) { | |
267 | $groups = $params['filter.group_id']; | |
268 | } | |
269 | else $groups = explode(',', $params['filter.group_id']); | |
270 | unset($params['filter.group_id']); | |
271 | $groups = array_flip($groups); | |
272 | $groups[key($groups)] = 1; | |
273 | $options['input_params']['group'] = $groups; | |
274 | } | |
275 | } | |
276 | ||
277 | /** | |
278 | * Delete a contact with given contact id | |
279 | * | |
280 | * @param array $params (reference ) input parameters, contact_id element required | |
281 | * | |
282 | * @return array API Result Array | |
283 | * @access public | |
284 | * | |
285 | * @example ContactDelete.php | |
286 | * {@getfields contact_delete} | |
287 | */ | |
288 | function civicrm_api3_contact_delete($params) { | |
289 | ||
290 | $contactID = CRM_Utils_Array::value('id', $params); | |
291 | ||
292 | $session = CRM_Core_Session::singleton(); | |
293 | if ($contactID == $session->get('userID')) { | |
294 | return civicrm_api3_create_error('This contact record is linked to the currently logged in user account - and cannot be deleted.'); | |
295 | } | |
296 | $restore = CRM_Utils_Array::value('restore', $params) ? $params['restore'] : FALSE; | |
297 | $skipUndelete = CRM_Utils_Array::value('skip_undelete', $params) ? $params['skip_undelete'] : FALSE; | |
f182074e PN |
298 | |
299 | // CRM-12929 | |
300 | // restrict permanent delete if a contact has financial trxn associated with it | |
301 | $error = NULL; | |
302 | if ($skipUndelete && CRM_Financial_BAO_FinancialItem::checkContactPresent(array($contactID), $error)) { | |
303 | return civicrm_api3_create_error($error['_qf_default']); | |
304 | } | |
6a488035 TO |
305 | if (CRM_Contact_BAO_Contact::deleteContact($contactID, $restore, $skipUndelete)) { |
306 | return civicrm_api3_create_success(); | |
307 | } | |
308 | else { | |
309 | return civicrm_api3_create_error('Could not delete contact'); | |
310 | } | |
311 | } | |
312 | ||
313 | ||
314 | function _civicrm_api3_contact_check_params( &$params, $dupeCheck = true, $dupeErrorArray = false, $obsoletevalue = true, $dedupeRuleGroupID = null ) | |
315 | { | |
316 | ||
317 | switch (strtolower(CRM_Utils_Array::value('contact_type', $params))) { | |
318 | case 'household': | |
319 | civicrm_api3_verify_mandatory($params, null, array('household_name')); | |
320 | break; | |
321 | case 'organization': | |
322 | civicrm_api3_verify_mandatory($params, null, array('organization_name')); | |
323 | break; | |
324 | case 'individual': | |
325 | civicrm_api3_verify_one_mandatory($params, null, array( | |
326 | 'first_name', | |
327 | 'last_name', | |
328 | 'email', | |
329 | 'display_name', | |
330 | ) | |
331 | ); | |
332 | break; | |
333 | } | |
334 | ||
335 | if (CRM_Utils_Array::value('contact_sub_type', $params) && CRM_Utils_Array::value('contact_type', $params)) { | |
336 | if (!(CRM_Contact_BAO_ContactType::isExtendsContactType($params['contact_sub_type'], $params['contact_type']))) { | |
337 | return civicrm_api3_create_error("Invalid or Mismatched Contact SubType: " . implode(', ', (array)$params['contact_sub_type'])); | |
338 | } | |
339 | } | |
340 | ||
341 | if ($dupeCheck) { | |
342 | // check for record already existing | |
343 | $dedupeParams = CRM_Dedupe_Finder::formatParams($params, $params['contact_type']); | |
344 | ||
345 | // CRM-6431 | |
346 | // setting 'check_permission' here means that the dedupe checking will be carried out even if the | |
347 | // person does not have permission to carry out de-dupes | |
348 | // this is similar to the front end form | |
349 | if (isset($params['check_permission'])) { | |
350 | $dedupeParams['check_permission'] = $params['check_permission']; | |
351 | } | |
352 | ||
353 | $ids = CRM_Dedupe_Finder::dupesByParams($dedupeParams, $params['contact_type'], 'Strict', array()); | |
354 | ||
355 | if (count($ids) >0) { | |
356 | throw new API_Exception("Found matching contacts: ". implode(',',$ids),"duplicate",array("ids"=>$ids)); | |
357 | } | |
358 | } | |
359 | ||
360 | //check for organisations with same name | |
361 | if (!empty($params['current_employer'])) { | |
362 | $organizationParams = array(); | |
363 | $organizationParams['organization_name'] = $params['current_employer']; | |
364 | ||
365 | $dedupParams = CRM_Dedupe_Finder::formatParams($organizationParams, 'Organization'); | |
366 | ||
367 | $dedupParams['check_permission'] = FALSE; | |
368 | $dupeIds = CRM_Dedupe_Finder::dupesByParams($dedupParams, 'Organization', 'Supervised'); | |
369 | ||
370 | // check for mismatch employer name and id | |
371 | if (!empty($params['employer_id']) && !in_array($params['employer_id'], $dupeIds)) { | |
372 | throw new API_Exception('Employer name and Employer id Mismatch'); | |
373 | } | |
374 | ||
375 | // show error if multiple organisation with same name exist | |
376 | if (empty($params['employer_id']) && (count($dupeIds) > 1)) { | |
377 | throw new API_Exception('Found more than one Organisation with same Name.'); | |
378 | } | |
379 | } | |
380 | ||
381 | return NULL; | |
382 | } | |
383 | ||
384 | /** | |
385 | * Takes an associative array and creates a contact object and all the associated | |
386 | * derived objects (i.e. individual, location, email, phone etc) | |
387 | * | |
388 | * @param array $params (reference ) an assoc array of name/value pairs | |
389 | * @param int $contactID if present the contact with that ID is updated | |
390 | * | |
391 | * @return object CRM_Contact_BAO_Contact object | |
392 | * @access public | |
393 | * @static | |
394 | */ | |
395 | function _civicrm_api3_contact_update($params, $contactID = NULL) { | |
396 | $transaction = new CRM_Core_Transaction(); | |
397 | ||
398 | if ($contactID) { | |
399 | $params['contact_id'] = $contactID; | |
400 | } | |
401 | ||
402 | $contact = CRM_Contact_BAO_Contact::create($params); | |
403 | ||
404 | $transaction->commit(); | |
405 | ||
406 | return $contact; | |
407 | } | |
408 | ||
409 | /** | |
410 | * Validate the addressee or email or postal greetings | |
411 | * | |
412 | * @param $params Associative array of property name/value | |
413 | * pairs to insert in new contact. | |
414 | * | |
415 | * @return array (reference ) null on success, error message otherwise | |
416 | * | |
417 | * @access public | |
418 | */ | |
419 | function _civicrm_api3_greeting_format_params($params) { | |
420 | $greetingParams = array('', '_id', '_custom'); | |
421 | foreach (array('email', 'postal', 'addressee') as $key) { | |
422 | $greeting = '_greeting'; | |
423 | if ($key == 'addressee') { | |
424 | $greeting = ''; | |
425 | } | |
426 | ||
427 | $formatParams = FALSE; | |
428 | // unset display value from params. | |
429 | if (isset($params["{$key}{$greeting}_display"])) { | |
430 | unset($params["{$key}{$greeting}_display"]); | |
431 | } | |
432 | ||
433 | // check if greetings are present in present | |
434 | foreach ($greetingParams as $greetingValues) { | |
435 | if (array_key_exists("{$key}{$greeting}{$greetingValues}", $params)) { | |
436 | $formatParams = TRUE; | |
437 | break; | |
438 | } | |
439 | } | |
440 | ||
441 | if (!$formatParams) { | |
442 | continue; | |
443 | } | |
444 | ||
445 | $nullValue = FALSE; | |
446 | $filter = array( | |
447 | 'contact_type' => $params['contact_type'], | |
448 | 'greeting_type' => "{$key}{$greeting}", | |
449 | ); | |
450 | ||
451 | $greetings = CRM_Core_PseudoConstant::greeting($filter); | |
452 | $greetingId = CRM_Utils_Array::value("{$key}{$greeting}_id", $params); | |
453 | $greetingVal = CRM_Utils_Array::value("{$key}{$greeting}", $params); | |
454 | $customGreeting = CRM_Utils_Array::value("{$key}{$greeting}_custom", $params); | |
455 | ||
456 | if (!$greetingId && $greetingVal) { | |
457 | $params["{$key}{$greeting}_id"] = CRM_Utils_Array::key($params["{$key}{$greeting}"], $greetings); | |
458 | } | |
459 | ||
460 | if ($customGreeting && $greetingId && | |
461 | ($greetingId != array_search('Customized', $greetings)) | |
462 | ) { | |
463 | return civicrm_api3_create_error(ts('Provide either %1 greeting id and/or %1 greeting or custom %1 greeting', | |
464 | array(1 => $key) | |
465 | )); | |
466 | } | |
467 | ||
468 | if ($greetingVal && $greetingId && | |
469 | ($greetingId != CRM_Utils_Array::key($greetingVal, $greetings)) | |
470 | ) { | |
471 | return civicrm_api3_create_error(ts('Mismatch in %1 greeting id and %1 greeting', | |
472 | array(1 => $key) | |
473 | )); | |
474 | } | |
475 | ||
476 | if ($greetingId) { | |
477 | ||
478 | if (!array_key_exists($greetingId, $greetings)) { | |
479 | return civicrm_api3_create_error(ts('Invalid %1 greeting Id', array(1 => $key))); | |
480 | } | |
481 | ||
482 | if (!$customGreeting && ($greetingId == array_search('Customized', $greetings))) { | |
483 | return civicrm_api3_create_error(ts('Please provide a custom value for %1 greeting', | |
484 | array(1 => $key) | |
485 | )); | |
486 | } | |
487 | } | |
488 | elseif ($greetingVal) { | |
489 | ||
490 | if (!in_array($greetingVal, $greetings)) { | |
491 | return civicrm_api3_create_error(ts('Invalid %1 greeting', array(1 => $key))); | |
492 | } | |
493 | ||
494 | $greetingId = CRM_Utils_Array::key($greetingVal, $greetings); | |
495 | } | |
496 | ||
497 | if ($customGreeting) { | |
498 | $greetingId = CRM_Utils_Array::key('Customized', $greetings); | |
499 | } | |
500 | ||
501 | $customValue = $params['contact_id'] ? CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', | |
502 | $params['contact_id'], | |
503 | "{$key}{$greeting}_custom" | |
504 | ) : FALSE; | |
505 | ||
506 | if (array_key_exists("{$key}{$greeting}_id", $params) && empty($params["{$key}{$greeting}_id"])) { | |
507 | $nullValue = TRUE; | |
508 | } | |
509 | elseif (array_key_exists("{$key}{$greeting}", $params) && empty($params["{$key}{$greeting}"])) { | |
510 | $nullValue = TRUE; | |
511 | } | |
512 | elseif ($customValue && array_key_exists("{$key}{$greeting}_custom", $params) | |
513 | && empty($params["{$key}{$greeting}_custom"]) | |
514 | ) { | |
515 | $nullValue = TRUE; | |
516 | } | |
517 | ||
518 | $params["{$key}{$greeting}_id"] = $greetingId; | |
519 | ||
520 | if (!$customValue && !$customGreeting && array_key_exists("{$key}{$greeting}_custom", $params)) { | |
521 | unset($params["{$key}{$greeting}_custom"]); | |
522 | } | |
523 | ||
524 | if ($nullValue) { | |
525 | $params["{$key}{$greeting}_id"] = ''; | |
526 | $params["{$key}{$greeting}_custom"] = ''; | |
527 | } | |
528 | ||
529 | if (isset($params["{$key}{$greeting}"])) { | |
530 | unset($params["{$key}{$greeting}"]); | |
531 | } | |
532 | } | |
533 | } | |
534 | ||
535 | /** | |
536 | * Contact quick search api | |
537 | * | |
538 | * @access public | |
539 | * | |
540 | * {@example ContactGetquick.php 0} | |
541 | * | |
542 | */ | |
543 | function civicrm_api3_contact_quicksearch($params) { | |
544 | // kept as an alias for compatibility reasons. CRM-11136 | |
545 | return civicrm_api3_contact_getquick($params); | |
546 | } | |
547 | ||
548 | function civicrm_api3_contact_getquick($params) { | |
549 | civicrm_api3_verify_mandatory($params, NULL, array('name')); | |
1aba4d9a | 550 | $name = CRM_Utils_Type::escape($params['name'], 'String'); |
6a488035 TO |
551 | |
552 | // get the autocomplete options from settings | |
553 | $acpref = explode(CRM_Core_DAO::VALUE_SEPARATOR, | |
554 | CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, | |
555 | 'contact_autocomplete_options' | |
556 | ) | |
557 | ); | |
558 | ||
559 | // get the option values for contact autocomplete | |
560 | $acOptions = CRM_Core_OptionGroup::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name'); | |
561 | ||
562 | $list = array(); | |
563 | foreach ($acpref as $value) { | |
564 | if ($value && CRM_Utils_Array::value($value, $acOptions)) { | |
565 | $list[$value] = $acOptions[$value]; | |
566 | } | |
567 | } | |
568 | // If we are doing quicksearch by a field other than name, make sure that field is added to results | |
569 | if (!empty($params['field_name'])) { | |
1aba4d9a | 570 | $field_name = CRM_Utils_String::munge($params['field_name']); |
5d8ba7a7 | 571 | // Unique name contact_id = id |
1aba4d9a CW |
572 | if ($field_name == 'contact_id') { |
573 | $field_name = 'id'; | |
5d8ba7a7 | 574 | } |
6a488035 | 575 | // phone_numeric should be phone |
1aba4d9a | 576 | $searchField = str_replace('_numeric', '', $field_name); |
6a488035 TO |
577 | if(!in_array($searchField, $list)) { |
578 | $list[] = $searchField; | |
579 | } | |
580 | } | |
581 | ||
582 | $select = $actualSelectElements = array('sort_name'); | |
583 | $where = ''; | |
584 | $from = array(); | |
585 | foreach ($list as $value) { | |
586 | $suffix = substr($value, 0, 2) . substr($value, -1); | |
587 | switch ($value) { | |
588 | case 'street_address': | |
589 | case 'city': | |
590 | case 'postal_code': | |
591 | $selectText = $value; | |
592 | $value = "address"; | |
593 | $suffix = 'sts'; | |
594 | case 'phone': | |
595 | case 'email': | |
596 | $actualSelectElements[] = $select[] = ($value == 'address') ? $selectText : $value; | |
597 | $from[$value] = "LEFT JOIN civicrm_{$value} {$suffix} ON ( cc.id = {$suffix}.contact_id AND {$suffix}.is_primary = 1 ) "; | |
598 | break; | |
599 | ||
600 | case 'country': | |
601 | case 'state_province': | |
602 | $select[] = "{$suffix}.name as {$value}"; | |
603 | $actualSelectElements[] = "{$suffix}.name"; | |
604 | if (!in_array('address', $from)) { | |
605 | $from['address'] = 'LEFT JOIN civicrm_address sts ON ( cc.id = sts.contact_id AND sts.is_primary = 1) '; | |
606 | } | |
607 | $from[$value] = " LEFT JOIN civicrm_{$value} {$suffix} ON ( sts.{$value}_id = {$suffix}.id ) "; | |
608 | break; | |
609 | ||
610 | default: | |
611 | if ($value != 'id') { | |
612 | $suffix = 'cc'; | |
613 | if (!empty($params['field_name']) && $params['field_name'] == 'value') { | |
133da98d | 614 | $suffix = CRM_Utils_String::munge(CRM_Utils_Array::value('table_name', $params, 'cc')); |
6a488035 TO |
615 | } |
616 | $actualSelectElements[] = $select[] = $suffix . '.' . $value; | |
617 | } | |
618 | break; | |
619 | } | |
620 | } | |
621 | ||
622 | $config = CRM_Core_Config::singleton(); | |
623 | $as = $select; | |
624 | $select = implode(', ', $select); | |
625 | if (!empty($select)) { | |
626 | $select = ", $select"; | |
627 | } | |
628 | $actualSelectElements = implode(', ', $actualSelectElements); | |
629 | $selectAliases = $from; | |
630 | unset($selectAliases['address']); | |
631 | $selectAliases = implode(', ', array_keys($selectAliases)); | |
632 | if (!empty($selectAliases)) { | |
633 | $selectAliases = ", $selectAliases"; | |
634 | } | |
635 | $from = implode(' ', $from); | |
133da98d CW |
636 | $limit = (int) CRM_Utils_Array::value('limit', $params); |
637 | $limit = $limit > 0 ? $limit : 10; | |
6a488035 TO |
638 | |
639 | // add acl clause here | |
640 | list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission::cacheClause('cc'); | |
641 | ||
642 | if ($aclWhere) { | |
643 | $where .= " AND $aclWhere "; | |
644 | } | |
645 | ||
646 | if (CRM_Utils_Array::value('org', $params)) { | |
647 | $where .= " AND contact_type = \"Organization\""; | |
648 | ||
649 | // CRM-7157, hack: get current employer details when | |
650 | // employee_id is present. | |
651 | $currEmpDetails = array(); | |
652 | if (CRM_Utils_Array::value('employee_id', $params)) { | |
653 | if ($currentEmployer = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', | |
133da98d | 654 | (int) $params['employee_id'], |
6a488035 TO |
655 | 'employer_id' |
656 | )) { | |
657 | if ($config->includeWildCardInName) { | |
658 | $strSearch = "%$name%"; | |
659 | } | |
660 | else { | |
661 | $strSearch = "$name%"; | |
662 | } | |
663 | ||
664 | // get current employer details | |
665 | $dao = CRM_Core_DAO::executeQuery("SELECT cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data, sort_name | |
666 | FROM civicrm_contact cc {$from} WHERE cc.contact_type = \"Organization\" AND cc.id = {$currentEmployer} AND cc.sort_name LIKE '$strSearch'"); | |
667 | if ($dao->fetch()) { | |
668 | $currEmpDetails = array( | |
669 | 'id' => $dao->id, | |
670 | 'data' => $dao->data, | |
671 | ); | |
672 | } | |
673 | } | |
674 | } | |
675 | } | |
676 | ||
677 | //set default for current_employer or return contact with particular id | |
678 | if (CRM_Utils_Array::value('id', $params)) { | |
1aba4d9a | 679 | $where .= " AND cc.id = " . (int) $params['id']; |
6a488035 TO |
680 | } |
681 | ||
682 | if (CRM_Utils_Array::value('cid', $params)) { | |
1aba4d9a | 683 | $where .= " AND cc.id <> " . (int) $params['cid']; |
6a488035 TO |
684 | } |
685 | ||
686 | //contact's based of relationhip type | |
687 | $relType = NULL; | |
688 | if (CRM_Utils_Array::value('rel', $params)) { | |
689 | $relation = explode('_', CRM_Utils_Array::value('rel', $params)); | |
690 | $relType = CRM_Utils_Type::escape($relation[0], 'Integer'); | |
691 | $rel = CRM_Utils_Type::escape($relation[2], 'String'); | |
692 | } | |
693 | ||
694 | if ($config->includeWildCardInName) { | |
695 | $strSearch = "%$name%"; | |
696 | } | |
697 | else { | |
698 | $strSearch = "$name%"; | |
699 | } | |
700 | $includeEmailFrom = $includeNickName = $exactIncludeNickName = ''; | |
701 | if ($config->includeNickNameInName) { | |
702 | $includeNickName = " OR nick_name LIKE '$strSearch'"; | |
703 | $exactIncludeNickName = " OR nick_name LIKE '$name'"; | |
704 | } | |
705 | ||
706 | //CRM-10687 | |
707 | if (!empty($params['field_name']) && !empty($params['table_name'])) { | |
1aba4d9a | 708 | $table_name = CRM_Utils_String::munge($params['table_name']); |
6a488035 TO |
709 | $whereClause = " WHERE ( $table_name.$field_name LIKE '$strSearch')"; |
710 | $exactWhereClause = " WHERE ( $table_name.$field_name = '$name')"; | |
711 | // Search by id should be exact | |
712 | if ($field_name == 'id' || $field_name == 'external_identifier') { | |
713 | $whereClause = $exactWhereClause; | |
714 | } | |
715 | } | |
716 | else { | |
717 | if ($config->includeEmailInName) { | |
718 | if (!in_array('email', $list)) { | |
719 | $includeEmailFrom = "LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )"; | |
720 | } | |
721 | $whereClause = " WHERE ( email LIKE '$strSearch' OR sort_name LIKE '$strSearch' $includeNickName ) {$where} "; | |
722 | $exactWhereClause = " WHERE ( email LIKE '$name' OR sort_name LIKE '$name' $exactIncludeNickName ) {$where} "; | |
723 | } | |
724 | else { | |
725 | $whereClause = " WHERE ( sort_name LIKE '$strSearch' $includeNickName ) {$where} "; | |
726 | $exactWhereClause = " WHERE ( sort_name LIKE '$name' $exactIncludeNickName ) {$where} "; | |
727 | } | |
728 | } | |
729 | ||
730 | $additionalFrom = ''; | |
731 | if ($relType) { | |
732 | $additionalFrom = " | |
733 | INNER JOIN civicrm_relationship_type r ON ( | |
734 | r.id = {$relType} | |
735 | AND ( cc.contact_type = r.contact_type_{$rel} OR r.contact_type_{$rel} IS NULL ) | |
736 | AND ( cc.contact_sub_type = r.contact_sub_type_{$rel} OR r.contact_sub_type_{$rel} IS NULL ) | |
737 | )"; | |
738 | } | |
739 | ||
740 | // check if only CMS users are requested | |
741 | if (CRM_Utils_Array::value('cmsuser', $params)) { | |
742 | $additionalFrom = " | |
743 | INNER JOIN civicrm_uf_match um ON (um.contact_id=cc.id) | |
744 | "; | |
745 | } | |
746 | ||
51e61eae ARW |
747 | $orderByInner = ""; |
748 | $orderByOuter = "ORDER BY exactFirst"; | |
749 | if ($config->includeOrderByClause) { | |
750 | $orderByInner = "ORDER BY sort_name"; | |
751 | $orderByOuter .= ", sort_name"; | |
752 | } | |
753 | ||
6a488035 TO |
754 | //CRM-5954 |
755 | $query = " | |
756 | SELECT DISTINCT(id), data, sort_name {$selectAliases} | |
757 | FROM ( | |
758 | ( SELECT 0 as exactFirst, cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data {$select} | |
759 | FROM civicrm_contact cc {$from} | |
760 | {$aclFrom} | |
761 | {$additionalFrom} {$includeEmailFrom} | |
762 | {$exactWhereClause} | |
763 | LIMIT 0, {$limit} ) | |
764 | UNION | |
765 | ( SELECT 1 as exactFirst, cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data {$select} | |
766 | FROM civicrm_contact cc {$from} | |
767 | {$aclFrom} | |
768 | {$additionalFrom} {$includeEmailFrom} | |
769 | {$whereClause} | |
51e61eae | 770 | {$orderByInner} |
6a488035 TO |
771 | LIMIT 0, {$limit} ) |
772 | ) t | |
51e61eae | 773 | {$orderByOuter} |
6a488035 TO |
774 | LIMIT 0, {$limit} |
775 | "; | |
776 | // send query to hook to be modified if needed | |
777 | CRM_Utils_Hook::contactListQuery($query, | |
778 | $name, | |
133da98d CW |
779 | empty($params['context']) ? NULL : CRM_Utils_Type::escape($params['context'], 'String'), |
780 | empty($params['id']) ? NULL : $params['id'] | |
6a488035 TO |
781 | ); |
782 | ||
783 | $dao = CRM_Core_DAO::executeQuery($query); | |
784 | ||
785 | $contactList = array(); | |
786 | $listCurrentEmployer = TRUE; | |
787 | while ($dao->fetch()) { | |
788 | $t = array('id' => $dao->id); | |
789 | foreach ($as as $k) { | |
790 | $t[$k] = isset($dao->$k)? $dao->$k: ''; | |
791 | } | |
792 | $t['data'] = $dao->data; | |
793 | $contactList[] = $t; | |
794 | if (CRM_Utils_Array::value('org', $params) && | |
795 | !empty($currEmpDetails) && | |
796 | $dao->id == $currEmpDetails['id'] | |
797 | ) { | |
798 | $listCurrentEmployer = FALSE; | |
799 | } | |
800 | } | |
801 | ||
802 | //return organization name if doesn't exist in db | |
803 | if (empty($contactList)) { | |
804 | if (CRM_Utils_Array::value('org', $params)) { | |
805 | if ($listCurrentEmployer && !empty($currEmpDetails)) { | |
806 | $contactList = array( | |
807 | array( | |
808 | 'data' => $currEmpDetails['data'], | |
809 | 'id' => $currEmpDetails['id'] | |
810 | ) | |
811 | ); | |
812 | } | |
813 | else { | |
814 | $contactList = array( | |
815 | array( | |
816 | 'data' => $name, | |
817 | 'id' => $name | |
818 | ) | |
819 | ); | |
820 | } | |
821 | } | |
822 | } | |
823 | ||
824 | return civicrm_api3_create_success($contactList, $params); | |
825 | } | |
826 | ||
827 | /** | |
828 | * Merges given pair of duplicate contacts. | |
829 | * | |
830 | * @param array $params input parameters | |
831 | * | |
832 | * Allowed @params array keys are: | |
833 | * {int main_id main contact id with whom merge has to happen} | |
834 | * {int other_id duplicate contact which would be deleted after merge operation} | |
835 | * {string mode helps decide how to behave when there are conflicts. | |
836 | * A 'safe' value skips the merge if there are no conflicts. Does a force merge otherwise.} | |
837 | * {boolean auto_flip wether to let api decide which contact to retain and which to delete.} | |
838 | * | |
839 | * @return array API Result Array | |
840 | * | |
841 | * @static void | |
842 | * @access public | |
843 | */ | |
844 | function civicrm_api3_contact_merge($params) { | |
845 | $mode = CRM_Utils_Array::value('mode', $params, 'safe'); | |
846 | $autoFlip = CRM_Utils_Array::value('auto_flip', $params, TRUE); | |
847 | ||
848 | $dupePairs = array(array('srcID' => CRM_Utils_Array::value('main_id', $params), | |
849 | 'dstID' => CRM_Utils_Array::value('other_id', $params), | |
850 | )); | |
851 | $result = CRM_Dedupe_Merger::merge($dupePairs, array(), $mode, $autoFlip); | |
852 | ||
853 | if ($result['is_error'] == 0) { | |
854 | return civicrm_api3_create_success(); | |
855 | } | |
856 | else { | |
857 | return civicrm_api3_create_error($result['messages']); | |
858 | } | |
859 | } | |
860 | ||
861 | function _civicrm_api3_contact_proximity_spec(&$params) { | |
862 | $params['latitude']['api.required'] = 1; | |
863 | $params['longitude']['api.required'] = 1; | |
864 | $params['unit']['api.default'] = 'meter'; | |
865 | } | |
866 | ||
867 | function civicrm_api3_contact_proximity($params) { | |
868 | $latitude = CRM_Utils_Array::value('latitude', $params); | |
869 | $longitude = CRM_Utils_Array::value('longitude', $params); | |
870 | $distance = CRM_Utils_Array::value('distance', $params); | |
871 | ||
872 | $unit = CRM_Utils_Array::value('unit', $params); | |
873 | ||
874 | // check and ensure that lat/long and distance are floats | |
875 | if ( | |
876 | !CRM_Utils_Rule::numeric($latitude) || | |
877 | !CRM_Utils_Rule::numeric($longitude) || | |
878 | !CRM_Utils_Rule::numeric($distance) | |
879 | ) { | |
880 | throw new Exception(ts('Latitude, Longitude and Distance should exist and be numeric')); | |
881 | } | |
882 | ||
883 | if ($unit == "mile") { | |
884 | $conversionFactor = 1609.344; | |
885 | } | |
886 | else { | |
887 | $conversionFactor = 1000; | |
888 | } | |
889 | //Distance in meters | |
890 | $distance = $distance * $conversionFactor; | |
891 | ||
892 | $whereClause = CRM_Contact_BAO_ProximityQuery::where($latitude, $longitude, $distance); | |
893 | ||
894 | $query = " | |
895 | SELECT civicrm_contact.id as contact_id, | |
896 | civicrm_contact.display_name as display_name | |
897 | FROM civicrm_contact | |
898 | LEFT JOIN civicrm_address ON civicrm_contact.id = civicrm_address.contact_id | |
899 | WHERE $whereClause | |
900 | "; | |
901 | ||
902 | $dao = CRM_Core_DAO::executeQuery($query); | |
903 | $contacts = array(); | |
904 | while ($dao->fetch()) { | |
905 | $contacts[] = $dao->toArray(); | |
906 | } | |
907 | ||
908 | return civicrm_api3_create_success($contacts, $params, 'contact', 'get_by_location', $dao); | |
909 | } | |
910 |