3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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['skip_greeting_processing'] = array(
157 'title' => 'Skip Greeting processing',
158 'description' => 'Do not process greetings, (these can be done by scheduled job and there may be a preference to do so for performance reasons)',
159 'type' => CRM_Utils_Type
::T_BOOLEAN
,
162 $params['prefix_id']['api.aliases'] = array('individual_prefix', 'individual_prefix_id');
163 $params['suffix_id']['api.aliases'] = array('individual_suffix', 'individual_suffix_id');
164 $params['gender_id']['api.aliases'] = array('gender');
168 * Retrieve one or more contacts, given a set of search params.
170 * @param array $params
175 function civicrm_api3_contact_get($params) {
177 _civicrm_api3_contact_get_supportanomalies($params, $options);
178 $contacts = _civicrm_api3_get_using_query_object('Contact', $params, $options);
179 $contacts = _civicrm_api3_contact_formatResult($params, $contacts);
180 return civicrm_api3_create_success($contacts, $params, 'Contact');
186 * @param array $result
189 * @throws \CRM_Core_Exception
191 function _civicrm_api3_contact_formatResult($params, $result) {
192 $apiKeyPerms = array('edit api keys', 'administer CiviCRM');
193 $allowApiKey = empty($params['check_permissions']) || CRM_Core_Permission
::check(array($apiKeyPerms));
195 if (is_array($result)) {
196 // Single-value $result
197 if (isset($result['api_key'])) {
198 unset($result['api_key']);
201 // Multi-value $result
202 foreach ($result as $key => $row) {
203 if (is_array($row)) {
204 unset($result[$key]['api_key']);
213 * Get number of contacts matching the supplied criteria.
215 * @param array $params
219 function civicrm_api3_contact_getcount($params) {
221 _civicrm_api3_contact_get_supportanomalies($params, $options);
222 $count = _civicrm_api3_get_using_query_object('Contact', $params, $options, 1);
227 * Adjust Metadata for Get action.
229 * @param array $params
230 * Array of parameters determined by getfields.
232 function _civicrm_api3_contact_get_spec(&$params) {
233 $params['contact_is_deleted']['api.default'] = 0;
235 // We declare all these pseudoFields as there are other undocumented fields accessible
236 // via the api - but if check permissions is set we only allow declared fields
237 $params['address_id'] = array(
238 'title' => 'Primary Address ID',
239 'type' => CRM_Utils_Type
::T_INT
,
241 $params['street_address'] = array(
242 'title' => 'Primary Address Street Address',
243 'type' => CRM_Utils_Type
::T_STRING
,
245 $params['supplemental_address_1'] = array(
246 'title' => 'Primary Address Supplemental Address 1',
247 'type' => CRM_Utils_Type
::T_STRING
,
249 $params['supplemental_address_2'] = array(
250 'title' => 'Primary Address Supplemental Address 2',
251 'type' => CRM_Utils_Type
::T_STRING
,
253 $params['supplemental_address_3'] = array(
254 'title' => 'Primary Address Supplemental Address 3',
255 'type' => CRM_Utils_Type
::T_STRING
,
257 $params['current_employer'] = array(
258 'title' => 'Current Employer',
259 'type' => CRM_Utils_Type
::T_STRING
,
261 $params['city'] = array(
262 'title' => 'Primary Address City',
263 'type' => CRM_Utils_Type
::T_STRING
,
265 $params['postal_code_suffix'] = array(
266 'title' => 'Primary Address Post Code Suffix',
267 'type' => CRM_Utils_Type
::T_STRING
,
269 $params['postal_code'] = array(
270 'title' => 'Primary Address Post Code',
271 'type' => CRM_Utils_Type
::T_STRING
,
273 $params['geo_code_1'] = array(
274 'title' => 'Primary Address Latitude',
275 'type' => CRM_Utils_Type
::T_STRING
,
277 $params['geo_code_2'] = array(
278 'title' => 'Primary Address Longitude',
279 'type' => CRM_Utils_Type
::T_STRING
,
281 $params['state_province_id'] = array(
282 'title' => 'Primary Address State Province ID',
283 'type' => CRM_Utils_Type
::T_INT
,
284 'pseudoconstant' => array(
285 'table' => 'civicrm_state_province',
288 $params['state_province_name'] = array(
289 'title' => 'Primary Address State Province Name',
290 'type' => CRM_Utils_Type
::T_STRING
,
291 'pseudoconstant' => array(
292 'table' => 'civicrm_state_province',
295 $params['state_province'] = array(
296 'title' => 'Primary Address State Province',
297 'type' => CRM_Utils_Type
::T_STRING
,
298 'pseudoconstant' => array(
299 'table' => 'civicrm_state_province',
302 $params['country_id'] = array(
303 'title' => 'Primary Address Country ID',
304 'type' => CRM_Utils_Type
::T_INT
,
305 'pseudoconstant' => array(
306 'table' => 'civicrm_country',
309 $params['country'] = array(
310 'title' => 'Primary Address country',
311 'type' => CRM_Utils_Type
::T_STRING
,
312 'pseudoconstant' => array(
313 'table' => 'civicrm_country',
316 $params['worldregion_id'] = array(
317 'title' => 'Primary Address World Region ID',
318 'type' => CRM_Utils_Type
::T_INT
,
319 'pseudoconstant' => array(
320 'table' => 'civicrm_world_region',
323 $params['worldregion'] = array(
324 'title' => 'Primary Address World Region',
325 'type' => CRM_Utils_Type
::T_STRING
,
326 'pseudoconstant' => array(
327 'table' => 'civicrm_world_region',
330 $params['phone_id'] = array(
331 'title' => 'Primary Phone ID',
332 'type' => CRM_Utils_Type
::T_INT
,
334 $params['phone'] = array(
335 'title' => 'Primary Phone',
336 'type' => CRM_Utils_Type
::T_STRING
,
338 $params['phone_type_id'] = array(
339 'title' => 'Primary Phone Type ID',
340 'type' => CRM_Utils_Type
::T_INT
,
342 $params['provider_id'] = array(
343 'title' => 'Primary Phone Provider ID',
344 'type' => CRM_Utils_Type
::T_INT
,
346 $params['email_id'] = array(
347 'title' => 'Primary Email ID',
348 'type' => CRM_Utils_Type
::T_INT
,
350 $params['email'] = array(
351 'title' => 'Primary Email',
352 'type' => CRM_Utils_Type
::T_STRING
,
354 $params['on_hold'] = array(
355 'title' => 'Primary Email On Hold',
356 'type' => CRM_Utils_Type
::T_BOOLEAN
,
358 $params['im'] = array(
359 'title' => 'Primary Instant Messenger',
360 'type' => CRM_Utils_Type
::T_STRING
,
362 $params['im_id'] = array(
363 'title' => 'Primary Instant Messenger ID',
364 'type' => CRM_Utils_Type
::T_INT
,
366 $params['group'] = array(
368 'pseudoconstant' => array(
369 'table' => 'civicrm_group',
372 $params['tag'] = array(
374 'pseudoconstant' => array(
375 'table' => 'civicrm_tag',
378 $params['uf_user'] = array(
379 'title' => 'CMS User',
380 'type' => CRM_Utils_Type
::T_BOOLEAN
,
382 $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'));
383 $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'));
384 $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'));
385 $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'));
389 * Support for historical oddities.
391 * We are supporting 'showAll' = 'all', 'trash' or 'active' for Contact get
393 * - hopefully some day we'll come up with a std syntax for the 3-way-boolean of
396 * We also support 'filter_group_id' & 'filter.group_id'
398 * @param array $params
399 * As passed into api get or getcount function.
400 * @param array $options
401 * Array of options (so we can modify the filter).
403 function _civicrm_api3_contact_get_supportanomalies(&$params, &$options) {
404 if (isset($params['showAll'])) {
405 if (strtolower($params['showAll']) == "active") {
406 $params['contact_is_deleted'] = 0;
408 if (strtolower($params['showAll']) == "trash") {
409 $params['contact_is_deleted'] = 1;
411 if (strtolower($params['showAll']) == "all" && isset($params['contact_is_deleted'])) {
412 unset($params['contact_is_deleted']);
415 // support for group filters
416 if (array_key_exists('filter_group_id', $params)) {
417 $params['filter.group_id'] = $params['filter_group_id'];
418 unset($params['filter_group_id']);
420 // filter.group_id works both for 1,2,3 and array (1,2,3)
421 if (array_key_exists('filter.group_id', $params)) {
422 if (is_array($params['filter.group_id'])) {
423 $groups = $params['filter.group_id'];
426 $groups = explode(',', $params['filter.group_id']);
428 unset($params['filter.group_id']);
429 $options['input_params']['group'] = $groups;
431 if (isset($params['group'])) {
432 $groups = $params['group'];
433 $groupsByTitle = CRM_Core_PseudoConstant
::group();
434 $groupsByName = CRM_Contact_BAO_GroupContact
::buildOptions('group_id', 'validate');
435 $allGroups = array_merge(array_flip($groupsByTitle), array_flip($groupsByName));
436 if (is_array($groups) && in_array(key($groups), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
437 // Get the groups array.
438 $groupsArray = $groups[key($groups)];
439 foreach ($groupsArray as &$group) {
440 if (!is_numeric($group) && !empty($allGroups[$group])) {
441 $group = $allGroups[$group];
444 // Now reset the $groups array with the ids not the titles.
445 $groups[key($groups)] = $groupsArray;
447 // handle format like 'group' => array('title1', 'title2').
448 elseif (is_array($groups)) {
449 foreach ($groups as $k => &$group) {
450 if (!is_numeric($group) && !empty($allGroups[$group])) {
451 $group = $allGroups[$group];
453 if (!is_numeric($k) && !empty($allGroups[$k])) {
455 $groups[$allGroups[$k]] = $group;
459 elseif (!is_numeric($groups) && !empty($allGroups[$groups])) {
460 $groups = $allGroups[$groups];
462 $params['group'] = $groups;
467 * Delete a Contact with given contact_id.
469 * @param array $params
470 * input parameters per getfields
472 * @throws \Civi\API\Exception\UnauthorizedException
476 function civicrm_api3_contact_delete($params) {
477 $contactID = CRM_Utils_Array
::value('id', $params);
479 if (!empty($params['check_permissions']) && !CRM_Contact_BAO_Contact_Permission
::allow($contactID, CRM_Core_Permission
::DELETE
)) {
480 throw new \Civi\API\Exception\
UnauthorizedException('Permission denied to modify contact record');
483 $session = CRM_Core_Session
::singleton();
484 if ($contactID == $session->get('userID')) {
485 return civicrm_api3_create_error('This contact record is linked to the currently logged in user account - and cannot be deleted.');
487 $restore = !empty($params['restore']) ?
$params['restore'] : FALSE;
488 $skipUndelete = !empty($params['skip_undelete']) ?
$params['skip_undelete'] : FALSE;
491 // restrict permanent delete if a contact has financial trxn associated with it
493 if ($skipUndelete && CRM_Financial_BAO_FinancialItem
::checkContactPresent(array($contactID), $error)) {
494 return civicrm_api3_create_error($error['_qf_default']);
496 if (CRM_Contact_BAO_Contact
::deleteContact($contactID, $restore, $skipUndelete,
497 CRM_Utils_Array
::value('check_permissions', $params))) {
498 return civicrm_api3_create_success();
501 return civicrm_api3_create_error('Could not delete contact');
507 * Check parameters passed in.
509 * This function is on it's way out.
511 * @param array $params
514 * @throws API_Exception
515 * @throws CiviCRM_API3_Exception
517 function _civicrm_api3_contact_check_params(&$params) {
519 switch (strtolower(CRM_Utils_Array
::value('contact_type', $params))) {
521 civicrm_api3_verify_mandatory($params, NULL, array('household_name'));
525 civicrm_api3_verify_mandatory($params, NULL, array('organization_name'));
529 civicrm_api3_verify_one_mandatory($params, NULL, array(
539 if (!empty($params['contact_sub_type']) && !empty($params['contact_type'])) {
540 if (!(CRM_Contact_BAO_ContactType
::isExtendsContactType($params['contact_sub_type'], $params['contact_type']))) {
541 throw new API_Exception("Invalid or Mismatched Contact Subtype: " . implode(', ', (array) $params['contact_sub_type']));
545 // The BAO no longer supports the legacy param "current_employer" so here is a shim for api backward-compatability
546 if (!empty($params['current_employer'])) {
547 $organizationParams = array(
548 'organization_name' => $params['current_employer'],
551 $dupeIds = CRM_Contact_BAO_Contact
::getDuplicateContacts($organizationParams, 'Organization', 'Supervised', array(), FALSE);
553 // check for mismatch employer name and id
554 if (!empty($params['employer_id']) && !in_array($params['employer_id'], $dupeIds)) {
555 throw new API_Exception('Employer name and Employer id Mismatch');
558 // show error if multiple organisation with same name exist
559 if (empty($params['employer_id']) && (count($dupeIds) > 1)) {
560 throw new API_Exception('Found more than one Organisation with same Name.');
564 $params['employer_id'] = $dupeIds[0];
567 $result = civicrm_api3('Contact', 'create', array(
568 'organization_name' => $params['current_employer'],
569 'contact_type' => 'Organization',
571 $params['employer_id'] = $result['id'];
579 * Helper function for Contact create.
581 * @param array $params
582 * (reference ) an assoc array of name/value pairs.
583 * @param int $contactID
584 * If present the contact with that ID is updated.
586 * @return CRM_Contact_BAO_Contact|CRM_Core_Error
588 function _civicrm_api3_contact_update($params, $contactID = NULL) {
589 //@todo - doesn't contact create support 'id' which is already set- check & remove
591 $params['contact_id'] = $contactID;
594 return CRM_Contact_BAO_Contact
::create($params);
598 * Validate the addressee or email or postal greetings.
600 * @param array $params
601 * Array per getfields metadata.
603 * @throws API_Exception
605 function _civicrm_api3_greeting_format_params($params) {
606 $greetingParams = array('', '_id', '_custom');
607 foreach (array('email', 'postal', 'addressee') as $key) {
608 $greeting = '_greeting';
609 if ($key == 'addressee') {
613 $formatParams = FALSE;
614 // Unset display value from params.
615 if (isset($params["{$key}{$greeting}_display"])) {
616 unset($params["{$key}{$greeting}_display"]);
619 // check if greetings are present in present
620 foreach ($greetingParams as $greetingValues) {
621 if (array_key_exists("{$key}{$greeting}{$greetingValues}", $params)) {
622 $formatParams = TRUE;
627 if (!$formatParams) {
633 'greeting_type' => "{$key}{$greeting}",
636 $greetings = CRM_Core_PseudoConstant
::greeting($filter);
637 $greetingId = CRM_Utils_Array
::value("{$key}{$greeting}_id", $params);
638 $greetingVal = CRM_Utils_Array
::value("{$key}{$greeting}", $params);
639 $customGreeting = CRM_Utils_Array
::value("{$key}{$greeting}_custom", $params);
641 if (!$greetingId && $greetingVal) {
642 $params["{$key}{$greeting}_id"] = CRM_Utils_Array
::key($params["{$key}{$greeting}"], $greetings);
645 if ($customGreeting && $greetingId &&
646 ($greetingId != array_search('Customized', $greetings))
648 throw new API_Exception(ts('Provide either %1 greeting id and/or %1 greeting or custom %1 greeting',
653 if ($greetingVal && $greetingId &&
654 ($greetingId != CRM_Utils_Array
::key($greetingVal, $greetings))
656 throw new API_Exception(ts('Mismatch in %1 greeting id and %1 greeting',
662 if (!$customGreeting && ($greetingId == array_search('Customized', $greetings))) {
663 throw new API_Exception(ts('Please provide a custom value for %1 greeting',
668 elseif ($greetingVal) {
670 if (!in_array($greetingVal, $greetings)) {
671 throw new API_Exception(ts('Invalid %1 greeting', array(1 => $key)));
674 $greetingId = CRM_Utils_Array
::key($greetingVal, $greetings);
677 if ($customGreeting) {
678 $greetingId = CRM_Utils_Array
::key('Customized', $greetings);
681 $customValue = isset($params['contact_id']) ? CRM_Core_DAO
::getFieldValue(
682 'CRM_Contact_DAO_Contact',
683 $params['contact_id'],
684 "{$key}{$greeting}_custom"
687 if (array_key_exists("{$key}{$greeting}_id", $params) && empty($params["{$key}{$greeting}_id"])) {
690 elseif (array_key_exists("{$key}{$greeting}", $params) && empty($params["{$key}{$greeting}"])) {
693 elseif ($customValue && array_key_exists("{$key}{$greeting}_custom", $params)
694 && empty($params["{$key}{$greeting}_custom"])
699 $params["{$key}{$greeting}_id"] = $greetingId;
701 if (!$customValue && !$customGreeting && array_key_exists("{$key}{$greeting}_custom", $params)) {
702 unset($params["{$key}{$greeting}_custom"]);
706 $params["{$key}{$greeting}_id"] = '';
707 $params["{$key}{$greeting}_custom"] = '';
710 if (isset($params["{$key}{$greeting}"])) {
711 unset($params["{$key}{$greeting}"]);
717 * Adjust Metadata for Get action.
719 * @param array $params
720 * Array of parameters determined by getfields.
722 function _civicrm_api3_contact_getquick_spec(&$params) {
723 $params['name']['api.required'] = TRUE;
724 $params['name']['title'] = ts('String to search on');
725 $params['name']['type'] = CRM_Utils_Type
::T_STRING
;
726 $params['field']['type'] = CRM_Utils_Type
::T_STRING
;
727 $params['field']['title'] = ts('Field to search on');
728 $params['field']['options'] = array(
732 'external_identifier',
742 $params['table_name']['type'] = CRM_Utils_Type
::T_STRING
;
743 $params['table_name']['title'] = ts('Table alias to search on');
744 $params['table_name']['api.default'] = 'cc';
748 * Old Contact quick search api.
752 * @param array $params
755 * @throws \API_Exception
757 function civicrm_api3_contact_getquick($params) {
758 $name = CRM_Utils_Type
::escape(CRM_Utils_Array
::value('name', $params), 'String');
759 $table_name = CRM_Utils_String
::munge($params['table_name']);
760 // get the autocomplete options from settings
761 $acpref = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
762 CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
763 'contact_autocomplete_options'
769 'phone_numeric' => 'phe',
770 'street_address' => 'sts',
772 'postal_code' => 'sts',
775 // get the option values for contact autocomplete
776 $acOptions = CRM_Core_OptionGroup
::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name');
778 $list = $from = array();
779 foreach ($acpref as $value) {
780 if ($value && !empty($acOptions[$value])) {
781 $list[$value] = $acOptions[$value];
784 // If we are doing quicksearch by a field other than name, make sure that field is added to results
785 if (!empty($params['field_name'])) {
786 $field_name = CRM_Utils_String
::munge($params['field_name']);
787 // Unique name contact_id = id
788 if ($field_name == 'contact_id') {
791 if (isset($table_names[$field_name])) {
792 $table_name = $table_names[$field_name];
794 elseif (strpos($field_name, 'custom_') === 0) {
795 $customField = civicrm_api3('CustomField', 'getsingle', [
796 'id' => substr($field_name, 7),
797 'return' => ['custom_group_id.table_name', 'column_name', 'data_type', 'option_group_id', 'html_type'],
799 $field_name = $customField['column_name'];
800 $table_name = CRM_Utils_String
::munge($customField['custom_group_id.table_name']);
801 $from[$field_name] = "LEFT JOIN `$table_name` ON cc.id = `$table_name`.entity_id";
802 if (CRM_Core_BAO_CustomField
::hasOptions($customField)) {
803 $customOptionsWhere = [];
804 $customFieldOptions = CRM_Contact_BAO_Contact
::buildOptions('custom_' . $customField['id'], 'search');
805 $isMultivalueField = CRM_Core_BAO_CustomField
::isSerialized($customField);
806 $sep = CRM_Core_DAO
::VALUE_SEPARATOR
;
807 foreach ($customFieldOptions as $optionKey => $optionLabel) {
808 if (mb_stripos($optionLabel, $name) !== FALSE) {
809 $customOptionsWhere[$optionKey] = "$table_name.$field_name " . ($isMultivalueField ?
"LIKE '%{$sep}{$optionKey}{$sep}%'" : "= '$optionKey'");
814 // phone_numeric should be phone
815 $searchField = str_replace('_numeric', '', $field_name);
816 if (!in_array($searchField, $list)) {
817 $list[] = $searchField;
821 // Set field name to first name for exact match checking.
822 $field_name = 'sort_name';
825 $select = $actualSelectElements = array('sort_name');
827 foreach ($list as $value) {
828 $suffix = substr($value, 0, 2) . substr($value, -1);
830 case 'street_address':
833 $selectText = $value;
838 $actualSelectElements[] = $select[] = ($value == 'address') ?
$selectText : $value;
839 if ($value == 'phone') {
840 $actualSelectElements[] = $select[] = 'phone_ext';
842 $from[$value] = "LEFT JOIN civicrm_{$value} {$suffix} ON ( cc.id = {$suffix}.contact_id AND {$suffix}.is_primary = 1 ) ";
846 case 'state_province':
847 $select[] = "{$suffix}.name as {$value}";
848 $actualSelectElements[] = "{$suffix}.name";
849 if (!in_array('address', $from)) {
850 $from['address'] = 'LEFT JOIN civicrm_address sts ON ( cc.id = sts.contact_id AND sts.is_primary = 1) ';
852 $from[$value] = " LEFT JOIN civicrm_{$value} {$suffix} ON ( sts.{$value}_id = {$suffix}.id ) ";
856 if ($value == 'id') {
857 $actualSelectElements[] = 'cc.id';
859 elseif ($value != 'sort_name') {
861 if ($field_name == $value) {
862 $suffix = $table_name;
864 $actualSelectElements[] = $select[] = $suffix . '.' . $value;
870 $config = CRM_Core_Config
::singleton();
872 $select = implode(', ', $select);
873 if (!empty($select)) {
874 $select = ", $select";
876 $actualSelectElements = implode(', ', $actualSelectElements);
877 $from = implode(' ', $from);
878 $limit = (int) CRM_Utils_Array
::value('limit', $params);
879 $limit = $limit > 0 ?
$limit : Civi
::settings()->get('search_autocomplete_count');
881 // add acl clause here
882 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause('cc');
885 $where .= " AND $aclWhere ";
887 $isPrependWildcard = \Civi
::settings()->get('includeWildCardInName');
889 if (!empty($params['org'])) {
890 $where .= " AND contact_type = \"Organization\"";
892 // CRM-7157, hack: get current employer details when
893 // employee_id is present.
894 $currEmpDetails = array();
895 if (!empty($params['employee_id'])) {
896 if ($currentEmployer = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
897 (int) $params['employee_id'],
900 if ($isPrependWildcard) {
901 $strSearch = "%$name%";
904 $strSearch = "$name%";
907 // get current employer details
908 $dao = CRM_Core_DAO
::executeQuery("SELECT cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data, sort_name
909 FROM civicrm_contact cc {$from} WHERE cc.contact_type = \"Organization\" AND cc.id = {$currentEmployer} AND cc.sort_name LIKE '$strSearch'");
911 $currEmpDetails = array(
913 'data' => $dao->data
,
920 if (!empty($params['contact_sub_type'])) {
921 $contactSubType = CRM_Utils_Type
::escape($params['contact_sub_type'], 'String');
922 $where .= " AND cc.contact_sub_type = '{$contactSubType}'";
925 if (!empty($params['contact_type'])) {
926 $contactType = CRM_Utils_Type
::escape($params['contact_type'], 'String');
927 $where .= " AND cc.contact_type LIKE '{$contactType}'";
930 // Set default for current_employer or return contact with particular id
931 if (!empty($params['id'])) {
932 $where .= " AND cc.id = " . (int) $params['id'];
935 if (!empty($params['cid'])) {
936 $where .= " AND cc.id <> " . (int) $params['cid'];
939 // Contact's based of relationhip type
941 if (!empty($params['rel'])) {
942 $relation = explode('_', CRM_Utils_Array
::value('rel', $params));
943 $relType = CRM_Utils_Type
::escape($relation[0], 'Integer');
944 $rel = CRM_Utils_Type
::escape($relation[2], 'String');
947 if ($isPrependWildcard) {
948 $strSearch = "%$name%";
951 $strSearch = "$name%";
953 $includeEmailFrom = $includeNickName = '';
954 if ($config->includeNickNameInName
) {
955 $includeNickName = " OR nick_name LIKE '$strSearch'";
958 if (isset($customOptionsWhere)) {
959 $customOptionsWhere = $customOptionsWhere ?
: [0];
960 $whereClause = " WHERE (" . implode(' OR ', $customOptionsWhere) . ") $where";
962 elseif (!empty($params['field_name']) && !empty($params['table_name']) && $params['field_name'] != 'sort_name') {
963 $whereClause = " WHERE ( $table_name.$field_name LIKE '$strSearch') {$where}";
964 // Search by id should be exact
965 if ($field_name == 'id' ||
$field_name == 'external_identifier') {
966 $whereClause = " WHERE ( $table_name.$field_name = '$name') {$where}";
970 $whereClause = " WHERE ( sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
971 if ($config->includeEmailInName
) {
972 if (!in_array('email', $list)) {
973 $includeEmailFrom = "LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )";
975 $emailWhere = " WHERE email LIKE '$strSearch'";
979 $additionalFrom = '';
982 INNER JOIN civicrm_relationship_type r ON (
984 AND ( cc.contact_type = r.contact_type_{$rel} OR r.contact_type_{$rel} IS NULL )
985 AND ( cc.contact_sub_type = r.contact_sub_type_{$rel} OR r.contact_sub_type_{$rel} IS NULL )
989 // check if only CMS users are requested
990 if (!empty($params['cmsuser'])) {
992 INNER JOIN civicrm_uf_match um ON (um.contact_id=cc.id)
995 $orderBy = _civicrm_api3_quicksearch_get_order_by($name, $isPrependWildcard, $field_name);
999 SELECT DISTINCT(id), data, sort_name, exactFirst
1001 ( SELECT IF($table_name.$field_name = '{$name}', 0, 1) as exactFirst, cc.id as id, CONCAT_WS( ' :: ',
1002 {$actualSelectElements} )
1005 FROM civicrm_contact cc {$from}
1013 if (!empty($emailWhere)) {
1016 SELECT IF($table_name.$field_name = '{$name}', 0, 1) as exactFirst, cc.id as id, CONCAT_WS( ' :: ',
1017 {$actualSelectElements} )
1020 FROM civicrm_contact cc {$from}
1022 {$additionalFrom} {$includeEmailFrom}
1023 {$emailWhere} AND cc.is_deleted = 0 " . ($aclWhere ?
" AND $aclWhere " : '') . "
1034 // send query to hook to be modified if needed
1035 CRM_Utils_Hook
::contactListQuery($query,
1037 empty($params['context']) ?
NULL : CRM_Utils_Type
::escape($params['context'], 'String'),
1038 empty($params['id']) ?
NULL : $params['id']
1041 $dao = CRM_Core_DAO
::executeQuery($query);
1043 $contactList = array();
1044 $listCurrentEmployer = TRUE;
1045 while ($dao->fetch()) {
1046 $t = array('id' => $dao->id
);
1047 foreach ($as as $k) {
1048 $t[$k] = isset($dao->$k) ?
$dao->$k : '';
1050 $t['data'] = $dao->data
;
1051 // Replace keys with values when displaying fields from an option list
1052 if (!empty($customOptionsWhere)) {
1053 $data = explode(' :: ', $dao->data
);
1054 $pos = count($data) - 1;
1055 $customValue = array_intersect(CRM_Utils_Array
::explodePadded($data[$pos]), array_keys($customOptionsWhere));
1056 $data[$pos] = implode(', ', array_intersect_key($customFieldOptions, array_flip($customValue)));
1057 $t['data'] = implode(' :: ', $data);
1059 $contactList[] = $t;
1060 if (!empty($params['org']) &&
1061 !empty($currEmpDetails) &&
1062 $dao->id
== $currEmpDetails['id']
1064 $listCurrentEmployer = FALSE;
1068 //return organization name if doesn't exist in db
1069 if (empty($contactList)) {
1070 if (!empty($params['org'])) {
1071 if ($listCurrentEmployer && !empty($currEmpDetails)) {
1072 $contactList = array(
1074 'data' => $currEmpDetails['data'],
1075 'id' => $currEmpDetails['id'],
1080 $contactList = array(
1090 return civicrm_api3_create_success($contactList, $params, 'Contact', 'getquick');
1094 * Get the order by string for the quicksearch query.
1096 * Get the order by string. The string might be
1097 * - sort name if there is no search value provided and the site is configured
1098 * to search by sort name
1099 * - empty if there is no search value provided and the site is not configured
1100 * to search by sort name
1101 * - exactFirst and then sort name if a search value is provided and the site is configured
1102 * to search by sort name
1103 * - exactFirst if a search value is provided and the site is not configured
1104 * to search by sort name
1106 * exactFirst means 'yes if the search value exactly matches the searched field. else no'.
1107 * It is intended to prioritise exact matches for the entered string so on a first name search
1108 * for 'kath' contacts with a first name of exactly Kath rise to the top.
1110 * On short strings it is expensive. Per CRM-19547 there is still an open question
1111 * as to whether we should only do exactMatch on a minimum length or on certain fields.
1113 * However, we have mitigated this somewhat by not doing an exact match search on
1114 * empty strings, non-wildcard sort-name searches and email searches where there is
1115 * no @ after the first character.
1117 * For the user it is further mitigated by the fact they just don't know the
1118 * slower queries are firing. If they type 'smit' slowly enough 4 queries will trigger
1119 * but if the first 3 are slow the first result they see may be off the 4th query.
1121 * @param string $name
1122 * @param bool $isPrependWildcard
1123 * @param string $field_name
1127 function _civicrm_api3_quicksearch_get_order_by($name, $isPrependWildcard, $field_name) {
1128 $skipExactMatch = ($name === '%');
1129 if ($field_name === 'email' && !strpos('@', $name)) {
1130 $skipExactMatch = TRUE;
1133 if (!\Civi
::settings()->get('includeOrderByClause')) {
1134 return $skipExactMatch ?
'' : "ORDER BY exactFirst";
1136 if ($skipExactMatch ||
(!$isPrependWildcard && $field_name === 'sort_name')) {
1137 // If there is no wildcard then sorting by exactFirst would have the same
1138 // effect as just a sort_name search, but slower.
1139 return "ORDER BY sort_name";
1142 return "ORDER BY exactFirst, sort_name";
1146 * Declare deprecated api functions.
1148 * @deprecated api notice
1150 * Array of deprecated actions
1152 function _civicrm_api3_contact_deprecation() {
1153 return array('getquick' => 'The "getquick" action is deprecated in favor of "getlist".');
1157 * Merges given pair of duplicate contacts.
1159 * @param array $params
1160 * Allowed array keys are:
1161 * -int main_id: main contact id with whom merge has to happen
1162 * -int other_id: duplicate contact which would be deleted after merge operation
1163 * -string mode: "safe" skips the merge if there are no conflicts. Does a force merge otherwise.
1167 * @throws API_Exception
1169 function civicrm_api3_contact_merge($params) {
1170 if (($result = CRM_Dedupe_Merger
::merge(array(
1172 'srcID' => $params['to_remove_id'],
1173 'dstID' => $params['to_keep_id'],
1175 ), array(), $params['mode'])) != FALSE) {
1176 return civicrm_api3_create_success($result, $params);
1178 throw new API_Exception('Merge failed');
1182 * Adjust metadata for contact_merge api function.
1184 * @param array $params
1186 function _civicrm_api3_contact_merge_spec(&$params) {
1187 $params['to_remove_id'] = array(
1188 'title' => 'ID of the contact to merge & remove',
1189 'description' => ts('Wow - these 2 params are the logical reverse of what I expect - but what to do?'),
1190 'api.required' => 1,
1191 'type' => CRM_Utils_Type
::T_INT
,
1192 'api.aliases' => array('main_id'),
1194 $params['to_keep_id'] = array(
1195 'title' => 'ID of the contact to keep',
1196 'description' => ts('Wow - these 2 params are the logical reverse of what I expect - but what to do?'),
1197 'api.required' => 1,
1198 'type' => CRM_Utils_Type
::T_INT
,
1199 'api.aliases' => array('other_id'),
1201 $params['mode'] = array(
1202 // @todo need more detail on what this means.
1203 'title' => 'Dedupe mode',
1204 'api.default' => 'safe',
1209 * Get the ultimate contact a contact was merged to.
1211 * @param array $params
1215 * @throws API_Exception
1217 function civicrm_api3_contact_getmergedto($params) {
1218 $contactID = _civicrm_api3_contact_getmergedto($params);
1220 $values = [$contactID => ['id' => $contactID]];
1225 return civicrm_api3_create_success($values, $params);
1229 * Get the contact our contact was finally merged to.
1231 * If the contact has been merged multiple times the crucial parent activity will have
1232 * wound up on the ultimate contact so we can figure out the final resting place of the
1233 * contact with only 2 activities even if 50 merges took place.
1235 * @param array $params
1239 function _civicrm_api3_contact_getmergedto($params) {
1241 $deleteActivity = civicrm_api3('ActivityContact', 'get', [
1242 'contact_id' => $params['contact_id'],
1243 'activity_id.activity_type_id' => 'Contact Deleted By Merge',
1245 'is_test' => $params['is_test'],
1246 'record_type_id' => 'Activity Targets',
1247 'return' => ['activity_id.parent_id'],
1251 'sort' => 'activity_id.activity_date_time DESC'
1254 if (!empty($deleteActivity)) {
1255 $contactID = civicrm_api3('ActivityContact', 'getvalue', [
1256 'activity_id' => $deleteActivity[0]['activity_id.parent_id'],
1257 'record_type_id' => 'Activity Targets',
1258 'return' => 'contact_id',
1265 * Adjust metadata for contact_merge api function.
1267 * @param array $params
1269 function _civicrm_api3_contact_getmergedto_spec(&$params) {
1270 $params['contact_id'] = [
1271 'title' => ts('ID of contact to find ultimate contact for'),
1272 'type' => CRM_Utils_Type
::T_INT
,
1273 'api.required' => TRUE,
1275 $params['is_test'] = [
1276 'title' => ts('Get test deletions rather than live?'),
1277 'type' => CRM_Utils_Type
::T_BOOLEAN
,
1283 * Get the ultimate contact a contact was merged to.
1285 * @param array $params
1289 * @throws API_Exception
1291 function civicrm_api3_contact_getmergedfrom($params) {
1292 $contacts = _civicrm_api3_contact_getmergedfrom($params);
1293 return civicrm_api3_create_success($contacts, $params);
1297 * Get all the contacts merged into our contact.
1299 * @param array $params
1303 function _civicrm_api3_contact_getmergedfrom($params) {
1305 $deleteActivities = civicrm_api3('ActivityContact', 'get', [
1306 'contact_id' => $params['contact_id'],
1307 'activity_id.activity_type_id' => 'Contact Merged',
1309 'is_test' => $params['is_test'],
1310 'record_type_id' => 'Activity Targets',
1311 'return' => 'activity_id',
1314 foreach ($deleteActivities as $deleteActivity) {
1315 $activities[] = $deleteActivity['activity_id'];
1317 if (empty($activities)) {
1321 $activityContacts = civicrm_api3('ActivityContact', 'get', [
1322 'activity_id.parent_id' => ['IN' => $activities],
1323 'record_type_id' => 'Activity Targets',
1324 'return' => 'contact_id',
1327 foreach ($activityContacts as $activityContact) {
1328 $contacts[$activityContact['contact_id']] = ['id' => $activityContact['contact_id']];
1334 * Adjust metadata for contact_merge api function.
1336 * @param array $params
1338 function _civicrm_api3_contact_getmergedfrom_spec(&$params) {
1339 $params['contact_id'] = [
1340 'title' => ts('ID of contact to find ultimate contact for'),
1341 'type' => CRM_Utils_Type
::T_INT
,
1342 'api.required' => TRUE,
1344 $params['is_test'] = [
1345 'title' => ts('Get test deletions rather than live?'),
1346 'type' => CRM_Utils_Type
::T_BOOLEAN
,
1352 * Adjust metadata for contact_proximity api function.
1354 * @param array $params
1356 function _civicrm_api3_contact_proximity_spec(&$params) {
1357 $params['latitude'] = array(
1358 'title' => 'Latitude',
1359 'api.required' => 1,
1360 'type' => CRM_Utils_Type
::T_STRING
,
1362 $params['longitude'] = array(
1363 'title' => 'Longitude',
1364 'api.required' => 1,
1365 'type' => CRM_Utils_Type
::T_STRING
,
1368 $params['unit'] = array(
1369 'title' => 'Unit of Measurement',
1370 'api.default' => 'meter',
1371 'type' => CRM_Utils_Type
::T_STRING
,
1376 * Get contacts by proximity.
1378 * @param array $params
1383 function civicrm_api3_contact_proximity($params) {
1384 $latitude = CRM_Utils_Array
::value('latitude', $params);
1385 $longitude = CRM_Utils_Array
::value('longitude', $params);
1386 $distance = CRM_Utils_Array
::value('distance', $params);
1388 $unit = CRM_Utils_Array
::value('unit', $params);
1390 // check and ensure that lat/long and distance are floats
1392 !CRM_Utils_Rule
::numeric($latitude) ||
1393 !CRM_Utils_Rule
::numeric($longitude) ||
1394 !CRM_Utils_Rule
::numeric($distance)
1396 throw new Exception(ts('Latitude, Longitude and Distance should exist and be numeric'));
1399 if ($unit == "mile") {
1400 $conversionFactor = 1609.344;
1403 $conversionFactor = 1000;
1405 //Distance in meters
1406 $distance = $distance * $conversionFactor;
1408 $whereClause = CRM_Contact_BAO_ProximityQuery
::where($latitude, $longitude, $distance);
1411 SELECT civicrm_contact.id as contact_id,
1412 civicrm_contact.display_name as display_name
1413 FROM civicrm_contact
1414 LEFT JOIN civicrm_address ON civicrm_contact.id = civicrm_address.contact_id
1418 $dao = CRM_Core_DAO
::executeQuery($query);
1419 $contacts = array();
1420 while ($dao->fetch()) {
1421 $contacts[] = $dao->toArray();
1424 return civicrm_api3_create_success($contacts, $params, 'Contact', 'get_by_location', $dao);
1429 * Get parameters for getlist function.
1431 * @see _civicrm_api3_generic_getlist_params
1433 * @param array $request
1435 function _civicrm_api3_contact_getlist_params(&$request) {
1436 // get the autocomplete options from settings
1437 $acpref = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1438 CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1439 'contact_autocomplete_options'
1443 // get the option values for contact autocomplete
1444 $acOptions = CRM_Core_OptionGroup
::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name');
1447 foreach ($acpref as $value) {
1448 if ($value && !empty($acOptions[$value])) {
1449 $list[] = $acOptions[$value];
1452 // If we are doing quicksearch by a field other than name, make sure that field is added to results
1453 $field_name = CRM_Utils_String
::munge($request['search_field']);
1454 // Unique name contact_id = id
1455 if ($field_name == 'contact_id') {
1458 // phone_numeric should be phone
1459 $searchField = str_replace('_numeric', '', $field_name);
1460 if (!in_array($searchField, $list)) {
1461 $list[] = $searchField;
1463 $request['description_field'] = $list;
1464 $list[] = 'contact_type';
1465 $request['params']['return'] = array_unique(array_merge($list, $request['extra']));
1466 $request['params']['options']['sort'] = 'sort_name';
1467 // Contact api doesn't support array(LIKE => 'foo') syntax
1468 if (!empty($request['input'])) {
1469 $request['params'][$request['search_field']] = $request['input'];
1470 // Temporarily override wildcard setting
1471 if (Civi
::settings()->get('includeWildCardInName') != $request['add_wildcard']) {
1472 Civi
::$statics['civicrm_api3_contact_getlist']['override_wildcard'] = !$request['add_wildcard'];
1473 Civi
::settings()->set('includeWildCardInName', $request['add_wildcard']);
1479 * Get output for getlist function.
1481 * @see _civicrm_api3_generic_getlist_output
1483 * @param array $result
1484 * @param array $request
1488 function _civicrm_api3_contact_getlist_output($result, $request) {
1490 if (!empty($result['values'])) {
1491 $addressFields = array_intersect(array(
1497 $request['params']['return']);
1498 foreach ($result['values'] as $row) {
1500 'id' => $row[$request['id_field']],
1501 'label' => $row[$request['label_field']],
1502 'description' => array(),
1504 foreach ($request['description_field'] as $item) {
1505 if (!strpos($item, '_name') && !in_array($item, $addressFields) && !empty($row[$item])) {
1506 $data['description'][] = $row[$item];
1510 foreach ($addressFields as $item) {
1511 if (!empty($row[$item])) {
1512 $address[] = $row[$item];
1516 $data['description'][] = implode(' ', $address);
1518 if (!empty($request['image_field'])) {
1519 $data['image'] = isset($row[$request['image_field']]) ?
$row[$request['image_field']] : '';
1522 $data['icon_class'] = $row['contact_type'];
1527 // Restore wildcard override by _civicrm_api3_contact_getlist_params
1528 if (isset(Civi
::$statics['civicrm_api3_contact_getlist']['override_wildcard'])) {
1529 Civi
::settings()->set('includeWildCardInName', Civi
::$statics['civicrm_api3_contact_getlist']['override_wildcard']);
1530 unset(Civi
::$statics['civicrm_api3_contact_getlist']['override_wildcard']);
1536 * Check for duplicate contacts.
1538 * @param array $params
1539 * Params per getfields metadata.
1542 * API formatted array
1544 function civicrm_api3_contact_duplicatecheck($params) {
1545 $dupes = CRM_Contact_BAO_Contact
::getDuplicateContacts(
1547 $params['match']['contact_type'],
1548 $params['rule_type'],
1549 CRM_Utils_Array
::value('exclude', $params, []),
1550 CRM_Utils_Array
::value('check_permissions', $params),
1551 CRM_Utils_Array
::value('dedupe_rule_id', $params)
1554 if ($dupes && !empty($params['return'])) {
1555 return civicrm_api3('Contact', 'get', array(
1556 'return' => $params['return'],
1557 'id' => array('IN' => $dupes),
1558 'options' => CRM_Utils_Array
::value('options', $params),
1559 'sequential' => CRM_Utils_Array
::value('sequential', $params),
1560 'check_permissions' => CRM_Utils_Array
::value('check_permissions', $params),
1563 foreach ($dupes as $dupe) {
1564 $values[$dupe] = array('id' => $dupe);
1566 return civicrm_api3_create_success($values, $params, 'Contact', 'duplicatecheck');
1570 * Declare metadata for contact dedupe function.
1574 function _civicrm_api3_contact_duplicatecheck_spec(&$params) {
1575 $params['dedupe_rule_id'] = array(
1576 'title' => 'Dedupe Rule ID (optional)',
1577 'description' => 'This will default to the built in unsupervised rule',
1578 'type' => CRM_Utils_Type
::T_INT
,
1580 $params['rule_type'] = array(
1581 'title' => 'Dedupe Rule Type',
1582 'description' => 'If no rule id specified, pass "Unsupervised" or "Supervised"',
1583 'type' => CRM_Utils_Type
::T_STRING
,
1584 'api.default' => 'Unsupervised',
1586 // @todo declare 'match' parameter. We don't have a standard for type = array yet.