3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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 static $_commPrefs = array(
78 static $_greetingTypes = array(
85 * Static field for all the contact information that we can potentially import.
89 static $_importableFields = array();
92 * Static field for all the contact information that we can potentially export.
96 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 // Fixed contact source.
150 if (isset($params['contact_source'])) {
151 $params['source'] = $params['contact_source'];
154 // Fix for preferred communication method.
155 $prefComm = CRM_Utils_Array
::value('preferred_communication_method', $params, '');
156 if ($prefComm && is_array($prefComm)) {
157 unset($params['preferred_communication_method']);
159 CRM_Utils_Array
::formatArrayKeys($prefComm);
160 $prefComm = CRM_Utils_Array
::implodePadded($prefComm);
163 $contact->preferred_communication_method
= $prefComm;
165 $allNull = $contact->copyValues($params);
167 $contact->id
= CRM_Utils_Array
::value('contact_id', $params);
169 if ($contact->contact_type
== 'Individual') {
172 // Format individual fields.
173 CRM_Contact_BAO_Individual
::format($params, $contact);
175 elseif ($contact->contact_type
== 'Household') {
176 if (isset($params['household_name'])) {
178 $contact->display_name
= $contact->sort_name
= CRM_Utils_Array
::value('household_name', $params, '');
181 elseif ($contact->contact_type
== 'Organization') {
182 if (isset($params['organization_name'])) {
184 $contact->display_name
= $contact->sort_name
= CRM_Utils_Array
::value('organization_name', $params, '');
188 $privacy = CRM_Utils_Array
::value('privacy', $params);
190 is_array($privacy) &&
194 foreach (self
::$_commPrefs as $name) {
195 $contact->$name = CRM_Utils_Array
::value($name, $privacy, FALSE);
199 // Since hash was required, make sure we have a 0 value for it (CRM-1063).
200 // @todo - does this mean we can remove this block?
201 // Fixed in 1.5 by making hash optional, only do this in create mode, not update.
202 if ((!array_key_exists('hash', $contact) ||
!$contact->hash
) && !$contact->id
) {
204 $contact->hash
= md5(uniqid(rand(), TRUE));
207 // Even if we don't need $employerId, it's important to call getFieldValue() before
208 // the contact is saved because we want the existing value to be cached.
209 // createCurrentEmployerRelationship() needs the old value not the updated one. CRM-10788
210 $employerId = empty($contact->id
) ?
NULL : CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contact->id
, 'employer_id');
215 CRM_Core_BAO_Log
::register($contact->id
,
221 if ($contact->contact_type
== 'Individual' && (isset($params['current_employer']) ||
isset($params['employer_id']))) {
222 // Create current employer.
223 $newEmployer = !empty($params['employer_id']) ?
$params['employer_id'] : CRM_Utils_Array
::value('current_employer', $params);
226 if (empty($params['contact_id'])) {
230 CRM_Contact_BAO_Contact_Utils
::createCurrentEmployerRelationship($contact->id
, $newEmployer, $employerId, $newContact);
234 CRM_Contact_BAO_Contact_Utils
::clearCurrentEmployer($contact->id
, $employerId);
239 // Update cached employer name.
240 if ($contact->contact_type
== 'Organization') {
241 CRM_Contact_BAO_Contact_Utils
::updateCurrentEmployer($contact->id
);
250 * takes an associative array and creates a contact object and all the associated
251 * derived objects (i.e. individual, location, email, phone etc)
253 * This function is invoked from within the web form layer and also from the api layer
255 * @param array $params
256 * (reference ) an assoc array of name/value pairs.
257 * @param bool $fixAddress
258 * If we need to fix address.
259 * @param bool $invokeHooks
260 * If we need to invoke hooks.
262 * @param bool $skipDelete
263 * Unclear parameter, passed to website create
265 * @todo explain this parameter
268 * @return CRM_Contact_BAO_Contact|CRM_Core_Error
269 * Created or updated contribution object. We are deprecating returning an error in
270 * favour of exceptions
272 public static function &create(&$params, $fixAddress = TRUE, $invokeHooks = TRUE, $skipDelete = FALSE) {
274 if (empty($params['contact_type']) && empty($params['contact_id'])) {
280 if (!empty($params['contact_id'])) {
281 CRM_Utils_Hook
::pre('edit', $params['contact_type'], $params['contact_id'], $params);
284 CRM_Utils_Hook
::pre('create', $params['contact_type'], NULL, $params);
289 $config = CRM_Core_Config
::singleton();
291 // CRM-6942: set preferred language to the current language if it’s unset (and we’re creating a contact).
292 if (empty($params['contact_id'])) {
293 // A case could be made for checking isset rather than empty but this is more consistent with previous behaviour.
294 if (empty($params['preferred_language']) && ($language = CRM_Core_I18n
::getContactDefaultLanguage()) != FALSE) {
295 $params['preferred_language'] = $language;
298 // CRM-9739: set greeting & addressee if unset and we’re creating a contact.
299 foreach (self
::$_greetingTypes as $greeting) {
300 if (empty($params[$greeting . '_id'])) {
301 if ($defaultGreetingTypeId
302 = CRM_Contact_BAO_Contact_Utils
::defaultGreeting($params['contact_type'], $greeting)
304 $params[$greeting . '_id'] = $defaultGreetingTypeId;
310 $transaction = new CRM_Core_Transaction();
312 $contact = self
::add($params);
314 // Not dying here is stupid, since we get into weird situation and into a bug that
315 // is impossible to figure out for the user or for us
317 CRM_Core_Error
::fatal();
320 $params['contact_id'] = $contact->id
;
322 if (Civi
::settings()->get('is_enabled')) {
323 // Enabling multisite causes the contact to be added to the domain group.
324 $domainGroupID = CRM_Core_BAO_Domain
::getGroupId();
325 if (!empty($domainGroupID)) {
326 if (!empty($params['group']) && is_array($params['group'])) {
327 $params['group'][$domainGroupID] = 1;
330 $params['group'] = array($domainGroupID => 1);
335 if (array_key_exists('group', $params)) {
336 $contactIds = array($params['contact_id']);
337 foreach ($params['group'] as $groupId => $flag) {
339 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $groupId);
341 elseif ($flag == -1) {
342 CRM_Contact_BAO_GroupContact
::removeContactsFromGroup($contactIds, $groupId);
347 // Add location Block data.
348 $blocks = CRM_Core_BAO_Location
::create($params, $fixAddress);
349 foreach ($blocks as $name => $value) {
350 $contact->$name = $value;
352 if (!empty($params['updateBlankLocInfo'])) {
357 CRM_Core_BAO_Website
::create($params['website'], $contact->id
, $skipDelete);
359 //get userID from session
360 $session = CRM_Core_Session
::singleton();
361 $userID = $session->get('userID');
363 if (!empty($params['note'])) {
364 if (is_array($params['note'])) {
365 foreach ($params['note'] as $note) {
366 $contactId = $contact->id
;
367 if (isset($note['contact_id'])) {
368 $contactId = $note['contact_id'];
370 //if logged in user, overwrite contactId
372 $contactId = $userID;
376 'entity_id' => $contact->id
,
377 'entity_table' => 'civicrm_contact',
378 'note' => $note['note'],
379 'subject' => CRM_Utils_Array
::value('subject', $note),
380 'contact_id' => $contactId,
382 CRM_Core_BAO_Note
::add($noteParams, CRM_Core_DAO
::$_nullArray);
386 $contactId = $contact->id
;
387 if (isset($note['contact_id'])) {
388 $contactId = $note['contact_id'];
390 //if logged in user, overwrite contactId
392 $contactId = $userID;
396 'entity_id' => $contact->id
,
397 'entity_table' => 'civicrm_contact',
398 'note' => $params['note'],
399 'subject' => CRM_Utils_Array
::value('subject', $params),
400 'contact_id' => $contactId,
402 CRM_Core_BAO_Note
::add($noteParams, CRM_Core_DAO
::$_nullArray);
406 // update the UF user_unique_id if that has changed
407 CRM_Core_BAO_UFMatch
::updateUFName($contact->id
);
409 if (!empty($params['custom']) &&
410 is_array($params['custom'])
412 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_contact', $contact->id
);
415 // make a civicrm_subscription_history entry only on contact create (CRM-777)
416 if (empty($params['contact_id'])) {
417 $subscriptionParams = array(
418 'contact_id' => $contact->id
,
422 CRM_Contact_BAO_SubscriptionHistory
::create($subscriptionParams);
425 $transaction->commit();
427 // CRM-6367: fetch the right label for contact type’s display
428 $contact->contact_type_display
= CRM_Core_DAO
::getFieldValue(
429 'CRM_Contact_DAO_ContactType',
430 $contact->contact_type
,
435 if (!$config->doNotResetCache
) {
436 // Note: doNotResetCache flag is currently set by import contact process and merging,
437 // since resetting and
438 // rebuilding cache could be expensive (for many contacts). We might come out with better
439 // approach in future.
440 CRM_Contact_BAO_Contact_Utils
::clearContactCaches($contact->id
);
445 CRM_Utils_Hook
::post('edit', $params['contact_type'], $contact->id
, $contact);
448 CRM_Utils_Hook
::post('create', $params['contact_type'], $contact->id
, $contact);
452 // process greetings CRM-4575, cache greetings
453 self
::processGreetings($contact);
459 * Get the display name and image of a contact.
464 * @param bool $includeTypeInReturnParameters
465 * Should type be part of the returned array?
468 * the displayName and contactImage for this contact
470 public static function getDisplayAndImage($id, $includeTypeInReturnParameters = FALSE) {
471 //CRM-14276 added the * on the civicrm_contact table so that we have all the contact info available
473 SELECT civicrm_contact.*,
474 civicrm_email.email as email
476 LEFT JOIN civicrm_email ON civicrm_email.contact_id = civicrm_contact.id
477 AND civicrm_email.is_primary = 1
478 WHERE civicrm_contact.id = " . CRM_Utils_Type
::escape($id, 'Integer');
479 $dao = new CRM_Core_DAO();
482 $image = CRM_Contact_BAO_Contact_Utils
::getImage($dao->contact_sub_type ?
483 $dao->contact_sub_type
: $dao->contact_type
, FALSE, $id
485 $imageUrl = CRM_Contact_BAO_Contact_Utils
::getImage($dao->contact_sub_type ?
486 $dao->contact_sub_type
: $dao->contact_type
, TRUE, $id
489 // use email if display_name is empty
490 if (empty($dao->display_name
)) {
491 $displayName = $dao->email
;
494 $displayName = $dao->display_name
;
497 CRM_Utils_Hook
::alterDisplayName($displayName, $id, $dao);
499 return $includeTypeInReturnParameters ?
array(
503 $dao->contact_sub_type
,
505 ) : array($displayName, $image, $imageUrl);
511 * Add billing fields to the params if appropriate.
513 * If we have ANY name fields then we want to ignore all the billing name fields. However, if we
514 * don't then we should set the name fields to the filling fields AND add the preserveDBName
515 * parameter (which will tell the BAO only to set those fields if none already exist.
517 * We specifically don't want to set first name from billing and last name form an on-page field. Mixing &
518 * matching is best done by hipsters.
520 * @param array $params
522 public static function addBillingNameFieldsIfOtherwiseNotSet(&$params) {
523 $nameFields = array('first_name', 'middle_name', 'last_name');
524 foreach ($nameFields as $field) {
525 if (!empty($params[$field])) {
529 // There are only 3 - we can iterate through them twice :-)
530 foreach ($nameFields as $field) {
531 if (!empty($params['billing_' . $field])) {
532 $params[$field] = $params['billing_' . $field];
534 $params['preserveDBName'] = TRUE;
540 * Create last viewed link to recently updated contact.
542 * @param array $crudLinkSpec
543 * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
544 * - entity_table: string, eg "civicrm_contact"
548 * NULL if unavailable, or
549 * [path: string, query: string, title: string]
550 * @see CRM_Utils_System::createDefaultCrudLink
552 public function createDefaultCrudLink($crudLinkSpec) {
553 switch ($crudLinkSpec['action']) {
554 case CRM_Core_Action
::VIEW
:
556 'title' => $this->display_name
,
557 'path' => 'civicrm/contact/view',
565 case CRM_Core_Action
::UPDATE
:
567 'title' => $this->display_name
,
568 'path' => 'civicrm/contact/add',
571 'action' => 'update',
581 * Get the values for pseudoconstants for name->value and reverse.
583 * @param array $defaults
584 * (reference) the default values, some of which need to be resolved.
585 * @param bool $reverse
586 * True if we want to resolve the values in the reverse direction (value -> name).
588 public static function resolveDefaults(&$defaults, $reverse = FALSE) {
589 // Hack for birth_date.
590 if (!empty($defaults['birth_date'])) {
591 if (is_array($defaults['birth_date'])) {
592 $defaults['birth_date'] = CRM_Utils_Date
::format($defaults['birth_date'], '-');
596 CRM_Utils_Array
::lookupValue($defaults, 'prefix', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'prefix_id'), $reverse);
597 CRM_Utils_Array
::lookupValue($defaults, 'suffix', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'suffix_id'), $reverse);
598 CRM_Utils_Array
::lookupValue($defaults, 'gender', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id'), $reverse);
599 CRM_Utils_Array
::lookupValue($defaults, 'communication_style', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'communication_style_id'), $reverse);
601 //lookup value of email/postal greeting, addressee, CRM-4575
602 foreach (self
::$_greetingTypes as $greeting) {
603 $filterCondition = array(
604 'contact_type' => CRM_Utils_Array
::value('contact_type', $defaults),
605 'greeting_type' => $greeting,
607 CRM_Utils_Array
::lookupValue($defaults, $greeting,
608 CRM_Core_PseudoConstant
::greeting($filterCondition), $reverse
612 $blocks = array('address', 'im', 'phone');
613 foreach ($blocks as $name) {
614 if (!array_key_exists($name, $defaults) ||
!is_array($defaults[$name])) {
617 foreach ($defaults[$name] as $count => & $values) {
619 //get location type id.
620 CRM_Utils_Array
::lookupValue($values, 'location_type', CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id'), $reverse);
622 if ($name == 'address') {
623 // FIXME: lookupValue doesn't work for vcard_name
624 if (!empty($values['location_type_id'])) {
625 $vcardNames = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id', array('labelColumn' => 'vcard_name'));
626 $values['vcard_name'] = $vcardNames[$values['location_type_id']];
629 if (!CRM_Utils_Array
::lookupValue($values,
631 CRM_Core_PseudoConstant
::country(),
636 CRM_Utils_Array
::lookupValue($values,
638 CRM_Core_PseudoConstant
::countryIsoCode(),
644 // if we find a country id above, we need to restrict it to that country
645 // rather than the list of all countries
647 if (!empty($values['country_id'])) {
648 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceForCountry($values['country_id']);
651 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvince();
653 if (!CRM_Utils_Array
::lookupValue($values,
661 if (!empty($values['country_id'])) {
662 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceForCountry($values['country_id'], 'abbreviation');
665 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceAbbreviation();
667 CRM_Utils_Array
::lookupValue($values,
674 if (!empty($values['state_province_id'])) {
675 $countyList = CRM_Core_PseudoConstant
::countyForState($values['state_province_id']);
678 $countyList = CRM_Core_PseudoConstant
::county();
680 CRM_Utils_Array
::lookupValue($values,
688 CRM_Utils_Array
::lookupValue($values,
690 CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id'),
695 if ($name == 'phone') {
696 CRM_Utils_Array
::lookupValue($values,
698 CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id'),
703 // Kill the reference.
710 * Fetch object based on array of properties.
712 * @param array $params
713 * (reference ) an assoc array of name/value pairs.
714 * @param array $defaults
715 * (reference ) an assoc array to hold the name / value pairs.
716 * in a hierarchical manner
717 * @param bool $microformat
718 * For location in microformat.
720 * @return CRM_Contact_BAO_Contact
722 public static function &retrieve(&$params, &$defaults, $microformat = FALSE) {
723 if (array_key_exists('contact_id', $params)) {
724 $params['id'] = $params['contact_id'];
726 elseif (array_key_exists('id', $params)) {
727 $params['contact_id'] = $params['id'];
730 $contact = self
::getValues($params, $defaults);
732 unset($params['id']);
734 //get the block information for this contact
735 $entityBlock = array('contact_id' => $params['contact_id']);
736 $blocks = CRM_Core_BAO_Location
::getValues($entityBlock, $microformat);
737 $defaults = array_merge($defaults, $blocks);
738 foreach ($blocks as $block => $value) {
739 $contact->$block = $value;
742 if (!isset($params['noNotes'])) {
743 $contact->notes
= CRM_Core_BAO_Note
::getValues($params, $defaults);
746 if (!isset($params['noRelationships'])) {
747 $contact->relationship
= CRM_Contact_BAO_Relationship
::getValues($params, $defaults);
750 if (!isset($params['noGroups'])) {
751 $contact->groupContact
= CRM_Contact_BAO_GroupContact
::getValues($params, $defaults);
754 if (!isset($params['noWebsite'])) {
755 $contact->website
= CRM_Core_BAO_Website
::getValues($params, $defaults);
762 * Get the display name of a contact.
767 * @return null|string
768 * display name of the contact if found
770 public static function displayName($id) {
773 $displayName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $id, 'display_name');
780 * Delete a contact and all its associated records.
783 * Id of the contact to delete.
784 * @param bool $restore
785 * Whether to actually restore, not delete.
786 * @param bool $skipUndelete
787 * Whether to force contact delete or not.
790 * Was contact deleted?
792 public static function deleteContact($id, $restore = FALSE, $skipUndelete = FALSE) {
797 // If trash is disabled in system settings then we always skip
798 if (!Civi
::settings()->get('contact_undelete')) {
799 $skipUndelete = TRUE;
802 // make sure we have edit permission for this contact
804 if (($skipUndelete && !CRM_Core_Permission
::check('delete contacts')) ||
805 ($restore && !CRM_Core_Permission
::check('access deleted contacts'))
811 // Restrict contact to be delete if contact has financial trxns
813 if ($skipUndelete && CRM_Financial_BAO_FinancialItem
::checkContactPresent(array($id), $error)) {
817 // make sure this contact_id does not have any membership types
818 $membershipTypeID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
821 'member_of_contact_id'
823 if ($membershipTypeID) {
827 $contact = new CRM_Contact_DAO_Contact();
829 if (!$contact->find(TRUE)) {
833 $contactType = $contact->contact_type
;
834 // currently we only clear employer cache.
835 // we are now deleting inherited membership if any.
836 if ($contact->contact_type
== 'Organization') {
837 $action = $restore ? CRM_Core_Action
::ENABLE
: CRM_Core_Action
::DISABLE
;
838 $relationshipDtls = CRM_Contact_BAO_Relationship
::getRelationship($id);
839 if (!empty($relationshipDtls)) {
840 foreach ($relationshipDtls as $rId => $details) {
841 CRM_Contact_BAO_Relationship
::disableEnableRelationship($rId, $action);
844 CRM_Contact_BAO_Contact_Utils
::clearAllEmployee($id);
848 return self
::contactTrashRestore($contact, TRUE);
851 // start a new transaction
852 $transaction = new CRM_Core_Transaction();
855 CRM_Utils_Hook
::pre('delete', $contactType, $id, CRM_Core_DAO
::$_nullArray);
857 //delete billing address if exists.
858 CRM_Contribute_BAO_Contribution
::deleteAddress(NULL, $id);
860 // delete the log entries since we dont have triggers enabled as yet
861 $logDAO = new CRM_Core_DAO_Log();
862 $logDAO->entity_table
= 'civicrm_contact';
863 $logDAO->entity_id
= $id;
866 // delete contact participants CRM-12155
867 CRM_Event_BAO_Participant
::deleteContactParticipant($id);
869 // delete contact contributions CRM-12155
870 CRM_Contribute_BAO_Contribution
::deleteContactContribution($id);
872 // do activity cleanup, CRM-5604
873 CRM_Activity_BAO_Activity
::cleanupActivity($id);
875 // delete all notes related to contact
876 CRM_Core_BAO_Note
::cleanContactNotes($id);
878 // delete cases related to contact
879 $contactCases = CRM_Case_BAO_Case
::retrieveCaseIdsByContactId($id);
880 if (!empty($contactCases)) {
881 foreach ($contactCases as $caseId) {
882 //check if case is associate with other contact or not.
883 $caseContactId = CRM_Case_BAO_Case
::getCaseClients($caseId);
884 if (count($caseContactId) <= 1) {
885 CRM_Case_BAO_Case
::deleteCase($caseId);
893 self
::contactTrashRestore($contact);
896 //delete the contact id from recently view
897 CRM_Utils_Recent
::delContact($id);
898 self
::updateContactCache($id, empty($restore));
900 // delete any dupe cache entry
901 CRM_Core_BAO_PrevNextCache
::deleteItem($id);
903 $transaction->commit();
906 CRM_Utils_Hook
::post('delete', $contactType, $contact->id
, $contact);
909 // also reset the DB_DO global array so we can reuse the memory
910 // http://issues.civicrm.org/jira/browse/CRM-4387
911 CRM_Core_DAO
::freeResult();
917 * Action to update any caches relating to a recently update contact.
919 * I was going to call this from delete as well as from create to ensure the delete is being
920 * done whenever a contact is set to is_deleted=1 BUT I found create is already over-aggressive in
921 * that regard so adding it to delete seems to be enough to remove it from CRM_Contact_BAO_Contact_Permission
922 * where the call involved a subquery that was locking the table.
924 * @param int $contactID
925 * @param bool $isTrashed
927 public static function updateContactCache($contactID, $isTrashed = FALSE) {
930 CRM_Contact_BAO_GroupContactCache
::removeContact($contactID);
931 // This has been moved to here from CRM_Contact_BAO_Contact_Permission as that was causing
932 // a table-locking query. It still seems a bit inadequate as it assumes the acl users can't see deleted
933 // but this should not cause any change as long as contacts are not being trashed outside the
934 // main functions for that.
935 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_acl_contact_cache WHERE contact_id = %1', array(1 => array($contactID, 'Integer')));
938 CRM_Contact_BAO_GroupContactCache
::remove();
943 * Delete the image of a contact.
949 * Was contact image deleted?
951 public static function deleteContactImage($id) {
956 UPDATE civicrm_contact
959 CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
964 * Return proportional height and width of the image.
966 * @param int $imageWidth
969 * @param int $imageHeight
973 * Thumb dimension of image
975 public static function getThumbSize($imageWidth, $imageHeight) {
977 if ($imageWidth && $imageHeight) {
978 $imageRatio = $imageWidth / $imageHeight;
983 if ($imageRatio > 1) {
984 $imageThumbWidth = $thumbWidth;
985 $imageThumbHeight = round($thumbWidth / $imageRatio);
988 $imageThumbHeight = $thumbWidth;
989 $imageThumbWidth = round($thumbWidth * $imageRatio);
992 return array($imageThumbWidth, $imageThumbHeight);
996 * Validate type of contact image.
998 * @param array $params
999 * @param string $imageIndex
1000 * Index of image field.
1001 * @param string $statusMsg
1002 * Status message to be set after operation.
1003 * @param string $opType
1004 * Type of operation like fatal, bounce etc.
1007 * true if valid image extension
1009 public static function processImageParams(
1011 $imageIndex = 'image_URL',
1025 if (in_array($params[$imageIndex]['type'], $mimeType)) {
1026 $photo = basename($params[$imageIndex]['name']);
1027 $params[$imageIndex] = CRM_Utils_System
::url('civicrm/contact/imagefile', 'photo=' . $photo, TRUE, NULL, TRUE, TRUE);
1031 unset($params[$imageIndex]);
1033 $statusMsg = ts('Image could not be uploaded due to invalid type extension.');
1035 if ($opType == 'status') {
1036 CRM_Core_Session
::setStatus($statusMsg, 'Sorry', 'error');
1038 // FIXME: additional support for fatal, bounce etc could be added.
1044 * Extract contact id from url for deleting contact image.
1046 public static function processImage() {
1048 $action = CRM_Utils_Request
::retrieve('action', 'String');
1049 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive');
1050 // retrieve contact id in case of Profile context
1051 $id = CRM_Utils_Request
::retrieve('id', 'Positive');
1052 $cid = $cid ?
$cid : $id;
1053 if ($action & CRM_Core_Action
::DELETE
) {
1054 if (CRM_Utils_Request
::retrieve('confirmed', 'Boolean')) {
1055 CRM_Contact_BAO_Contact
::deleteContactImage($cid);
1056 CRM_Core_Session
::setStatus(ts('Contact image deleted successfully'), ts('Image Deleted'), 'success');
1057 $session = CRM_Core_Session
::singleton();
1058 $toUrl = $session->popUserContext();
1059 CRM_Utils_System
::redirect($toUrl);
1065 * Function to set is_delete true or restore deleted contact.
1067 * @param CRM_Contact_DAO_Contact $contact
1068 * Contact DAO object.
1069 * @param bool $restore
1070 * True to set the is_delete = 1 else false to restore deleted contact,
1071 * i.e. is_delete = 0
1075 public static function contactTrashRestore($contact, $restore = FALSE) {
1076 $updateParams = array(
1077 'id' => $contact->id
,
1078 'is_deleted' => $restore ?
0 : 1,
1081 CRM_Utils_Hook
::pre('update', $contact->contact_type
, $contact->id
, $updateParams);
1083 $params = array(1 => array($contact->id
, 'Integer'));
1085 $query = "DELETE FROM civicrm_uf_match WHERE contact_id = %1";
1086 CRM_Core_DAO
::executeQuery($query, $params);
1089 $contact->copyValues($updateParams);
1092 CRM_Utils_Hook
::post('update', $contact->contact_type
, $contact->id
, $contact);
1098 * Get contact type for a contact.
1101 * Id of the contact whose contact type is needed.
1104 * contact_type if $id found else null ""
1106 public static function getContactType($id) {
1107 return CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_type');
1111 * Get contact sub type for a contact.
1114 * Id of the contact whose contact sub type is needed.
1116 * @param string $implodeDelimiter
1119 * contact_sub_type if $id found else null ""
1121 public static function getContactSubType($id, $implodeDelimiter = NULL) {
1122 $subtype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_sub_type');
1124 return $implodeDelimiter ?
NULL : array();
1127 $subtype = CRM_Utils_Array
::explodePadded($subtype);
1129 if ($implodeDelimiter) {
1130 $subtype = implode($implodeDelimiter, $subtype);
1136 * Get pair of contact-type and sub-type for a contact.
1139 * Id of the contact whose contact sub/contact type is needed.
1143 public static function getContactTypes($id) {
1144 $params = array('id' => $id);
1146 $contact = CRM_Core_DAO
::commonRetrieve('CRM_Contact_DAO_Contact',
1149 array('contact_type', 'contact_sub_type')
1153 $contactTypes = array();
1154 if ($contact->contact_sub_type
) {
1155 $contactTypes = CRM_Utils_Array
::explodePadded($contact->contact_sub_type
);
1157 array_unshift($contactTypes, $contact->contact_type
);
1159 return $contactTypes;
1162 CRM_Core_Error
::fatal();
1167 * Combine all the importable fields from the lower levels object.
1169 * The ordering is important, since currently we do not have a weight
1170 * scheme. Adding weight is super important
1172 * @param int|string $contactType contact Type
1173 * @param bool $status
1174 * Status is used to manipulate first title.
1175 * @param bool $showAll
1176 * If true returns all fields (includes disabled fields).
1177 * @param bool $isProfile
1178 * If its profile mode.
1179 * @param bool $checkPermission
1180 * If false, do not include permissioning clause (for custom data).
1182 * @param bool $withMultiCustomFields
1185 * array of importable Fields
1187 public static function importableFields(
1188 $contactType = 'Individual',
1192 $checkPermission = TRUE,
1193 $withMultiCustomFields = FALSE
1195 if (empty($contactType)) {
1196 $contactType = 'All';
1199 $cacheKeyString = "importableFields $contactType";
1200 $cacheKeyString .= $status ?
'_1' : '_0';
1201 $cacheKeyString .= $showAll ?
'_1' : '_0';
1202 $cacheKeyString .= $isProfile ?
'_1' : '_0';
1203 $cacheKeyString .= $checkPermission ?
'_1' : '_0';
1205 $fields = CRM_Utils_Array
::value($cacheKeyString, self
::$_importableFields);
1208 // check if we can retrieve from database cache
1209 $fields = CRM_Core_BAO_Cache
::getItem('contact fields', $cacheKeyString);
1213 $fields = CRM_Contact_DAO_Contact
::import();
1215 // get the fields thar are meant for contact types
1216 if (in_array($contactType, array(
1222 $fields = array_merge($fields, CRM_Core_OptionValue
::getFields('', $contactType));
1225 $locationFields = array_merge(CRM_Core_DAO_Address
::import(),
1226 CRM_Core_DAO_Phone
::import(),
1227 CRM_Core_DAO_Email
::import(),
1228 CRM_Core_DAO_IM
::import(TRUE),
1229 CRM_Core_DAO_OpenID
::import()
1232 $locationFields = array_merge($locationFields,
1233 CRM_Core_BAO_CustomField
::getFieldsForImport('Address',
1241 foreach ($locationFields as $key => $field) {
1242 $locationFields[$key]['hasLocationType'] = TRUE;
1245 $fields = array_merge($fields, $locationFields);
1247 $fields = array_merge($fields, CRM_Contact_DAO_Contact
::import());
1248 $fields = array_merge($fields, CRM_Core_DAO_Note
::import());
1251 $fields = array_merge($fields, CRM_Core_DAO_Website
::import());
1252 $fields['url']['hasWebsiteType'] = TRUE;
1254 if ($contactType != 'All') {
1255 $fields = array_merge($fields,
1256 CRM_Core_BAO_CustomField
::getFieldsForImport($contactType,
1261 $withMultiCustomFields
1264 //unset the fields, which are not related to their
1266 $commonValues = array(
1267 'Individual' => array(
1271 'organization_name',
1273 'Household' => array(
1283 'organization_name',
1291 'Organization' => array(
1306 foreach ($commonValues[$contactType] as $value) {
1307 unset($fields[$value]);
1311 foreach (array('Individual', 'Household', 'Organization') as $type) {
1312 $fields = array_merge($fields,
1313 CRM_Core_BAO_CustomField
::getFieldsForImport($type,
1318 $withMultiCustomFields
1325 $fields = array_merge($fields, array(
1327 'title' => ts('Group(s)'),
1331 'title' => ts('Tag(s)'),
1335 'title' => ts('Note(s)'),
1338 'communication_style_id' => array(
1339 'title' => ts('Communication Style'),
1340 'name' => 'communication_style_id',
1345 //Sorting fields in alphabetical order(CRM-1507)
1346 $fields = CRM_Utils_Array
::crmArraySortByField($fields, 'title');
1348 CRM_Core_BAO_Cache
::setItem($fields, 'contact fields', $cacheKeyString);
1351 self
::$_importableFields[$cacheKeyString] = $fields;
1355 $fields = array_merge(array('do_not_import' => array('title' => ts('- do not import -'))),
1356 self
::$_importableFields[$cacheKeyString]
1360 $fields = array_merge(array('' => array('title' => ts('- Contact Fields -'))),
1361 self
::$_importableFields[$cacheKeyString]
1369 * Combine all the exportable fields from the lower levels object.
1371 * Currently we are using importable fields as exportable fields
1373 * @param int|string $contactType contact Type
1374 * @param bool $status
1375 * True while exporting primary contacts.
1376 * @param bool $export
1377 * True when used during export.
1378 * @param bool $search
1379 * True when used during search, might conflict with export param?.
1381 * @param bool $withMultiRecord
1384 * array of exportable Fields
1386 public static function &exportableFields($contactType = 'Individual', $status = FALSE, $export = FALSE, $search = FALSE, $withMultiRecord = FALSE) {
1387 if (empty($contactType)) {
1388 $contactType = 'All';
1391 $cacheKeyString = "exportableFields $contactType";
1392 $cacheKeyString .= $export ?
'_1' : '_0';
1393 $cacheKeyString .= $status ?
'_1' : '_0';
1394 $cacheKeyString .= $search ?
'_1' : '_0';
1395 //CRM-14501 it turns out that the impact of permissioning here is sometimes inconsistent. The field that
1396 //calculates custom fields takes into account the logged in user & caches that for all users
1397 //as an interim fix we will cache the fields by contact
1398 $cacheKeyString .= '_' . CRM_Core_Session
::getLoggedInContactID();
1400 if (!self
::$_exportableFields ||
!CRM_Utils_Array
::value($cacheKeyString, self
::$_exportableFields)) {
1401 if (!self
::$_exportableFields) {
1402 self
::$_exportableFields = array();
1405 // check if we can retrieve from database cache
1406 $fields = CRM_Core_BAO_Cache
::getItem('contact fields', $cacheKeyString);
1409 $fields = CRM_Contact_DAO_Contact
::export();
1411 // The fields are meant for contact types.
1412 if (in_array($contactType, array(
1419 $fields = array_merge($fields, CRM_Core_OptionValue
::getFields('', $contactType));
1421 // add current employer for individuals
1422 $fields = array_merge($fields, array(
1423 'current_employer' =>
1425 'name' => 'organization_name',
1426 'title' => ts('Current Employer'),
1430 $locationType = array(
1431 'location_type' => array(
1432 'name' => 'location_type',
1433 'where' => 'civicrm_location_type.name',
1434 'title' => ts('Location Type'),
1438 $IMProvider = array(
1439 'im_provider' => array(
1440 'name' => 'im_provider',
1441 'where' => 'civicrm_im.provider_id',
1442 'title' => ts('IM Provider'),
1446 $locationFields = array_merge($locationType,
1447 CRM_Core_DAO_Address
::export(),
1448 CRM_Core_DAO_Phone
::export(),
1449 CRM_Core_DAO_Email
::export(),
1451 CRM_Core_DAO_IM
::export(TRUE),
1452 CRM_Core_DAO_OpenID
::export()
1455 $locationFields = array_merge($locationFields,
1456 CRM_Core_BAO_CustomField
::getFieldsForImport('Address')
1459 foreach ($locationFields as $key => $field) {
1460 $locationFields[$key]['hasLocationType'] = TRUE;
1463 $fields = array_merge($fields, $locationFields);
1466 $fields = array_merge($fields,
1467 CRM_Core_DAO_Worldregion
::export()
1470 $fields = array_merge($fields,
1471 CRM_Contact_DAO_Contact
::export()
1475 $fields = array_merge($fields, CRM_Core_DAO_Website
::export());
1477 if ($contactType != 'All') {
1478 $fields = array_merge($fields,
1479 CRM_Core_BAO_CustomField
::getFieldsForImport($contactType, $status, FALSE, $search, TRUE, $withMultiRecord)
1488 $fields = array_merge($fields,
1489 CRM_Core_BAO_CustomField
::getFieldsForImport($type, FALSE, FALSE, $search, TRUE, $withMultiRecord)
1496 $fields = array_merge($fields, array(
1498 'title' => ts('Group(s)'),
1502 'title' => ts('Tag(s)'),
1506 'title' => ts('Note(s)'),
1512 $fields = array_merge($fields, array(
1514 'title' => ts('Group(s)'),
1518 'title' => ts('Tag(s)'),
1522 'title' => ts('Note(s)'),
1528 //Sorting fields in alphabetical order(CRM-1507)
1529 foreach ($fields as $k => $v) {
1530 $sortArray[$k] = CRM_Utils_Array
::value('title', $v);
1533 $fields = array_merge($sortArray, $fields);
1534 //unset the field which are not related to their contact type.
1535 if ($contactType != 'All') {
1536 $commonValues = array(
1537 'Individual' => array(
1541 'organization_name',
1542 'email_greeting_custom',
1543 'postal_greeting_custom',
1546 'Household' => array(
1556 'organization_name',
1564 'email_greeting_custom',
1565 'postal_greeting_custom',
1570 'Organization' => array(
1581 'email_greeting_custom',
1582 'postal_greeting_custom',
1592 foreach ($commonValues[$contactType] as $value) {
1593 unset($fields[$value]);
1597 CRM_Core_BAO_Cache
::setItem($fields, 'contact fields', $cacheKeyString);
1599 self
::$_exportableFields[$cacheKeyString] = $fields;
1603 $fields = self
::$_exportableFields[$cacheKeyString];
1606 $fields = array_merge(array('' => array('title' => ts('- Contact Fields -'))),
1607 self
::$_exportableFields[$cacheKeyString]
1615 * Get the all contact details (Hierarchical).
1617 * @param int $contactId
1619 * @param array $fields
1625 public static function getHierContactDetails($contactId, &$fields) {
1626 $params = array(array('contact_id', '=', $contactId, 0, 0));
1629 $returnProperties = self
::makeHierReturnProperties($fields, $contactId);
1631 // We don't know the contents of return properties, but we need the lower
1632 // level ids of the contact so add a few fields.
1633 $returnProperties['first_name'] = 1;
1634 $returnProperties['organization_name'] = 1;
1635 $returnProperties['household_name'] = 1;
1636 $returnProperties['contact_type'] = 1;
1637 $returnProperties['contact_sub_type'] = 1;
1638 return list($query, $options) = CRM_Contact_BAO_Query
::apiQuery($params, $returnProperties, $options);
1642 * Given a set of flat profile style field names, create a hierarchy.
1644 * This is for the query to use, create the right sql.
1647 * @param int $contactId
1651 * A hierarchical property tree if appropriate
1653 public static function &makeHierReturnProperties($fields, $contactId = NULL) {
1654 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
1656 $returnProperties = array();
1658 $multipleFields = array('website' => 'url');
1659 foreach ($fields as $name => $dontCare) {
1660 if (strpos($name, '-') !== FALSE) {
1661 list($fieldName, $id, $type) = CRM_Utils_System
::explode('-', $name, 3);
1663 if (!in_array($fieldName, $multipleFields)) {
1664 if ($id == 'Primary') {
1665 $locationTypeName = 1;
1668 $locationTypeName = CRM_Utils_Array
::value($id, $locationTypes);
1669 if (!$locationTypeName) {
1674 if (empty($returnProperties['location'])) {
1675 $returnProperties['location'] = array();
1677 if (empty($returnProperties['location'][$locationTypeName])) {
1678 $returnProperties['location'][$locationTypeName] = array();
1679 $returnProperties['location'][$locationTypeName]['location_type'] = $id;
1681 if (in_array($fieldName, array(
1689 $returnProperties['location'][$locationTypeName][$fieldName . '-' . $type] = 1;
1692 $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1695 elseif (substr($fieldName, 0, 14) === 'address_custom') {
1696 $returnProperties['location'][$locationTypeName][substr($fieldName, 8)] = 1;
1699 $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1703 $returnProperties['website'][$id][$fieldName] = 1;
1707 $returnProperties[$name] = 1;
1711 return $returnProperties;
1715 * Return the primary location type of a contact.
1717 * $params int $contactId contact_id
1718 * $params boolean $isPrimaryExist if true, return primary contact location type otherwise null
1719 * $params boolean $skipDefaultPriamry if true, return primary contact location type otherwise null
1721 * @param int $contactId
1722 * @param bool $skipDefaultPriamry
1723 * @param null $block
1726 * $locationType location_type_id
1728 public static function getPrimaryLocationType($contactId, $skipDefaultPriamry = FALSE, $block = NULL) {
1730 $entityBlock = array('contact_id' => $contactId);
1731 $blocks = CRM_Core_BAO_Location
::getValues($entityBlock);
1732 foreach ($blocks[$block] as $key => $value) {
1733 if (!empty($value['is_primary'])) {
1734 $locationType = CRM_Utils_Array
::value('location_type_id', $value);
1741 IF ( civicrm_email.location_type_id IS NULL,
1742 IF ( civicrm_address.location_type_id IS NULL,
1743 IF ( civicrm_phone.location_type_id IS NULL,
1744 IF ( civicrm_im.location_type_id IS NULL,
1745 IF ( civicrm_openid.location_type_id IS NULL, null, civicrm_openid.location_type_id)
1746 ,civicrm_im.location_type_id)
1747 ,civicrm_phone.location_type_id)
1748 ,civicrm_address.location_type_id)
1749 ,civicrm_email.location_type_id) as locationType
1750 FROM civicrm_contact
1751 LEFT JOIN civicrm_email ON ( civicrm_email.is_primary = 1 AND civicrm_email.contact_id = civicrm_contact.id )
1752 LEFT JOIN civicrm_address ON ( civicrm_address.is_primary = 1 AND civicrm_address.contact_id = civicrm_contact.id)
1753 LEFT JOIN civicrm_phone ON ( civicrm_phone.is_primary = 1 AND civicrm_phone.contact_id = civicrm_contact.id)
1754 LEFT JOIN civicrm_im ON ( civicrm_im.is_primary = 1 AND civicrm_im.contact_id = civicrm_contact.id)
1755 LEFT JOIN civicrm_openid ON ( civicrm_openid.is_primary = 1 AND civicrm_openid.contact_id = civicrm_contact.id)
1756 WHERE civicrm_contact.id = %1 ";
1758 $params = array(1 => array($contactId, 'Integer'));
1760 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1762 $locationType = NULL;
1763 if ($dao->fetch()) {
1764 $locationType = $dao->locationType
;
1767 if (isset($locationType)) {
1768 return $locationType;
1770 elseif ($skipDefaultPriamry) {
1771 // if there is no primary contact location then return null
1775 // if there is no primart contact location, then return default
1776 // location type of the system
1777 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
1778 return $defaultLocationType->id
;
1783 * Get the display name, primary email and location type of a contact.
1786 * Id of the contact.
1789 * Array of display_name, email if found, do_not_email or (null,null,null)
1791 public static function getContactDetails($id) {
1792 // check if the contact type
1793 $contactType = self
::getContactType($id);
1795 $nameFields = ($contactType == 'Individual') ?
"civicrm_contact.first_name, civicrm_contact.last_name, civicrm_contact.display_name" : "civicrm_contact.display_name";
1798 SELECT $nameFields, civicrm_email.email, civicrm_contact.do_not_email, civicrm_email.on_hold, civicrm_contact.is_deceased
1799 FROM civicrm_contact LEFT JOIN civicrm_email ON (civicrm_contact.id = civicrm_email.contact_id)
1800 WHERE civicrm_contact.id = %1
1801 ORDER BY civicrm_email.is_primary DESC";
1802 $params = array(1 => array($id, 'Integer'));
1803 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
1805 if ($dao->fetch()) {
1806 if ($contactType == 'Individual') {
1807 if ($dao->first_name ||
$dao->last_name
) {
1808 $name = "{$dao->first_name} {$dao->last_name}";
1811 $name = $dao->display_name
;
1815 $name = $dao->display_name
;
1817 $email = $dao->email
;
1818 $doNotEmail = $dao->do_not_email ?
TRUE : FALSE;
1819 $onHold = $dao->on_hold ?
TRUE : FALSE;
1820 $isDeceased = $dao->is_deceased ?
TRUE : FALSE;
1821 return array($name, $email, $doNotEmail, $onHold, $isDeceased);
1823 return array(NULL, NULL, NULL, NULL, NULL);
1827 * Add/edit/register contacts through profile.
1829 * @param array $params
1830 * Array of profile fields to be edited/added.
1831 * @param array $fields
1832 * Array of fields from UFGroup.
1833 * @param int $contactID
1834 * Id of the contact to be edited/added.
1835 * @param int $addToGroupID
1836 * Specifies the default group to which contact is added.
1837 * @param int $ufGroupId
1838 * Uf group id (profile id).
1839 * @param string $ctype
1840 * @param bool $visibility
1841 * Basically lets us know where this request is coming from.
1842 * if via a profile from web, we restrict what groups are changed
1845 * contact id created/edited
1847 public static function createProfileContact(
1851 $addToGroupID = NULL,
1856 // add ufGroupID to params array ( CRM-2012 )
1858 $params['uf_group_id'] = $ufGroupId;
1860 self
::addBillingNameFieldsIfOtherwiseNotSet($params);
1862 // If a user has logged in, or accessed via a checksum
1863 // Then deliberately 'blanking' a value in the profile should remove it from their record
1864 $session = CRM_Core_Session
::singleton();
1865 $params['updateBlankLocInfo'] = TRUE;
1866 if (($session->get('authSrc') & (CRM_Core_Permission
::AUTH_SRC_CHECKSUM + CRM_Core_Permission
::AUTH_SRC_LOGIN
)) == 0) {
1867 $params['updateBlankLocInfo'] = FALSE;
1872 CRM_Utils_Hook
::pre('edit', 'Profile', $contactID, $params);
1876 CRM_Utils_Hook
::pre('create', 'Profile', NULL, $params);
1879 list($data, $contactDetails) = self
::formatProfileContactParams($params, $fields, $contactID, $ufGroupId, $ctype);
1881 // manage is_opt_out
1882 if (array_key_exists('is_opt_out', $fields) && array_key_exists('is_opt_out', $params)) {
1883 $wasOptOut = CRM_Utils_Array
::value('is_opt_out', $contactDetails, FALSE);
1884 $isOptOut = CRM_Utils_Array
::value('is_opt_out', $params, FALSE);
1885 $data['is_opt_out'] = $isOptOut;
1886 // on change, create new civicrm_subscription_history entry
1887 if (($wasOptOut != $isOptOut) && !empty($contactDetails['contact_id'])) {
1889 'contact_id' => $contactDetails['contact_id'],
1890 'status' => $isOptOut ?
'Removed' : 'Added',
1893 CRM_Contact_BAO_SubscriptionHistory
::create($shParams);
1897 $contact = self
::create($data);
1899 // contact is null if the profile does not have any contact fields
1901 $contactID = $contact->id
;
1904 if (empty($contactID)) {
1905 CRM_Core_Error
::fatal('Cannot proceed without a valid contact id');
1908 // Process group and tag
1909 if (!empty($fields['group'])) {
1911 // this for sure means we are coming in via profile since i added it to fix
1912 // removing contacts from user groups -- lobo
1916 CRM_Contact_BAO_GroupContact
::create($params['group'], $contactID, $visibility, $method);
1919 if (!empty($fields['tag'])) {
1920 CRM_Core_BAO_EntityTag
::create($params['tag'], 'civicrm_contact', $contactID);
1923 //to add profile in default group
1924 if (is_array($addToGroupID)) {
1925 $contactIds = array($contactID);
1926 foreach ($addToGroupID as $groupId) {
1927 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $groupId);
1930 elseif ($addToGroupID) {
1931 $contactIds = array($contactID);
1932 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $addToGroupID);
1935 // reset the group contact cache for this group
1936 CRM_Contact_BAO_GroupContactCache
::remove();
1939 CRM_Utils_Hook
::post('edit', 'Profile', $contactID, $params);
1942 CRM_Utils_Hook
::post('create', 'Profile', $contactID, $params);
1948 * Format profile contact parameters.
1950 * @param array $params
1952 * @param int $contactID
1953 * @param int $ufGroupId
1954 * @param null $ctype
1955 * @param bool $skipCustom
1959 public static function formatProfileContactParams(
1968 $data = $contactDetails = array();
1970 // get the contact details (hier)
1972 list($details, $options) = self
::getHierContactDetails($contactID, $fields);
1974 $contactDetails = $details[$contactID];
1975 $data['contact_type'] = CRM_Utils_Array
::value('contact_type', $contactDetails);
1976 $data['contact_sub_type'] = CRM_Utils_Array
::value('contact_sub_type', $contactDetails);
1979 //we should get contact type only if contact
1981 $data['contact_type'] = CRM_Core_BAO_UFField
::getProfileType($ufGroupId);
1983 //special case to handle profile with only contact fields
1984 if ($data['contact_type'] == 'Contact') {
1985 $data['contact_type'] = 'Individual';
1987 elseif (CRM_Contact_BAO_ContactType
::isaSubType($data['contact_type'])) {
1988 $data['contact_type'] = CRM_Contact_BAO_ContactType
::getBasicType($data['contact_type']);
1992 $data['contact_type'] = $ctype;
1995 $data['contact_type'] = 'Individual';
1999 //fix contact sub type CRM-5125
2000 if (array_key_exists('contact_sub_type', $params) &&
2001 !empty($params['contact_sub_type'])
2003 $data['contact_sub_type'] = CRM_Utils_Array
::implodePadded($params['contact_sub_type']);
2005 elseif (array_key_exists('contact_sub_type_hidden', $params) &&
2006 !empty($params['contact_sub_type_hidden'])
2008 // if profile was used, and had any subtype, we obtain it from there
2009 //CRM-13596 - add to existing contact types, rather than overwriting
2010 $data_contact_sub_type_arr = CRM_Utils_Array
::explodePadded($data['contact_sub_type']);
2011 if (!in_array($params['contact_sub_type_hidden'], $data_contact_sub_type_arr)) {
2012 $data['contact_sub_type'] .= CRM_Utils_Array
::implodePadded($params['contact_sub_type_hidden']);
2016 if ($ctype == 'Organization') {
2017 $data['organization_name'] = CRM_Utils_Array
::value('organization_name', $contactDetails);
2019 elseif ($ctype == 'Household') {
2020 $data['household_name'] = CRM_Utils_Array
::value('household_name', $contactDetails);
2023 $locationType = array();
2028 $data['contact_id'] = $contactID;
2029 $primaryLocationType = self
::getPrimaryLocationType($contactID);
2032 $defaultLocation = CRM_Core_BAO_LocationType
::getDefault();
2033 $defaultLocationId = $defaultLocation->id
;
2036 $billingLocationTypeId = CRM_Core_BAO_LocationType
::getBilling();
2038 $blocks = array('email', 'phone', 'im', 'openid');
2040 $multiplFields = array('url');
2041 // prevent overwritten of formatted array, reset all block from
2042 // params if it is not in valid format (since import pass valid format)
2043 foreach ($blocks as $blk) {
2044 if (array_key_exists($blk, $params) &&
2045 !is_array($params[$blk])
2047 unset($params[$blk]);
2051 $primaryPhoneLoc = NULL;
2052 $session = CRM_Core_Session
::singleton();
2053 foreach ($params as $key => $value) {
2054 $locTypeId = $typeId = NULL;
2055 list($fieldName, $locTypeId, $typeId) = CRM_Utils_System
::explode('-', $key, 3);
2057 //store original location type id
2058 $actualLocTypeId = $locTypeId;
2060 if ($locTypeId == 'Primary') {
2062 if (in_array($fieldName, $blocks)) {
2063 $locTypeId = self
::getPrimaryLocationType($contactID, FALSE, $fieldName);
2066 $locTypeId = self
::getPrimaryLocationType($contactID, FALSE, 'address');
2068 $primaryLocationType = $locTypeId;
2071 $locTypeId = $defaultLocationId;
2075 if (is_numeric($locTypeId) &&
2076 !in_array($fieldName, $multiplFields) &&
2077 substr($fieldName, 0, 7) != 'custom_'
2079 $index = $locTypeId;
2081 if (is_numeric($typeId)) {
2082 $index .= '-' . $typeId;
2084 if (!in_array($index, $locationType)) {
2085 $locationType[$count] = $index;
2089 $loc = CRM_Utils_Array
::key($index, $locationType);
2091 $blockName = in_array($fieldName, $blocks) ?
$fieldName : 'address';
2093 $data[$blockName][$loc]['location_type_id'] = $locTypeId;
2095 //set is_billing true, for location type "Billing"
2096 if ($locTypeId == $billingLocationTypeId) {
2097 $data[$blockName][$loc]['is_billing'] = 1;
2101 //get the primary location type
2102 if ($locTypeId == $primaryLocationType) {
2103 $data[$blockName][$loc]['is_primary'] = 1;
2106 elseif ($locTypeId == $defaultLocationId) {
2107 $data[$blockName][$loc]['is_primary'] = 1;
2110 if (in_array($fieldName, array('phone'))) {
2112 $data['phone'][$loc]['phone_type_id'] = $typeId;
2115 $data['phone'][$loc]['phone_type_id'] = '';
2117 $data['phone'][$loc]['phone'] = $value;
2119 //special case to handle primary phone with different phone types
2120 // in this case we make first phone type as primary
2121 if (isset($data['phone'][$loc]['is_primary']) && !$primaryPhoneLoc) {
2122 $primaryPhoneLoc = $loc;
2125 if ($loc != $primaryPhoneLoc) {
2126 unset($data['phone'][$loc]['is_primary']);
2129 elseif ($fieldName == 'phone_ext') {
2130 $data['phone'][$loc]['phone_ext'] = $value;
2132 elseif ($fieldName == 'email') {
2133 $data['email'][$loc]['email'] = $value;
2134 if (empty($contactID)) {
2135 $data['email'][$loc]['is_primary'] = 1;
2138 elseif ($fieldName == 'im') {
2139 if (isset($params[$key . '-provider_id'])) {
2140 $data['im'][$loc]['provider_id'] = $params[$key . '-provider_id'];
2142 if (strpos($key, '-provider_id') !== FALSE) {
2143 $data['im'][$loc]['provider_id'] = $params[$key];
2146 $data['im'][$loc]['name'] = $value;
2149 elseif ($fieldName == 'openid') {
2150 $data['openid'][$loc]['openid'] = $value;
2153 if ($fieldName === 'state_province') {
2155 if (is_numeric($value) && ((int ) $value) >= 1000) {
2156 $data['address'][$loc]['state_province_id'] = $value;
2158 elseif (empty($value)) {
2159 $data['address'][$loc]['state_province_id'] = '';
2162 $data['address'][$loc]['state_province'] = $value;
2165 elseif ($fieldName === 'country') {
2167 if (is_numeric($value) && ((int ) $value) >= 1000
2169 $data['address'][$loc]['country_id'] = $value;
2171 elseif (empty($value)) {
2172 $data['address'][$loc]['country_id'] = '';
2175 $data['address'][$loc]['country'] = $value;
2178 elseif ($fieldName === 'county') {
2179 $data['address'][$loc]['county_id'] = $value;
2181 elseif ($fieldName == 'address_name') {
2182 $data['address'][$loc]['name'] = $value;
2184 elseif (substr($fieldName, 0, 14) === 'address_custom') {
2185 $data['address'][$loc][substr($fieldName, 8)] = $value;
2188 $data['address'][$loc][$fieldName] = $value;
2193 if (substr($key, 0, 4) === 'url-') {
2194 $websiteField = explode('-', $key);
2195 $data['website'][$websiteField[1]]['website_type_id'] = $websiteField[1];
2196 $data['website'][$websiteField[1]]['url'] = $value;
2198 elseif (in_array($key, self
::$_greetingTypes, TRUE)) {
2199 //save email/postal greeting and addressee values if any, CRM-4575
2200 $data[$key . '_id'] = $value;
2202 elseif (!$skipCustom && ($customFieldId = CRM_Core_BAO_CustomField
::getKeyID($key))) {
2203 // for autocomplete transfer hidden value instead of label
2204 if ($params[$key] && isset($params[$key . '_id'])) {
2205 $value = $params[$key . '_id'];
2208 // we need to append time with date
2209 if ($params[$key] && isset($params[$key . '_time'])) {
2210 $value .= ' ' . $params[$key . '_time'];
2213 // if auth source is not checksum / login && $value is blank, do not proceed - CRM-10128
2214 if (($session->get('authSrc') & (CRM_Core_Permission
::AUTH_SRC_CHECKSUM + CRM_Core_Permission
::AUTH_SRC_LOGIN
)) == 0 &&
2215 ($value == '' ||
!isset($value))
2221 if (!empty($params['customRecordValues'])) {
2222 if (is_array($params['customRecordValues']) && !empty($params['customRecordValues'])) {
2223 foreach ($params['customRecordValues'] as $recId => $customFields) {
2224 if (is_array($customFields) && !empty($customFields)) {
2225 foreach ($customFields as $customFieldName) {
2226 if ($customFieldName == $key) {
2236 //CRM-13596 - check for contact_sub_type_hidden first
2237 if (array_key_exists('contact_sub_type_hidden', $params)) {
2238 $type = $params['contact_sub_type_hidden'];
2241 $type = $data['contact_type'];
2242 if (!empty($data['contact_sub_type'])) {
2243 $type = $data['contact_sub_type'];
2244 $type = CRM_Utils_Array
::explodePadded($type);
2245 // generally a contact even if, has multiple subtypes the parent-type is going to be one only
2246 // and since formatCustomField() would be interested in parent type, lets consider only one subtype
2247 // as the results going to be same.
2252 CRM_Core_BAO_CustomField
::formatCustomField($customFieldId,
2260 elseif ($key == 'edit') {
2264 if ($key == 'location') {
2265 foreach ($value as $locationTypeId => $field) {
2266 foreach ($field as $block => $val) {
2267 if ($block == 'address' && array_key_exists('address_name', $val)) {
2268 $value[$locationTypeId][$block]['name'] = $value[$locationTypeId][$block]['address_name'];
2273 if ($key == 'phone' && isset($params['phone_ext'])) {
2274 $data[$key] = $value;
2275 foreach ($value as $cnt => $phoneBlock) {
2276 if ($params[$key][$cnt]['location_type_id'] == $params['phone_ext'][$cnt]['location_type_id']) {
2277 $data[$key][$cnt]['phone_ext'] = CRM_Utils_Array
::retrieveValueRecursive($params['phone_ext'][$cnt], 'phone_ext');
2281 elseif (in_array($key,
2292 ($value == '' ||
!isset($value)) &&
2293 ($session->get('authSrc') & (CRM_Core_Permission
::AUTH_SRC_CHECKSUM + CRM_Core_Permission
::AUTH_SRC_LOGIN
)) == 0 ||
2294 ($key == 'current_employer' && empty($params['current_employer']))) {
2295 // CRM-10128: if auth source is not checksum / login && $value is blank, do not fill $data with empty value
2296 // to avoid update with empty values
2300 $data[$key] = $value;
2306 if (!isset($data['contact_type'])) {
2307 $data['contact_type'] = 'Individual';
2310 //set the values for checkboxes (do_not_email, do_not_mail, do_not_trade, do_not_phone)
2311 $privacy = CRM_Core_SelectValues
::privacy();
2312 foreach ($privacy as $key => $value) {
2313 if (array_key_exists($key, $fields)) {
2314 // do not reset values for existing contacts, if fields are added to a profile
2315 if (array_key_exists($key, $params)) {
2316 $data[$key] = $params[$key];
2317 if (empty($params[$key])) {
2321 elseif (!$contactID) {
2327 return array($data, $contactDetails);
2331 * Find the get contact details.
2333 * This function does not respect ACLs for now, which might need to be rectified at some
2334 * stage based on how its used.
2336 * @param string $mail
2337 * Primary email address of the contact.
2338 * @param string $ctype
2342 * $dao contact details
2344 public static function &matchContactOnEmail($mail, $ctype = NULL) {
2345 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2346 $mail = $strtolower(trim($mail));
2348 SELECT civicrm_contact.id as contact_id,
2349 civicrm_contact.hash as hash,
2350 civicrm_contact.contact_type as contact_type,
2351 civicrm_contact.contact_sub_type as contact_sub_type
2352 FROM civicrm_contact
2353 INNER JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id )";
2355 if (Civi
::settings()->get('uniq_email_per_site')) {
2356 // try to find a match within a site (multisite).
2357 $groups = CRM_Core_BAO_Domain
::getChildGroupIds();
2358 if (!empty($groups)) {
2360 INNER JOIN civicrm_group_contact gc ON
2361 (civicrm_contact.id = gc.contact_id AND gc.status = 'Added' AND gc.group_id IN (" . implode(',', $groups) . "))";
2366 WHERE civicrm_email.email = %1 AND civicrm_contact.is_deleted=0";
2367 $p = array(1 => array($mail, 'String'));
2370 $query .= " AND civicrm_contact.contact_type = %3";
2371 $p[3] = array($ctype, 'String');
2374 $query .= " ORDER BY civicrm_email.is_primary DESC";
2376 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2378 if ($dao->fetch()) {
2381 return CRM_Core_DAO
::$_nullObject;
2385 * Find the contact details associated with an OpenID.
2387 * @param string $openId
2388 * OpenId of the contact.
2389 * @param string $ctype
2393 * $dao contact details
2395 public static function &matchContactOnOpenId($openId, $ctype = NULL) {
2396 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2397 $openId = $strtolower(trim($openId));
2399 SELECT civicrm_contact.id as contact_id,
2400 civicrm_contact.hash as hash,
2401 civicrm_contact.contact_type as contact_type,
2402 civicrm_contact.contact_sub_type as contact_sub_type
2403 FROM civicrm_contact
2404 INNER JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id )
2405 WHERE civicrm_openid.openid = %1";
2406 $p = array(1 => array($openId, 'String'));
2409 $query .= " AND civicrm_contact.contact_type = %3";
2410 $p[3] = array($ctype, 'String');
2413 $query .= " ORDER BY civicrm_openid.is_primary DESC";
2415 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2417 if ($dao->fetch()) {
2420 return CRM_Core_DAO
::$_nullObject;
2424 * Get primary email of the contact.
2426 * @param int $contactID
2430 * Email address if present else null
2432 public static function getPrimaryEmail($contactID) {
2433 // fetch the primary email
2435 SELECT civicrm_email.email as email
2436 FROM civicrm_contact
2437 LEFT JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id )
2438 WHERE civicrm_email.is_primary = 1
2439 AND civicrm_contact.id = %1";
2440 $p = array(1 => array($contactID, 'Integer'));
2441 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2444 if ($dao->fetch()) {
2445 $email = $dao->email
;
2452 * Function to get primary OpenID of the contact.
2454 * @param int $contactID
2458 * >openid OpenID if present else null
2460 public static function getPrimaryOpenId($contactID) {
2461 // fetch the primary OpenID
2463 SELECT civicrm_openid.openid as openid
2464 FROM civicrm_contact
2465 LEFT JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id )
2466 WHERE civicrm_contact.id = %1
2467 AND civicrm_openid.is_primary = 1";
2468 $p = array(1 => array($contactID, 'Integer'));
2469 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2472 if ($dao->fetch()) {
2473 $openId = $dao->openid
;
2480 * Fetch the object and store the values in the values array.
2482 * @param array $params
2483 * Input parameters to find object.
2484 * @param array $values
2485 * Output values of the object.
2487 * @return CRM_Contact_BAO_Contact|null
2488 * The found object or null
2490 public static function getValues(&$params, &$values) {
2491 $contact = new CRM_Contact_BAO_Contact();
2493 $contact->copyValues($params);
2495 if ($contact->find(TRUE)) {
2497 CRM_Core_DAO
::storeValues($contact, $values);
2500 foreach (self
::$_commPrefs as $name) {
2501 if (isset($contact->$name)) {
2502 $privacy[$name] = $contact->$name;
2506 if (!empty($privacy)) {
2507 $values['privacy'] = $privacy;
2510 // communication Prefferance
2511 $preffComm = $comm = array();
2512 $comm = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
2513 $contact->preferred_communication_method
2515 foreach ($comm as $value) {
2516 $preffComm[$value] = 1;
2518 $temp = array('preferred_communication_method' => $contact->preferred_communication_method
);
2521 'preferred_communication_method' => array(
2522 'newName' => 'preferred_communication_method_display',
2523 'groupName' => 'preferred_communication_method',
2527 CRM_Core_OptionGroup
::lookupValues($temp, $names, FALSE);
2529 $values['preferred_communication_method'] = $preffComm;
2530 $values['preferred_communication_method_display'] = CRM_Utils_Array
::value('preferred_communication_method_display', $temp);
2532 if ($contact->preferred_mail_format
) {
2533 $preferredMailingFormat = CRM_Core_SelectValues
::pmf();
2534 $values['preferred_mail_format'] = $preferredMailingFormat[$contact->preferred_mail_format
];
2537 // get preferred languages
2538 if (!empty($contact->preferred_language
)) {
2539 $values['preferred_language'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $contact->preferred_language
);
2542 // Calculating Year difference
2543 if ($contact->birth_date
) {
2544 $birthDate = CRM_Utils_Date
::customFormat($contact->birth_date
, '%Y%m%d');
2545 if ($birthDate < date('Ymd')) {
2546 $age = CRM_Utils_Date
::calculateAge($birthDate);
2547 $values['age']['y'] = CRM_Utils_Array
::value('years', $age);
2548 $values['age']['m'] = CRM_Utils_Array
::value('months', $age);
2551 list($values['birth_date']) = CRM_Utils_Date
::setDateDefaults($contact->birth_date
, 'birth');
2552 $values['birth_date_display'] = $contact->birth_date
;
2555 if ($contact->deceased_date
) {
2556 list($values['deceased_date']) = CRM_Utils_Date
::setDateDefaults($contact->deceased_date
, 'birth');
2557 $values['deceased_date_display'] = $contact->deceased_date
;
2560 $contact->contact_id
= $contact->id
;
2568 * Given the component name and returns the count of participation of contact.
2570 * @param string $component
2571 * Input component name.
2572 * @param int $contactId
2574 * @param string $tableName
2575 * Optional tableName if component is custom group.
2578 * total number in database
2580 public static function getCountComponent($component, $contactId, $tableName = NULL) {
2582 switch ($component) {
2584 return CRM_Core_BAO_EntityTag
::getContactTags($contactId, TRUE);
2587 $result = CRM_Contact_BAO_Relationship
::getRelationship($contactId,
2588 CRM_Contact_BAO_Relationship
::CURRENT
,
2593 return count($result);
2597 return CRM_Contact_BAO_GroupContact
::getContactGroup($contactId, "Added", NULL, TRUE);
2600 if (CRM_Core_BAO_Log
::useLoggingReport()) {
2603 return CRM_Core_BAO_Log
::getContactLogCount($contactId);
2606 return CRM_Core_BAO_Note
::getContactNoteCount($contactId);
2608 case 'contribution':
2609 return CRM_Contribute_BAO_Contribution
::contributionCount($contactId);
2612 return CRM_Member_BAO_Membership
::getContactMembershipCount($contactId, TRUE);
2615 return CRM_Event_BAO_Participant
::getContactParticipantCount($contactId);
2618 return CRM_Pledge_BAO_Pledge
::getContactPledgeCount($contactId);
2621 return CRM_Case_BAO_Case
::caseCount($contactId);
2624 return CRM_Grant_BAO_Grant
::getContactGrantCount($contactId);
2628 'contact_id' => $contactId,
2631 'context' => 'activity',
2633 return CRM_Activity_BAO_Activity
::getActivitiesCount($input);
2636 $params = array('contact_id' => $contactId);
2637 return CRM_Mailing_BAO_Mailing
::getContactMailingsCount($params);
2640 $custom = explode('_', $component);
2641 if ($custom['0'] = 'custom') {
2643 $tableName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $custom['1'], 'table_name');
2645 $queryString = "SELECT count(id) FROM {$tableName} WHERE entity_id = {$contactId}";
2646 return CRM_Core_DAO
::singleValueQuery($queryString);
2652 * Process greetings and cache.
2654 * @param object $contact
2655 * Contact object after save.
2656 * @param bool $useDefaults
2657 * Use default greeting values.
2659 public static function processGreetings(&$contact, $useDefaults = FALSE) {
2661 //retrieve default greetings
2662 $defaultGreetings = CRM_Core_PseudoConstant
::greetingDefaults();
2663 $contactDefaults = $defaultGreetings[$contact->contact_type
];
2666 // note that contact object not always has required greeting related
2667 // fields that are required to calculate greeting and
2668 // also other fields used in tokens etc,
2669 // hence we need to retrieve it again.
2670 if ($contact->_query
!== FALSE) {
2671 $contact->find(TRUE);
2674 // store object values to an array
2675 $contactDetails = array();
2676 CRM_Core_DAO
::storeValues($contact, $contactDetails);
2677 $contactDetails = array(array($contact->id
=> $contactDetails));
2679 $emailGreetingString = $postalGreetingString = $addresseeString = NULL;
2680 $updateQueryString = array();
2682 //cache email and postal greeting to greeting display
2683 if ($contact->email_greeting_custom
!= 'null' && $contact->email_greeting_custom
) {
2684 $emailGreetingString = $contact->email_greeting_custom
;
2686 elseif ($contact->email_greeting_id
!= 'null' && $contact->email_greeting_id
) {
2687 // the filter value for Individual contact type is set to 1
2689 'contact_type' => $contact->contact_type
,
2690 'greeting_type' => 'email_greeting',
2693 $emailGreeting = CRM_Core_PseudoConstant
::greeting($filter);
2694 $emailGreetingString = $emailGreeting[$contact->email_greeting_id
];
2695 $updateQueryString[] = " email_greeting_custom = NULL ";
2699 reset($contactDefaults['email_greeting']);
2700 $emailGreetingID = key($contactDefaults['email_greeting']);
2701 $emailGreetingString = $contactDefaults['email_greeting'][$emailGreetingID];
2702 $updateQueryString[] = " email_greeting_id = $emailGreetingID ";
2703 $updateQueryString[] = " email_greeting_custom = NULL ";
2705 elseif ($contact->email_greeting_custom
) {
2706 $updateQueryString[] = " email_greeting_display = NULL ";
2710 if ($emailGreetingString) {
2711 CRM_Contact_BAO_Contact_Utils
::processGreetingTemplate($emailGreetingString,
2714 'CRM_Contact_BAO_Contact'
2716 $emailGreetingString = CRM_Core_DAO
::escapeString(CRM_Utils_String
::stripSpaces($emailGreetingString));
2717 $updateQueryString[] = " email_greeting_display = '{$emailGreetingString}'";
2721 if ($contact->postal_greeting_custom
!= 'null' && $contact->postal_greeting_custom
) {
2722 $postalGreetingString = $contact->postal_greeting_custom
;
2724 elseif ($contact->postal_greeting_id
!= 'null' && $contact->postal_greeting_id
) {
2726 'contact_type' => $contact->contact_type
,
2727 'greeting_type' => 'postal_greeting',
2729 $postalGreeting = CRM_Core_PseudoConstant
::greeting($filter);
2730 $postalGreetingString = $postalGreeting[$contact->postal_greeting_id
];
2731 $updateQueryString[] = " postal_greeting_custom = NULL ";
2735 reset($contactDefaults['postal_greeting']);
2736 $postalGreetingID = key($contactDefaults['postal_greeting']);
2737 $postalGreetingString = $contactDefaults['postal_greeting'][$postalGreetingID];
2738 $updateQueryString[] = " postal_greeting_id = $postalGreetingID ";
2739 $updateQueryString[] = " postal_greeting_custom = NULL ";
2741 elseif ($contact->postal_greeting_custom
) {
2742 $updateQueryString[] = " postal_greeting_display = NULL ";
2746 if ($postalGreetingString) {
2747 CRM_Contact_BAO_Contact_Utils
::processGreetingTemplate($postalGreetingString,
2750 'CRM_Contact_BAO_Contact'
2752 $postalGreetingString = CRM_Core_DAO
::escapeString(CRM_Utils_String
::stripSpaces($postalGreetingString));
2753 $updateQueryString[] = " postal_greeting_display = '{$postalGreetingString}'";
2757 if ($contact->addressee_custom
!= 'null' && $contact->addressee_custom
) {
2758 $addresseeString = $contact->addressee_custom
;
2760 elseif ($contact->addressee_id
!= 'null' && $contact->addressee_id
) {
2762 'contact_type' => $contact->contact_type
,
2763 'greeting_type' => 'addressee',
2766 $addressee = CRM_Core_PseudoConstant
::greeting($filter);
2767 $addresseeString = $addressee[$contact->addressee_id
];
2768 $updateQueryString[] = " addressee_custom = NULL ";
2772 reset($contactDefaults['addressee']);
2773 $addresseeID = key($contactDefaults['addressee']);
2774 $addresseeString = $contactDefaults['addressee'][$addresseeID];
2775 $updateQueryString[] = " addressee_id = $addresseeID ";
2776 $updateQueryString[] = " addressee_custom = NULL ";
2778 elseif ($contact->addressee_custom
) {
2779 $updateQueryString[] = " addressee_display = NULL ";
2783 if ($addresseeString) {
2784 CRM_Contact_BAO_Contact_Utils
::processGreetingTemplate($addresseeString,
2787 'CRM_Contact_BAO_Contact'
2789 $addresseeString = CRM_Core_DAO
::escapeString(CRM_Utils_String
::stripSpaces($addresseeString));
2790 $updateQueryString[] = " addressee_display = '{$addresseeString}'";
2793 if (!empty($updateQueryString)) {
2794 $updateQueryString = implode(',', $updateQueryString);
2795 $queryString = "UPDATE civicrm_contact SET {$updateQueryString} WHERE id = {$contact->id}";
2796 CRM_Core_DAO
::executeQuery($queryString);
2801 * Retrieve loc block ids w/ given condition.
2803 * @param int $contactId
2805 * @param array $criteria
2806 * Key => value pair which should be.
2807 * fulfill by return record ids.
2808 * @param string $condOperator
2809 * Operator use for grouping multiple conditions.
2812 * loc block ids which fulfill condition.
2814 public static function getLocBlockIds($contactId, $criteria = array(), $condOperator = 'AND') {
2815 $locBlockIds = array();
2817 return $locBlockIds;
2820 foreach (array('Email', 'OpenID', 'Phone', 'Address', 'IM') as $block) {
2821 $name = strtolower($block);
2822 $className = "CRM_Core_DAO_$block";
2823 $blockDAO = new $className();
2825 // build the condition.
2826 if (is_array($criteria)) {
2827 $fields = $blockDAO->fields();
2828 $conditions = array();
2829 foreach ($criteria as $field => $value) {
2830 if (array_key_exists($field, $fields)) {
2831 $cond = "( $field = $value )";
2832 // value might be zero or null.
2833 if (!$value ||
strtolower($value) == 'null') {
2834 $cond = "( $field = 0 OR $field IS NULL )";
2836 $conditions[] = $cond;
2839 if (!empty($conditions)) {
2840 $blockDAO->whereAdd(implode(" $condOperator ", $conditions));
2844 $blockDAO->contact_id
= $contactId;
2846 while ($blockDAO->fetch()) {
2847 $locBlockIds[$name][] = $blockDAO->id
;
2852 return $locBlockIds;
2856 * Build context menu items.
2858 * @param int $contactId
2861 * Array of context menu for logged in user.
2863 public static function contextMenu($contactId = NULL) {
2866 'title' => ts('View Contact'),
2868 'ref' => 'view-contact',
2869 'class' => 'no-popup',
2871 'permissions' => array('view all contacts'),
2874 'title' => ts('Edit Contact'),
2876 'ref' => 'edit-contact',
2877 'class' => 'no-popup',
2879 'permissions' => array('edit all contacts'),
2882 'title' => ts('Delete Contact'),
2884 'ref' => 'delete-contact',
2886 'permissions' => array('access deleted contacts', 'delete contacts'),
2888 'contribution' => array(
2889 'title' => ts('Add Contribution'),
2891 'ref' => 'new-contribution',
2892 'key' => 'contribution',
2893 'tab' => 'contribute',
2894 'component' => 'CiviContribute',
2895 'href' => CRM_Utils_System
::url('civicrm/contact/view/contribution',
2896 'reset=1&action=add&context=contribution'
2898 'permissions' => array(
2899 'access CiviContribute',
2900 'edit contributions',
2903 'participant' => array(
2904 'title' => ts('Register for Event'),
2906 'ref' => 'new-participant',
2907 'key' => 'participant',
2908 'tab' => 'participant',
2909 'component' => 'CiviEvent',
2910 'href' => CRM_Utils_System
::url('civicrm/contact/view/participant', 'reset=1&action=add&context=participant'),
2911 'permissions' => array(
2913 'edit event participants',
2916 'activity' => array(
2917 'title' => ts('Record Activity'),
2919 'ref' => 'new-activity',
2920 'key' => 'activity',
2921 'permissions' => array('edit all contacts'),
2924 'title' => ts('Add Pledge'),
2926 'ref' => 'new-pledge',
2929 'href' => CRM_Utils_System
::url('civicrm/contact/view/pledge',
2930 'reset=1&action=add&context=pledge'
2932 'component' => 'CiviPledge',
2933 'permissions' => array(
2934 'access CiviPledge',
2938 'membership' => array(
2939 'title' => ts('Add Membership'),
2941 'ref' => 'new-membership',
2942 'key' => 'membership',
2944 'component' => 'CiviMember',
2945 'href' => CRM_Utils_System
::url('civicrm/contact/view/membership',
2946 'reset=1&action=add&context=membership'
2948 'permissions' => array(
2949 'access CiviMember',
2954 'title' => ts('Add Case'),
2956 'ref' => 'new-case',
2959 'component' => 'CiviCase',
2960 'href' => CRM_Utils_System
::url('civicrm/case/add', 'reset=1&action=add&context=case'),
2961 'permissions' => array('add cases'),
2964 'title' => ts('Add Grant'),
2966 'ref' => 'new-grant',
2969 'component' => 'CiviGrant',
2970 'href' => CRM_Utils_System
::url('civicrm/contact/view/grant',
2971 'reset=1&action=add&context=grant'
2973 'permissions' => array('edit grants'),
2976 'title' => ts('Add Relationship'),
2978 'ref' => 'new-relationship',
2981 'href' => CRM_Utils_System
::url('civicrm/contact/view/rel',
2982 'reset=1&action=add'
2984 'permissions' => array('edit all contacts'),
2987 'title' => ts('Add Note'),
2989 'ref' => 'new-note',
2992 'class' => 'medium-popup',
2993 'href' => CRM_Utils_System
::url('civicrm/contact/view/note',
2994 'reset=1&action=add'
2996 'permissions' => array('edit all contacts'),
2999 'title' => ts('Send an Email'),
3001 'ref' => 'new-email',
3003 'permissions' => array('view all contacts'),
3006 'title' => ts('Add to Group'),
3008 'ref' => 'group-add-contact',
3011 'permissions' => array('edit groups'),
3014 'title' => ts('Tag Contact'),
3016 'ref' => 'tag-contact',
3019 'permissions' => array('edit all contacts'),
3023 CRM_Utils_Hook
::summaryActions($menu, $contactId);
3024 //1. check for component is active.
3025 //2. check for user permissions.
3026 //3. check for acls.
3027 //3. edit and view contact are directly accessible to user.
3029 $aclPermissionedTasks = array(
3034 'group-add-contact',
3038 $corePermission = CRM_Core_Permission
::getPermission();
3040 $config = CRM_Core_Config
::singleton();
3042 $contextMenu = array();
3043 foreach ($menu as $key => $values) {
3044 $componentName = CRM_Utils_Array
::value('component', $values);
3046 // if component action - make sure component is enable.
3047 if ($componentName && !in_array($componentName, $config->enableComponents
)) {
3051 // make sure user has all required permissions.
3052 $hasAllPermissions = FALSE;
3054 $permissions = CRM_Utils_Array
::value('permissions', $values);
3055 if (!is_array($permissions) ||
empty($permissions)) {
3056 $hasAllPermissions = TRUE;
3059 // iterate for required permissions in given permissions array.
3060 if (!$hasAllPermissions) {
3061 $hasPermissions = 0;
3062 foreach ($permissions as $permission) {
3063 if (CRM_Core_Permission
::check($permission)) {
3068 if (count($permissions) == $hasPermissions) {
3069 $hasAllPermissions = TRUE;
3072 // if still user does not have required permissions, check acl.
3073 if (!$hasAllPermissions && $values['ref'] != 'delete-contact') {
3074 if (in_array($values['ref'], $aclPermissionedTasks) &&
3075 $corePermission == CRM_Core_Permission
::EDIT
3077 $hasAllPermissions = TRUE;
3079 elseif (in_array($values['ref'], array(
3082 // grant permissions for these tasks.
3083 $hasAllPermissions = TRUE;
3088 // user does not have necessary permissions.
3089 if (!$hasAllPermissions) {
3093 // build directly accessible action menu.
3094 if (in_array($values['ref'], array(
3098 $contextMenu['primaryActions'][$key] = array(
3099 'title' => $values['title'],
3100 'ref' => $values['ref'],
3101 'class' => CRM_Utils_Array
::value('class', $values),
3102 'key' => $values['key'],
3107 // finally get menu item for -more- action widget.
3108 $contextMenu['moreActions'][$values['weight']] = array(
3109 'title' => $values['title'],
3110 'ref' => $values['ref'],
3111 'href' => CRM_Utils_Array
::value('href', $values),
3112 'tab' => CRM_Utils_Array
::value('tab', $values),
3113 'class' => CRM_Utils_Array
::value('class', $values),
3114 'key' => $values['key'],
3118 ksort($contextMenu['moreActions']);
3120 return $contextMenu;
3124 * Retrieve display name of contact that address is shared.
3126 * This is based on $masterAddressId or $contactId .
3128 * @param int $masterAddressId
3130 * @param int $contactId
3133 * @return string|null
3134 * the found display name or null.
3136 public static function getMasterDisplayName($masterAddressId = NULL, $contactId = NULL) {
3137 $masterDisplayName = NULL;
3139 if (!$masterAddressId && !$contactId) {
3140 return $masterDisplayName;
3143 if ($masterAddressId) {
3145 SELECT display_name from civicrm_contact
3146 LEFT JOIN civicrm_address ON ( civicrm_address.contact_id = civicrm_contact.id )
3147 WHERE civicrm_address.id = " . $masterAddressId;
3149 elseif ($contactId) {
3151 SELECT display_name from civicrm_contact cc, civicrm_address add1
3152 LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id )
3153 WHERE cc.id = add2.contact_id AND add1.contact_id = " . $contactId;
3156 $masterDisplayName = CRM_Core_DAO
::singleValueQuery($sql);
3157 return $masterDisplayName;
3161 * Get the creation/modification times for a contact.
3163 * @param int $contactId
3166 * Dates - ('created_date' => $, 'modified_date' => $)
3168 public static function getTimestamps($contactId) {
3169 $timestamps = CRM_Core_DAO
::executeQuery(
3170 'SELECT created_date, modified_date
3171 FROM civicrm_contact
3174 1 => array($contactId, 'Integer'),
3177 if ($timestamps->fetch()) {
3179 'created_date' => $timestamps->created_date
,
3180 'modified_date' => $timestamps->modified_date
,
3189 * Generate triggers to update the timestamp.
3191 * The corresponding civicrm_contact row is updated on insert/update/delete
3192 * to a table that extends civicrm_contact.
3193 * Don't regenerate triggers for all such tables if only asked for one table.
3195 * @param array $info
3196 * Reference to the array where generated trigger information is being stored
3197 * @param string|null $reqTableName
3198 * Name of the table for which triggers are being generated, or NULL if all tables
3199 * @param array $relatedTableNames
3200 * Array of all core or all custom table names extending civicrm_contact
3201 * @param string $contactRefColumn
3202 * 'contact_id' if processing core tables, 'entity_id' if processing custom tables
3204 * @link https://issues.civicrm.org/jira/browse/CRM-15602
3207 public static function generateTimestampTriggers(&$info, $reqTableName, $relatedTableNames, $contactRefColumn) {
3209 $contactRefColumn = CRM_Core_DAO
::escapeString($contactRefColumn);
3210 // If specific related table requested, just process that one
3211 if (in_array($reqTableName, $relatedTableNames)) {
3212 $relatedTableNames = array($reqTableName);
3215 // If no specific table requested (include all related tables),
3216 // or a specific related table requested (as matched above)
3217 if (empty($reqTableName) ||
in_array($reqTableName, $relatedTableNames)) {
3219 'table' => $relatedTableNames,
3221 'event' => array('INSERT', 'UPDATE'),
3222 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.$contactRefColumn;\n",
3225 'table' => $relatedTableNames,
3227 'event' => array('DELETE'),
3228 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = OLD.$contactRefColumn;\n",
3234 * Get a list of triggers for the contact table.
3236 * @see hook_civicrm_triggerInfo
3237 * @see CRM_Core_DAO::triggerRebuild
3238 * @see http://issues.civicrm.org/jira/browse/CRM-10554
3241 * @param null $tableName
3243 public static function triggerInfo(&$info, $tableName = NULL) {
3244 //during upgrade, first check for valid version and then create triggers
3245 //i.e the columns created_date and modified_date are introduced in 4.3.alpha1 so dont create triggers for older version
3246 if (CRM_Core_Config
::isUpgradeMode()) {
3247 $currentVer = CRM_Core_BAO_Domain
::version(TRUE);
3248 //if current version is less than 4.3.alpha1 dont create below triggers
3249 if (version_compare($currentVer, '4.3.alpha1') < 0) {
3254 // Update timestamp for civicrm_contact itself
3255 if ($tableName == NULL ||
$tableName == self
::getTableName()) {
3257 'table' => array(self
::getTableName()),
3259 'event' => array('INSERT'),
3260 'sql' => "\nSET NEW.created_date = CURRENT_TIMESTAMP;\n",
3264 // Update timestamp when modifying closely related core tables
3265 $relatedTables = array(
3272 self
::generateTimestampTriggers($info, $tableName, $relatedTables, 'contact_id');
3274 // Update timestamp when modifying related custom-data tables
3275 $customGroupTables = array();
3276 $customGroupDAO = CRM_Core_BAO_CustomGroup
::getAllCustomGroupsByBaseEntity('Contact');
3277 $customGroupDAO->is_multiple
= 0;
3278 $customGroupDAO->find();
3279 while ($customGroupDAO->fetch()) {
3280 $customGroupTables[] = $customGroupDAO->table_name
;
3282 if (!empty($customGroupTables)) {
3283 self
::generateTimestampTriggers($info, $tableName, $customGroupTables, 'entity_id');
3286 // Update phone table to populate phone_numeric field
3287 if (!$tableName ||
$tableName == 'civicrm_phone') {
3288 // Define stored sql function needed for phones
3289 CRM_Core_DAO
::executeQuery(self
::DROP_STRIP_FUNCTION_43
);
3290 CRM_Core_DAO
::executeQuery(self
::CREATE_STRIP_FUNCTION_43
);
3292 'table' => array('civicrm_phone'),
3294 'event' => array('INSERT', 'UPDATE'),
3295 'sql' => "\nSET NEW.phone_numeric = civicrm_strip_non_numeric(NEW.phone);\n",
3301 * Check if contact is being used in civicrm_domain based on $contactId.
3303 * @param int $contactId
3307 * true if present else false.
3309 public static function checkDomainContact($contactId) {
3313 $domainId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Domain', $contactId, 'id', 'contact_id');
3324 * Get options for a given contact field.
3326 * @see CRM_Core_DAO::buildOptions
3328 * TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow?
3329 * TODO: In context of chainselect, what to return if e.g. a country has no states?
3331 * @param string $fieldName
3332 * @param string $context
3333 * @see CRM_Core_DAO::buildOptionsContext
3334 * @param array $props
3335 * whatever is known about this dao object.
3337 * @return array|bool
3339 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3341 // Special logic for fields whose options depend on context or properties
3342 switch ($fieldName) {
3343 case 'contact_sub_type':
3344 if (!empty($props['contact_type'])) {
3345 $params['condition'] = "parent_id = (SELECT id FROM civicrm_contact_type WHERE name='{$props['contact_type']}')";
3349 case 'contact_type':
3350 if ($context == 'search') {
3351 // CRM-15495 - EntityRef filters and basic search forms expect this format
3352 // FIXME: Search builder does not
3353 return CRM_Contact_BAO_ContactType
::getSelectElements();
3357 // The contact api supports some related entities so we'll honor that by fetching their options
3360 return CRM_Contact_BAO_GroupContact
::buildOptions('group_id', $context, $props);
3364 $props['entity_table'] = 'civicrm_contact';
3365 return CRM_Core_BAO_EntityTag
::buildOptions('tag_id', $context, $props);
3367 case 'state_province_id':
3368 case 'state_province':
3369 case 'state_province_name':
3374 case 'worldregion_id':
3375 return CRM_Core_BAO_Address
::buildOptions($fieldName, 'get', $props);
3378 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);
3382 * Delete a contact-related object that has an 'is_primary' field.
3384 * Ensures that is_primary gets assigned to another object if available
3385 * Also calls pre/post hooks
3391 public static function deleteObjectWithPrimary($type, $id) {
3392 if (!$id ||
!is_numeric($id)) {
3395 $daoName = "CRM_Core_DAO_$type";
3396 $obj = new $daoName();
3399 if ($obj->fetch()) {
3400 CRM_Utils_Hook
::pre('delete', $type, $id, CRM_Core_DAO
::$_nullArray);
3401 $contactId = $obj->contact_id
;
3407 // is_primary is only relavent if this field belongs to a contact
3409 $dao = new $daoName();
3410 $dao->contact_id
= $contactId;
3411 $dao->is_primary
= 1;
3412 // Pick another record to be primary (if one isn't already)
3413 if (!$dao->find(TRUE)) {
3414 $dao->is_primary
= 0;
3416 if ($dao->fetch()) {
3417 $dao->is_primary
= 1;
3423 CRM_Utils_Hook
::post('delete', $type, $id, $obj);