3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Contact_BAO_Contact_Utils
{
38 * given a contact type, get the contact image
40 * @param string $contactType contact type
41 * @param boolean $urlOnly if we need to return only image url
42 * @param int $contactId contact id
43 * @param boolean $addProfileOverlay if profile overlay class should be added
49 static function getImage($contactType, $urlOnly = FALSE, $contactId = NULL, $addProfileOverlay = TRUE) {
50 static $imageInfo = array();
52 $contactType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, trim($contactType, CRM_Core_DAO
::VALUE_SEPARATOR
));
53 $contactType = $contactType[0];
55 if (!array_key_exists($contactType, $imageInfo)) {
56 $imageInfo[$contactType] = array();
59 $params = array('name' => $contactType);
60 CRM_Contact_BAO_ContactType
::retrieve($params, $typeInfo);
62 if (!empty($typeInfo['image_URL'])) {
63 $imageUrl = $typeInfo['image_URL'];
64 $config = CRM_Core_Config
::singleton();
66 if (!preg_match("/^(\/|(http(s)?:)).+$/i", $imageUrl)) {
67 $imageUrl = $config->resourceBase
. $imageUrl;
69 $imageInfo[$contactType]['image'] = "<div class=\"icon crm-icon {$typeInfo['name']}-icon\" style=\"background: url('{$imageUrl}')\" title=\"{$contactType}\"></div>";
70 $imageInfo[$contactType]['url'] = $imageUrl;
73 $isSubtype = (array_key_exists('parent_id', $typeInfo) &&
74 $typeInfo['parent_id']
78 $type = CRM_Contact_BAO_ContactType
::getBasicType($typeInfo['name']) . '-subtype';
81 $type = CRM_Utils_Array
::value('name', $typeInfo);
84 // do not add title since it hides contact name
85 if ($addProfileOverlay) {
86 $imageInfo[$contactType]['image'] = "<div class=\"icon crm-icon {$type}-icon\"></div>";
89 $imageInfo[$contactType]['image'] = "<div class=\"icon crm-icon {$type}-icon\" title=\"{$contactType}\"></div>";
91 $imageInfo[$contactType]['url'] = NULL;
95 if ($addProfileOverlay) {
96 static $summaryOverlayProfileId = NULL;
97 if (!$summaryOverlayProfileId) {
98 $summaryOverlayProfileId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', 'summary_overlay', 'id', 'name');
101 $profileURL = CRM_Utils_System
::url('civicrm/profile/view',
102 "reset=1&gid={$summaryOverlayProfileId}&id={$contactId}&snippet=4"
105 $imageInfo[$contactType]['summary-link'] = '<a href="' . $profileURL . '" class="crm-summary-link">' . $imageInfo[$contactType]['image'] . '</a>';
108 $imageInfo[$contactType]['summary-link'] = $imageInfo[$contactType]['image'];
111 return $urlOnly ?
$imageInfo[$contactType]['url'] : $imageInfo[$contactType]['summary-link'];
115 * function check for mix contact ids(individual+household etc...)
117 * @param array $contactIds array of contact ids
119 * @return boolen true or false true if mix contact array else fale
124 public static function checkContactType(&$contactIds) {
125 if (empty($contactIds)) {
129 $idString = implode(',', $contactIds);
131 SELECT count( DISTINCT contact_type )
133 WHERE id IN ( $idString )
135 $count = CRM_Core_DAO
::singleValueQuery($query,
136 CRM_Core_DAO
::$_nullArray
138 return $count > 1 ?
TRUE : FALSE;
142 * Generate a checksum for a $entityId of type $entityType
144 * @param int $entityId
145 * @param int $ts timestamp that checksum was generated
146 * @param int $live life of this checksum in hours/ 'inf' for infinite
147 * @param string $hash contact hash, if sent, prevents a query in inner loop
149 * @param string $entityType
150 * @param null $hashSize
152 * @return array ( $cs, $ts, $live )
156 static function generateChecksum($entityId, $ts = NULL, $live = NULL, $hash = NULL, $entityType = 'contact', $hashSize = NULL) {
157 // return a warning message if we dont get a entityId
158 // this typically happens when we do a message preview
159 // or an anon mailing view - CRM-8298
161 return 'invalidChecksum';
165 if ($entityType == 'contact') {
166 $hash = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
170 elseif ($entityType == 'mailing') {
171 $hash = CRM_Core_DAO
::getFieldValue('CRM_Mailing_DAO_Mailing',
178 $hash = md5(uniqid(rand(), TRUE));
180 $hash = substr($hash, 0, $hashSize);
183 if ($entityType == 'contact') {
184 CRM_Core_DAO
::setFieldValue('CRM_Contact_DAO_Contact',
189 elseif ($entityType == 'mailing') {
190 CRM_Core_DAO
::setFieldValue('CRM_Mailing_DAO_Mailing',
202 $days = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
210 $cs = md5("{$hash}_{$entityId}_{$ts}_{$live}");
211 return "{$cs}_{$ts}_{$live}";
215 * Make sure the checksum is valid for the passed in contactID
217 * @param int $contactID
218 * @param string $inputCheck checksum to match against
220 * @return boolean true if valid, else false
224 static function validChecksum($contactID, $inputCheck) {
226 $input = CRM_Utils_System
::explode('_', $inputCheck, 3);
228 $inputCS = CRM_Utils_Array
::value(0, $input);
229 $inputTS = CRM_Utils_Array
::value(1, $input);
230 $inputLF = CRM_Utils_Array
::value(2, $input);
232 $check = self
::generateChecksum($contactID, $inputTS, $inputLF);
234 if ($check != $inputCheck) {
238 // no life limit for checksum
239 if ($inputLF == 'inf') {
243 // checksum matches so now check timestamp
245 return ($inputTS +
($inputLF * 60 * 60) >= $now);
249 * Function to get the count of contact loctions
251 * @param int $contactId contact id
253 * @return int $locationCount max locations for the contact
257 static function maxLocations($contactId) {
258 $contactLocations = array();
260 // find number of location blocks for this contact and adjust value accordinly
261 // get location type from email
263 ( SELECT location_type_id FROM civicrm_email WHERE contact_id = {$contactId} )
265 ( SELECT location_type_id FROM civicrm_phone WHERE contact_id = {$contactId} )
267 ( SELECT location_type_id FROM civicrm_im WHERE contact_id = {$contactId} )
269 ( SELECT location_type_id FROM civicrm_address WHERE contact_id = {$contactId} )
271 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
276 * Create Current employer relationship for a individual
278 * @param int $contactID contact id of the individual
279 * @param $organization (id or name)
280 * @param null $previousEmployerID
282 * @internal param string $organization it can be name or id of organization
287 static function createCurrentEmployerRelationship($contactID, $organization, $previousEmployerID = NULL, $newContact = FALSE) {
288 //if organization name is passed. CRM-15368,CRM-15547
289 if ($organization && !is_numeric($organization)) {
290 $organizationParams['organization_name'] = $organization;
291 $dedupeParams = CRM_Dedupe_Finder
::formatParams($organizationParams, 'Organization');
293 $dedupeParams['check_permission'] = FALSE;
294 $dupeIDs = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, 'Organization', 'Supervised');
296 if (is_array($dupeIDs) && !empty($dupeIDs)) {
297 // we should create relationship only w/ first org CRM-4193
298 foreach ($dupeIDs as $orgId) {
299 $organization = $orgId;
304 //create new organization
306 'contact_type' => 'Organization',
307 'organization_name' => $organization,
309 $org = CRM_Contact_BAO_Contact
::create($newOrg);
310 $organization = $org->id
;
314 if ($organization && is_numeric($organization)) {
315 $cid = array('contact' => $contactID);
317 // get the relationship type id of "Employee of"
318 $relTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType', 'Employee of', 'id', 'name_a_b');
320 CRM_Core_Error
::fatal(ts("You seem to have deleted the relationship type 'Employee of'"));
323 // create employee of relationship
324 $relationshipParams = array(
326 'relationship_type_id' => $relTypeId . '_a_b',
327 'contact_check' => array($organization => TRUE),
329 list($valid, $invalid, $duplicate,
330 $saved, $relationshipIds
331 ) = CRM_Contact_BAO_Relationship
::create($relationshipParams, $cid);
334 // In case we change employer, clean previous employer related records.
335 if (!$previousEmployerID && !$newContact) {
336 $previousEmployerID = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'employer_id');
338 if ($previousEmployerID &&
339 $previousEmployerID != $organization
341 self
::clearCurrentEmployer($contactID, $previousEmployerID);
344 // set current employer
345 self
::setCurrentEmployer(array($contactID => $organization));
347 $relationshipParams['relationship_ids'] = $relationshipIds;
348 // handle related meberships. CRM-3792
349 self
::currentEmployerRelatedMembership($contactID, $organization, $relationshipParams, $duplicate, $previousEmployerID);
354 * create related memberships for current employer
356 * @param int $contactID contact id of the individual
357 * @param int $employerID contact id of the organization.
358 * @param array $relationshipParams relationship params.
359 * @param boolean $duplicate are we triggered existing relationship.
361 * @param null $previousEmpID
363 * @throws CiviCRM_API3_Exception
367 static function currentEmployerRelatedMembership($contactID, $employerID, $relationshipParams, $duplicate = FALSE, $previousEmpID = NULL) {
369 $action = CRM_Core_Action
::ADD
;
371 //we do not know that triggered relationship record is active.
373 $relationship = new CRM_Contact_DAO_Relationship();
374 $relationship->contact_id_a
= $contactID;
375 $relationship->contact_id_b
= $employerID;
376 $relationship->relationship_type_id
= $relationshipParams['relationship_type_id'];
377 if ($relationship->find(TRUE)) {
378 $action = CRM_Core_Action
::UPDATE
;
379 $ids['contact'] = $contactID;
380 $ids['contactTarget'] = $employerID;
381 $ids['relationship'] = $relationship->id
;
382 CRM_Contact_BAO_Relationship
::setIsActive($relationship->id
, TRUE);
384 $relationship->free();
387 //need to handle related meberships. CRM-3792
388 if ($previousEmpID != $employerID) {
389 CRM_Contact_BAO_Relationship
::relatedMemberships($contactID, $relationshipParams, $ids, $action);
394 * Function to set current employer id and organization name
396 * @param array $currentEmployerParams associated array of contact id and its employer id
399 static function setCurrentEmployer($currentEmployerParams) {
400 foreach ($currentEmployerParams as $contactId => $orgId) {
401 $query = "UPDATE civicrm_contact contact_a,civicrm_contact contact_b
402 SET contact_a.employer_id=contact_b.id, contact_a.organization_name=contact_b.organization_name
403 WHERE contact_a.id ={$contactId} AND contact_b.id={$orgId}; ";
405 //FIXME : currently civicrm mysql_query support only single statement
406 //execution, though mysql 5.0 support multiple statement execution.
407 $dao = CRM_Core_DAO
::executeQuery($query);
412 * Function to update cached current employer name
414 * @param int $organizationId current employer id
417 static function updateCurrentEmployer($organizationId) {
418 $query = "UPDATE civicrm_contact contact_a,civicrm_contact contact_b
419 SET contact_a.organization_name=contact_b.organization_name
420 WHERE contact_a.employer_id=contact_b.id AND contact_b.id={$organizationId}; ";
422 $dao = CRM_Core_DAO
::executeQuery($query);
426 * Function to clear cached current employer name
428 * @param int $contactId contact id ( mostly individual contact id)
429 * @param int $employerId contact id ( mostly organization contact id)
432 static function clearCurrentEmployer($contactId, $employerId = NULL) {
433 $query = "UPDATE civicrm_contact
434 SET organization_name=NULL, employer_id = NULL
435 WHERE id={$contactId}; ";
437 $dao = CRM_Core_DAO
::executeQuery($query);
439 // need to handle related meberships. CRM-3792
441 //1. disable corresponding relationship.
442 //2. delete related membership.
444 //get the relationship type id of "Employee of"
445 $relTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType', 'Employee of', 'id', 'name_a_b');
447 CRM_Core_Error
::fatal(ts("You seem to have deleted the relationship type 'Employee of'"));
449 $relMembershipParams['relationship_type_id'] = $relTypeId . '_a_b';
450 $relMembershipParams['contact_check'][$employerId] = 1;
452 //get relationship id.
453 if (CRM_Contact_BAO_Relationship
::checkDuplicateRelationship($relMembershipParams, $contactId, $employerId)) {
454 $relationship = new CRM_Contact_DAO_Relationship();
455 $relationship->contact_id_a
= $contactId;
456 $relationship->contact_id_b
= $employerId;
457 $relationship->relationship_type_id
= $relTypeId;
459 if ($relationship->find(TRUE)) {
460 CRM_Contact_BAO_Relationship
::setIsActive($relationship->id
, FALSE);
461 CRM_Contact_BAO_Relationship
::relatedMemberships($contactId, $relMembershipParams,
463 ), CRM_Core_Action
::DELETE
466 $relationship->free();
472 * Function to build form for related contacts / on behalf of organization.
474 * @param $form object invoking Object
475 * @param $contactType string contact type
478 * @param $title string fieldset title
480 * @internal param int $maxLocationBlocks number of location blocks
484 static function buildOnBehalfForm(&$form, $contactType, $countryID, $stateID, $title) {
486 $config = CRM_Core_Config
::singleton();
488 $form->assign('contact_type', $contactType);
489 $form->assign('fieldSetTitle', $title);
490 $form->assign('contactEditMode', TRUE);
492 $attributes = CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact');
493 if ($form->_contactId
) {
494 $form->assign('orgId', $form->_contactId
);
497 switch ($contactType) {
499 $form->add('text', 'organization_name', ts('Organization Name'), $attributes['organization_name'], TRUE);
503 $form->add('text', 'household_name', ts('Household Name'), $attributes['household_name']);
508 $form->addElement('select', 'prefix_id', ts('Prefix'),
509 array('' => ts('- prefix -')) + CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'prefix_id')
511 $form->addElement('text', 'first_name', ts('First Name'),
512 $attributes['first_name']
514 $form->addElement('text', 'middle_name', ts('Middle Name'),
515 $attributes['middle_name']
517 $form->addElement('text', 'last_name', ts('Last Name'),
518 $attributes['last_name']
520 $form->addElement('select', 'suffix_id', ts('Suffix'),
521 array('' => ts('- suffix -')) + CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'suffix_id')
525 $addressSequence = $config->addressSequence();
526 $form->assign('addressSequence', array_fill_keys($addressSequence, 1));
529 $form->addElement('text',
532 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Phone',
537 $form->addElement('text',
540 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Email',
544 //build the address block
545 CRM_Contact_Form_Edit_Address
::buildQuickForm($form);
549 * Function to clear cache employer name and employer id
550 * of all employee when employer get deleted.
552 * @param int $employerId contact id of employer ( organization id )
555 static function clearAllEmployee($employerId) {
557 UPDATE civicrm_contact
558 SET organization_name=NULL, employer_id = NULL
559 WHERE employer_id={$employerId}; ";
561 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
565 * Given an array of contact ids this function will return array with links to view contact page
567 * @param array $contactIDs associated contact id's
568 * @param bool $addViewLink
569 * @param bool $addEditLink
570 * @param int $originalId associated with the contact which is edited
573 * @return array $contactViewLinks returns array with links to contact view
577 static function formatContactIDSToLinks($contactIDs, $addViewLink = TRUE, $addEditLink = TRUE, $originalId = NULL) {
578 $contactLinks = array();
579 if (!is_array($contactIDs) ||
empty($contactIDs)) {
580 return $contactLinks;
583 // does contact has sufficient permissions.
584 $permissions = array(
585 'view' => 'view all contacts',
586 'edit' => 'edit all contacts',
587 'merge' => 'merge duplicate contacts',
590 $permissionedContactIds = array();
591 foreach ($permissions as $task => $permission) {
593 if (CRM_Core_Permission
::check($permission)) {
594 foreach ($contactIDs as $contactId) {
595 $permissionedContactIds[$contactId][$task] = TRUE;
600 // check permission on acl basis.
601 if (in_array($task, array(
603 $aclPermission = CRM_Core_Permission
::VIEW
;
604 if ($task == 'edit') {
605 $aclPermission = CRM_Core_Permission
::EDIT
;
607 foreach ($contactIDs as $contactId) {
608 if (CRM_Contact_BAO_Contact_Permission
::allow($contactId, $aclPermission)) {
609 $permissionedContactIds[$contactId][$task] = TRUE;
615 // retrieve display names for all contacts
617 SELECT c.id, c.display_name, c.contact_type, ce.email
618 FROM civicrm_contact c
619 LEFT JOIN civicrm_email ce ON ( ce.contact_id=c.id AND ce.is_primary = 1 )
620 WHERE c.id IN (' . implode(',', $contactIDs) . ' ) LIMIT 20';
622 $dao = CRM_Core_DAO
::executeQuery($query);
624 $contactLinks['msg'] = NULL;
626 while ($dao->fetch()) {
628 $contactLinks['rows'][$i]['display_name'] = $dao->display_name
;
629 $contactLinks['rows'][$i]['primary_email'] = $dao->email
;
631 // get the permission for current contact id.
632 $hasPermissions = CRM_Utils_Array
::value($dao->id
, $permissionedContactIds);
633 if (!is_array($hasPermissions) ||
empty($hasPermissions)) {
638 // do check for view.
639 if (array_key_exists('view', $hasPermissions)) {
640 $contactLinks['rows'][$i]['view'] = '<a class="action-item" href="' . CRM_Utils_System
::url('civicrm/contact/view', 'reset=1&cid=' . $dao->id
) . '" target="_blank">' . ts('View') . '</a>';
641 if (!$contactLinks['msg']) {
642 $contactLinks['msg'] = 'view';
645 if (array_key_exists('edit', $hasPermissions)) {
646 $contactLinks['rows'][$i]['edit'] = '<a class="action-item" href="' . CRM_Utils_System
::url('civicrm/contact/add', 'reset=1&action=update&cid=' . $dao->id
) . '" target="_blank">' . ts('Edit') . '</a>';
647 if (!$contactLinks['msg'] ||
$contactLinks['msg'] != 'merge') {
648 $contactLinks['msg'] = 'edit';
651 if (!empty($originalId) && array_key_exists('merge', $hasPermissions)) {
652 $rgBao = new CRM_Dedupe_BAO_RuleGroup();
653 $rgBao->contact_type
= $dao->contact_type
;
654 $rgBao->used
= 'Supervised';
655 if ($rgBao->find(TRUE)) {
658 if ($rgid && isset($dao->id
)) {
659 //get an url to merge the contact
660 $contactLinks['rows'][$i]['merge'] = '<a class="action-item" href="' . CRM_Utils_System
::url('civicrm/contact/merge', "reset=1&cid=" . $originalId . '&oid=' . $dao->id
. '&action=update&rgid=' . $rgid) . '">' . ts('Merge') . '</a>';
661 $contactLinks['msg'] = 'merge';
668 return $contactLinks;
672 * This function retrieve component related contact information.
674 * @param array $componentIds array of component Ids.
675 * @param $componentName
676 * @param array $returnProperties array of return elements.
678 * @return array $contactDetails array of contact info.@static
680 static function contactDetails($componentIds, $componentName, $returnProperties = array(
682 $contactDetails = array();
683 if (empty($componentIds) ||
684 !in_array($componentName, array('CiviContribute', 'CiviMember', 'CiviEvent', 'Activity'))
686 return $contactDetails;
689 if (empty($returnProperties)) {
690 $autocompleteContactSearch = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
691 'contact_autocomplete_options'
693 $returnProperties = array_fill_keys(array_merge(array('sort_name'),
694 array_keys($autocompleteContactSearch)
699 if ($componentName == 'CiviContribute') {
700 $compTable = 'civicrm_contribution';
702 elseif ($componentName == 'CiviMember') {
703 $compTable = 'civicrm_membership';
705 elseif ($componentName == 'Activity') {
706 $compTable = 'civicrm_activity';
707 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
710 $compTable = 'civicrm_participant';
713 $select = $from = array();
714 foreach ($returnProperties as $property => $ignore) {
715 $value = (in_array($property, array(
716 'city', 'street_address'))) ?
'address' : $property;
719 if ($componentName == 'Activity') {
720 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
721 $select[] = "contact.$property as $property";
723 INNER JOIN civicrm_activity_contact acs ON (acs.activity_id = {$compTable}.id AND acs.record_type_id = {$sourceID})
724 INNER JOIN civicrm_contact contact ON ( contact.id = acs.contact_id )";
727 $select[] = "$property as $property";
728 $from[$value] = "INNER JOIN civicrm_contact contact ON ( contact.id = $compTable.contact_id )";
732 case 'target_sort_name':
733 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
734 $select[] = "contact_target.sort_name as $property";
736 INNER JOIN civicrm_activity_contact act ON (act.activity_id = {$compTable}.id AND act.record_type_id = {$targetID})
737 INNER JOIN civicrm_contact contact_target ON ( contact_target.id = act.contact_id )";
743 case 'street_address':
744 $select[] = "$property as $property";
745 // Grab target contact properties if this is for activity
746 if ($componentName == 'Activity') {
747 $from[$value] = "LEFT JOIN civicrm_{$value} {$value} ON ( contact_target.id = {$value}.contact_id AND {$value}.is_primary = 1 ) ";
750 $from[$value] = "LEFT JOIN civicrm_{$value} {$value} ON ( contact.id = {$value}.contact_id AND {$value}.is_primary = 1 ) ";
755 case 'state_province':
756 $select[] = "{$property}.name as $property";
757 if (!in_array('address', $from)) {
758 // Grab target contact properties if this is for activity
759 if ($componentName == 'Activity') {
760 $from['address'] = 'LEFT JOIN civicrm_address address ON ( contact_target.id = address.contact_id AND address.is_primary = 1) ';
763 $from['address'] = 'LEFT JOIN civicrm_address address ON ( contact.id = address.contact_id AND address.is_primary = 1) ';
766 $from[$value] = " LEFT JOIN civicrm_{$value} {$value} ON ( address.{$value}_id = {$value}.id ) ";
771 //finally retrieve contact details.
772 if (!empty($select) && !empty($from)) {
773 $fromClause = implode(' ', $from);
774 $selectClause = implode(', ', $select);
775 $whereClause = "{$compTable}.id IN (" . implode(',', $componentIds) . ')';
778 SELECT contact.id as contactId, $compTable.id as componentId, $selectClause
779 FROM $compTable as $compTable $fromClause
781 Group By componentId";
783 $contact = CRM_Core_DAO
::executeQuery($query);
784 while ($contact->fetch()) {
785 $contactDetails[$contact->componentId
]['contact_id'] = $contact->contactId
;
786 foreach ($returnProperties as $property => $ignore) {
787 $contactDetails[$contact->componentId
][$property] = $contact->$property;
793 return $contactDetails;
797 * Function handles shared contact address processing
798 * In this function we just modify submitted values so that new address created for the user
799 * has same address as shared contact address. We copy the address so that search etc will be
802 * @param array $address this is associated array which contains submitted form values
808 static function processSharedAddress(&$address) {
809 if (!is_array($address)) {
813 // Sharing contact address during create mode is pretty straight forward.
814 // In update mode we should check following:
815 // - We should check if user has uncheck shared contact address
816 // - If yes then unset the master_id or may be just delete the address that copied master
817 // Normal update process will automatically create new address with submitted values
819 // 1. loop through entire subnitted address array
820 $masterAddress = array();
821 $skipFields = array('is_primary', 'location_type_id', 'is_billing', 'master_id');
822 foreach ($address as & $values) {
823 // 2. check if master id exists, if not continue
824 if (empty($values['master_id']) ||
empty($values['use_shared_address'])) {
825 // we should unset master id when use uncheck share address for existing address
826 $values['master_id'] = 'null';
830 // 3. get the address details for master_id
831 $masterAddress = new CRM_Core_BAO_Address();
832 $masterAddress->id
= CRM_Utils_Array
::value('master_id', $values);
833 $masterAddress->find(TRUE);
835 // 4. modify submitted params and update it with shared contact address
836 // make sure you preserve specific form values like location type, is_primary_ is_billing, master_id
837 // CRM-10336: Also empty any fields from the existing address block if they don't exist in master (otherwise they will persist)
838 foreach ($values as $field => $submittedValue) {
839 if (!in_array($field, $skipFields)){
840 if (isset($masterAddress->$field)) {
841 $values[$field] = $masterAddress->$field;
843 $values[$field] = '';
851 * Function to get the list of contact name give address associated array
853 * @param array $addresses associated array of
855 * @return array $contactNames associated array of contact names@static
857 static function getAddressShareContactNames(&$addresses) {
858 $contactNames = array();
859 // get the list of master id's for address
860 $masterAddressIds = array();
861 foreach ($addresses as $key => $addressValue) {
862 if (!empty($addressValue['master_id'])) {
863 $masterAddressIds[] = $addressValue['master_id'];
867 if (!empty($masterAddressIds)) {
868 $query = 'SELECT ca.id, cc.display_name, cc.id as cid, cc.is_deleted
869 FROM civicrm_contact cc
870 INNER JOIN civicrm_address ca ON cc.id = ca.contact_id
871 WHERE ca.id IN ( ' . implode(',', $masterAddressIds) . ')';
872 $dao = CRM_Core_DAO
::executeQuery($query);
874 while ($dao->fetch()) {
875 $contactViewUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$dao->cid}");
876 $contactNames[$dao->id
] = array(
877 'name' => "<a href='{$contactViewUrl}'>{$dao->display_name}</a>",
878 'is_deleted' => $dao->is_deleted
,
879 'contact_id' => $dao->cid
,
883 return $contactNames;
887 * Clear the contact cache so things are kosher. We started off being super aggressive with clearing
888 * caches, but are backing off from this with every release. Compromise between ease of coding versus
889 * performance versus being accurate at that very instant
891 * @param $contactID - the contactID that was edited / deleted
896 static function clearContactCaches($contactID = NULL) {
897 // clear acl cache if any.
898 CRM_ACL_BAO_Cache
::resetCache();
900 if (empty($contactID)) {
901 // also clear prev/next dedupe cache - if no contactID passed in
902 CRM_Core_BAO_PrevNextCache
::deleteItem();
905 // reset the group contact cache for this group
906 CRM_Contact_BAO_GroupContactCache
::remove();
914 public static function updateGreeting($params) {
915 $contactType = $params['ct'];
916 $greeting = $params['gt'];
917 $valueID = $id = CRM_Utils_Array
::value('id', $params);
918 $force = CRM_Utils_Array
::value('force', $params);
919 $limit = CRM_Utils_Array
::value('limit', $params);
921 // if valueID is not passed use default value
923 $valueID = $id = self
::defaultGreeting($contactType, $greeting);
927 'contact_type' => $contactType,
928 'greeting_type' => $greeting,
931 $allGreetings = CRM_Core_PseudoConstant
::greeting($filter);
932 $originalGreetingString = $greetingString = CRM_Utils_Array
::value($valueID, $allGreetings);
933 if (!$greetingString) {
934 CRM_Core_Error
::fatal(ts('Incorrect greeting value id %1, or no default greeting for this contact type and greeting type.', array(1 => $valueID)));
937 // build return properties based on tokens
938 $greetingTokens = CRM_Utils_Token
::getTokens($greetingString);
939 $tokens = CRM_Utils_Array
::value('contact', $greetingTokens);
940 $greetingsReturnProperties = array();
941 if (is_array($tokens)) {
942 $greetingsReturnProperties = array_fill_keys(array_values($tokens), 1);
945 // Process ALL contacts only when force=1 or force=2 is passed. Else only contacts with NULL greeting or addressee value are updated.
946 $processAll = $processOnlyIdSet = FALSE;
950 elseif ($force == 2) {
951 $processOnlyIdSet = TRUE;
954 //FIXME : apiQuery should handle these clause.
955 $filterContactFldIds = $filterIds = array();
956 $idFldName = $displayFldName = NULL;
957 if (in_array($greeting, CRM_Contact_BAO_Contact
::$_greetingTypes)) {
958 $idFldName = $greeting . '_id';
959 $displayFldName = $greeting . '_display';
963 $queryParams = array(1 => array($contactType, 'String'));
965 // if $force == 1 then update all contacts else only
966 // those with NULL greeting or addressee value CRM-9476
968 $sql = "SELECT DISTINCT id, $idFldName FROM civicrm_contact WHERE contact_type = %1 ";
972 SELECT DISTINCT id, $idFldName
974 WHERE contact_type = %1
975 AND ({$idFldName} IS NULL
976 OR ( {$idFldName} IS NOT NULL AND ({$displayFldName} IS NULL OR {$displayFldName} = '')) )";
980 $sql .= " LIMIT 0, %2";
981 $queryParams +
= array(2 => array($limit, 'Integer'));
984 $dao = CRM_Core_DAO
::executeQuery($sql, $queryParams);
985 while ($dao->fetch()) {
986 $filterContactFldIds[$dao->id
] = $dao->$idFldName;
988 if (!CRM_Utils_System
::isNull($dao->$idFldName)) {
989 $filterIds[$dao->id
] = $dao->$idFldName;
994 if (empty($filterContactFldIds)) {
995 $filterContactFldIds[] = 0;
998 // retrieve only required contact information
999 $extraParams[] = array('contact_type', '=', $contactType, 0, 0);
1000 // we do token replacement in the replaceGreetingTokens hook
1001 list($greetingDetails) = CRM_Utils_Token
::getTokenDetails(array_keys($filterContactFldIds),
1002 $greetingsReturnProperties,
1003 FALSE, FALSE, $extraParams
1005 // perform token replacement and build update SQL
1006 $contactIds = array();
1007 $cacheFieldQuery = "UPDATE civicrm_contact SET {$greeting}_display = CASE id ";
1008 foreach ($greetingDetails as $contactID => $contactDetails) {
1010 !array_key_exists($contactID, $filterContactFldIds)
1015 if ($processOnlyIdSet && !array_key_exists($contactID, $filterIds)) {
1020 $greetingString = $originalGreetingString;
1021 $contactIds[] = $contactID;
1024 if ($greetingBuffer = CRM_Utils_Array
::value($filterContactFldIds[$contactID], $allGreetings)) {
1025 $greetingString = $greetingBuffer;
1029 self
::processGreetingTemplate($greetingString, $contactDetails, $contactID, 'CRM_UpdateGreeting');
1030 $greetingString = CRM_Core_DAO
::escapeString($greetingString);
1031 $cacheFieldQuery .= " WHEN {$contactID} THEN '{$greetingString}' ";
1033 $allContactIds[] = $contactID;
1036 if (!empty($allContactIds)) {
1037 $cacheFieldQuery .= " ELSE {$greeting}_display
1039 if (!empty($contactIds)) {
1040 // need to update greeting _id field.
1041 // reset greeting _custom
1042 $resetCustomGreeting = '';
1043 if ($valueID != 4) {
1044 $resetCustomGreeting = ", {$greeting}_custom = NULL ";
1048 UPDATE civicrm_contact
1049 SET {$greeting}_id = {$valueID}
1050 {$resetCustomGreeting}
1051 WHERE id IN (" . implode(',', $contactIds) . ")";
1052 CRM_Core_DAO
::executeQuery($queryString);
1055 // now update cache field
1056 CRM_Core_DAO
::executeQuery($cacheFieldQuery);
1061 * Fetch the default greeting for a given contact type
1063 * @param string $contactType contact type
1064 * @param string $greetingType greeting type
1066 * @return int or null
1068 static function defaultGreeting($contactType, $greetingType) {
1069 $contactTypeFilters = array('Individual' => 1, 'Household' => 2, 'Organization' => 3);
1070 if (!isset($contactTypeFilters[$contactType])) {
1073 $filter = $contactTypeFilters[$contactType];
1075 $id = CRM_Core_OptionGroup
::values($greetingType, NULL, NULL, NULL,
1076 " AND is_default = 1 AND (filter = {$filter} OR filter = 0)",
1080 return current($id);
1085 * Process a greeting template string to produce the individualised greeting text.
1087 * This works just like message templates for mailings:
1088 * the template is processed with the token substitution mechanism,
1089 * to supply the individual contact data;
1090 * and it is also processed with Smarty,
1091 * to allow for conditionals etc. based on the contact data.
1093 * Note: We don't pass any variables to Smarty --
1094 * all variable data is inserted into the input string
1095 * by the token substitution mechanism,
1096 * before Smarty is invoked.
1098 * @param string $templateString the greeting template string with contact tokens + Smarty syntax
1100 * @param $contactDetails
1107 static function processGreetingTemplate(&$templateString, $contactDetails, $contactID, $className) {
1108 CRM_Utils_Token
::replaceGreetingTokens($templateString, $contactDetails, $contactID, $className, TRUE);
1110 $smarty = CRM_Core_Smarty
::singleton();
1111 $templateString = $smarty->fetch("string:$templateString");