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 * @example ContactCreate.php Example of Create Call
51 * @return array API Result Array
56 function civicrm_api3_contact_create($params) {
58 $contactID = CRM_Utils_Array
::value('contact_id', $params, CRM_Utils_Array
::value('id', $params));
59 $dupeCheck = CRM_Utils_Array
::value('dupe_check', $params, FALSE);
60 $values = _civicrm_api3_contact_check_params($params, $dupeCheck);
66 // If we get here, we're ready to create a new contact
67 if (($email = CRM_Utils_Array
::value('email', $params)) && !is_array($params['email'])) {
68 $defLocType = CRM_Core_BAO_LocationType
::getDefault();
69 $params['email'] = array(
70 1 => array('email' => $email,
72 'location_type_id' => ($defLocType->id
) ?
$defLocType->id
: 1,
78 if (!empty($params['home_url'])) {
79 $websiteTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id');
80 $params['website'] = array(1 => array('website_type_id' => key($websiteTypes),
81 'url' => $params['home_url'],
86 _civicrm_api3_greeting_format_params($params);
90 if (empty($params['contact_type']) && $contactID) {
91 $params['contact_type'] = CRM_Contact_BAO_Contact
::getContactType($contactID);
94 if (!isset($params['contact_sub_type']) && $contactID) {
95 $params['contact_sub_type'] = CRM_Contact_BAO_Contact
::getContactSubType($contactID);
98 _civicrm_api3_custom_format_params($params, $values, $params['contact_type'], $contactID);
100 $params = array_merge($params, $values);
101 //@todo we should just call basic_create here - but need to make contact:create accept 'id' on the bao
102 $contact = _civicrm_api3_contact_update($params, $contactID);
104 if (is_a($contact, 'CRM_Core_Error')) {
105 throw new API_Exception($contact->_errors
[0]['message']);
109 _civicrm_api3_object_to_array_unique_fields($contact, $values[$contact->id
]);
112 return civicrm_api3_create_success($values, $params, 'Contact', 'create');
116 * Adjust Metadata for Create action
118 * @param array $params array or parameters determined by getfields
120 function _civicrm_api3_contact_create_spec(&$params) {
121 $params['contact_type']['api.required'] = 1;
122 $params['id']['api.aliases'] = array('contact_id');
123 $params['current_employer'] = array(
124 'title' => 'Current Employer',
125 'description' => 'Name of Current Employer',
126 'type' => CRM_Utils_Type
::T_STRING
,
128 $params['dupe_check'] = array(
129 'title' => 'Check for Duplicates',
130 'description' => 'Throw error if contact create matches dedupe rule',
132 $params['prefix_id']['api.aliases'] = array('individual_prefix', 'individual_prefix_id');
133 $params['suffix_id']['api.aliases'] = array('individual_suffix', 'individual_suffix_id');
137 * Retrieve one or more contacts, given a set of search params
139 * @param array input parameters
141 * @return array API Result Array
142 * (@getfields contact_get}
146 * @example ContactGet.php Standard GET example
149 function civicrm_api3_contact_get($params) {
151 _civicrm_api3_contact_get_supportanomalies($params, $options);
152 $contacts = _civicrm_api3_get_using_query_object('contact', $params, $options);
153 return civicrm_api3_create_success($contacts, $params, 'contact');
156 function civicrm_api3_contact_getcount($params) {
158 _civicrm_api3_contact_get_supportanomalies($params, $options);
159 $count = _civicrm_api3_get_using_query_object('contact', $params, $options,1);
164 * Adjust Metadata for Get action
166 * @param array $params array or parameters determined by getfields
168 function _civicrm_api3_contact_get_spec(&$params) {
169 $params['contact_is_deleted']['api.default'] = 0;
171 //we declare all these pseudofields as there are other undocumented fields accessible
172 // via the api - but if check permissions is set we only allow declared fields
173 $params['address_id']['title'] = 'Primary Address ID';
174 $params['street_address']['title'] = 'Primary Address Street Address';
175 $params['supplemental_address_1']['title'] = 'Primary Address Supplemental Address 1';
176 $params['supplemental_address_2']['title'] = 'Primary Address Supplemental Address 2';
177 $params['current_employer']['title'] = 'Current Employer';
178 $params['city']['title'] = 'Primary Address City';
179 $params['postal_code_suffix']['title'] = 'Primary Address Post Code Suffix';
180 $params['postal_code']['title'] = 'Primary Address Post Code';
181 $params['geo_code_1']['title'] = 'Primary Address Latitude';
182 $params['geo_code_2']['title'] = 'Primary Address Longitude';
183 $params['state_province_id']['title'] = 'Primary Address State Province ID';
184 $params['state_province_name']['title'] = 'Primary Address State Province Name';
185 $params['state_province']['title'] = 'Primary Address State Province';
186 $params['country_id']['title'] = 'Primary Address Country ID';
187 $params['country']['title'] = 'Primary Address country';
188 $params['worldregion_id']['title'] = 'Primary Address World Region ID';
189 $params['worldregion']['title'] = 'Primary Address World Region';
190 $params['phone_id']['title'] = 'Primary Phone ID';
191 $params['phone']['title'] = 'Primary Phone';
192 $params['phone_type_id']['title'] = 'Primary Phone Type ID';
193 $params['provider_id']['title'] = 'Primary Phone Provider ID';
194 $params['email_id']['title'] = 'Primary Email ID';
195 $params['email']['title'] = 'Primary Email';
196 $params['gender_id']['title'] = 'Gender ID';
197 $params['gender']['title'] = 'Gender';
198 $params['on_hold']['title'] = 'Primary Email On Hold';
199 $params['im']['title'] = 'Primary Instant Messanger';
200 $params['im_id']['title'] = 'Primary Instant Messanger ID';
201 $params['group_id']['title'] = 'Group Memberships (filter)';
202 $params['group']['title'] = 'Group Memberships (filter, array)';
203 $params['tag']['title'] = 'Assigned tags (filter, array)';
207 * We are supporting 'showAll' = 'all', 'trash' or 'active' for contact get
209 * - hopefully some day we'll come up with a std syntax for the 3-way-boolean of
212 * We also support 'filter_group_id' & 'filter.group_id'
214 * @param array $params as passed into api get or getcount function
215 * @param array $options array of options (so we can modify the filter)
217 function _civicrm_api3_contact_get_supportanomalies(&$params, &$options) {
218 if (isset($params['showAll'])) {
219 if (strtolower($params['showAll']) == "active") {
220 $params['contact_is_deleted'] = 0;
222 if (strtolower($params['showAll']) == "trash") {
223 $params['contact_is_deleted'] = 1;
225 if (strtolower($params['showAll']) == "all" && isset($params['contact_is_deleted'])) {
226 unset($params['contact_is_deleted']);
229 // support for group filters
230 if (array_key_exists('filter_group_id', $params)) {
231 $params['filter.group_id'] = $params['filter_group_id'];
232 unset($params['filter_group_id']);
234 // filter.group_id works both for 1,2,3 and array (1,2,3)
235 if (array_key_exists('filter.group_id', $params)) {
236 if (is_array($params['filter.group_id'])) {
237 $groups = $params['filter.group_id'];
239 else $groups = explode(',', $params['filter.group_id']);
240 unset($params['filter.group_id']);
241 $groups = array_flip($groups);
242 $groups[key($groups)] = 1;
243 $options['input_params']['group'] = $groups;
248 * Delete a contact with given contact id
250 * @param array $params (reference ) input parameters, contact_id element required
252 * @return array API Result Array
255 * @example ContactDelete.php
256 * {@getfields contact_delete}
258 function civicrm_api3_contact_delete($params) {
260 $contactID = CRM_Utils_Array
::value('id', $params);
262 $session = CRM_Core_Session
::singleton();
263 if ($contactID == $session->get('userID')) {
264 return civicrm_api3_create_error('This contact record is linked to the currently logged in user account - and cannot be deleted.');
266 $restore = !empty($params['restore']) ?
$params['restore'] : FALSE;
267 $skipUndelete = !empty($params['skip_undelete']) ?
$params['skip_undelete'] : FALSE;
270 // restrict permanent delete if a contact has financial trxn associated with it
272 if ($skipUndelete && CRM_Financial_BAO_FinancialItem
::checkContactPresent(array($contactID), $error)) {
273 return civicrm_api3_create_error($error['_qf_default']);
275 if (CRM_Contact_BAO_Contact
::deleteContact($contactID, $restore, $skipUndelete)) {
276 return civicrm_api3_create_success();
279 return civicrm_api3_create_error('Could not delete contact');
284 function _civicrm_api3_contact_check_params( &$params, $dupeCheck = true, $dupeErrorArray = false, $obsoletevalue = true, $dedupeRuleGroupID = null )
287 switch (strtolower(CRM_Utils_Array
::value('contact_type', $params))) {
289 civicrm_api3_verify_mandatory($params, null, array('household_name'));
292 civicrm_api3_verify_mandatory($params, null, array('organization_name'));
295 civicrm_api3_verify_one_mandatory($params, null, array(
305 // Fixme: This really needs to be handled at a lower level. @See CRM-13123
306 if (isset($params['preferred_communication_method'])) {
307 $params['preferred_communication_method'] = CRM_Utils_Array
::implodePadded($params['preferred_communication_method']);
310 if (!empty($params['contact_sub_type']) && !empty($params['contact_type'])) {
311 if (!(CRM_Contact_BAO_ContactType
::isExtendsContactType($params['contact_sub_type'], $params['contact_type']))) {
312 throw new API_Exception("Invalid or Mismatched Contact SubType: " . implode(', ', (array)$params['contact_sub_type']));
317 // check for record already existing
318 $dedupeParams = CRM_Dedupe_Finder
::formatParams($params, $params['contact_type']);
321 // setting 'check_permission' here means that the dedupe checking will be carried out even if the
322 // person does not have permission to carry out de-dupes
323 // this is similar to the front end form
324 if (isset($params['check_permission'])) {
325 $dedupeParams['check_permission'] = $params['check_permission'];
328 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, $params['contact_type'], 'Strict', array());
330 if (count($ids) >0) {
331 throw new API_Exception("Found matching contacts: ". implode(',',$ids),"duplicate",array("ids"=>$ids));
335 // The BAO no longer supports the legacy param "current_employer" so here is a shim for api backward-compatability
336 if (!empty($params['current_employer'])) {
337 $organizationParams = array(
338 'organization_name' => $params['current_employer'],
341 $dedupParams = CRM_Dedupe_Finder
::formatParams($organizationParams, 'Organization');
343 $dedupParams['check_permission'] = FALSE;
344 $dupeIds = CRM_Dedupe_Finder
::dupesByParams($dedupParams, 'Organization', 'Supervised');
346 // check for mismatch employer name and id
347 if (!empty($params['employer_id']) && !in_array($params['employer_id'], $dupeIds)) {
348 throw new API_Exception('Employer name and Employer id Mismatch');
351 // show error if multiple organisation with same name exist
352 if (empty($params['employer_id']) && (count($dupeIds) > 1)) {
353 throw new API_Exception('Found more than one Organisation with same Name.');
357 $params['employer_id'] = $dupeIds[0];
360 $result = civicrm_api3('contact', 'create', array(
361 'organization_name' => $params['current_employer'],
362 'contact_type' => 'Organization'
364 $params['employer_id'] = $result['id'];
372 * Takes an associative array and creates a contact object and all the associated
373 * derived objects (i.e. individual, location, email, phone etc)
375 * @param array $params (reference ) an assoc array of name/value pairs
376 * @param int $contactID if present the contact with that ID is updated
378 * @return object CRM_Contact_BAO_Contact object
382 function _civicrm_api3_contact_update($params, $contactID = NULL) {
383 //@todo - doesn't contact create support 'id' which is already set- check & remove
385 $params['contact_id'] = $contactID;
388 return CRM_Contact_BAO_Contact
::create($params);
392 * Validate the addressee or email or postal greetings
394 * @param $params Associative array of property name/value
395 * pairs to insert in new contact.
397 * @return array (reference ) null on success, error message otherwise
401 function _civicrm_api3_greeting_format_params($params) {
402 $greetingParams = array('', '_id', '_custom');
403 foreach (array('email', 'postal', 'addressee') as $key) {
404 $greeting = '_greeting';
405 if ($key == 'addressee') {
409 $formatParams = FALSE;
410 // unset display value from params.
411 if (isset($params["{$key}{$greeting}_display"])) {
412 unset($params["{$key}{$greeting}_display"]);
415 // check if greetings are present in present
416 foreach ($greetingParams as $greetingValues) {
417 if (array_key_exists("{$key}{$greeting}{$greetingValues}", $params)) {
418 $formatParams = TRUE;
423 if (!$formatParams) {
429 'contact_type' => $params['contact_type'],
430 'greeting_type' => "{$key}{$greeting}",
433 $greetings = CRM_Core_PseudoConstant
::greeting($filter);
434 $greetingId = CRM_Utils_Array
::value("{$key}{$greeting}_id", $params);
435 $greetingVal = CRM_Utils_Array
::value("{$key}{$greeting}", $params);
436 $customGreeting = CRM_Utils_Array
::value("{$key}{$greeting}_custom", $params);
438 if (!$greetingId && $greetingVal) {
439 $params["{$key}{$greeting}_id"] = CRM_Utils_Array
::key($params["{$key}{$greeting}"], $greetings);
442 if ($customGreeting && $greetingId &&
443 ($greetingId != array_search('Customized', $greetings))
445 throw new API_Exception(ts('Provide either %1 greeting id and/or %1 greeting or custom %1 greeting',
450 if ($greetingVal && $greetingId &&
451 ($greetingId != CRM_Utils_Array
::key($greetingVal, $greetings))
453 throw new API_Exception(ts('Mismatch in %1 greeting id and %1 greeting',
460 if (!array_key_exists($greetingId, $greetings)) {
461 throw new API_Exception(ts('Invalid %1 greeting Id', array(1 => $key)));
464 if (!$customGreeting && ($greetingId == array_search('Customized', $greetings))) {
465 throw new API_Exception(ts('Please provide a custom value for %1 greeting',
470 elseif ($greetingVal) {
472 if (!in_array($greetingVal, $greetings)) {
473 throw new API_Exception(ts('Invalid %1 greeting', array(1 => $key)));
476 $greetingId = CRM_Utils_Array
::key($greetingVal, $greetings);
479 if ($customGreeting) {
480 $greetingId = CRM_Utils_Array
::key('Customized', $greetings);
483 $customValue = isset($params['contact_id']) ?
484 CRM_Core_DAO
::getFieldValue(
485 'CRM_Contact_DAO_Contact',
486 $params['contact_id'],
487 "{$key}{$greeting}_custom"
491 if (array_key_exists("{$key}{$greeting}_id", $params) && empty($params["{$key}{$greeting}_id"])) {
494 elseif (array_key_exists("{$key}{$greeting}", $params) && empty($params["{$key}{$greeting}"])) {
497 elseif ($customValue && array_key_exists("{$key}{$greeting}_custom", $params)
498 && empty($params["{$key}{$greeting}_custom"])
503 $params["{$key}{$greeting}_id"] = $greetingId;
505 if (!$customValue && !$customGreeting && array_key_exists("{$key}{$greeting}_custom", $params)) {
506 unset($params["{$key}{$greeting}_custom"]);
510 $params["{$key}{$greeting}_id"] = '';
511 $params["{$key}{$greeting}_custom"] = '';
514 if (isset($params["{$key}{$greeting}"])) {
515 unset($params["{$key}{$greeting}"]);
521 * Old contact quick search api
525 * {@example ContactGetquick.php 0}
528 function civicrm_api3_contact_getquick($params) {
529 civicrm_api3_verify_mandatory($params, NULL, array('name'));
530 $name = CRM_Utils_Type
::escape(CRM_Utils_Array
::value('name', $params), 'String');
532 // get the autocomplete options from settings
533 $acpref = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
534 CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
535 'contact_autocomplete_options'
539 // get the option values for contact autocomplete
540 $acOptions = CRM_Core_OptionGroup
::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name');
543 foreach ($acpref as $value) {
544 if ($value && !empty($acOptions[$value])) {
545 $list[$value] = $acOptions[$value];
548 // If we are doing quicksearch by a field other than name, make sure that field is added to results
549 if (!empty($params['field_name'])) {
550 $field_name = CRM_Utils_String
::munge($params['field_name']);
551 // Unique name contact_id = id
552 if ($field_name == 'contact_id') {
555 // phone_numeric should be phone
556 $searchField = str_replace('_numeric', '', $field_name);
557 if(!in_array($searchField, $list)) {
558 $list[] = $searchField;
562 $select = $actualSelectElements = array('sort_name');
565 foreach ($list as $value) {
566 $suffix = substr($value, 0, 2) . substr($value, -1);
568 case 'street_address':
571 $selectText = $value;
576 $actualSelectElements[] = $select[] = ($value == 'address') ?
$selectText : $value;
577 if ($value == 'phone') {
578 $actualSelectElements[] = $select[] = 'phone_ext';
580 $from[$value] = "LEFT JOIN civicrm_{$value} {$suffix} ON ( cc.id = {$suffix}.contact_id AND {$suffix}.is_primary = 1 ) ";
584 case 'state_province':
585 $select[] = "{$suffix}.name as {$value}";
586 $actualSelectElements[] = "{$suffix}.name";
587 if (!in_array('address', $from)) {
588 $from['address'] = 'LEFT JOIN civicrm_address sts ON ( cc.id = sts.contact_id AND sts.is_primary = 1) ';
590 $from[$value] = " LEFT JOIN civicrm_{$value} {$suffix} ON ( sts.{$value}_id = {$suffix}.id ) ";
594 if ($value != 'id') {
596 if (!empty($params['field_name']) && $params['field_name'] == 'value') {
597 $suffix = CRM_Utils_String
::munge(CRM_Utils_Array
::value('table_name', $params, 'cc'));
599 $actualSelectElements[] = $select[] = $suffix . '.' . $value;
605 $config = CRM_Core_Config
::singleton();
607 $select = implode(', ', $select);
608 if (!empty($select)) {
609 $select = ", $select";
611 $actualSelectElements = implode(', ', $actualSelectElements);
612 $selectAliases = $from;
613 unset($selectAliases['address']);
614 $selectAliases = implode(', ', array_keys($selectAliases));
615 if (!empty($selectAliases)) {
616 $selectAliases = ", $selectAliases";
618 $from = implode(' ', $from);
619 $limit = (int) CRM_Utils_Array
::value('limit', $params);
620 $limit = $limit > 0 ?
$limit : 10;
622 // add acl clause here
623 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause('cc');
626 $where .= " AND $aclWhere ";
629 if (!empty($params['org'])) {
630 $where .= " AND contact_type = \"Organization\"";
632 // CRM-7157, hack: get current employer details when
633 // employee_id is present.
634 $currEmpDetails = array();
635 if (!empty($params['employee_id'])) {
636 if ($currentEmployer = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
637 (int) $params['employee_id'],
640 if ($config->includeWildCardInName
) {
641 $strSearch = "%$name%";
644 $strSearch = "$name%";
647 // get current employer details
648 $dao = CRM_Core_DAO
::executeQuery("SELECT cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data, sort_name
649 FROM civicrm_contact cc {$from} WHERE cc.contact_type = \"Organization\" AND cc.id = {$currentEmployer} AND cc.sort_name LIKE '$strSearch'");
651 $currEmpDetails = array(
653 'data' => $dao->data
,
660 if (!empty($params['contact_sub_type'])) {
661 $contactSubType = CRM_Utils_Type
::escape($params['contact_sub_type'], 'String');
662 $where .= " AND cc.contact_sub_type = '{$contactSubType}'";
665 if (!empty($params['contact_type'])) {
666 $contactType = CRM_Utils_Type
::escape($params['contact_type'], 'String');
667 $where .= " AND cc.contact_type LIKE '{$contactType}'";
670 //set default for current_employer or return contact with particular id
671 if (!empty($params['id'])) {
672 $where .= " AND cc.id = " . (int) $params['id'];
675 if (!empty($params['cid'])) {
676 $where .= " AND cc.id <> " . (int) $params['cid'];
679 //contact's based of relationhip type
681 if (!empty($params['rel'])) {
682 $relation = explode('_', CRM_Utils_Array
::value('rel', $params));
683 $relType = CRM_Utils_Type
::escape($relation[0], 'Integer');
684 $rel = CRM_Utils_Type
::escape($relation[2], 'String');
687 if ($config->includeWildCardInName
) {
688 $strSearch = "%$name%";
691 $strSearch = "$name%";
693 $includeEmailFrom = $includeNickName = $exactIncludeNickName = '';
694 if ($config->includeNickNameInName
) {
695 $includeNickName = " OR nick_name LIKE '$strSearch'";
696 $exactIncludeNickName = " OR nick_name LIKE '$name'";
700 if (!empty($params['field_name']) && !empty($params['table_name'])) {
701 $table_name = CRM_Utils_String
::munge($params['table_name']);
702 $whereClause = " WHERE ( $table_name.$field_name LIKE '$strSearch')";
703 $exactWhereClause = " WHERE ( $table_name.$field_name = '$name')";
704 // Search by id should be exact
705 if ($field_name == 'id' ||
$field_name == 'external_identifier') {
706 $whereClause = $exactWhereClause;
710 if ($config->includeEmailInName
) {
711 if (!in_array('email', $list)) {
712 $includeEmailFrom = "LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )";
714 $whereClause = " WHERE ( email LIKE '$strSearch' OR sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
715 $exactWhereClause = " WHERE ( email LIKE '$name' OR sort_name LIKE '$name' $exactIncludeNickName ) {$where} ";
718 $whereClause = " WHERE ( sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
719 $exactWhereClause = " WHERE ( sort_name LIKE '$name' $exactIncludeNickName ) {$where} ";
723 $additionalFrom = '';
726 INNER JOIN civicrm_relationship_type r ON (
728 AND ( cc.contact_type = r.contact_type_{$rel} OR r.contact_type_{$rel} IS NULL )
729 AND ( cc.contact_sub_type = r.contact_sub_type_{$rel} OR r.contact_sub_type_{$rel} IS NULL )
733 // check if only CMS users are requested
734 if (!empty($params['cmsuser'])) {
736 INNER JOIN civicrm_uf_match um ON (um.contact_id=cc.id)
741 $orderByOuter = "ORDER BY exactFirst";
742 if ($config->includeOrderByClause
) {
743 $orderByInner = "ORDER BY sort_name";
744 $orderByOuter .= ", sort_name";
749 SELECT DISTINCT(id), data, sort_name {$selectAliases}
751 ( SELECT 0 as exactFirst, cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data {$select}
752 FROM civicrm_contact cc {$from}
754 {$additionalFrom} {$includeEmailFrom}
758 ( SELECT 1 as exactFirst, cc.id as id, CONCAT_WS( ' :: ', {$actualSelectElements} ) as data {$select}
759 FROM civicrm_contact cc {$from}
761 {$additionalFrom} {$includeEmailFrom}
769 // send query to hook to be modified if needed
770 CRM_Utils_Hook
::contactListQuery($query,
772 empty($params['context']) ?
NULL : CRM_Utils_Type
::escape($params['context'], 'String'),
773 empty($params['id']) ?
NULL : $params['id']
776 $dao = CRM_Core_DAO
::executeQuery($query);
778 $contactList = array();
779 $listCurrentEmployer = TRUE;
780 while ($dao->fetch()) {
781 $t = array('id' => $dao->id
);
782 foreach ($as as $k) {
783 $t[$k] = isset($dao->$k)?
$dao->$k: '';
785 $t['data'] = $dao->data
;
787 if (!empty($params['org']) &&
788 !empty($currEmpDetails) &&
789 $dao->id
== $currEmpDetails['id']
791 $listCurrentEmployer = FALSE;
795 //return organization name if doesn't exist in db
796 if (empty($contactList)) {
797 if (!empty($params['org'])) {
798 if ($listCurrentEmployer && !empty($currEmpDetails)) {
799 $contactList = array(
801 'data' => $currEmpDetails['data'],
802 'id' => $currEmpDetails['id']
807 $contactList = array(
817 return civicrm_api3_create_success($contactList, $params);
821 * Merges given pair of duplicate contacts.
823 * @param array $params input parameters
825 * Allowed @params array keys are:
826 * {int main_id main contact id with whom merge has to happen}
827 * {int other_id duplicate contact which would be deleted after merge operation}
828 * {string mode helps decide how to behave when there are conflicts.
829 * A 'safe' value skips the merge if there are no conflicts. Does a force merge otherwise.}
830 * {boolean auto_flip wether to let api decide which contact to retain and which to delete.}
832 * @return array API Result Array
837 function civicrm_api3_contact_merge($params) {
838 $mode = CRM_Utils_Array
::value('mode', $params, 'safe');
839 $autoFlip = CRM_Utils_Array
::value('auto_flip', $params, TRUE);
841 $dupePairs = array(array('srcID' => CRM_Utils_Array
::value('main_id', $params),
842 'dstID' => CRM_Utils_Array
::value('other_id', $params),
844 $result = CRM_Dedupe_Merger
::merge($dupePairs, array(), $mode, $autoFlip);
846 if ($result['is_error'] == 0) {
847 return civicrm_api3_create_success();
850 return civicrm_api3_create_error($result['messages']);
854 function _civicrm_api3_contact_proximity_spec(&$params) {
855 $params['latitude']['api.required'] = 1;
856 $params['longitude']['api.required'] = 1;
857 $params['unit']['api.default'] = 'meter';
860 function civicrm_api3_contact_proximity($params) {
861 $latitude = CRM_Utils_Array
::value('latitude', $params);
862 $longitude = CRM_Utils_Array
::value('longitude', $params);
863 $distance = CRM_Utils_Array
::value('distance', $params);
865 $unit = CRM_Utils_Array
::value('unit', $params);
867 // check and ensure that lat/long and distance are floats
869 !CRM_Utils_Rule
::numeric($latitude) ||
870 !CRM_Utils_Rule
::numeric($longitude) ||
871 !CRM_Utils_Rule
::numeric($distance)
873 throw new Exception(ts('Latitude, Longitude and Distance should exist and be numeric'));
876 if ($unit == "mile") {
877 $conversionFactor = 1609.344;
880 $conversionFactor = 1000;
883 $distance = $distance * $conversionFactor;
885 $whereClause = CRM_Contact_BAO_ProximityQuery
::where($latitude, $longitude, $distance);
888 SELECT civicrm_contact.id as contact_id,
889 civicrm_contact.display_name as display_name
891 LEFT JOIN civicrm_address ON civicrm_contact.id = civicrm_address.contact_id
895 $dao = CRM_Core_DAO
::executeQuery($query);
897 while ($dao->fetch()) {
898 $contacts[] = $dao->toArray();
901 return civicrm_api3_create_success($contacts, $params, 'contact', 'get_by_location', $dao);
906 * @see _civicrm_api3_generic_getlist_params
908 * @param $request array
910 function _civicrm_api3_contact_getlist_params(&$request) {
911 // get the autocomplete options from settings
912 $acpref = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
913 CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
914 'contact_autocomplete_options'
918 // get the option values for contact autocomplete
919 $acOptions = CRM_Core_OptionGroup
::values('contact_autocomplete_options', FALSE, FALSE, FALSE, NULL, 'name');
922 foreach ($acpref as $value) {
923 if ($value && !empty($acOptions[$value])) {
924 $list[] = $acOptions[$value];
927 // If we are doing quicksearch by a field other than name, make sure that field is added to results
928 $field_name = CRM_Utils_String
::munge($request['search_field']);
929 // Unique name contact_id = id
930 if ($field_name == 'contact_id') {
933 // phone_numeric should be phone
934 $searchField = str_replace('_numeric', '', $field_name);
935 if(!in_array($searchField, $list)) {
936 $list[] = $searchField;
938 $request['description_field'] = $list;
939 $list[] = 'contact_type';
940 $request['params']['return'] = array_unique(array_merge($list, $request['extra']));
941 $request['params']['options']['sort'] = 'sort_name';
942 // Contact api doesn't support array(LIKE => 'foo') syntax
943 if (!empty($request['input'])) {
944 $request['params'][$request['search_field']] = $request['input'];
949 * @see _civicrm_api3_generic_getlist_output
951 * @param $result array
952 * @param $request array
956 function _civicrm_api3_contact_getlist_output($result, $request) {
958 if (!empty($result['values'])) {
959 $addressFields = array_intersect(array('street_address', 'city', 'state_province', 'country'), $request['params']['return']);
960 foreach ($result['values'] as $row) {
962 'id' => $row[$request['id_field']],
963 'label' => $row[$request['label_field']],
964 'description' => array(),
966 foreach ($request['description_field'] as $item) {
967 if (!strpos($item, '_name') && !in_array($item, $addressFields) && !empty($row[$item])) {
968 $data['description'][] = $row[$item];
972 foreach($addressFields as $item) {
973 if (!empty($row[$item])) {
974 $address[] = $row[$item];
978 $data['description'][] = implode(' ', $address);
980 if (!empty($request['image_field'])) {
981 $data['image'] = isset($row[$request['image_field']]) ?
$row[$request['image_field']] : '';
984 $data['icon_class'] = $row['contact_type'];
986 foreach ($request['extra'] as $field) {
987 $data['extra'][$field] = isset($row[$field]) ?
$row[$field] : NULL;