3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
33 class CRM_Contact_BAO_Contact
extends CRM_Contact_DAO_Contact
{
36 * SQL function used to format the phone_numeric field via trigger.
37 * @see self::triggerInfo()
39 * Note that this is also used by the 4.3 upgrade script.
40 * @see CRM_Upgrade_Incremental_php_FourThree
42 const DROP_STRIP_FUNCTION_43
= "DROP FUNCTION IF EXISTS civicrm_strip_non_numeric";
43 const CREATE_STRIP_FUNCTION_43
= "
44 CREATE FUNCTION civicrm_strip_non_numeric(input VARCHAR(255) CHARACTER SET utf8)
45 RETURNS VARCHAR(255) CHARACTER SET utf8
49 DECLARE output VARCHAR(255) CHARACTER SET utf8 DEFAULT '';
50 DECLARE iterator INT DEFAULT 1;
51 WHILE iterator < (LENGTH(input) + 1) DO
52 IF SUBSTRING(input, iterator, 1) IN ('0', '1', '2', '3', '4', '5', '6', '7', '8', '9') THEN
53 SET output = CONCAT(output, SUBSTRING(input, iterator, 1));
55 SET iterator = iterator + 1;
61 * The types of communication preferences.
65 public static $_commPrefs = array(
78 public static $_greetingTypes = array(
85 * Static field for all the contact information that we can potentially import.
89 public static $_importableFields = array();
92 * Static field for all the contact information that we can potentially export.
96 public static $_exportableFields = NULL;
101 public function __construct() {
102 parent
::__construct();
106 * Takes an associative array and creates a contact object.
108 * The function extracts all the params it needs to initialize the create a
109 * contact object. the params array could contain additional unused name/value
112 * @param array $params
113 * (reference) an assoc array of name/value pairs.
115 * @return CRM_Contact_BAO_Contact|CRM_Core_Error|NULL
116 * Created or updated contact object or error object.
117 * (error objects are being phased out in favour of exceptions)
119 public static function add(&$params) {
120 $contact = new CRM_Contact_DAO_Contact();
122 if (empty($params)) {
126 // Fix for validate contact sub type CRM-5143.
127 if (isset($params['contact_sub_type'])) {
128 if (empty($params['contact_sub_type'])) {
129 $params['contact_sub_type'] = 'null';
132 if (!CRM_Contact_BAO_ContactType
::isExtendsContactType($params['contact_sub_type'],
133 $params['contact_type'], TRUE
136 // we'll need to fix tests to handle this
138 CRM_Core_Error
::fatal(ts('The Contact Sub Type does not match the Contact type for this record'));
140 $params['contact_sub_type'] = CRM_Utils_Array
::implodePadded($params['contact_sub_type']);
146 $params['contact_sub_type'] = 'null';
149 if (isset($params['preferred_communication_method']) && is_array($params['preferred_communication_method'])) {
150 CRM_Utils_Array
::formatArrayKeys($params['preferred_communication_method']);
151 $contact->preferred_communication_method
= CRM_Utils_Array
::implodePadded($params['preferred_communication_method']);
152 unset($params['preferred_communication_method']);
155 $defaults = ['source' => CRM_Utils_Array
::value('contact_source', $params)];
156 if ($params['contact_type'] === 'Organization' && isset($params['organization_name'])) {
157 $defaults['display_name'] = $params['organization_name'];
158 $defaults['sort_name'] = $params['organization_name'];
160 if ($params['contact_type'] === 'Household' && isset($params['household_name'])) {
161 $defaults['display_name'] = $params['household_name'];
162 $defaults['sort_name'] = $params['household_name'];
164 $params = array_merge($defaults, $params);
166 $allNull = $contact->copyValues($params);
168 $contact->id
= CRM_Utils_Array
::value('contact_id', $params);
170 if ($contact->contact_type
== 'Individual') {
172 // @todo allow the lines below to be overridden by input or hooks & add tests,
173 // as has been done for households and organizations.
174 // Format individual fields.
175 CRM_Contact_BAO_Individual
::format($params, $contact);
178 if (strlen($contact->display_name
) > 128) {
179 $contact->display_name
= substr($contact->display_name
, 0, 128);
181 if (strlen($contact->sort_name
) > 128) {
182 $contact->sort_name
= substr($contact->sort_name
, 0, 128);
185 $privacy = CRM_Utils_Array
::value('privacy', $params);
187 is_array($privacy) &&
191 foreach (self
::$_commPrefs as $name) {
192 $contact->$name = CRM_Utils_Array
::value($name, $privacy, FALSE);
196 // Since hash was required, make sure we have a 0 value for it (CRM-1063).
197 // @todo - does this mean we can remove this block?
198 // Fixed in 1.5 by making hash optional, only do this in create mode, not update.
199 if ((!array_key_exists('hash', $contact) ||
!$contact->hash
) && !$contact->id
) {
201 $contact->hash
= md5(uniqid(rand(), TRUE));
204 // Even if we don't need $employerId, it's important to call getFieldValue() before
205 // the contact is saved because we want the existing value to be cached.
206 // createCurrentEmployerRelationship() needs the old value not the updated one. CRM-10788
207 $employerId = empty($contact->id
) ?
NULL : CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contact->id
, 'employer_id');
212 CRM_Core_BAO_Log
::register($contact->id
,
218 if ($contact->contact_type
== 'Individual' && (isset($params['current_employer']) ||
isset($params['employer_id']))) {
219 // Create current employer.
220 $newEmployer = !empty($params['employer_id']) ?
$params['employer_id'] : CRM_Utils_Array
::value('current_employer', $params);
223 if (empty($params['contact_id'])) {
227 CRM_Contact_BAO_Contact_Utils
::createCurrentEmployerRelationship($contact->id
, $newEmployer, $employerId, $newContact);
231 CRM_Contact_BAO_Contact_Utils
::clearCurrentEmployer($contact->id
, $employerId);
236 // Update cached employer name.
237 if ($contact->contact_type
== 'Organization') {
238 CRM_Contact_BAO_Contact_Utils
::updateCurrentEmployer($contact->id
);
247 * takes an associative array and creates a contact object and all the associated
248 * derived objects (i.e. individual, location, email, phone etc)
250 * This function is invoked from within the web form layer and also from the api layer
252 * @param array $params
253 * (reference ) an assoc array of name/value pairs.
254 * @param bool $fixAddress
255 * If we need to fix address.
256 * @param bool $invokeHooks
257 * If we need to invoke hooks.
259 * @param bool $skipDelete
260 * Unclear parameter, passed to website create
262 * @todo explain this parameter
265 * @return CRM_Contact_BAO_Contact|CRM_Core_Error
266 * Created or updated contribution object. We are deprecating returning an error in
267 * favour of exceptions
269 public static function &create(&$params, $fixAddress = TRUE, $invokeHooks = TRUE, $skipDelete = FALSE) {
271 if (empty($params['contact_type']) && empty($params['contact_id'])) {
275 if (!empty($params['contact_id']) && empty($params['contact_type'])) {
276 $params['contact_type'] = self
::getContactType($params['contact_id']);
281 if (!empty($params['contact_id'])) {
282 CRM_Utils_Hook
::pre('edit', $params['contact_type'], $params['contact_id'], $params);
285 CRM_Utils_Hook
::pre('create', $params['contact_type'], NULL, $params);
290 self
::ensureGreetingParamsAreSet($params);
292 // CRM-6942: set preferred language to the current language if it’s unset (and we’re creating a contact).
293 if (empty($params['contact_id'])) {
294 // A case could be made for checking isset rather than empty but this is more consistent with previous behaviour.
295 if (empty($params['preferred_language']) && ($language = CRM_Core_I18n
::getContactDefaultLanguage()) != FALSE) {
296 $params['preferred_language'] = $language;
299 // CRM-21041: set default 'Communication Style' if unset when creating a contact.
300 if (empty($params['communication_style_id'])) {
301 $defaultCommunicationStyleId = CRM_Core_OptionGroup
::values('communication_style', TRUE, NULL, NULL, 'AND is_default = 1');
302 $params['communication_style_id'] = array_pop($defaultCommunicationStyleId);
306 $transaction = new CRM_Core_Transaction();
308 $contact = self
::add($params);
310 // Not dying here is stupid, since we get into weird situation and into a bug that
311 // is impossible to figure out for the user or for us
313 CRM_Core_Error
::fatal();
316 $params['contact_id'] = $contact->id
;
318 if (Civi
::settings()->get('is_enabled')) {
319 // Enabling multisite causes the contact to be added to the domain group.
320 $domainGroupID = CRM_Core_BAO_Domain
::getGroupId();
321 if (!empty($domainGroupID)) {
322 if (!empty($params['group']) && is_array($params['group'])) {
323 $params['group'][$domainGroupID] = 1;
326 $params['group'] = array($domainGroupID => 1);
331 if (array_key_exists('group', $params)) {
332 $contactIds = array($params['contact_id']);
333 foreach ($params['group'] as $groupId => $flag) {
335 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $groupId);
337 elseif ($flag == -1) {
338 CRM_Contact_BAO_GroupContact
::removeContactsFromGroup($contactIds, $groupId);
343 // Add location Block data.
344 $blocks = CRM_Core_BAO_Location
::create($params, $fixAddress);
345 foreach ($blocks as $name => $value) {
346 $contact->$name = $value;
348 if (!empty($params['updateBlankLocInfo'])) {
352 if (isset($params['website'])) {
353 CRM_Core_BAO_Website
::process($params['website'], $contact->id
, $skipDelete);
356 $userID = CRM_Core_Session
::singleton()->get('userID');
358 if (!empty($params['note'])) {
359 if (is_array($params['note'])) {
360 foreach ($params['note'] as $note) {
361 $contactId = $contact->id
;
362 if (isset($note['contact_id'])) {
363 $contactId = $note['contact_id'];
365 //if logged in user, overwrite contactId
367 $contactId = $userID;
371 'entity_id' => $contact->id
,
372 'entity_table' => 'civicrm_contact',
373 'note' => $note['note'],
374 'subject' => CRM_Utils_Array
::value('subject', $note),
375 'contact_id' => $contactId,
377 CRM_Core_BAO_Note
::add($noteParams, CRM_Core_DAO
::$_nullArray);
381 $contactId = $contact->id
;
382 //if logged in user, overwrite contactId
384 $contactId = $userID;
388 'entity_id' => $contact->id
,
389 'entity_table' => 'civicrm_contact',
390 'note' => $params['note'],
391 'subject' => CRM_Utils_Array
::value('subject', $params),
392 'contact_id' => $contactId,
394 CRM_Core_BAO_Note
::add($noteParams, CRM_Core_DAO
::$_nullArray);
398 // update the UF user_unique_id if that has changed
399 CRM_Core_BAO_UFMatch
::updateUFName($contact->id
);
401 if (!empty($params['custom']) &&
402 is_array($params['custom'])
404 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_contact', $contact->id
);
407 // make a civicrm_subscription_history entry only on contact create (CRM-777)
408 if (empty($params['contact_id'])) {
409 $subscriptionParams = array(
410 'contact_id' => $contact->id
,
414 CRM_Contact_BAO_SubscriptionHistory
::create($subscriptionParams);
417 $transaction->commit();
419 // CRM-6367: fetch the right label for contact type’s display
420 $contact->contact_type_display
= CRM_Core_DAO
::getFieldValue(
421 'CRM_Contact_DAO_ContactType',
422 $contact->contact_type
,
427 CRM_Contact_BAO_Contact_Utils
::clearContactCaches();
431 CRM_Utils_Hook
::post('edit', $params['contact_type'], $contact->id
, $contact);
434 CRM_Utils_Hook
::post('create', $params['contact_type'], $contact->id
, $contact);
438 // In order to prevent a series of expensive queries in intensive batch processing
439 // api calls may pass in skip_greeting_processing, probably doing it later via the
440 // scheduled job. CRM-21551
441 if (empty($params['skip_greeting_processing'])) {
442 self
::processGreetings($contact);
449 * Ensure greeting parameters are set.
451 * By always populating greetings here we can be sure they are set if required & avoid a call later.
452 * (ie. knowing we have definitely tried disambiguates between NULL & not loaded.)
454 * @param array $params
456 public static function ensureGreetingParamsAreSet(&$params) {
457 $allGreetingParams = array('addressee' => 'addressee_id', 'postal_greeting' => 'postal_greeting_id', 'email_greeting' => 'email_greeting_id');
458 $missingGreetingParams = array();
460 foreach ($allGreetingParams as $greetingIndex => $greetingParam) {
461 if (empty($params[$greetingParam])) {
462 $missingGreetingParams[$greetingIndex] = $greetingParam;
466 if (!empty($params['contact_id']) && !empty($missingGreetingParams)) {
467 $savedGreetings = civicrm_api3('Contact', 'getsingle', array(
468 'id' => $params['contact_id'],
469 'return' => array_keys($missingGreetingParams),
473 foreach (array_keys($missingGreetingParams) as $missingGreetingParam) {
474 if (!empty($savedGreetings[$missingGreetingParam . '_custom'])) {
475 $missingGreetingParams[$missingGreetingParam . '_custom'] = $missingGreetingParam . '_custom';
478 // Filter out other fields.
479 $savedGreetings = array_intersect_key($savedGreetings, array_flip($missingGreetingParams));
480 $params = array_merge($params, $savedGreetings);
483 foreach ($missingGreetingParams as $greetingName => $greeting) {
484 $params[$greeting] = CRM_Contact_BAO_Contact_Utils
::defaultGreeting($params['contact_type'], $greetingName);
488 foreach ($allGreetingParams as $greetingIndex => $greetingParam) {
489 if ($params[$greetingParam] === 'null') {
490 // If we are setting it to null then null out the display field.
491 $params[$greetingIndex . '_display'] = 'null';
497 * Get the display name and image of a contact.
502 * @param bool $includeTypeInReturnParameters
503 * Should type be part of the returned array?
506 * the displayName and contactImage for this contact
508 public static function getDisplayAndImage($id, $includeTypeInReturnParameters = FALSE) {
509 //CRM-14276 added the * on the civicrm_contact table so that we have all the contact info available
511 SELECT civicrm_contact.*,
512 civicrm_email.email as email
514 LEFT JOIN civicrm_email ON civicrm_email.contact_id = civicrm_contact.id
515 AND civicrm_email.is_primary = 1
516 WHERE civicrm_contact.id = " . CRM_Utils_Type
::escape($id, 'Integer');
517 $dao = new CRM_Core_DAO();
520 $image = CRM_Contact_BAO_Contact_Utils
::getImage($dao->contact_sub_type ?
521 $dao->contact_sub_type
: $dao->contact_type
, FALSE, $id
523 $imageUrl = CRM_Contact_BAO_Contact_Utils
::getImage($dao->contact_sub_type ?
524 $dao->contact_sub_type
: $dao->contact_type
, TRUE, $id
527 // use email if display_name is empty
528 if (empty($dao->display_name
)) {
529 $displayName = $dao->email
;
532 $displayName = $dao->display_name
;
535 CRM_Utils_Hook
::alterDisplayName($displayName, $id, $dao);
537 return $includeTypeInReturnParameters ?
array(
541 $dao->contact_sub_type
,
543 ) : array($displayName, $image, $imageUrl);
549 * Add billing fields to the params if appropriate.
551 * If we have ANY name fields then we want to ignore all the billing name fields. However, if we
552 * don't then we should set the name fields to the filling fields AND add the preserveDBName
553 * parameter (which will tell the BAO only to set those fields if none already exist.
555 * We specifically don't want to set first name from billing and last name form an on-page field. Mixing &
556 * matching is best done by hipsters.
558 * @param array $params
560 public static function addBillingNameFieldsIfOtherwiseNotSet(&$params) {
561 $nameFields = array('first_name', 'middle_name', 'last_name', 'nick_name', 'prefix_id', 'suffix_id');
562 foreach ($nameFields as $field) {
563 if (!empty($params[$field])) {
567 // There are only 3 - we can iterate through them twice :-)
568 foreach ($nameFields as $field) {
569 if (!empty($params['billing_' . $field])) {
570 $params[$field] = $params['billing_' . $field];
572 $params['preserveDBName'] = TRUE;
578 * Resolve a state province string (UT or Utah) to an ID.
580 * If country has been passed in we should select a state belonging to that country.
582 * Alternatively we should choose from enabled countries, prioritising the default country.
584 * @param array $values
585 * @param int|NULL $countryID
589 protected static function resolveStateProvinceID($values, $countryID) {
592 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceForCountry($countryID);
593 if (CRM_Utils_Array
::lookupValue($values,
598 return $values['state_province_id'];
600 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceForCountry($countryID, 'abbreviation');
601 if (CRM_Utils_Array
::lookupValue($values,
606 return $values['state_province_id'];
611 // The underlying lookupValue function needs some de-fanging. Until that has been unravelled we
612 // continue to resolve stateprovince lists in descending order of preference & just 'keep trying'.
613 // prefer matching country..
614 $stateProvinceList = CRM_Core_BAO_Address
::buildOptions('state_province_id', NULL, array('country_id' => Civi
::settings()->get('defaultContactCountry')));
615 if (CRM_Utils_Array
::lookupValue($values,
620 return $values['state_province_id'];
623 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvince();
624 if (CRM_Utils_Array
::lookupValue($values,
629 return $values['state_province_id'];
632 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceAbbreviationForDefaultCountry();
633 if (CRM_Utils_Array
::lookupValue($values,
638 return $values['state_province_id'];
640 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceAbbreviation();
641 if (CRM_Utils_Array
::lookupValue($values,
646 return $values['state_province_id'];
654 * Get the relevant location entity for the array key.
656 * Based on the field name we determine which location entity
657 * we are dealing with. Apart from a few specific ones they
658 * are mostly 'address' (the default).
660 * @param string $fieldName
664 protected static function getLocationEntityForKey($fieldName) {
665 if (in_array($fieldName, ['email', 'phone', 'im', 'openid'])) {
668 if ($fieldName === 'phone_ext') {
675 * Create last viewed link to recently updated contact.
677 * @param array $crudLinkSpec
678 * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
679 * - entity_table: string, eg "civicrm_contact"
683 * NULL if unavailable, or
684 * [path: string, query: string, title: string]
685 * @see CRM_Utils_System::createDefaultCrudLink
687 public function createDefaultCrudLink($crudLinkSpec) {
688 switch ($crudLinkSpec['action']) {
689 case CRM_Core_Action
::VIEW
:
691 'title' => $this->display_name
,
692 'path' => 'civicrm/contact/view',
700 case CRM_Core_Action
::UPDATE
:
702 'title' => $this->display_name
,
703 'path' => 'civicrm/contact/add',
706 'action' => 'update',
716 * Get the values for pseudoconstants for name->value and reverse.
720 * This is called specifically from the contact import parser & should be moved there
721 * as it is not truly a generic function.
723 * @param array $defaults
724 * (reference) the default values, some of which need to be resolved.
725 * @param bool $reverse
726 * Always true as this function is only called from one place..
728 public static function resolveDefaults(&$defaults, $reverse = FALSE) {
729 // Hack for birth_date.
730 if (!empty($defaults['birth_date'])) {
731 if (is_array($defaults['birth_date'])) {
732 $defaults['birth_date'] = CRM_Utils_Date
::format($defaults['birth_date'], '-');
736 CRM_Utils_Array
::lookupValue($defaults, 'prefix', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'prefix_id'), $reverse);
737 CRM_Utils_Array
::lookupValue($defaults, 'suffix', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'suffix_id'), $reverse);
738 CRM_Utils_Array
::lookupValue($defaults, 'gender', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id'), $reverse);
739 CRM_Utils_Array
::lookupValue($defaults, 'communication_style', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'communication_style_id'), $reverse);
741 //lookup value of email/postal greeting, addressee, CRM-4575
742 foreach (self
::$_greetingTypes as $greeting) {
743 $filterCondition = array(
744 'contact_type' => CRM_Utils_Array
::value('contact_type', $defaults),
745 'greeting_type' => $greeting,
747 CRM_Utils_Array
::lookupValue($defaults, $greeting,
748 CRM_Core_PseudoConstant
::greeting($filterCondition), $reverse
752 $blocks = array('address', 'im', 'phone');
753 foreach ($blocks as $name) {
754 if (!array_key_exists($name, $defaults) ||
!is_array($defaults[$name])) {
757 foreach ($defaults[$name] as $count => & $values) {
759 //get location type id.
760 CRM_Utils_Array
::lookupValue($values, 'location_type', CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id'), $reverse);
762 if ($name == 'address') {
763 // FIXME: lookupValue doesn't work for vcard_name
764 if (!empty($values['location_type_id'])) {
765 $vcardNames = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id', array('labelColumn' => 'vcard_name'));
766 $values['vcard_name'] = $vcardNames[$values['location_type_id']];
769 if (!CRM_Utils_Array
::lookupValue($values,
771 CRM_Core_PseudoConstant
::country(),
776 CRM_Utils_Array
::lookupValue($values,
778 CRM_Core_PseudoConstant
::countryIsoCode(),
782 $stateProvinceID = self
::resolveStateProvinceID($values, CRM_Utils_Array
::value('country_id', $values));
783 if ($stateProvinceID) {
784 $values['state_province_id'] = $stateProvinceID;
787 if (!empty($values['state_province_id'])) {
788 $countyList = CRM_Core_PseudoConstant
::countyForState($values['state_province_id']);
791 $countyList = CRM_Core_PseudoConstant
::county();
793 CRM_Utils_Array
::lookupValue($values,
801 CRM_Utils_Array
::lookupValue($values,
803 CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id'),
808 if ($name == 'phone') {
809 CRM_Utils_Array
::lookupValue($values,
811 CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id'),
816 // Kill the reference.
823 * Fetch object based on array of properties.
825 * @param array $params
826 * (reference ) an assoc array of name/value pairs.
827 * @param array $defaults
828 * (reference ) an assoc array to hold the name / value pairs.
829 * in a hierarchical manner
830 * @param bool $microformat
831 * For location in microformat.
833 * @return CRM_Contact_BAO_Contact
835 public static function &retrieve(&$params, &$defaults, $microformat = FALSE) {
836 if (array_key_exists('contact_id', $params)) {
837 $params['id'] = $params['contact_id'];
839 elseif (array_key_exists('id', $params)) {
840 $params['contact_id'] = $params['id'];
843 $contact = self
::getValues($params, $defaults);
845 unset($params['id']);
847 //get the block information for this contact
848 $entityBlock = array('contact_id' => $params['contact_id']);
849 $blocks = CRM_Core_BAO_Location
::getValues($entityBlock, $microformat);
850 $defaults = array_merge($defaults, $blocks);
851 foreach ($blocks as $block => $value) {
852 $contact->$block = $value;
855 if (!isset($params['noNotes'])) {
856 $contact->notes
= CRM_Core_BAO_Note
::getValues($params, $defaults);
859 if (!isset($params['noRelationships'])) {
860 $contact->relationship
= CRM_Contact_BAO_Relationship
::getValues($params, $defaults);
863 if (!isset($params['noGroups'])) {
864 $contact->groupContact
= CRM_Contact_BAO_GroupContact
::getValues($params, $defaults);
867 if (!isset($params['noWebsite'])) {
868 $contact->website
= CRM_Core_BAO_Website
::getValues($params, $defaults);
875 * Get the display name of a contact.
880 * @return null|string
881 * display name of the contact if found
883 public static function displayName($id) {
886 $displayName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $id, 'display_name');
893 * Delete a contact and all its associated records.
896 * Id of the contact to delete.
897 * @param bool $restore
898 * Whether to actually restore, not delete.
899 * @param bool $skipUndelete
900 * Whether to force contact delete or not.
901 * @param bool $checkPermissions
904 * Was contact deleted?
906 public static function deleteContact($id, $restore = FALSE, $skipUndelete = FALSE, $checkPermissions = TRUE) {
911 // If trash is disabled in system settings then we always skip
912 if (!Civi
::settings()->get('contact_undelete')) {
913 $skipUndelete = TRUE;
916 // make sure we have edit permission for this contact
918 if ($checkPermissions && (($skipUndelete && !CRM_Core_Permission
::check('delete contacts')) ||
919 ($restore && !CRM_Core_Permission
::check('access deleted contacts')))
925 // Restrict contact to be delete if contact has financial trxns
927 if ($skipUndelete && CRM_Financial_BAO_FinancialItem
::checkContactPresent(array($id), $error)) {
931 // make sure this contact_id does not have any membership types
932 $membershipTypeID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
935 'member_of_contact_id'
937 if ($membershipTypeID) {
941 $contact = new CRM_Contact_DAO_Contact();
943 if (!$contact->find(TRUE)) {
947 $contactType = $contact->contact_type
;
948 // currently we only clear employer cache.
949 // we are now deleting inherited membership if any.
950 if ($contact->contact_type
== 'Organization') {
951 $action = $restore ? CRM_Core_Action
::ENABLE
: CRM_Core_Action
::DISABLE
;
952 $relationshipDtls = CRM_Contact_BAO_Relationship
::getRelationship($id);
953 if (!empty($relationshipDtls)) {
954 foreach ($relationshipDtls as $rId => $details) {
955 CRM_Contact_BAO_Relationship
::disableEnableRelationship($rId, $action);
958 CRM_Contact_BAO_Contact_Utils
::clearAllEmployee($id);
962 return self
::contactTrashRestore($contact, TRUE);
965 // start a new transaction
966 $transaction = new CRM_Core_Transaction();
969 CRM_Utils_Hook
::pre('delete', $contactType, $id, CRM_Core_DAO
::$_nullArray);
971 //delete billing address if exists.
972 CRM_Contribute_BAO_Contribution
::deleteAddress(NULL, $id);
974 // delete the log entries since we dont have triggers enabled as yet
975 $logDAO = new CRM_Core_DAO_Log();
976 $logDAO->entity_table
= 'civicrm_contact';
977 $logDAO->entity_id
= $id;
980 // delete contact participants CRM-12155
981 CRM_Event_BAO_Participant
::deleteContactParticipant($id);
983 // delete contact contributions CRM-12155
984 CRM_Contribute_BAO_Contribution
::deleteContactContribution($id);
986 // do activity cleanup, CRM-5604
987 CRM_Activity_BAO_Activity
::cleanupActivity($id);
989 // delete all notes related to contact
990 CRM_Core_BAO_Note
::cleanContactNotes($id);
992 // delete cases related to contact
993 $contactCases = CRM_Case_BAO_Case
::retrieveCaseIdsByContactId($id);
994 if (!empty($contactCases)) {
995 foreach ($contactCases as $caseId) {
996 //check if case is associate with other contact or not.
997 $caseContactId = CRM_Case_BAO_Case
::getCaseClients($caseId);
998 if (count($caseContactId) <= 1) {
999 CRM_Case_BAO_Case
::deleteCase($caseId);
1007 self
::contactTrashRestore($contact);
1010 //delete the contact id from recently view
1011 CRM_Utils_Recent
::delContact($id);
1012 self
::updateContactCache($id, empty($restore));
1014 // delete any prevnext/dupe cache entry
1015 // These two calls are redundant in default deployments, but they're
1016 // meaningful if "prevnext" is memory-backed.
1017 Civi
::service('prevnext')->deleteItem($id);
1018 CRM_Core_BAO_PrevNextCache
::deleteItem($id);
1020 $transaction->commit();
1022 if ($skipUndelete) {
1023 CRM_Utils_Hook
::post('delete', $contactType, $contact->id
, $contact);
1030 * Action to update any caches relating to a recently update contact.
1032 * I was going to call this from delete as well as from create to ensure the delete is being
1033 * done whenever a contact is set to is_deleted=1 BUT I found create is already over-aggressive in
1034 * that regard so adding it to delete seems to be enough to remove it from CRM_Contact_BAO_Contact_Permission
1035 * where the call involved a subquery that was locking the table.
1037 * @param int $contactID
1038 * @param bool $isTrashed
1040 public static function updateContactCache($contactID, $isTrashed = FALSE) {
1043 CRM_Contact_BAO_GroupContactCache
::removeContact($contactID);
1044 // This has been moved to here from CRM_Contact_BAO_Contact_Permission as that was causing
1045 // a table-locking query. It still seems a bit inadequate as it assumes the acl users can't see deleted
1046 // but this should not cause any change as long as contacts are not being trashed outside the
1047 // main functions for that.
1048 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_acl_contact_cache WHERE contact_id = %1', array(1 => array($contactID, 'Integer')));
1051 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
1056 * Delete the image of a contact.
1059 * Id of the contact.
1062 * Was contact image deleted?
1064 public static function deleteContactImage($id) {
1069 $contact = new self();
1071 $contact->image_URL
= 'null';
1078 * Return proportional height and width of the image.
1080 * @param int $imageWidth
1083 * @param int $imageHeight
1087 * Thumb dimension of image
1089 public static function getThumbSize($imageWidth, $imageHeight) {
1091 if ($imageWidth && $imageHeight) {
1092 $imageRatio = $imageWidth / $imageHeight;
1097 if ($imageRatio > 1) {
1098 $imageThumbWidth = $thumbWidth;
1099 $imageThumbHeight = round($thumbWidth / $imageRatio);
1102 $imageThumbHeight = $thumbWidth;
1103 $imageThumbWidth = round($thumbWidth * $imageRatio);
1106 return array($imageThumbWidth, $imageThumbHeight);
1110 * Validate type of contact image.
1112 * @param array $params
1113 * @param string $imageIndex
1114 * Index of image field.
1115 * @param string $statusMsg
1116 * Status message to be set after operation.
1117 * @param string $opType
1118 * Type of operation like fatal, bounce etc.
1121 * true if valid image extension
1123 public static function processImageParams(
1125 $imageIndex = 'image_URL',
1139 if (in_array($params[$imageIndex]['type'], $mimeType)) {
1140 $photo = basename($params[$imageIndex]['name']);
1141 $params[$imageIndex] = CRM_Utils_System
::url('civicrm/contact/imagefile', 'photo=' . $photo, TRUE, NULL, TRUE, TRUE);
1145 unset($params[$imageIndex]);
1147 $statusMsg = ts('Image could not be uploaded due to invalid type extension.');
1149 if ($opType == 'status') {
1150 CRM_Core_Session
::setStatus($statusMsg, ts('Error'), 'error');
1152 // FIXME: additional support for fatal, bounce etc could be added.
1158 * Extract contact id from url for deleting contact image.
1160 public static function processImage() {
1162 $action = CRM_Utils_Request
::retrieve('action', 'String');
1163 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive');
1164 // retrieve contact id in case of Profile context
1165 $id = CRM_Utils_Request
::retrieve('id', 'Positive');
1166 $cid = $cid ?
$cid : $id;
1167 if ($action & CRM_Core_Action
::DELETE
) {
1168 if (CRM_Utils_Request
::retrieve('confirmed', 'Boolean')) {
1169 CRM_Contact_BAO_Contact
::deleteContactImage($cid);
1170 CRM_Core_Session
::setStatus(ts('Contact image deleted successfully'), ts('Image Deleted'), 'success');
1171 $session = CRM_Core_Session
::singleton();
1172 $toUrl = $session->popUserContext();
1173 CRM_Utils_System
::redirect($toUrl);
1179 * Function to set is_delete true or restore deleted contact.
1181 * @param CRM_Contact_DAO_Contact $contact
1182 * Contact DAO object.
1183 * @param bool $restore
1184 * True to set the is_delete = 1 else false to restore deleted contact,
1185 * i.e. is_delete = 0
1189 public static function contactTrashRestore($contact, $restore = FALSE) {
1190 $updateParams = array(
1191 'id' => $contact->id
,
1192 'is_deleted' => $restore ?
0 : 1,
1195 CRM_Utils_Hook
::pre('update', $contact->contact_type
, $contact->id
, $updateParams);
1197 $params = array(1 => array($contact->id
, 'Integer'));
1199 $query = "DELETE FROM civicrm_uf_match WHERE contact_id = %1";
1200 CRM_Core_DAO
::executeQuery($query, $params);
1203 $contact->copyValues($updateParams);
1205 CRM_Core_BAO_Log
::register($contact->id
, 'civicrm_contact', $contact->id
);
1207 CRM_Utils_Hook
::post('update', $contact->contact_type
, $contact->id
, $contact);
1213 * Get contact type for a contact.
1216 * Id of the contact whose contact type is needed.
1219 * contact_type if $id found else null ""
1221 public static function getContactType($id) {
1222 return CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_type');
1226 * Get contact sub type for a contact.
1229 * Id of the contact whose contact sub type is needed.
1231 * @param string $implodeDelimiter
1234 * contact_sub_type if $id found else null ""
1236 public static function getContactSubType($id, $implodeDelimiter = NULL) {
1237 $subtype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_sub_type');
1239 return $implodeDelimiter ?
NULL : array();
1242 $subtype = CRM_Utils_Array
::explodePadded($subtype);
1244 if ($implodeDelimiter) {
1245 $subtype = implode($implodeDelimiter, $subtype);
1251 * Get pair of contact-type and sub-type for a contact.
1254 * Id of the contact whose contact sub/contact type is needed.
1258 public static function getContactTypes($id) {
1259 $params = array('id' => $id);
1261 $contact = CRM_Core_DAO
::commonRetrieve('CRM_Contact_DAO_Contact',
1264 array('contact_type', 'contact_sub_type')
1268 $contactTypes = array();
1269 if ($contact->contact_sub_type
) {
1270 $contactTypes = CRM_Utils_Array
::explodePadded($contact->contact_sub_type
);
1272 array_unshift($contactTypes, $contact->contact_type
);
1274 return $contactTypes;
1277 CRM_Core_Error
::fatal();
1282 * Combine all the importable fields from the lower levels object.
1284 * The ordering is important, since currently we do not have a weight
1285 * scheme. Adding weight is super important
1287 * @param int|string $contactType contact Type
1288 * @param bool $status
1289 * Status is used to manipulate first title.
1290 * @param bool $showAll
1291 * If true returns all fields (includes disabled fields).
1292 * @param bool $isProfile
1293 * If its profile mode.
1294 * @param bool $checkPermission
1295 * If false, do not include permissioning clause (for custom data).
1297 * @param bool $withMultiCustomFields
1300 * array of importable Fields
1302 public static function importableFields(
1303 $contactType = 'Individual',
1307 $checkPermission = TRUE,
1308 $withMultiCustomFields = FALSE
1310 if (empty($contactType)) {
1311 $contactType = 'All';
1314 $cacheKeyString = "importableFields $contactType";
1315 $cacheKeyString .= $status ?
'_1' : '_0';
1316 $cacheKeyString .= $showAll ?
'_1' : '_0';
1317 $cacheKeyString .= $isProfile ?
'_1' : '_0';
1318 $cacheKeyString .= $checkPermission ?
'_1' : '_0';
1320 $fields = CRM_Utils_Array
::value($cacheKeyString, self
::$_importableFields);
1323 // check if we can retrieve from database cache
1324 $fields = CRM_Core_BAO_Cache
::getItem('contact fields', $cacheKeyString);
1328 $fields = CRM_Contact_DAO_Contact
::import();
1330 // get the fields thar are meant for contact types
1331 if (in_array($contactType, array(
1337 $fields = array_merge($fields, CRM_Core_OptionValue
::getFields('', $contactType));
1340 $locationFields = array_merge(CRM_Core_DAO_Address
::import(),
1341 CRM_Core_DAO_Phone
::import(),
1342 CRM_Core_DAO_Email
::import(),
1343 CRM_Core_DAO_IM
::import(TRUE),
1344 CRM_Core_DAO_OpenID
::import()
1347 $locationFields = array_merge($locationFields,
1348 CRM_Core_BAO_CustomField
::getFieldsForImport('Address',
1356 foreach ($locationFields as $key => $field) {
1357 $locationFields[$key]['hasLocationType'] = TRUE;
1360 $fields = array_merge($fields, $locationFields);
1362 $fields = array_merge($fields, CRM_Contact_DAO_Contact
::import());
1363 $fields = array_merge($fields, CRM_Core_DAO_Note
::import());
1366 $fields = array_merge($fields, CRM_Core_DAO_Website
::import());
1367 $fields['url']['hasWebsiteType'] = TRUE;
1369 if ($contactType != 'All') {
1370 $fields = array_merge($fields,
1371 CRM_Core_BAO_CustomField
::getFieldsForImport($contactType,
1376 $withMultiCustomFields
1379 //unset the fields, which are not related to their
1381 $commonValues = array(
1382 'Individual' => array(
1386 'organization_name',
1388 'Household' => array(
1398 'organization_name',
1406 'Organization' => array(
1421 foreach ($commonValues[$contactType] as $value) {
1422 unset($fields[$value]);
1426 foreach (array('Individual', 'Household', 'Organization') as $type) {
1427 $fields = array_merge($fields,
1428 CRM_Core_BAO_CustomField
::getFieldsForImport($type,
1433 $withMultiCustomFields
1440 $fields = array_merge($fields, array(
1442 'title' => ts('Group(s)'),
1446 'title' => ts('Tag(s)'),
1450 'title' => ts('Note'),
1453 'communication_style_id' => array(
1454 'title' => ts('Communication Style'),
1455 'name' => 'communication_style_id',
1460 //Sorting fields in alphabetical order(CRM-1507)
1461 $fields = CRM_Utils_Array
::crmArraySortByField($fields, 'title');
1463 CRM_Core_BAO_Cache
::setItem($fields, 'contact fields', $cacheKeyString);
1466 self
::$_importableFields[$cacheKeyString] = $fields;
1470 $fields = array_merge(array('do_not_import' => array('title' => ts('- do not import -'))),
1471 self
::$_importableFields[$cacheKeyString]
1475 $fields = array_merge(array('' => array('title' => ts('- Contact Fields -'))),
1476 self
::$_importableFields[$cacheKeyString]
1484 * Combine all the exportable fields from the lower levels object.
1486 * Currently we are using importable fields as exportable fields
1488 * @param int|string $contactType contact Type
1489 * @param bool $status
1490 * True while exporting primary contacts.
1491 * @param bool $export
1492 * True when used during export.
1493 * @param bool $search
1494 * True when used during search, might conflict with export param?.
1496 * @param bool $withMultiRecord
1497 * @param bool $checkPermissions
1499 * array of exportable Fields
1501 public static function &exportableFields($contactType = 'Individual', $status = FALSE, $export = FALSE, $search = FALSE, $withMultiRecord = FALSE, $checkPermissions = TRUE) {
1502 if (empty($contactType)) {
1503 $contactType = 'All';
1506 $cacheKeyString = "exportableFields $contactType";
1507 $cacheKeyString .= $export ?
'_1' : '_0';
1508 $cacheKeyString .= $status ?
'_1' : '_0';
1509 $cacheKeyString .= $search ?
'_1' : '_0';
1510 //CRM-14501 it turns out that the impact of permissioning here is sometimes inconsistent. The field that
1511 //calculates custom fields takes into account the logged in user & caches that for all users
1512 //as an interim fix we will cache the fields by contact
1513 $cacheKeyString .= '_' . CRM_Core_Session
::getLoggedInContactID();
1515 if (!self
::$_exportableFields ||
!CRM_Utils_Array
::value($cacheKeyString, self
::$_exportableFields)) {
1516 if (!self
::$_exportableFields) {
1517 self
::$_exportableFields = array();
1520 // check if we can retrieve from database cache
1521 $fields = CRM_Core_BAO_Cache
::getItem('contact fields', $cacheKeyString);
1524 $fields = CRM_Contact_DAO_Contact
::export();
1526 // The fields are meant for contact types.
1527 if (in_array($contactType, array(
1533 $fields = array_merge($fields, CRM_Core_OptionValue
::getFields('', $contactType));
1535 // add current employer for individuals
1536 $fields = array_merge($fields, array(
1537 'current_employer' =>
1539 'name' => 'organization_name',
1540 'title' => ts('Current Employer'),
1544 $locationType = array(
1545 'location_type' => array(
1546 'name' => 'location_type',
1547 'where' => 'civicrm_location_type.name',
1548 'title' => ts('Location Type'),
1552 $IMProvider = array(
1553 'im_provider' => array(
1554 'name' => 'im_provider',
1555 'where' => 'civicrm_im.provider_id',
1556 'title' => ts('IM Provider'),
1560 $locationFields = array_merge($locationType,
1561 CRM_Core_DAO_Address
::export(),
1562 CRM_Core_DAO_Phone
::export(),
1563 CRM_Core_DAO_Email
::export(),
1565 CRM_Core_DAO_IM
::export(TRUE),
1566 CRM_Core_DAO_OpenID
::export()
1569 $locationFields = array_merge($locationFields,
1570 CRM_Core_BAO_CustomField
::getFieldsForImport('Address')
1573 foreach ($locationFields as $key => $field) {
1574 $locationFields[$key]['hasLocationType'] = TRUE;
1577 $fields = array_merge($fields, $locationFields);
1580 $fields = array_merge($fields,
1581 CRM_Core_DAO_Worldregion
::export()
1584 $fields = array_merge($fields,
1585 CRM_Contact_DAO_Contact
::export()
1589 $fields = array_merge($fields, CRM_Core_DAO_Website
::export());
1591 if ($contactType != 'All') {
1592 $fields = array_merge($fields,
1593 CRM_Core_BAO_CustomField
::getFieldsForImport($contactType, $status, FALSE, $search, $checkPermissions, $withMultiRecord)
1602 $fields = array_merge($fields,
1603 CRM_Core_BAO_CustomField
::getFieldsForImport($type, FALSE, FALSE, $search, $checkPermissions, $withMultiRecord)
1607 $fields['current_employer_id']['title'] = ts('Current Employer ID');
1610 $fields = array_merge($fields, array(
1612 'title' => ts('Group(s)'),
1616 'title' => ts('Tag(s)'),
1620 'title' => ts('Note(s)'),
1626 $fields = array_merge($fields, array(
1628 'title' => ts('Group(s)'),
1632 'title' => ts('Tag(s)'),
1636 'title' => ts('Note(s)'),
1642 //Sorting fields in alphabetical order(CRM-1507)
1643 foreach ($fields as $k => $v) {
1644 $sortArray[$k] = CRM_Utils_Array
::value('title', $v);
1647 $fields = array_merge($sortArray, $fields);
1648 //unset the field which are not related to their contact type.
1649 if ($contactType != 'All') {
1650 $commonValues = array(
1651 'Individual' => array(
1655 'organization_name',
1656 'email_greeting_custom',
1657 'postal_greeting_custom',
1660 'Household' => array(
1670 'organization_name',
1678 'email_greeting_custom',
1679 'postal_greeting_custom',
1684 'Organization' => array(
1695 'email_greeting_custom',
1696 'postal_greeting_custom',
1706 foreach ($commonValues[$contactType] as $value) {
1707 unset($fields[$value]);
1711 CRM_Core_BAO_Cache
::setItem($fields, 'contact fields', $cacheKeyString);
1713 self
::$_exportableFields[$cacheKeyString] = $fields;
1717 $fields = self
::$_exportableFields[$cacheKeyString];
1720 $fields = array_merge(array('' => array('title' => ts('- Contact Fields -'))),
1721 self
::$_exportableFields[$cacheKeyString]
1729 * Get the all contact details (Hierarchical).
1731 * @param int $contactId
1733 * @param array $fields
1739 public static function getHierContactDetails($contactId, &$fields) {
1740 $params = array(array('contact_id', '=', $contactId, 0, 0));
1743 $returnProperties = self
::makeHierReturnProperties($fields, $contactId);
1745 // We don't know the contents of return properties, but we need the lower
1746 // level ids of the contact so add a few fields.
1747 $returnProperties['first_name'] = 1;
1748 $returnProperties['organization_name'] = 1;
1749 $returnProperties['household_name'] = 1;
1750 $returnProperties['contact_type'] = 1;
1751 $returnProperties['contact_sub_type'] = 1;
1752 return list($query, $options) = CRM_Contact_BAO_Query
::apiQuery($params, $returnProperties, $options);
1756 * Given a set of flat profile style field names, create a hierarchy.
1758 * This is for the query to use, create the right sql.
1761 * @param int $contactId
1765 * A hierarchical property tree if appropriate
1767 public static function &makeHierReturnProperties($fields, $contactId = NULL) {
1768 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
1770 $returnProperties = array();
1772 $multipleFields = array('website' => 'url');
1773 foreach ($fields as $name => $dontCare) {
1774 if (strpos($name, '-') !== FALSE) {
1775 list($fieldName, $id, $type) = CRM_Utils_System
::explode('-', $name, 3);
1777 if (!in_array($fieldName, $multipleFields)) {
1778 if ($id == 'Primary') {
1779 $locationTypeName = 1;
1782 $locationTypeName = CRM_Utils_Array
::value($id, $locationTypes);
1783 if (!$locationTypeName) {
1788 if (empty($returnProperties['location'])) {
1789 $returnProperties['location'] = array();
1791 if (empty($returnProperties['location'][$locationTypeName])) {
1792 $returnProperties['location'][$locationTypeName] = array();
1793 $returnProperties['location'][$locationTypeName]['location_type'] = $id;
1795 if (in_array($fieldName, array(
1803 $returnProperties['location'][$locationTypeName][$fieldName . '-' . $type] = 1;
1806 $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1809 elseif (substr($fieldName, 0, 14) === 'address_custom') {
1810 $returnProperties['location'][$locationTypeName][substr($fieldName, 8)] = 1;
1813 $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1817 $returnProperties['website'][$id][$fieldName] = 1;
1821 $returnProperties[$name] = 1;
1825 return $returnProperties;
1829 * Return the primary location type of a contact.
1831 * $params int $contactId contact_id
1832 * $params boolean $isPrimaryExist if true, return primary contact location type otherwise null
1833 * $params boolean $skipDefaultPriamry if true, return primary contact location type otherwise null
1835 * @param int $contactId
1836 * @param bool $skipDefaultPriamry
1837 * @param null $block
1840 * $locationType location_type_id
1842 public static function getPrimaryLocationType($contactId, $skipDefaultPriamry = FALSE, $block = NULL) {
1844 $entityBlock = array('contact_id' => $contactId);
1845 $blocks = CRM_Core_BAO_Location
::getValues($entityBlock);
1846 foreach ($blocks[$block] as $key => $value) {
1847 if (!empty($value['is_primary'])) {
1848 $locationType = CRM_Utils_Array
::value('location_type_id', $value);
1855 IF ( civicrm_email.location_type_id IS NULL,
1856 IF ( civicrm_address.location_type_id IS NULL,
1857 IF ( civicrm_phone.location_type_id IS NULL,
1858 IF ( civicrm_im.location_type_id IS NULL,
1859 IF ( civicrm_openid.location_type_id IS NULL, null, civicrm_openid.location_type_id)
1860 ,civicrm_im.location_type_id)
1861 ,civicrm_phone.location_type_id)
1862 ,civicrm_address.location_type_id)
1863 ,civicrm_email.location_type_id) as locationType
1864 FROM civicrm_contact
1865 LEFT JOIN civicrm_email ON ( civicrm_email.is_primary = 1 AND civicrm_email.contact_id = civicrm_contact.id )
1866 LEFT JOIN civicrm_address ON ( civicrm_address.is_primary = 1 AND civicrm_address.contact_id = civicrm_contact.id)
1867 LEFT JOIN civicrm_phone ON ( civicrm_phone.is_primary = 1 AND civicrm_phone.contact_id = civicrm_contact.id)
1868 LEFT JOIN civicrm_im ON ( civicrm_im.is_primary = 1 AND civicrm_im.contact_id = civicrm_contact.id)
1869 LEFT JOIN civicrm_openid ON ( civicrm_openid.is_primary = 1 AND civicrm_openid.contact_id = civicrm_contact.id)
1870 WHERE civicrm_contact.id = %1 ";
1872 $params = array(1 => array($contactId, 'Integer'));
1874 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1876 $locationType = NULL;
1877 if ($dao->fetch()) {
1878 $locationType = $dao->locationType
;
1881 if (isset($locationType)) {
1882 return $locationType;
1884 elseif ($skipDefaultPriamry) {
1885 // if there is no primary contact location then return null
1889 // if there is no primart contact location, then return default
1890 // location type of the system
1891 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
1892 return $defaultLocationType->id
;
1897 * Get the display name, primary email and location type of a contact.
1900 * Id of the contact.
1903 * Array of display_name, email if found, do_not_email or (null,null,null)
1905 public static function getContactDetails($id) {
1906 // check if the contact type
1907 $contactType = self
::getContactType($id);
1909 $nameFields = ($contactType == 'Individual') ?
"civicrm_contact.first_name, civicrm_contact.last_name, civicrm_contact.display_name" : "civicrm_contact.display_name";
1912 SELECT $nameFields, civicrm_email.email, civicrm_contact.do_not_email, civicrm_email.on_hold, civicrm_contact.is_deceased
1913 FROM civicrm_contact LEFT JOIN civicrm_email ON (civicrm_contact.id = civicrm_email.contact_id)
1914 WHERE civicrm_contact.id = %1
1915 ORDER BY civicrm_email.is_primary DESC";
1916 $params = array(1 => array($id, 'Integer'));
1917 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
1919 if ($dao->fetch()) {
1920 if ($contactType == 'Individual') {
1921 if ($dao->first_name ||
$dao->last_name
) {
1922 $name = "{$dao->first_name} {$dao->last_name}";
1925 $name = $dao->display_name
;
1929 $name = $dao->display_name
;
1931 $email = $dao->email
;
1932 $doNotEmail = $dao->do_not_email ?
TRUE : FALSE;
1933 $onHold = $dao->on_hold ?
TRUE : FALSE;
1934 $isDeceased = $dao->is_deceased ?
TRUE : FALSE;
1935 return array($name, $email, $doNotEmail, $onHold, $isDeceased);
1937 return array(NULL, NULL, NULL, NULL, NULL);
1941 * Add/edit/register contacts through profile.
1943 * @param array $params
1944 * Array of profile fields to be edited/added.
1945 * @param array $fields
1946 * Array of fields from UFGroup.
1947 * @param int $contactID
1948 * Id of the contact to be edited/added.
1949 * @param int $addToGroupID
1950 * Specifies the default group to which contact is added.
1951 * @param int $ufGroupId
1952 * Uf group id (profile id).
1953 * @param string $ctype
1954 * @param bool $visibility
1955 * Basically lets us know where this request is coming from.
1956 * if via a profile from web, we restrict what groups are changed
1959 * contact id created/edited
1961 public static function createProfileContact(
1965 $addToGroupID = NULL,
1970 // add ufGroupID to params array ( CRM-2012 )
1972 $params['uf_group_id'] = $ufGroupId;
1974 self
::addBillingNameFieldsIfOtherwiseNotSet($params);
1976 // If a user has logged in, or accessed via a checksum
1977 // Then deliberately 'blanking' a value in the profile should remove it from their record
1978 $session = CRM_Core_Session
::singleton();
1979 $params['updateBlankLocInfo'] = TRUE;
1980 if (($session->get('authSrc') & (CRM_Core_Permission
::AUTH_SRC_CHECKSUM + CRM_Core_Permission
::AUTH_SRC_LOGIN
)) == 0) {
1981 $params['updateBlankLocInfo'] = FALSE;
1986 CRM_Utils_Hook
::pre('edit', 'Profile', $contactID, $params);
1990 CRM_Utils_Hook
::pre('create', 'Profile', NULL, $params);
1993 list($data, $contactDetails) = self
::formatProfileContactParams($params, $fields, $contactID, $ufGroupId, $ctype);
1995 // manage is_opt_out
1996 if (array_key_exists('is_opt_out', $fields) && array_key_exists('is_opt_out', $params)) {
1997 $wasOptOut = CRM_Utils_Array
::value('is_opt_out', $contactDetails, FALSE);
1998 $isOptOut = CRM_Utils_Array
::value('is_opt_out', $params, FALSE);
1999 $data['is_opt_out'] = $isOptOut;
2000 // on change, create new civicrm_subscription_history entry
2001 if (($wasOptOut != $isOptOut) && !empty($contactDetails['contact_id'])) {
2003 'contact_id' => $contactDetails['contact_id'],
2004 'status' => $isOptOut ?
'Removed' : 'Added',
2007 CRM_Contact_BAO_SubscriptionHistory
::create($shParams);
2011 $contact = self
::create($data);
2013 // contact is null if the profile does not have any contact fields
2015 $contactID = $contact->id
;
2018 if (empty($contactID)) {
2019 CRM_Core_Error
::fatal('Cannot proceed without a valid contact id');
2022 // Process group and tag
2023 if (!empty($fields['group'])) {
2025 // this for sure means we are coming in via profile since i added it to fix
2026 // removing contacts from user groups -- lobo
2030 CRM_Contact_BAO_GroupContact
::create($params['group'], $contactID, $visibility, $method);
2033 if (!empty($fields['tag']) && array_key_exists('tag', $params)) {
2034 // Convert comma separated form values from select2 v3
2035 $tags = is_array($params['tag']) ?
$params['tag'] : array_fill_keys(array_filter(explode(',', $params['tag'])), 1);
2036 CRM_Core_BAO_EntityTag
::create($tags, 'civicrm_contact', $contactID);
2039 //to add profile in default group
2040 if (is_array($addToGroupID)) {
2041 $contactIds = array($contactID);
2042 foreach ($addToGroupID as $groupId) {
2043 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $groupId);
2046 elseif ($addToGroupID) {
2047 $contactIds = array($contactID);
2048 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $addToGroupID);
2051 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
2054 CRM_Utils_Hook
::post('edit', 'Profile', $contactID, $params);
2057 CRM_Utils_Hook
::post('create', 'Profile', $contactID, $params);
2063 * Format profile contact parameters.
2065 * @param array $params
2067 * @param int $contactID
2068 * @param int $ufGroupId
2069 * @param null $ctype
2070 * @param bool $skipCustom
2074 public static function formatProfileContactParams(
2083 $data = $contactDetails = array();
2085 // get the contact details (hier)
2087 list($details, $options) = self
::getHierContactDetails($contactID, $fields);
2089 $contactDetails = $details[$contactID];
2090 $data['contact_type'] = CRM_Utils_Array
::value('contact_type', $contactDetails);
2091 $data['contact_sub_type'] = CRM_Utils_Array
::value('contact_sub_type', $contactDetails);
2094 //we should get contact type only if contact
2096 $data['contact_type'] = CRM_Core_BAO_UFField
::getProfileType($ufGroupId);
2098 //special case to handle profile with only contact fields
2099 if ($data['contact_type'] == 'Contact') {
2100 $data['contact_type'] = 'Individual';
2102 elseif (CRM_Contact_BAO_ContactType
::isaSubType($data['contact_type'])) {
2103 $data['contact_type'] = CRM_Contact_BAO_ContactType
::getBasicType($data['contact_type']);
2107 $data['contact_type'] = $ctype;
2110 $data['contact_type'] = 'Individual';
2114 //fix contact sub type CRM-5125
2115 if (array_key_exists('contact_sub_type', $params) &&
2116 !empty($params['contact_sub_type'])
2118 $data['contact_sub_type'] = CRM_Utils_Array
::implodePadded($params['contact_sub_type']);
2120 elseif (array_key_exists('contact_sub_type_hidden', $params) &&
2121 !empty($params['contact_sub_type_hidden'])
2123 // if profile was used, and had any subtype, we obtain it from there
2124 //CRM-13596 - add to existing contact types, rather than overwriting
2125 if (empty($data['contact_sub_type'])) {
2126 // If we don't have a contact ID the $data['contact_sub_type'] will not be defined...
2127 $data['contact_sub_type'] = CRM_Utils_Array
::implodePadded($params['contact_sub_type_hidden']);
2130 $data_contact_sub_type_arr = CRM_Utils_Array
::explodePadded($data['contact_sub_type']);
2131 if (!in_array($params['contact_sub_type_hidden'], $data_contact_sub_type_arr)) {
2132 //CRM-20517 - make sure contact_sub_type gets the correct delimiters
2133 $data['contact_sub_type'] = trim($data['contact_sub_type'], CRM_Core_DAO
::VALUE_SEPARATOR
);
2134 $data['contact_sub_type'] = CRM_Core_DAO
::VALUE_SEPARATOR
. $data['contact_sub_type'] . CRM_Utils_Array
::implodePadded($params['contact_sub_type_hidden']);
2139 if ($ctype == 'Organization') {
2140 $data['organization_name'] = CRM_Utils_Array
::value('organization_name', $contactDetails);
2142 elseif ($ctype == 'Household') {
2143 $data['household_name'] = CRM_Utils_Array
::value('household_name', $contactDetails);
2146 $locationType = array();
2151 $data['contact_id'] = $contactID;
2152 $primaryLocationType = self
::getPrimaryLocationType($contactID);
2155 $defaultLocation = CRM_Core_BAO_LocationType
::getDefault();
2156 $defaultLocationId = $defaultLocation->id
;
2159 $billingLocationTypeId = CRM_Core_BAO_LocationType
::getBilling();
2161 $blocks = array('email', 'phone', 'im', 'openid');
2163 $multiplFields = array('url');
2164 // prevent overwritten of formatted array, reset all block from
2165 // params if it is not in valid format (since import pass valid format)
2166 foreach ($blocks as $blk) {
2167 if (array_key_exists($blk, $params) &&
2168 !is_array($params[$blk])
2170 unset($params[$blk]);
2174 $primaryPhoneLoc = NULL;
2175 $session = CRM_Core_Session
::singleton();
2176 foreach ($params as $key => $value) {
2177 list($fieldName, $locTypeId, $typeId) = CRM_Utils_System
::explode('-', $key, 3);
2179 if ($locTypeId == 'Primary') {
2181 if (in_array($fieldName, $blocks)) {
2182 $locTypeId = self
::getPrimaryLocationType($contactID, FALSE, $fieldName);
2185 $locTypeId = self
::getPrimaryLocationType($contactID, FALSE, 'address');
2187 $primaryLocationType = $locTypeId;
2190 $locTypeId = $defaultLocationId;
2194 if (is_numeric($locTypeId) &&
2195 !in_array($fieldName, $multiplFields) &&
2196 substr($fieldName, 0, 7) != 'custom_'
2198 $index = $locTypeId;
2200 if (is_numeric($typeId)) {
2201 $index .= '-' . $typeId;
2203 if (!in_array($index, $locationType)) {
2204 $locationType[$count] = $index;
2208 $loc = CRM_Utils_Array
::key($index, $locationType);
2210 $blockName = self
::getLocationEntityForKey($fieldName);
2212 $data[$blockName][$loc]['location_type_id'] = $locTypeId;
2214 //set is_billing true, for location type "Billing"
2215 if ($locTypeId == $billingLocationTypeId) {
2216 $data[$blockName][$loc]['is_billing'] = 1;
2220 //get the primary location type
2221 if ($locTypeId == $primaryLocationType) {
2222 $data[$blockName][$loc]['is_primary'] = 1;
2225 elseif ($locTypeId == $defaultLocationId) {
2226 $data[$blockName][$loc]['is_primary'] = 1;
2229 if (in_array($fieldName, array('phone'))) {
2231 $data['phone'][$loc]['phone_type_id'] = $typeId;
2234 $data['phone'][$loc]['phone_type_id'] = '';
2236 $data['phone'][$loc]['phone'] = $value;
2238 //special case to handle primary phone with different phone types
2239 // in this case we make first phone type as primary
2240 if (isset($data['phone'][$loc]['is_primary']) && !$primaryPhoneLoc) {
2241 $primaryPhoneLoc = $loc;
2244 if ($loc != $primaryPhoneLoc) {
2245 unset($data['phone'][$loc]['is_primary']);
2248 elseif ($fieldName == 'email') {
2249 $data['email'][$loc]['email'] = $value;
2250 if (empty($contactID)) {
2251 $data['email'][$loc]['is_primary'] = 1;
2254 elseif ($fieldName == 'im') {
2255 if (isset($params[$key . '-provider_id'])) {
2256 $data['im'][$loc]['provider_id'] = $params[$key . '-provider_id'];
2258 if (strpos($key, '-provider_id') !== FALSE) {
2259 $data['im'][$loc]['provider_id'] = $params[$key];
2262 $data['im'][$loc]['name'] = $value;
2265 elseif ($fieldName == 'openid') {
2266 $data['openid'][$loc]['openid'] = $value;
2269 if ($fieldName === 'state_province') {
2271 if (is_numeric($value) && ((int ) $value) >= 1000) {
2272 $data['address'][$loc]['state_province_id'] = $value;
2274 elseif (empty($value)) {
2275 $data['address'][$loc]['state_province_id'] = '';
2278 $data['address'][$loc]['state_province'] = $value;
2281 elseif ($fieldName === 'country') {
2283 if (is_numeric($value) && ((int ) $value) >= 1000
2285 $data['address'][$loc]['country_id'] = $value;
2287 elseif (empty($value)) {
2288 $data['address'][$loc]['country_id'] = '';
2291 $data['address'][$loc]['country'] = $value;
2294 elseif ($fieldName === 'county') {
2295 $data['address'][$loc]['county_id'] = $value;
2297 elseif ($fieldName == 'address_name') {
2298 $data['address'][$loc]['name'] = $value;
2300 elseif (substr($fieldName, 0, 14) === 'address_custom') {
2301 $data['address'][$loc][substr($fieldName, 8)] = $value;
2304 $data[$blockName][$loc][$fieldName] = $value;
2309 if (substr($key, 0, 4) === 'url-') {
2310 $websiteField = explode('-', $key);
2311 $data['website'][$websiteField[1]]['website_type_id'] = $websiteField[1];
2312 $data['website'][$websiteField[1]]['url'] = $value;
2314 elseif (in_array($key, self
::$_greetingTypes, TRUE)) {
2315 //save email/postal greeting and addressee values if any, CRM-4575
2316 $data[$key . '_id'] = $value;
2318 elseif (!$skipCustom && ($customFieldId = CRM_Core_BAO_CustomField
::getKeyID($key))) {
2319 // for autocomplete transfer hidden value instead of label
2320 if ($params[$key] && isset($params[$key . '_id'])) {
2321 $value = $params[$key . '_id'];
2324 // we need to append time with date
2325 if ($params[$key] && isset($params[$key . '_time'])) {
2326 $value .= ' ' . $params[$key . '_time'];
2329 // if auth source is not checksum / login && $value is blank, do not proceed - CRM-10128
2330 if (($session->get('authSrc') & (CRM_Core_Permission
::AUTH_SRC_CHECKSUM + CRM_Core_Permission
::AUTH_SRC_LOGIN
)) == 0 &&
2331 ($value == '' ||
!isset($value))
2337 if (!empty($params['customRecordValues'])) {
2338 if (is_array($params['customRecordValues']) && !empty($params['customRecordValues'])) {
2339 foreach ($params['customRecordValues'] as $recId => $customFields) {
2340 if (is_array($customFields) && !empty($customFields)) {
2341 foreach ($customFields as $customFieldName) {
2342 if ($customFieldName == $key) {
2352 //CRM-13596 - check for contact_sub_type_hidden first
2353 if (array_key_exists('contact_sub_type_hidden', $params)) {
2354 $type = $params['contact_sub_type_hidden'];
2357 $type = $data['contact_type'];
2358 if (!empty($data['contact_sub_type'])) {
2359 $type = CRM_Utils_Array
::explodePadded($data['contact_sub_type']);
2363 CRM_Core_BAO_CustomField
::formatCustomField($customFieldId,
2373 elseif ($key == 'edit') {
2377 if ($key == 'location') {
2378 foreach ($value as $locationTypeId => $field) {
2379 foreach ($field as $block => $val) {
2380 if ($block == 'address' && array_key_exists('address_name', $val)) {
2381 $value[$locationTypeId][$block]['name'] = $value[$locationTypeId][$block]['address_name'];
2386 if ($key == 'phone' && isset($params['phone_ext'])) {
2387 $data[$key] = $value;
2388 foreach ($value as $cnt => $phoneBlock) {
2389 if ($params[$key][$cnt]['location_type_id'] == $params['phone_ext'][$cnt]['location_type_id']) {
2390 $data[$key][$cnt]['phone_ext'] = CRM_Utils_Array
::retrieveValueRecursive($params['phone_ext'][$cnt], 'phone_ext');
2394 elseif (in_array($key, array(
2403 )) && ($value == '' ||
!isset($value)) &&
2404 ($session->get('authSrc') & (CRM_Core_Permission
::AUTH_SRC_CHECKSUM + CRM_Core_Permission
::AUTH_SRC_LOGIN
)) == 0 ||
2405 ($key == 'current_employer' && empty($params['current_employer']))) {
2406 // CRM-10128: if auth source is not checksum / login && $value is blank, do not fill $data with empty value
2407 // to avoid update with empty values
2411 $data[$key] = $value;
2417 if (!isset($data['contact_type'])) {
2418 $data['contact_type'] = 'Individual';
2421 //set the values for checkboxes (do_not_email, do_not_mail, do_not_trade, do_not_phone)
2422 $privacy = CRM_Core_SelectValues
::privacy();
2423 foreach ($privacy as $key => $value) {
2424 if (array_key_exists($key, $fields)) {
2425 // do not reset values for existing contacts, if fields are added to a profile
2426 if (array_key_exists($key, $params)) {
2427 $data[$key] = $params[$key];
2428 if (empty($params[$key])) {
2432 elseif (!$contactID) {
2438 return array($data, $contactDetails);
2442 * Find the get contact details.
2444 * This function does not respect ACLs for now, which might need to be rectified at some
2445 * stage based on how its used.
2447 * @param string $mail
2448 * Primary email address of the contact.
2449 * @param string $ctype
2452 * @return object|null
2453 * $dao contact details
2455 public static function matchContactOnEmail($mail, $ctype = NULL) {
2456 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2457 $mail = $strtolower(trim($mail));
2459 SELECT civicrm_contact.id as contact_id,
2460 civicrm_contact.hash as hash,
2461 civicrm_contact.contact_type as contact_type,
2462 civicrm_contact.contact_sub_type as contact_sub_type
2463 FROM civicrm_contact
2464 INNER JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id )";
2466 if (Civi
::settings()->get('uniq_email_per_site')) {
2467 // try to find a match within a site (multisite).
2468 $groups = CRM_Core_BAO_Domain
::getChildGroupIds();
2469 if (!empty($groups)) {
2471 INNER JOIN civicrm_group_contact gc ON
2472 (civicrm_contact.id = gc.contact_id AND gc.status = 'Added' AND gc.group_id IN (" . implode(',', $groups) . "))";
2477 WHERE civicrm_email.email = %1 AND civicrm_contact.is_deleted=0";
2478 $p = array(1 => array($mail, 'String'));
2481 $query .= " AND civicrm_contact.contact_type = %3";
2482 $p[3] = array($ctype, 'String');
2485 $query .= " ORDER BY civicrm_email.is_primary DESC";
2487 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2489 if ($dao->fetch()) {
2496 * Find the contact details associated with an OpenID.
2498 * @param string $openId
2499 * OpenId of the contact.
2500 * @param string $ctype
2503 * @return object|null
2504 * $dao contact details
2506 public static function matchContactOnOpenId($openId, $ctype = NULL) {
2507 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2508 $openId = $strtolower(trim($openId));
2510 SELECT civicrm_contact.id as contact_id,
2511 civicrm_contact.hash as hash,
2512 civicrm_contact.contact_type as contact_type,
2513 civicrm_contact.contact_sub_type as contact_sub_type
2514 FROM civicrm_contact
2515 INNER JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id )
2516 WHERE civicrm_openid.openid = %1";
2517 $p = array(1 => array($openId, 'String'));
2520 $query .= " AND civicrm_contact.contact_type = %3";
2521 $p[3] = array($ctype, 'String');
2524 $query .= " ORDER BY civicrm_openid.is_primary DESC";
2526 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2528 if ($dao->fetch()) {
2535 * Get primary email of the contact.
2537 * @param int $contactID
2541 * Email address if present else null
2543 public static function getPrimaryEmail($contactID) {
2544 // fetch the primary email
2546 SELECT civicrm_email.email as email
2547 FROM civicrm_contact
2548 LEFT JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id )
2549 WHERE civicrm_email.is_primary = 1
2550 AND civicrm_contact.id = %1";
2551 $p = array(1 => array($contactID, 'Integer'));
2552 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2555 if ($dao->fetch()) {
2556 $email = $dao->email
;
2562 * Function to get primary OpenID of the contact.
2564 * @param int $contactID
2568 * >openid OpenID if present else null
2570 public static function getPrimaryOpenId($contactID) {
2571 // fetch the primary OpenID
2573 SELECT civicrm_openid.openid as openid
2574 FROM civicrm_contact
2575 LEFT JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id )
2576 WHERE civicrm_contact.id = %1
2577 AND civicrm_openid.is_primary = 1";
2578 $p = array(1 => array($contactID, 'Integer'));
2579 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2582 if ($dao->fetch()) {
2583 $openId = $dao->openid
;
2589 * Fetch the object and store the values in the values array.
2591 * @param array $params
2592 * Input parameters to find object.
2593 * @param array $values
2594 * Output values of the object.
2596 * @return CRM_Contact_BAO_Contact|null
2597 * The found object or null
2599 public static function getValues(&$params, &$values) {
2600 $contact = new CRM_Contact_BAO_Contact();
2602 $contact->copyValues($params);
2604 if ($contact->find(TRUE)) {
2606 CRM_Core_DAO
::storeValues($contact, $values);
2609 foreach (self
::$_commPrefs as $name) {
2610 if (isset($contact->$name)) {
2611 $privacy[$name] = $contact->$name;
2615 if (!empty($privacy)) {
2616 $values['privacy'] = $privacy;
2619 // communication Prefferance
2620 $preffComm = $comm = array();
2621 $comm = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
2622 $contact->preferred_communication_method
2624 foreach ($comm as $value) {
2625 $preffComm[$value] = 1;
2627 $temp = array('preferred_communication_method' => $contact->preferred_communication_method
);
2630 'preferred_communication_method' => array(
2631 'newName' => 'preferred_communication_method_display',
2632 'groupName' => 'preferred_communication_method',
2636 // @todo This can be figured out from metadata & we can avoid the uncached query.
2637 CRM_Core_OptionGroup
::lookupValues($temp, $names, FALSE);
2639 $values['preferred_communication_method'] = $preffComm;
2640 $values['preferred_communication_method_display'] = CRM_Utils_Array
::value('preferred_communication_method_display', $temp);
2642 if ($contact->preferred_mail_format
) {
2643 $preferredMailingFormat = CRM_Core_SelectValues
::pmf();
2644 $values['preferred_mail_format'] = $preferredMailingFormat[$contact->preferred_mail_format
];
2647 // get preferred languages
2648 if (!empty($contact->preferred_language
)) {
2649 $values['preferred_language'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $contact->preferred_language
);
2652 // Calculating Year difference
2653 if ($contact->birth_date
) {
2654 $birthDate = CRM_Utils_Date
::customFormat($contact->birth_date
, '%Y%m%d');
2655 if ($birthDate < date('Ymd')) {
2656 $age = CRM_Utils_Date
::calculateAge($birthDate);
2657 $values['age']['y'] = CRM_Utils_Array
::value('years', $age);
2658 $values['age']['m'] = CRM_Utils_Array
::value('months', $age);
2662 $contact->contact_id
= $contact->id
;
2670 * Given the component name and returns the count of participation of contact.
2672 * @param string $component
2673 * Input component name.
2674 * @param int $contactId
2676 * @param string $tableName
2677 * Optional tableName if component is custom group.
2680 * total number in database
2682 public static function getCountComponent($component, $contactId, $tableName = NULL) {
2684 switch ($component) {
2686 return CRM_Core_BAO_EntityTag
::getContactTags($contactId, TRUE);
2689 $result = CRM_Contact_BAO_Relationship
::getRelationship($contactId,
2690 CRM_Contact_BAO_Relationship
::CURRENT
,
2699 return CRM_Contact_BAO_GroupContact
::getContactGroup($contactId, "Added", NULL, TRUE);
2702 if (CRM_Core_BAO_Log
::useLoggingReport()) {
2705 return CRM_Core_BAO_Log
::getContactLogCount($contactId);
2708 return CRM_Core_BAO_Note
::getContactNoteCount($contactId);
2710 case 'contribution':
2711 return CRM_Contribute_BAO_Contribution
::contributionCount($contactId);
2714 return CRM_Member_BAO_Membership
::getContactMembershipCount($contactId, TRUE);
2717 return CRM_Event_BAO_Participant
::getContactParticipantCount($contactId);
2720 return CRM_Pledge_BAO_Pledge
::getContactPledgeCount($contactId);
2723 return CRM_Case_BAO_Case
::caseCount($contactId);
2726 return CRM_Grant_BAO_Grant
::getContactGrantCount($contactId);
2730 'contact_id' => $contactId,
2733 'context' => 'activity',
2735 return CRM_Activity_BAO_Activity
::getActivitiesCount($input);
2738 $params = array('contact_id' => $contactId);
2739 return CRM_Mailing_BAO_Mailing
::getContactMailingsCount($params);
2742 $custom = explode('_', $component);
2743 if ($custom['0'] = 'custom') {
2745 $tableName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $custom['1'], 'table_name');
2747 $queryString = "SELECT count(id) FROM {$tableName} WHERE entity_id = {$contactId}";
2748 return CRM_Core_DAO
::singleValueQuery($queryString);
2754 * Update contact greetings if an update has resulted in a custom field change.
2756 * @param array $updatedFields
2757 * Array of fields that have been updated e.g array('first_name', 'prefix_id', 'custom_2');
2758 * @param array $contactParams
2759 * Parameters known about the contact. At minimum array('contact_id' => x).
2760 * Fields in this array will take precedence over DB fields (so far only
2761 * in the case of greeting id fields).
2763 public static function updateGreetingsOnTokenFieldChange($updatedFields, $contactParams) {
2764 $contactID = $contactParams['contact_id'];
2765 CRM_Contact_BAO_Contact
::ensureGreetingParamsAreSet($contactParams);
2766 $tokens = CRM_Contact_BAO_Contact_Utils
::getTokensRequiredForContactGreetings($contactParams);
2767 if (!empty($tokens['all']['contact'])) {
2768 $affectedTokens = array_intersect_key($updatedFields[$contactID], array_flip($tokens['all']['contact']));
2769 if (!empty($affectedTokens)) {
2770 // @todo this is still reloading the whole contact -fix to be more selective & use pre-loaded.
2771 $contact = new CRM_Contact_BAO_Contact();
2772 $contact->id
= $contactID;
2773 CRM_Contact_BAO_Contact
::processGreetings($contact);
2779 * Process greetings and cache.
2781 * @param object $contact
2782 * Contact object after save.
2784 public static function processGreetings(&$contact) {
2786 //@todo this function does a lot of unnecessary loading.
2787 // ensureGreetingParamsAreSet now makes sure that the contact is
2788 // loaded and using updateGreetingsOnTokenFieldChange
2789 // allows us the possibility of only doing an update if required.
2791 // The contact object has not always required the
2792 // fields that are required to calculate greetings
2793 // so we need to retrieve it again.
2794 if ($contact->_query
!== FALSE) {
2795 $contact->find(TRUE);
2798 // store object values to an array
2799 $contactDetails = array();
2800 CRM_Core_DAO
::storeValues($contact, $contactDetails);
2801 $contactDetails = array(array($contact->id
=> $contactDetails));
2803 $emailGreetingString = $postalGreetingString = $addresseeString = NULL;
2804 $updateQueryString = array();
2806 //cache email and postal greeting to greeting display
2807 if ($contact->email_greeting_custom
!= 'null' && $contact->email_greeting_custom
) {
2808 $emailGreetingString = $contact->email_greeting_custom
;
2810 elseif ($contact->email_greeting_id
!= 'null' && $contact->email_greeting_id
) {
2811 // the filter value for Individual contact type is set to 1
2813 'contact_type' => $contact->contact_type
,
2814 'greeting_type' => 'email_greeting',
2817 $emailGreeting = CRM_Core_PseudoConstant
::greeting($filter);
2818 $emailGreetingString = $emailGreeting[$contact->email_greeting_id
];
2819 $updateQueryString[] = " email_greeting_custom = NULL ";
2822 if ($contact->email_greeting_custom
) {
2823 $updateQueryString[] = " email_greeting_display = NULL ";
2827 if ($emailGreetingString) {
2828 CRM_Contact_BAO_Contact_Utils
::processGreetingTemplate($emailGreetingString,
2831 'CRM_Contact_BAO_Contact'
2833 $emailGreetingString = CRM_Core_DAO
::escapeString(CRM_Utils_String
::stripSpaces($emailGreetingString));
2834 $updateQueryString[] = " email_greeting_display = '{$emailGreetingString}'";
2838 if ($contact->postal_greeting_custom
!= 'null' && $contact->postal_greeting_custom
) {
2839 $postalGreetingString = $contact->postal_greeting_custom
;
2841 elseif ($contact->postal_greeting_id
!= 'null' && $contact->postal_greeting_id
) {
2843 'contact_type' => $contact->contact_type
,
2844 'greeting_type' => 'postal_greeting',
2846 $postalGreeting = CRM_Core_PseudoConstant
::greeting($filter);
2847 $postalGreetingString = $postalGreeting[$contact->postal_greeting_id
];
2848 $updateQueryString[] = " postal_greeting_custom = NULL ";
2851 if ($contact->postal_greeting_custom
) {
2852 $updateQueryString[] = " postal_greeting_display = NULL ";
2856 if ($postalGreetingString) {
2857 CRM_Contact_BAO_Contact_Utils
::processGreetingTemplate($postalGreetingString,
2860 'CRM_Contact_BAO_Contact'
2862 $postalGreetingString = CRM_Core_DAO
::escapeString(CRM_Utils_String
::stripSpaces($postalGreetingString));
2863 $updateQueryString[] = " postal_greeting_display = '{$postalGreetingString}'";
2867 if ($contact->addressee_custom
!= 'null' && $contact->addressee_custom
) {
2868 $addresseeString = $contact->addressee_custom
;
2870 elseif ($contact->addressee_id
!= 'null' && $contact->addressee_id
) {
2872 'contact_type' => $contact->contact_type
,
2873 'greeting_type' => 'addressee',
2876 $addressee = CRM_Core_PseudoConstant
::greeting($filter);
2877 $addresseeString = $addressee[$contact->addressee_id
];
2878 $updateQueryString[] = " addressee_custom = NULL ";
2881 if ($contact->addressee_custom
) {
2882 $updateQueryString[] = " addressee_display = NULL ";
2886 if ($addresseeString) {
2887 CRM_Contact_BAO_Contact_Utils
::processGreetingTemplate($addresseeString,
2890 'CRM_Contact_BAO_Contact'
2892 $addresseeString = CRM_Core_DAO
::escapeString(CRM_Utils_String
::stripSpaces($addresseeString));
2893 $updateQueryString[] = " addressee_display = '{$addresseeString}'";
2896 if (!empty($updateQueryString)) {
2897 $updateQueryString = implode(',', $updateQueryString);
2898 $queryString = "UPDATE civicrm_contact SET {$updateQueryString} WHERE id = {$contact->id}";
2899 CRM_Core_DAO
::executeQuery($queryString);
2904 * Retrieve loc block ids w/ given condition.
2906 * @param int $contactId
2908 * @param array $criteria
2909 * Key => value pair which should be.
2910 * fulfill by return record ids.
2911 * @param string $condOperator
2912 * Operator use for grouping multiple conditions.
2915 * loc block ids which fulfill condition.
2917 public static function getLocBlockIds($contactId, $criteria = array(), $condOperator = 'AND') {
2918 $locBlockIds = array();
2920 return $locBlockIds;
2923 foreach (array('Email', 'OpenID', 'Phone', 'Address', 'IM') as $block) {
2924 $name = strtolower($block);
2925 $className = "CRM_Core_DAO_$block";
2926 $blockDAO = new $className();
2928 // build the condition.
2929 if (is_array($criteria)) {
2930 $fields = $blockDAO->fields();
2931 $conditions = array();
2932 foreach ($criteria as $field => $value) {
2933 if (array_key_exists($field, $fields)) {
2934 $cond = "( $field = $value )";
2935 // value might be zero or null.
2936 if (!$value ||
strtolower($value) == 'null') {
2937 $cond = "( $field = 0 OR $field IS NULL )";
2939 $conditions[] = $cond;
2942 if (!empty($conditions)) {
2943 $blockDAO->whereAdd(implode(" $condOperator ", $conditions));
2947 $blockDAO->contact_id
= $contactId;
2949 while ($blockDAO->fetch()) {
2950 $locBlockIds[$name][] = $blockDAO->id
;
2954 return $locBlockIds;
2958 * Build context menu items.
2960 * @param int $contactId
2963 * Array of context menu for logged in user.
2965 public static function contextMenu($contactId = NULL) {
2968 'title' => ts('View Contact'),
2970 'ref' => 'view-contact',
2971 'class' => 'no-popup',
2973 'permissions' => array('view all contacts'),
2976 'title' => ts('Edit Contact'),
2978 'ref' => 'edit-contact',
2979 'class' => 'no-popup',
2981 'permissions' => array('edit all contacts'),
2984 'title' => ts('Delete Contact'),
2986 'ref' => 'delete-contact',
2988 'permissions' => array('access deleted contacts', 'delete contacts'),
2990 'contribution' => array(
2991 'title' => ts('Add Contribution'),
2993 'ref' => 'new-contribution',
2994 'key' => 'contribution',
2995 'tab' => 'contribute',
2996 'component' => 'CiviContribute',
2997 'href' => CRM_Utils_System
::url('civicrm/contact/view/contribution',
2998 'reset=1&action=add&context=contribution'
3000 'permissions' => array(
3001 'access CiviContribute',
3002 'edit contributions',
3005 'participant' => array(
3006 'title' => ts('Register for Event'),
3008 'ref' => 'new-participant',
3009 'key' => 'participant',
3010 'tab' => 'participant',
3011 'component' => 'CiviEvent',
3012 'href' => CRM_Utils_System
::url('civicrm/contact/view/participant', 'reset=1&action=add&context=participant'),
3013 'permissions' => array(
3015 'edit event participants',
3018 'activity' => array(
3019 'title' => ts('Record Activity'),
3021 'ref' => 'new-activity',
3022 'key' => 'activity',
3023 'permissions' => array('edit all contacts'),
3026 'title' => ts('Add Pledge'),
3028 'ref' => 'new-pledge',
3031 'href' => CRM_Utils_System
::url('civicrm/contact/view/pledge',
3032 'reset=1&action=add&context=pledge'
3034 'component' => 'CiviPledge',
3035 'permissions' => array(
3036 'access CiviPledge',
3040 'membership' => array(
3041 'title' => ts('Add Membership'),
3043 'ref' => 'new-membership',
3044 'key' => 'membership',
3046 'component' => 'CiviMember',
3047 'href' => CRM_Utils_System
::url('civicrm/contact/view/membership',
3048 'reset=1&action=add&context=membership'
3050 'permissions' => array(
3051 'access CiviMember',
3056 'title' => ts('Add Case'),
3058 'ref' => 'new-case',
3061 'component' => 'CiviCase',
3062 'href' => CRM_Utils_System
::url('civicrm/case/add', 'reset=1&action=add&context=case'),
3063 'permissions' => array('add cases'),
3066 'title' => ts('Add Grant'),
3068 'ref' => 'new-grant',
3071 'component' => 'CiviGrant',
3072 'href' => CRM_Utils_System
::url('civicrm/contact/view/grant',
3073 'reset=1&action=add&context=grant'
3075 'permissions' => array('edit grants'),
3078 'title' => ts('Add Relationship'),
3080 'ref' => 'new-relationship',
3083 'href' => CRM_Utils_System
::url('civicrm/contact/view/rel',
3084 'reset=1&action=add'
3086 'permissions' => array('edit all contacts'),
3089 'title' => ts('Add Note'),
3091 'ref' => 'new-note',
3094 'class' => 'medium-popup',
3095 'href' => CRM_Utils_System
::url('civicrm/contact/view/note',
3096 'reset=1&action=add'
3098 'permissions' => array('edit all contacts'),
3101 'title' => ts('Send an Email'),
3103 'ref' => 'new-email',
3105 'permissions' => array('view all contacts'),
3108 'title' => ts('Add to Group'),
3110 'ref' => 'group-add-contact',
3113 'permissions' => array('edit groups'),
3116 'title' => ts('Tag Contact'),
3118 'ref' => 'tag-contact',
3121 'permissions' => array('edit all contacts'),
3125 $menu['otherActions'] = array(
3127 'title' => ts('Print Summary'),
3128 'description' => ts('Printer-friendly view of this page.'),
3130 'ref' => 'crm-contact-print',
3133 'href' => CRM_Utils_System
::url('civicrm/contact/view/print',
3137 'icon' => 'crm-i fa-print',
3140 'title' => ts('vCard'),
3141 'description' => ts('vCard record for this contact.'),
3143 'ref' => 'crm-contact-vcard',
3146 'href' => CRM_Utils_System
::url('civicrm/contact/view/vcard',
3150 'icon' => 'crm-i fa-list-alt',
3154 if (CRM_Core_Permission
::check('access Contact Dashboard')) {
3155 $menu['otherActions']['dashboard'] = array(
3156 'title' => ts('Contact Dashboard'),
3157 'description' => ts('Contact Dashboard'),
3159 'ref' => 'crm-contact-dashboard',
3160 'key' => 'dashboard',
3161 'tab' => 'dashboard',
3162 'class' => 'dashboard',
3163 // NOTE: As an alternative you can also build url on CMS specific way
3164 // as CRM_Core_Config::singleton()->userSystem->getUserRecordUrl($contactId)
3165 'href' => CRM_Utils_System
::url('civicrm/user', "reset=1&id={$contactId}"),
3166 'icon' => 'crm-i fa-tachometer',
3170 $uid = CRM_Core_BAO_UFMatch
::getUFId($contactId);
3172 $menu['otherActions']['user-record'] = array(
3173 'title' => ts('User Record'),
3174 'description' => ts('User Record'),
3176 'ref' => 'crm-contact-user-record',
3177 'key' => 'user-record',
3178 'tab' => 'user-record',
3179 'class' => 'user-record',
3180 'href' => CRM_Core_Config
::singleton()->userSystem
->getUserRecordUrl($contactId),
3181 'icon' => 'crm-i fa-user',
3184 elseif (CRM_Core_Config
::singleton()->userSystem
->checkPermissionAddUser()) {
3185 $menu['otherActions']['user-add'] = array(
3186 'title' => ts('Create User Record'),
3187 'description' => ts('Create User Record'),
3189 'ref' => 'crm-contact-user-add',
3190 'key' => 'user-add',
3191 'tab' => 'user-add',
3192 'class' => 'user-add',
3193 'href' => CRM_Utils_System
::url('civicrm/contact/view/useradd', 'reset=1&action=add&cid=' . $contactId),
3194 'icon' => 'crm-i fa-user-plus',
3198 CRM_Utils_Hook
::summaryActions($menu, $contactId);
3199 //1. check for component is active.
3200 //2. check for user permissions.
3201 //3. check for acls.
3202 //3. edit and view contact are directly accessible to user.
3204 $aclPermissionedTasks = array(
3209 'group-add-contact',
3213 $corePermission = CRM_Core_Permission
::getPermission();
3215 $contextMenu = array();
3216 foreach ($menu as $key => $values) {
3217 if ($key != 'otherActions') {
3219 // user does not have necessary permissions.
3220 if (!self
::checkUserMenuPermissions($aclPermissionedTasks, $corePermission, $values)) {
3223 // build directly accessible action menu.
3224 if (in_array($values['ref'], array(
3228 $contextMenu['primaryActions'][$key] = array(
3229 'title' => $values['title'],
3230 'ref' => $values['ref'],
3231 'class' => CRM_Utils_Array
::value('class', $values),
3232 'key' => $values['key'],
3237 // finally get menu item for -more- action widget.
3238 $contextMenu['moreActions'][$values['weight']] = array(
3239 'title' => $values['title'],
3240 'ref' => $values['ref'],
3241 'href' => CRM_Utils_Array
::value('href', $values),
3242 'tab' => CRM_Utils_Array
::value('tab', $values),
3243 'class' => CRM_Utils_Array
::value('class', $values),
3244 'key' => $values['key'],
3248 foreach ($values as $value) {
3249 // user does not have necessary permissions.
3250 if (!self
::checkUserMenuPermissions($aclPermissionedTasks, $corePermission, $value)) {
3254 // finally get menu item for -more- action widget.
3255 $contextMenu['otherActions'][$value['weight']] = array(
3256 'title' => $value['title'],
3257 'ref' => $value['ref'],
3258 'href' => CRM_Utils_Array
::value('href', $value),
3259 'tab' => CRM_Utils_Array
::value('tab', $value),
3260 'class' => CRM_Utils_Array
::value('class', $value),
3261 'icon' => CRM_Utils_Array
::value('icon', $value),
3262 'key' => $value['key'],
3268 ksort($contextMenu['moreActions']);
3269 ksort($contextMenu['otherActions']);
3271 return $contextMenu;
3275 * Check if user has permissions to access items in action menu.
3277 * @param array $aclPermissionedTasks
3278 * Array containing ACL related tasks.
3279 * @param string $corePermission
3280 * The permission of the user (edit or view or null).
3281 * @param array $menuOptions
3282 * Array containing params of the menu (title, href, etc).
3285 * TRUE if user has all permissions, FALSE if otherwise.
3287 public static function checkUserMenuPermissions($aclPermissionedTasks, $corePermission, $menuOptions) {
3288 $componentName = CRM_Utils_Array
::value('component', $menuOptions);
3290 // if component action - make sure component is enable.
3291 if ($componentName && !in_array($componentName, CRM_Core_Config
::singleton()->enableComponents
)) {
3295 // make sure user has all required permissions.
3296 $hasAllPermissions = FALSE;
3298 $permissions = CRM_Utils_Array
::value('permissions', $menuOptions);
3299 if (!is_array($permissions) ||
empty($permissions)) {
3300 $hasAllPermissions = TRUE;
3303 // iterate for required permissions in given permissions array.
3304 if (!$hasAllPermissions) {
3305 $hasPermissions = 0;
3306 foreach ($permissions as $permission) {
3307 if (CRM_Core_Permission
::check($permission)) {
3312 if (count($permissions) == $hasPermissions) {
3313 $hasAllPermissions = TRUE;
3316 // if still user does not have required permissions, check acl.
3317 if (!$hasAllPermissions && $menuOptions['ref'] != 'delete-contact') {
3318 if (in_array($menuOptions['ref'], $aclPermissionedTasks) &&
3319 $corePermission == CRM_Core_Permission
::EDIT
3321 $hasAllPermissions = TRUE;
3323 elseif (in_array($menuOptions['ref'], array(
3326 // grant permissions for these tasks.
3327 $hasAllPermissions = TRUE;
3332 return $hasAllPermissions;
3336 * Retrieve display name of contact that address is shared.
3338 * This is based on $masterAddressId or $contactId .
3340 * @param int $masterAddressId
3342 * @param int $contactId
3343 * Contact id. (deprecated - do not use)
3345 * @return string|null
3346 * the found display name or null.
3348 public static function getMasterDisplayName($masterAddressId = NULL, $contactId = NULL) {
3349 $masterDisplayName = NULL;
3350 if (!$masterAddressId) {
3351 return $masterDisplayName;
3355 SELECT display_name from civicrm_contact
3356 LEFT JOIN civicrm_address ON ( civicrm_address.contact_id = civicrm_contact.id )
3357 WHERE civicrm_address.id = " . $masterAddressId;
3359 $masterDisplayName = CRM_Core_DAO
::singleValueQuery($sql);
3360 return $masterDisplayName;
3364 * Get the creation/modification times for a contact.
3366 * @param int $contactId
3369 * Dates - ('created_date' => $, 'modified_date' => $)
3371 public static function getTimestamps($contactId) {
3372 $timestamps = CRM_Core_DAO
::executeQuery(
3373 'SELECT created_date, modified_date
3374 FROM civicrm_contact
3377 1 => array($contactId, 'Integer'),
3380 if ($timestamps->fetch()) {
3382 'created_date' => $timestamps->created_date
,
3383 'modified_date' => $timestamps->modified_date
,
3392 * Get a list of triggers for the contact table.
3394 * @see hook_civicrm_triggerInfo
3395 * @see CRM_Core_DAO::triggerRebuild
3396 * @see http://issues.civicrm.org/jira/browse/CRM-10554
3399 * @param null $tableName
3401 public static function triggerInfo(&$info, $tableName = NULL) {
3402 //during upgrade, first check for valid version and then create triggers
3403 //i.e the columns created_date and modified_date are introduced in 4.3.alpha1 so dont create triggers for older version
3404 if (CRM_Core_Config
::isUpgradeMode()) {
3405 $currentVer = CRM_Core_BAO_Domain
::version(TRUE);
3406 //if current version is less than 4.3.alpha1 dont create below triggers
3407 if (version_compare($currentVer, '4.3.alpha1') < 0) {
3412 // Modifications to these records should update the contact timestamps.
3413 \Civi\Core\SqlTrigger\TimestampTriggers
::create('civicrm_contact', 'Contact')
3414 ->setRelations(array(
3415 array('table' => 'civicrm_address', 'column' => 'contact_id'),
3416 array('table' => 'civicrm_email', 'column' => 'contact_id'),
3417 array('table' => 'civicrm_im', 'column' => 'contact_id'),
3418 array('table' => 'civicrm_phone', 'column' => 'contact_id'),
3419 array('table' => 'civicrm_website', 'column' => 'contact_id'),
3421 ->alterTriggerInfo($info, $tableName);
3423 // Update phone table to populate phone_numeric field
3424 if (!$tableName ||
$tableName == 'civicrm_phone') {
3425 // Define stored sql function needed for phones
3426 $sqlTriggers = Civi
::service('sql_triggers');
3427 $sqlTriggers->enqueueQuery(self
::DROP_STRIP_FUNCTION_43
);
3428 $sqlTriggers->enqueueQuery(self
::CREATE_STRIP_FUNCTION_43
);
3430 'table' => array('civicrm_phone'),
3432 'event' => array('INSERT', 'UPDATE'),
3433 'sql' => "\nSET NEW.phone_numeric = civicrm_strip_non_numeric(NEW.phone);\n",
3439 * Check if contact is being used in civicrm_domain based on $contactId.
3441 * @param int $contactId
3445 * true if present else false.
3447 public static function checkDomainContact($contactId) {
3451 $domainId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Domain', $contactId, 'id', 'contact_id');
3462 * Get options for a given contact field.
3464 * @see CRM_Core_DAO::buildOptions
3466 * TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow?
3467 * TODO: In context of chainselect, what to return if e.g. a country has no states?
3469 * @param string $fieldName
3470 * @param string $context
3471 * @see CRM_Core_DAO::buildOptionsContext
3472 * @param array $props
3473 * whatever is known about this dao object.
3475 * @return array|bool
3477 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3479 // Special logic for fields whose options depend on context or properties
3480 switch ($fieldName) {
3481 case 'contact_sub_type':
3482 if (!empty($props['contact_type'])) {
3483 $params['condition'] = "parent_id = (SELECT id FROM civicrm_contact_type WHERE name='{$props['contact_type']}')";
3487 case 'contact_type':
3488 if ($context == 'search') {
3489 // CRM-15495 - EntityRef filters and basic search forms expect this format
3490 // FIXME: Search builder does not
3491 return CRM_Contact_BAO_ContactType
::getSelectElements();
3495 // The contact api supports some related entities so we'll honor that by fetching their options
3498 return CRM_Contact_BAO_GroupContact
::buildOptions('group_id', $context, $props);
3502 $props['entity_table'] = 'civicrm_contact';
3503 return CRM_Core_BAO_EntityTag
::buildOptions('tag_id', $context, $props);
3505 case 'state_province_id':
3506 case 'state_province':
3507 case 'state_province_name':
3512 case 'worldregion_id':
3513 return CRM_Core_BAO_Address
::buildOptions($fieldName, 'get', $props);
3516 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);
3520 * Delete a contact-related object that has an 'is_primary' field.
3522 * Ensures that is_primary gets assigned to another object if available
3523 * Also calls pre/post hooks
3525 * @param string $type
3529 public static function deleteObjectWithPrimary($type, $id) {
3530 if (!$id ||
!is_numeric($id)) {
3533 $daoName = "CRM_Core_DAO_$type";
3534 $obj = new $daoName();
3538 if ($obj->fetch()) {
3539 CRM_Utils_Hook
::pre('delete', $type, $id, $hookParams);
3540 $contactId = $obj->contact_id
;
3546 // is_primary is only relavent if this field belongs to a contact
3548 $dao = new $daoName();
3549 $dao->contact_id
= $contactId;
3550 $dao->is_primary
= 1;
3551 // Pick another record to be primary (if one isn't already)
3552 if (!$dao->find(TRUE)) {
3553 $dao->is_primary
= 0;
3555 if ($dao->fetch()) {
3556 $dao->is_primary
= 1;
3561 CRM_Utils_Hook
::post('delete', $type, $id, $obj);
3568 public function addSelectWhereClause() {
3569 // We always return an array with these keys, even if they are empty,
3570 // because this tells the query builder that we have considered these fields for acls
3572 'id' => (array) CRM_Contact_BAO_Contact_Permission
::cacheSubquery(),
3573 'is_deleted' => CRM_Core_Permission
::check('access deleted contacts') ?
array() : array('!= 1'),
3575 CRM_Utils_Hook
::selectWhereClause($this, $clauses);
3580 * Get any existing duplicate contacts based on the input parameters.
3582 * @param array $input
3583 * Input parameters to be matched.
3584 * @param string $contactType
3585 * @param string $rule
3588 * @param $excludedContactIDs
3589 * An array of ids not to be included in the results.
3590 * @param bool $checkPermissions
3591 * @param int $ruleGroupID
3592 * ID of the rule group to be used if an override is desirable.
3593 * @param array $contextParams
3594 * The context if relevant, eg. ['event_id' => X]
3598 public static function getDuplicateContacts($input, $contactType, $rule = 'Unsupervised', $excludedContactIDs = [], $checkPermissions = TRUE, $ruleGroupID = NULL, $contextParams = []) {
3599 $dedupeParams = CRM_Dedupe_Finder
::formatParams($input, $contactType);
3600 $dedupeParams['check_permission'] = $checkPermissions;
3601 $dedupeParams['contact_type'] = $contactType;
3602 $dedupeParams['rule'] = $rule;
3603 $dedupeParams['rule_group_id'] = $ruleGroupID;
3604 $dedupeParams['excluded_contact_ids'] = $excludedContactIDs;
3605 $dedupeResults['ids'] = [];
3606 $dedupeResults['handled'] = FALSE;
3607 CRM_Utils_Hook
::findDuplicates($dedupeParams, $dedupeResults, $contextParams);
3608 if (!$dedupeResults['handled']) {
3609 $dedupeResults['ids'] = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, $contactType, $rule, $excludedContactIDs, $ruleGroupID);
3611 return $dedupeResults['ids'];
3615 * Get the first duplicate contacts based on the input parameters.
3617 * @param array $input
3618 * Input parameters to be matched.
3619 * @param string $contactType
3620 * @param string $rule
3623 * @param $excludedContactIDs
3624 * An array of ids not to be included in the results.
3625 * @param bool $checkPermissions
3626 * @param int $ruleGroupID
3627 * ID of the rule group to be used if an override is desirable.
3628 * @param array $contextParams
3629 * The context if relevant, eg. ['event_id' => X]
3633 public static function getFirstDuplicateContact($input, $contactType, $rule = 'Unsupervised', $excludedContactIDs = [], $checkPermissions = TRUE, $ruleGroupID = NULL, $contextParams = []) {
3634 $ids = self
::getDuplicateContacts($input, $contactType, $rule, $excludedContactIDs, $checkPermissions, $ruleGroupID, $contextParams);
3642 * Check if a field is associated with an entity that has a location type.
3644 * (ie. is an address, phone, email etc field).
3646 * @param string $fieldTitle
3647 * Title of the field (not the name - create a new function for that if required).
3651 public static function isFieldHasLocationType($fieldTitle) {
3652 foreach (CRM_Contact_BAO_Contact
::importableFields() as $key => $field) {
3653 if ($field['title'] === $fieldTitle) {
3654 return CRM_Utils_Array
::value('hasLocationType', $field);
3661 * @param array $appendProfiles
3662 * Name of profile(s) to append to each link.
3666 public static function getEntityRefCreateLinks($appendProfiles = []) {
3667 // You'd think that "create contacts" would be the permission to check,
3668 // But new contact popups are profile forms and those use their own permissions.
3669 if (!CRM_Core_Permission
::check([['profile create', 'profile listings and forms']])) {
3673 foreach (CRM_Contact_BAO_ContactType
::basicTypes() as $contactType) {
3674 $profiles[] = 'new_' . strtolower($contactType);
3676 $retrieved = civicrm_api3('uf_group', 'get', [
3677 'name' => ['IN' => array_merge($profiles, (array) $appendProfiles)],
3680 $links = $append = [];
3681 if (!empty($retrieved['values'])) {
3683 'individual' => 'fa-user',
3684 'organization' => 'fa-building',
3685 'household' => 'fa-home',
3687 foreach ($retrieved['values'] as $id => $profile) {
3688 if (in_array($profile['name'], $profiles)) {
3690 'label' => $profile['title'],
3691 'url' => CRM_Utils_System
::url('civicrm/profile/create', "reset=1&context=dialog&gid=$id",
3692 NULL, NULL, FALSE, FALSE, TRUE),
3693 'type' => ucfirst(str_replace('new_', '', $profile['name'])),
3694 'icon' => CRM_Utils_Array
::value(str_replace('new_', '', $profile['name']), $icons),
3701 foreach ($append as $id) {
3702 foreach ($links as &$link) {
3703 $link['url'] .= ",$id";
3713 public static function getEntityRefFilters() {
3715 ['key' => 'contact_type', 'value' => ts('Contact Type')],
3716 ['key' => 'group', 'value' => ts('Group'), 'entity' => 'GroupContact'],
3717 ['key' => 'tag', 'value' => ts('Tag'), 'entity' => 'EntityTag'],
3718 ['key' => 'state_province', 'value' => ts('State/Province'), 'entity' => 'Address'],
3719 ['key' => 'country', 'value' => ts('Country'), 'entity' => 'Address'],
3720 ['key' => 'gender_id', 'value' => ts('Gender'), 'condition' => ['contact_type' => 'Individual']],
3721 ['key' => 'is_deceased', 'value' => ts('Deceased'), 'condition' => ['contact_type' => 'Individual']],
3722 ['key' => 'contact_id', 'value' => ts('Contact ID'), 'type' => 'text'],
3723 ['key' => 'external_identifier', 'value' => ts('External ID'), 'type' => 'text'],
3724 ['key' => 'source', 'value' => ts('Contact Source'), 'type' => 'text'],