3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 * new version of civicrm apis. See blog post at
30 * http://civicrm.org/node/131
33 * @package CiviCRM_APIv3
34 * @subpackage API_Contact
35 * @copyright CiviCRM LLC (c) 2004-2014
36 * $Id: Contact.php 30879 2010-11-22 15:45:55Z shot $
41 * Create or update a contact (note you should always call this via civicrm_api() & never directly)
43 * @param array $params input parameters
45 * Allowed @params array keys are:
46 * {@getfields contact_create}
49 * @throws API_Exception
50 * @example ContactCreate.php Example of Create Call
52 * @return array API Result Array
57 function civicrm_api3_contact_create($params) {
59 $contactID = CRM_Utils_Array
::value('contact_id', $params, CRM_Utils_Array
::value('id', $params));
60 $dupeCheck = CRM_Utils_Array
::value('dupe_check', $params, FALSE);
61 $values = _civicrm_api3_contact_check_params($params, $dupeCheck);
67 // If we get here, we're ready to create a new contact
68 if (($email = CRM_Utils_Array
::value('email', $params)) && !is_array($params['email'])) {
69 $defLocType = CRM_Core_BAO_LocationType
::getDefault();
70 $params['email'] = array(
71 1 => array('email' => $email,
73 'location_type_id' => ($defLocType->id
) ?
$defLocType->id
: 1,
79 if (!empty($params['home_url'])) {
80 $websiteTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id');
81 $params['website'] = array(1 => array('website_type_id' => key($websiteTypes),
82 'url' => $params['home_url'],
87 _civicrm_api3_greeting_format_params($params);
91 if (empty($params['contact_type']) && $contactID) {
92 $params['contact_type'] = CRM_Contact_BAO_Contact
::getContactType($contactID);
95 if (!isset($params['contact_sub_type']) && $contactID) {
96 $params['contact_sub_type'] = CRM_Contact_BAO_Contact
::getContactSubType($contactID);
99 _civicrm_api3_custom_format_params($params, $values, $params['contact_type'], $contactID);
101 $params = array_merge($params, $values);
102 //@todo we should just call basic_create here - but need to make contact:create accept 'id' on the bao
103 $contact = _civicrm_api3_contact_update($params, $contactID);
105 if (is_a($contact, 'CRM_Core_Error')) {
106 throw new API_Exception($contact->_errors
[0]['message']);
110 _civicrm_api3_object_to_array_unique_fields($contact, $values[$contact->id
]);
113 return civicrm_api3_create_success($values, $params, 'Contact', 'create');
117 * Adjust Metadata for Create action
119 * @param array $params array or parameters determined by getfields
121 function _civicrm_api3_contact_create_spec(&$params) {
122 $params['contact_type']['api.required'] = 1;
123 $params['id']['api.aliases'] = array('contact_id');
124 $params['current_employer'] = array(
125 'title' => 'Current Employer',
126 'description' => 'Name of Current Employer',
127 'type' => CRM_Utils_Type
::T_STRING
,
129 $params['dupe_check'] = array(
130 'title' => 'Check for Duplicates',
131 'description' => 'Throw error if contact create matches dedupe rule',
133 $params['prefix_id']['api.aliases'] = array('individual_prefix', 'individual_prefix_id');
134 $params['suffix_id']['api.aliases'] = array('individual_suffix', 'individual_suffix_id');
138 * Retrieve one or more contacts, given a set of search params
140 * @param array input parameters
142 * @return array API Result Array
143 * (@getfields contact_get}
147 * @example ContactGet.php Standard GET example
150 function civicrm_api3_contact_get($params) {
152 _civicrm_api3_contact_get_supportanomalies($params, $options);
153 $contacts = _civicrm_api3_get_using_query_object('contact', $params, $options);
154 return civicrm_api3_create_success($contacts, $params, 'contact');
157 function civicrm_api3_contact_getcount($params) {
159 _civicrm_api3_contact_get_supportanomalies($params, $options);
160 $count = _civicrm_api3_get_using_query_object('contact', $params, $options,1);
165 * Adjust Metadata for Get action
167 * @param array $params array or parameters determined by getfields
169 function _civicrm_api3_contact_get_spec(&$params) {
170 $params['contact_is_deleted']['api.default'] = 0;
172 //we declare all these pseudofields as there are other undocumented fields accessible
173 // via the api - but if check permissions is set we only allow declared fields
174 $params['address_id']['title'] = 'Primary Address ID';
175 $params['street_address']['title'] = 'Primary Address Street Address';
176 $params['supplemental_address_1']['title'] = 'Primary Address Supplemental Address 1';
177 $params['supplemental_address_2']['title'] = 'Primary Address Supplemental Address 2';
178 $params['current_employer']['title'] = 'Current Employer';
179 $params['city']['title'] = 'Primary Address City';
180 $params['postal_code_suffix']['title'] = 'Primary Address Post Code Suffix';
181 $params['postal_code']['title'] = 'Primary Address Post Code';
182 $params['geo_code_1']['title'] = 'Primary Address Latitude';
183 $params['geo_code_2']['title'] = 'Primary Address Longitude';
184 $params['state_province_id']['title'] = 'Primary Address State Province ID';
185 $params['state_province_name']['title'] = 'Primary Address State Province Name';
186 $params['state_province']['title'] = 'Primary Address State Province';
187 $params['country_id']['title'] = 'Primary Address Country ID';
188 $params['country']['title'] = 'Primary Address country';
189 $params['worldregion_id']['title'] = 'Primary Address World Region ID';
190 $params['worldregion']['title'] = 'Primary Address World Region';
191 $params['phone_id']['title'] = 'Primary Phone ID';
192 $params['phone']['title'] = 'Primary Phone';
193 $params['phone_type_id']['title'] = 'Primary Phone Type ID';
194 $params['provider_id']['title'] = 'Primary Phone Provider ID';
195 $params['email_id']['title'] = 'Primary Email ID';
196 $params['email']['title'] = 'Primary Email';
197 $params['gender_id']['title'] = 'Gender ID';
198 $params['gender']['title'] = 'Gender';
199 $params['on_hold']['title'] = 'Primary Email On Hold';
200 $params['im']['title'] = 'Primary Instant Messanger';
201 $params['im_id']['title'] = 'Primary Instant Messanger ID';
202 $params['group_id']['title'] = 'Group Memberships (filter)';
203 $params['group']['title'] = 'Group Memberships (filter, array)';
204 $params['tag']['title'] = 'Assigned tags (filter, array)';
205 $params['birth_date_low'] = array('name' => 'birth_date_low', 'type' => CRM_Utils_Type
::T_DATE
, 'title' => ts('Birthdate is equal to or greater than'));
206 $params['birth_date_high'] = array('name' => 'birth_date_high', 'type' => CRM_Utils_Type
::T_DATE
, 'title' => ts('Birthdate is equal to or less than'));
207 $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'));
208 $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'));
212 * We are supporting 'showAll' = 'all', 'trash' or 'active' for contact get
214 * - hopefully some day we'll come up with a std syntax for the 3-way-boolean of
217 * We also support 'filter_group_id' & 'filter.group_id'
219 * @param array $params as passed into api get or getcount function
220 * @param array $options array of options (so we can modify the filter)
222 function _civicrm_api3_contact_get_supportanomalies(&$params, &$options) {
223 if (isset($params['showAll'])) {
224 if (strtolower($params['showAll']) == "active") {
225 $params['contact_is_deleted'] = 0;
227 if (strtolower($params['showAll']) == "trash") {
228 $params['contact_is_deleted'] = 1;
230 if (strtolower($params['showAll']) == "all" && isset($params['contact_is_deleted'])) {
231 unset($params['contact_is_deleted']);
234 // support for group filters
235 if (array_key_exists('filter_group_id', $params)) {
236 $params['filter.group_id'] = $params['filter_group_id'];
237 unset($params['filter_group_id']);
239 // filter.group_id works both for 1,2,3 and array (1,2,3)
240 if (array_key_exists('filter.group_id', $params)) {
241 if (is_array($params['filter.group_id'])) {
242 $groups = $params['filter.group_id'];
244 else $groups = explode(',', $params['filter.group_id']);
245 unset($params['filter.group_id']);
246 $groups = array_flip($groups);
247 $groups[key($groups)] = 1;
248 $options['input_params']['group'] = $groups;
253 * Delete a contact with given contact id
255 * @param array $params (reference ) input parameters, contact_id element required
257 * @return array API Result Array
260 * @example ContactDelete.php
261 * {@getfields contact_delete}
263 function civicrm_api3_contact_delete($params) {
265 $contactID = CRM_Utils_Array
::value('id', $params);
267 $session = CRM_Core_Session
::singleton();
268 if ($contactID == $session->get('userID')) {
269 return civicrm_api3_create_error('This contact record is linked to the currently logged in user account - and cannot be deleted.');
271 $restore = !empty($params['restore']) ?
$params['restore'] : FALSE;
272 $skipUndelete = !empty($params['skip_undelete']) ?
$params['skip_undelete'] : FALSE;
275 // restrict permanent delete if a contact has financial trxn associated with it
277 if ($skipUndelete && CRM_Financial_BAO_FinancialItem
::checkContactPresent(array($contactID), $error)) {
278 return civicrm_api3_create_error($error['_qf_default']);
280 if (CRM_Contact_BAO_Contact
::deleteContact($contactID, $restore, $skipUndelete)) {
281 return civicrm_api3_create_success();
284 return civicrm_api3_create_error('Could not delete contact');
289 function _civicrm_api3_contact_check_params( &$params, $dupeCheck = true, $dupeErrorArray = false, $obsoletevalue = true, $dedupeRuleGroupID = null )
292 switch (strtolower(CRM_Utils_Array
::value('contact_type', $params))) {
294 civicrm_api3_verify_mandatory($params, null, array('household_name'));
297 civicrm_api3_verify_mandatory($params, null, array('organization_name'));
300 civicrm_api3_verify_one_mandatory($params, null, array(
310 // Fixme: This really needs to be handled at a lower level. @See CRM-13123
311 if (isset($params['preferred_communication_method'])) {
312 $params['preferred_communication_method'] = CRM_Utils_Array
::implodePadded($params['preferred_communication_method']);
315 if (!empty($params['contact_sub_type']) && !empty($params['contact_type'])) {
316 if (!(CRM_Contact_BAO_ContactType
::isExtendsContactType($params['contact_sub_type'], $params['contact_type']))) {
317 throw new API_Exception("Invalid or Mismatched Contact SubType: " . implode(', ', (array)$params['contact_sub_type']));
322 // check for record already existing
323 $dedupeParams = CRM_Dedupe_Finder
::formatParams($params, $params['contact_type']);
326 // setting 'check_permission' here means that the dedupe checking will be carried out even if the
327 // person does not have permission to carry out de-dupes
328 // this is similar to the front end form
329 if (isset($params['check_permission'])) {
330 $dedupeParams['check_permission'] = $params['check_permission'];
333 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, $params['contact_type'], 'Unsupervised', array());
335 if (count($ids) >0) {
336 throw new API_Exception("Found matching contacts: ". implode(',',$ids),"duplicate",array("ids"=>$ids));
340 // The BAO no longer supports the legacy param "current_employer" so here is a shim for api backward-compatability
341 if (!empty($params['current_employer'])) {
342 $organizationParams = array(
343 'organization_name' => $params['current_employer'],
346 $dedupParams = CRM_Dedupe_Finder
::formatParams($organizationParams, 'Organization');
348 $dedupParams['check_permission'] = FALSE;
349 $dupeIds = CRM_Dedupe_Finder
::dupesByParams($dedupParams, 'Organization', 'Supervised');
351 // check for mismatch employer name and id
352 if (!empty($params['employer_id']) && !in_array($params['employer_id'], $dupeIds)) {
353 throw new API_Exception('Employer name and Employer id Mismatch');
356 // show error if multiple organisation with same name exist
357 if (empty($params['employer_id']) && (count($dupeIds) > 1)) {
358 throw new API_Exception('Found more than one Organisation with same Name.');
362 $params['employer_id'] = $dupeIds[0];
365 $result = civicrm_api3('contact', 'create', array(
366 'organization_name' => $params['current_employer'],
367 'contact_type' => 'Organization'
369 $params['employer_id'] = $result['id'];
377 * Takes an associative array and creates a contact object and all the associated
378 * derived objects (i.e. individual, location, email, phone etc)
380 * @param array $params (reference ) an assoc array of name/value pairs
381 * @param int $contactID if present the contact with that ID is updated
383 * @return object CRM_Contact_BAO_Contact object
387 function _civicrm_api3_contact_update($params, $contactID = NULL) {
388 //@todo - doesn't contact create support 'id' which is already set- check & remove
390 $params['contact_id'] = $contactID;
393 return CRM_Contact_BAO_Contact
::create($params);
397 * Validate the addressee or email or postal greetings
399 * @param $params Associative array of property name/value
400 * pairs to insert in new contact.
402 * @throws API_Exception
403 * @return array (reference ) null on success, error message otherwise
407 function _civicrm_api3_greeting_format_params($params) {
408 $greetingParams = array('', '_id', '_custom');
409 foreach (array('email', 'postal', 'addressee') as $key) {
410 $greeting = '_greeting';
411 if ($key == 'addressee') {
415 $formatParams = FALSE;
416 // unset display value from params.
417 if (isset($params["{$key}{$greeting}_display"])) {
418 unset($params["{$key}{$greeting}_display"]);
421 // check if greetings are present in present
422 foreach ($greetingParams as $greetingValues) {
423 if (array_key_exists("{$key}{$greeting}{$greetingValues}", $params)) {
424 $formatParams = TRUE;
429 if (!$formatParams) {
435 'contact_type' => $params['contact_type'],
436 'greeting_type' => "{$key}{$greeting}",
439 $greetings = CRM_Core_PseudoConstant
::greeting($filter);
440 $greetingId = CRM_Utils_Array
::value("{$key}{$greeting}_id", $params);
441 $greetingVal = CRM_Utils_Array
::value("{$key}{$greeting}", $params);
442 $customGreeting = CRM_Utils_Array
::value("{$key}{$greeting}_custom", $params);
444 if (!$greetingId && $greetingVal) {
445 $params["{$key}{$greeting}_id"] = CRM_Utils_Array
::key($params["{$key}{$greeting}"], $greetings);
448 if ($customGreeting && $greetingId &&
449 ($greetingId != array_search('Customized', $greetings))
451 throw new API_Exception(ts('Provide either %1 greeting id and/or %1 greeting or custom %1 greeting',
456 if ($greetingVal && $greetingId &&
457 ($greetingId != CRM_Utils_Array
::key($greetingVal, $greetings))
459 throw new API_Exception(ts('Mismatch in %1 greeting id and %1 greeting',
466 if (!array_key_exists($greetingId, $greetings)) {
467 throw new API_Exception(ts('Invalid %1 greeting Id', array(1 => $key)));
470 if (!$customGreeting && ($greetingId == array_search('Customized', $greetings))) {
471 throw new API_Exception(ts('Please provide a custom value for %1 greeting',
476 elseif ($greetingVal) {
478 if (!in_array($greetingVal, $greetings)) {
479 throw new API_Exception(ts('Invalid %1 greeting', array(1 => $key)));
482 $greetingId = CRM_Utils_Array
::key($greetingVal, $greetings);
485 if ($customGreeting) {
486 $greetingId = CRM_Utils_Array
::key('Customized', $greetings);
489 $customValue = isset($params['contact_id']) ?
490 CRM_Core_DAO
::getFieldValue(
491 'CRM_Contact_DAO_Contact',
492 $params['contact_id'],
493 "{$key}{$greeting}_custom"
497 if (array_key_exists("{$key}{$greeting}_id", $params) && empty($params["{$key}{$greeting}_id"])) {
500 elseif (array_key_exists("{$key}{$greeting}", $params) && empty($params["{$key}{$greeting}"])) {
503 elseif ($customValue && array_key_exists("{$key}{$greeting}_custom", $params)
504 && empty($params["{$key}{$greeting}_custom"])
509 $params["{$key}{$greeting}_id"] = $greetingId;
511 if (!$customValue && !$customGreeting && array_key_exists("{$key}{$greeting}_custom", $params)) {
512 unset($params["{$key}{$greeting}_custom"]);
516 $params["{$key}{$greeting}_id"] = '';
517 $params["{$key}{$greeting}_custom"] = '';
520 if (isset($params["{$key}{$greeting}"])) {
521 unset($params["{$key}{$greeting}"]);
527 * Old contact quick search api
531 * {@example ContactGetquick.php 0}
534 function civicrm_api3_contact_getquick($params) {
535 civicrm_api3_verify_mandatory($params, NULL, array('name'));
536 $name = CRM_Utils_Type
::escape(CRM_Utils_Array
::value('name', $params), 'String');
538 // get the autocomplete options from settings
539 $acpref = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
540 CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
541 'contact_autocomplete_options'
545 // get the option values for contact autocomplete
546 $acOptions = CRM_Core_OptionGroup
::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name');
549 foreach ($acpref as $value) {
550 if ($value && !empty($acOptions[$value])) {
551 $list[$value] = $acOptions[$value];
554 // If we are doing quicksearch by a field other than name, make sure that field is added to results
555 if (!empty($params['field_name'])) {
556 $field_name = CRM_Utils_String
::munge($params['field_name']);
557 // Unique name contact_id = id
558 if ($field_name == 'contact_id') {
561 // phone_numeric should be phone
562 $searchField = str_replace('_numeric', '', $field_name);
563 if(!in_array($searchField, $list)) {
564 $list[] = $searchField;
568 $select = $actualSelectElements = array('sort_name');
571 foreach ($list as $value) {
572 $suffix = substr($value, 0, 2) . substr($value, -1);
574 case 'street_address':
577 $selectText = $value;
582 $actualSelectElements[] = $select[] = ($value == 'address') ?
$selectText : $value;
583 if ($value == 'phone') {
584 $actualSelectElements[] = $select[] = 'phone_ext';
586 $from[$value] = "LEFT JOIN civicrm_{$value} {$suffix} ON ( cc.id = {$suffix}.contact_id AND {$suffix}.is_primary = 1 ) ";
590 case 'state_province':
591 $select[] = "{$suffix}.name as {$value}";
592 $actualSelectElements[] = "{$suffix}.name";
593 if (!in_array('address', $from)) {
594 $from['address'] = 'LEFT JOIN civicrm_address sts ON ( cc.id = sts.contact_id AND sts.is_primary = 1) ';
596 $from[$value] = " LEFT JOIN civicrm_{$value} {$suffix} ON ( sts.{$value}_id = {$suffix}.id ) ";
600 if ($value != 'id') {
602 if (!empty($params['field_name']) && $params['field_name'] == 'value') {
603 $suffix = CRM_Utils_String
::munge(CRM_Utils_Array
::value('table_name', $params, 'cc'));
605 $actualSelectElements[] = $select[] = $suffix . '.' . $value;
611 $config = CRM_Core_Config
::singleton();
613 $select = implode(', ', $select);
614 if (!empty($select)) {
615 $select = ", $select";
617 $actualSelectElements = implode(', ', $actualSelectElements);
618 $selectAliases = $from;
619 unset($selectAliases['address']);
620 $selectAliases = implode(', ', array_keys($selectAliases));
621 if (!empty($selectAliases)) {
622 $selectAliases = ", $selectAliases";
624 $from = implode(' ', $from);
625 $limit = (int) CRM_Utils_Array
::value('limit', $params);
626 $limit = $limit > 0 ?
$limit : 10;
628 // add acl clause here
629 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause('cc');
632 $where .= " AND $aclWhere ";
635 if (!empty($params['org'])) {
636 $where .= " AND contact_type = \"Organization\"";
638 // CRM-7157, hack: get current employer details when
639 // employee_id is present.
640 $currEmpDetails = array();
641 if (!empty($params['employee_id'])) {
642 if ($currentEmployer = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
643 (int) $params['employee_id'],
646 if ($config->includeWildCardInName
) {
647 $strSearch = "%$name%";
650 $strSearch = "$name%";
653 // get current employer details
654 $dao = CRM_Core_DAO
::executeQuery("SELECT cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data, sort_name
655 FROM civicrm_contact cc {$from} WHERE cc.contact_type = \"Organization\" AND cc.id = {$currentEmployer} AND cc.sort_name LIKE '$strSearch'");
657 $currEmpDetails = array(
659 'data' => $dao->data
,
666 if (!empty($params['contact_sub_type'])) {
667 $contactSubType = CRM_Utils_Type
::escape($params['contact_sub_type'], 'String');
668 $where .= " AND cc.contact_sub_type = '{$contactSubType}'";
671 if (!empty($params['contact_type'])) {
672 $contactType = CRM_Utils_Type
::escape($params['contact_type'], 'String');
673 $where .= " AND cc.contact_type LIKE '{$contactType}'";
676 //set default for current_employer or return contact with particular id
677 if (!empty($params['id'])) {
678 $where .= " AND cc.id = " . (int) $params['id'];
681 if (!empty($params['cid'])) {
682 $where .= " AND cc.id <> " . (int) $params['cid'];
685 //contact's based of relationhip type
687 if (!empty($params['rel'])) {
688 $relation = explode('_', CRM_Utils_Array
::value('rel', $params));
689 $relType = CRM_Utils_Type
::escape($relation[0], 'Integer');
690 $rel = CRM_Utils_Type
::escape($relation[2], 'String');
693 if ($config->includeWildCardInName
) {
694 $strSearch = "%$name%";
697 $strSearch = "$name%";
699 $includeEmailFrom = $includeNickName = $exactIncludeNickName = '';
700 if ($config->includeNickNameInName
) {
701 $includeNickName = " OR nick_name LIKE '$strSearch'";
702 $exactIncludeNickName = " OR nick_name LIKE '$name'";
706 if (!empty($params['field_name']) && !empty($params['table_name'])) {
707 $table_name = CRM_Utils_String
::munge($params['table_name']);
708 $whereClause = " WHERE ( $table_name.$field_name LIKE '$strSearch')";
709 $exactWhereClause = " WHERE ( $table_name.$field_name = '$name')";
710 // Search by id should be exact
711 if ($field_name == 'id' ||
$field_name == 'external_identifier') {
712 $whereClause = $exactWhereClause;
716 if ($config->includeEmailInName
) {
717 if (!in_array('email', $list)) {
718 $includeEmailFrom = "LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )";
720 $whereClause = " WHERE ( email LIKE '$strSearch' OR sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
721 $exactWhereClause = " WHERE ( email LIKE '$name' OR sort_name LIKE '$name' $exactIncludeNickName ) {$where} ";
724 $whereClause = " WHERE ( sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
725 $exactWhereClause = " WHERE ( sort_name LIKE '$name' $exactIncludeNickName ) {$where} ";
729 $additionalFrom = '';
732 INNER JOIN civicrm_relationship_type r ON (
734 AND ( cc.contact_type = r.contact_type_{$rel} OR r.contact_type_{$rel} IS NULL )
735 AND ( cc.contact_sub_type = r.contact_sub_type_{$rel} OR r.contact_sub_type_{$rel} IS NULL )
739 // check if only CMS users are requested
740 if (!empty($params['cmsuser'])) {
742 INNER JOIN civicrm_uf_match um ON (um.contact_id=cc.id)
747 $orderByOuter = "ORDER BY exactFirst";
748 if ($config->includeOrderByClause
) {
749 $orderByInner = "ORDER BY sort_name";
750 $orderByOuter .= ", sort_name";
755 SELECT DISTINCT(id), data, sort_name {$selectAliases}
757 ( SELECT 0 as exactFirst, cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data {$select}
758 FROM civicrm_contact cc {$from}
760 {$additionalFrom} {$includeEmailFrom}
764 ( SELECT 1 as exactFirst, cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data {$select}
765 FROM civicrm_contact cc {$from}
767 {$additionalFrom} {$includeEmailFrom}
775 // send query to hook to be modified if needed
776 CRM_Utils_Hook
::contactListQuery($query,
778 empty($params['context']) ?
NULL : CRM_Utils_Type
::escape($params['context'], 'String'),
779 empty($params['id']) ?
NULL : $params['id']
782 $dao = CRM_Core_DAO
::executeQuery($query);
784 $contactList = array();
785 $listCurrentEmployer = TRUE;
786 while ($dao->fetch()) {
787 $t = array('id' => $dao->id
);
788 foreach ($as as $k) {
789 $t[$k] = isset($dao->$k)?
$dao->$k: '';
791 $t['data'] = $dao->data
;
793 if (!empty($params['org']) &&
794 !empty($currEmpDetails) &&
795 $dao->id
== $currEmpDetails['id']
797 $listCurrentEmployer = FALSE;
801 //return organization name if doesn't exist in db
802 if (empty($contactList)) {
803 if (!empty($params['org'])) {
804 if ($listCurrentEmployer && !empty($currEmpDetails)) {
805 $contactList = array(
807 'data' => $currEmpDetails['data'],
808 'id' => $currEmpDetails['id']
813 $contactList = array(
823 return civicrm_api3_create_success($contactList, $params);
827 * Merges given pair of duplicate contacts.
829 * @param array $params input parameters
831 * Allowed @params array keys are:
832 * {int main_id main contact id with whom merge has to happen}
833 * {int other_id duplicate contact which would be deleted after merge operation}
834 * {string mode helps decide how to behave when there are conflicts.
835 * A 'safe' value skips the merge if there are no conflicts. Does a force merge otherwise.}
836 * {boolean auto_flip wether to let api decide which contact to retain and which to delete.}
838 * @return array API Result Array
843 function civicrm_api3_contact_merge($params) {
844 $mode = CRM_Utils_Array
::value('mode', $params, 'safe');
845 $autoFlip = CRM_Utils_Array
::value('auto_flip', $params, TRUE);
847 $dupePairs = array(array('srcID' => CRM_Utils_Array
::value('main_id', $params),
848 'dstID' => CRM_Utils_Array
::value('other_id', $params),
850 $result = CRM_Dedupe_Merger
::merge($dupePairs, array(), $mode, $autoFlip);
852 if ($result['is_error'] == 0) {
853 return civicrm_api3_create_success();
856 return civicrm_api3_create_error($result['messages']);
860 function _civicrm_api3_contact_proximity_spec(&$params) {
861 $params['latitude']['api.required'] = 1;
862 $params['longitude']['api.required'] = 1;
863 $params['unit']['api.default'] = 'meter';
866 function civicrm_api3_contact_proximity($params) {
867 $latitude = CRM_Utils_Array
::value('latitude', $params);
868 $longitude = CRM_Utils_Array
::value('longitude', $params);
869 $distance = CRM_Utils_Array
::value('distance', $params);
871 $unit = CRM_Utils_Array
::value('unit', $params);
873 // check and ensure that lat/long and distance are floats
875 !CRM_Utils_Rule
::numeric($latitude) ||
876 !CRM_Utils_Rule
::numeric($longitude) ||
877 !CRM_Utils_Rule
::numeric($distance)
879 throw new Exception(ts('Latitude, Longitude and Distance should exist and be numeric'));
882 if ($unit == "mile") {
883 $conversionFactor = 1609.344;
886 $conversionFactor = 1000;
889 $distance = $distance * $conversionFactor;
891 $whereClause = CRM_Contact_BAO_ProximityQuery
::where($latitude, $longitude, $distance);
894 SELECT civicrm_contact.id as contact_id,
895 civicrm_contact.display_name as display_name
897 LEFT JOIN civicrm_address ON civicrm_contact.id = civicrm_address.contact_id
901 $dao = CRM_Core_DAO
::executeQuery($query);
903 while ($dao->fetch()) {
904 $contacts[] = $dao->toArray();
907 return civicrm_api3_create_success($contacts, $params, 'contact', 'get_by_location', $dao);
912 * @see _civicrm_api3_generic_getlist_params
914 * @param $request array
916 function _civicrm_api3_contact_getlist_params(&$request) {
917 // get the autocomplete options from settings
918 $acpref = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
919 CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
920 'contact_autocomplete_options'
924 // get the option values for contact autocomplete
925 $acOptions = CRM_Core_OptionGroup
::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name');
928 foreach ($acpref as $value) {
929 if ($value && !empty($acOptions[$value])) {
930 $list[] = $acOptions[$value];
933 // If we are doing quicksearch by a field other than name, make sure that field is added to results
934 $field_name = CRM_Utils_String
::munge($request['search_field']);
935 // Unique name contact_id = id
936 if ($field_name == 'contact_id') {
939 // phone_numeric should be phone
940 $searchField = str_replace('_numeric', '', $field_name);
941 if(!in_array($searchField, $list)) {
942 $list[] = $searchField;
944 $request['description_field'] = $list;
945 $list[] = 'contact_type';
946 $request['params']['return'] = array_unique(array_merge($list, $request['extra']));
947 $request['params']['options']['sort'] = 'sort_name';
948 // Contact api doesn't support array(LIKE => 'foo') syntax
949 if (!empty($request['input'])) {
950 $request['params'][$request['search_field']] = $request['input'];
955 * @see _civicrm_api3_generic_getlist_output
957 * @param $result array
958 * @param $request array
962 function _civicrm_api3_contact_getlist_output($result, $request) {
964 if (!empty($result['values'])) {
965 $addressFields = array_intersect(array('street_address', 'city', 'state_province', 'country'), $request['params']['return']);
966 foreach ($result['values'] as $row) {
968 'id' => $row[$request['id_field']],
969 'label' => $row[$request['label_field']],
970 'description' => array(),
972 foreach ($request['description_field'] as $item) {
973 if (!strpos($item, '_name') && !in_array($item, $addressFields) && !empty($row[$item])) {
974 $data['description'][] = $row[$item];
978 foreach($addressFields as $item) {
979 if (!empty($row[$item])) {
980 $address[] = $row[$item];
984 $data['description'][] = implode(' ', $address);
986 if (!empty($request['image_field'])) {
987 $data['image'] = isset($row[$request['image_field']]) ?
$row[$request['image_field']] : '';
990 $data['icon_class'] = $row['contact_type'];
992 foreach ($request['extra'] as $field) {
993 $data['extra'][$field] = isset($row[$field]) ?
$row[$field] : NULL;