3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
35 class CRM_Contact_BAO_Contact
extends CRM_Contact_DAO_Contact
{
38 * SQL function used to format the phone_numeric field via trigger.
39 * @see self::triggerInfo()
41 * Note that this is also used by the 4.3 upgrade script.
42 * @see CRM_Upgrade_Incremental_php_FourThree
44 const DROP_STRIP_FUNCTION_43
= "DROP FUNCTION IF EXISTS civicrm_strip_non_numeric";
45 const CREATE_STRIP_FUNCTION_43
= "
46 CREATE FUNCTION civicrm_strip_non_numeric(input VARCHAR(255) CHARACTER SET utf8)
47 RETURNS VARCHAR(255) CHARACTER SET utf8
51 DECLARE output VARCHAR(255) CHARACTER SET utf8 DEFAULT '';
52 DECLARE iterator INT DEFAULT 1;
53 WHILE iterator < (LENGTH(input) + 1) DO
54 IF SUBSTRING(input, iterator, 1) IN ('0', '1', '2', '3', '4', '5', '6', '7', '8', '9') THEN
55 SET output = CONCAT(output, SUBSTRING(input, iterator, 1));
57 SET iterator = iterator + 1;
63 * the types of communication preferences
67 static $_commPrefs = array('do_not_phone', 'do_not_email', 'do_not_mail', 'do_not_sms', 'do_not_trade');
74 static $_greetingTypes = array('addressee', 'email_greeting', 'postal_greeting');
77 * static field for all the contact information that we can potentially import
82 static $_importableFields = array();
85 * static field for all the contact information that we can potentially export
90 static $_exportableFields = NULL;
91 function __construct() {
92 parent
::__construct();
96 * takes an associative array and creates a contact object
98 * the function extract all the params it needs to initialize the create a
99 * contact object. the params array could contain additional unused name/value
102 * @param array $params (reference ) an assoc array of name/value pairs
104 * @return object CRM_Contact_BAO_Contact object
108 static function add(&$params) {
109 $contact = new CRM_Contact_DAO_Contact();
111 if (empty($params)) {
115 //fix for validate contact sub type CRM-5143
116 if ( isset( $params['contact_sub_type'] ) ) {
117 if ( empty($params['contact_sub_type']) ) {
118 $params['contact_sub_type'] = 'null';
121 if (!CRM_Contact_BAO_ContactType
::isExtendsContactType($params['contact_sub_type'],
122 $params['contact_type'], TRUE
124 // we'll need to fix tests to handle this
126 CRM_Core_Error
::fatal(ts('The Contact Sub Type does not match the Contact type for this record'));
128 if (is_array($params['contact_sub_type'])) {
129 $params['contact_sub_type'] = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $params['contact_sub_type']) . CRM_Core_DAO
::VALUE_SEPARATOR
;
132 $params['contact_sub_type'] = CRM_Core_DAO
::VALUE_SEPARATOR
. trim($params['contact_sub_type'], CRM_Core_DAO
::VALUE_SEPARATOR
) . CRM_Core_DAO
::VALUE_SEPARATOR
;
139 $params['contact_sub_type'] = 'null';
142 //fixed contact source
143 if (isset($params['contact_source'])) {
144 $params['source'] = $params['contact_source'];
147 //fix for preferred communication method
148 $prefComm = CRM_Utils_Array
::value('preferred_communication_method', $params);
149 if ($prefComm && is_array($prefComm)) {
150 unset($params['preferred_communication_method']);
153 foreach ($prefComm as $k => $v) {
159 $prefComm = $newPref;
160 if (is_array($prefComm) && !empty($prefComm)) {
161 $prefComm = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, array_keys($prefComm)) . CRM_Core_DAO
::VALUE_SEPARATOR
;
162 $contact->preferred_communication_method
= $prefComm;
165 $contact->preferred_communication_method
= '';
169 $allNull = $contact->copyValues($params);
171 $contact->id
= CRM_Utils_Array
::value('contact_id', $params);
173 if ($contact->contact_type
== 'Individual') {
176 //format individual fields
177 CRM_Contact_BAO_Individual
::format($params, $contact);
179 elseif ($contact->contact_type
== 'Household') {
180 if (isset($params['household_name'])) {
182 $contact->display_name
= $contact->sort_name
= CRM_Utils_Array
::value('household_name', $params, '');
185 elseif ($contact->contact_type
== 'Organization') {
186 if (isset($params['organization_name'])) {
188 $contact->display_name
= $contact->sort_name
= CRM_Utils_Array
::value('organization_name', $params, '');
193 $privacy = CRM_Utils_Array
::value('privacy', $params);
195 is_array($privacy) &&
199 foreach (self
::$_commPrefs as $name) {
200 $contact->$name = CRM_Utils_Array
::value($name, $privacy, FALSE);
204 // since hash was required, make sure we have a 0 value for it, CRM-1063
205 // fixed in 1.5 by making hash optional
206 // only do this in create mode, not update
207 if ((!array_key_exists('hash', $contact) ||
!$contact->hash
) && !$contact->id
) {
209 $contact->hash
= md5(uniqid(rand(), TRUE));
212 // Even if we don't need $employerId, it's important to call getFieldValue() before
213 // the contact is saved because we want the existing value to be cached.
214 // createCurrentEmployerRelationship() needs the old value not the updated one. CRM-10788
215 $employerId = empty($contact->id
) ?
NULL : CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contact->id
, 'employer_id');
220 CRM_Core_BAO_Log
::register($contact->id
,
226 if ($contact->contact_type
== 'Individual' &&
227 (isset($params['current_employer']) ||
228 isset($params['employer_id'])
231 // create current employer
232 if (isset($params['employer_id'])) {
233 CRM_Contact_BAO_Contact_Utils
::createCurrentEmployerRelationship($contact->id
,
234 $params['employer_id'], $employerId
237 elseif ($params['current_employer']) {
238 CRM_Contact_BAO_Contact_Utils
::createCurrentEmployerRelationship($contact->id
,
239 $params['current_employer']
243 //unset if employer id exits
245 CRM_Contact_BAO_Contact_Utils
::clearCurrentEmployer($contact->id
, $employerId);
250 //update cached employee name
251 if ($contact->contact_type
== 'Organization') {
252 CRM_Contact_BAO_Contact_Utils
::updateCurrentEmployer($contact->id
);
259 * Function to create contact
260 * takes an associative array and creates a contact object and all the associated
261 * derived objects (i.e. individual, location, email, phone etc)
263 * This function is invoked from within the web form layer and also from the api layer
265 * @param array $params (reference ) an assoc array of name/value pairs
266 * @param boolean $fixAddress if we need to fix address
267 * @param boolean $invokeHooks if we need to invoke hooks
269 * @return object CRM_Contact_BAO_Contact object
273 static function &create(&$params, $fixAddress = TRUE, $invokeHooks = TRUE, $skipDelete = FALSE) {
275 if (!CRM_Utils_Array
::value('contact_type', $params) &&
276 !CRM_Utils_Array
::value('contact_id', $params)
283 if (!empty($params['contact_id'])) {
284 CRM_Utils_Hook
::pre('edit', $params['contact_type'], $params['contact_id'], $params);
287 CRM_Utils_Hook
::pre('create', $params['contact_type'], NULL, $params);
292 $config = CRM_Core_Config
::singleton();
294 // CRM-6942: set preferred language to the current language if it’s unset (and we’re creating a contact)
295 if (empty($params['contact_id']) && empty($params['preferred_language'])) {
296 $params['preferred_language'] = $config->lcMessages
;
299 // CRM-9739: set greeting & addressee if unset and we’re creating a contact
300 if (empty($params['contact_id'])) {
301 foreach (self
::$_greetingTypes as $greeting) {
302 if (empty($params[$greeting . '_id'])) {
303 if ($defaultGreetingTypeId =
304 CRM_Contact_BAO_Contact_Utils
::defaultGreeting($params['contact_type'], $greeting)
306 $params[$greeting . '_id'] = $defaultGreetingTypeId;
312 $transaction = new CRM_Core_Transaction();
314 $contact = self
::add($params);
316 // not dying here is stupid, since we get into wierd situation and into a bug that
317 // is impossible to figure out for the user or for us
319 CRM_Core_Error
::fatal();
322 $params['contact_id'] = $contact->id
;
324 if (CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MULTISITE_PREFERENCES_NAME
,
327 // Enabling multisite causes the contact to be added to the domain group
328 $domainGroupID = CRM_Core_BAO_Domain
::getGroupId();
329 if(!empty($domainGroupID)){
330 if (CRM_Utils_Array
::value('group', $params) && is_array($params['group'])) {
331 $params['group'][$domainGroupID] = 1;
334 $params['group'] = array($domainGroupID => 1);
339 if (array_key_exists('group', $params)) {
340 $contactIds = array($params['contact_id']);
341 foreach ($params['group'] as $groupId => $flag) {
343 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $groupId);
345 elseif ($flag == -1) {
346 CRM_Contact_BAO_GroupContact
::removeContactsFromGroup($contactIds, $groupId);
351 //add location Block data
352 $blocks = CRM_Core_BAO_Location
::create($params, $fixAddress);
353 foreach ($blocks as $name => $value) {
354 $contact->$name = $value;
358 CRM_Core_BAO_Website
::create($params['website'], $contact->id
, $skipDelete);
360 //get userID from session
361 $session = CRM_Core_Session
::singleton();
362 $userID = $session->get('userID');
364 if (CRM_Utils_Array
::value('note', $params)) {
365 if (is_array($params['note'])) {
366 foreach ($params['note'] as $note) {
367 $contactId = $contact->id
;
368 if (isset($note['contact_id'])) {
369 $contactId = $note['contact_id'];
371 //if logged in user, overwrite contactId
373 $contactId = $userID;
377 'entity_id' => $contact->id
,
378 'entity_table' => 'civicrm_contact',
379 'note' => $note['note'],
380 'subject' => CRM_Utils_Array
::value('subject', $note),
381 'contact_id' => $contactId,
383 CRM_Core_BAO_Note
::add($noteParams, CRM_Core_DAO
::$_nullArray);
387 $contactId = $contact->id
;
388 if (isset($note['contact_id'])) {
389 $contactId = $note['contact_id'];
391 //if logged in user, overwrite contactId
393 $contactId = $userID;
397 'entity_id' => $contact->id
,
398 'entity_table' => 'civicrm_contact',
399 'note' => $params['note'],
400 'subject' => CRM_Utils_Array
::value('subject', $params),
401 'contact_id' => $contactId,
403 CRM_Core_BAO_Note
::add($noteParams, CRM_Core_DAO
::$_nullArray);
408 // update the UF user_unique_id if that has changed
409 CRM_Core_BAO_UFMatch
::updateUFName($contact->id
);
411 if (CRM_Utils_Array
::value('custom', $params) &&
412 is_array($params['custom'])
414 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_contact', $contact->id
);
417 // make a civicrm_subscription_history entry only on contact create (CRM-777)
418 if (!CRM_Utils_Array
::value('contact_id', $params)) {
419 $subscriptionParams = array(
420 'contact_id' => $contact->id
,
424 CRM_Contact_BAO_SubscriptionHistory
::create($subscriptionParams);
427 $transaction->commit();
429 // CRM-6367: fetch the right label for contact type’s display
430 $contact->contact_type_display
= CRM_Core_DAO
::getFieldValue(
431 'CRM_Contact_DAO_ContactType',
432 $contact->contact_type
,
437 if (!$config->doNotResetCache
) {
438 // Note: doNotResetCache flag is currently set by import contact process and merging,
439 // since resetting and
440 // rebuilding cache could be expensive (for many contacts). We might come out with better
441 // approach in future.
442 CRM_Contact_BAO_Contact_Utils
::clearContactCaches($contact->id
);
447 CRM_Utils_Hook
::post('edit', $params['contact_type'], $contact->id
, $contact);
450 CRM_Utils_Hook
::post('create', $params['contact_type'], $contact->id
, $contact);
454 // process greetings CRM-4575, cache greetings
455 self
::processGreetings($contact);
461 * Get the display name and image of a contact
463 * @param int $id the contactId
465 * @return array the displayName and contactImage for this contact
469 static function getDisplayAndImage($id, $type = FALSE) {
471 SELECT civicrm_contact.display_name as display_name,
472 civicrm_contact.contact_type as contact_type,
473 civicrm_contact.contact_sub_type as contact_sub_type,
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 $dao->display_name
= $dao->email
;
493 return $type ?
array(
494 $dao->display_name
, $image,
495 $dao->contact_type
, $dao->contact_sub_type
, $imageUrl,
496 ) : array($dao->display_name
, $image, $imageUrl);
503 * Get the values for pseudoconstants for name->value and reverse.
505 * @param array $defaults (reference) the default values, some of which need to be resolved.
506 * @param boolean $reverse true if we want to resolve the values in the reverse direction (value -> name)
512 static function resolveDefaults(&$defaults, $reverse = FALSE) {
513 // hack for birth_date
514 if (CRM_Utils_Array
::value('birth_date', $defaults)) {
515 if (is_array($defaults['birth_date'])) {
516 $defaults['birth_date'] = CRM_Utils_Date
::format($defaults['birth_date'], '-');
520 CRM_Utils_Array
::lookupValue($defaults, 'prefix', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'prefix_id'), $reverse);
521 CRM_Utils_Array
::lookupValue($defaults, 'suffix', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'suffix_id'), $reverse);
522 CRM_Utils_Array
::lookupValue($defaults, 'gender', CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id'), $reverse);
524 //lookup value of email/postal greeting, addressee, CRM-4575
525 foreach (self
::$_greetingTypes as $greeting) {
526 $filterCondition = array('contact_type' => CRM_Utils_Array
::value('contact_type', $defaults),
527 'greeting_type' => $greeting,
529 CRM_Utils_Array
::lookupValue($defaults, $greeting,
530 CRM_Core_PseudoConstant
::greeting($filterCondition), $reverse
534 $blocks = array('address', 'im', 'phone');
535 foreach ($blocks as $name) {
536 if (!array_key_exists($name, $defaults) ||
!is_array($defaults[$name])) {
539 foreach ($defaults[$name] as $count => & $values) {
541 //get location type id.
542 CRM_Utils_Array
::lookupValue($values, 'location_type', CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id'), $reverse);
544 if ($name == 'address') {
545 // FIXME: lookupValue doesn't work for vcard_name
546 if (CRM_Utils_Array
::value('location_type_id', $values)) {
547 $vcardNames = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id', array('labelColumn' => 'vcard_name'));
548 $values['vcard_name'] = $vcardNames[$values['location_type_id']];
551 if (!CRM_Utils_Array
::lookupValue($values,
553 CRM_Core_PseudoConstant
::country(),
558 CRM_Utils_Array
::lookupValue($values,
560 CRM_Core_PseudoConstant
::countryIsoCode(),
566 // if we find a country id above, we need to restrict it to that country
567 // rather than the list of all countries
569 if (!empty($values['country_id'])) {
570 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceForCountry($values['country_id']);
573 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvince();
575 if (!CRM_Utils_Array
::lookupValue($values,
583 if (!empty($values['country_id'])) {
584 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceForCountry($values['country_id'], 'abbreviation');
587 $stateProvinceList = CRM_Core_PseudoConstant
::stateProvinceAbbreviation();
589 CRM_Utils_Array
::lookupValue($values,
596 if (!empty($values['state_province_id'])) {
597 $countyList = CRM_Core_PseudoConstant
::countyForState($values['state_province_id']);
600 $countyList = CRM_Core_PseudoConstant
::county();
602 CRM_Utils_Array
::lookupValue($values,
610 CRM_Utils_Array
::lookupValue($values,
612 CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id'),
617 if ($name == 'phone') {
618 CRM_Utils_Array
::lookupValue($values,
620 CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id'),
625 //kill the reference.
632 * Takes a bunch of params that are needed to match certain criteria and
633 * retrieves the relevant objects. Typically the valid params are only
634 * contact_id. We'll tweak this function to be more full featured over a period
635 * of time. This is the inverse function of create. It also stores all the retrieved
636 * values in the default array
638 * @param array $params (reference ) an assoc array of name/value pairs
639 * @param array $defaults (reference ) an assoc array to hold the name / value pairs
640 * in a hierarchical manner
641 * @param boolean $microformat for location in microformat
643 * @return object CRM_Contact_BAO_Contact object
647 static function &retrieve(&$params, &$defaults, $microformat = FALSE) {
648 if (array_key_exists('contact_id', $params)) {
649 $params['id'] = $params['contact_id'];
651 elseif (array_key_exists('id', $params)) {
652 $params['contact_id'] = $params['id'];
655 $contact = self
::getValues($params, $defaults);
657 unset($params['id']);
659 //get the block information for this contact
660 $entityBlock = array('contact_id' => $params['contact_id']);
661 $blocks = CRM_Core_BAO_Location
::getValues($entityBlock, $microformat);
662 $defaults = array_merge($defaults, $blocks);
663 foreach ($blocks as $block => $value) $contact->$block = $value;
665 if (!isset($params['noNotes'])) {
666 $contact->notes
= CRM_Core_BAO_Note
::getValues($params, $defaults);
669 if (!isset($params['noRelationships'])) {
670 $contact->relationship
= CRM_Contact_BAO_Relationship
::getValues($params, $defaults);
673 if (!isset($params['noGroups'])) {
674 $contact->groupContact
= CRM_Contact_BAO_GroupContact
::getValues($params, $defaults);
677 if (!isset($params['noWebsite'])) {
678 $contact->website
= CRM_Core_BAO_Website
::getValues($params, $defaults);
685 * function to get the display name of a contact
687 * @param int $id id of the contact
689 * @return null|string display name of the contact if found
693 static function displayName($id) {
696 $displayName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $id, 'display_name');
703 * Delete a contact and all its associated records
705 * @param int $id id of the contact to delete
706 * @param bool $restore whether to actually restore, not delete
707 * @param bool $skipUndelete whether to force contact delete or not
709 * @return boolean true if contact deleted, false otherwise
713 static function deleteContact($id, $restore = FALSE, $skipUndelete = FALSE) {
719 // make sure we have edit permission for this contact
721 if (($skipUndelete && !CRM_Core_Permission
::check('delete contacts')) ||
722 ($restore && !CRM_Core_Permission
::check('access deleted contacts'))
728 // Restrict contact to be delete if contact has financial trxns
730 if ($skipUndelete && CRM_Financial_BAO_FinancialItem
::checkContactPresent(array($id), $error)) {
734 // make sure this contact_id does not have any membership types
735 $membershipTypeID = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
738 'member_of_contact_id'
740 if ($membershipTypeID) {
744 $contact = new CRM_Contact_DAO_Contact();
746 if (!$contact->find(TRUE)) {
750 $contactType = $contact->contact_type
;
751 $action = ($restore) ?
'restore' : 'delete';
753 CRM_Utils_Hook
::pre($action, $contactType, $id, CRM_Core_DAO
::$_nullArray);
756 self
::contactTrashRestore($contact, TRUE);
757 CRM_Utils_Hook
::post($action, $contactType, $contact->id
, $contact);
762 // currently we only clear employer cache.
763 // we are not deleting inherited membership if any.
764 if ($contact->contact_type
== 'Organization') {
765 CRM_Contact_BAO_Contact_Utils
::clearAllEmployee($id);
768 // start a new transaction
769 $transaction = new CRM_Core_Transaction();
771 if ($skipUndelete or !CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'contact_undelete', NULL)) {
773 //delete billing address if exists.
774 CRM_Contribute_BAO_Contribution
::deleteAddress(NULL, $id);
776 // delete the log entries since we dont have triggers enabled as yet
777 $logDAO = new CRM_Core_DAO_Log();
778 $logDAO->entity_table
= 'civicrm_contact';
779 $logDAO->entity_id
= $id;
782 // delete contact participants CRM-12155
783 CRM_Event_BAO_Participant
::deleteContactParticipant($id);
785 // delete contact contributions CRM-12155
786 CRM_Contribute_BAO_Contribution
::deleteContactContribution($id);
788 // do activity cleanup, CRM-5604
789 CRM_Activity_BAO_Activity
::cleanupActivity($id);
791 // delete all notes related to contact
792 CRM_Core_BAO_Note
::cleanContactNotes($id);
794 // delete cases related to contact
795 $contactCases = CRM_Case_BAO_Case
::retrieveCaseIdsByContactId($id);
796 if (!empty($contactCases)) {
797 foreach ($contactCases as $caseId) {
798 //check if case is associate with other contact or not.
799 $caseContactId = CRM_Case_BAO_Case
::getCaseClients($caseId);
800 if (count($caseContactId) <= 1) {
801 CRM_Case_BAO_Case
::deleteCase($caseId);
809 self
::contactTrashRestore($contact);
812 //delete the contact id from recently view
813 CRM_Utils_Recent
::delContact($id);
815 // reset the group contact cache for this group
816 CRM_Contact_BAO_GroupContactCache
::remove();
818 // delete any dupe cache entry
819 CRM_Core_BAO_PrevNextCache
::deleteItem($id);
821 $transaction->commit();
823 CRM_Utils_Hook
::post('delete', $contactType, $contact->id
, $contact);
825 // also reset the DB_DO global array so we can reuse the memory
826 // http://issues.civicrm.org/jira/browse/CRM-4387
827 CRM_Core_DAO
::freeResult();
833 * function to delete the image of a contact
835 * @param int $id id of the contact
837 * @return boolean true if contact image is deleted
839 public static function deleteContactImage($id) {
844 UPDATE civicrm_contact
847 CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
852 * function to return relative path
853 * @todo make this a method of $config->userSystem (i.e. UF classes) rather than a static function
855 * @param String $absPath absolute path
857 * @return String $relativePath Relative url of uploaded image
859 public static function getRelativePath($absolutePath) {
860 $relativePath = NULL;
861 $config = CRM_Core_Config
::singleton();
862 if ($config->userFramework
== 'Joomla') {
863 $userFrameworkBaseURL = trim(str_replace('/administrator/', '', $config->userFrameworkBaseURL
));
864 $customFileUploadDirectory = strstr(str_replace('\\', '/', $absolutePath), '/media');
865 $relativePath = $userFrameworkBaseURL . $customFileUploadDirectory;
867 elseif ($config->userSystem
->is_drupal
== '1') {
868 //ideally we would do a bigger re-factoring & move the getRelativePath onto the UF class
869 $rootPath = $config->userSystem
->cmsRootPath();
870 $baseUrl = $config->userFrameworkBaseURL
;
872 //format url for language negotiation, CRM-7135
873 $baseUrl = CRM_Utils_System
::languageNegotiationURL($baseUrl, FALSE, TRUE);
875 $relativePath = str_replace("{$rootPath}/",
877 str_replace('\\', '/', $absolutePath)
879 } else if ( $config->userFramework
== 'WordPress' ) {
880 $userFrameworkBaseURL = trim( str_replace( '/wp-admin/', '', $config->userFrameworkBaseURL
) );
881 $customFileUploadDirectory = strstr( str_replace('\\', '/', $absolutePath), '/wp-content/' );
882 $relativePath = $userFrameworkBaseURL . $customFileUploadDirectory;
885 return $relativePath;
889 * function to return proportional height and width of the image
891 * @param Integer $imageWidth width of image
893 * @param Integer $imageHeight height of image
895 * @return Array thumb dimension of image
897 public static function getThumbSize($imageWidth, $imageHeight) {
899 if ($imageWidth && $imageHeight) {
900 $imageRatio = $imageWidth / $imageHeight;
905 if ($imageRatio > 1) {
906 $imageThumbWidth = $thumbWidth;
907 $imageThumbHeight = round($thumbWidth / $imageRatio);
910 $imageThumbHeight = $thumbWidth;
911 $imageThumbWidth = round($thumbWidth * $imageRatio);
914 return array($imageThumbWidth, $imageThumbHeight);
918 * function to validate type of contact image
920 * @param Array $param array of contact/profile field to be edited/added
922 * @param String $imageIndex index of image field
924 * @param String $statusMsg status message to be set after operation
926 * @opType String $opType type of operation like fatal, bounce etc
928 * @return boolean true if valid image extension
930 public static function processImageParams(&$params,
931 $imageIndex = 'image_URL',
945 if (in_array($params[$imageIndex]['type'], $mimeType)) {
946 $params[$imageIndex] = CRM_Contact_BAO_Contact
::getRelativePath($params[$imageIndex]['name']);
950 unset($params[$imageIndex]);
952 $statusMsg = ts('Image could not be uploaded due to invalid type extension.');
954 if ($opType == 'status') {
955 CRM_Core_Session
::setStatus($statusMsg, 'Sorry', 'error');
957 // FIXME: additional support for fatal, bounce etc could be added.
963 * function to extract contact id from url for deleting contact image
965 public static function processImage() {
967 $action = CRM_Utils_Request
::retrieve('action', 'String', $this);
968 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
969 // retrieve contact id in case of Profile context
970 $id = CRM_Utils_Request
::retrieve('id', 'Positive', $this);
971 $cid = $cid ?
$cid : $id;
972 if ($action & CRM_Core_Action
::DELETE
) {
973 if (CRM_Utils_Request
::retrieve('confirmed', 'Boolean', $this)) {
974 CRM_Contact_BAO_Contact
::deleteContactImage($cid);
975 CRM_Core_Session
::setStatus(ts('Contact image deleted successfully'), ts('Image Deleted'), 'success');
976 $session = CRM_Core_Session
::singleton();
977 $toUrl = $session->popUserContext();
978 CRM_Utils_System
::redirect($toUrl);
984 * Function to set is_delete true or restore deleted contact
986 * @param int $contact Contact DAO object
987 * @param boolean $restore true to set the is_delete = 1 else false to restore deleted contact,
993 static function contactTrashRestore($contact, $restore = FALSE) {
994 $op = ($restore ?
'restore' : 'trash');
996 CRM_Utils_Hook
::pre($op, $contact->contact_type
, $contact->id
, CRM_Core_DAO
::$_nullArray);
998 $params = array(1 => array($contact->id
, 'Integer'));
999 $isDelete = ' is_deleted = 1 ';
1001 $isDelete = ' is_deleted = 0 ';
1004 $query = "DELETE FROM civicrm_uf_match WHERE contact_id = %1";
1005 CRM_Core_DAO
::executeQuery($query, $params);
1008 $query = "UPDATE civicrm_contact SET {$isDelete} WHERE id = %1";
1009 CRM_Core_DAO
::executeQuery($query, $params);
1011 CRM_Utils_Hook
::post($op, $contact->contact_type
, $contact->id
, $contact);
1015 * Get contact type for a contact.
1017 * @param int $id - id of the contact whose contact type is needed
1019 * @return string contact_type if $id found else null ""
1026 public static function getContactType($id) {
1027 return CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_type');
1031 * Get contact sub type for a contact.
1033 * @param int $id - id of the contact whose contact sub type is needed
1035 * @return string contact_sub_type if $id found else null ""
1042 public static function getContactSubType($id, $implodeDelimiter = NULL) {
1043 $subtype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_sub_type');
1045 return $implodeDelimiter ?
NULL : array();
1048 $subtype = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, trim($subtype, CRM_Core_DAO
::VALUE_SEPARATOR
));
1050 if ($implodeDelimiter) {
1051 $subtype = implode($implodeDelimiter, $subtype);
1057 * Get pair of contact-type and sub-type for a contact.
1059 * @param int $id - id of the contact whose contact sub/contact type is needed
1068 public static function getContactTypes($id) {
1069 $params = array('id' => $id);
1071 $contact = CRM_Core_DAO
::commonRetrieve('CRM_Contact_DAO_Contact',
1074 array('contact_type', 'contact_sub_type')
1078 $contactTypes = array();
1079 if ($contact->contact_sub_type
)
1080 $contactTypes = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, trim($contact->contact_sub_type
, CRM_Core_DAO
::VALUE_SEPARATOR
));
1081 array_unshift($contactTypes, $contact->contact_type
);
1083 return $contactTypes;
1086 CRM_Core_Error
::fatal();
1091 * combine all the importable fields from the lower levels object
1093 * The ordering is important, since currently we do not have a weight
1094 * scheme. Adding weight is super important
1096 * @param int $contactType contact Type
1097 * @param boolean $status status is used to manipulate first title
1098 * @param boolean $showAll if true returns all fields (includes disabled fields)
1099 * @param boolean $isProfile if its profile mode
1100 * @param boolean $checkPermission if false, do not include permissioning clause (for custom data)
1102 * @return array array of importable Fields
1106 static function importableFields($contactType = 'Individual',
1110 $checkPermission = TRUE,
1111 $withMultiCustomFields = FALSE
1113 if (empty($contactType)) {
1114 $contactType = 'All';
1117 $cacheKeyString = "importableFields $contactType";
1118 $cacheKeyString .= $status ?
'_1' : '_0';
1119 $cacheKeyString .= $showAll ?
'_1' : '_0';
1120 $cacheKeyString .= $isProfile ?
'_1' : '_0';
1121 $cacheKeyString .= $checkPermission ?
'_1' : '_0';
1123 $fields = CRM_Utils_Array
::value($cacheKeyString, self
::$_importableFields);
1126 // check if we can retrieve from database cache
1127 $fields = CRM_Core_BAO_Cache
::getItem('contact fields', $cacheKeyString);
1131 $fields = CRM_Contact_DAO_Contact
::import();
1133 // get the fields thar are meant for contact types
1134 if (in_array($contactType, array(
1135 'Individual', 'Household', 'Organization', 'All'))) {
1136 $fields = array_merge($fields, CRM_Core_OptionValue
::getFields('', $contactType));
1139 $locationFields = array_merge(CRM_Core_DAO_Address
::import(),
1140 CRM_Core_DAO_Phone
::import(),
1141 CRM_Core_DAO_Email
::import(),
1142 CRM_Core_DAO_IM
::import(TRUE),
1143 CRM_Core_DAO_OpenID
::import()
1146 $locationFields = array_merge($locationFields,
1147 CRM_Core_BAO_CustomField
::getFieldsForImport('Address',
1155 foreach ($locationFields as $key => $field) {
1156 $locationFields[$key]['hasLocationType'] = TRUE;
1159 $fields = array_merge($fields, $locationFields);
1161 $fields = array_merge($fields, CRM_Contact_DAO_Contact
::import());
1162 $fields = array_merge($fields, CRM_Core_DAO_Note
::import());
1165 $fields = array_merge($fields, CRM_Core_DAO_Website
::import());
1167 if ($contactType != 'All') {
1168 $fields = array_merge($fields,
1169 CRM_Core_BAO_CustomField
::getFieldsForImport($contactType,
1174 $withMultiCustomFields
1177 //unset the fields, which are not related to their
1179 $commonValues = array(
1180 'Individual' => array(
1186 'Household' => array(
1192 'individual_prefix',
1193 'individual_suffix',
1195 'organization_name',
1203 'Organization' => array(
1209 'individual_prefix',
1210 'individual_suffix',
1217 foreach ($commonValues[$contactType] as $value) {
1218 unset($fields[$value]);
1223 'Individual', 'Household', 'Organization') as $type) {
1224 $fields = array_merge($fields,
1225 CRM_Core_BAO_CustomField
::getFieldsForImport($type,
1230 $withMultiCustomFields
1237 $fields = array_merge($fields, array(
1239 'title' => ts('Group(s)'),
1243 'title' => ts('Tag(s)'),
1247 'title' => ts('Note(s)'),
1253 //Sorting fields in alphabetical order(CRM-1507)
1254 $fields = CRM_Utils_Array
::crmArraySortByField($fields, 'title');
1256 CRM_Core_BAO_Cache
::setItem($fields, 'contact fields', $cacheKeyString);
1259 self
::$_importableFields[$cacheKeyString] = $fields;
1263 $fields = array_merge(array('do_not_import' => array('title' => ts('- do not import -'))),
1264 self
::$_importableFields[$cacheKeyString]
1268 $fields = array_merge(array('' => array('title' => ts('- Contact Fields -'))),
1269 self
::$_importableFields[$cacheKeyString]
1277 * combine all the exportable fields from the lower levels object
1279 * currentlty we are using importable fields as exportable fields
1281 * @param int $contactType contact Type
1282 * @param boolean $status true while exporting primary contacts
1283 * @param boolean $export true when used during export
1284 * @param boolean $search true when used during search, might conflict with export param?
1286 * @return array array of exportable Fields
1290 static function &exportableFields($contactType = 'Individual', $status = FALSE, $export = FALSE, $search = FALSE, $withMultiRecord = FALSE) {
1291 if (empty($contactType)) {
1292 $contactType = 'All';
1295 $cacheKeyString = "exportableFields $contactType";
1296 $cacheKeyString .= $export ?
'_1' : '_0';
1297 $cacheKeyString .= $status ?
'_1' : '_0';
1298 $cacheKeyString .= $search ?
'_1' : '_0';
1300 if (!self
::$_exportableFields ||
!CRM_Utils_Array
::value($cacheKeyString, self
::$_exportableFields)) {
1301 if (!self
::$_exportableFields) {
1302 self
::$_exportableFields = array();
1305 // check if we can retrieve from database cache
1306 $fields = CRM_Core_BAO_Cache
::getItem('contact fields', $cacheKeyString);
1309 $fields = CRM_Contact_DAO_Contact
::export();
1311 // the fields are meant for contact types
1315 array('Individual', 'Household', 'Organization', 'All')
1318 $fields = array_merge($fields, CRM_Core_OptionValue
::getFields('', $contactType));
1320 // add current employer for individuals
1321 $fields = array_merge($fields, array(
1322 'current_employer' =>
1324 'name' => 'organization_name',
1325 'title' => ts('Current Employer'),
1329 $locationType = array(
1330 'location_type' => array(
1331 'name' => 'location_type',
1332 'where' => 'civicrm_location_type.name',
1333 'title' => ts('Location Type'),
1336 $IMProvider = array(
1337 'im_provider' => array(
1338 'name' => 'im_provider',
1339 'where' => 'civicrm_im.provider_id',
1340 'title' => ts('IM Provider'),
1343 $locationFields = array_merge($locationType,
1344 CRM_Core_DAO_Address
::export(),
1345 CRM_Core_DAO_Phone
::export(),
1346 CRM_Core_DAO_Email
::export(),
1348 CRM_Core_DAO_IM
::export(TRUE),
1349 CRM_Core_DAO_OpenID
::export()
1352 $locationFields = array_merge($locationFields,
1353 CRM_Core_BAO_CustomField
::getFieldsForImport('Address')
1356 foreach ($locationFields as $key => $field) {
1357 $locationFields[$key]['hasLocationType'] = TRUE;
1360 $fields = array_merge($fields, $locationFields);
1363 $fields = array_merge($fields,
1364 CRM_Core_DAO_Worldregion
::export()
1368 $fields = array_merge($fields,
1369 CRM_Contact_DAO_Contact
::export()
1373 $fields = array_merge($fields, CRM_Core_DAO_Website
::export());
1375 if ($contactType != 'All') {
1376 $fields = array_merge($fields,
1377 CRM_Core_BAO_CustomField
::getFieldsForImport($contactType, $status, TRUE, $search, TRUE, $withMultiRecord)
1382 'Individual', 'Household', 'Organization') as $type) {
1383 $fields = array_merge($fields,
1384 CRM_Core_BAO_CustomField
::getFieldsForImport($type, FALSE, FALSE, $search, TRUE, $withMultiRecord)
1391 $fields = array_merge($fields, array(
1393 'title' => ts('Group(s)'),
1397 'title' => ts('Tag(s)'),
1401 'title' => ts('Note(s)'),
1407 $fields = array_merge($fields, array(
1409 'title' => ts('Group(s)'),
1413 'title' => ts('Tag(s)'),
1417 'title' => ts('Note(s)'),
1423 //Sorting fields in alphabetical order(CRM-1507)
1424 foreach ($fields as $k => $v) {
1425 $sortArray[$k] = CRM_Utils_Array
::value('title', $v);
1428 $fields = array_merge($sortArray, $fields);
1429 //unset the field which are not related to their contact type.
1430 if ($contactType != 'All') {
1431 $commonValues = array(
1432 'Individual' => array(
1436 'organization_name',
1437 'email_greeting_custom',
1438 'postal_greeting_custom',
1441 'Household' => array(
1447 'individual_prefix',
1448 'individual_suffix',
1450 'organization_name',
1458 'email_greeting_custom',
1459 'postal_greeting_custom',
1464 'Organization' => array(
1470 'individual_prefix',
1471 'individual_suffix',
1474 'email_greeting_custom',
1475 'postal_greeting_custom',
1485 foreach ($commonValues[$contactType] as $value) {
1486 unset($fields[$value]);
1490 CRM_Core_BAO_Cache
::setItem($fields, 'contact fields', $cacheKeyString);
1492 self
::$_exportableFields[$cacheKeyString] = $fields;
1496 $fields = self
::$_exportableFields[$cacheKeyString];
1499 $fields = array_merge(array('' => array('title' => ts('- Contact Fields -'))),
1500 self
::$_exportableFields[$cacheKeyString]
1508 * Function to get the all contact details(Hierarchical)
1510 * @param int $contactId contact id
1511 * @param array $fields fields array
1513 * @return $values array contains the contact details
1517 static function getHierContactDetails($contactId, &$fields) {
1518 $params = array(array('contact_id', '=', $contactId, 0, 0));
1521 $returnProperties = self
::makeHierReturnProperties($fields, $contactId);
1523 // we dont know the contents of return properties, but we need the lower level ids of the contact
1524 // so add a few fields
1525 $returnProperties['first_name'] =
1526 $returnProperties['organization_name'] =
1527 $returnProperties['household_name'] =
1528 $returnProperties['contact_type'] =
1529 $returnProperties['contact_sub_type'] = 1;
1530 return list($query, $options) = CRM_Contact_BAO_Query
::apiQuery($params, $returnProperties, $options);
1534 * given a set of flat profile style field names, create a hierarchy
1535 * for query to use and crete the right sql
1537 * @param array $properties a flat return properties name value array
1538 * @param int $contactId contact id
1540 * @return array a hierarchical property tree if appropriate
1544 static function &makeHierReturnProperties($fields, $contactId = NULL) {
1545 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
1547 $returnProperties = array();
1549 $multipleFields = array('website' => 'url');
1550 foreach ($fields as $name => $dontCare) {
1551 if (strpos($name, '-') !== FALSE) {
1552 list($fieldName, $id, $type) = CRM_Utils_System
::explode('-', $name, 3);
1554 if (!in_array($fieldName, $multipleFields)) {
1555 if ($id == 'Primary') {
1556 $locationTypeName = 1;
1559 $locationTypeName = CRM_Utils_Array
::value($id, $locationTypes);
1560 if (!$locationTypeName) {
1565 if (!CRM_Utils_Array
::value('location', $returnProperties)) {
1566 $returnProperties['location'] = array();
1568 if (!CRM_Utils_Array
::value($locationTypeName, $returnProperties['location'])) {
1569 $returnProperties['location'][$locationTypeName] = array();
1570 $returnProperties['location'][$locationTypeName]['location_type'] = $id;
1572 if (in_array($fieldName, array(
1573 'phone', 'im', 'email', 'openid', 'phone_ext'))) {
1575 $returnProperties['location'][$locationTypeName][$fieldName . '-' . $type] = 1;
1578 $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1581 elseif (substr($fieldName, 0, 14) === 'address_custom') {
1582 $returnProperties['location'][$locationTypeName][substr($fieldName, 8)] = 1;
1585 $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1589 $returnProperties['website'][$id][$fieldName] = 1;
1593 $returnProperties[$name] = 1;
1597 return $returnProperties;
1601 * Function to return the primary location type of a contact
1603 * $params int $contactId contact_id
1604 * $params boolean $isPrimaryExist if true, return primary contact location type otherwise null
1605 * $params boolean $skipDefaultPriamry if true, return primary contact location type otherwise null
1607 * @return int $locationType location_type_id
1611 static function getPrimaryLocationType($contactId, $skipDefaultPriamry = FALSE, $block = NULL) {
1613 $entityBlock = array('contact_id' => $contactId);
1614 $blocks = CRM_Core_BAO_Location
::getValues($entityBlock);
1615 foreach($blocks[$block] as $key => $value){
1616 if (CRM_Utils_Array
::value('is_primary', $value)){
1617 $locationType = CRM_Utils_Array
::value('location_type_id',$value);
1624 IF ( civicrm_email.location_type_id IS NULL,
1625 IF ( civicrm_address.location_type_id IS NULL,
1626 IF ( civicrm_phone.location_type_id IS NULL,
1627 IF ( civicrm_im.location_type_id IS NULL,
1628 IF ( civicrm_openid.location_type_id IS NULL, null, civicrm_openid.location_type_id)
1629 ,civicrm_im.location_type_id)
1630 ,civicrm_phone.location_type_id)
1631 ,civicrm_address.location_type_id)
1632 ,civicrm_email.location_type_id) as locationType
1633 FROM civicrm_contact
1634 LEFT JOIN civicrm_email ON ( civicrm_email.is_primary = 1 AND civicrm_email.contact_id = civicrm_contact.id )
1635 LEFT JOIN civicrm_address ON ( civicrm_address.is_primary = 1 AND civicrm_address.contact_id = civicrm_contact.id)
1636 LEFT JOIN civicrm_phone ON ( civicrm_phone.is_primary = 1 AND civicrm_phone.contact_id = civicrm_contact.id)
1637 LEFT JOIN civicrm_im ON ( civicrm_im.is_primary = 1 AND civicrm_im.contact_id = civicrm_contact.id)
1638 LEFT JOIN civicrm_openid ON ( civicrm_openid.is_primary = 1 AND civicrm_openid.contact_id = civicrm_contact.id)
1639 WHERE civicrm_contact.id = %1 ";
1641 $params = array(1 => array($contactId, 'Integer'));
1643 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1645 $locationType = NULL;
1646 if ($dao->fetch()) {
1647 $locationType = $dao->locationType
;
1650 if (isset($locationType)) {
1651 return $locationType;
1653 elseif ($skipDefaultPriamry) {
1654 // if there is no primary contact location then return null
1658 // if there is no primart contact location, then return default
1659 // location type of the system
1660 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
1661 return $defaultLocationType->id
;
1666 * function to get the display name, primary email and location type of a contact
1668 * @param int $id id of the contact
1670 * @return array of display_name, email if found, do_not_email or (null,null,null)
1674 static function getContactDetails($id) {
1675 // check if the contact type
1676 $contactType = self
::getContactType($id);
1678 $nameFields = ($contactType == 'Individual') ?
"civicrm_contact.first_name, civicrm_contact.last_name, civicrm_contact.display_name" : "civicrm_contact.display_name";
1681 SELECT $nameFields, civicrm_email.email, civicrm_contact.do_not_email, civicrm_email.on_hold, civicrm_contact.is_deceased
1682 FROM civicrm_contact LEFT JOIN civicrm_email ON (civicrm_contact.id = civicrm_email.contact_id)
1683 WHERE civicrm_contact.id = %1
1684 ORDER BY civicrm_email.is_primary DESC";
1685 $params = array(1 => array($id, 'Integer'));
1686 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
1688 if ($dao->fetch()) {
1689 if ($contactType == 'Individual') {
1690 if ($dao->first_name ||
$dao->last_name
) {
1691 $name = "{$dao->first_name} {$dao->last_name}";
1694 $name = $dao->display_name
;
1698 $name = $dao->display_name
;
1700 $email = $dao->email
;
1701 $doNotEmail = $dao->do_not_email ?
TRUE : FALSE;
1702 $onHold = $dao->on_hold ?
TRUE : FALSE;
1703 $isDeceased = $dao->is_deceased ?
TRUE : FALSE;
1704 return array($name, $email, $doNotEmail, $onHold, $isDeceased);
1706 return array(NULL, NULL, NULL, NULL, NULL);
1710 * function to add/edit/register contacts through profile.
1712 * @params array $params Array of profile fields to be edited/added.
1713 * @params int $contactID contact_id of the contact to be edited/added.
1714 * @params array $fields array of fields from UFGroup
1715 * @params int $addToGroupID specifies the default group to which contact is added.
1716 * @params int $ufGroupId uf group id (profile id)
1717 * @param string $ctype contact type
1718 * @param boolean $visibility basically lets us know where this request is coming from
1719 * if via a profile from web, we restrict what groups are changed
1721 * @return int contact id created/edited
1725 static function createProfileContact(
1729 $addToGroupID = NULL,
1734 // add ufGroupID to params array ( CRM-2012 )
1736 $params['uf_group_id'] = $ufGroupId;
1741 CRM_Utils_Hook
::pre('edit', 'Profile', $contactID, $params);
1745 CRM_Utils_Hook
::pre('create', 'Profile', NULL, $params);
1748 list($data, $contactDetails) = self
::formatProfileContactParams($params, $fields, $contactID, $ufGroupId, $ctype);
1750 // manage is_opt_out
1751 if (array_key_exists('is_opt_out', $fields) && array_key_exists('is_opt_out', $params)) {
1752 $wasOptOut = CRM_Utils_Array
::value('is_opt_out', $contactDetails, FALSE);
1753 $isOptOut = CRM_Utils_Array
::value('is_opt_out', $params, FALSE);
1754 $data['is_opt_out'] = $isOptOut;
1755 // on change, create new civicrm_subscription_history entry
1756 if (($wasOptOut != $isOptOut) &&
1757 CRM_Utils_Array
::value('contact_id', $contactDetails)
1760 'contact_id' => $contactDetails['contact_id'],
1761 'status' => $isOptOut ?
'Removed' : 'Added',
1764 CRM_Contact_BAO_SubscriptionHistory
::create($shParams);
1768 $contact = self
::create($data);
1770 // contact is null if the profile does not have any contact fields
1772 $contactID = $contact->id
;
1775 if (empty($contactID)) {
1776 CRM_Core_Error
::fatal('Cannot proceed without a valid contact id');
1779 // Process group and tag
1780 if (CRM_Utils_Array
::value('group', $fields)) {
1782 // this for sure means we are coming in via profile since i added it to fix
1783 // removing contacts from user groups -- lobo
1787 CRM_Contact_BAO_GroupContact
::create($params['group'], $contactID, $visibility, $method);
1790 if (CRM_Utils_Array
::value('tag', $fields)) {
1791 CRM_Core_BAO_EntityTag
::create($params['tag'], 'civicrm_contact', $contactID);
1794 //to add profile in default group
1795 if (is_array($addToGroupID)) {
1796 $contactIds = array($contactID);
1797 foreach ($addToGroupID as $groupId) {
1798 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $groupId);
1801 elseif ($addToGroupID) {
1802 $contactIds = array($contactID);
1803 CRM_Contact_BAO_GroupContact
::addContactsToGroup($contactIds, $addToGroupID);
1806 // reset the group contact cache for this group
1807 CRM_Contact_BAO_GroupContactCache
::remove();
1810 CRM_Utils_Hook
::post('edit', 'Profile', $contactID, $params);
1813 CRM_Utils_Hook
::post('create', 'Profile', $contactID, $params);
1818 static function formatProfileContactParams(
1827 $data = $contactDetails = array();
1829 // get the contact details (hier)
1831 list($details, $options) = self
::getHierContactDetails($contactID, $fields);
1833 $contactDetails = $details[$contactID];
1834 $data['contact_type'] = CRM_Utils_Array
::value('contact_type', $contactDetails);
1835 $data['contact_sub_type'] = CRM_Utils_Array
::value('contact_sub_type', $contactDetails);
1838 //we should get contact type only if contact
1840 $data['contact_type'] = CRM_Core_BAO_UFField
::getProfileType($ufGroupId);
1842 //special case to handle profile with only contact fields
1843 if ($data['contact_type'] == 'Contact') {
1844 $data['contact_type'] = 'Individual';
1846 elseif (CRM_Contact_BAO_ContactType
::isaSubType($data['contact_type'])) {
1847 $data['contact_type'] = CRM_Contact_BAO_ContactType
::getBasicType($data['contact_type']);
1851 $data['contact_type'] = $ctype;
1854 $data['contact_type'] = 'Individual';
1858 //fix contact sub type CRM-5125
1859 if (array_key_exists('contact_sub_type', $params) &&
1860 !empty($params['contact_sub_type'])
1862 $data['contact_sub_type'] = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, (array)$params['contact_sub_type']) . CRM_Core_DAO
::VALUE_SEPARATOR
;
1864 elseif (array_key_exists('contact_sub_type_hidden', $params) &&
1865 !empty($params['contact_sub_type_hidden'])
1867 // if profile was used, and had any subtype, we obtain it from there
1868 $data['contact_sub_type'] = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, (array)$params['contact_sub_type_hidden']) . CRM_Core_DAO
::VALUE_SEPARATOR
;
1871 if ($ctype == 'Organization') {
1872 $data['organization_name'] = CRM_Utils_Array
::value('organization_name', $contactDetails);
1874 elseif ($ctype == 'Household') {
1875 $data['household_name'] = CRM_Utils_Array
::value('household_name', $contactDetails);
1878 $locationType = array();
1883 $data['contact_id'] = $contactID;
1884 $primaryLocationType = self
::getPrimaryLocationType($contactID);
1887 $defaultLocation = CRM_Core_BAO_LocationType
::getDefault();
1888 $defaultLocationId = $defaultLocation->id
;
1891 // get the billing location type
1892 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
1893 $billingLocationTypeId = array_search('Billing', $locationTypes);
1895 $blocks = array('email', 'phone', 'im', 'openid');
1897 $multiplFields = array('url');
1898 // prevent overwritten of formatted array, reset all block from
1899 // params if it is not in valid format (since import pass valid format)
1900 foreach ($blocks as $blk) {
1901 if (array_key_exists($blk, $params) &&
1902 !is_array($params[$blk])
1904 unset($params[$blk]);
1908 $primaryPhoneLoc = NULL;
1909 foreach ($params as $key => $value) {
1910 $fieldName = $locTypeId = $typeId = NULL;
1911 list($fieldName, $locTypeId, $typeId) = CRM_Utils_System
::explode('-', $key, 3);
1913 //store original location type id
1914 $actualLocTypeId = $locTypeId;
1916 if ($locTypeId == 'Primary') {
1918 if(in_array( $fieldName, $blocks)){
1919 $locTypeId = self
::getPrimaryLocationType($contactID, FALSE, $fieldName);
1922 $locTypeId = self
::getPrimaryLocationType($contactID, FALSE, 'address');
1924 $primaryLocationType = $locTypeId;
1927 $locTypeId = $defaultLocationId;
1931 if (is_numeric($locTypeId) &&
1932 !in_array($fieldName, $multiplFields) &&
1933 substr($fieldName, 0, 7) != 'custom_'
1935 $index = $locTypeId;
1937 if (is_numeric($typeId)) {
1938 $index .= '-' . $typeId;
1940 if (!in_array($index, $locationType)) {
1941 $locationType[$count] = $index;
1945 $loc = CRM_Utils_Array
::key($index, $locationType);
1947 $blockName = in_array( $fieldName, $blocks) ?
$fieldName : 'address';
1949 $data[$blockName][$loc]['location_type_id'] = $locTypeId;
1951 //set is_billing true, for location type "Billing"
1952 if ($locTypeId == $billingLocationTypeId) {
1953 $data[$blockName][$loc]['is_billing'] = 1;
1957 //get the primary location type
1958 if ($locTypeId == $primaryLocationType) {
1959 $data[$blockName][$loc]['is_primary'] = 1;
1962 elseif ($locTypeId == $defaultLocationId) {
1963 $data[$blockName][$loc]['is_primary'] = 1;
1966 if ( in_array($fieldName, array('phone'))) {
1968 $data['phone'][$loc]['phone_type_id'] = $typeId;
1971 $data['phone'][$loc]['phone_type_id'] = '';
1973 $data['phone'][$loc]['phone'] = $value;
1975 //special case to handle primary phone with different phone types
1976 // in this case we make first phone type as primary
1977 if (isset($data['phone'][$loc]['is_primary']) && !$primaryPhoneLoc) {
1978 $primaryPhoneLoc = $loc;
1981 if ($loc != $primaryPhoneLoc) {
1982 unset($data['phone'][$loc]['is_primary']);
1985 elseif ($fieldName == 'phone_ext') {
1986 $data['phone'][$loc]['phone_ext'] = $value;
1988 elseif ($fieldName == 'email') {
1989 $data['email'][$loc]['email'] = $value;
1991 elseif ($fieldName == 'im') {
1992 if (isset($params[$key . '-provider_id'])) {
1993 $data['im'][$loc]['provider_id'] = $params[$key . '-provider_id'];
1995 if (strpos($key, '-provider_id') !== FALSE) {
1996 $data['im'][$loc]['provider_id'] = $params[$key];
1999 $data['im'][$loc]['name'] = $value;
2002 elseif ($fieldName == 'openid') {
2003 $data['openid'][$loc]['openid'] = $value;
2006 if ($fieldName === 'state_province') {
2008 if (is_numeric($value) && ((int ) $value) >= 1000) {
2009 $data['address'][$loc]['state_province_id'] = $value;
2011 elseif (empty($value)) {
2012 $data['address'][$loc]['state_province_id'] = '';
2015 $data['address'][$loc]['state_province'] = $value;
2018 elseif ($fieldName === 'country') {
2020 if (is_numeric($value) && ((int ) $value) >= 1000
2022 $data['address'][$loc]['country_id'] = $value;
2024 elseif (empty($value)) {
2025 $data['address'][$loc]['country_id'] = '';
2028 $data['address'][$loc]['country'] = $value;
2031 elseif ($fieldName === 'county') {
2032 $data['address'][$loc]['county_id'] = $value;
2034 elseif ($fieldName == 'address_name') {
2035 $data['address'][$loc]['name'] = $value;
2037 elseif (substr($fieldName, 0, 14) === 'address_custom') {
2038 $data['address'][$loc][substr($fieldName, 8)] = $value;
2041 $data['address'][$loc][$fieldName] = $value;
2046 if (substr($key, 0, 4) === 'url-') {
2047 $websiteField = explode('-', $key);
2048 if (isset($websiteField[2])) {
2049 $data['website'][$websiteField[1]]['website_type_id'] = $value;
2052 $data['website'][$websiteField[1]]['url'] = $value;
2055 elseif (in_array($key, self
::$_greetingTypes, TRUE)) {
2056 //save email/postal greeting and addressee values if any, CRM-4575
2057 $data[$key . '_id'] = $value;
2059 elseif (!$skipCustom && ($customFieldId = CRM_Core_BAO_CustomField
::getKeyID($key))) {
2060 // for autocomplete transfer hidden value instead of label
2061 if ($params[$key] && isset($params[$key . '_id'])) {
2062 $value = $params[$key . '_id'];
2065 // we need to append time with date
2066 if ($params[$key] && isset($params[$key . '_time'])) {
2067 $value .= ' ' . $params[$key . '_time'];
2070 // updateBlankCustomInfo flag is false && $value is blank, do not proceed
2071 if (!CRM_Utils_Array
::value('updateBlankCustomInfo', $params, TRUE) && ($value == '' ||
!isset($value))) {
2076 if (CRM_Utils_Array
::value('customRecordValues', $params)) {
2077 if (is_array($params['customRecordValues']) && !empty($params['customRecordValues'])) {
2078 foreach ($params['customRecordValues'] as $recId => $customFields) {
2079 if (is_array($customFields) && !empty($customFields)) {
2080 foreach ($customFields as $customFieldName) {
2081 if ($customFieldName == $key) {
2091 $type = $data['contact_type'];
2092 if ( CRM_Utils_Array
::value('contact_sub_type', $data) ) {
2093 $type = $data['contact_sub_type'];
2094 $type = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, trim($type, CRM_Core_DAO
::VALUE_SEPARATOR
));
2095 // generally a contact even if, has multiple subtypes the parent-type is going to be one only
2096 // and since formatCustomField() would be interested in parent type, lets consider only one subtype
2097 // as the results going to be same.
2101 CRM_Core_BAO_CustomField
::formatCustomField($customFieldId,
2109 elseif ($key == 'edit') {
2113 if ($key == 'location') {
2114 foreach ($value as $locationTypeId => $field) {
2115 foreach ($field as $block => $val) {
2116 if ($block == 'address' && array_key_exists('address_name', $val)) {
2117 $value[$locationTypeId][$block]['name'] = $value[$locationTypeId][$block]['address_name'];
2122 if($key == 'phone' && isset($params['phone_ext'])){
2123 $data[$key] = $value;
2124 foreach($value as $cnt => $phoneBlock){
2125 if($params[$key][$cnt]['location_type_id'] == $params['phone_ext'][$cnt]['location_type_id']){
2126 $data[$key][$cnt]['phone_ext'] = CRM_Utils_Array
::retrieveValueRecursive($params['phone_ext'][$cnt], 'phone_ext');
2131 $data[$key] = $value;
2137 if (!isset($data['contact_type'])) {
2138 $data['contact_type'] = 'Individual';
2141 //set the values for checkboxes (do_not_email, do_not_mail, do_not_trade, do_not_phone)
2142 $privacy = CRM_Core_SelectValues
::privacy();
2143 foreach ($privacy as $key => $value) {
2144 if (array_key_exists($key, $fields)) {
2145 // do not reset values for existing contacts, if fields are added to a profile
2146 if (array_key_exists($key, $params)) {
2147 $data[$key] = $params[$key];
2148 if (empty($params[$key])) {
2152 elseif (!$contactID) {
2158 return array($data, $contactDetails);
2162 * Function to find the get contact details
2163 * does not respect ACLs for now, which might need to be rectified at some
2164 * stage based on how its used
2166 * @param string $mail primary email address of the contact
2167 * @param string $ctype contact type
2169 * @return object $dao contact details
2172 static function &matchContactOnEmail($mail, $ctype = NULL) {
2173 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2174 $mail = $strtolower(trim($mail));
2176 SELECT civicrm_contact.id as contact_id,
2177 civicrm_contact.hash as hash,
2178 civicrm_contact.contact_type as contact_type,
2179 civicrm_contact.contact_sub_type as contact_sub_type
2180 FROM civicrm_contact
2181 INNER JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id )";
2184 if (CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MULTISITE_PREFERENCES_NAME
,
2185 'uniq_email_per_site'
2187 // try to find a match within a site (multisite).
2188 $groups = CRM_Core_BAO_Domain
::getChildGroupIds();
2189 if (!empty($groups)) {
2191 INNER JOIN civicrm_group_contact gc ON
2192 (civicrm_contact.id = gc.contact_id AND gc.status = 'Added' AND gc.group_id IN (" . implode(',', $groups) . "))";
2197 WHERE civicrm_email.email = %1 AND civicrm_contact.is_deleted=0";
2198 $p = array(1 => array($mail, 'String'));
2201 $query .= " AND civicrm_contact.contact_type = %3";
2202 $p[3] = array($ctype, 'String');
2205 $query .= " ORDER BY civicrm_email.is_primary DESC";
2207 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2209 if ($dao->fetch()) {
2212 return CRM_Core_DAO
::$_nullObject;
2216 * Function to find the contact details associated with an OpenID
2218 * @param string $openId openId of the contact
2219 * @param string $ctype contact type
2221 * @return object $dao contact details
2224 static function &matchContactOnOpenId($openId, $ctype = NULL) {
2225 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2226 $openId = $strtolower(trim($openId));
2228 SELECT civicrm_contact.id as contact_id,
2229 civicrm_contact.hash as hash,
2230 civicrm_contact.contact_type as contact_type,
2231 civicrm_contact.contact_sub_type as contact_sub_type
2232 FROM civicrm_contact
2233 INNER JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id )
2234 WHERE civicrm_openid.openid = %1";
2235 $p = array(1 => array($openId, 'String'));
2238 $query .= " AND civicrm_contact.contact_type = %3";
2239 $p[3] = array($ctype, 'String');
2242 $query .= " ORDER BY civicrm_openid.is_primary DESC";
2244 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2246 if ($dao->fetch()) {
2249 return CRM_Core_DAO
::$_nullObject;
2253 * Funtion to get primary email of the contact
2255 * @param int $contactID contact id
2257 * @return string $dao->email email address if present else null
2261 public static function getPrimaryEmail($contactID) {
2262 // fetch the primary email
2264 SELECT civicrm_email.email as email
2265 FROM civicrm_contact
2266 LEFT JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id )
2267 WHERE civicrm_email.is_primary = 1
2268 AND civicrm_contact.id = %1";
2269 $p = array(1 => array($contactID, 'Integer'));
2270 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2273 if ($dao->fetch()) {
2274 $email = $dao->email
;
2281 * Funtion to get primary OpenID of the contact
2283 * @param int $contactID contact id
2285 * @return string $dao->openid OpenID if present else null
2289 public static function getPrimaryOpenId($contactID) {
2290 // fetch the primary OpenID
2292 SELECT civicrm_openid.openid as openid
2293 FROM civicrm_contact
2294 LEFT JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id )
2295 WHERE civicrm_contact.id = %1
2296 AND civicrm_openid.is_primary = 1";
2297 $p = array(1 => array($contactID, 'Integer'));
2298 $dao = CRM_Core_DAO
::executeQuery($query, $p);
2301 if ($dao->fetch()) {
2302 $openId = $dao->openid
;
2309 * Given the list of params in the params array, fetch the object
2310 * and store the values in the values array
2312 * @param array $params input parameters to find object
2313 * @param array $values output values of the object
2315 * @return CRM_Contact_BAO_Contact|null the found object or null
2319 public static function getValues(&$params, &$values) {
2320 $contact = new CRM_Contact_BAO_Contact();
2322 $contact->copyValues($params);
2324 if ($contact->find(TRUE)) {
2326 CRM_Core_DAO
::storeValues($contact, $values);
2329 foreach (self
::$_commPrefs as $name) {
2330 if (isset($contact->$name)) {
2331 $privacy[$name] = $contact->$name;
2335 if (!empty($privacy)) {
2336 $values['privacy'] = $privacy;
2339 // communication Prefferance
2340 $preffComm = $comm = array();
2341 $comm = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
2342 $contact->preferred_communication_method
2344 foreach ($comm as $value) {
2345 $preffComm[$value] = 1;
2347 $temp = array('preferred_communication_method' => $contact->preferred_communication_method
);
2350 'preferred_communication_method' => array('newName' => 'preferred_communication_method_display',
2351 'groupName' => 'preferred_communication_method',
2354 CRM_Core_OptionGroup
::lookupValues($temp, $names, FALSE);
2356 $values['preferred_communication_method'] = $preffComm;
2357 $values['preferred_communication_method_display'] = CRM_Utils_Array
::value('preferred_communication_method_display', $temp);
2359 CRM_Contact_DAO_Contact
::addDisplayEnums($values);
2361 // get preferred languages
2362 if (!empty($contact->preferred_language
)) {
2363 $values['preferred_language'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $contact->preferred_language
);
2366 // Calculating Year difference
2367 if ($contact->birth_date
) {
2368 $birthDate = CRM_Utils_Date
::customFormat($contact->birth_date
, '%Y%m%d');
2369 if ($birthDate < date('Ymd')) {
2370 $age = CRM_Utils_Date
::calculateAge($birthDate);
2371 $values['age']['y'] = CRM_Utils_Array
::value('years', $age);
2372 $values['age']['m'] = CRM_Utils_Array
::value('months', $age);
2375 list($values['birth_date']) = CRM_Utils_Date
::setDateDefaults($contact->birth_date
, 'birth');
2376 $values['birth_date_display'] = $contact->birth_date
;
2379 if ($contact->deceased_date
) {
2380 list($values['deceased_date']) = CRM_Utils_Date
::setDateDefaults($contact->deceased_date
, 'birth');
2381 $values['deceased_date_display'] = $contact->deceased_date
;
2384 $contact->contact_id
= $contact->id
;
2392 * Given the component name and returns
2393 * the count of participation of contact
2395 * @param string $component input component name
2396 * @param integer $contactId input contact id
2397 * @param string $tableName optional tableName if component is custom group
2399 * @return total number of count of occurence in database
2403 static function getCountComponent($component, $contactId, $tableName = NULL) {
2405 switch ($component) {
2407 return CRM_Core_BAO_EntityTag
::getContactTags($contactId, TRUE);
2410 return CRM_Contact_BAO_Relationship
::getRelationship($contactId,
2411 CRM_Contact_BAO_Relationship
::CURRENT
,
2416 return CRM_Contact_BAO_GroupContact
::getContactGroup($contactId, "Added", NULL, TRUE);
2419 if (CRM_Core_BAO_Log
::useLoggingReport()) {
2422 return CRM_Core_BAO_Log
::getContactLogCount($contactId);
2425 return CRM_Core_BAO_Note
::getContactNoteCount($contactId);
2427 case 'contribution':
2428 return CRM_Contribute_BAO_Contribution
::contributionCount($contactId);
2431 return CRM_Member_BAO_Membership
::getContactMembershipCount($contactId, TRUE);
2434 return CRM_Event_BAO_Participant
::getContactParticipantCount($contactId);
2437 return CRM_Pledge_BAO_Pledge
::getContactPledgeCount($contactId);
2440 return CRM_Case_BAO_Case
::caseCount($contactId);
2443 return CRM_Grant_BAO_Grant
::getContactGrantCount($contactId);
2447 'contact_id' => $contactId,
2450 'context' => 'activity',
2452 return CRM_Activity_BAO_Activity
::getActivitiesCount($input);
2455 $params = array('contact_id' => $contactId);
2456 return CRM_Mailing_BAO_Mailing
::getContactMailingsCount($params);
2459 $custom = explode('_', $component);
2460 if ($custom['0'] = 'custom') {
2462 $tableName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $custom['1'], 'table_name');
2464 $queryString = "SELECT count(id) FROM {$tableName} WHERE entity_id = {$contactId}";
2465 return CRM_Core_DAO
::singleValueQuery($queryString);
2471 * Function to process greetings and cache
2473 * @param object $contact contact object after save
2474 * @param boolean $useDefaults use default greeting values
2480 static function processGreetings(&$contact, $useDefaults = FALSE) {
2482 //retrieve default greetings
2483 $defaultGreetings = CRM_Core_PseudoConstant
::greetingDefaults();
2484 $contactDefaults = $defaultGreetings[$contact->contact_type
];
2487 // note that contact object not always has required greeting related
2488 // fields that are required to calculate greeting and
2489 // also other fields used in tokens etc,
2490 // hence we need to retrieve it again.
2491 $contact->find(TRUE);
2493 // store object values to an array
2494 $contactDetails = array();
2495 CRM_Core_DAO
::storeValues($contact, $contactDetails);
2496 $contactDetails = array(array($contact->id
=> $contactDetails));
2498 $emailGreetingString = $postalGreetingString = $addresseeString = NULL;
2499 $updateQueryString = array();
2501 //cache email and postal greeting to greeting display
2502 if ($contact->email_greeting_custom
!= 'null' && $contact->email_greeting_custom
) {
2503 $emailGreetingString = $contact->email_greeting_custom
;
2505 elseif ($contact->email_greeting_id
!= 'null' && $contact->email_greeting_id
) {
2506 // the filter value for Individual contact type is set to 1
2508 'contact_type' => $contact->contact_type
,
2509 'greeting_type' => 'email_greeting',
2512 $emailGreeting = CRM_Core_PseudoConstant
::greeting($filter);
2513 $emailGreetingString = $emailGreeting[$contact->email_greeting_id
];
2514 $updateQueryString[] = " email_greeting_custom = NULL ";
2518 reset($contactDefaults['email_greeting']);
2519 $emailGreetingID = key($contactDefaults['email_greeting']);
2520 $emailGreetingString = $contactDefaults['email_greeting'][$emailGreetingID];
2521 $updateQueryString[] = " email_greeting_id = $emailGreetingID ";
2522 $updateQueryString[] = " email_greeting_custom = NULL ";
2524 elseif ($contact->email_greeting_custom
) {
2525 $updateQueryString[] = " email_greeting_display = NULL ";
2529 if ($emailGreetingString) {
2530 CRM_Utils_Token
::replaceGreetingTokens($emailGreetingString,
2533 'CRM_Contact_BAO_Contact'
2535 $emailGreetingString = CRM_Core_DAO
::escapeString(CRM_Utils_String
::stripSpaces($emailGreetingString));
2536 $updateQueryString[] = " email_greeting_display = '{$emailGreetingString}'";
2540 if ($contact->postal_greeting_custom
!= 'null' && $contact->postal_greeting_custom
) {
2541 $postalGreetingString = $contact->postal_greeting_custom
;
2543 elseif ($contact->postal_greeting_id
!= 'null' && $contact->postal_greeting_id
) {
2545 'contact_type' => $contact->contact_type
,
2546 'greeting_type' => 'postal_greeting',
2548 $postalGreeting = CRM_Core_PseudoConstant
::greeting($filter);
2549 $postalGreetingString = $postalGreeting[$contact->postal_greeting_id
];
2550 $updateQueryString[] = " postal_greeting_custom = NULL ";
2554 reset($contactDefaults['postal_greeting']);
2555 $postalGreetingID = key($contactDefaults['postal_greeting']);
2556 $postalGreetingString = $contactDefaults['postal_greeting'][$postalGreetingID];
2557 $updateQueryString[] = " postal_greeting_id = $postalGreetingID ";
2558 $updateQueryString[] = " postal_greeting_custom = NULL ";
2560 elseif ($contact->postal_greeting_custom
) {
2561 $updateQueryString[] = " postal_greeting_display = NULL ";
2565 if ($postalGreetingString) {
2566 CRM_Utils_Token
::replaceGreetingTokens($postalGreetingString,
2569 'CRM_Contact_BAO_Contact'
2571 $postalGreetingString = CRM_Core_DAO
::escapeString(CRM_Utils_String
::stripSpaces($postalGreetingString));
2572 $updateQueryString[] = " postal_greeting_display = '{$postalGreetingString}'";
2576 if ($contact->addressee_custom
!= 'null' && $contact->addressee_custom
) {
2577 $addresseeString = $contact->addressee_custom
;
2579 elseif ($contact->addressee_id
!= 'null' && $contact->addressee_id
) {
2581 'contact_type' => $contact->contact_type
,
2582 'greeting_type' => 'addressee',
2585 $addressee = CRM_Core_PseudoConstant
::greeting($filter);
2586 $addresseeString = $addressee[$contact->addressee_id
];
2587 $updateQueryString[] = " addressee_custom = NULL ";
2591 reset($contactDefaults['addressee']);
2592 $addresseeID = key($contactDefaults['addressee']);
2593 $addresseeString = $contactDefaults['addressee'][$addresseeID];
2594 $updateQueryString[] = " addressee_id = $addresseeID ";
2595 $updateQueryString[] = " addressee_custom = NULL ";
2597 elseif ($contact->addressee_custom
) {
2598 $updateQueryString[] = " addressee_display = NULL ";
2602 if ($addresseeString) {
2603 CRM_Utils_Token
::replaceGreetingTokens($addresseeString,
2606 'CRM_Contact_BAO_Contact'
2608 $addresseeString = CRM_Core_DAO
::escapeString(CRM_Utils_String
::stripSpaces($addresseeString));
2609 $updateQueryString[] = " addressee_display = '{$addresseeString}'";
2612 if (!empty($updateQueryString)) {
2613 $updateQueryString = implode(',', $updateQueryString);
2614 $queryString = "UPDATE civicrm_contact SET {$updateQueryString} WHERE id = {$contact->id}";
2615 CRM_Core_DAO
::executeQuery($queryString);
2620 * Function to retrieve loc block ids w/ given condition.
2622 * @param int $contactId contact id.
2623 * @param array $criteria key => value pair which should be
2624 * fulfill by return record ids.
2625 * @param string $condOperator operator use for grouping multiple conditions.
2627 * @return array $locBlockIds loc block ids which fulfill condition.
2630 static function getLocBlockIds($contactId, $criteria = array(), $condOperator = 'AND') {
2631 $locBlockIds = array();
2633 return $locBlockIds;
2636 foreach (array('Email', 'OpenID', 'Phone', 'Address', 'IM') as $block) {
2637 $name = strtolower($block);
2638 $className = "CRM_Core_DAO_$block";
2639 $blockDAO = new $className();
2641 // build the condition.
2642 if (is_array($criteria)) {
2643 $fields = $blockDAO->fields();
2644 $conditions = array();
2645 foreach ($criteria as $field => $value) {
2646 if (array_key_exists($field, $fields)) {
2647 $cond = "( $field = $value )";
2648 // value might be zero or null.
2649 if (!$value ||
strtolower($value) == 'null') {
2650 $cond = "( $field = 0 OR $field IS NULL )";
2652 $conditions[] = $cond;
2655 if (!empty($conditions)) {
2656 $blockDAO->whereAdd(implode(" $condOperator ", $conditions));
2660 $blockDAO->contact_id
= $contactId;
2662 while ($blockDAO->fetch()) {
2663 $locBlockIds[$name][] = $blockDAO->id
;
2668 return $locBlockIds;
2672 * Function to build context menu items.
2674 * @return array of context menu for logged in user.
2677 static function contextMenu($contactId = NULL) {
2679 'view' => array('title' => ts('View Contact'),
2681 'ref' => 'view-contact',
2683 'permissions' => array('view all contacts'),
2685 'add' => array('title' => ts('Edit Contact'),
2687 'ref' => 'edit-contact',
2689 'permissions' => array('edit all contacts'),
2691 'delete' => array('title' => ts('Delete Contact'),
2693 'ref' => 'delete-contact',
2695 'permissions' => array('access deleted contacts', 'delete contacts'),
2697 'contribution' => array('title' => ts('Add Contribution'),
2699 'ref' => 'new-contribution',
2700 'key' => 'contribution',
2701 'component' => 'CiviContribute',
2702 'href' => CRM_Utils_System
::url('civicrm/contact/view/contribution',
2703 'reset=1&action=add&context=contribution'
2705 'permissions' => array(
2706 'access CiviContribute',
2707 'edit contributions',
2710 'participant' => array('title' => ts('Register for Event'),
2712 'ref' => 'new-participant',
2713 'key' => 'participant',
2714 'component' => 'CiviEvent',
2715 'href' => CRM_Utils_System
::url('civicrm/contact/view/participant', 'reset=1&action=add&context=participant'),
2716 'permissions' => array(
2718 'edit event participants',
2721 'activity' => array('title' => ts('Record Activity'),
2723 'ref' => 'new-activity',
2724 'key' => 'activity',
2725 'permissions' => array('edit all contacts'),
2727 'pledge' => array('title' => ts('Add Pledge'),
2729 'ref' => 'new-pledge',
2731 'href' => CRM_Utils_System
::url('civicrm/contact/view/pledge',
2732 'reset=1&action=add&context=pledge'
2734 'component' => 'CiviPledge',
2735 'permissions' => array(
2736 'access CiviPledge',
2740 'membership' => array('title' => ts('Add Membership'),
2742 'ref' => 'new-membership',
2743 'key' => 'membership',
2744 'component' => 'CiviMember',
2745 'href' => CRM_Utils_System
::url('civicrm/contact/view/membership',
2746 'reset=1&action=add&context=membership'
2748 'permissions' => array(
2749 'access CiviMember',
2753 'case' => array('title' => ts('Add Case'),
2755 'ref' => 'new-case',
2757 'component' => 'CiviCase',
2758 'href' => CRM_Utils_System
::url('civicrm/case/add', 'reset=1&action=add&context=case'),
2759 'permissions' => array('add cases'),
2761 'grant' => array('title' => ts('Add Grant'),
2763 'ref' => 'new-grant',
2765 'component' => 'CiviGrant',
2766 'href' => CRM_Utils_System
::url('civicrm/contact/view/grant',
2767 'reset=1&action=add&context=grant'
2769 'permissions' => array('edit grants'),
2771 'rel' => array('title' => ts('Add Relationship'),
2773 'ref' => 'new-relationship',
2775 'href' => CRM_Utils_System
::url('civicrm/contact/view/rel',
2776 'reset=1&action=add'
2778 'permissions' => array('edit all contacts'),
2780 'note' => array('title' => ts('Add Note'),
2782 'ref' => 'new-note',
2784 'href' => CRM_Utils_System
::url('civicrm/contact/view/note',
2785 'reset=1&action=add'
2787 'permissions' => array('edit all contacts'),
2789 'email' => array('title' => ts('Send an Email'),
2791 'ref' => 'new-email',
2793 'permissions' => array('view all contacts'),
2795 'group' => array('title' => ts('Add to Group'),
2797 'ref' => 'group-add-contact',
2799 'permissions' => array('edit groups'),
2801 'tag' => array('title' => ts('Tag'),
2803 'ref' => 'tag-contact',
2805 'permissions' => array('edit all contacts'),
2809 CRM_Utils_Hook
::summaryActions($menu, $contactId);
2810 //1. check for component is active.
2811 //2. check for user permissions.
2812 //3. check for acls.
2813 //3. edit and view contact are directly accessible to user.
2815 $aclPermissionedTasks = array(
2816 'view-contact', 'edit-contact', 'new-activity',
2817 'new-email', 'group-add-contact', 'tag-contact', 'delete-contact',
2819 $corePermission = CRM_Core_Permission
::getPermission();
2821 $config = CRM_Core_Config
::singleton();
2823 $contextMenu = array();
2824 foreach ($menu as $key => $values) {
2825 $componentName = CRM_Utils_Array
::value('component', $values);
2827 // if component action - make sure component is enable.
2828 if ($componentName && !in_array($componentName, $config->enableComponents
)) {
2832 // make sure user has all required permissions.
2833 $hasAllPermissions = FALSE;
2835 $permissions = CRM_Utils_Array
::value('permissions', $values);
2836 if (!is_array($permissions) ||
empty($permissions)) {
2837 $hasAllPermissions = TRUE;
2840 // iterate for required permissions in given permissions array.
2841 if (!$hasAllPermissions) {
2842 $hasPermissions = 0;
2843 foreach ($permissions as $permission) {
2844 if (CRM_Core_Permission
::check($permission)) {
2849 if (count($permissions) == $hasPermissions) {
2850 $hasAllPermissions = TRUE;
2853 // if still user does not have required permissions, check acl.
2854 if (!$hasAllPermissions && $values['ref'] != 'delete-contact') {
2855 if (in_array($values['ref'], $aclPermissionedTasks) &&
2856 $corePermission == CRM_Core_Permission
::EDIT
2858 $hasAllPermissions = TRUE;
2860 elseif (in_array($values['ref'], array(
2862 // grant permissions for these tasks.
2863 $hasAllPermissions = TRUE;
2868 // user does not have necessary permissions.
2869 if (!$hasAllPermissions) {
2873 // build directly accessible action menu.
2874 if (in_array($values['ref'], array(
2875 'view-contact', 'edit-contact'))) {
2876 $contextMenu['primaryActions'][$key] = array(
2877 'title' => $values['title'],
2878 'ref' => $values['ref'],
2879 'key' => $values['key'],
2884 // finally get menu item for -more- action widget.
2885 $contextMenu['moreActions'][$values['weight']] = array(
2886 'title' => $values['title'],
2887 'ref' => $values['ref'],
2888 'href' => CRM_Utils_Array
::value('href', $values),
2889 'key' => $values['key'],
2893 ksort($contextMenu['moreActions']);
2895 return $contextMenu;
2899 * Function to retrieve display name of contact that address is shared
2900 * based on $masterAddressId or $contactId .
2902 * @param int $masterAddressId master id.
2903 * @param int $contactId contact id.
2905 * @return display name |null the found display name or null.
2909 static function getMasterDisplayName($masterAddressId = NULL, $contactId = NULL) {
2910 $masterDisplayName = NULL;
2912 if (!$masterAddressId && !$contactId) {
2913 return $masterDisplayName;
2916 if ($masterAddressId) {
2918 SELECT display_name from civicrm_contact
2919 LEFT JOIN civicrm_address ON ( civicrm_address.contact_id = civicrm_contact.id )
2920 WHERE civicrm_address.id = " . $masterAddressId;
2922 elseif ($contactId) {
2924 SELECT display_name from civicrm_contact cc, civicrm_address add1
2925 LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id )
2926 WHERE cc.id = add2.contact_id AND add1.contact_id = " . $contactId;
2929 $masterDisplayName = CRM_Core_DAO
::singleValueQuery($sql);
2930 return $masterDisplayName;
2934 * Get the creation/modification times for a contact
2936 * @return array('created_date' => $, 'modified_date' => $)
2938 static function getTimestamps($contactId) {
2939 $timestamps = CRM_Core_DAO
::executeQuery(
2940 'SELECT created_date, modified_date
2941 FROM civicrm_contact
2944 1 => array($contactId, 'Integer'),
2947 if ($timestamps->fetch()) {
2949 'created_date' => $timestamps->created_date
,
2950 'modified_date' => $timestamps->modified_date
,
2959 * Get a list of triggers for the contact table
2961 * @see hook_civicrm_triggerInfo
2962 * @see CRM_Core_DAO::triggerRebuild
2963 * @see http://issues.civicrm.org/jira/browse/CRM-10554
2965 static function triggerInfo(&$info, $tableName = NULL) {
2966 //during upgrade, first check for valid version and then create triggers
2967 //i.e the columns created_date and modified_date are introduced in 4.3.alpha1 so dont create triggers for older version
2968 if (CRM_Core_Config
::isUpgradeMode()) {
2969 $currentVer = CRM_Core_BAO_Domain
::version(TRUE);
2970 //if current version is less than 4.3.alpha1 dont create below triggers
2971 if (version_compare($currentVer, '4.3.alpha1') < 0) {
2976 if ($tableName == NULL ||
$tableName == self
::getTableName()) {
2978 'table' => array(self
::getTableName()),
2980 'event' => array('INSERT'),
2981 'sql' => "\nSET NEW.created_date = CURRENT_TIMESTAMP;\n",
2985 // Update timestamp when modifying closely related core tables
2986 $relatedTables = array(
2994 'table' => $relatedTables,
2996 'event' => array('INSERT', 'UPDATE'),
2997 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.contact_id;\n",
3000 'table' => $relatedTables,
3002 'event' => array('DELETE'),
3003 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = OLD.contact_id;\n",
3006 // Update timestamp when modifying related custom-data tables
3007 $customGroupTables = array();
3008 $customGroupDAO = CRM_Core_BAO_CustomGroup
::getAllCustomGroupsByBaseEntity('Contact');
3009 $customGroupDAO->is_multiple
= 0;
3010 $customGroupDAO->find();
3011 while ($customGroupDAO->fetch()) {
3012 $customGroupTables[] = $customGroupDAO->table_name
;
3014 if (!empty($customGroupTables)) {
3016 'table' => $customGroupTables,
3018 'event' => array('INSERT', 'UPDATE'),
3019 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.entity_id;\n",
3022 'table' => $customGroupTables,
3024 'event' => array('DELETE'),
3025 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = OLD.entity_id;\n",
3029 // Update phone table to populate phone_numeric field
3030 if (!$tableName ||
$tableName == 'civicrm_phone') {
3031 // Define stored sql function needed for phones
3032 CRM_Core_DAO
::executeQuery(self
::DROP_STRIP_FUNCTION_43
);
3033 CRM_Core_DAO
::executeQuery(self
::CREATE_STRIP_FUNCTION_43
);
3035 'table' => array('civicrm_phone'),
3037 'event' => array('INSERT', 'UPDATE'),
3038 'sql' => "\nSET NEW.phone_numeric = civicrm_strip_non_numeric(NEW.phone);\n",
3044 * Function to check if contact is being used in civicrm_domain
3045 * based on $contactId
3047 * @param int $contactId contact id.
3049 * @return true if present else false.
3053 static function checkDomainContact($contactId) {
3056 $domainId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Domain', $contactId, 'id', 'contact_id');
3066 * Get options for a given contact field.
3067 * @see CRM_Core_DAO::buildOptions
3069 * TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow?
3070 * TODO: In context of chainselect, what to return if e.g. a country has no states?
3072 * @param String $fieldName
3073 * @param String $context: @see CRM_Core_DAO::buildOptionsContext
3074 * @param Array $props: whatever is known about this dao object
3076 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3078 // Special logic for fields whose options depend on context or properties
3079 switch ($fieldName) {
3080 case 'contact_sub_type':
3081 if (!empty($props['contact_type'])) {
3082 $params['condition'] = "parent_id = (SELECT id FROM civicrm_contact_type WHERE name='{$props['contact_type']}')";
3086 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);
3090 * Delete a contact-related object that has an 'is_primary' field
3091 * Ensures that is_primary gets assigned to another object if available
3092 * Also calls pre/post hooks
3094 * @var $type: object type
3095 * @var $id: object id
3097 public static function deleteObjectWithPrimary($type, $id) {
3098 if (!$id ||
!is_numeric($id)) {
3101 $daoName = "CRM_Core_DAO_$type";
3102 $obj = new $daoName();
3105 if ($obj->fetch()) {
3106 CRM_Utils_Hook
::pre('delete', $type, $id, CRM_Core_DAO
::$_nullArray);
3107 $contactId = $obj->contact_id
;
3113 // is_primary is only relavent if this field belongs to a contact
3115 $dao = new $daoName();
3116 $dao->contact_id
= $contactId;
3117 $dao->is_primary
= 1;
3118 // Pick another record to be primary (if one isn't already)
3119 if (!$dao->find(TRUE)) {
3120 $dao->is_primary
= 0;
3122 if ($dao->fetch()) {
3123 $dao->is_primary
= 1;
3129 CRM_Utils_Hook
::post('delete', $type, $id, $obj);