3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 class CRM_Contact_BAO_Contact
extends CRM_Contact_DAO_Contact
{
20 * SQL function used to format the phone_numeric field via trigger.
22 * @see self::triggerInfo()
24 * Note that this is also used by the 4.3 upgrade script.
25 * @see CRM_Upgrade_Incremental_php_FourThree
27 const DROP_STRIP_FUNCTION_43
= "DROP FUNCTION IF EXISTS civicrm_strip_non_numeric";
29 const CREATE_STRIP_FUNCTION_43
= "
30 CREATE FUNCTION civicrm_strip_non_numeric(input VARCHAR(255))
35 DECLARE output VARCHAR(255) DEFAULT '';
36 DECLARE iterator INT DEFAULT 1;
37 WHILE iterator < (LENGTH(input) + 1) DO
38 IF SUBSTRING(input, iterator, 1) IN ('0', '1', '2', '3', '4', '5', '6', '7', '8', '9') THEN
39 SET output = CONCAT(output, SUBSTRING(input, iterator, 1));
41 SET iterator = iterator + 1;
47 * The types of communication preferences.
51 public static $_commPrefs = [
64 public static $_greetingTypes = [
71 * Static field for all the contact information that we can potentially import.
75 public static $_importableFields = [];
78 * Static field for all the contact information that we can potentially export.
82 public static $_exportableFields = NULL;
87 public function __construct() {
88 parent
::__construct();
92 * Takes an associative array and creates a contact object.
94 * The function extracts all the params it needs to initialize the create a
95 * contact object. the params array could contain additional unused name/value
98 * @param array $params
99 * (reference) an assoc array of name/value pairs.
101 * @return CRM_Contact_DAO_Contact|CRM_Core_Error|NULL
102 * Created or updated contact object or error object.
103 * (error objects are being phased out in favour of exceptions)
104 * @throws \CRM_Core_Exception
106 public static function add(&$params) {
107 $contact = new CRM_Contact_DAO_Contact();
108 $contactID = $params['contact_id'] ??
NULL;
109 if (empty($params)) {
113 // Fix for validate contact sub type CRM-5143.
114 if (isset($params['contact_sub_type'])) {
115 if (empty($params['contact_sub_type'])) {
116 $params['contact_sub_type'] = 'null';
118 elseif ($params['contact_sub_type'] !== 'null') {
119 if (!CRM_Contact_BAO_ContactType
::isExtendsContactType($params['contact_sub_type'],
120 $params['contact_type'], TRUE
123 // we'll need to fix tests to handle this
125 throw new CRM_Core_Exception(ts('The Contact Sub Type does not match the Contact type for this record'));
127 $params['contact_sub_type'] = CRM_Utils_Array
::implodePadded($params['contact_sub_type']);
131 if (isset($params['preferred_communication_method']) && is_array($params['preferred_communication_method'])) {
132 CRM_Utils_Array
::formatArrayKeys($params['preferred_communication_method']);
133 $contact->preferred_communication_method
= CRM_Utils_Array
::implodePadded($params['preferred_communication_method']);
134 unset($params['preferred_communication_method']);
137 $defaults = ['source' => $params['contact_source'] ??
NULL];
138 if ($params['contact_type'] === 'Organization' && isset($params['organization_name'])) {
139 $defaults['display_name'] = $params['organization_name'];
140 $defaults['sort_name'] = $params['organization_name'];
142 if ($params['contact_type'] === 'Household' && isset($params['household_name'])) {
143 $defaults['display_name'] = $params['household_name'];
144 $defaults['sort_name'] = $params['household_name'];
146 $params = array_merge($defaults, $params);
148 $allNull = $contact->copyValues($params);
150 $contact->id
= $contactID;
152 if ($contact->contact_type
=== 'Individual') {
154 // @todo allow the lines below to be overridden by input or hooks & add tests,
155 // as has been done for households and organizations.
156 // Format individual fields.
157 CRM_Contact_BAO_Individual
::format($params, $contact);
160 if (strlen($contact->display_name
) > 128) {
161 $contact->display_name
= substr($contact->display_name
, 0, 128);
163 if (strlen($contact->sort_name
) > 128) {
164 $contact->sort_name
= substr($contact->sort_name
, 0, 128);
167 $privacy = $params['privacy'] ??
NULL;
168 if ($privacy && is_array($privacy)) {
170 foreach (self
::$_commPrefs as $name) {
171 $contact->$name = $privacy[$name] ??
FALSE;
175 // Since hash was required, make sure we have a 0 value for it (CRM-1063).
176 // @todo - does this mean we can remove this block?
177 // Fixed in 1.5 by making hash optional, only do this in create mode, not update.
178 if ((!isset($contact->hash
) ||
!$contact->hash
) && !$contact->id
) {
180 $contact->hash
= md5(uniqid(rand(), TRUE));
183 // Even if we don't need $employerId, it's important to call getFieldValue() before
184 // the contact is saved because we want the existing value to be cached.
185 // createCurrentEmployerRelationship() needs the old value not the updated one. CRM-10788
186 $employerId = (!$contactID ||
$contact->contact_type
!== 'Individual') ?
NULL : CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contact->id
, 'employer_id');
191 CRM_Core_BAO_Log
::register($contact->id
,
197 if ($contact->contact_type
=== 'Individual' && (isset($params['current_employer']) ||
isset($params['employer_id']))) {
198 // Create current employer.
199 $newEmployer = !empty($params['employer_id']) ?
$params['employer_id'] : $params['current_employer'] ??
NULL;
201 $newContact = empty($params['contact_id']);
203 CRM_Contact_BAO_Contact_Utils
::createCurrentEmployerRelationship($contact->id
, $newEmployer, $employerId, $newContact);
205 elseif ($employerId) {
206 CRM_Contact_BAO_Contact_Utils
::clearCurrentEmployer($contact->id
, $employerId);
210 // Update cached employer name if the name of an existing organization is being updated.
211 if ($contact->contact_type
=== 'Organization' && !empty($params['organization_name']) && $contactID) {
212 CRM_Contact_BAO_Contact_Utils
::updateCurrentEmployer($contact->id
);
221 * takes an associative array and creates a contact object and all the associated
222 * derived objects (i.e. individual, location, email, phone etc)
224 * This function is invoked from within the web form layer and also from the api layer
226 * @param array $params
227 * (reference ) an assoc array of name/value pairs.
228 * @param bool $fixAddress
229 * If we need to fix address.
230 * @param bool $invokeHooks
231 * If we need to invoke hooks.
233 * @param bool $skipDelete
234 * Unclear parameter, passed to website create
236 * @return CRM_Contact_BAO_Contact|CRM_Core_Error
237 * Created or updated contribution object. We are deprecating returning an error in
238 * favour of exceptions
240 * @throws \CRM_Core_Exception
241 * @throws \CiviCRM_API3_Exception
242 * @throws \Civi\API\Exception\UnauthorizedException
244 public static function &create(&$params, $fixAddress = TRUE, $invokeHooks = TRUE, $skipDelete = FALSE) {
246 if (empty($params['contact_type']) && empty($params['contact_id'])) {
250 $isEdit = !empty($params['contact_id']);
252 if ($isEdit && empty($params['contact_type'])) {
253 $params['contact_type'] = self
::getContactType($params['contact_id']);
256 if (!empty($params['check_permissions']) && isset($params['api_key'])
257 && !CRM_Core_Permission
::check([['edit api keys', 'administer CiviCRM']])
258 && !($isEdit && CRM_Core_Permission
::check('edit own api keys') && $params['contact_id'] == CRM_Core_Session
::getLoggedInContactID())
260 throw new \Civi\API\Exception\
UnauthorizedException('Permission denied to modify api key');
264 if (!empty($params['contact_id'])) {
265 CRM_Utils_Hook
::pre('edit', $params['contact_type'], $params['contact_id'], $params);
268 CRM_Utils_Hook
::pre('create', $params['contact_type'], NULL, $params);
272 self
::ensureGreetingParamsAreSet($params);
274 // CRM-6942: set preferred language to the current language if it’s unset (and we’re creating a contact).
275 if (empty($params['contact_id'])) {
276 // A case could be made for checking isset rather than empty but this is more consistent with previous behaviour.
277 if (empty($params['preferred_language']) && ($language = CRM_Core_I18n
::getContactDefaultLanguage()) != FALSE) {
278 $params['preferred_language'] = $language;
281 // CRM-21041: set default 'Communication Style' if unset when creating a contact.
282 if (empty($params['communication_style_id'])) {
283 $defaultCommunicationStyleId = CRM_Core_OptionGroup
::values('communication_style', TRUE, NULL, NULL, 'AND is_default = 1');
284 $params['communication_style_id'] = array_pop($defaultCommunicationStyleId);
288 $transaction = new CRM_Core_Transaction();
290 $contact = self
::add($params);
292 $params['contact_id'] = $contact->id
;
294 if (Civi
::settings()->get('is_enabled')) {
295 // Enabling multisite causes the contact to be added to the domain group.
296 $domainGroupID = CRM_Core_BAO_Domain
::getGroupId();
297 if (!empty($domainGroupID)) {
298 if (!empty($params['group']) && is_array($params['group'])) {
299 $params['group'][$domainGroupID] = 1;
302 $params['group'] = [$domainGroupID => 1];
307 if (!empty($params['group'])) {
308 $contactIds = [$params['contact_id']];
309 foreach ($params['group'] as $groupId => $flag) {
311 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $groupId);
313 elseif ($flag == -1) {
314 CRM_Contact_BAO_GroupContact
::removeContactsFromGroup($contactIds, $groupId);
319 // Add location Block data.
320 $blocks = CRM_Core_BAO_Location
::create($params, $fixAddress);
321 foreach ($blocks as $name => $value) {
322 $contact->$name = $value;
324 if (!empty($params['updateBlankLocInfo'])) {
328 if (isset($params['website'])) {
329 CRM_Core_BAO_Website
::process($params['website'], $contact->id
, $skipDelete);
332 $userID = CRM_Core_Session
::singleton()->get('userID');
334 if (!empty($params['note'])) {
335 if (is_array($params['note'])) {
336 foreach ($params['note'] as $note) {
337 $contactId = $contact->id
;
338 if (isset($note['contact_id'])) {
339 $contactId = $note['contact_id'];
341 //if logged in user, overwrite contactId
343 $contactId = $userID;
347 'entity_id' => $contact->id
,
348 'entity_table' => 'civicrm_contact',
349 'note' => $note['note'],
350 'subject' => $note['subject'] ??
NULL,
351 'contact_id' => $contactId,
353 CRM_Core_BAO_Note
::add($noteParams);
357 $contactId = $contact->id
;
358 //if logged in user, overwrite contactId
360 $contactId = $userID;
364 'entity_id' => $contact->id
,
365 'entity_table' => 'civicrm_contact',
366 'note' => $params['note'],
367 'subject' => $params['subject'] ??
NULL,
368 'contact_id' => $contactId,
370 CRM_Core_BAO_Note
::add($noteParams);
374 // update the UF user_unique_id if that has changed
375 CRM_Core_BAO_UFMatch
::updateUFName($contact->id
);
377 if (!empty($params['custom']) &&
378 is_array($params['custom'])
380 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_contact', $contact->id
);
383 $transaction->commit();
385 // CRM-6367: fetch the right label for contact type’s display
386 $contact->contact_type_display
= CRM_Core_DAO
::getFieldValue(
387 'CRM_Contact_DAO_ContactType',
388 $contact->contact_type
,
393 CRM_Contact_BAO_Contact_Utils
::clearContactCaches();
397 CRM_Utils_Hook
::post('edit', $params['contact_type'], $contact->id
, $contact);
400 CRM_Utils_Hook
::post('create', $params['contact_type'], $contact->id
, $contact);
404 // In order to prevent a series of expensive queries in intensive batch processing
405 // api calls may pass in skip_greeting_processing, probably doing it later via the
406 // scheduled job. CRM-21551
407 if (empty($params['skip_greeting_processing'])) {
408 self
::processGreetings($contact);
411 if (!empty($params['check_permissions'])) {
412 $contacts = [&$contact];
413 self
::unsetProtectedFields($contacts);
416 if (!empty($params['is_deceased'])) {
417 // Edit Membership Status
419 'contact_id' => $contact->id
,
420 'is_deceased' => $params['is_deceased'],
421 'deceased_date' => $params['deceased_date'] ??
NULL,
423 CRM_Member_BAO_Membership
::updateMembershipStatus($deceasedParams, $params['contact_type']);
430 * Format the output of the create contact function
432 * @param CRM_Contact_DAO_Contact[]|array[] $contacts
434 public static function unsetProtectedFields(&$contacts) {
435 if (!CRM_Core_Permission
::check([['edit api keys', 'administer CiviCRM']])) {
436 $currentUser = CRM_Core_Session
::getLoggedInContactID();
437 $editOwn = $currentUser && CRM_Core_Permission
::check('edit own api keys');
438 foreach ($contacts as &$contact) {
439 $cid = is_object($contact) ?
$contact->id
: $contact['id'] ??
NULL;
440 if (!($editOwn && $cid == $currentUser)) {
441 if (is_object($contact)) {
442 unset($contact->api_key
);
445 unset($contact['api_key']);
453 * Ensure greeting parameters are set.
455 * By always populating greetings here we can be sure they are set if required & avoid a call later.
456 * (ie. knowing we have definitely tried disambiguates between NULL & not loaded.)
458 * @param array $params
460 * @throws \CiviCRM_API3_Exception
462 public static function ensureGreetingParamsAreSet(&$params) {
463 $allGreetingParams = ['addressee' => 'addressee_id', 'postal_greeting' => 'postal_greeting_id', 'email_greeting' => 'email_greeting_id'];
464 $missingGreetingParams = [];
466 foreach ($allGreetingParams as $greetingIndex => $greetingParam) {
467 if (empty($params[$greetingParam])) {
468 $missingGreetingParams[$greetingIndex] = $greetingParam;
472 if (!empty($params['contact_id']) && !empty($missingGreetingParams)) {
473 $savedGreetings = civicrm_api3('Contact', 'getsingle', [
474 'id' => $params['contact_id'],
475 'return' => array_keys($missingGreetingParams),
478 foreach (array_keys($missingGreetingParams) as $missingGreetingParam) {
479 if (!empty($savedGreetings[$missingGreetingParam . '_custom'])) {
480 $missingGreetingParams[$missingGreetingParam . '_custom'] = $missingGreetingParam . '_custom';
483 // Filter out other fields.
484 $savedGreetings = array_intersect_key($savedGreetings, array_flip($missingGreetingParams));
485 $params = array_merge($params, $savedGreetings);
488 foreach ($missingGreetingParams as $greetingName => $greeting) {
489 $params[$greeting] = CRM_Contact_BAO_Contact_Utils
::defaultGreeting($params['contact_type'], $greetingName);
493 foreach ($allGreetingParams as $greetingIndex => $greetingParam) {
494 if ($params[$greetingParam] === 'null') {
495 // If we are setting it to null then null out the display field.
496 $params[$greetingIndex . '_display'] = 'null';
502 * Get the display name and image of a contact.
507 * @param bool $includeTypeInReturnParameters
508 * Should type be part of the returned array?
511 * the displayName and contactImage for this contact
513 public static function getDisplayAndImage($id, $includeTypeInReturnParameters = FALSE) {
514 //CRM-14276 added the * on the civicrm_contact table so that we have all the contact info available
516 SELECT civicrm_contact.*,
517 civicrm_email.email as email
519 LEFT JOIN civicrm_email ON civicrm_email.contact_id = civicrm_contact.id
520 AND civicrm_email.is_primary = 1
521 WHERE civicrm_contact.id = " . CRM_Utils_Type
::escape($id, 'Integer');
522 $dao = new CRM_Core_DAO();
525 $image = CRM_Contact_BAO_Contact_Utils
::getImage($dao->contact_sub_type ?
526 $dao->contact_sub_type
: $dao->contact_type
, FALSE, $id
528 $imageUrl = CRM_Contact_BAO_Contact_Utils
::getImage($dao->contact_sub_type ?
529 $dao->contact_sub_type
: $dao->contact_type
, TRUE, $id
532 // use email if display_name is empty
533 if (empty($dao->display_name
)) {
534 $displayName = $dao->email
;
537 $displayName = $dao->display_name
;
540 CRM_Utils_Hook
::alterDisplayName($displayName, $id, $dao);
542 return $includeTypeInReturnParameters ?
[
546 $dao->contact_sub_type
,
548 ] : [$displayName, $image, $imageUrl];
554 * Add billing fields to the params if appropriate.
556 * If we have ANY name fields then we want to ignore all the billing name fields. However, if we
557 * don't then we should set the name fields to the billing fields AND add the preserveDBName
558 * parameter (which will tell the BAO only to set those fields if none already exist.
560 * We specifically don't want to set first name from billing and last name form an on-page field. Mixing &
561 * matching is best done by hipsters.
563 * @param array $params
565 * @fixme How does this relate to almost the same thing being done in CRM_Core_Form::formatParamsForPaymentProcessor()
567 public static function addBillingNameFieldsIfOtherwiseNotSet(&$params) {
568 $nameFields = ['first_name', 'middle_name', 'last_name', 'nick_name', 'prefix_id', 'suffix_id'];
569 foreach ($nameFields as $field) {
570 if (!empty($params[$field])) {
574 // There are only 3 - we can iterate through them twice :-)
575 foreach ($nameFields as $field) {
576 if (!empty($params['billing_' . $field])) {
577 $params[$field] = $params['billing_' . $field];
579 $params['preserveDBName'] = TRUE;
585 * Resolve a state province string (UT or Utah) to an ID.
587 * If country has been passed in we should select a state belonging to that country.
589 * Alternatively we should choose from enabled countries, prioritising the default country.
591 * @param array $values
592 * @param int|null $countryID
596 * @throws \CRM_Core_Exception
598 protected static function resolveStateProvinceID($values, $countryID) {
601 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceForCountry($countryID);
602 if (CRM_Utils_Array
::lookupValue($values,
607 return $values['state_province_id'];
609 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceForCountry($countryID, 'abbreviation');
610 if (CRM_Utils_Array
::lookupValue($values,
615 return $values['state_province_id'];
620 // The underlying lookupValue function needs some de-fanging. Until that has been unravelled we
621 // continue to resolve stateprovince lists in descending order of preference & just 'keep trying'.
622 // prefer matching country..
623 $stateProvinceList = CRM_Core_BAO_Address
::buildOptions('state_province_id', NULL, ['country_id' => Civi
::settings()->get('defaultContactCountry')]);
624 if (CRM_Utils_Array
::lookupValue($values,
629 return $values['state_province_id'];
632 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvince();
633 if (CRM_Utils_Array
::lookupValue($values,
638 return $values['state_province_id'];
641 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceAbbreviationForDefaultCountry();
642 if (CRM_Utils_Array
::lookupValue($values,
647 return $values['state_province_id'];
649 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceAbbreviation();
650 if (CRM_Utils_Array
::lookupValue($values,
655 return $values['state_province_id'];
663 * Get the relevant location entity for the array key.
665 * Based on the field name we determine which location entity
666 * we are dealing with. Apart from a few specific ones they
667 * are mostly 'address' (the default).
669 * @param string $fieldName
673 protected static function getLocationEntityForKey($fieldName) {
674 if (in_array($fieldName, ['email', 'phone', 'im', 'openid'])) {
677 if ($fieldName === 'phone_ext') {
684 * Soft delete a contact.
686 * Call this via the api, not directly.
688 * @param \CRM_Contact_BAO_Contact $contact
691 * @throws \CRM_Core_Exception
693 protected static function contactTrash($contact): bool {
695 'id' => $contact->id
,
698 CRM_Utils_Hook
::pre('update', $contact->contact_type
, $contact->id
, $updateParams);
700 $params = [1 => [$contact->id
, 'Integer']];
701 $query = 'DELETE FROM civicrm_uf_match WHERE contact_id = %1';
702 CRM_Core_DAO
::executeQuery($query, $params);
704 $contact->copyValues($updateParams);
706 CRM_Core_BAO_Log
::register($contact->id
, 'civicrm_contact', $contact->id
);
708 CRM_Utils_Hook
::post('update', $contact->contact_type
, $contact->id
, $contact);
714 * Create last viewed link to recently updated contact.
716 * @param array $crudLinkSpec
717 * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
718 * - entity_table: string, eg "civicrm_contact"
722 * NULL if unavailable, or
723 * [path: string, query: string, title: string]
724 * @see CRM_Utils_System::createDefaultCrudLink
726 public function createDefaultCrudLink($crudLinkSpec) {
727 switch ($crudLinkSpec['action']) {
728 case CRM_Core_Action
::VIEW
:
730 'title' => $this->display_name
,
731 'path' => 'civicrm/contact/view',
739 case CRM_Core_Action
::UPDATE
:
741 'title' => $this->display_name
,
742 'path' => 'civicrm/contact/add',
745 'action' => 'update',
755 * Get the values for pseudoconstants for name->value and reverse.
757 * @param array $defaults
758 * (reference) the default values, some of which need to be resolved.
759 * @param bool $reverse
760 * Always true as this function is only called from one place..
764 * This is called specifically from the contact import parser & should be moved there
765 * as it is not truly a generic function.
768 public static function resolveDefaults(&$defaults, $reverse = FALSE) {
769 // Hack for birth_date.
770 if (!empty($defaults['birth_date'])) {
771 if (is_array($defaults['birth_date'])) {
772 $defaults['birth_date'] = CRM_Utils_Date
::format($defaults['birth_date'], '-');
776 CRM_Utils_Array
::lookupValue($defaults, 'prefix', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'prefix_id'), $reverse);
777 CRM_Utils_Array
::lookupValue($defaults, 'suffix', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'suffix_id'), $reverse);
778 CRM_Utils_Array
::lookupValue($defaults, 'gender', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id'), $reverse);
779 CRM_Utils_Array
::lookupValue($defaults, 'communication_style', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'communication_style_id'), $reverse);
781 //lookup value of email/postal greeting, addressee, CRM-4575
782 foreach (self
::$_greetingTypes as $greeting) {
784 'contact_type' => $defaults['contact_type'] ??
NULL,
785 'greeting_type' => $greeting,
787 CRM_Utils_Array
::lookupValue($defaults, $greeting,
788 CRM_Core_PseudoConstant
::greeting($filterCondition), $reverse
792 $blocks = ['address', 'im', 'phone'];
793 foreach ($blocks as $name) {
794 if (!array_key_exists($name, $defaults) ||
!is_array($defaults[$name])) {
797 foreach ($defaults[$name] as $count => & $values) {
799 //get location type id.
800 CRM_Utils_Array
::lookupValue($values, 'location_type', CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id'), $reverse);
802 if ($name == 'address') {
803 // FIXME: lookupValue doesn't work for vcard_name
804 if (!empty($values['location_type_id'])) {
805 $vcardNames = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id', ['labelColumn' => 'vcard_name']);
806 $values['vcard_name'] = $vcardNames[$values['location_type_id']];
809 if (!CRM_Utils_Array
::lookupValue($values,
811 CRM_Core_PseudoConstant
::country(),
816 CRM_Utils_Array
::lookupValue($values,
818 CRM_Core_PseudoConstant
::countryIsoCode(),
822 $stateProvinceID = self
::resolveStateProvinceID($values, $values['country_id'] ??
NULL);
823 if ($stateProvinceID) {
824 $values['state_province_id'] = $stateProvinceID;
827 if (!empty($values['state_province_id'])) {
828 $countyList = CRM_Core_PseudoConstant
::countyForState($values['state_province_id']);
831 $countyList = CRM_Core_PseudoConstant
::county();
833 CRM_Utils_Array
::lookupValue($values,
841 CRM_Utils_Array
::lookupValue($values,
843 CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id'),
848 if ($name == 'phone') {
849 CRM_Utils_Array
::lookupValue($values,
851 CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id'),
856 // Kill the reference.
863 * Fetch object based on array of properties.
865 * @param array $params
866 * (reference ) an assoc array of name/value pairs.
867 * @param array $defaults
868 * (reference ) an assoc array to hold the name / value pairs.
869 * in a hierarchical manner
870 * @param bool $microformat
871 * For location in microformat.
873 * @return CRM_Contact_BAO_Contact
875 public static function &retrieve(&$params, &$defaults, $microformat = FALSE) {
876 if (array_key_exists('contact_id', $params)) {
877 $params['id'] = $params['contact_id'];
879 elseif (array_key_exists('id', $params)) {
880 $params['contact_id'] = $params['id'];
883 $contact = self
::getValues($params, $defaults);
885 unset($params['id']);
887 //get the block information for this contact
888 $entityBlock = ['contact_id' => $params['contact_id']];
889 $blocks = CRM_Core_BAO_Location
::getValues($entityBlock, $microformat);
890 $defaults = array_merge($defaults, $blocks);
891 foreach ($blocks as $block => $value) {
892 $contact->$block = $value;
895 if (!isset($params['noNotes'])) {
896 $contact->notes
= CRM_Core_BAO_Note
::getValues($params, $defaults);
899 if (!isset($params['noRelationships'])) {
900 $contact->relationship
= CRM_Contact_BAO_Relationship
::getValues($params, $defaults);
903 if (!isset($params['noGroups'])) {
904 $contact->groupContact
= CRM_Contact_BAO_GroupContact
::getValues($params, $defaults);
907 if (!isset($params['noWebsite'])) {
908 $contact->website
= CRM_Core_BAO_Website
::getValues($params, $defaults);
915 * Get the display name of a contact.
920 * @return null|string
921 * display name of the contact if found
923 public static function displayName($id) {
926 $displayName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $id, 'display_name');
933 * Delete a contact and all its associated records.
936 * Id of the contact to delete.
937 * @param bool $restore
938 * Whether to actually restore, not delete.
939 * @param bool $skipUndelete
940 * Whether to force contact delete or not.
941 * @param bool $checkPermissions
944 * Was contact deleted?
946 * @throws \CRM_Core_Exception
947 * @throws \CiviCRM_API3_Exception
949 public static function deleteContact($id, $restore = FALSE, $skipUndelete = FALSE, $checkPermissions = TRUE) {
951 if (!$id ||
!is_numeric($id)) {
952 CRM_Core_Error
::deprecatedFunctionWarning('calling delete contact without a valid contact ID is deprecated.');
955 // If trash is disabled in system settings then we always skip
956 if (!Civi
::settings()->get('contact_undelete')) {
957 $skipUndelete = TRUE;
960 // make sure we have edit permission for this contact
962 if ($checkPermissions && (($skipUndelete && !CRM_Core_Permission
::check('delete contacts')) ||
963 ($restore && !CRM_Core_Permission
::check('access deleted contacts')))
969 // Restrict contact to be delete if contact has financial trxns
971 if ($skipUndelete && CRM_Financial_BAO_FinancialItem
::checkContactPresent([$id], $error)) {
975 // make sure this contact_id does not have any membership types
976 $membershipTypeID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
979 'member_of_contact_id'
981 if ($membershipTypeID) {
985 $contact = new CRM_Contact_DAO_Contact();
987 if (!$contact->find(TRUE)) {
991 $contactType = $contact->contact_type
;
993 // @todo deprecate calling contactDelete with the intention to restore.
995 'id' => $contact->id
,
996 'is_deleted' => FALSE,
998 self
::create($updateParams);
1002 // start a new transaction
1003 $transaction = new CRM_Core_Transaction();
1005 if ($skipUndelete) {
1006 $hookParams = ['check_permissions' => $checkPermissions];
1007 CRM_Utils_Hook
::pre('delete', $contactType, $id, $hookParams);
1009 //delete billing address if exists.
1010 CRM_Contribute_BAO_Contribution
::deleteAddress(NULL, $id);
1012 // delete the log entries since we dont have triggers enabled as yet
1013 $logDAO = new CRM_Core_DAO_Log();
1014 $logDAO->entity_table
= 'civicrm_contact';
1015 $logDAO->entity_id
= $id;
1018 // delete contact participants CRM-12155
1019 CRM_Event_BAO_Participant
::deleteContactParticipant($id);
1021 // delete contact contributions CRM-12155
1022 CRM_Contribute_BAO_Contribution
::deleteContactContribution($id);
1024 // do activity cleanup, CRM-5604
1025 CRM_Activity_BAO_Activity
::cleanupActivity($id);
1027 // delete all notes related to contact
1028 CRM_Core_BAO_Note
::cleanContactNotes($id);
1030 // delete cases related to contact
1031 $contactCases = CRM_Case_BAO_Case
::retrieveCaseIdsByContactId($id);
1032 if (!empty($contactCases)) {
1033 foreach ($contactCases as $caseId) {
1034 //check if case is associate with other contact or not.
1035 $caseContactId = CRM_Case_BAO_Case
::getCaseClients($caseId);
1036 if (count($caseContactId) <= 1) {
1037 CRM_Case_BAO_Case
::deleteCase($caseId);
1045 self
::contactTrash($contact);
1047 // currently we only clear employer cache.
1048 // we are now deleting inherited membership if any.
1049 if ($contact->contact_type
== 'Organization') {
1050 $action = $restore ? CRM_Core_Action
::ENABLE
: CRM_Core_Action
::DISABLE
;
1051 $relationshipDtls = CRM_Contact_BAO_Relationship
::getRelationship($id);
1052 if (!empty($relationshipDtls)) {
1053 foreach ($relationshipDtls as $rId => $details) {
1054 CRM_Contact_BAO_Relationship
::disableEnableRelationship($rId, $action);
1057 CRM_Contact_BAO_Contact_Utils
::clearAllEmployee($id);
1060 //delete the contact id from recently view
1061 CRM_Utils_Recent
::delContact($id);
1062 self
::updateContactCache($id, empty($restore));
1064 // delete any prevnext/dupe cache entry
1065 // These two calls are redundant in default deployments, but they're
1066 // meaningful if "prevnext" is memory-backed.
1067 Civi
::service('prevnext')->deleteItem($id);
1068 CRM_Core_BAO_PrevNextCache
::deleteItem($id);
1070 $transaction->commit();
1072 if ($skipUndelete) {
1073 CRM_Utils_Hook
::post('delete', $contactType, $contact->id
, $contact);
1080 * Action to update any caches relating to a recently update contact.
1082 * I was going to call this from delete as well as from create to ensure the delete is being
1083 * done whenever a contact is set to is_deleted=1 BUT I found create is already over-aggressive in
1084 * that regard so adding it to delete seems to be enough to remove it from CRM_Contact_BAO_Contact_Permission
1085 * where the call involved a subquery that was locking the table.
1087 * @param int $contactID
1088 * @param bool $isTrashed
1090 public static function updateContactCache($contactID, $isTrashed = FALSE) {
1093 CRM_Contact_BAO_GroupContactCache
::removeContact($contactID);
1094 // This has been moved to here from CRM_Contact_BAO_Contact_Permission as that was causing
1095 // a table-locking query. It still seems a bit inadequate as it assumes the acl users can't see deleted
1096 // but this should not cause any change as long as contacts are not being trashed outside the
1097 // main functions for that.
1098 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_acl_contact_cache WHERE contact_id = %1', [1 => [$contactID, 'Integer']]);
1101 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
1106 * Delete the image of a contact.
1109 * Id of the contact.
1112 * Was contact image deleted?
1114 public static function deleteContactImage($id) {
1119 $contact = new self();
1121 $contact->image_URL
= 'null';
1128 * Return proportional height and width of the image.
1130 * @param int $imageWidth
1133 * @param int $imageHeight
1137 * Thumb dimension of image
1139 public static function getThumbSize($imageWidth, $imageHeight) {
1141 if ($imageWidth && $imageHeight) {
1142 $imageRatio = $imageWidth / $imageHeight;
1147 if ($imageRatio > 1) {
1148 $imageThumbWidth = $thumbWidth;
1149 $imageThumbHeight = round($thumbWidth / $imageRatio);
1152 $imageThumbHeight = $thumbWidth;
1153 $imageThumbWidth = round($thumbWidth * $imageRatio);
1156 return [$imageThumbWidth, $imageThumbHeight];
1160 * Validate type of contact image.
1162 * @param array $params
1163 * @param string $imageIndex
1164 * Index of image field.
1165 * @param string $statusMsg
1166 * Status message to be set after operation.
1167 * @param string $opType
1168 * Type of operation like fatal, bounce etc.
1171 * true if valid image extension
1173 public static function processImageParams(
1175 $imageIndex = 'image_URL',
1189 if (in_array($params[$imageIndex]['type'], $mimeType)) {
1190 $photo = basename($params[$imageIndex]['name']);
1191 $params[$imageIndex] = CRM_Utils_System
::url('civicrm/contact/imagefile', 'photo=' . $photo, TRUE, NULL, TRUE, TRUE);
1195 unset($params[$imageIndex]);
1197 $statusMsg = ts('Image could not be uploaded due to invalid type extension.');
1199 if ($opType == 'status') {
1200 CRM_Core_Session
::setStatus($statusMsg, ts('Error'), 'error');
1202 // FIXME: additional support for fatal, bounce etc could be added.
1208 * Extract contact id from url for deleting contact image.
1210 public static function processImage() {
1212 $action = CRM_Utils_Request
::retrieve('action', 'String');
1213 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive');
1214 // retrieve contact id in case of Profile context
1215 $id = CRM_Utils_Request
::retrieve('id', 'Positive');
1216 $cid = $cid ?
$cid : $id;
1217 if ($action & CRM_Core_Action
::DELETE
) {
1218 if (CRM_Utils_Request
::retrieve('confirmed', 'Boolean')) {
1219 CRM_Contact_BAO_Contact
::deleteContactImage($cid);
1220 CRM_Core_Session
::setStatus(ts('Contact image deleted successfully'), ts('Image Deleted'), 'success');
1221 $session = CRM_Core_Session
::singleton();
1222 $toUrl = $session->popUserContext();
1223 CRM_Utils_System
::redirect($toUrl);
1229 * Function to set is_delete true or restore deleted contact.
1231 * @param CRM_Contact_DAO_Contact $contact
1232 * Contact DAO object.
1233 * @param bool $restore
1234 * True to set the is_delete = 1 else false to restore deleted contact,
1235 * i.e. is_delete = 0
1240 * @throws \CRM_Core_Exception
1242 public static function contactTrashRestore($contact, $restore = FALSE) {
1243 CRM_Core_Error
::deprecatedFunctionWarning('Use the api');
1246 CRM_Core_Error
::deprecatedFunctionWarning('Use contact.create to restore - this does nothing much');
1247 // @todo deprecate calling contactDelete with the intention to restore.
1249 'id' => $contact->id
,
1250 'is_deleted' => FALSE,
1252 self
::create($updateParams);
1255 return self
::contactTrash($contact);
1259 * Get contact type for a contact.
1262 * Id of the contact whose contact type is needed.
1265 * contact_type if $id found else null ""
1267 public static function getContactType($id) {
1268 return CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_type');
1272 * Get contact sub type for a contact.
1275 * Id of the contact whose contact sub type is needed.
1277 * @param string $implodeDelimiter
1280 * contact_sub_type if $id found else null ""
1282 public static function getContactSubType($id, $implodeDelimiter = NULL) {
1283 $subtype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_sub_type');
1285 return $implodeDelimiter ?
NULL : [];
1288 $subtype = CRM_Utils_Array
::explodePadded($subtype);
1290 if ($implodeDelimiter) {
1291 $subtype = implode($implodeDelimiter, $subtype);
1297 * Get pair of contact-type and sub-type for a contact.
1300 * Id of the contact whose contact sub/contact type is needed.
1304 public static function getContactTypes($id) {
1305 $params = ['id' => $id];
1307 $contact = CRM_Core_DAO
::commonRetrieve('CRM_Contact_DAO_Contact',
1310 ['contact_type', 'contact_sub_type']
1315 if ($contact->contact_sub_type
) {
1316 $contactTypes = CRM_Utils_Array
::explodePadded($contact->contact_sub_type
);
1318 array_unshift($contactTypes, $contact->contact_type
);
1320 return $contactTypes;
1323 throw new CRM_Core_Exception();
1328 * Combine all the importable fields from the lower levels object.
1330 * The ordering is important, since currently we do not have a weight
1331 * scheme. Adding weight is super important
1333 * @param int|string $contactType contact Type
1334 * @param bool $status
1335 * Status is used to manipulate first title.
1336 * @param bool $showAll
1337 * If true returns all fields (includes disabled fields).
1338 * @param bool $isProfile
1339 * If its profile mode.
1340 * @param bool $checkPermission
1341 * If false, do not include permissioning clause (for custom data).
1343 * @param bool $withMultiCustomFields
1346 * array of importable Fields
1348 public static function importableFields(
1349 $contactType = 'Individual',
1353 $checkPermission = TRUE,
1354 $withMultiCustomFields = FALSE
1356 if (empty($contactType)) {
1357 $contactType = 'All';
1360 $cacheKeyString = "importableFields $contactType";
1361 $cacheKeyString .= $status ?
'_1' : '_0';
1362 $cacheKeyString .= $showAll ?
'_1' : '_0';
1363 $cacheKeyString .= $isProfile ?
'_1' : '_0';
1364 $cacheKeyString .= $checkPermission ?
'_1' : '_0';
1365 $cacheKeyString .= '_' . CRM_Core_Config
::domainID() . '_';
1367 $fields = self
::$_importableFields[$cacheKeyString] ?? Civi
::cache('fields')->get($cacheKeyString);
1370 $fields = CRM_Contact_DAO_Contact
::import();
1372 // get the fields thar are meant for contact types
1373 if (in_array($contactType, [
1379 $fields = array_merge($fields, CRM_Core_OptionValue
::getFields('', $contactType));
1382 $locationFields = array_merge(CRM_Core_DAO_Address
::import(),
1383 CRM_Core_DAO_Phone
::import(),
1384 CRM_Core_DAO_Email
::import(),
1385 CRM_Core_DAO_IM
::import(TRUE),
1386 CRM_Core_DAO_OpenID
::import()
1389 $locationFields = array_merge($locationFields,
1390 CRM_Core_BAO_CustomField
::getFieldsForImport('Address',
1398 foreach ($locationFields as $key => $field) {
1399 $locationFields[$key]['hasLocationType'] = TRUE;
1402 $fields = array_merge($fields, $locationFields);
1404 $fields = array_merge($fields, CRM_Contact_DAO_Contact
::import());
1405 $fields = array_merge($fields, CRM_Core_DAO_Note
::import());
1408 $fields = array_merge($fields, CRM_Core_DAO_Website
::import());
1409 $fields['url']['hasWebsiteType'] = TRUE;
1411 if ($contactType != 'All') {
1412 $fields = array_merge($fields,
1413 CRM_Core_BAO_CustomField
::getFieldsForImport($contactType,
1418 $withMultiCustomFields
1421 // Unset the fields which are not related to their contact type.
1422 foreach (CRM_Contact_DAO_Contact
::import() as $name => $value) {
1423 if (!empty($value['contactType']) && $value['contactType'] !== $contactType) {
1424 unset($fields[$name]);
1429 foreach (CRM_Contact_BAO_ContactType
::basicTypes() as $type) {
1430 $fields = array_merge($fields,
1431 CRM_Core_BAO_CustomField
::getFieldsForImport($type,
1436 $withMultiCustomFields
1443 $fields = array_merge($fields, [
1445 'title' => ts('Group(s)'),
1449 'title' => ts('Tag(s)'),
1453 'title' => ts('Note'),
1456 'communication_style_id' => [
1457 'title' => ts('Communication Style'),
1458 'name' => 'communication_style_id',
1463 //Sorting fields in alphabetical order(CRM-1507)
1464 $fields = CRM_Utils_Array
::crmArraySortByField($fields, 'title');
1466 Civi
::cache('fields')->set($cacheKeyString, $fields);
1469 self
::$_importableFields[$cacheKeyString] = $fields;
1473 $fields = array_merge(['do_not_import' => ['title' => ts('- do not import -')]],
1474 self
::$_importableFields[$cacheKeyString]
1478 $fields = array_merge(['' => ['title' => ts('- Contact Fields -')]],
1479 self
::$_importableFields[$cacheKeyString]
1487 * Combine all the exportable fields from the lower levels object.
1489 * Currently we are using importable fields as exportable fields
1491 * @param int|string $contactType contact Type
1492 * @param bool $status
1493 * True while exporting primary contacts.
1494 * @param bool $export
1495 * True when used during export.
1496 * @param bool $search
1497 * True when used during search, might conflict with export param?.
1499 * @param bool $withMultiRecord
1500 * @param bool $checkPermissions
1503 * array of exportable Fields
1505 public static function &exportableFields($contactType = 'Individual', $status = FALSE, $export = FALSE, $search = FALSE, $withMultiRecord = FALSE, $checkPermissions = TRUE) {
1506 if (empty($contactType)) {
1507 $contactType = 'All';
1510 $cacheKeyString = "exportableFields $contactType";
1511 $cacheKeyString .= $export ?
'_1' : '_0';
1512 $cacheKeyString .= $status ?
'_1' : '_0';
1513 $cacheKeyString .= $search ?
'_1' : '_0';
1514 $cacheKeyString .= '_' . (bool) $checkPermissions;
1515 //CRM-14501 it turns out that the impact of permissioning here is sometimes inconsistent. The field that
1516 //calculates custom fields takes into account the logged in user & caches that for all users
1517 //as an interim fix we will cache the fields by contact
1518 $cacheKeyString .= '_' . CRM_Core_Session
::getLoggedInContactID();
1520 if (!self
::$_exportableFields ||
empty(self
::$_exportableFields[$cacheKeyString])) {
1521 if (!self
::$_exportableFields) {
1522 self
::$_exportableFields = [];
1525 // check if we can retrieve from database cache
1526 $fields = Civi
::cache('fields')->get($cacheKeyString);
1529 $fields = CRM_Contact_DAO_Contact
::export();
1531 // The fields are meant for contact types.
1532 if (in_array($contactType, [
1538 $fields = array_merge($fields, CRM_Core_OptionValue
::getFields('', $contactType));
1540 // add current employer for individuals
1541 $fields = array_merge($fields, [
1542 'current_employer' =>
1544 'name' => 'organization_name',
1545 'title' => ts('Current Employer'),
1550 'location_type' => [
1551 'name' => 'location_type',
1552 'where' => 'civicrm_location_type.name',
1553 'title' => ts('Location Type'),
1559 'name' => 'im_provider',
1560 'where' => 'civicrm_im.provider_id',
1561 'title' => ts('IM Provider'),
1565 $phoneFields = CRM_Core_DAO_Phone
::export();
1566 // This adds phone_type to the exportable fields and make it available for export.
1567 // with testing the same can be done to the other entities.
1568 CRM_Core_DAO
::appendPseudoConstantsToFields($phoneFields);
1569 $locationFields = array_merge($locationType,
1570 CRM_Core_DAO_Address
::export(),
1572 CRM_Core_DAO_Email
::export(),
1574 CRM_Core_DAO_IM
::export(TRUE),
1575 CRM_Core_DAO_OpenID
::export()
1578 $locationFields = array_merge($locationFields,
1579 CRM_Core_BAO_CustomField
::getFieldsForImport('Address')
1582 foreach ($locationFields as $key => $field) {
1583 $locationFields[$key]['hasLocationType'] = TRUE;
1586 $fields = array_merge($fields, $locationFields);
1589 $fields = array_merge($fields,
1590 CRM_Core_DAO_Worldregion
::export()
1593 $fields = array_merge($fields,
1594 CRM_Contact_DAO_Contact
::export()
1598 $fields = array_merge($fields, CRM_Core_DAO_Website
::export());
1600 if ($contactType != 'All') {
1601 $fields = array_merge($fields,
1602 CRM_Core_BAO_CustomField
::getFieldsForImport($contactType, $status, FALSE, $search, $checkPermissions, $withMultiRecord)
1606 foreach (CRM_Contact_BAO_ContactType
::basicTypes() as $type) {
1607 $fields = array_merge($fields,
1608 CRM_Core_BAO_CustomField
::getFieldsForImport($type, FALSE, FALSE, $search, $checkPermissions, $withMultiRecord)
1614 $fields = array_merge($fields, [
1616 'title' => ts('Group(s)'),
1620 'title' => ts('Tag(s)'),
1624 'title' => ts('Note(s)'),
1630 $fields = array_merge($fields, [
1632 'title' => ts('Group(s)'),
1636 'title' => ts('Tag(s)'),
1640 'title' => ts('Note(s)'),
1646 //Sorting fields in alphabetical order(CRM-1507)
1647 foreach ($fields as $k => $v) {
1648 $sortArray[$k] = $v['title'] ??
NULL;
1651 $fields = array_merge($sortArray, $fields);
1652 //unset the field which are not related to their contact type.
1653 if ($contactType != 'All') {
1659 'organization_name',
1660 'email_greeting_custom',
1661 'postal_greeting_custom',
1674 'organization_name',
1682 'email_greeting_custom',
1683 'postal_greeting_custom',
1699 'email_greeting_custom',
1700 'postal_greeting_custom',
1710 foreach ($commonValues[$contactType] as $value) {
1711 unset($fields[$value]);
1715 Civi
::cache('fields')->set($cacheKeyString, $fields);
1717 self
::$_exportableFields[$cacheKeyString] = $fields;
1721 $fields = self
::$_exportableFields[$cacheKeyString];
1724 $fields = array_merge(['' => ['title' => ts('- Contact Fields -')]],
1725 self
::$_exportableFields[$cacheKeyString]
1733 * Get the all contact details (Hierarchical).
1735 * @param int $contactId
1737 * @param array $fields
1743 public static function getHierContactDetails($contactId, $fields) {
1744 $params = [['contact_id', '=', $contactId, 0, 0]];
1746 $returnProperties = self
::makeHierReturnProperties($fields, $contactId);
1748 // We don't know the contents of return properties, but we need the lower
1749 // level ids of the contact so add a few fields.
1750 $returnProperties['first_name'] = 1;
1751 $returnProperties['organization_name'] = 1;
1752 $returnProperties['household_name'] = 1;
1753 $returnProperties['contact_type'] = 1;
1754 $returnProperties['contact_sub_type'] = 1;
1755 list($query) = CRM_Contact_BAO_Query
::apiQuery($params, $returnProperties);
1760 * Given a set of flat profile style field names, create a hierarchy.
1762 * This is for the query to use, create the right sql.
1765 * @param int $contactId
1769 * A hierarchical property tree if appropriate
1771 public static function &makeHierReturnProperties($fields, $contactId = NULL) {
1772 $locationTypes = CRM_Core_BAO_Address
::buildOptions('location_type_id', 'validate');
1774 $returnProperties = [];
1776 $multipleFields = ['website' => 'url'];
1777 foreach ($fields as $name => $dontCare) {
1778 if (strpos($name, '-') !== FALSE) {
1779 list($fieldName, $id, $type) = CRM_Utils_System
::explode('-', $name, 3);
1781 if (!in_array($fieldName, $multipleFields)) {
1782 if ($id == 'Primary') {
1783 $locationTypeName = 1;
1786 $locationTypeName = $locationTypes[$id] ??
NULL;
1787 if (!$locationTypeName) {
1792 if (empty($returnProperties['location'])) {
1793 $returnProperties['location'] = [];
1795 if (empty($returnProperties['location'][$locationTypeName])) {
1796 $returnProperties['location'][$locationTypeName] = [];
1797 $returnProperties['location'][$locationTypeName]['location_type'] = $id;
1799 if (in_array($fieldName, [
1807 $returnProperties['location'][$locationTypeName][$fieldName . '-' . $type] = 1;
1810 $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1813 elseif (substr($fieldName, 0, 14) === 'address_custom') {
1814 $returnProperties['location'][$locationTypeName][substr($fieldName, 8)] = 1;
1817 $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1821 $returnProperties['website'][$id][$fieldName] = 1;
1825 $returnProperties[$name] = 1;
1829 return $returnProperties;
1833 * Return the primary location type of a contact.
1835 * $params int $contactId contact_id
1836 * $params boolean $isPrimaryExist if true, return primary contact location type otherwise null
1837 * $params boolean $skipDefaultPriamry if true, return primary contact location type otherwise null
1839 * @param int $contactId
1840 * @param bool $skipDefaultPriamry
1841 * @param null $block
1844 * $locationType location_type_id
1846 public static function getPrimaryLocationType($contactId, $skipDefaultPriamry = FALSE, $block = NULL) {
1848 $entityBlock = ['contact_id' => $contactId];
1849 $blocks = CRM_Core_BAO_Location
::getValues($entityBlock);
1850 foreach ($blocks[$block] as $key => $value) {
1851 if (!empty($value['is_primary'])) {
1852 $locationType = $value['location_type_id'] ??
NULL;
1859 IF ( civicrm_email.location_type_id IS NULL,
1860 IF ( civicrm_address.location_type_id IS NULL,
1861 IF ( civicrm_phone.location_type_id IS NULL,
1862 IF ( civicrm_im.location_type_id IS NULL,
1863 IF ( civicrm_openid.location_type_id IS NULL, null, civicrm_openid.location_type_id)
1864 ,civicrm_im.location_type_id)
1865 ,civicrm_phone.location_type_id)
1866 ,civicrm_address.location_type_id)
1867 ,civicrm_email.location_type_id) as locationType
1868 FROM civicrm_contact
1869 LEFT JOIN civicrm_email ON ( civicrm_email.is_primary = 1 AND civicrm_email.contact_id = civicrm_contact.id )
1870 LEFT JOIN civicrm_address ON ( civicrm_address.is_primary = 1 AND civicrm_address.contact_id = civicrm_contact.id)
1871 LEFT JOIN civicrm_phone ON ( civicrm_phone.is_primary = 1 AND civicrm_phone.contact_id = civicrm_contact.id)
1872 LEFT JOIN civicrm_im ON ( civicrm_im.is_primary = 1 AND civicrm_im.contact_id = civicrm_contact.id)
1873 LEFT JOIN civicrm_openid ON ( civicrm_openid.is_primary = 1 AND civicrm_openid.contact_id = civicrm_contact.id)
1874 WHERE civicrm_contact.id = %1 ";
1876 $params = [1 => [$contactId, 'Integer']];
1878 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1880 $locationType = NULL;
1881 if ($dao->fetch()) {
1882 $locationType = $dao->locationType
;
1885 if (isset($locationType)) {
1886 return $locationType;
1888 elseif ($skipDefaultPriamry) {
1889 // if there is no primary contact location then return null
1893 // if there is no primart contact location, then return default
1894 // location type of the system
1895 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
1896 return $defaultLocationType->id
;
1901 * Get the display name, primary email and location type of a contact.
1904 * Id of the contact.
1907 * Array of display_name, email if found, do_not_email or (null,null,null)
1909 public static function getContactDetails($id) {
1910 // check if the contact type
1911 $contactType = self
::getContactType($id);
1913 $nameFields = ($contactType == 'Individual') ?
"civicrm_contact.first_name, civicrm_contact.last_name, civicrm_contact.display_name" : "civicrm_contact.display_name";
1916 SELECT $nameFields, civicrm_email.email, civicrm_contact.do_not_email, civicrm_email.on_hold, civicrm_contact.is_deceased
1917 FROM civicrm_contact LEFT JOIN civicrm_email ON (civicrm_contact.id = civicrm_email.contact_id)
1918 WHERE civicrm_contact.id = %1
1919 ORDER BY civicrm_email.is_primary DESC";
1920 $params = [1 => [$id, 'Integer']];
1921 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
1923 if ($dao->fetch()) {
1924 if ($contactType == 'Individual') {
1925 if ($dao->first_name ||
$dao->last_name
) {
1926 $name = "{$dao->first_name} {$dao->last_name}";
1929 $name = $dao->display_name
;
1933 $name = $dao->display_name
;
1935 $email = $dao->email
;
1936 $doNotEmail = (bool) $dao->do_not_email
;
1937 $onHold = (bool) $dao->on_hold
;
1938 $isDeceased = (bool) $dao->is_deceased
;
1939 return [$name, $email, $doNotEmail, $onHold, $isDeceased];
1941 return [NULL, NULL, NULL, NULL, NULL];
1945 * Add/edit/register contacts through profile.
1947 * @param array $params
1948 * Array of profile fields to be edited/added.
1949 * @param array $fields
1950 * Array of fields from UFGroup.
1951 * @param int $contactID
1952 * Id of the contact to be edited/added.
1953 * @param int $addToGroupID
1954 * Specifies the default group to which contact is added.
1955 * @param int $ufGroupId
1956 * Uf group id (profile id).
1957 * @param string $ctype
1958 * @param bool $visibility
1959 * Basically lets us know where this request is coming from.
1960 * if via a profile from web, we restrict what groups are changed
1963 * contact id created/edited
1965 * @throws \CRM_Core_Exception
1966 * @throws \CiviCRM_API3_Exception
1967 * @throws \Civi\API\Exception\UnauthorizedException
1969 public static function createProfileContact(
1973 $addToGroupID = NULL,
1978 // add ufGroupID to params array ( CRM-2012 )
1980 $params['uf_group_id'] = $ufGroupId;
1982 self
::addBillingNameFieldsIfOtherwiseNotSet($params);
1984 // If a user has logged in, or accessed via a checksum
1985 // Then deliberately 'blanking' a value in the profile should remove it from their record
1986 $session = CRM_Core_Session
::singleton();
1987 $params['updateBlankLocInfo'] = TRUE;
1988 if (($session->get('authSrc') & (CRM_Core_Permission
::AUTH_SRC_CHECKSUM + CRM_Core_Permission
::AUTH_SRC_LOGIN
)) == 0) {
1989 $params['updateBlankLocInfo'] = FALSE;
1994 CRM_Utils_Hook
::pre('edit', 'Profile', $contactID, $params);
1998 CRM_Utils_Hook
::pre('create', 'Profile', NULL, $params);
2001 list($data, $contactDetails) = self
::formatProfileContactParams($params, $fields, $contactID, $ufGroupId, $ctype);
2003 // manage is_opt_out
2004 if (array_key_exists('is_opt_out', $fields) && array_key_exists('is_opt_out', $params)) {
2005 $wasOptOut = $contactDetails['is_opt_out'] ??
FALSE;
2006 $isOptOut = $params['is_opt_out'];
2007 $data['is_opt_out'] = $isOptOut;
2008 // on change, create new civicrm_subscription_history entry
2009 if (($wasOptOut != $isOptOut) && !empty($contactDetails['contact_id'])) {
2011 'contact_id' => $contactDetails['contact_id'],
2012 'status' => $isOptOut ?
'Removed' : 'Added',
2015 CRM_Contact_BAO_SubscriptionHistory
::create($shParams);
2019 $contact = self
::create($data);
2021 // contact is null if the profile does not have any contact fields
2023 $contactID = $contact->id
;
2026 if (empty($contactID)) {
2027 throw new CRM_Core_Exception('Cannot proceed without a valid contact id');
2030 // Process group and tag
2031 if (isset($params['group'])) {
2033 // this for sure means we are coming in via profile since i added it to fix
2034 // removing contacts from user groups -- lobo
2038 CRM_Contact_BAO_GroupContact
::create($params['group'], $contactID, $visibility, $method);
2041 if (!empty($fields['tag']) && array_key_exists('tag', $params)) {
2042 // Convert comma separated form values from select2 v3
2043 $tags = is_array($params['tag']) ?
$params['tag'] : array_fill_keys(array_filter(explode(',', $params['tag'])), 1);
2044 CRM_Core_BAO_EntityTag
::create($tags, 'civicrm_contact', $contactID);
2047 //to add profile in default group
2048 if (is_array($addToGroupID)) {
2049 $contactIds = [$contactID];
2050 foreach ($addToGroupID as $groupId) {
2051 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $groupId);
2054 elseif ($addToGroupID) {
2055 $contactIds = [$contactID];
2056 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $addToGroupID);
2060 CRM_Utils_Hook
::post('edit', 'Profile', $contactID, $params);
2063 CRM_Utils_Hook
::post('create', 'Profile', $contactID, $params);
2069 * Format profile contact parameters.
2071 * @param array $params
2073 * @param int $contactID
2074 * @param int $ufGroupId
2075 * @param null $ctype
2076 * @param bool $skipCustom
2080 public static function formatProfileContactParams(
2089 $data = $contactDetails = [];
2091 // get the contact details (hier)
2093 $details = self
::getHierContactDetails($contactID, $fields);
2095 $contactDetails = $details[$contactID];
2096 $data['contact_type'] = $contactDetails['contact_type'] ??
NULL;
2097 $data['contact_sub_type'] = $contactDetails['contact_sub_type'] ??
NULL;
2100 //we should get contact type only if contact
2102 $data['contact_type'] = CRM_Core_BAO_UFField
::getProfileType($ufGroupId);
2104 //special case to handle profile with only contact fields
2105 if ($data['contact_type'] == 'Contact') {
2106 $data['contact_type'] = 'Individual';
2108 elseif (CRM_Contact_BAO_ContactType
::isaSubType($data['contact_type'])) {
2109 $data['contact_type'] = CRM_Contact_BAO_ContactType
::getBasicType($data['contact_type']);
2113 $data['contact_type'] = $ctype;
2116 $data['contact_type'] = 'Individual';
2120 //fix contact sub type CRM-5125
2121 if (array_key_exists('contact_sub_type', $params) &&
2122 !empty($params['contact_sub_type'])
2124 $data['contact_sub_type'] = CRM_Utils_Array
::implodePadded($params['contact_sub_type']);
2126 elseif (array_key_exists('contact_sub_type_hidden', $params) &&
2127 !empty($params['contact_sub_type_hidden'])
2129 // if profile was used, and had any subtype, we obtain it from there
2130 //CRM-13596 - add to existing contact types, rather than overwriting
2131 if (empty($data['contact_sub_type'])) {
2132 // If we don't have a contact ID the $data['contact_sub_type'] will not be defined...
2133 $data['contact_sub_type'] = CRM_Utils_Array
::implodePadded($params['contact_sub_type_hidden']);
2136 $data_contact_sub_type_arr = CRM_Utils_Array
::explodePadded($data['contact_sub_type']);
2137 if (!in_array($params['contact_sub_type_hidden'], $data_contact_sub_type_arr)) {
2138 //CRM-20517 - make sure contact_sub_type gets the correct delimiters
2139 $data['contact_sub_type'] = trim($data['contact_sub_type'], CRM_Core_DAO
::VALUE_SEPARATOR
);
2140 $data['contact_sub_type'] = CRM_Core_DAO
::VALUE_SEPARATOR
. $data['contact_sub_type'] . CRM_Utils_Array
::implodePadded($params['contact_sub_type_hidden']);
2145 if ($ctype == 'Organization') {
2146 $data['organization_name'] = $contactDetails['organization_name'] ??
NULL;
2148 elseif ($ctype == 'Household') {
2149 $data['household_name'] = $contactDetails['household_name'] ??
NULL;
2157 $data['contact_id'] = $contactID;
2158 $primaryLocationType = self
::getPrimaryLocationType($contactID);
2161 $defaultLocation = CRM_Core_BAO_LocationType
::getDefault();
2162 $defaultLocationId = $defaultLocation->id
;
2165 $billingLocationTypeId = CRM_Core_BAO_LocationType
::getBilling();
2167 $blocks = ['email', 'phone', 'im', 'openid'];
2169 $multiplFields = ['url'];
2170 // prevent overwritten of formatted array, reset all block from
2171 // params if it is not in valid format (since import pass valid format)
2172 foreach ($blocks as $blk) {
2173 if (array_key_exists($blk, $params) &&
2174 !is_array($params[$blk])
2176 unset($params[$blk]);
2180 $primaryPhoneLoc = NULL;
2181 $session = CRM_Core_Session
::singleton();
2182 foreach ($params as $key => $value) {
2183 list($fieldName, $locTypeId, $typeId) = CRM_Utils_System
::explode('-', $key, 3);
2185 if ($locTypeId == 'Primary') {
2187 if (in_array($fieldName, $blocks)) {
2188 $locTypeId = self
::getPrimaryLocationType($contactID, FALSE, $fieldName);
2191 $locTypeId = self
::getPrimaryLocationType($contactID, FALSE, 'address');
2193 $primaryLocationType = $locTypeId;
2196 $locTypeId = $defaultLocationId;
2200 if (is_numeric($locTypeId) &&
2201 !in_array($fieldName, $multiplFields) &&
2202 substr($fieldName, 0, 7) != 'custom_'
2204 $index = $locTypeId;
2206 if (is_numeric($typeId)) {
2207 $index .= '-' . $typeId;
2209 if (!in_array($index, $locationType)) {
2210 $locationType[$count] = $index;
2214 $loc = CRM_Utils_Array
::key($index, $locationType);
2216 $blockName = self
::getLocationEntityForKey($fieldName);
2218 $data[$blockName][$loc]['location_type_id'] = $locTypeId;
2220 //set is_billing true, for location type "Billing"
2221 if ($locTypeId == $billingLocationTypeId) {
2222 $data[$blockName][$loc]['is_billing'] = 1;
2226 //get the primary location type
2227 if ($locTypeId == $primaryLocationType) {
2228 $data[$blockName][$loc]['is_primary'] = 1;
2231 elseif ($locTypeId == $defaultLocationId) {
2232 $data[$blockName][$loc]['is_primary'] = 1;
2235 if (in_array($fieldName, ['phone'])) {
2237 $data['phone'][$loc]['phone_type_id'] = $typeId;
2240 $data['phone'][$loc]['phone_type_id'] = '';
2242 $data['phone'][$loc]['phone'] = $value;
2244 //special case to handle primary phone with different phone types
2245 // in this case we make first phone type as primary
2246 if (isset($data['phone'][$loc]['is_primary']) && !$primaryPhoneLoc) {
2247 $primaryPhoneLoc = $loc;
2250 if ($loc != $primaryPhoneLoc) {
2251 unset($data['phone'][$loc]['is_primary']);
2254 elseif ($fieldName == 'email') {
2255 $data['email'][$loc]['email'] = $value;
2256 if (empty($contactID)) {
2257 $data['email'][$loc]['is_primary'] = 1;
2260 elseif ($fieldName == 'im') {
2261 if (isset($params[$key . '-provider_id'])) {
2262 $data['im'][$loc]['provider_id'] = $params[$key . '-provider_id'];
2264 if (strpos($key, '-provider_id') !== FALSE) {
2265 $data['im'][$loc]['provider_id'] = $params[$key];
2268 $data['im'][$loc]['name'] = $value;
2271 elseif ($fieldName == 'openid') {
2272 $data['openid'][$loc]['openid'] = $value;
2275 if ($fieldName === 'state_province') {
2277 if (is_numeric($value) && ((int ) $value) >= 1000) {
2278 $data['address'][$loc]['state_province_id'] = $value;
2280 elseif (empty($value)) {
2281 $data['address'][$loc]['state_province_id'] = '';
2284 $data['address'][$loc]['state_province'] = $value;
2287 elseif ($fieldName === 'country') {
2289 if (is_numeric($value) && ((int ) $value) >= 1000
2291 $data['address'][$loc]['country_id'] = $value;
2293 elseif (empty($value)) {
2294 $data['address'][$loc]['country_id'] = '';
2297 $data['address'][$loc]['country'] = $value;
2300 elseif ($fieldName === 'county') {
2301 $data['address'][$loc]['county_id'] = $value;
2303 elseif ($fieldName == 'address_name') {
2304 $data['address'][$loc]['name'] = $value;
2306 elseif (substr($fieldName, 0, 14) === 'address_custom') {
2307 $data['address'][$loc][substr($fieldName, 8)] = $value;
2310 $data[$blockName][$loc][$fieldName] = $value;
2315 if (substr($key, 0, 4) === 'url-') {
2316 $websiteField = explode('-', $key);
2317 $data['website'][$websiteField[1]]['website_type_id'] = $websiteField[1];
2318 $data['website'][$websiteField[1]]['url'] = $value;
2320 elseif (in_array($key, self
::$_greetingTypes, TRUE)) {
2321 //save email/postal greeting and addressee values if any, CRM-4575
2322 $data[$key . '_id'] = $value;
2324 elseif (!$skipCustom && ($customFieldId = CRM_Core_BAO_CustomField
::getKeyID($key))) {
2325 // for autocomplete transfer hidden value instead of label
2326 if ($params[$key] && isset($params[$key . '_id'])) {
2327 $value = $params[$key . '_id'];
2330 // we need to append time with date
2331 if ($params[$key] && isset($params[$key . '_time'])) {
2332 $value .= ' ' . $params[$key . '_time'];
2335 // if auth source is not checksum / login && $value is blank, do not proceed - CRM-10128
2336 if (($session->get('authSrc') & (CRM_Core_Permission
::AUTH_SRC_CHECKSUM + CRM_Core_Permission
::AUTH_SRC_LOGIN
)) == 0 &&
2337 ($value == '' ||
!isset($value))
2343 if (!empty($params['customRecordValues'])) {
2344 if (is_array($params['customRecordValues']) && !empty($params['customRecordValues'])) {
2345 foreach ($params['customRecordValues'] as $recId => $customFields) {
2346 if (is_array($customFields) && !empty($customFields)) {
2347 foreach ($customFields as $customFieldName) {
2348 if ($customFieldName == $key) {
2358 //CRM-13596 - check for contact_sub_type_hidden first
2359 if (array_key_exists('contact_sub_type_hidden', $params)) {
2360 $type = $params['contact_sub_type_hidden'];
2363 $type = $data['contact_type'];
2364 if (!empty($data['contact_sub_type'])) {
2365 $type = CRM_Utils_Array
::explodePadded($data['contact_sub_type']);
2369 CRM_Core_BAO_CustomField
::formatCustomField($customFieldId,
2379 elseif ($key === 'edit') {
2383 if ($key === 'location') {
2384 foreach ($value as $locationTypeId => $field) {
2385 foreach ($field as $block => $val) {
2386 if ($block === 'address' && array_key_exists('address_name', $val)) {
2387 $value[$locationTypeId][$block]['name'] = $value[$locationTypeId][$block]['address_name'];
2392 if ($key === 'phone' && isset($params['phone_ext'])) {
2393 $data[$key] = $value;
2394 foreach ($value as $cnt => $phoneBlock) {
2395 if ($params[$key][$cnt]['location_type_id'] == $params['phone_ext'][$cnt]['location_type_id']) {
2396 $data[$key][$cnt]['phone_ext'] = CRM_Utils_Array
::retrieveValueRecursive($params['phone_ext'][$cnt], 'phone_ext');
2400 elseif (in_array($key, ['nick_name', 'job_title', 'middle_name', 'birth_date', 'gender_id', 'current_employer', 'prefix_id', 'suffix_id'])
2401 && ($value == '' ||
!isset($value)) &&
2402 ($session->get('authSrc') & (CRM_Core_Permission
::AUTH_SRC_CHECKSUM + CRM_Core_Permission
::AUTH_SRC_LOGIN
)) == 0 ||
2403 ($key === 'current_employer' && empty($params['current_employer']))) {
2404 // CRM-10128: if auth source is not checksum / login && $value is blank, do not fill $data with empty value
2405 // to avoid update with empty values
2409 $data[$key] = $value;
2415 if (!isset($data['contact_type'])) {
2416 $data['contact_type'] = 'Individual';
2419 //set the values for checkboxes (do_not_email, do_not_mail, do_not_trade, do_not_phone)
2420 $privacy = CRM_Core_SelectValues
::privacy();
2421 foreach ($privacy as $key => $value) {
2422 if (array_key_exists($key, $fields)) {
2423 // do not reset values for existing contacts, if fields are added to a profile
2424 if (array_key_exists($key, $params)) {
2425 $data[$key] = $params[$key];
2426 if (empty($params[$key])) {
2430 elseif (!$contactID) {
2436 return [$data, $contactDetails];
2440 * Find the get contact details.
2442 * This function does not respect ACLs for now, which might need to be rectified at some
2443 * stage based on how its used.
2445 * @param string $mail
2446 * Primary email address of the contact.
2447 * @param string $ctype
2450 * @return object|null
2451 * $dao contact details
2453 public static function matchContactOnEmail($mail, $ctype = NULL) {
2454 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2455 $mail = $strtolower(trim($mail));
2457 SELECT civicrm_contact.id as contact_id,
2458 civicrm_contact.hash as hash,
2459 civicrm_contact.contact_type as contact_type,
2460 civicrm_contact.contact_sub_type as contact_sub_type
2461 FROM civicrm_contact
2462 INNER JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id )";
2464 if (Civi
::settings()->get('uniq_email_per_site')) {
2465 // try to find a match within a site (multisite).
2466 $groups = CRM_Core_BAO_Domain
::getChildGroupIds();
2467 if (!empty($groups)) {
2469 INNER JOIN civicrm_group_contact gc ON
2470 (civicrm_contact.id = gc.contact_id AND gc.status = 'Added' AND gc.group_id IN (" . implode(',', $groups) . "))";
2475 WHERE civicrm_email.email = %1 AND civicrm_contact.is_deleted=0";
2476 $p = [1 => [$mail, 'String']];
2479 $query .= " AND civicrm_contact.contact_type = %3";
2480 $p[3] = [$ctype, 'String'];
2483 $query .= " ORDER BY civicrm_email.is_primary DESC";
2485 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2487 if ($dao->fetch()) {
2494 * Find the contact details associated with an OpenID.
2496 * @param string $openId
2497 * OpenId of the contact.
2498 * @param string $ctype
2501 * @return object|null
2502 * $dao contact details
2504 public static function matchContactOnOpenId($openId, $ctype = NULL) {
2505 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2506 $openId = $strtolower(trim($openId));
2508 SELECT civicrm_contact.id as contact_id,
2509 civicrm_contact.hash as hash,
2510 civicrm_contact.contact_type as contact_type,
2511 civicrm_contact.contact_sub_type as contact_sub_type
2512 FROM civicrm_contact
2513 INNER JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id )
2514 WHERE civicrm_openid.openid = %1";
2515 $p = [1 => [$openId, 'String']];
2518 $query .= " AND civicrm_contact.contact_type = %3";
2519 $p[3] = [$ctype, 'String'];
2522 $query .= " ORDER BY civicrm_openid.is_primary DESC";
2524 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2526 if ($dao->fetch()) {
2533 * Get primary email of the contact.
2535 * @param int $contactID
2537 * @param bool $polite
2538 * Whether to only pull an email if it's okay to send to it--that is, if it
2539 * is not on_hold and the contact is not do_not_email.
2542 * Email address if present else null
2544 public static function getPrimaryEmail($contactID, $polite = FALSE) {
2545 // fetch the primary email
2547 SELECT civicrm_email.email as email
2548 FROM civicrm_contact
2549 LEFT JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id )
2550 WHERE civicrm_email.is_primary = 1
2551 AND civicrm_contact.id = %1";
2554 AND civicrm_contact.do_not_email = 0
2555 AND civicrm_email.on_hold = 0';
2557 $p = [1 => [$contactID, 'Integer']];
2558 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2561 if ($dao->fetch()) {
2562 $email = $dao->email
;
2568 * Function to get primary OpenID of the contact.
2570 * @param int $contactID
2574 * >openid OpenID if present else null
2576 public static function getPrimaryOpenId($contactID) {
2577 // fetch the primary OpenID
2579 SELECT civicrm_openid.openid as openid
2580 FROM civicrm_contact
2581 LEFT JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id )
2582 WHERE civicrm_contact.id = %1
2583 AND civicrm_openid.is_primary = 1";
2584 $p = [1 => [$contactID, 'Integer']];
2585 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2588 if ($dao->fetch()) {
2589 $openId = $dao->openid
;
2595 * Fetch the object and store the values in the values array.
2597 * @param array $params
2598 * Input parameters to find object.
2599 * @param array $values
2600 * Output values of the object.
2602 * @return CRM_Contact_BAO_Contact|null
2603 * The found object or null
2605 public static function getValues(&$params, &$values) {
2606 $contact = new CRM_Contact_BAO_Contact();
2608 $contact->copyValues($params);
2610 if ($contact->find(TRUE)) {
2612 CRM_Core_DAO
::storeValues($contact, $values);
2615 foreach (self
::$_commPrefs as $name) {
2616 if (isset($contact->$name)) {
2617 $privacy[$name] = $contact->$name;
2621 if (!empty($privacy)) {
2622 $values['privacy'] = $privacy;
2625 // communication Prefferance
2626 $preffComm = $comm = [];
2627 $comm = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
2628 $contact->preferred_communication_method
2630 foreach ($comm as $value) {
2631 $preffComm[$value] = 1;
2633 $temp = ['preferred_communication_method' => $contact->preferred_communication_method
];
2636 'preferred_communication_method' => [
2637 'newName' => 'preferred_communication_method_display',
2638 'groupName' => 'preferred_communication_method',
2642 // @todo This can be figured out from metadata & we can avoid the uncached query.
2643 CRM_Core_OptionGroup
::lookupValues($temp, $names, FALSE);
2645 $values['preferred_communication_method'] = $preffComm;
2646 $values['preferred_communication_method_display'] = $temp['preferred_communication_method_display'] ??
NULL;
2648 if ($contact->preferred_mail_format
) {
2649 $preferredMailingFormat = CRM_Core_SelectValues
::pmf();
2650 $values['preferred_mail_format'] = $preferredMailingFormat[$contact->preferred_mail_format
];
2653 // get preferred languages
2654 if (!empty($contact->preferred_language
)) {
2655 $values['preferred_language'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $contact->preferred_language
);
2658 // Calculating Year difference
2659 if ($contact->birth_date
) {
2660 $birthDate = CRM_Utils_Date
::customFormat($contact->birth_date
, '%Y%m%d');
2661 if ($birthDate < date('Ymd')) {
2662 $age = CRM_Utils_Date
::calculateAge($birthDate);
2663 $values['age']['y'] = $age['years'] ??
NULL;
2664 $values['age']['m'] = $age['months'] ??
NULL;
2668 $contact->contact_id
= $contact->id
;
2676 * Given the component name and returns the count of participation of contact.
2678 * @param string $component
2679 * Input component name.
2680 * @param int $contactId
2682 * @param string $tableName
2683 * Optional tableName if component is custom group.
2686 * total number in database
2688 public static function getCountComponent($component, $contactId, $tableName = NULL) {
2690 switch ($component) {
2692 return CRM_Core_BAO_EntityTag
::getContactTags($contactId, TRUE);
2695 $result = CRM_Contact_BAO_Relationship
::getRelationship($contactId,
2696 CRM_Contact_BAO_Relationship
::CURRENT
,
2705 return CRM_Contact_BAO_GroupContact
::getContactGroup($contactId, "Added", NULL, TRUE, FALSE, FALSE, TRUE, NULL, TRUE);
2708 if (CRM_Core_BAO_Log
::useLoggingReport()) {
2711 return CRM_Core_BAO_Log
::getContactLogCount($contactId);
2714 return CRM_Core_BAO_Note
::getContactNoteCount($contactId);
2716 case 'contribution':
2717 return CRM_Contribute_BAO_Contribution
::contributionCount($contactId);
2720 return CRM_Member_BAO_Membership
::getContactMembershipCount($contactId, TRUE);
2723 return CRM_Event_BAO_Participant
::getContactParticipantCount($contactId);
2726 return CRM_Pledge_BAO_Pledge
::getContactPledgeCount($contactId);
2729 return CRM_Case_BAO_Case
::caseCount($contactId);
2732 return CRM_Grant_BAO_Grant
::getContactGrantCount($contactId);
2736 'contact_id' => $contactId,
2739 'context' => 'activity',
2741 return CRM_Activity_BAO_Activity
::getActivitiesCount($input);
2744 $params = ['contact_id' => $contactId];
2745 return CRM_Mailing_BAO_Mailing
::getContactMailingsCount($params);
2748 $custom = explode('_', $component);
2749 if ($custom['0'] = 'custom') {
2751 $tableName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $custom['1'], 'table_name');
2753 $queryString = "SELECT count(id) FROM {$tableName} WHERE entity_id = {$contactId}";
2754 return CRM_Core_DAO
::singleValueQuery($queryString);
2760 * Update contact greetings if an update has resulted in a custom field change.
2762 * @param array $updatedFields
2763 * Array of fields that have been updated e.g array('first_name', 'prefix_id', 'custom_2');
2764 * @param array $contactParams
2765 * Parameters known about the contact. At minimum array('contact_id' => x).
2766 * Fields in this array will take precedence over DB fields (so far only
2767 * in the case of greeting id fields).
2769 public static function updateGreetingsOnTokenFieldChange($updatedFields, $contactParams) {
2770 $contactID = $contactParams['contact_id'];
2771 CRM_Contact_BAO_Contact
::ensureGreetingParamsAreSet($contactParams);
2772 $tokens = CRM_Contact_BAO_Contact_Utils
::getTokensRequiredForContactGreetings($contactParams);
2773 if (!empty($tokens['all']['contact'])) {
2774 $affectedTokens = array_intersect_key($updatedFields[$contactID], array_flip($tokens['all']['contact']));
2775 if (!empty($affectedTokens)) {
2776 // @todo this is still reloading the whole contact -fix to be more selective & use pre-loaded.
2777 $contact = new CRM_Contact_BAO_Contact();
2778 $contact->id
= $contactID;
2779 CRM_Contact_BAO_Contact
::processGreetings($contact);
2785 * Process greetings and cache.
2787 * @param object $contact
2788 * Contact object after save.
2790 public static function processGreetings(&$contact) {
2792 //@todo this function does a lot of unnecessary loading.
2793 // ensureGreetingParamsAreSet now makes sure that the contact is
2794 // loaded and using updateGreetingsOnTokenFieldChange
2795 // allows us the possibility of only doing an update if required.
2797 // The contact object has not always required the
2798 // fields that are required to calculate greetings
2799 // so we need to retrieve it again.
2800 if ($contact->_query
!== FALSE) {
2801 $contact->find(TRUE);
2804 // store object values to an array
2805 $contactDetails = [];
2806 CRM_Core_DAO
::storeValues($contact, $contactDetails);
2807 $contactDetails = [[$contact->id
=> $contactDetails]];
2809 $emailGreetingString = $postalGreetingString = $addresseeString = NULL;
2810 $updateQueryString = [];
2812 //cache email and postal greeting to greeting display
2813 if ($contact->email_greeting_custom
!= 'null' && $contact->email_greeting_custom
) {
2814 $emailGreetingString = $contact->email_greeting_custom
;
2816 elseif ($contact->email_greeting_id
!= 'null' && $contact->email_greeting_id
) {
2817 // the filter value for Individual contact type is set to 1
2819 'contact_type' => $contact->contact_type
,
2820 'greeting_type' => 'email_greeting',
2823 $emailGreeting = CRM_Core_PseudoConstant
::greeting($filter);
2824 $emailGreetingString = $emailGreeting[$contact->email_greeting_id
];
2825 $updateQueryString[] = " email_greeting_custom = NULL ";
2828 if ($contact->email_greeting_custom
) {
2829 $updateQueryString[] = " email_greeting_display = NULL ";
2833 if ($emailGreetingString) {
2834 CRM_Contact_BAO_Contact_Utils
::processGreetingTemplate($emailGreetingString,
2837 'CRM_Contact_BAO_Contact'
2839 $emailGreetingString = CRM_Core_DAO
::escapeString(CRM_Utils_String
::stripSpaces($emailGreetingString));
2840 $updateQueryString[] = " email_greeting_display = '{$emailGreetingString}'";
2844 if ($contact->postal_greeting_custom
!== 'null' && $contact->postal_greeting_custom
) {
2845 $postalGreetingString = $contact->postal_greeting_custom
;
2847 elseif ($contact->postal_greeting_id
!== 'null' && $contact->postal_greeting_id
) {
2849 'contact_type' => $contact->contact_type
,
2850 'greeting_type' => 'postal_greeting',
2852 $postalGreeting = CRM_Core_PseudoConstant
::greeting($filter);
2853 $postalGreetingString = $postalGreeting[$contact->postal_greeting_id
];
2854 $updateQueryString[] = " postal_greeting_custom = NULL ";
2857 if ($contact->postal_greeting_custom
) {
2858 $updateQueryString[] = " postal_greeting_display = NULL ";
2862 if ($postalGreetingString) {
2863 CRM_Contact_BAO_Contact_Utils
::processGreetingTemplate($postalGreetingString,
2866 'CRM_Contact_BAO_Contact'
2868 $postalGreetingString = CRM_Core_DAO
::escapeString(CRM_Utils_String
::stripSpaces($postalGreetingString));
2869 $updateQueryString[] = " postal_greeting_display = '{$postalGreetingString}'";
2873 if ($contact->addressee_custom
!== 'null' && $contact->addressee_custom
) {
2874 $addresseeString = $contact->addressee_custom
;
2876 elseif ($contact->addressee_id
!== 'null' && $contact->addressee_id
) {
2878 'contact_type' => $contact->contact_type
,
2879 'greeting_type' => 'addressee',
2882 $addressee = CRM_Core_PseudoConstant
::greeting($filter);
2883 $addresseeString = $addressee[$contact->addressee_id
];
2884 $updateQueryString[] = " addressee_custom = NULL ";
2887 if ($contact->addressee_custom
) {
2888 $updateQueryString[] = " addressee_display = NULL ";
2892 if ($addresseeString) {
2893 CRM_Contact_BAO_Contact_Utils
::processGreetingTemplate($addresseeString,
2896 'CRM_Contact_BAO_Contact'
2898 $addresseeString = CRM_Core_DAO
::escapeString(CRM_Utils_String
::stripSpaces($addresseeString));
2899 $updateQueryString[] = " addressee_display = '{$addresseeString}'";
2902 if (!empty($updateQueryString)) {
2903 $updateQueryString = implode(',', $updateQueryString);
2904 $queryString = "UPDATE civicrm_contact SET {$updateQueryString} WHERE id = {$contact->id}";
2905 CRM_Core_DAO
::executeQuery($queryString);
2910 * Retrieve loc block ids w/ given condition.
2912 * @param int $contactId
2914 * @param array $criteria
2915 * Key => value pair which should be.
2916 * fulfill by return record ids.
2917 * @param string $condOperator
2918 * Operator use for grouping multiple conditions.
2921 * loc block ids which fulfill condition.
2923 public static function getLocBlockIds($contactId, $criteria = [], $condOperator = 'AND') {
2926 return $locBlockIds;
2929 foreach (['Email', 'OpenID', 'Phone', 'Address', 'IM'] as $block) {
2930 $name = strtolower($block);
2931 $className = "CRM_Core_DAO_$block";
2932 $blockDAO = new $className();
2934 // build the condition.
2935 if (is_array($criteria)) {
2936 $fields = $blockDAO->fields();
2938 foreach ($criteria as $field => $value) {
2939 if (array_key_exists($field, $fields)) {
2940 $cond = "( $field = $value )";
2941 // value might be zero or null.
2942 if (!$value ||
strtolower($value) === 'null') {
2943 $cond = "( $field = 0 OR $field IS NULL )";
2945 $conditions[] = $cond;
2948 if (!empty($conditions)) {
2949 $blockDAO->whereAdd(implode(" $condOperator ", $conditions));
2953 $blockDAO->contact_id
= $contactId;
2955 while ($blockDAO->fetch()) {
2956 $locBlockIds[$name][] = $blockDAO->id
;
2960 return $locBlockIds;
2964 * Build context menu items.
2966 * @param int $contactId
2969 * Array of context menu for logged in user.
2971 public static function contextMenu($contactId = NULL) {
2974 'title' => ts('View Contact'),
2976 'ref' => 'view-contact',
2977 'class' => 'no-popup',
2979 'permissions' => ['view all contacts'],
2982 'title' => ts('Edit Contact'),
2984 'ref' => 'edit-contact',
2985 'class' => 'no-popup',
2987 'permissions' => ['edit all contacts'],
2990 'title' => ts('Delete Contact'),
2992 'ref' => 'delete-contact',
2994 'permissions' => ['access deleted contacts', 'delete contacts'],
2997 'title' => ts('Add Contribution'),
2999 'ref' => 'new-contribution',
3000 'key' => 'contribution',
3001 'tab' => 'contribute',
3002 'component' => 'CiviContribute',
3003 'href' => CRM_Utils_System
::url('civicrm/contact/view/contribution',
3004 'reset=1&action=add&context=contribution'
3007 'access CiviContribute',
3008 'edit contributions',
3012 'title' => ts('Register for Event'),
3014 'ref' => 'new-participant',
3015 'key' => 'participant',
3016 'tab' => 'participant',
3017 'component' => 'CiviEvent',
3018 'href' => CRM_Utils_System
::url('civicrm/contact/view/participant', 'reset=1&action=add&context=participant'),
3021 'edit event participants',
3025 'title' => ts('Record Activity'),
3027 'ref' => 'new-activity',
3028 'key' => 'activity',
3029 'permissions' => ['edit all contacts'],
3032 'title' => ts('Add Pledge'),
3034 'ref' => 'new-pledge',
3037 'href' => CRM_Utils_System
::url('civicrm/contact/view/pledge',
3038 'reset=1&action=add&context=pledge'
3040 'component' => 'CiviPledge',
3042 'access CiviPledge',
3047 'title' => ts('Add Membership'),
3049 'ref' => 'new-membership',
3050 'key' => 'membership',
3052 'component' => 'CiviMember',
3053 'href' => CRM_Utils_System
::url('civicrm/contact/view/membership',
3054 'reset=1&action=add&context=membership'
3057 'access CiviMember',
3062 'title' => ts('Add Case'),
3064 'ref' => 'new-case',
3067 'component' => 'CiviCase',
3068 'href' => CRM_Utils_System
::url('civicrm/case/add', 'reset=1&action=add&context=case'),
3069 'permissions' => ['add cases'],
3072 'title' => ts('Add Grant'),
3074 'ref' => 'new-grant',
3077 'component' => 'CiviGrant',
3078 'href' => CRM_Utils_System
::url('civicrm/contact/view/grant',
3079 'reset=1&action=add&context=grant'
3081 'permissions' => ['edit grants'],
3084 'title' => ts('Add Relationship'),
3086 'ref' => 'new-relationship',
3089 'href' => CRM_Utils_System
::url('civicrm/contact/view/rel',
3090 'reset=1&action=add'
3092 'permissions' => ['edit all contacts'],
3095 'title' => ts('Add Note'),
3097 'ref' => 'new-note',
3100 'class' => 'medium-popup',
3101 'href' => CRM_Utils_System
::url('civicrm/contact/view/note',
3102 'reset=1&action=add'
3104 'permissions' => ['edit all contacts'],
3107 'title' => ts('Send an Email'),
3109 'ref' => 'new-email',
3111 'permissions' => ['view all contacts'],
3114 'title' => ts('Add to Group'),
3116 'ref' => 'group-add-contact',
3119 'permissions' => ['edit groups'],
3122 'title' => ts('Tag Contact'),
3124 'ref' => 'tag-contact',
3127 'permissions' => ['edit all contacts'],
3131 $menu['otherActions'] = [
3133 'title' => ts('Print Summary'),
3134 'description' => ts('Printer-friendly view of this page.'),
3136 'ref' => 'crm-contact-print',
3139 'href' => CRM_Utils_System
::url('civicrm/contact/view/print',
3143 'icon' => 'crm-i fa-print',
3146 'title' => ts('vCard'),
3147 'description' => ts('vCard record for this contact.'),
3149 'ref' => 'crm-contact-vcard',
3152 'href' => CRM_Utils_System
::url('civicrm/contact/view/vcard',
3156 'icon' => 'crm-i fa-list-alt',
3160 if (CRM_Core_Permission
::check('access Contact Dashboard')) {
3161 $menu['otherActions']['dashboard'] = [
3162 'title' => ts('Contact Dashboard'),
3163 'description' => ts('Contact Dashboard'),
3165 'ref' => 'crm-contact-dashboard',
3166 'key' => 'dashboard',
3167 'tab' => 'dashboard',
3168 'class' => 'dashboard',
3169 // NOTE: As an alternative you can also build url on CMS specific way
3170 // as CRM_Core_Config::singleton()->userSystem->getUserRecordUrl($contactId)
3171 'href' => CRM_Utils_System
::url('civicrm/user', "reset=1&id={$contactId}"),
3172 'icon' => 'crm-i fa-tachometer',
3176 $uid = CRM_Core_BAO_UFMatch
::getUFId($contactId);
3178 $menu['otherActions']['user-record'] = [
3179 'title' => ts('User Record'),
3180 'description' => ts('User Record'),
3182 'ref' => 'crm-contact-user-record',
3183 'key' => 'user-record',
3184 'tab' => 'user-record',
3185 'class' => 'user-record',
3186 'href' => CRM_Core_Config
::singleton()->userSystem
->getUserRecordUrl($contactId),
3187 'icon' => 'crm-i fa-user',
3190 elseif (CRM_Core_Config
::singleton()->userSystem
->checkPermissionAddUser()) {
3191 $menu['otherActions']['user-add'] = [
3192 'title' => ts('Create User Record'),
3193 'description' => ts('Create User Record'),
3195 'ref' => 'crm-contact-user-add',
3196 'key' => 'user-add',
3197 'tab' => 'user-add',
3198 'class' => 'user-add',
3199 'href' => CRM_Utils_System
::url('civicrm/contact/view/useradd', 'reset=1&action=add&cid=' . $contactId),
3200 'icon' => 'crm-i fa-user-plus',
3204 CRM_Utils_Hook
::summaryActions($menu, $contactId);
3205 //1. check for component is active.
3206 //2. check for user permissions.
3207 //3. check for acls.
3208 //3. edit and view contact are directly accessible to user.
3210 $aclPermissionedTasks = [
3215 'group-add-contact',
3219 $corePermission = CRM_Core_Permission
::getPermission();
3222 foreach ($menu as $key => $values) {
3223 if ($key !== 'otherActions') {
3225 // user does not have necessary permissions.
3226 if (!self
::checkUserMenuPermissions($aclPermissionedTasks, $corePermission, $values)) {
3229 // build directly accessible action menu.
3230 if (in_array($values['ref'], [
3234 $contextMenu['primaryActions'][$key] = [
3235 'title' => $values['title'],
3236 'ref' => $values['ref'],
3237 'class' => $values['class'] ??
NULL,
3238 'key' => $values['key'],
3243 // finally get menu item for -more- action widget.
3244 $contextMenu['moreActions'][$values['weight']] = [
3245 'title' => $values['title'],
3246 'ref' => $values['ref'],
3247 'href' => $values['href'] ??
NULL,
3248 'tab' => $values['tab'] ??
NULL,
3249 'class' => $values['class'] ??
NULL,
3250 'key' => $values['key'],
3254 foreach ($values as $value) {
3255 // user does not have necessary permissions.
3256 if (!self
::checkUserMenuPermissions($aclPermissionedTasks, $corePermission, $value)) {
3260 // finally get menu item for -more- action widget.
3261 $contextMenu['otherActions'][$value['weight']] = [
3262 'title' => $value['title'],
3263 'ref' => $value['ref'],
3264 'href' => $value['href'] ??
NULL,
3265 'tab' => $value['tab'] ??
NULL,
3266 'class' => $value['class'] ??
NULL,
3267 'icon' => $value['icon'] ??
NULL,
3268 'key' => $value['key'],
3274 ksort($contextMenu['moreActions']);
3275 ksort($contextMenu['otherActions']);
3277 return $contextMenu;
3281 * Check if user has permissions to access items in action menu.
3283 * @param array $aclPermissionedTasks
3284 * Array containing ACL related tasks.
3285 * @param string $corePermission
3286 * The permission of the user (edit or view or null).
3287 * @param array $menuOptions
3288 * Array containing params of the menu (title, href, etc).
3291 * TRUE if user has all permissions, FALSE if otherwise.
3293 public static function checkUserMenuPermissions($aclPermissionedTasks, $corePermission, $menuOptions) {
3294 $componentName = $menuOptions['component'] ??
NULL;
3296 // if component action - make sure component is enable.
3297 if ($componentName && !in_array($componentName, CRM_Core_Config
::singleton()->enableComponents
)) {
3301 // make sure user has all required permissions.
3302 $hasAllPermissions = FALSE;
3304 $permissions = $menuOptions['permissions'] ??
NULL;
3305 if (!is_array($permissions) ||
empty($permissions)) {
3306 $hasAllPermissions = TRUE;
3309 // iterate for required permissions in given permissions array.
3310 if (!$hasAllPermissions) {
3311 $hasPermissions = 0;
3312 foreach ($permissions as $permission) {
3313 if (CRM_Core_Permission
::check($permission)) {
3318 if (count($permissions) == $hasPermissions) {
3319 $hasAllPermissions = TRUE;
3322 // if still user does not have required permissions, check acl.
3323 if (!$hasAllPermissions && $menuOptions['ref'] !== 'delete-contact') {
3324 if (in_array($menuOptions['ref'], $aclPermissionedTasks) &&
3325 $corePermission == CRM_Core_Permission
::EDIT
3327 $hasAllPermissions = TRUE;
3329 elseif (in_array($menuOptions['ref'], [
3332 // grant permissions for these tasks.
3333 $hasAllPermissions = TRUE;
3338 return $hasAllPermissions;
3342 * Retrieve display name of contact that address is shared.
3344 * This is based on $masterAddressId or $contactId .
3346 * @param int $masterAddressId
3348 * @param int $contactId
3349 * Contact id. (deprecated - do not use)
3351 * @return string|null
3352 * the found display name or null.
3354 public static function getMasterDisplayName($masterAddressId = NULL, $contactId = NULL) {
3355 $masterDisplayName = NULL;
3356 if (!$masterAddressId) {
3357 return $masterDisplayName;
3361 SELECT display_name from civicrm_contact
3362 LEFT JOIN civicrm_address ON ( civicrm_address.contact_id = civicrm_contact.id )
3363 WHERE civicrm_address.id = " . $masterAddressId;
3365 $masterDisplayName = CRM_Core_DAO
::singleValueQuery($sql);
3366 return $masterDisplayName;
3370 * Get the creation/modification times for a contact.
3372 * @param int $contactId
3375 * Dates - ('created_date' => $, 'modified_date' => $)
3377 public static function getTimestamps($contactId) {
3378 $timestamps = CRM_Core_DAO
::executeQuery(
3379 'SELECT created_date, modified_date
3380 FROM civicrm_contact
3383 1 => [$contactId, 'Integer'],
3386 if ($timestamps->fetch()) {
3388 'created_date' => $timestamps->created_date
,
3389 'modified_date' => $timestamps->modified_date
,
3398 * Get a list of triggers for the contact table.
3401 * @param null $tableName
3403 * @see http://issues.civicrm.org/jira/browse/CRM-10554
3405 * @see hook_civicrm_triggerInfo
3406 * @see CRM_Core_DAO::triggerRebuild
3408 public static function triggerInfo(&$info, $tableName = NULL) {
3410 // Modifications to these records should update the contact timestamps.
3411 \Civi\Core\SqlTrigger\TimestampTriggers
::create('civicrm_contact', 'Contact')
3413 ['table' => 'civicrm_address', 'column' => 'contact_id'],
3414 ['table' => 'civicrm_email', 'column' => 'contact_id'],
3415 ['table' => 'civicrm_im', 'column' => 'contact_id'],
3416 ['table' => 'civicrm_phone', 'column' => 'contact_id'],
3417 ['table' => 'civicrm_website', 'column' => 'contact_id'],
3419 ->alterTriggerInfo($info, $tableName);
3421 // Update phone table to populate phone_numeric field
3422 if (!$tableName ||
$tableName == 'civicrm_phone') {
3423 // Define stored sql function needed for phones
3424 $sqlTriggers = Civi
::service('sql_triggers');
3425 $sqlTriggers->enqueueQuery(self
::DROP_STRIP_FUNCTION_43
);
3426 $sqlTriggers->enqueueQuery(self
::CREATE_STRIP_FUNCTION_43
);
3428 'table' => ['civicrm_phone'],
3430 'event' => ['INSERT', 'UPDATE'],
3431 'sql' => "\nSET NEW.phone_numeric = civicrm_strip_non_numeric(NEW.phone);\n",
3437 * Check if contact is being used in civicrm_domain based on $contactId.
3439 * @param int $contactId
3443 * true if present else false.
3445 public static function checkDomainContact($contactId) {
3449 $domainId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Domain', $contactId, 'id', 'contact_id');
3460 * Get options for a given contact field.
3462 * @param string $fieldName
3463 * @param string $context
3464 * @param array $props
3465 * whatever is known about this dao object.
3467 * @return array|bool
3468 * @see CRM_Core_DAO::buildOptions
3470 * TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow?
3471 * TODO: In context of chainselect, what to return if e.g. a country has no states?
3473 * @see CRM_Core_DAO::buildOptionsContext
3475 public static function buildOptions($fieldName, $context = NULL, $props = []) {
3477 // Special logic for fields whose options depend on context or properties
3478 switch ($fieldName) {
3479 case 'contact_sub_type':
3480 if (!empty($props['contact_type'])) {
3481 $params['condition'] = "parent_id = (SELECT id FROM civicrm_contact_type WHERE name='{$props['contact_type']}')";
3485 case 'contact_type':
3486 if ($context == 'search') {
3487 // CRM-15495 - EntityRef filters and basic search forms expect this format
3488 // FIXME: Search builder does not
3489 return CRM_Contact_BAO_ContactType
::getSelectElements();
3493 // The contact api supports some related entities so we'll honor that by fetching their options
3496 return CRM_Contact_BAO_GroupContact
::buildOptions('group_id', $context, $props);
3500 $props['entity_table'] = 'civicrm_contact';
3501 return CRM_Core_BAO_EntityTag
::buildOptions('tag_id', $context, $props);
3503 case 'state_province_id':
3504 case 'state_province':
3505 case 'state_province_name':
3510 case 'worldregion_id':
3511 return CRM_Core_BAO_Address
::buildOptions($fieldName, 'get', $props);
3514 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);
3518 * Delete a contact-related object that has an 'is_primary' field.
3520 * Ensures that is_primary gets assigned to another object if available
3521 * Also calls pre/post hooks
3523 * @param string $type
3528 public static function deleteObjectWithPrimary($type, $id) {
3529 if (!$id ||
!is_numeric($id)) {
3532 $daoName = "CRM_Core_DAO_$type";
3533 $obj = new $daoName();
3537 if ($obj->fetch()) {
3538 CRM_Utils_Hook
::pre('delete', $type, $id, $hookParams);
3539 $contactId = $obj->contact_id
;
3545 // is_primary is only relavent if this field belongs to a contact
3547 $dao = new $daoName();
3548 $dao->contact_id
= $contactId;
3549 $dao->is_primary
= 1;
3550 // Pick another record to be primary (if one isn't already)
3551 if (!$dao->find(TRUE)) {
3552 $dao->is_primary
= 0;
3554 if ($dao->fetch()) {
3555 $dao->is_primary
= 1;
3560 CRM_Utils_Hook
::post('delete', $type, $id, $obj);
3567 public function addSelectWhereClause() {
3568 // We always return an array with these keys, even if they are empty,
3569 // because this tells the query builder that we have considered these fields for acls
3571 'id' => (array) CRM_Contact_BAO_Contact_Permission
::cacheSubquery(),
3572 'is_deleted' => CRM_Core_Permission
::check('access deleted contacts') ?
[] : ['!= 1'],
3574 CRM_Utils_Hook
::selectWhereClause($this, $clauses);
3579 * Get any existing duplicate contacts based on the input parameters.
3581 * @param array $input
3582 * Input parameters to be matched.
3583 * @param string $contactType
3584 * @param string $rule
3587 * @param $excludedContactIDs
3588 * An array of ids not to be included in the results.
3589 * @param bool $checkPermissions
3590 * @param int $ruleGroupID
3591 * ID of the rule group to be used if an override is desirable.
3592 * @param array $contextParams
3593 * The context if relevant, eg. ['event_id' => X]
3597 public static function getDuplicateContacts($input, $contactType, $rule = 'Unsupervised', $excludedContactIDs = [], $checkPermissions = TRUE, $ruleGroupID = NULL, $contextParams = []) {
3598 $dedupeParams = CRM_Dedupe_Finder
::formatParams($input, $contactType);
3599 $dedupeParams['check_permission'] = $checkPermissions;
3600 $dedupeParams['contact_type'] = $contactType;
3601 $dedupeParams['rule'] = $rule;
3602 $dedupeParams['rule_group_id'] = $ruleGroupID;
3603 $dedupeParams['excluded_contact_ids'] = $excludedContactIDs;
3604 $dedupeResults['ids'] = [];
3605 $dedupeResults['handled'] = FALSE;
3606 CRM_Utils_Hook
::findDuplicates($dedupeParams, $dedupeResults, $contextParams);
3607 if (!$dedupeResults['handled']) {
3608 $dedupeResults['ids'] = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, $contactType, $rule, $excludedContactIDs, $ruleGroupID);
3610 return $dedupeResults['ids'];
3614 * Get the first duplicate contacts based on the input parameters.
3616 * @param array $input
3617 * Input parameters to be matched.
3618 * @param string $contactType
3619 * @param string $rule
3622 * @param $excludedContactIDs
3623 * An array of ids not to be included in the results.
3624 * @param bool $checkPermissions
3625 * @param int $ruleGroupID
3626 * ID of the rule group to be used if an override is desirable.
3627 * @param array $contextParams
3628 * The context if relevant, eg. ['event_id' => X]
3632 public static function getFirstDuplicateContact($input, $contactType, $rule = 'Unsupervised', $excludedContactIDs = [], $checkPermissions = TRUE, $ruleGroupID = NULL, $contextParams = []) {
3633 $ids = self
::getDuplicateContacts($input, $contactType, $rule, $excludedContactIDs, $checkPermissions, $ruleGroupID, $contextParams);
3641 * Check if a field is associated with an entity that has a location type.
3643 * (ie. is an address, phone, email etc field).
3645 * @param string $fieldTitle
3646 * Title of the field (not the name - create a new function for that if required).
3650 public static function isFieldHasLocationType($fieldTitle) {
3651 foreach (CRM_Contact_BAO_Contact
::importableFields() as $key => $field) {
3652 if ($field['title'] === $fieldTitle) {
3653 return $field['hasLocationType'] ??
NULL;
3660 * @param array $appendProfiles
3661 * Name of profile(s) to append to each link.
3665 public static function getEntityRefCreateLinks($appendProfiles = []) {
3666 // You'd think that "create contacts" would be the permission to check,
3667 // But new contact popups are profile forms and those use their own permissions.
3668 if (!CRM_Core_Permission
::check([['profile create', 'profile listings and forms']])) {
3672 foreach (CRM_Contact_BAO_ContactType
::basicTypes() as $contactType) {
3673 $profiles[] = 'new_' . strtolower($contactType);
3675 $retrieved = civicrm_api3('uf_group', 'get', [
3676 'name' => ['IN' => array_merge($profiles, (array) $appendProfiles)],
3679 $links = $append = [];
3680 if (!empty($retrieved['values'])) {
3682 'individual' => 'fa-user',
3683 'organization' => 'fa-building',
3684 'household' => 'fa-home',
3686 foreach ($retrieved['values'] as $id => $profile) {
3687 if (in_array($profile['name'], $profiles)) {
3689 'label' => $profile['title'],
3690 'url' => CRM_Utils_System
::url('civicrm/profile/create', "reset=1&context=dialog&gid=$id",
3691 NULL, NULL, FALSE, FALSE, TRUE),
3692 'type' => ucfirst(str_replace('new_', '', $profile['name'])),
3693 'icon' => $icons[str_replace('new_', '', $profile['name'])] ??
NULL,
3700 foreach ($append as $id) {
3701 foreach ($links as &$link) {
3702 $link['url'] .= ",$id";
3712 public static function getEntityRefFilters() {
3714 ['key' => 'contact_type', 'value' => ts('Contact Type')],
3715 ['key' => 'group', 'value' => ts('Group'), 'entity' => 'GroupContact'],
3716 ['key' => 'tag', 'value' => ts('Tag'), 'entity' => 'EntityTag'],
3717 ['key' => 'city', 'value' => ts('City'), 'type' => 'text', 'entity' => 'Address'],
3718 ['key' => 'postal_code', 'value' => ts('Postal Code'), 'type' => 'text', 'entity' => 'Address'],
3719 ['key' => 'state_province', 'value' => ts('State/Province'), 'entity' => 'Address'],
3720 ['key' => 'country', 'value' => ts('Country'), 'entity' => 'Address'],
3721 ['key' => 'first_name', 'value' => ts('First Name'), 'type' => 'text', 'condition' => ['contact_type' => 'Individual']],
3722 ['key' => 'last_name', 'value' => ts('Last Name'), 'type' => 'text', 'condition' => ['contact_type' => 'Individual']],
3723 ['key' => 'nick_name', 'value' => ts('Nick Name'), 'type' => 'text', 'condition' => ['contact_type' => 'Individual']],
3724 ['key' => 'organization_name', 'value' => ts('Employer name'), 'type' => 'text', 'condition' => ['contact_type' => 'Individual']],
3725 ['key' => 'gender_id', 'value' => ts('Gender'), 'condition' => ['contact_type' => 'Individual']],
3726 ['key' => 'is_deceased', 'value' => ts('Deceased'), 'condition' => ['contact_type' => 'Individual']],
3727 ['key' => 'contact_id', 'value' => ts('Contact ID'), 'type' => 'text'],
3728 ['key' => 'external_identifier', 'value' => ts('External ID'), 'type' => 'text'],
3729 ['key' => 'source', 'value' => ts('Contact Source'), 'type' => 'text'],