3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 * This api exposes CiviCRM contacts.
31 * Contacts are the main entity in CiviCRM and this api is more robust than most.
32 * - Get action allows all params supported by advanced search.
33 * - Create action allows creating several related entities at once (e.g. email).
34 * - Create allows checking for duplicate contacts.
35 * Use getfields to list the full range of parameters and options supported by each action.
37 * @package CiviCRM_APIv3
41 * Create or update a Contact.
43 * @param array $params
46 * @throws API_Exception
51 function civicrm_api3_contact_create($params) {
52 $contactID = CRM_Utils_Array
::value('contact_id', $params, CRM_Utils_Array
::value('id', $params));
54 if ($contactID && !empty($params['check_permissions']) && !CRM_Contact_BAO_Contact_Permission
::allow($contactID, CRM_Core_Permission
::EDIT
)) {
55 throw new \Civi\API\Exception\
UnauthorizedException('Permission denied to modify contact record');
58 if (!empty($params['dupe_check'])) {
59 $ids = CRM_Contact_BAO_Contact
::getDuplicateContacts($params, $params['contact_type'], 'Unsupervised', array(), $params['check_permission']);
60 if (count($ids) > 0) {
61 throw new API_Exception("Found matching contacts: " . implode(',', $ids), "duplicate", array("ids" => $ids));
65 $values = _civicrm_api3_contact_check_params($params);
70 if (array_key_exists('api_key', $params) && !empty($params['check_permissions'])) {
71 if (CRM_Core_Permission
::check('edit api keys') || CRM_Core_Permission
::check('administer CiviCRM')) {
74 elseif ($contactID && CRM_Core_Permission
::check('edit own api keys') && CRM_Core_Session
::singleton()->get('userID') == $contactID) {
78 throw new \Civi\API\Exception\
UnauthorizedException('Permission denied to modify api key');
83 // If we get here, we're ready to create a new contact
84 if (($email = CRM_Utils_Array
::value('email', $params)) && !is_array($params['email'])) {
85 $defLocType = CRM_Core_BAO_LocationType
::getDefault();
86 $params['email'] = array(
90 'location_type_id' => ($defLocType->id
) ?
$defLocType->id
: 1,
96 if (!empty($params['home_url'])) {
97 $websiteTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id');
98 $params['website'] = array(
100 'website_type_id' => key($websiteTypes),
101 'url' => $params['home_url'],
106 _civicrm_api3_greeting_format_params($params);
110 if (empty($params['contact_type']) && $contactID) {
111 $params['contact_type'] = CRM_Contact_BAO_Contact
::getContactType($contactID);
114 if (!isset($params['contact_sub_type']) && $contactID) {
115 $params['contact_sub_type'] = CRM_Contact_BAO_Contact
::getContactSubType($contactID);
118 _civicrm_api3_custom_format_params($params, $values, $params['contact_type'], $contactID);
120 $params = array_merge($params, $values);
121 //@todo we should just call basic_create here - but need to make contact:create accept 'id' on the bao
122 $contact = _civicrm_api3_contact_update($params, $contactID);
124 if (is_a($contact, 'CRM_Core_Error')) {
125 throw new API_Exception($contact->_errors
[0]['message']);
129 _civicrm_api3_object_to_array_unique_fields($contact, $values[$contact->id
]);
132 $values = _civicrm_api3_contact_formatResult($params, $values);
134 return civicrm_api3_create_success($values, $params, 'Contact', 'create');
138 * Adjust Metadata for Create action.
140 * @param array $params
141 * Array of parameters determined by getfields.
143 function _civicrm_api3_contact_create_spec(&$params) {
144 $params['contact_type']['api.required'] = 1;
145 $params['id']['api.aliases'] = array('contact_id');
146 $params['current_employer'] = array(
147 'title' => 'Current Employer',
148 'description' => 'Name of Current Employer',
149 'type' => CRM_Utils_Type
::T_STRING
,
151 $params['dupe_check'] = array(
152 'title' => 'Check for Duplicates',
153 'description' => 'Throw error if contact create matches dedupe rule',
154 'type' => CRM_Utils_Type
::T_BOOLEAN
,
156 $params['prefix_id']['api.aliases'] = array('individual_prefix', 'individual_prefix_id');
157 $params['suffix_id']['api.aliases'] = array('individual_suffix', 'individual_suffix_id');
158 $params['gender_id']['api.aliases'] = array('gender');
162 * Retrieve one or more contacts, given a set of search params.
164 * @param array $params
169 function civicrm_api3_contact_get($params) {
171 _civicrm_api3_contact_get_supportanomalies($params, $options);
172 $contacts = _civicrm_api3_get_using_query_object('Contact', $params, $options);
173 $contacts = _civicrm_api3_contact_formatResult($params, $contacts);
174 return civicrm_api3_create_success($contacts, $params, 'Contact');
180 * @param array $result
183 * @throws \CRM_Core_Exception
185 function _civicrm_api3_contact_formatResult($params, $result) {
186 $apiKeyPerms = array('edit api keys', 'administer CiviCRM');
187 $allowApiKey = empty($params['check_permissions']) || CRM_Core_Permission
::check(array($apiKeyPerms));
189 if (is_array($result)) {
190 // Single-value $result
191 if (isset($result['api_key'])) {
192 unset($result['api_key']);
195 // Multi-value $result
196 foreach ($result as $key => $row) {
197 if (is_array($row)) {
198 unset($result[$key]['api_key']);
207 * Get number of contacts matching the supplied criteria.
209 * @param array $params
213 function civicrm_api3_contact_getcount($params) {
215 _civicrm_api3_contact_get_supportanomalies($params, $options);
216 $count = _civicrm_api3_get_using_query_object('Contact', $params, $options, 1);
221 * Adjust Metadata for Get action.
223 * @param array $params
224 * Array of parameters determined by getfields.
226 function _civicrm_api3_contact_get_spec(&$params) {
227 $params['contact_is_deleted']['api.default'] = 0;
229 // We declare all these pseudoFields as there are other undocumented fields accessible
230 // via the api - but if check permissions is set we only allow declared fields
231 $params['address_id'] = array(
232 'title' => 'Primary Address ID',
233 'type' => CRM_Utils_Type
::T_INT
,
235 $params['street_address'] = array(
236 'title' => 'Primary Address Street Address',
237 'type' => CRM_Utils_Type
::T_STRING
,
239 $params['supplemental_address_1'] = array(
240 'title' => 'Primary Address Supplemental Address 1',
241 'type' => CRM_Utils_Type
::T_STRING
,
243 $params['supplemental_address_2'] = array(
244 'title' => 'Primary Address Supplemental Address 2',
245 'type' => CRM_Utils_Type
::T_STRING
,
247 $params['supplemental_address_3'] = array(
248 'title' => 'Primary Address Supplemental Address 3',
249 'type' => CRM_Utils_Type
::T_STRING
,
251 $params['current_employer'] = array(
252 'title' => 'Current Employer',
253 'type' => CRM_Utils_Type
::T_STRING
,
255 $params['city'] = array(
256 'title' => 'Primary Address City',
257 'type' => CRM_Utils_Type
::T_STRING
,
259 $params['postal_code_suffix'] = array(
260 'title' => 'Primary Address Post Code Suffix',
261 'type' => CRM_Utils_Type
::T_STRING
,
263 $params['postal_code'] = array(
264 'title' => 'Primary Address Post Code',
265 'type' => CRM_Utils_Type
::T_STRING
,
267 $params['geo_code_1'] = array(
268 'title' => 'Primary Address Latitude',
269 'type' => CRM_Utils_Type
::T_STRING
,
271 $params['geo_code_2'] = array(
272 'title' => 'Primary Address Longitude',
273 'type' => CRM_Utils_Type
::T_STRING
,
275 $params['state_province_id'] = array(
276 'title' => 'Primary Address State Province ID',
277 'type' => CRM_Utils_Type
::T_INT
,
278 'pseudoconstant' => array(
279 'table' => 'civicrm_state_province',
282 $params['state_province_name'] = array(
283 'title' => 'Primary Address State Province Name',
284 'type' => CRM_Utils_Type
::T_STRING
,
285 'pseudoconstant' => array(
286 'table' => 'civicrm_state_province',
289 $params['state_province'] = array(
290 'title' => 'Primary Address State Province',
291 'type' => CRM_Utils_Type
::T_STRING
,
292 'pseudoconstant' => array(
293 'table' => 'civicrm_state_province',
296 $params['country_id'] = array(
297 'title' => 'Primary Address Country ID',
298 'type' => CRM_Utils_Type
::T_INT
,
299 'pseudoconstant' => array(
300 'table' => 'civicrm_country',
303 $params['country'] = array(
304 'title' => 'Primary Address country',
305 'type' => CRM_Utils_Type
::T_STRING
,
306 'pseudoconstant' => array(
307 'table' => 'civicrm_country',
310 $params['worldregion_id'] = array(
311 'title' => 'Primary Address World Region ID',
312 'type' => CRM_Utils_Type
::T_INT
,
313 'pseudoconstant' => array(
314 'table' => 'civicrm_world_region',
317 $params['worldregion'] = array(
318 'title' => 'Primary Address World Region',
319 'type' => CRM_Utils_Type
::T_STRING
,
320 'pseudoconstant' => array(
321 'table' => 'civicrm_world_region',
324 $params['phone_id'] = array(
325 'title' => 'Primary Phone ID',
326 'type' => CRM_Utils_Type
::T_INT
,
328 $params['phone'] = array(
329 'title' => 'Primary Phone',
330 'type' => CRM_Utils_Type
::T_STRING
,
332 $params['phone_type_id'] = array(
333 'title' => 'Primary Phone Type ID',
334 'type' => CRM_Utils_Type
::T_INT
,
336 $params['provider_id'] = array(
337 'title' => 'Primary Phone Provider ID',
338 'type' => CRM_Utils_Type
::T_INT
,
340 $params['email_id'] = array(
341 'title' => 'Primary Email ID',
342 'type' => CRM_Utils_Type
::T_INT
,
344 $params['email'] = array(
345 'title' => 'Primary Email',
346 'type' => CRM_Utils_Type
::T_STRING
,
348 $params['on_hold'] = array(
349 'title' => 'Primary Email On Hold',
350 'type' => CRM_Utils_Type
::T_BOOLEAN
,
352 $params['im'] = array(
353 'title' => 'Primary Instant Messenger',
354 'type' => CRM_Utils_Type
::T_STRING
,
356 $params['im_id'] = array(
357 'title' => 'Primary Instant Messenger ID',
358 'type' => CRM_Utils_Type
::T_INT
,
360 $params['group'] = array(
362 'pseudoconstant' => array(
363 'table' => 'civicrm_group',
366 $params['tag'] = array(
368 'pseudoconstant' => array(
369 'table' => 'civicrm_tag',
372 $params['birth_date_low'] = array('name' => 'birth_date_low', 'type' => CRM_Utils_Type
::T_DATE
, 'title' => ts('Birth Date is equal to or greater than'));
373 $params['birth_date_high'] = array('name' => 'birth_date_high', 'type' => CRM_Utils_Type
::T_DATE
, 'title' => ts('Birth Date is equal to or less than'));
374 $params['deceased_date_low'] = array('name' => 'deceased_date_low', 'type' => CRM_Utils_Type
::T_DATE
, 'title' => ts('Deceased Date is equal to or greater than'));
375 $params['deceased_date_high'] = array('name' => 'deceased_date_high', 'type' => CRM_Utils_Type
::T_DATE
, 'title' => ts('Deceased Date is equal to or less than'));
379 * Support for historical oddities.
381 * We are supporting 'showAll' = 'all', 'trash' or 'active' for Contact get
383 * - hopefully some day we'll come up with a std syntax for the 3-way-boolean of
386 * We also support 'filter_group_id' & 'filter.group_id'
388 * @param array $params
389 * As passed into api get or getcount function.
390 * @param array $options
391 * Array of options (so we can modify the filter).
393 function _civicrm_api3_contact_get_supportanomalies(&$params, &$options) {
394 if (isset($params['showAll'])) {
395 if (strtolower($params['showAll']) == "active") {
396 $params['contact_is_deleted'] = 0;
398 if (strtolower($params['showAll']) == "trash") {
399 $params['contact_is_deleted'] = 1;
401 if (strtolower($params['showAll']) == "all" && isset($params['contact_is_deleted'])) {
402 unset($params['contact_is_deleted']);
405 // support for group filters
406 if (array_key_exists('filter_group_id', $params)) {
407 $params['filter.group_id'] = $params['filter_group_id'];
408 unset($params['filter_group_id']);
410 // filter.group_id works both for 1,2,3 and array (1,2,3)
411 if (array_key_exists('filter.group_id', $params)) {
412 if (is_array($params['filter.group_id'])) {
413 $groups = $params['filter.group_id'];
416 $groups = explode(',', $params['filter.group_id']);
418 unset($params['filter.group_id']);
419 $options['input_params']['group'] = $groups;
421 if (isset($params['group'])) {
422 $groups = $params['group'];
423 $allGroups = CRM_Core_PseudoConstant
::group();
424 if (is_array($groups) && in_array(key($groups), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
425 // Get the groups array.
426 $groupsArray = $groups[key($groups)];
427 foreach ($groupsArray as &$group) {
428 if (!is_numeric($group) && array_search($group, $allGroups)) {
429 $group = array_search($group, $allGroups);
432 // Now reset the $groups array with the ids not the titles.
433 $groups[key($groups)] = $groupsArray;
435 // handle format like 'group' => array('title1', 'title2').
436 elseif (is_array($groups)) {
437 foreach ($groups as $k => &$group) {
438 if (!is_numeric($group) && array_search($group, $allGroups)) {
439 $group = array_search($group, $allGroups);
441 if (!is_numeric($k) && array_search($k, $allGroups)) {
443 $groups[array_search($k, $allGroups)] = $group;
447 elseif (!is_numeric($groups) && array_search($groups, $allGroups)) {
448 $groups = array_search($groups, $allGroups);
450 $params['group'] = $groups;
455 * Delete a Contact with given contact_id.
457 * @param array $params
458 * input parameters per getfields
460 * @throws \Civi\API\Exception\UnauthorizedException
464 function civicrm_api3_contact_delete($params) {
465 $contactID = CRM_Utils_Array
::value('id', $params);
467 if (!empty($params['check_permissions']) && !CRM_Contact_BAO_Contact_Permission
::allow($contactID, CRM_Core_Permission
::DELETE
)) {
468 throw new \Civi\API\Exception\
UnauthorizedException('Permission denied to modify contact record');
471 $session = CRM_Core_Session
::singleton();
472 if ($contactID == $session->get('userID')) {
473 return civicrm_api3_create_error('This contact record is linked to the currently logged in user account - and cannot be deleted.');
475 $restore = !empty($params['restore']) ?
$params['restore'] : FALSE;
476 $skipUndelete = !empty($params['skip_undelete']) ?
$params['skip_undelete'] : FALSE;
479 // restrict permanent delete if a contact has financial trxn associated with it
481 if ($skipUndelete && CRM_Financial_BAO_FinancialItem
::checkContactPresent(array($contactID), $error)) {
482 return civicrm_api3_create_error($error['_qf_default']);
484 if (CRM_Contact_BAO_Contact
::deleteContact($contactID, $restore, $skipUndelete,
485 CRM_Utils_Array
::value('check_permissions', $params))) {
486 return civicrm_api3_create_success();
489 return civicrm_api3_create_error('Could not delete contact');
495 * Check parameters passed in.
497 * This function is on it's way out.
499 * @param array $params
502 * @throws API_Exception
503 * @throws CiviCRM_API3_Exception
505 function _civicrm_api3_contact_check_params(&$params) {
507 switch (strtolower(CRM_Utils_Array
::value('contact_type', $params))) {
509 civicrm_api3_verify_mandatory($params, NULL, array('household_name'));
513 civicrm_api3_verify_mandatory($params, NULL, array('organization_name'));
517 civicrm_api3_verify_one_mandatory($params, NULL, array(
527 // Fixme: This really needs to be handled at a lower level. @See CRM-13123
528 if (isset($params['preferred_communication_method'])) {
529 $params['preferred_communication_method'] = CRM_Utils_Array
::implodePadded($params['preferred_communication_method']);
532 if (!empty($params['contact_sub_type']) && !empty($params['contact_type'])) {
533 if (!(CRM_Contact_BAO_ContactType
::isExtendsContactType($params['contact_sub_type'], $params['contact_type']))) {
534 throw new API_Exception("Invalid or Mismatched Contact Subtype: " . implode(', ', (array) $params['contact_sub_type']));
538 // The BAO no longer supports the legacy param "current_employer" so here is a shim for api backward-compatability
539 if (!empty($params['current_employer'])) {
540 $organizationParams = array(
541 'organization_name' => $params['current_employer'],
544 $dupeIds = CRM_Contact_BAO_Contact
::getDuplicateContacts($organizationParams, 'Organization', 'Supervised', array(), FALSE);
546 // check for mismatch employer name and id
547 if (!empty($params['employer_id']) && !in_array($params['employer_id'], $dupeIds)) {
548 throw new API_Exception('Employer name and Employer id Mismatch');
551 // show error if multiple organisation with same name exist
552 if (empty($params['employer_id']) && (count($dupeIds) > 1)) {
553 throw new API_Exception('Found more than one Organisation with same Name.');
557 $params['employer_id'] = $dupeIds[0];
560 $result = civicrm_api3('Contact', 'create', array(
561 'organization_name' => $params['current_employer'],
562 'contact_type' => 'Organization',
564 $params['employer_id'] = $result['id'];
572 * Helper function for Contact create.
574 * @param array $params
575 * (reference ) an assoc array of name/value pairs.
576 * @param int $contactID
577 * If present the contact with that ID is updated.
579 * @return CRM_Contact_BAO_Contact|CRM_Core_Error
581 function _civicrm_api3_contact_update($params, $contactID = NULL) {
582 //@todo - doesn't contact create support 'id' which is already set- check & remove
584 $params['contact_id'] = $contactID;
587 return CRM_Contact_BAO_Contact
::create($params);
591 * Validate the addressee or email or postal greetings.
593 * @param array $params
594 * Array per getfields metadata.
596 * @throws API_Exception
598 function _civicrm_api3_greeting_format_params($params) {
599 $greetingParams = array('', '_id', '_custom');
600 foreach (array('email', 'postal', 'addressee') as $key) {
601 $greeting = '_greeting';
602 if ($key == 'addressee') {
606 $formatParams = FALSE;
607 // Unset display value from params.
608 if (isset($params["{$key}{$greeting}_display"])) {
609 unset($params["{$key}{$greeting}_display"]);
612 // check if greetings are present in present
613 foreach ($greetingParams as $greetingValues) {
614 if (array_key_exists("{$key}{$greeting}{$greetingValues}", $params)) {
615 $formatParams = TRUE;
620 if (!$formatParams) {
626 'contact_type' => $params['contact_type'],
627 'greeting_type' => "{$key}{$greeting}",
630 $greetings = CRM_Core_PseudoConstant
::greeting($filter);
631 $greetingId = CRM_Utils_Array
::value("{$key}{$greeting}_id", $params);
632 $greetingVal = CRM_Utils_Array
::value("{$key}{$greeting}", $params);
633 $customGreeting = CRM_Utils_Array
::value("{$key}{$greeting}_custom", $params);
635 if (!$greetingId && $greetingVal) {
636 $params["{$key}{$greeting}_id"] = CRM_Utils_Array
::key($params["{$key}{$greeting}"], $greetings);
639 if ($customGreeting && $greetingId &&
640 ($greetingId != array_search('Customized', $greetings))
642 throw new API_Exception(ts('Provide either %1 greeting id and/or %1 greeting or custom %1 greeting',
647 if ($greetingVal && $greetingId &&
648 ($greetingId != CRM_Utils_Array
::key($greetingVal, $greetings))
650 throw new API_Exception(ts('Mismatch in %1 greeting id and %1 greeting',
657 if (!array_key_exists($greetingId, $greetings)) {
658 throw new API_Exception(ts('Invalid %1 greeting Id', array(1 => $key)));
661 if (!$customGreeting && ($greetingId == array_search('Customized', $greetings))) {
662 throw new API_Exception(ts('Please provide a custom value for %1 greeting',
667 elseif ($greetingVal) {
669 if (!in_array($greetingVal, $greetings)) {
670 throw new API_Exception(ts('Invalid %1 greeting', array(1 => $key)));
673 $greetingId = CRM_Utils_Array
::key($greetingVal, $greetings);
676 if ($customGreeting) {
677 $greetingId = CRM_Utils_Array
::key('Customized', $greetings);
680 $customValue = isset($params['contact_id']) ? CRM_Core_DAO
::getFieldValue(
681 'CRM_Contact_DAO_Contact',
682 $params['contact_id'],
683 "{$key}{$greeting}_custom"
686 if (array_key_exists("{$key}{$greeting}_id", $params) && empty($params["{$key}{$greeting}_id"])) {
689 elseif (array_key_exists("{$key}{$greeting}", $params) && empty($params["{$key}{$greeting}"])) {
692 elseif ($customValue && array_key_exists("{$key}{$greeting}_custom", $params)
693 && empty($params["{$key}{$greeting}_custom"])
698 $params["{$key}{$greeting}_id"] = $greetingId;
700 if (!$customValue && !$customGreeting && array_key_exists("{$key}{$greeting}_custom", $params)) {
701 unset($params["{$key}{$greeting}_custom"]);
705 $params["{$key}{$greeting}_id"] = '';
706 $params["{$key}{$greeting}_custom"] = '';
709 if (isset($params["{$key}{$greeting}"])) {
710 unset($params["{$key}{$greeting}"]);
716 * Adjust Metadata for Get action.
718 * @param array $params
719 * Array of parameters determined by getfields.
721 function _civicrm_api3_contact_getquick_spec(&$params) {
722 $params['name']['api.required'] = TRUE;
723 $params['name']['title'] = ts('String to search on');
724 $params['name']['type'] = CRM_Utils_Type
::T_STRING
;
725 $params['field']['type'] = CRM_Utils_Type
::T_STRING
;
726 $params['field']['title'] = ts('Field to search on');
727 $params['field']['options'] = array(
731 'external_identifier',
741 $params['table_name']['type'] = CRM_Utils_Type
::T_STRING
;
742 $params['table_name']['title'] = ts('Table alias to search on');
743 $params['table_name']['api.default'] = 'cc';
747 * Old Contact quick search api.
751 * @param array $params
754 * @throws \API_Exception
756 function civicrm_api3_contact_getquick($params) {
757 $name = CRM_Utils_Type
::escape(CRM_Utils_Array
::value('name', $params), 'String');
758 $table_name = CRM_Utils_String
::munge($params['table_name']);
759 // get the autocomplete options from settings
760 $acpref = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
761 CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
762 'contact_autocomplete_options'
766 // get the option values for contact autocomplete
767 $acOptions = CRM_Core_OptionGroup
::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name');
770 foreach ($acpref as $value) {
771 if ($value && !empty($acOptions[$value])) {
772 $list[$value] = $acOptions[$value];
775 // If we are doing quicksearch by a field other than name, make sure that field is added to results
776 if (!empty($params['field_name'])) {
777 $field_name = CRM_Utils_String
::munge($params['field_name']);
778 // Unique name contact_id = id
779 if ($field_name == 'contact_id') {
782 // phone_numeric should be phone
783 $searchField = str_replace('_numeric', '', $field_name);
784 if (!in_array($searchField, $list)) {
785 $list[] = $searchField;
789 // Set field name to first name for exact match checking.
790 $field_name = 'sort_name';
793 $select = $actualSelectElements = array('sort_name');
796 foreach ($list as $value) {
797 $suffix = substr($value, 0, 2) . substr($value, -1);
799 case 'street_address':
802 $selectText = $value;
807 $actualSelectElements[] = $select[] = ($value == 'address') ?
$selectText : $value;
808 if ($value == 'phone') {
809 $actualSelectElements[] = $select[] = 'phone_ext';
811 $from[$value] = "LEFT JOIN civicrm_{$value} {$suffix} ON ( cc.id = {$suffix}.contact_id AND {$suffix}.is_primary = 1 ) ";
815 case 'state_province':
816 $select[] = "{$suffix}.name as {$value}";
817 $actualSelectElements[] = "{$suffix}.name";
818 if (!in_array('address', $from)) {
819 $from['address'] = 'LEFT JOIN civicrm_address sts ON ( cc.id = sts.contact_id AND sts.is_primary = 1) ';
821 $from[$value] = " LEFT JOIN civicrm_{$value} {$suffix} ON ( sts.{$value}_id = {$suffix}.id ) ";
825 if ($value != 'id') {
827 if (!empty($params['field_name']) && $params['field_name'] == 'value') {
828 $suffix = CRM_Utils_String
::munge(CRM_Utils_Array
::value('table_name', $params, 'cc'));
830 $actualSelectElements[] = $select[] = $suffix . '.' . $value;
836 $config = CRM_Core_Config
::singleton();
838 $select = implode(', ', $select);
839 if (!empty($select)) {
840 $select = ", $select";
842 $actualSelectElements = implode(', ', $actualSelectElements);
843 $selectAliases = $from;
844 unset($selectAliases['address']);
845 $selectAliases = implode(', ', array_keys($selectAliases));
846 if (!empty($selectAliases)) {
847 $selectAliases = ", $selectAliases";
849 $from = implode(' ', $from);
850 $limit = (int) CRM_Utils_Array
::value('limit', $params);
851 $limit = $limit > 0 ?
$limit : Civi
::settings()->get('search_autocomplete_count');
853 // add acl clause here
854 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause('cc');
857 $where .= " AND $aclWhere ";
859 $isPrependWildcard = \Civi
::settings()->get('includeWildCardInName');
861 if (!empty($params['org'])) {
862 $where .= " AND contact_type = \"Organization\"";
864 // CRM-7157, hack: get current employer details when
865 // employee_id is present.
866 $currEmpDetails = array();
867 if (!empty($params['employee_id'])) {
868 if ($currentEmployer = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
869 (int) $params['employee_id'],
872 if ($isPrependWildcard) {
873 $strSearch = "%$name%";
876 $strSearch = "$name%";
879 // get current employer details
880 $dao = CRM_Core_DAO
::executeQuery("SELECT cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data, sort_name
881 FROM civicrm_contact cc {$from} WHERE cc.contact_type = \"Organization\" AND cc.id = {$currentEmployer} AND cc.sort_name LIKE '$strSearch'");
883 $currEmpDetails = array(
885 'data' => $dao->data
,
892 if (!empty($params['contact_sub_type'])) {
893 $contactSubType = CRM_Utils_Type
::escape($params['contact_sub_type'], 'String');
894 $where .= " AND cc.contact_sub_type = '{$contactSubType}'";
897 if (!empty($params['contact_type'])) {
898 $contactType = CRM_Utils_Type
::escape($params['contact_type'], 'String');
899 $where .= " AND cc.contact_type LIKE '{$contactType}'";
902 // Set default for current_employer or return contact with particular id
903 if (!empty($params['id'])) {
904 $where .= " AND cc.id = " . (int) $params['id'];
907 if (!empty($params['cid'])) {
908 $where .= " AND cc.id <> " . (int) $params['cid'];
911 // Contact's based of relationhip type
913 if (!empty($params['rel'])) {
914 $relation = explode('_', CRM_Utils_Array
::value('rel', $params));
915 $relType = CRM_Utils_Type
::escape($relation[0], 'Integer');
916 $rel = CRM_Utils_Type
::escape($relation[2], 'String');
919 if ($isPrependWildcard) {
920 $strSearch = "%$name%";
923 $strSearch = "$name%";
925 $includeEmailFrom = $includeNickName = $exactIncludeNickName = '';
926 if ($config->includeNickNameInName
) {
927 $includeNickName = " OR nick_name LIKE '$strSearch'";
928 $exactIncludeNickName = " OR nick_name LIKE '$name'";
932 if (!empty($params['field_name']) && !empty($params['table_name'])) {
933 $whereClause = " WHERE ( $table_name.$field_name LIKE '$strSearch') {$where}";
934 // Search by id should be exact
935 if ($field_name == 'id' ||
$field_name == 'external_identifier') {
936 $whereClause = " WHERE ( $table_name.$field_name = '$name') {$where}";
940 $whereClause = " WHERE ( sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
941 if ($config->includeEmailInName
) {
942 if (!in_array('email', $list)) {
943 $includeEmailFrom = "LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )";
945 $emailWhere = " WHERE email LIKE '$strSearch'";
949 $additionalFrom = '';
952 INNER JOIN civicrm_relationship_type r ON (
954 AND ( cc.contact_type = r.contact_type_{$rel} OR r.contact_type_{$rel} IS NULL )
955 AND ( cc.contact_sub_type = r.contact_sub_type_{$rel} OR r.contact_sub_type_{$rel} IS NULL )
959 // check if only CMS users are requested
960 if (!empty($params['cmsuser'])) {
962 INNER JOIN civicrm_uf_match um ON (um.contact_id=cc.id)
965 $orderBy = _civicrm_api3_quicksearch_get_order_by($name, $isPrependWildcard, $field_name);
969 SELECT DISTINCT(id), data, sort_name {$selectAliases}, exactFirst
971 ( SELECT IF($table_name.$field_name = '{$name}', 0, 1) as exactFirst, cc.id as id, CONCAT_WS( ' :: ',
972 {$actualSelectElements} )
975 FROM civicrm_contact cc {$from}
983 if (!empty($emailWhere)) {
986 SELECT IF($table_name.$field_name = '{$name}', 0, 1) as exactFirst, cc.id as id, CONCAT_WS( ' :: ',
987 {$actualSelectElements} )
990 FROM civicrm_contact cc {$from}
992 {$additionalFrom} {$includeEmailFrom}
993 {$emailWhere} AND cc.is_deleted = 0 " . ($aclWhere ?
" AND $aclWhere " : '') . "
1004 // send query to hook to be modified if needed
1005 CRM_Utils_Hook
::contactListQuery($query,
1007 empty($params['context']) ?
NULL : CRM_Utils_Type
::escape($params['context'], 'String'),
1008 empty($params['id']) ?
NULL : $params['id']
1011 $dao = CRM_Core_DAO
::executeQuery($query);
1013 $contactList = array();
1014 $listCurrentEmployer = TRUE;
1015 while ($dao->fetch()) {
1016 $t = array('id' => $dao->id
);
1017 foreach ($as as $k) {
1018 $t[$k] = isset($dao->$k) ?
$dao->$k : '';
1020 $t['data'] = $dao->data
;
1021 $contactList[] = $t;
1022 if (!empty($params['org']) &&
1023 !empty($currEmpDetails) &&
1024 $dao->id
== $currEmpDetails['id']
1026 $listCurrentEmployer = FALSE;
1030 //return organization name if doesn't exist in db
1031 if (empty($contactList)) {
1032 if (!empty($params['org'])) {
1033 if ($listCurrentEmployer && !empty($currEmpDetails)) {
1034 $contactList = array(
1036 'data' => $currEmpDetails['data'],
1037 'id' => $currEmpDetails['id'],
1042 $contactList = array(
1052 return civicrm_api3_create_success($contactList, $params, 'Contact', 'getquick');
1056 * Get the order by string for the quicksearch query.
1058 * Get the order by string. The string might be
1059 * - sort name if there is no search value provided and the site is configured
1060 * to search by sort name
1061 * - empty if there is no search value provided and the site is not configured
1062 * to search by sort name
1063 * - exactFirst and then sort name if a search value is provided and the site is configured
1064 * to search by sort name
1065 * - exactFirst if a search value is provided and the site is not configured
1066 * to search by sort name
1068 * exactFirst means 'yes if the search value exactly matches the searched field. else no'.
1069 * It is intended to prioritise exact matches for the entered string so on a first name search
1070 * for 'kath' contacts with a first name of exactly Kath rise to the top.
1072 * On short strings it is expensive. Per CRM-19547 there is still an open question
1073 * as to whether we should only do exactMatch on a minimum length or on certain fields.
1075 * However, we have mitigated this somewhat by not doing an exact match search on
1076 * empty strings, non-wildcard sort-name searches and email searches where there is
1077 * no @ after the first character.
1079 * For the user it is further mitigated by the fact they just don't know the
1080 * slower queries are firing. If they type 'smit' slowly enough 4 queries will trigger
1081 * but if the first 3 are slow the first result they see may be off the 4th query.
1083 * @param string $name
1084 * @param bool $isPrependWildcard
1085 * @param string $field_name
1089 function _civicrm_api3_quicksearch_get_order_by($name, $isPrependWildcard, $field_name) {
1090 $skipExactMatch = ($name === '%');
1091 if ($field_name === 'email' && !strpos('@', $name)) {
1092 $skipExactMatch = TRUE;
1095 if (!\Civi
::settings()->get('includeOrderByClause')) {
1096 return $skipExactMatch ?
'' : "ORDER BY exactFirst";
1098 if ($skipExactMatch ||
(!$isPrependWildcard && $field_name === 'sort_name')) {
1099 // If there is no wildcard then sorting by exactFirst would have the same
1100 // effect as just a sort_name search, but slower.
1101 return "ORDER BY sort_name";
1104 return "ORDER BY exactFirst, sort_name";
1108 * Declare deprecated api functions.
1110 * @deprecated api notice
1112 * Array of deprecated actions
1114 function _civicrm_api3_contact_deprecation() {
1115 return array('getquick' => 'The "getquick" action is deprecated in favor of "getlist".');
1119 * Merges given pair of duplicate contacts.
1121 * @param array $params
1122 * Allowed array keys are:
1123 * -int main_id: main contact id with whom merge has to happen
1124 * -int other_id: duplicate contact which would be deleted after merge operation
1125 * -string mode: "safe" skips the merge if there are no conflicts. Does a force merge otherwise.
1129 * @throws API_Exception
1131 function civicrm_api3_contact_merge($params) {
1132 if (($result = CRM_Dedupe_Merger
::merge(array(
1134 'srcID' => $params['to_remove_id'],
1135 'dstID' => $params['to_keep_id'],
1137 ), array(), $params['mode'])) != FALSE) {
1138 return civicrm_api3_create_success($result, $params);
1140 throw new API_Exception('Merge failed');
1144 * Adjust metadata for contact_merge api function.
1146 * @param array $params
1148 function _civicrm_api3_contact_merge_spec(&$params) {
1149 $params['to_remove_id'] = array(
1150 'title' => 'ID of the contact to merge & remove',
1151 'description' => ts('Wow - these 2 params are the logical reverse of what I expect - but what to do?'),
1152 'api.required' => 1,
1153 'type' => CRM_Utils_Type
::T_INT
,
1154 'api.aliases' => array('main_id'),
1156 $params['to_keep_id'] = array(
1157 'title' => 'ID of the contact to keep',
1158 'description' => ts('Wow - these 2 params are the logical reverse of what I expect - but what to do?'),
1159 'api.required' => 1,
1160 'type' => CRM_Utils_Type
::T_INT
,
1161 'api.aliases' => array('other_id'),
1163 $params['mode'] = array(
1164 // @todo need more detail on what this means.
1165 'title' => 'Dedupe mode',
1166 'api.default' => 'safe',
1171 * Adjust metadata for contact_proximity api function.
1173 * @param array $params
1175 function _civicrm_api3_contact_proximity_spec(&$params) {
1176 $params['latitude'] = array(
1177 'title' => 'Latitude',
1178 'api.required' => 1,
1179 'type' => CRM_Utils_Type
::T_STRING
,
1181 $params['longitude'] = array(
1182 'title' => 'Longitude',
1183 'api.required' => 1,
1184 'type' => CRM_Utils_Type
::T_STRING
,
1187 $params['unit'] = array(
1188 'title' => 'Unit of Measurement',
1189 'api.default' => 'meter',
1190 'type' => CRM_Utils_Type
::T_STRING
,
1195 * Get contacts by proximity.
1197 * @param array $params
1202 function civicrm_api3_contact_proximity($params) {
1203 $latitude = CRM_Utils_Array
::value('latitude', $params);
1204 $longitude = CRM_Utils_Array
::value('longitude', $params);
1205 $distance = CRM_Utils_Array
::value('distance', $params);
1207 $unit = CRM_Utils_Array
::value('unit', $params);
1209 // check and ensure that lat/long and distance are floats
1211 !CRM_Utils_Rule
::numeric($latitude) ||
1212 !CRM_Utils_Rule
::numeric($longitude) ||
1213 !CRM_Utils_Rule
::numeric($distance)
1215 throw new Exception(ts('Latitude, Longitude and Distance should exist and be numeric'));
1218 if ($unit == "mile") {
1219 $conversionFactor = 1609.344;
1222 $conversionFactor = 1000;
1224 //Distance in meters
1225 $distance = $distance * $conversionFactor;
1227 $whereClause = CRM_Contact_BAO_ProximityQuery
::where($latitude, $longitude, $distance);
1230 SELECT civicrm_contact.id as contact_id,
1231 civicrm_contact.display_name as display_name
1232 FROM civicrm_contact
1233 LEFT JOIN civicrm_address ON civicrm_contact.id = civicrm_address.contact_id
1237 $dao = CRM_Core_DAO
::executeQuery($query);
1238 $contacts = array();
1239 while ($dao->fetch()) {
1240 $contacts[] = $dao->toArray();
1243 return civicrm_api3_create_success($contacts, $params, 'Contact', 'get_by_location', $dao);
1248 * Get parameters for getlist function.
1250 * @see _civicrm_api3_generic_getlist_params
1252 * @param array $request
1254 function _civicrm_api3_contact_getlist_params(&$request) {
1255 // get the autocomplete options from settings
1256 $acpref = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1257 CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1258 'contact_autocomplete_options'
1262 // get the option values for contact autocomplete
1263 $acOptions = CRM_Core_OptionGroup
::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name');
1266 foreach ($acpref as $value) {
1267 if ($value && !empty($acOptions[$value])) {
1268 $list[] = $acOptions[$value];
1271 // If we are doing quicksearch by a field other than name, make sure that field is added to results
1272 $field_name = CRM_Utils_String
::munge($request['search_field']);
1273 // Unique name contact_id = id
1274 if ($field_name == 'contact_id') {
1277 // phone_numeric should be phone
1278 $searchField = str_replace('_numeric', '', $field_name);
1279 if (!in_array($searchField, $list)) {
1280 $list[] = $searchField;
1282 $request['description_field'] = $list;
1283 $list[] = 'contact_type';
1284 $request['params']['return'] = array_unique(array_merge($list, $request['extra']));
1285 $request['params']['options']['sort'] = 'sort_name';
1286 // Contact api doesn't support array(LIKE => 'foo') syntax
1287 if (!empty($request['input'])) {
1288 $request['params'][$request['search_field']] = $request['input'];
1289 // Temporarily override wildcard setting
1290 if (Civi
::settings()->get('includeWildCardInName') != $request['add_wildcard']) {
1291 Civi
::$statics['civicrm_api3_contact_getlist']['override_wildcard'] = !$request['add_wildcard'];
1292 Civi
::settings()->set('includeWildCardInName', $request['add_wildcard']);
1298 * Get output for getlist function.
1300 * @see _civicrm_api3_generic_getlist_output
1302 * @param array $result
1303 * @param array $request
1307 function _civicrm_api3_contact_getlist_output($result, $request) {
1309 if (!empty($result['values'])) {
1310 $addressFields = array_intersect(array(
1316 $request['params']['return']);
1317 foreach ($result['values'] as $row) {
1319 'id' => $row[$request['id_field']],
1320 'label' => $row[$request['label_field']],
1321 'description' => array(),
1323 foreach ($request['description_field'] as $item) {
1324 if (!strpos($item, '_name') && !in_array($item, $addressFields) && !empty($row[$item])) {
1325 $data['description'][] = $row[$item];
1329 foreach ($addressFields as $item) {
1330 if (!empty($row[$item])) {
1331 $address[] = $row[$item];
1335 $data['description'][] = implode(' ', $address);
1337 if (!empty($request['image_field'])) {
1338 $data['image'] = isset($row[$request['image_field']]) ?
$row[$request['image_field']] : '';
1341 $data['icon_class'] = $row['contact_type'];
1346 // Restore wildcard override by _civicrm_api3_contact_getlist_params
1347 if (isset(Civi
::$statics['civicrm_api3_contact_getlist']['override_wildcard'])) {
1348 Civi
::settings()->set('includeWildCardInName', Civi
::$statics['civicrm_api3_contact_getlist']['override_wildcard']);
1349 unset(Civi
::$statics['civicrm_api3_contact_getlist']['override_wildcard']);
1355 * Check for duplicate contacts.
1357 * @param array $params
1358 * Params per getfields metadata.
1361 * API formatted array
1363 function civicrm_api3_contact_duplicatecheck($params) {
1364 $dupes = CRM_Contact_BAO_Contact
::getDuplicateContacts(
1366 $params['match']['contact_type'],
1369 CRM_Utils_Array
::value('check_permissions', $params),
1370 CRM_Utils_Array
::value('dedupe_rule_id', $params)
1372 $values = empty($dupes) ?
array() : array_fill_keys($dupes, array());
1373 return civicrm_api3_create_success($values, $params, 'Contact', 'duplicatecheck');
1377 * Declare metadata for contact dedupe function.
1381 function _civicrm_api3_contact_duplicatecheck_spec(&$params) {
1382 $params['dedupe_rule_id'] = array(
1383 'title' => 'Dedupe Rule ID (optional)',
1384 'description' => 'This will default to the built in unsupervised rule',
1385 'type' => CRM_Utils_Type
::T_INT
,
1387 // @todo declare 'match' parameter. We don't have a standard for type = array yet.