projects / civicrm-core.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Introduce new `formal_title` field for contacts
[civicrm-core.git] / CRM / Contact / BAO / Contact.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2013
32 * $Id$
33 *
34 */
35 class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact {
36
37 /**
38 * SQL function used to format the phone_numeric field via trigger.
39 * @see self::triggerInfo()
40 *
41 * Note that this is also used by the 4.3 upgrade script.
42 * @see CRM_Upgrade_Incremental_php_FourThree
43 */
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
48 DETERMINISTIC
49 NO SQL
50 BEGIN
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));
56 END IF;
57 SET iterator = iterator + 1;
58 END WHILE;
59 RETURN output;
60 END";
61
62 /**
63 * the types of communication preferences
64 *
65 * @var array
66 */
67 static $_commPrefs = array('do_not_phone', 'do_not_email', 'do_not_mail', 'do_not_sms', 'do_not_trade');
68
69 /**
70 * types of greetings
71 *
72 * @var array
73 */
74 static $_greetingTypes = array('addressee', 'email_greeting', 'postal_greeting');
75
76 /**
77 * static field for all the contact information that we can potentially import
78 *
79 * @var array
80 * @static
81 */
82 static $_importableFields = array();
83
84 /**
85 * static field for all the contact information that we can potentially export
86 *
87 * @var array
88 * @static
89 */
90 static $_exportableFields = NULL;
91 function __construct() {
92 parent::__construct();
93 }
94
95 /**
96 * takes an associative array and creates a contact object
97 *
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
100 * pairs
101 *
102 * @param array $params (reference ) an assoc array of name/value pairs
103 *
104 * @return object CRM_Contact_BAO_Contact object
105 * @access public
106 * @static
107 */
108 static function add(&$params) {
109 $contact = new CRM_Contact_DAO_Contact();
110
111 if (empty($params)) {
112 return;
113 }
114
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';
119 }
120 else {
121 if (!CRM_Contact_BAO_ContactType::isExtendsContactType($params['contact_sub_type'],
122 $params['contact_type'], TRUE
123 )) {
124 // we'll need to fix tests to handle this
125 // CRM-7925
126 CRM_Core_Error::fatal(ts('The Contact Sub Type does not match the Contact type for this record'));
127 }
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;
130 }
131 else {
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;
133 }
134 }
135 }
136 else {
137 // reset the value
138 // CRM-101XX
139 $params['contact_sub_type'] = 'null';
140 }
141
142 //fixed contact source
143 if (isset($params['contact_source'])) {
144 $params['source'] = $params['contact_source'];
145 }
146
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']);
151 $newPref = array();
152
153 foreach ($prefComm as $k => $v) {
154 if ($v) {
155 $newPref[$k] = $v;
156 }
157 }
158
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;
163 }
164 else {
165 $contact->preferred_communication_method = '';
166 }
167 }
168
169 $allNull = $contact->copyValues($params);
170
171 $contact->id = CRM_Utils_Array::value('contact_id', $params);
172
173 if ($contact->contact_type == 'Individual') {
174 $allNull = FALSE;
175
176 //format individual fields
177 CRM_Contact_BAO_Individual::format($params, $contact);
178 }
179 elseif ($contact->contact_type == 'Household') {
180 if (isset($params['household_name'])) {
181 $allNull = FALSE;
182 $contact->display_name = $contact->sort_name = CRM_Utils_Array::value('household_name', $params, '');
183 }
184 }
185 elseif ($contact->contact_type == 'Organization') {
186 if (isset($params['organization_name'])) {
187 $allNull = FALSE;
188 $contact->display_name = $contact->sort_name = CRM_Utils_Array::value('organization_name', $params, '');
189 }
190 }
191
192 // privacy block
193 $privacy = CRM_Utils_Array::value('privacy', $params);
194 if ($privacy &&
195 is_array($privacy) &&
196 !empty($privacy)
197 ) {
198 $allNull = FALSE;
199 foreach (self::$_commPrefs as $name) {
200 $contact->$name = CRM_Utils_Array::value($name, $privacy, FALSE);
201 }
202 }
203
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) {
208 $allNull = FALSE;
209 $contact->hash = md5(uniqid(rand(), TRUE));
210 }
211
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');
216
217 if (!$allNull) {
218 $contact->save();
219
220 CRM_Core_BAO_Log::register($contact->id,
221 'civicrm_contact',
222 $contact->id
223 );
224 }
225
226 if ($contact->contact_type == 'Individual' &&
227 (isset($params['current_employer']) ||
228 isset($params['employer_id'])
229 )
230 ) {
231 // create current employer
232 if (isset($params['employer_id'])) {
233 CRM_Contact_BAO_Contact_Utils::createCurrentEmployerRelationship($contact->id,
234 $params['employer_id'], $employerId
235 );
236 }
237 elseif ($params['current_employer']) {
238 CRM_Contact_BAO_Contact_Utils::createCurrentEmployerRelationship($contact->id,
239 $params['current_employer']
240 );
241 }
242 else {
243 //unset if employer id exits
244 if ($employerId) {
245 CRM_Contact_BAO_Contact_Utils::clearCurrentEmployer($contact->id, $employerId);
246 }
247 }
248 }
249
250 //update cached employee name
251 if ($contact->contact_type == 'Organization') {
252 CRM_Contact_BAO_Contact_Utils::updateCurrentEmployer($contact->id);
253 }
254
255 return $contact;
256 }
257
258 /**
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)
262 *
263 * This function is invoked from within the web form layer and also from the api layer
264 *
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
268 *
269 * @return object CRM_Contact_BAO_Contact object
270 * @access public
271 * @static
272 */
273 static function &create(&$params, $fixAddress = TRUE, $invokeHooks = TRUE, $skipDelete = FALSE) {
274 $contact = NULL;
275 if (!CRM_Utils_Array::value('contact_type', $params) &&
276 !CRM_Utils_Array::value('contact_id', $params)
277 ) {
278 return $contact;
279 }
280
281 $isEdit = TRUE;
282 if ($invokeHooks) {
283 if (!empty($params['contact_id'])) {
284 CRM_Utils_Hook::pre('edit', $params['contact_type'], $params['contact_id'], $params);
285 }
286 else {
287 CRM_Utils_Hook::pre('create', $params['contact_type'], NULL, $params);
288 $isEdit = FALSE;
289 }
290 }
291
292 $config = CRM_Core_Config::singleton();
293
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;
297 }
298
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)
305 ) {
306 $params[$greeting . '_id'] = $defaultGreetingTypeId;
307 }
308 }
309 }
310 }
311
312 $transaction = new CRM_Core_Transaction();
313
314 $contact = self::add($params);
315 if (!$contact) {
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
318 // CRM-7925
319 CRM_Core_Error::fatal();
320 }
321
322 $params['contact_id'] = $contact->id;
323
324 if (CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MULTISITE_PREFERENCES_NAME,
325 'is_enabled'
326 )) {
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;
332 }
333 else {
334 $params['group'] = array($domainGroupID => 1);
335 }
336 }
337 }
338
339 if (array_key_exists('group', $params)) {
340 $contactIds = array($params['contact_id']);
341 foreach ($params['group'] as $groupId => $flag) {
342 if ($flag == 1) {
343 CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $groupId);
344 }
345 elseif ($flag == -1) {
346 CRM_Contact_BAO_GroupContact::removeContactsFromGroup($contactIds, $groupId);
347 }
348 }
349 }
350
351 //add location Block data
352 $blocks = CRM_Core_BAO_Location::create($params, $fixAddress);
353 foreach ($blocks as $name => $value) {
354 $contact->$name = $value;
355 }
356
357 //add website
358 CRM_Core_BAO_Website::create($params['website'], $contact->id, $skipDelete);
359
360 //get userID from session
361 $session = CRM_Core_Session::singleton();
362 $userID = $session->get('userID');
363 // add notes
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'];
370 }
371 //if logged in user, overwrite contactId
372 if ($userID) {
373 $contactId = $userID;
374 }
375
376 $noteParams = array(
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,
382 );
383 CRM_Core_BAO_Note::add($noteParams, CRM_Core_DAO::$_nullArray);
384 }
385 }
386 else {
387 $contactId = $contact->id;
388 if (isset($note['contact_id'])) {
389 $contactId = $note['contact_id'];
390 }
391 //if logged in user, overwrite contactId
392 if ($userID) {
393 $contactId = $userID;
394 }
395
396 $noteParams = array(
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,
402 );
403 CRM_Core_BAO_Note::add($noteParams, CRM_Core_DAO::$_nullArray);
404 }
405 }
406
407
408 // update the UF user_unique_id if that has changed
409 CRM_Core_BAO_UFMatch::updateUFName($contact->id);
410
411 if (CRM_Utils_Array::value('custom', $params) &&
412 is_array($params['custom'])
413 ) {
414 CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contact', $contact->id);
415 }
416
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,
421 'status' => 'Added',
422 'method' => 'Admin',
423 );
424 CRM_Contact_BAO_SubscriptionHistory::create($subscriptionParams);
425 }
426
427 $transaction->commit();
428
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,
433 'label',
434 'name'
435 );
436
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);
443 }
444
445 if ($invokeHooks) {
446 if ($isEdit) {
447 CRM_Utils_Hook::post('edit', $params['contact_type'], $contact->id, $contact);
448 }
449 else {
450 CRM_Utils_Hook::post('create', $params['contact_type'], $contact->id, $contact);
451 }
452 }
453
454 // process greetings CRM-4575, cache greetings
455 self::processGreetings($contact);
456
457 return $contact;
458 }
459
460 /**
461 * Get the display name and image of a contact
462 *
463 * @param int $id the contactId
464 *
465 * @return array the displayName and contactImage for this contact
466 * @access public
467 * @static
468 */
469 static function getDisplayAndImage($id, $type = FALSE) {
470 $sql = "
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
475 FROM civicrm_contact
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();
480 $dao->query($sql);
481 if ($dao->fetch()) {
482 $image = CRM_Contact_BAO_Contact_Utils::getImage($dao->contact_sub_type ?
483 $dao->contact_sub_type : $dao->contact_type, FALSE, $id
484 );
485 $imageUrl = CRM_Contact_BAO_Contact_Utils::getImage($dao->contact_sub_type ?
486 $dao->contact_sub_type : $dao->contact_type, TRUE, $id
487 );
488
489 // use email if display_name is empty
490 if (empty($dao->display_name)) {
491 $dao->display_name = $dao->email;
492 }
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);
497 }
498 return NULL;
499 }
500
501 /**
502 *
503 * Get the values for pseudoconstants for name->value and reverse.
504 *
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)
507 *
508 * @return none
509 * @access public
510 * @static
511 */
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'], '-');
517 }
518 }
519
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);
523
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,
528 );
529 CRM_Utils_Array::lookupValue($defaults, $greeting,
530 CRM_Core_PseudoConstant::greeting($filterCondition), $reverse
531 );
532 }
533
534 $blocks = array('address', 'im', 'phone');
535 foreach ($blocks as $name) {
536 if (!array_key_exists($name, $defaults) || !is_array($defaults[$name])) {
537 continue;
538 }
539 foreach ($defaults[$name] as $count => & $values) {
540
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);
543
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']];
549 }
550
551 if (!CRM_Utils_Array::lookupValue($values,
552 'country',
553 CRM_Core_PseudoConstant::country(),
554 $reverse
555 ) &&
556 $reverse
557 ) {
558 CRM_Utils_Array::lookupValue($values,
559 'country',
560 CRM_Core_PseudoConstant::countryIsoCode(),
561 $reverse
562 );
563 }
564
565 // CRM-7597
566 // if we find a country id above, we need to restrict it to that country
567 // rather than the list of all countries
568
569 if (!empty($values['country_id'])) {
570 $stateProvinceList = CRM_Core_PseudoConstant::stateProvinceForCountry($values['country_id']);
571 }
572 else {
573 $stateProvinceList = CRM_Core_PseudoConstant::stateProvince();
574 }
575 if (!CRM_Utils_Array::lookupValue($values,
576 'state_province',
577 $stateProvinceList,
578 $reverse
579 ) &&
580 $reverse
581 ) {
582
583 if (!empty($values['country_id'])) {
584 $stateProvinceList = CRM_Core_PseudoConstant::stateProvinceForCountry($values['country_id'], 'abbreviation');
585 }
586 else {
587 $stateProvinceList = CRM_Core_PseudoConstant::stateProvinceAbbreviation();
588 }
589 CRM_Utils_Array::lookupValue($values,
590 'state_province',
591 $stateProvinceList,
592 $reverse
593 );
594 }
595
596 if (!empty($values['state_province_id'])) {
597 $countyList = CRM_Core_PseudoConstant::countyForState($values['state_province_id']);
598 }
599 else {
600 $countyList = CRM_Core_PseudoConstant::county();
601 }
602 CRM_Utils_Array::lookupValue($values,
603 'county',
604 $countyList,
605 $reverse
606 );
607 }
608
609 if ($name == 'im') {
610 CRM_Utils_Array::lookupValue($values,
611 'provider',
612 CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id'),
613 $reverse
614 );
615 }
616
617 if ($name == 'phone') {
618 CRM_Utils_Array::lookupValue($values,
619 'phone_type',
620 CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id'),
621 $reverse
622 );
623 }
624
625 //kill the reference.
626 unset($values);
627 }
628 }
629 }
630
631 /**
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
637 *
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
642 *
643 * @return object CRM_Contact_BAO_Contact object
644 * @access public
645 * @static
646 */
647 static function &retrieve(&$params, &$defaults, $microformat = FALSE) {
648 if (array_key_exists('contact_id', $params)) {
649 $params['id'] = $params['contact_id'];
650 }
651 elseif (array_key_exists('id', $params)) {
652 $params['contact_id'] = $params['id'];
653 }
654
655 $contact = self::getValues($params, $defaults);
656
657 unset($params['id']);
658
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;
664
665 if (!isset($params['noNotes'])) {
666 $contact->notes = CRM_Core_BAO_Note::getValues($params, $defaults);
667 }
668
669 if (!isset($params['noRelationships'])) {
670 $contact->relationship = CRM_Contact_BAO_Relationship::getValues($params, $defaults);
671 }
672
673 if (!isset($params['noGroups'])) {
674 $contact->groupContact = CRM_Contact_BAO_GroupContact::getValues($params, $defaults);
675 }
676
677 if (!isset($params['noWebsite'])) {
678 $contact->website = CRM_Core_BAO_Website::getValues($params, $defaults);
679 }
680
681 return $contact;
682 }
683
684 /**
685 * function to get the display name of a contact
686 *
687 * @param int $id id of the contact
688 *
689 * @return null|string display name of the contact if found
690 * @static
691 * @access public
692 */
693 static function displayName($id) {
694 $displayName = NULL;
695 if ($id) {
696 $displayName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'display_name');
697 }
698
699 return $displayName;
700 }
701
702 /**
703 * Delete a contact and all its associated records
704 *
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
708 *
709 * @return boolean true if contact deleted, false otherwise
710 * @access public
711 * @static
712 */
713 static function deleteContact($id, $restore = FALSE, $skipUndelete = FALSE) {
714
715 if (!$id) {
716 return FALSE;
717 }
718
719 // make sure we have edit permission for this contact
720 // before we delete
721 if (($skipUndelete && !CRM_Core_Permission::check('delete contacts')) ||
722 ($restore && !CRM_Core_Permission::check('access deleted contacts'))
723 ) {
724 return FALSE;
725 }
726
727 // CRM-12929
728 // Restrict contact to be delete if contact has financial trxns
729 $error = NULL;
730 if ($skipUndelete && CRM_Financial_BAO_FinancialItem::checkContactPresent(array($id), $error)) {
731 return FALSE;
732 }
733
734 // make sure this contact_id does not have any membership types
735 $membershipTypeID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
736 $id,
737 'id',
738 'member_of_contact_id'
739 );
740 if ($membershipTypeID) {
741 return FALSE;
742 }
743
744 $contact = new CRM_Contact_DAO_Contact();
745 $contact->id = $id;
746 if (!$contact->find(TRUE)) {
747 return FALSE;
748 }
749
750 $contactType = $contact->contact_type;
751 $action = ($restore) ? 'restore' : 'delete';
752
753 CRM_Utils_Hook::pre($action, $contactType, $id, CRM_Core_DAO::$_nullArray);
754
755 if ($restore) {
756 self::contactTrashRestore($contact, TRUE);
757 CRM_Utils_Hook::post($action, $contactType, $contact->id, $contact);
758 return TRUE;
759 }
760
761
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);
766 }
767
768 // start a new transaction
769 $transaction = new CRM_Core_Transaction();
770
771 if ($skipUndelete or !CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'contact_undelete', NULL)) {
772
773 //delete billing address if exists.
774 CRM_Contribute_BAO_Contribution::deleteAddress(NULL, $id);
775
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;
780 $logDAO->delete();
781
782 // delete contact participants CRM-12155
783 CRM_Event_BAO_Participant::deleteContactParticipant($id);
784
785 // delete contact contributions CRM-12155
786 CRM_Contribute_BAO_Contribution::deleteContactContribution($id);
787
788 // do activity cleanup, CRM-5604
789 CRM_Activity_BAO_Activity::cleanupActivity($id);
790
791 // delete all notes related to contact
792 CRM_Core_BAO_Note::cleanContactNotes($id);
793
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);
802 }
803 }
804 }
805
806 $contact->delete();
807 }
808 else {
809 self::contactTrashRestore($contact);
810 }
811
812 //delete the contact id from recently view
813 CRM_Utils_Recent::delContact($id);
814
815 // reset the group contact cache for this group
816 CRM_Contact_BAO_GroupContactCache::remove();
817
818 // delete any dupe cache entry
819 CRM_Core_BAO_PrevNextCache::deleteItem($id);
820
821 $transaction->commit();
822
823 CRM_Utils_Hook::post('delete', $contactType, $contact->id, $contact);
824
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();
828
829 return TRUE;
830 }
831
832 /**
833 * function to delete the image of a contact
834 *
835 * @param int $id id of the contact
836 *
837 * @return boolean true if contact image is deleted
838 */
839 public static function deleteContactImage($id) {
840 if (!$id) {
841 return FALSE;
842 }
843 $query = "
844 UPDATE civicrm_contact
845 SET image_URL=NULL
846 WHERE id={$id}; ";
847 CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
848 return TRUE;
849 }
850
851 /**
852 * function to return relative path
853 * @todo make this a method of $config->userSystem (i.e. UF classes) rather than a static function
854 *
855 * @param String $absPath absolute path
856 *
857 * @return String $relativePath Relative url of uploaded image
858 */
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;
866 }
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;
871
872 //format url for language negotiation, CRM-7135
873 $baseUrl = CRM_Utils_System::languageNegotiationURL($baseUrl, FALSE, TRUE);
874
875 $relativePath = str_replace("{$rootPath}/",
876 $baseUrl,
877 str_replace('\\', '/', $absolutePath)
878 );
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;
883 }
884
885 return $relativePath;
886 }
887
888 /**
889 * function to return proportional height and width of the image
890 *
891 * @param Integer $imageWidth width of image
892 *
893 * @param Integer $imageHeight height of image
894 *
895 * @return Array thumb dimension of image
896 */
897 public static function getThumbSize($imageWidth, $imageHeight) {
898 $thumbWidth = 100;
899 if ($imageWidth && $imageHeight) {
900 $imageRatio = $imageWidth / $imageHeight;
901 }
902 else {
903 $imageRatio = 1;
904 }
905 if ($imageRatio > 1) {
906 $imageThumbWidth = $thumbWidth;
907 $imageThumbHeight = round($thumbWidth / $imageRatio);
908 }
909 else {
910 $imageThumbHeight = $thumbWidth;
911 $imageThumbWidth = round($thumbWidth * $imageRatio);
912 }
913
914 return array($imageThumbWidth, $imageThumbHeight);
915 }
916
917 /**
918 * function to validate type of contact image
919 *
920 * @param Array $param array of contact/profile field to be edited/added
921 *
922 * @param String $imageIndex index of image field
923 *
924 * @param String $statusMsg status message to be set after operation
925 *
926 * @opType String $opType type of operation like fatal, bounce etc
927 *
928 * @return boolean true if valid image extension
929 */
930 public static function processImageParams(&$params,
931 $imageIndex = 'image_URL',
932 $statusMsg = NULL,
933 $opType = 'status'
934 ) {
935 $mimeType = array(
936 'image/jpeg',
937 'image/jpg',
938 'image/png',
939 'image/bmp',
940 'image/p-jpeg',
941 'image/gif',
942 'image/x-png',
943 );
944
945 if (in_array($params[$imageIndex]['type'], $mimeType)) {
946 $params[$imageIndex] = CRM_Contact_BAO_Contact::getRelativePath($params[$imageIndex]['name']);
947 return TRUE;
948 }
949 else {
950 unset($params[$imageIndex]);
951 if (!$statusMsg) {
952 $statusMsg = ts('Image could not be uploaded due to invalid type extension.');
953 }
954 if ($opType == 'status') {
955 CRM_Core_Session::setStatus($statusMsg, 'Sorry', 'error');
956 }
957 // FIXME: additional support for fatal, bounce etc could be added.
958 return FALSE;
959 }
960 }
961
962 /**
963 * function to extract contact id from url for deleting contact image
964 */
965 public static function processImage() {
966
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);
979 }
980 }
981 }
982
983 /**
984 * Function to set is_delete true or restore deleted contact
985 *
986 * @param int $contact Contact DAO object
987 * @param boolean $restore true to set the is_delete = 1 else false to restore deleted contact,
988 * i.e. is_delete = 0
989 *
990 * @return void
991 * @static
992 */
993 static function contactTrashRestore($contact, $restore = FALSE) {
994 $op = ($restore ? 'restore' : 'trash');
995
996 CRM_Utils_Hook::pre($op, $contact->contact_type, $contact->id, CRM_Core_DAO::$_nullArray);
997
998 $params = array(1 => array($contact->id, 'Integer'));
999 $isDelete = ' is_deleted = 1 ';
1000 if ($restore) {
1001 $isDelete = ' is_deleted = 0 ';
1002 }
1003 else {
1004 $query = "DELETE FROM civicrm_uf_match WHERE contact_id = %1";
1005 CRM_Core_DAO::executeQuery($query, $params);
1006 }
1007
1008 $query = "UPDATE civicrm_contact SET {$isDelete} WHERE id = %1";
1009 CRM_Core_DAO::executeQuery($query, $params);
1010
1011 CRM_Utils_Hook::post($op, $contact->contact_type, $contact->id, $contact);
1012 }
1013
1014 /**
1015 * Get contact type for a contact.
1016 *
1017 * @param int $id - id of the contact whose contact type is needed
1018 *
1019 * @return string contact_type if $id found else null ""
1020 *
1021 * @access public
1022 *
1023 * @static
1024 *
1025 */
1026 public static function getContactType($id) {
1027 return CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_type');
1028 }
1029
1030 /**
1031 * Get contact sub type for a contact.
1032 *
1033 * @param int $id - id of the contact whose contact sub type is needed
1034 *
1035 * @return string contact_sub_type if $id found else null ""
1036 *
1037 * @access public
1038 *
1039 * @static
1040 *
1041 */
1042 public static function getContactSubType($id, $implodeDelimiter = NULL) {
1043 $subtype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_sub_type');
1044 if (!$subtype) {
1045 return $implodeDelimiter ? NULL : array();
1046 }
1047
1048 $subtype = explode(CRM_Core_DAO::VALUE_SEPARATOR, trim($subtype, CRM_Core_DAO::VALUE_SEPARATOR));
1049
1050 if ($implodeDelimiter) {
1051 $subtype = implode($implodeDelimiter, $subtype);
1052 }
1053 return $subtype;
1054 }
1055
1056 /**
1057 * Get pair of contact-type and sub-type for a contact.
1058 *
1059 * @param int $id - id of the contact whose contact sub/contact type is needed
1060 *
1061 * @return array
1062 *
1063 * @access public
1064 *
1065 * @static
1066 *
1067 */
1068 public static function getContactTypes($id) {
1069 $params = array('id' => $id);
1070 $details = array();
1071 $contact = CRM_Core_DAO::commonRetrieve('CRM_Contact_DAO_Contact',
1072 $params,
1073 $details,
1074 array('contact_type', 'contact_sub_type')
1075 );
1076
1077 if ($contact) {
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);
1082
1083 return $contactTypes;
1084 }
1085 else {
1086 CRM_Core_Error::fatal();
1087 }
1088 }
1089
1090 /**
1091 * combine all the importable fields from the lower levels object
1092 *
1093 * The ordering is important, since currently we do not have a weight
1094 * scheme. Adding weight is super important
1095 *
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)
1101 *
1102 * @return array array of importable Fields
1103 * @access public
1104 * @static
1105 */
1106 static function importableFields($contactType = 'Individual',
1107 $status = FALSE,
1108 $showAll = FALSE,
1109 $isProfile = FALSE,
1110 $checkPermission = TRUE,
1111 $withMultiCustomFields = FALSE
1112 ) {
1113 if (empty($contactType)) {
1114 $contactType = 'All';
1115 }
1116
1117 $cacheKeyString = "importableFields $contactType";
1118 $cacheKeyString .= $status ? '_1' : '_0';
1119 $cacheKeyString .= $showAll ? '_1' : '_0';
1120 $cacheKeyString .= $isProfile ? '_1' : '_0';
1121 $cacheKeyString .= $checkPermission ? '_1' : '_0';
1122
1123 $fields = CRM_Utils_Array::value($cacheKeyString, self::$_importableFields);
1124
1125 if (!$fields) {
1126 // check if we can retrieve from database cache
1127 $fields = CRM_Core_BAO_Cache::getItem('contact fields', $cacheKeyString);
1128 }
1129
1130 if (!$fields) {
1131 $fields = CRM_Contact_DAO_Contact::import();
1132
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));
1137 }
1138
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()
1144 );
1145
1146 $locationFields = array_merge($locationFields,
1147 CRM_Core_BAO_CustomField::getFieldsForImport('Address',
1148 FALSE,
1149 FALSE,
1150 FALSE,
1151 FALSE
1152 )
1153 );
1154
1155 foreach ($locationFields as $key => $field) {
1156 $locationFields[$key]['hasLocationType'] = TRUE;
1157 }
1158
1159 $fields = array_merge($fields, $locationFields);
1160
1161 $fields = array_merge($fields, CRM_Contact_DAO_Contact::import());
1162 $fields = array_merge($fields, CRM_Core_DAO_Note::import());
1163
1164 //website fields
1165 $fields = array_merge($fields, CRM_Core_DAO_Website::import());
1166
1167 if ($contactType != 'All') {
1168 $fields = array_merge($fields,
1169 CRM_Core_BAO_CustomField::getFieldsForImport($contactType,
1170 $showAll,
1171 TRUE,
1172 FALSE,
1173 FALSE,
1174 $withMultiCustomFields
1175 )
1176 );
1177 //unset the fields, which are not related to their
1178 //contact type.
1179 $commonValues = array(
1180 'Individual' => array(
1181 'household_name',
1182 'legal_name',
1183 'sic_code',
1184 'organization_name'
1185 ),
1186 'Household' => array(
1187 'first_name',
1188 'middle_name',
1189 'last_name',
1190 'formal_title',
1191 'job_title',
1192 'gender_id',
1193 'prefix_id',
1194 'suffix_id',
1195 'birth_date',
1196 'organization_name',
1197 'legal_name',
1198 'legal_identifier',
1199 'sic_code',
1200 'home_URL',
1201 'is_deceased',
1202 'deceased_date',
1203 ),
1204 'Organization' => array(
1205 'first_name',
1206 'middle_name',
1207 'last_name',
1208 'formal_title',
1209 'job_title',
1210 'gender_id',
1211 'prefix_id',
1212 'suffix_id',
1213 'birth_date',
1214 'household_name',
1215 'is_deceased',
1216 'deceased_date',
1217 ),
1218 );
1219 foreach ($commonValues[$contactType] as $value) {
1220 unset($fields[$value]);
1221 }
1222 }
1223 else {
1224 foreach (array(
1225 'Individual', 'Household', 'Organization') as $type) {
1226 $fields = array_merge($fields,
1227 CRM_Core_BAO_CustomField::getFieldsForImport($type,
1228 $showAll,
1229 FALSE,
1230 FALSE,
1231 FALSE,
1232 $withMultiCustomFields
1233 )
1234 );
1235 }
1236 }
1237
1238 if ($isProfile) {
1239 $fields = array_merge($fields, array(
1240 'group' => array(
1241 'title' => ts('Group(s)'),
1242 'name' => 'group',
1243 ),
1244 'tag' => array(
1245 'title' => ts('Tag(s)'),
1246 'name' => 'tag',
1247 ),
1248 'note' => array(
1249 'title' => ts('Note(s)'),
1250 'name' => 'note',
1251 ),
1252 ));
1253 }
1254
1255 //Sorting fields in alphabetical order(CRM-1507)
1256 $fields = CRM_Utils_Array::crmArraySortByField($fields, 'title');
1257
1258 CRM_Core_BAO_Cache::setItem($fields, 'contact fields', $cacheKeyString);
1259 }
1260
1261 self::$_importableFields[$cacheKeyString] = $fields;
1262
1263 if (!$isProfile) {
1264 if (!$status) {
1265 $fields = array_merge(array('do_not_import' => array('title' => ts('- do not import -'))),
1266 self::$_importableFields[$cacheKeyString]
1267 );
1268 }
1269 else {
1270 $fields = array_merge(array('' => array('title' => ts('- Contact Fields -'))),
1271 self::$_importableFields[$cacheKeyString]
1272 );
1273 }
1274 }
1275 return $fields;
1276 }
1277
1278 /**
1279 * combine all the exportable fields from the lower levels object
1280 *
1281 * currentlty we are using importable fields as exportable fields
1282 *
1283 * @param int|string $contactType contact Type
1284 * @param boolean $status true while exporting primary contacts
1285 * @param boolean $export true when used during export
1286 * @param boolean $search true when used during search, might conflict with export param?
1287 *
1288 * @param bool $withMultiRecord
1289 *
1290 * @return array array of exportable Fields
1291 * @access public
1292 * @static
1293 */
1294 static function &exportableFields($contactType = 'Individual', $status = FALSE, $export = FALSE, $search = FALSE, $withMultiRecord = FALSE) {
1295 if (empty($contactType)) {
1296 $contactType = 'All';
1297 }
1298
1299 $cacheKeyString = "exportableFields $contactType";
1300 $cacheKeyString .= $export ? '_1' : '_0';
1301 $cacheKeyString .= $status ? '_1' : '_0';
1302 $cacheKeyString .= $search ? '_1' : '_0';
1303
1304 if (!self::$_exportableFields || !CRM_Utils_Array::value($cacheKeyString, self::$_exportableFields)) {
1305 if (!self::$_exportableFields) {
1306 self::$_exportableFields = array();
1307 }
1308
1309 // check if we can retrieve from database cache
1310 $fields = CRM_Core_BAO_Cache::getItem('contact fields', $cacheKeyString);
1311
1312 if (!$fields) {
1313 $fields = CRM_Contact_DAO_Contact::export();
1314
1315 // the fields are meant for contact types
1316 if (
1317 in_array(
1318 $contactType,
1319 array('Individual', 'Household', 'Organization', 'All')
1320 )
1321 ) {
1322 $fields = array_merge($fields, CRM_Core_OptionValue::getFields('', $contactType));
1323 }
1324 // add current employer for individuals
1325 $fields = array_merge($fields, array(
1326 'current_employer' =>
1327 array(
1328 'name' => 'organization_name',
1329 'title' => ts('Current Employer'),
1330 ),
1331 ));
1332
1333 $locationType = array(
1334 'location_type' => array(
1335 'name' => 'location_type',
1336 'where' => 'civicrm_location_type.name',
1337 'title' => ts('Location Type'),
1338 ));
1339
1340 $IMProvider = array(
1341 'im_provider' => array(
1342 'name' => 'im_provider',
1343 'where' => 'civicrm_im.provider_id',
1344 'title' => ts('IM Provider'),
1345 ));
1346
1347 $locationFields = array_merge($locationType,
1348 CRM_Core_DAO_Address::export(),
1349 CRM_Core_DAO_Phone::export(),
1350 CRM_Core_DAO_Email::export(),
1351 $IMProvider,
1352 CRM_Core_DAO_IM::export(TRUE),
1353 CRM_Core_DAO_OpenID::export()
1354 );
1355
1356 $locationFields = array_merge($locationFields,
1357 CRM_Core_BAO_CustomField::getFieldsForImport('Address')
1358 );
1359
1360 foreach ($locationFields as $key => $field) {
1361 $locationFields[$key]['hasLocationType'] = TRUE;
1362 }
1363
1364 $fields = array_merge($fields, $locationFields);
1365
1366 //add world region
1367 $fields = array_merge($fields,
1368 CRM_Core_DAO_Worldregion::export()
1369 );
1370
1371
1372 $fields = array_merge($fields,
1373 CRM_Contact_DAO_Contact::export()
1374 );
1375
1376 //website fields
1377 $fields = array_merge($fields, CRM_Core_DAO_Website::export());
1378
1379 if ($contactType != 'All') {
1380 $fields = array_merge($fields,
1381 CRM_Core_BAO_CustomField::getFieldsForImport($contactType, $status, TRUE, $search, TRUE, $withMultiRecord)
1382 );
1383 }
1384 else {
1385 foreach (array(
1386 'Individual', 'Household', 'Organization') as $type) {
1387 $fields = array_merge($fields,
1388 CRM_Core_BAO_CustomField::getFieldsForImport($type, FALSE, FALSE, $search, TRUE, $withMultiRecord)
1389 );
1390 }
1391 }
1392
1393 //fix for CRM-791
1394 if ($export) {
1395 $fields = array_merge($fields, array(
1396 'groups' => array(
1397 'title' => ts('Group(s)'),
1398 'name' => 'groups',
1399 ),
1400 'tags' => array(
1401 'title' => ts('Tag(s)'),
1402 'name' => 'tags',
1403 ),
1404 'notes' => array(
1405 'title' => ts('Note(s)'),
1406 'name' => 'notes',
1407 ),
1408 ));
1409 }
1410 else {
1411 $fields = array_merge($fields, array(
1412 'group' => array(
1413 'title' => ts('Group(s)'),
1414 'name' => 'group',
1415 ),
1416 'tag' => array(
1417 'title' => ts('Tag(s)'),
1418 'name' => 'tag',
1419 ),
1420 'note' => array(
1421 'title' => ts('Note(s)'),
1422 'name' => 'note',
1423 ),
1424 ));
1425 }
1426
1427 //Sorting fields in alphabetical order(CRM-1507)
1428 foreach ($fields as $k => $v) {
1429 $sortArray[$k] = CRM_Utils_Array::value('title', $v);
1430 }
1431
1432 $fields = array_merge($sortArray, $fields);
1433 //unset the field which are not related to their contact type.
1434 if ($contactType != 'All') {
1435 $commonValues = array(
1436 'Individual' => array(
1437 'household_name',
1438 'legal_name',
1439 'sic_code',
1440 'organization_name',
1441 'email_greeting_custom',
1442 'postal_greeting_custom',
1443 'addressee_custom',
1444 ),
1445 'Household' => array(
1446 'first_name',
1447 'middle_name',
1448 'last_name',
1449 'formal_title',
1450 'job_title',
1451 'gender_id',
1452 'prefix_id',
1453 'suffix_id',
1454 'birth_date',
1455 'organization_name',
1456 'legal_name',
1457 'legal_identifier',
1458 'sic_code',
1459 'home_URL',
1460 'is_deceased',
1461 'deceased_date',
1462 'current_employer',
1463 'email_greeting_custom',
1464 'postal_greeting_custom',
1465 'addressee_custom',
1466 'prefix_id',
1467 'suffix_id'
1468 ),
1469 'Organization' => array(
1470 'first_name',
1471 'middle_name',
1472 'last_name',
1473 'formal_title',
1474 'job_title',
1475 'gender_id',
1476 'prefix_id',
1477 'suffix_id',
1478 'birth_date',
1479 'household_name',
1480 'email_greeting_custom',
1481 'postal_greeting_custom',
1482 'prefix_id',
1483 'suffix_id',
1484 'gender_id',
1485 'addressee_custom',
1486 'is_deceased',
1487 'deceased_date',
1488 'current_employer',
1489 ),
1490 );
1491 foreach ($commonValues[$contactType] as $value) {
1492 unset($fields[$value]);
1493 }
1494 }
1495
1496 CRM_Core_BAO_Cache::setItem($fields, 'contact fields', $cacheKeyString);
1497 }
1498 self::$_exportableFields[$cacheKeyString] = $fields;
1499 }
1500
1501 if (!$status) {
1502 $fields = self::$_exportableFields[$cacheKeyString];
1503 }
1504 else {
1505 $fields = array_merge(array('' => array('title' => ts('- Contact Fields -'))),
1506 self::$_exportableFields[$cacheKeyString]
1507 );
1508 }
1509
1510 return $fields;
1511 }
1512
1513 /**
1514 * Function to get the all contact details(Hierarchical)
1515 *
1516 * @param int $contactId contact id
1517 * @param array $fields fields array
1518 *
1519 * @return $values array contains the contact details
1520 * @static
1521 * @access public
1522 */
1523 static function getHierContactDetails($contactId, &$fields) {
1524 $params = array(array('contact_id', '=', $contactId, 0, 0));
1525 $options = array();
1526
1527 $returnProperties = self::makeHierReturnProperties($fields, $contactId);
1528
1529 // we dont know the contents of return properties, but we need the lower level ids of the contact
1530 // so add a few fields
1531 $returnProperties['first_name'] =
1532 $returnProperties['organization_name'] =
1533 $returnProperties['household_name'] =
1534 $returnProperties['contact_type'] =
1535 $returnProperties['contact_sub_type'] = 1;
1536 return list($query, $options) = CRM_Contact_BAO_Query::apiQuery($params, $returnProperties, $options);
1537 }
1538
1539 /**
1540 * given a set of flat profile style field names, create a hierarchy
1541 * for query to use and crete the right sql
1542 *
1543 * @param $fields
1544 * @param int $contactId contact id
1545 *
1546 * @internal param array $properties a flat return properties name value array
1547 * @return array a hierarchical property tree if appropriate
1548 * @access public
1549 * @static
1550 */
1551 static function &makeHierReturnProperties($fields, $contactId = NULL) {
1552 $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
1553
1554 $returnProperties = array();
1555
1556 $multipleFields = array('website' => 'url');
1557 foreach ($fields as $name => $dontCare) {
1558 if (strpos($name, '-') !== FALSE) {
1559 list($fieldName, $id, $type) = CRM_Utils_System::explode('-', $name, 3);
1560
1561 if (!in_array($fieldName, $multipleFields)) {
1562 if ($id == 'Primary') {
1563 $locationTypeName = 1;
1564 }
1565 else {
1566 $locationTypeName = CRM_Utils_Array::value($id, $locationTypes);
1567 if (!$locationTypeName) {
1568 continue;
1569 }
1570 }
1571
1572 if (!CRM_Utils_Array::value('location', $returnProperties)) {
1573 $returnProperties['location'] = array();
1574 }
1575 if (!CRM_Utils_Array::value($locationTypeName, $returnProperties['location'])) {
1576 $returnProperties['location'][$locationTypeName] = array();
1577 $returnProperties['location'][$locationTypeName]['location_type'] = $id;
1578 }
1579 if (in_array($fieldName, array(
1580 'phone', 'im', 'email', 'openid', 'phone_ext'))) {
1581 if ($type) {
1582 $returnProperties['location'][$locationTypeName][$fieldName . '-' . $type] = 1;
1583 }
1584 else {
1585 $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1586 }
1587 }
1588 elseif (substr($fieldName, 0, 14) === 'address_custom') {
1589 $returnProperties['location'][$locationTypeName][substr($fieldName, 8)] = 1;
1590 }
1591 else {
1592 $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1593 }
1594 }
1595 else {
1596 $returnProperties['website'][$id][$fieldName] = 1;
1597 }
1598 }
1599 else {
1600 $returnProperties[$name] = 1;
1601 }
1602 }
1603
1604 return $returnProperties;
1605 }
1606
1607 /**
1608 * Function to return the primary location type of a contact
1609 *
1610 * $params int $contactId contact_id
1611 * $params boolean $isPrimaryExist if true, return primary contact location type otherwise null
1612 * $params boolean $skipDefaultPriamry if true, return primary contact location type otherwise null
1613 *
1614 * @param $contactId
1615 * @param bool $skipDefaultPriamry
1616 * @param null $block
1617 *
1618 * @return int $locationType location_type_id
1619 * @access public
1620 * @static
1621 */
1622 static function getPrimaryLocationType($contactId, $skipDefaultPriamry = FALSE, $block = NULL) {
1623 if($block){
1624 $entityBlock = array('contact_id' => $contactId);
1625 $blocks = CRM_Core_BAO_Location::getValues($entityBlock);
1626 foreach($blocks[$block] as $key => $value){
1627 if (CRM_Utils_Array::value('is_primary', $value)){
1628 $locationType = CRM_Utils_Array::value('location_type_id',$value);
1629 }
1630 }
1631 }
1632 else {
1633 $query = "
1634 SELECT
1635 IF ( civicrm_email.location_type_id IS NULL,
1636 IF ( civicrm_address.location_type_id IS NULL,
1637 IF ( civicrm_phone.location_type_id IS NULL,
1638 IF ( civicrm_im.location_type_id IS NULL,
1639 IF ( civicrm_openid.location_type_id IS NULL, null, civicrm_openid.location_type_id)
1640 ,civicrm_im.location_type_id)
1641 ,civicrm_phone.location_type_id)
1642 ,civicrm_address.location_type_id)
1643 ,civicrm_email.location_type_id) as locationType
1644 FROM civicrm_contact
1645 LEFT JOIN civicrm_email ON ( civicrm_email.is_primary = 1 AND civicrm_email.contact_id = civicrm_contact.id )
1646 LEFT JOIN civicrm_address ON ( civicrm_address.is_primary = 1 AND civicrm_address.contact_id = civicrm_contact.id)
1647 LEFT JOIN civicrm_phone ON ( civicrm_phone.is_primary = 1 AND civicrm_phone.contact_id = civicrm_contact.id)
1648 LEFT JOIN civicrm_im ON ( civicrm_im.is_primary = 1 AND civicrm_im.contact_id = civicrm_contact.id)
1649 LEFT JOIN civicrm_openid ON ( civicrm_openid.is_primary = 1 AND civicrm_openid.contact_id = civicrm_contact.id)
1650 WHERE civicrm_contact.id = %1 ";
1651
1652 $params = array(1 => array($contactId, 'Integer'));
1653
1654 $dao = CRM_Core_DAO::executeQuery($query, $params);
1655
1656 $locationType = NULL;
1657 if ($dao->fetch()) {
1658 $locationType = $dao->locationType;
1659 }
1660 }
1661 if (isset($locationType)) {
1662 return $locationType;
1663 }
1664 elseif ($skipDefaultPriamry) {
1665 // if there is no primary contact location then return null
1666 return NULL;
1667 }
1668 else {
1669 // if there is no primart contact location, then return default
1670 // location type of the system
1671 $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
1672 return $defaultLocationType->id;
1673 }
1674 }
1675
1676 /**
1677 * function to get the display name, primary email and location type of a contact
1678 *
1679 * @param int $id id of the contact
1680 *
1681 * @return array of display_name, email if found, do_not_email or (null,null,null)
1682 * @static
1683 * @access public
1684 */
1685 static function getContactDetails($id) {
1686 // check if the contact type
1687 $contactType = self::getContactType($id);
1688
1689 $nameFields = ($contactType == 'Individual') ? "civicrm_contact.first_name, civicrm_contact.last_name, civicrm_contact.display_name" : "civicrm_contact.display_name";
1690
1691 $sql = "
1692 SELECT $nameFields, civicrm_email.email, civicrm_contact.do_not_email, civicrm_email.on_hold, civicrm_contact.is_deceased
1693 FROM civicrm_contact LEFT JOIN civicrm_email ON (civicrm_contact.id = civicrm_email.contact_id)
1694 WHERE civicrm_contact.id = %1
1695 ORDER BY civicrm_email.is_primary DESC";
1696 $params = array(1 => array($id, 'Integer'));
1697 $dao = CRM_Core_DAO::executeQuery($sql, $params);
1698
1699 if ($dao->fetch()) {
1700 if ($contactType == 'Individual') {
1701 if ($dao->first_name || $dao->last_name) {
1702 $name = "{$dao->first_name} {$dao->last_name}";
1703 }
1704 else {
1705 $name = $dao->display_name;
1706 }
1707 }
1708 else {
1709 $name = $dao->display_name;
1710 }
1711 $email = $dao->email;
1712 $doNotEmail = $dao->do_not_email ? TRUE : FALSE;
1713 $onHold = $dao->on_hold ? TRUE : FALSE;
1714 $isDeceased = $dao->is_deceased ? TRUE : FALSE;
1715 return array($name, $email, $doNotEmail, $onHold, $isDeceased);
1716 }
1717 return array(NULL, NULL, NULL, NULL, NULL);
1718 }
1719
1720 /**
1721 * function to add/edit/register contacts through profile.
1722 *
1723 * @params array $params Array of profile fields to be edited/added.
1724 * @params int $contactID contact_id of the contact to be edited/added.
1725 * @params array $fields array of fields from UFGroup
1726 * @params int $addToGroupID specifies the default group to which contact is added.
1727 * @params int $ufGroupId uf group id (profile id)
1728 * @param string $ctype contact type
1729 * @param boolean $visibility basically lets us know where this request is coming from
1730 * if via a profile from web, we restrict what groups are changed
1731 *
1732 * @return int contact id created/edited
1733 * @static
1734 * @access public
1735 */
1736 static function createProfileContact(
1737 &$params,
1738 &$fields,
1739 $contactID = NULL,
1740 $addToGroupID = NULL,
1741 $ufGroupId = NULL,
1742 $ctype = NULL,
1743 $visibility = FALSE
1744 ) {
1745 // add ufGroupID to params array ( CRM-2012 )
1746 if ($ufGroupId) {
1747 $params['uf_group_id'] = $ufGroupId;
1748 }
1749
1750 if ($contactID) {
1751 $editHook = TRUE;
1752 CRM_Utils_Hook::pre('edit', 'Profile', $contactID, $params);
1753 }
1754 else {
1755 $editHook = FALSE;
1756 CRM_Utils_Hook::pre('create', 'Profile', NULL, $params);
1757 }
1758
1759 list($data, $contactDetails) = self::formatProfileContactParams($params, $fields, $contactID, $ufGroupId, $ctype);
1760
1761 // manage is_opt_out
1762 if (array_key_exists('is_opt_out', $fields) && array_key_exists('is_opt_out', $params)) {
1763 $wasOptOut = CRM_Utils_Array::value('is_opt_out', $contactDetails, FALSE);
1764 $isOptOut = CRM_Utils_Array::value('is_opt_out', $params, FALSE);
1765 $data['is_opt_out'] = $isOptOut;
1766 // on change, create new civicrm_subscription_history entry
1767 if (($wasOptOut != $isOptOut) &&
1768 CRM_Utils_Array::value('contact_id', $contactDetails)
1769 ) {
1770 $shParams = array(
1771 'contact_id' => $contactDetails['contact_id'],
1772 'status' => $isOptOut ? 'Removed' : 'Added',
1773 'method' => 'Web',
1774 );
1775 CRM_Contact_BAO_SubscriptionHistory::create($shParams);
1776 }
1777 }
1778
1779 $contact = self::create($data);
1780
1781 // contact is null if the profile does not have any contact fields
1782 if ($contact) {
1783 $contactID = $contact->id;
1784 }
1785
1786 if (empty($contactID)) {
1787 CRM_Core_Error::fatal('Cannot proceed without a valid contact id');
1788 }
1789
1790 // Process group and tag
1791 if (CRM_Utils_Array::value('group', $fields)) {
1792 $method = 'Admin';
1793 // this for sure means we are coming in via profile since i added it to fix
1794 // removing contacts from user groups -- lobo
1795 if ($visibility) {
1796 $method = 'Web';
1797 }
1798 CRM_Contact_BAO_GroupContact::create($params['group'], $contactID, $visibility, $method);
1799 }
1800
1801 if (CRM_Utils_Array::value('tag', $fields)) {
1802 CRM_Core_BAO_EntityTag::create($params['tag'], 'civicrm_contact', $contactID);
1803 }
1804
1805 //to add profile in default group
1806 if (is_array($addToGroupID)) {
1807 $contactIds = array($contactID);
1808 foreach ($addToGroupID as $groupId) {
1809 CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $groupId);
1810 }
1811 }
1812 elseif ($addToGroupID) {
1813 $contactIds = array($contactID);
1814 CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $addToGroupID);
1815 }
1816
1817 // reset the group contact cache for this group
1818 CRM_Contact_BAO_GroupContactCache::remove();
1819
1820 if ($editHook) {
1821 CRM_Utils_Hook::post('edit', 'Profile', $contactID, $params);
1822 }
1823 else {
1824 CRM_Utils_Hook::post('create', 'Profile', $contactID, $params);
1825 }
1826 return $contactID;
1827 }
1828
1829 static function formatProfileContactParams(
1830 &$params,
1831 &$fields,
1832 $contactID = NULL,
1833 $ufGroupId = NULL,
1834 $ctype = NULL,
1835 $skipCustom = FALSE
1836 ) {
1837
1838 $data = $contactDetails = array();
1839
1840 // get the contact details (hier)
1841 if ($contactID) {
1842 list($details, $options) = self::getHierContactDetails($contactID, $fields);
1843
1844 $contactDetails = $details[$contactID];
1845 $data['contact_type'] = CRM_Utils_Array::value('contact_type', $contactDetails);
1846 $data['contact_sub_type'] = CRM_Utils_Array::value('contact_sub_type', $contactDetails);
1847 }
1848 else {
1849 //we should get contact type only if contact
1850 if ($ufGroupId) {
1851 $data['contact_type'] = CRM_Core_BAO_UFField::getProfileType($ufGroupId);
1852
1853 //special case to handle profile with only contact fields
1854 if ($data['contact_type'] == 'Contact') {
1855 $data['contact_type'] = 'Individual';
1856 }
1857 elseif (CRM_Contact_BAO_ContactType::isaSubType($data['contact_type'])) {
1858 $data['contact_type'] = CRM_Contact_BAO_ContactType::getBasicType($data['contact_type']);
1859 }
1860 }
1861 elseif ($ctype) {
1862 $data['contact_type'] = $ctype;
1863 }
1864 else {
1865 $data['contact_type'] = 'Individual';
1866 }
1867 }
1868
1869 //fix contact sub type CRM-5125
1870 if (array_key_exists('contact_sub_type', $params) &&
1871 !empty($params['contact_sub_type'])
1872 ) {
1873 $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;
1874 }
1875 elseif (array_key_exists('contact_sub_type_hidden', $params) &&
1876 !empty($params['contact_sub_type_hidden'])
1877 ) {
1878 // if profile was used, and had any subtype, we obtain it from there
1879 $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;
1880 }
1881
1882 if ($ctype == 'Organization') {
1883 $data['organization_name'] = CRM_Utils_Array::value('organization_name', $contactDetails);
1884 }
1885 elseif ($ctype == 'Household') {
1886 $data['household_name'] = CRM_Utils_Array::value('household_name', $contactDetails);
1887 }
1888
1889 $locationType = array();
1890 $count = 1;
1891
1892 if ($contactID) {
1893 //add contact id
1894 $data['contact_id'] = $contactID;
1895 $primaryLocationType = self::getPrimaryLocationType($contactID);
1896 }
1897 else {
1898 $defaultLocation = CRM_Core_BAO_LocationType::getDefault();
1899 $defaultLocationId = $defaultLocation->id;
1900 }
1901
1902 // get the billing location type
1903 $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
1904 $billingLocationTypeId = array_search('Billing', $locationTypes);
1905
1906 $blocks = array('email', 'phone', 'im', 'openid');
1907
1908 $multiplFields = array('url');
1909 // prevent overwritten of formatted array, reset all block from
1910 // params if it is not in valid format (since import pass valid format)
1911 foreach ($blocks as $blk) {
1912 if (array_key_exists($blk, $params) &&
1913 !is_array($params[$blk])
1914 ) {
1915 unset($params[$blk]);
1916 }
1917 }
1918
1919 $primaryPhoneLoc = NULL;
1920 $session = CRM_Core_Session::singleton();
1921 foreach ($params as $key => $value) {
1922 $fieldName = $locTypeId = $typeId = NULL;
1923 list($fieldName, $locTypeId, $typeId) = CRM_Utils_System::explode('-', $key, 3);
1924
1925 //store original location type id
1926 $actualLocTypeId = $locTypeId;
1927
1928 if ($locTypeId == 'Primary') {
1929 if ($contactID) {
1930 if(in_array( $fieldName, $blocks)){
1931 $locTypeId = self::getPrimaryLocationType($contactID, FALSE, $fieldName);
1932 }
1933 else{
1934 $locTypeId = self::getPrimaryLocationType($contactID, FALSE, 'address');
1935 }
1936 $primaryLocationType = $locTypeId;
1937 }
1938 else {
1939 $locTypeId = $defaultLocationId;
1940 }
1941 }
1942
1943 if (is_numeric($locTypeId) &&
1944 !in_array($fieldName, $multiplFields) &&
1945 substr($fieldName, 0, 7) != 'custom_'
1946 ) {
1947 $index = $locTypeId;
1948
1949 if (is_numeric($typeId)) {
1950 $index .= '-' . $typeId;
1951 }
1952 if (!in_array($index, $locationType)) {
1953 $locationType[$count] = $index;
1954 $count++;
1955 }
1956
1957 $loc = CRM_Utils_Array::key($index, $locationType);
1958
1959 $blockName = in_array( $fieldName, $blocks) ? $fieldName : 'address';
1960
1961 $data[$blockName][$loc]['location_type_id'] = $locTypeId;
1962
1963 //set is_billing true, for location type "Billing"
1964 if ($locTypeId == $billingLocationTypeId) {
1965 $data[$blockName][$loc]['is_billing'] = 1;
1966 }
1967
1968 if ($contactID) {
1969 //get the primary location type
1970 if ($locTypeId == $primaryLocationType) {
1971 $data[$blockName][$loc]['is_primary'] = 1;
1972 }
1973 }
1974 elseif ($locTypeId == $defaultLocationId) {
1975 $data[$blockName][$loc]['is_primary'] = 1;
1976 }
1977
1978 if ( in_array($fieldName, array('phone'))) {
1979 if ($typeId) {
1980 $data['phone'][$loc]['phone_type_id'] = $typeId;
1981 }
1982 else {
1983 $data['phone'][$loc]['phone_type_id'] = '';
1984 }
1985 $data['phone'][$loc]['phone'] = $value;
1986
1987 //special case to handle primary phone with different phone types
1988 // in this case we make first phone type as primary
1989 if (isset($data['phone'][$loc]['is_primary']) && !$primaryPhoneLoc) {
1990 $primaryPhoneLoc = $loc;
1991 }
1992
1993 if ($loc != $primaryPhoneLoc) {
1994 unset($data['phone'][$loc]['is_primary']);
1995 }
1996 }
1997 elseif ($fieldName == 'phone_ext') {
1998 $data['phone'][$loc]['phone_ext'] = $value;
1999 }
2000 elseif ($fieldName == 'email') {
2001 $data['email'][$loc]['email'] = $value;
2002 }
2003 elseif ($fieldName == 'im') {
2004 if (isset($params[$key . '-provider_id'])) {
2005 $data['im'][$loc]['provider_id'] = $params[$key . '-provider_id'];
2006 }
2007 if (strpos($key, '-provider_id') !== FALSE) {
2008 $data['im'][$loc]['provider_id'] = $params[$key];
2009 }
2010 else {
2011 $data['im'][$loc]['name'] = $value;
2012 }
2013 }
2014 elseif ($fieldName == 'openid') {
2015 $data['openid'][$loc]['openid'] = $value;
2016 }
2017 else {
2018 if ($fieldName === 'state_province') {
2019 // CRM-3393
2020 if (is_numeric($value) && ((int ) $value) >= 1000) {
2021 $data['address'][$loc]['state_province_id'] = $value;
2022 }
2023 elseif (empty($value)) {
2024 $data['address'][$loc]['state_province_id'] = '';
2025 }
2026 else {
2027 $data['address'][$loc]['state_province'] = $value;
2028 }
2029 }
2030 elseif ($fieldName === 'country') {
2031 // CRM-3393
2032 if (is_numeric($value) && ((int ) $value) >= 1000
2033 ) {
2034 $data['address'][$loc]['country_id'] = $value;
2035 }
2036 elseif (empty($value)) {
2037 $data['address'][$loc]['country_id'] = '';
2038 }
2039 else {
2040 $data['address'][$loc]['country'] = $value;
2041 }
2042 }
2043 elseif ($fieldName === 'county') {
2044 $data['address'][$loc]['county_id'] = $value;
2045 }
2046 elseif ($fieldName == 'address_name') {
2047 $data['address'][$loc]['name'] = $value;
2048 }
2049 elseif (substr($fieldName, 0, 14) === 'address_custom') {
2050 $data['address'][$loc][substr($fieldName, 8)] = $value;
2051 }
2052 else {
2053 $data['address'][$loc][$fieldName] = $value;
2054 }
2055 }
2056 }
2057 else {
2058 if (substr($key, 0, 4) === 'url-') {
2059 $websiteField = explode('-', $key);
2060 if (isset($websiteField[2])) {
2061 $data['website'][$websiteField[1]]['website_type_id'] = $value;
2062 }
2063 else {
2064 $data['website'][$websiteField[1]]['url'] = $value;
2065 }
2066 }
2067 elseif (in_array($key, self::$_greetingTypes, TRUE)) {
2068 //save email/postal greeting and addressee values if any, CRM-4575
2069 $data[$key . '_id'] = $value;
2070 }
2071 elseif (!$skipCustom && ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($key))) {
2072 // for autocomplete transfer hidden value instead of label
2073 if ($params[$key] && isset($params[$key . '_id'])) {
2074 $value = $params[$key . '_id'];
2075 }
2076
2077 // we need to append time with date
2078 if ($params[$key] && isset($params[$key . '_time'])) {
2079 $value .= ' ' . $params[$key . '_time'];
2080 }
2081
2082 // if auth source is not checksum / login && $value is blank, do not proceed - CRM-10128
2083 if (($session->get('authSrc') & (CRM_Core_Permission::AUTH_SRC_CHECKSUM + CRM_Core_Permission::AUTH_SRC_LOGIN)) == 0 &&
2084 ($value == '' || !isset($value))) {
2085 continue;
2086 }
2087
2088 $valueId = NULL;
2089 if (CRM_Utils_Array::value('customRecordValues', $params)) {
2090 if (is_array($params['customRecordValues']) && !empty($params['customRecordValues'])) {
2091 foreach ($params['customRecordValues'] as $recId => $customFields) {
2092 if (is_array($customFields) && !empty($customFields)) {
2093 foreach ($customFields as $customFieldName) {
2094 if ($customFieldName == $key) {
2095 $valueId = $recId;
2096 break;
2097 }
2098 }
2099 }
2100 }
2101 }
2102 }
2103
2104 $type = $data['contact_type'];
2105 if ( CRM_Utils_Array::value('contact_sub_type', $data) ) {
2106 $type = $data['contact_sub_type'];
2107 $type = explode(CRM_Core_DAO::VALUE_SEPARATOR, trim($type, CRM_Core_DAO::VALUE_SEPARATOR));
2108 // generally a contact even if, has multiple subtypes the parent-type is going to be one only
2109 // and since formatCustomField() would be interested in parent type, lets consider only one subtype
2110 // as the results going to be same.
2111 $type = $type[0];
2112 }
2113
2114 CRM_Core_BAO_CustomField::formatCustomField($customFieldId,
2115 $data['custom'],
2116 $value,
2117 $type,
2118 $valueId,
2119 $contactID
2120 );
2121 }
2122 elseif ($key == 'edit') {
2123 continue;
2124 }
2125 else {
2126 if ($key == 'location') {
2127 foreach ($value as $locationTypeId => $field) {
2128 foreach ($field as $block => $val) {
2129 if ($block == 'address' && array_key_exists('address_name', $val)) {
2130 $value[$locationTypeId][$block]['name'] = $value[$locationTypeId][$block]['address_name'];
2131 }
2132 }
2133 }
2134 }
2135 if($key == 'phone' && isset($params['phone_ext'])){
2136 $data[$key] = $value;
2137 foreach($value as $cnt => $phoneBlock){
2138 if($params[$key][$cnt]['location_type_id'] == $params['phone_ext'][$cnt]['location_type_id']){
2139 $data[$key][$cnt]['phone_ext'] = CRM_Utils_Array::retrieveValueRecursive($params['phone_ext'][$cnt], 'phone_ext');
2140 }
2141 }
2142 }
2143 else if (in_array($key,
2144 array('nick_name',
2145 'job_title',
2146 'middle_name',
2147 'birth_date',
2148 'gender_id',
2149 'current_employer',
2150 'prefix_id',
2151 'suffix_id')) &&
2152 ($value == '' || !isset($value)) &&
2153 ($session->get('authSrc') & (CRM_Core_Permission::AUTH_SRC_CHECKSUM + CRM_Core_Permission::AUTH_SRC_LOGIN)) == 0) {
2154 // CRM-10128: if auth source is not checksum / login && $value is blank, do not fill $data with empty value
2155 // to avoid update with empty values
2156 continue;
2157 }
2158 else {
2159 $data[$key] = $value;
2160 }
2161 }
2162 }
2163 }
2164
2165 if (!isset($data['contact_type'])) {
2166 $data['contact_type'] = 'Individual';
2167 }
2168
2169 //set the values for checkboxes (do_not_email, do_not_mail, do_not_trade, do_not_phone)
2170 $privacy = CRM_Core_SelectValues::privacy();
2171 foreach ($privacy as $key => $value) {
2172 if (array_key_exists($key, $fields)) {
2173 // do not reset values for existing contacts, if fields are added to a profile
2174 if (array_key_exists($key, $params)) {
2175 $data[$key] = $params[$key];
2176 if (empty($params[$key])) {
2177 $data[$key] = 0;
2178 }
2179 }
2180 elseif (!$contactID) {
2181 $data[$key] = 0;
2182 }
2183 }
2184 }
2185
2186 return array($data, $contactDetails);
2187 }
2188
2189 /**
2190 * Function to find the get contact details
2191 * does not respect ACLs for now, which might need to be rectified at some
2192 * stage based on how its used
2193 *
2194 * @param string $mail primary email address of the contact
2195 * @param string $ctype contact type
2196 *
2197 * @return object $dao contact details
2198 * @static
2199 */
2200 static function &matchContactOnEmail($mail, $ctype = NULL) {
2201 $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
2202 $mail = $strtolower(trim($mail));
2203 $query = "
2204 SELECT civicrm_contact.id as contact_id,
2205 civicrm_contact.hash as hash,
2206 civicrm_contact.contact_type as contact_type,
2207 civicrm_contact.contact_sub_type as contact_sub_type
2208 FROM civicrm_contact
2209 INNER JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id )";
2210
2211
2212 if (CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MULTISITE_PREFERENCES_NAME,
2213 'uniq_email_per_site'
2214 )) {
2215 // try to find a match within a site (multisite).
2216 $groups = CRM_Core_BAO_Domain::getChildGroupIds();
2217 if (!empty($groups)) {
2218 $query .= "
2219 INNER JOIN civicrm_group_contact gc ON
2220 (civicrm_contact.id = gc.contact_id AND gc.status = 'Added' AND gc.group_id IN (" . implode(',', $groups) . "))";
2221 }
2222 }
2223
2224 $query .= "
2225 WHERE civicrm_email.email = %1 AND civicrm_contact.is_deleted=0";
2226 $p = array(1 => array($mail, 'String'));
2227
2228 if ($ctype) {
2229 $query .= " AND civicrm_contact.contact_type = %3";
2230 $p[3] = array($ctype, 'String');
2231 }
2232
2233 $query .= " ORDER BY civicrm_email.is_primary DESC";
2234
2235 $dao = CRM_Core_DAO::executeQuery($query, $p);
2236
2237 if ($dao->fetch()) {
2238 return $dao;
2239 }
2240 return CRM_Core_DAO::$_nullObject;
2241 }
2242
2243 /**
2244 * Function to find the contact details associated with an OpenID
2245 *
2246 * @param string $openId openId of the contact
2247 * @param string $ctype contact type
2248 *
2249 * @return object $dao contact details
2250 * @static
2251 */
2252 static function &matchContactOnOpenId($openId, $ctype = NULL) {
2253 $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
2254 $openId = $strtolower(trim($openId));
2255 $query = "
2256 SELECT civicrm_contact.id as contact_id,
2257 civicrm_contact.hash as hash,
2258 civicrm_contact.contact_type as contact_type,
2259 civicrm_contact.contact_sub_type as contact_sub_type
2260 FROM civicrm_contact
2261 INNER JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id )
2262 WHERE civicrm_openid.openid = %1";
2263 $p = array(1 => array($openId, 'String'));
2264
2265 if ($ctype) {
2266 $query .= " AND civicrm_contact.contact_type = %3";
2267 $p[3] = array($ctype, 'String');
2268 }
2269
2270 $query .= " ORDER BY civicrm_openid.is_primary DESC";
2271
2272 $dao = CRM_Core_DAO::executeQuery($query, $p);
2273
2274 if ($dao->fetch()) {
2275 return $dao;
2276 }
2277 return CRM_Core_DAO::$_nullObject;
2278 }
2279
2280 /**
2281 * Funtion to get primary email of the contact
2282 *
2283 * @param int $contactID contact id
2284 *
2285 * @return string $dao->email email address if present else null
2286 * @static
2287 * @access public
2288 */
2289 public static function getPrimaryEmail($contactID) {
2290 // fetch the primary email
2291 $query = "
2292 SELECT civicrm_email.email as email
2293 FROM civicrm_contact
2294 LEFT JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id )
2295 WHERE civicrm_email.is_primary = 1
2296 AND civicrm_contact.id = %1";
2297 $p = array(1 => array($contactID, 'Integer'));
2298 $dao = CRM_Core_DAO::executeQuery($query, $p);
2299
2300 $email = NULL;
2301 if ($dao->fetch()) {
2302 $email = $dao->email;
2303 }
2304 $dao->free();
2305 return $email;
2306 }
2307
2308 /**
2309 * Funtion to get primary OpenID of the contact
2310 *
2311 * @param int $contactID contact id
2312 *
2313 * @return string $dao->openid OpenID if present else null
2314 * @static
2315 * @access public
2316 */
2317 public static function getPrimaryOpenId($contactID) {
2318 // fetch the primary OpenID
2319 $query = "
2320 SELECT civicrm_openid.openid as openid
2321 FROM civicrm_contact
2322 LEFT JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id )
2323 WHERE civicrm_contact.id = %1
2324 AND civicrm_openid.is_primary = 1";
2325 $p = array(1 => array($contactID, 'Integer'));
2326 $dao = CRM_Core_DAO::executeQuery($query, $p);
2327
2328 $openId = NULL;
2329 if ($dao->fetch()) {
2330 $openId = $dao->openid;
2331 }
2332 $dao->free();
2333 return $openId;
2334 }
2335
2336 /**
2337 * Given the list of params in the params array, fetch the object
2338 * and store the values in the values array
2339 *
2340 * @param array $params input parameters to find object
2341 * @param array $values output values of the object
2342 *
2343 * @return CRM_Contact_BAO_Contact|null the found object or null
2344 * @access public
2345 * @static
2346 */
2347 public static function getValues(&$params, &$values) {
2348 $contact = new CRM_Contact_BAO_Contact();
2349
2350 $contact->copyValues($params);
2351
2352 if ($contact->find(TRUE)) {
2353
2354 CRM_Core_DAO::storeValues($contact, $values);
2355
2356 $privacy = array();
2357 foreach (self::$_commPrefs as $name) {
2358 if (isset($contact->$name)) {
2359 $privacy[$name] = $contact->$name;
2360 }
2361 }
2362
2363 if (!empty($privacy)) {
2364 $values['privacy'] = $privacy;
2365 }
2366
2367 // communication Prefferance
2368 $preffComm = $comm = array();
2369 $comm = explode(CRM_Core_DAO::VALUE_SEPARATOR,
2370 $contact->preferred_communication_method
2371 );
2372 foreach ($comm as $value) {
2373 $preffComm[$value] = 1;
2374 }
2375 $temp = array('preferred_communication_method' => $contact->preferred_communication_method);
2376
2377 $names = array(
2378 'preferred_communication_method' => array('newName' => 'preferred_communication_method_display',
2379 'groupName' => 'preferred_communication_method',
2380 ));
2381
2382 CRM_Core_OptionGroup::lookupValues($temp, $names, FALSE);
2383
2384 $values['preferred_communication_method'] = $preffComm;
2385 $values['preferred_communication_method_display'] = CRM_Utils_Array::value('preferred_communication_method_display', $temp);
2386
2387 CRM_Contact_DAO_Contact::addDisplayEnums($values);
2388
2389 // get preferred languages
2390 if (!empty($contact->preferred_language)) {
2391 $values['preferred_language'] = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $contact->preferred_language);
2392 }
2393
2394 // Calculating Year difference
2395 if ($contact->birth_date) {
2396 $birthDate = CRM_Utils_Date::customFormat($contact->birth_date, '%Y%m%d');
2397 if ($birthDate < date('Ymd')) {
2398 $age = CRM_Utils_Date::calculateAge($birthDate);
2399 $values['age']['y'] = CRM_Utils_Array::value('years', $age);
2400 $values['age']['m'] = CRM_Utils_Array::value('months', $age);
2401 }
2402
2403 list($values['birth_date']) = CRM_Utils_Date::setDateDefaults($contact->birth_date, 'birth');
2404 $values['birth_date_display'] = $contact->birth_date;
2405 }
2406
2407 if ($contact->deceased_date) {
2408 list($values['deceased_date']) = CRM_Utils_Date::setDateDefaults($contact->deceased_date, 'birth');
2409 $values['deceased_date_display'] = $contact->deceased_date;
2410 }
2411
2412 $contact->contact_id = $contact->id;
2413
2414 return $contact;
2415 }
2416 return NULL;
2417 }
2418
2419 /**
2420 * Given the component name and returns
2421 * the count of participation of contact
2422 *
2423 * @param string $component input component name
2424 * @param integer $contactId input contact id
2425 * @param string $tableName optional tableName if component is custom group
2426 *
2427 * @return total number of count of occurence in database
2428 * @access public
2429 * @static
2430 */
2431 static function getCountComponent($component, $contactId, $tableName = NULL) {
2432 $object = NULL;
2433 switch ($component) {
2434 case 'tag':
2435 return CRM_Core_BAO_EntityTag::getContactTags($contactId, TRUE);
2436
2437 case 'rel':
2438 return CRM_Contact_BAO_Relationship::getRelationship($contactId,
2439 CRM_Contact_BAO_Relationship::CURRENT,
2440 0, 1
2441 );
2442
2443 case 'group':
2444 return CRM_Contact_BAO_GroupContact::getContactGroup($contactId, "Added", NULL, TRUE);
2445
2446 case 'log':
2447 if (CRM_Core_BAO_Log::useLoggingReport()) {
2448 return FALSE;
2449 }
2450 return CRM_Core_BAO_Log::getContactLogCount($contactId);
2451
2452 case 'note':
2453 return CRM_Core_BAO_Note::getContactNoteCount($contactId);
2454
2455 case 'contribution':
2456 return CRM_Contribute_BAO_Contribution::contributionCount($contactId);
2457
2458 case 'membership':
2459 return CRM_Member_BAO_Membership::getContactMembershipCount($contactId, TRUE);
2460
2461 case 'participant':
2462 return CRM_Event_BAO_Participant::getContactParticipantCount($contactId);
2463
2464 case 'pledge':
2465 return CRM_Pledge_BAO_Pledge::getContactPledgeCount($contactId);
2466
2467 case 'case':
2468 return CRM_Case_BAO_Case::caseCount($contactId);
2469
2470 case 'grant':
2471 return CRM_Grant_BAO_Grant::getContactGrantCount($contactId);
2472
2473 case 'activity':
2474 $input = array(
2475 'contact_id' => $contactId,
2476 'admin' => FALSE,
2477 'caseId' => NULL,
2478 'context' => 'activity',
2479 );
2480 return CRM_Activity_BAO_Activity::getActivitiesCount($input);
2481
2482 case 'mailing':
2483 $params = array('contact_id' => $contactId);
2484 return CRM_Mailing_BAO_Mailing::getContactMailingsCount($params);
2485
2486 default:
2487 $custom = explode('_', $component);
2488 if ($custom['0'] = 'custom') {
2489 if (!$tableName) {
2490 $tableName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $custom['1'], 'table_name');
2491 }
2492 $queryString = "SELECT count(id) FROM {$tableName} WHERE entity_id = {$contactId}";
2493 return CRM_Core_DAO::singleValueQuery($queryString);
2494 }
2495 }
2496 }
2497
2498 /**
2499 * Function to process greetings and cache
2500 *
2501 * @param object $contact contact object after save
2502 * @param boolean $useDefaults use default greeting values
2503 *
2504 * @return void
2505 * @access public
2506 * @static
2507 */
2508 static function processGreetings(&$contact, $useDefaults = FALSE) {
2509 if ($useDefaults) {
2510 //retrieve default greetings
2511 $defaultGreetings = CRM_Core_PseudoConstant::greetingDefaults();
2512 $contactDefaults = $defaultGreetings[$contact->contact_type];
2513 }
2514
2515 // note that contact object not always has required greeting related
2516 // fields that are required to calculate greeting and
2517 // also other fields used in tokens etc,
2518 // hence we need to retrieve it again.
2519 $contact->find(TRUE);
2520
2521 // store object values to an array
2522 $contactDetails = array();
2523 CRM_Core_DAO::storeValues($contact, $contactDetails);
2524 $contactDetails = array(array($contact->id => $contactDetails));
2525
2526 $emailGreetingString = $postalGreetingString = $addresseeString = NULL;
2527 $updateQueryString = array();
2528
2529 //cache email and postal greeting to greeting display
2530 if ($contact->email_greeting_custom != 'null' && $contact->email_greeting_custom) {
2531 $emailGreetingString = $contact->email_greeting_custom;
2532 }
2533 elseif ($contact->email_greeting_id != 'null' && $contact->email_greeting_id) {
2534 // the filter value for Individual contact type is set to 1
2535 $filter = array(
2536 'contact_type' => $contact->contact_type,
2537 'greeting_type' => 'email_greeting',
2538 );
2539
2540 $emailGreeting = CRM_Core_PseudoConstant::greeting($filter);
2541 $emailGreetingString = $emailGreeting[$contact->email_greeting_id];
2542 $updateQueryString[] = " email_greeting_custom = NULL ";
2543 }
2544 else {
2545 if ($useDefaults) {
2546 reset($contactDefaults['email_greeting']);
2547 $emailGreetingID = key($contactDefaults['email_greeting']);
2548 $emailGreetingString = $contactDefaults['email_greeting'][$emailGreetingID];
2549 $updateQueryString[] = " email_greeting_id = $emailGreetingID ";
2550 $updateQueryString[] = " email_greeting_custom = NULL ";
2551 }
2552 elseif ($contact->email_greeting_custom) {
2553 $updateQueryString[] = " email_greeting_display = NULL ";
2554 }
2555 }
2556
2557 if ($emailGreetingString) {
2558 CRM_Contact_BAO_Contact_Utils::processGreetingTemplate($emailGreetingString,
2559 $contactDetails,
2560 $contact->id,
2561 'CRM_Contact_BAO_Contact'
2562 );
2563 $emailGreetingString = CRM_Core_DAO::escapeString(CRM_Utils_String::stripSpaces($emailGreetingString));
2564 $updateQueryString[] = " email_greeting_display = '{$emailGreetingString}'";
2565 }
2566
2567 //postal greetings
2568 if ($contact->postal_greeting_custom != 'null' && $contact->postal_greeting_custom) {
2569 $postalGreetingString = $contact->postal_greeting_custom;
2570 }
2571 elseif ($contact->postal_greeting_id != 'null' && $contact->postal_greeting_id) {
2572 $filter = array(
2573 'contact_type' => $contact->contact_type,
2574 'greeting_type' => 'postal_greeting',
2575 );
2576 $postalGreeting = CRM_Core_PseudoConstant::greeting($filter);
2577 $postalGreetingString = $postalGreeting[$contact->postal_greeting_id];
2578 $updateQueryString[] = " postal_greeting_custom = NULL ";
2579 }
2580 else {
2581 if ($useDefaults) {
2582 reset($contactDefaults['postal_greeting']);
2583 $postalGreetingID = key($contactDefaults['postal_greeting']);
2584 $postalGreetingString = $contactDefaults['postal_greeting'][$postalGreetingID];
2585 $updateQueryString[] = " postal_greeting_id = $postalGreetingID ";
2586 $updateQueryString[] = " postal_greeting_custom = NULL ";
2587 }
2588 elseif ($contact->postal_greeting_custom) {
2589 $updateQueryString[] = " postal_greeting_display = NULL ";
2590 }
2591 }
2592
2593 if ($postalGreetingString) {
2594 CRM_Contact_BAO_Contact_Utils::processGreetingTemplate($postalGreetingString,
2595 $contactDetails,
2596 $contact->id,
2597 'CRM_Contact_BAO_Contact'
2598 );
2599 $postalGreetingString = CRM_Core_DAO::escapeString(CRM_Utils_String::stripSpaces($postalGreetingString));
2600 $updateQueryString[] = " postal_greeting_display = '{$postalGreetingString}'";
2601 }
2602
2603 // addressee
2604 if ($contact->addressee_custom != 'null' && $contact->addressee_custom) {
2605 $addresseeString = $contact->addressee_custom;
2606 }
2607 elseif ($contact->addressee_id != 'null' && $contact->addressee_id) {
2608 $filter = array(
2609 'contact_type' => $contact->contact_type,
2610 'greeting_type' => 'addressee',
2611 );
2612
2613 $addressee = CRM_Core_PseudoConstant::greeting($filter);
2614 $addresseeString = $addressee[$contact->addressee_id];
2615 $updateQueryString[] = " addressee_custom = NULL ";
2616 }
2617 else {
2618 if ($useDefaults) {
2619 reset($contactDefaults['addressee']);
2620 $addresseeID = key($contactDefaults['addressee']);
2621 $addresseeString = $contactDefaults['addressee'][$addresseeID];
2622 $updateQueryString[] = " addressee_id = $addresseeID ";
2623 $updateQueryString[] = " addressee_custom = NULL ";
2624 }
2625 elseif ($contact->addressee_custom) {
2626 $updateQueryString[] = " addressee_display = NULL ";
2627 }
2628 }
2629
2630 if ($addresseeString) {
2631 CRM_Contact_BAO_Contact_Utils::processGreetingTemplate($addresseeString,
2632 $contactDetails,
2633 $contact->id,
2634 'CRM_Contact_BAO_Contact'
2635 );
2636 $addresseeString = CRM_Core_DAO::escapeString(CRM_Utils_String::stripSpaces($addresseeString));
2637 $updateQueryString[] = " addressee_display = '{$addresseeString}'";
2638 }
2639
2640 if (!empty($updateQueryString)) {
2641 $updateQueryString = implode(',', $updateQueryString);
2642 $queryString = "UPDATE civicrm_contact SET {$updateQueryString} WHERE id = {$contact->id}";
2643 CRM_Core_DAO::executeQuery($queryString);
2644 }
2645 }
2646
2647 /**
2648 * Function to retrieve loc block ids w/ given condition.
2649 *
2650 * @param int $contactId contact id.
2651 * @param array $criteria key => value pair which should be
2652 * fulfill by return record ids.
2653 * @param string $condOperator operator use for grouping multiple conditions.
2654 *
2655 * @return array $locBlockIds loc block ids which fulfill condition.
2656 * @static
2657 */
2658 static function getLocBlockIds($contactId, $criteria = array(), $condOperator = 'AND') {
2659 $locBlockIds = array();
2660 if (!$contactId) {
2661 return $locBlockIds;
2662 }
2663
2664 foreach (array('Email', 'OpenID', 'Phone', 'Address', 'IM') as $block) {
2665 $name = strtolower($block);
2666 $className = "CRM_Core_DAO_$block";
2667 $blockDAO = new $className();
2668
2669 // build the condition.
2670 if (is_array($criteria)) {
2671 $fields = $blockDAO->fields();
2672 $conditions = array();
2673 foreach ($criteria as $field => $value) {
2674 if (array_key_exists($field, $fields)) {
2675 $cond = "( $field = $value )";
2676 // value might be zero or null.
2677 if (!$value || strtolower($value) == 'null') {
2678 $cond = "( $field = 0 OR $field IS NULL )";
2679 }
2680 $conditions[] = $cond;
2681 }
2682 }
2683 if (!empty($conditions)) {
2684 $blockDAO->whereAdd(implode(" $condOperator ", $conditions));
2685 }
2686 }
2687
2688 $blockDAO->contact_id = $contactId;
2689 $blockDAO->find();
2690 while ($blockDAO->fetch()) {
2691 $locBlockIds[$name][] = $blockDAO->id;
2692 }
2693 $blockDAO->free();
2694 }
2695
2696 return $locBlockIds;
2697 }
2698
2699 /**
2700 * Function to build context menu items.
2701 *
2702 * @return array of context menu for logged in user.
2703 * @static
2704 */
2705 static function contextMenu($contactId = NULL) {
2706 $menu = array(
2707 'view' => array('title' => ts('View Contact'),
2708 'weight' => 0,
2709 'ref' => 'view-contact',
2710 'key' => 'view',
2711 'permissions' => array('view all contacts'),
2712 ),
2713 'add' => array('title' => ts('Edit Contact'),
2714 'weight' => 0,
2715 'ref' => 'edit-contact',
2716 'key' => 'add',
2717 'permissions' => array('edit all contacts'),
2718 ),
2719 'delete' => array('title' => ts('Delete Contact'),
2720 'weight' => 0,
2721 'ref' => 'delete-contact',
2722 'key' => 'delete',
2723 'permissions' => array('access deleted contacts', 'delete contacts'),
2724 ),
2725 'contribution' => array('title' => ts('Add Contribution'),
2726 'weight' => 5,
2727 'ref' => 'new-contribution',
2728 'key' => 'contribution',
2729 'component' => 'CiviContribute',
2730 'href' => CRM_Utils_System::url('civicrm/contact/view/contribution',
2731 'reset=1&action=add&context=contribution'
2732 ),
2733 'permissions' => array(
2734 'access CiviContribute',
2735 'edit contributions',
2736 ),
2737 ),
2738 'participant' => array('title' => ts('Register for Event'),
2739 'weight' => 10,
2740 'ref' => 'new-participant',
2741 'key' => 'participant',
2742 'component' => 'CiviEvent',
2743 'href' => CRM_Utils_System::url('civicrm/contact/view/participant', 'reset=1&action=add&context=participant'),
2744 'permissions' => array(
2745 'access CiviEvent',
2746 'edit event participants',
2747 ),
2748 ),
2749 'activity' => array('title' => ts('Record Activity'),
2750 'weight' => 35,
2751 'ref' => 'new-activity',
2752 'key' => 'activity',
2753 'permissions' => array('edit all contacts'),
2754 ),
2755 'pledge' => array('title' => ts('Add Pledge'),
2756 'weight' => 15,
2757 'ref' => 'new-pledge',
2758 'key' => 'pledge',
2759 'href' => CRM_Utils_System::url('civicrm/contact/view/pledge',
2760 'reset=1&action=add&context=pledge'
2761 ),
2762 'component' => 'CiviPledge',
2763 'permissions' => array(
2764 'access CiviPledge',
2765 'edit pledges',
2766 ),
2767 ),
2768 'membership' => array('title' => ts('Add Membership'),
2769 'weight' => 20,
2770 'ref' => 'new-membership',
2771 'key' => 'membership',
2772 'component' => 'CiviMember',
2773 'href' => CRM_Utils_System::url('civicrm/contact/view/membership',
2774 'reset=1&action=add&context=membership'
2775 ),
2776 'permissions' => array(
2777 'access CiviMember',
2778 'edit memberships',
2779 ),
2780 ),
2781 'case' => array('title' => ts('Add Case'),
2782 'weight' => 25,
2783 'ref' => 'new-case',
2784 'key' => 'case',
2785 'component' => 'CiviCase',
2786 'href' => CRM_Utils_System::url('civicrm/case/add', 'reset=1&action=add&context=case'),
2787 'permissions' => array('add cases'),
2788 ),
2789 'grant' => array('title' => ts('Add Grant'),
2790 'weight' => 26,
2791 'ref' => 'new-grant',
2792 'key' => 'grant',
2793 'component' => 'CiviGrant',
2794 'href' => CRM_Utils_System::url('civicrm/contact/view/grant',
2795 'reset=1&action=add&context=grant'
2796 ),
2797 'permissions' => array('edit grants'),
2798 ),
2799 'rel' => array('title' => ts('Add Relationship'),
2800 'weight' => 30,
2801 'ref' => 'new-relationship',
2802 'key' => 'rel',
2803 'href' => CRM_Utils_System::url('civicrm/contact/view/rel',
2804 'reset=1&action=add'
2805 ),
2806 'permissions' => array('edit all contacts'),
2807 ),
2808 'note' => array('title' => ts('Add Note'),
2809 'weight' => 40,
2810 'ref' => 'new-note',
2811 'key' => 'note',
2812 'href' => CRM_Utils_System::url('civicrm/contact/view/note',
2813 'reset=1&action=add'
2814 ),
2815 'permissions' => array('edit all contacts'),
2816 ),
2817 'email' => array('title' => ts('Send an Email'),
2818 'weight' => 45,
2819 'ref' => 'new-email',
2820 'key' => 'email',
2821 'permissions' => array('view all contacts'),
2822 ),
2823 'group' => array('title' => ts('Add to Group'),
2824 'weight' => 50,
2825 'ref' => 'group-add-contact',
2826 'key' => 'group',
2827 'permissions' => array('edit groups'),
2828 ),
2829 'tag' => array('title' => ts('Tag'),
2830 'weight' => 55,
2831 'ref' => 'tag-contact',
2832 'key' => 'tag',
2833 'permissions' => array('edit all contacts'),
2834 ),
2835 );
2836
2837 CRM_Utils_Hook::summaryActions($menu, $contactId);
2838 //1. check for component is active.
2839 //2. check for user permissions.
2840 //3. check for acls.
2841 //3. edit and view contact are directly accessible to user.
2842
2843 $aclPermissionedTasks = array(
2844 'view-contact', 'edit-contact', 'new-activity',
2845 'new-email', 'group-add-contact', 'tag-contact', 'delete-contact',
2846 );
2847 $corePermission = CRM_Core_Permission::getPermission();
2848
2849 $config = CRM_Core_Config::singleton();
2850
2851 $contextMenu = array();
2852 foreach ($menu as $key => $values) {
2853 $componentName = CRM_Utils_Array::value('component', $values);
2854
2855 // if component action - make sure component is enable.
2856 if ($componentName && !in_array($componentName, $config->enableComponents)) {
2857 continue;
2858 }
2859
2860 // make sure user has all required permissions.
2861 $hasAllPermissions = FALSE;
2862
2863 $permissions = CRM_Utils_Array::value('permissions', $values);
2864 if (!is_array($permissions) || empty($permissions)) {
2865 $hasAllPermissions = TRUE;
2866 }
2867
2868 // iterate for required permissions in given permissions array.
2869 if (!$hasAllPermissions) {
2870 $hasPermissions = 0;
2871 foreach ($permissions as $permission) {
2872 if (CRM_Core_Permission::check($permission)) {
2873 $hasPermissions++;
2874 }
2875 }
2876
2877 if (count($permissions) == $hasPermissions) {
2878 $hasAllPermissions = TRUE;
2879 }
2880
2881 // if still user does not have required permissions, check acl.
2882 if (!$hasAllPermissions && $values['ref'] != 'delete-contact') {
2883 if (in_array($values['ref'], $aclPermissionedTasks) &&
2884 $corePermission == CRM_Core_Permission::EDIT
2885 ) {
2886 $hasAllPermissions = TRUE;
2887 }
2888 elseif (in_array($values['ref'], array(
2889 'new-email'))) {
2890 // grant permissions for these tasks.
2891 $hasAllPermissions = TRUE;
2892 }
2893 }
2894 }
2895
2896 // user does not have necessary permissions.
2897 if (!$hasAllPermissions) {
2898 continue;
2899 }
2900
2901 // build directly accessible action menu.
2902 if (in_array($values['ref'], array(
2903 'view-contact', 'edit-contact'))) {
2904 $contextMenu['primaryActions'][$key] = array(
2905 'title' => $values['title'],
2906 'ref' => $values['ref'],
2907 'key' => $values['key'],
2908 );
2909 continue;
2910 }
2911
2912 // finally get menu item for -more- action widget.
2913 $contextMenu['moreActions'][$values['weight']] = array(
2914 'title' => $values['title'],
2915 'ref' => $values['ref'],
2916 'href' => CRM_Utils_Array::value('href', $values),
2917 'key' => $values['key'],
2918 );
2919 }
2920
2921 ksort($contextMenu['moreActions']);
2922
2923 return $contextMenu;
2924 }
2925
2926 /**
2927 * Function to retrieve display name of contact that address is shared
2928 * based on $masterAddressId or $contactId .
2929 *
2930 * @param int $masterAddressId master id.
2931 * @param int $contactId contact id.
2932 *
2933 * @return display name |null the found display name or null.
2934 * @access public
2935 * @static
2936 */
2937 static function getMasterDisplayName($masterAddressId = NULL, $contactId = NULL) {
2938 $masterDisplayName = NULL;
2939 $sql = NULL;
2940 if (!$masterAddressId && !$contactId) {
2941 return $masterDisplayName;
2942 }
2943
2944 if ($masterAddressId) {
2945 $sql = "
2946 SELECT display_name from civicrm_contact
2947 LEFT JOIN civicrm_address ON ( civicrm_address.contact_id = civicrm_contact.id )
2948 WHERE civicrm_address.id = " . $masterAddressId;
2949 }
2950 elseif ($contactId) {
2951 $sql = "
2952 SELECT display_name from civicrm_contact cc, civicrm_address add1
2953 LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id )
2954 WHERE cc.id = add2.contact_id AND add1.contact_id = " . $contactId;
2955 }
2956
2957 $masterDisplayName = CRM_Core_DAO::singleValueQuery($sql);
2958 return $masterDisplayName;
2959 }
2960
2961 /**
2962 * Get the creation/modification times for a contact
2963 *
2964 * @return array('created_date' => $, 'modified_date' => $)
2965 */
2966 static function getTimestamps($contactId) {
2967 $timestamps = CRM_Core_DAO::executeQuery(
2968 'SELECT created_date, modified_date
2969 FROM civicrm_contact
2970 WHERE id = %1',
2971 array(
2972 1 => array($contactId, 'Integer'),
2973 )
2974 );
2975 if ($timestamps->fetch()) {
2976 return array(
2977 'created_date' => $timestamps->created_date,
2978 'modified_date' => $timestamps->modified_date,
2979 );
2980 }
2981 else {
2982 return NULL;
2983 }
2984 }
2985
2986 /**
2987 * Get a list of triggers for the contact table
2988 *
2989 * @see hook_civicrm_triggerInfo
2990 * @see CRM_Core_DAO::triggerRebuild
2991 * @see http://issues.civicrm.org/jira/browse/CRM-10554
2992 */
2993 static function triggerInfo(&$info, $tableName = NULL) {
2994 //during upgrade, first check for valid version and then create triggers
2995 //i.e the columns created_date and modified_date are introduced in 4.3.alpha1 so dont create triggers for older version
2996 if (CRM_Core_Config::isUpgradeMode()) {
2997 $currentVer = CRM_Core_BAO_Domain::version(TRUE);
2998 //if current version is less than 4.3.alpha1 dont create below triggers
2999 if (version_compare($currentVer, '4.3.alpha1') < 0) {
3000 return;
3001 }
3002 }
3003
3004 if ($tableName == NULL || $tableName == self::getTableName()) {
3005 $info[] = array(
3006 'table' => array(self::getTableName()),
3007 'when' => 'BEFORE',
3008 'event' => array('INSERT'),
3009 'sql' => "\nSET NEW.created_date = CURRENT_TIMESTAMP;\n",
3010 );
3011 }
3012
3013 // Update timestamp when modifying closely related core tables
3014 $relatedTables = array(
3015 'civicrm_address',
3016 'civicrm_email',
3017 'civicrm_im',
3018 'civicrm_phone',
3019 'civicrm_website',
3020 );
3021 $info[] = array(
3022 'table' => $relatedTables,
3023 'when' => 'AFTER',
3024 'event' => array('INSERT', 'UPDATE'),
3025 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.contact_id;\n",
3026 );
3027 $info[] = array(
3028 'table' => $relatedTables,
3029 'when' => 'AFTER',
3030 'event' => array('DELETE'),
3031 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = OLD.contact_id;\n",
3032 );
3033
3034 // Update timestamp when modifying related custom-data tables
3035 $customGroupTables = array();
3036 $customGroupDAO = CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity('Contact');
3037 $customGroupDAO->is_multiple = 0;
3038 $customGroupDAO->find();
3039 while ($customGroupDAO->fetch()) {
3040 $customGroupTables[] = $customGroupDAO->table_name;
3041 }
3042 if (!empty($customGroupTables)) {
3043 $info[] = array(
3044 'table' => $customGroupTables,
3045 'when' => 'AFTER',
3046 'event' => array('INSERT', 'UPDATE'),
3047 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.entity_id;\n",
3048 );
3049 $info[] = array(
3050 'table' => $customGroupTables,
3051 'when' => 'AFTER',
3052 'event' => array('DELETE'),
3053 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = OLD.entity_id;\n",
3054 );
3055 }
3056
3057 // Update phone table to populate phone_numeric field
3058 if (!$tableName || $tableName == 'civicrm_phone') {
3059 // Define stored sql function needed for phones
3060 CRM_Core_DAO::executeQuery(self::DROP_STRIP_FUNCTION_43);
3061 CRM_Core_DAO::executeQuery(self::CREATE_STRIP_FUNCTION_43);
3062 $info[] = array(
3063 'table' => array('civicrm_phone'),
3064 'when' => 'BEFORE',
3065 'event' => array('INSERT', 'UPDATE'),
3066 'sql' => "\nSET NEW.phone_numeric = civicrm_strip_non_numeric(NEW.phone);\n",
3067 );
3068 }
3069 }
3070
3071 /**
3072 * Function to check if contact is being used in civicrm_domain
3073 * based on $contactId
3074 *
3075 * @param int $contactId contact id.
3076 *
3077 * @return true if present else false.
3078 * @access public
3079 * @static
3080 */
3081 static function checkDomainContact($contactId) {
3082 if (!$contactId)
3083 return FALSE;
3084 $domainId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Domain', $contactId, 'id', 'contact_id');
3085
3086 if ($domainId) {
3087 return TRUE;
3088 } else {
3089 return FALSE;
3090 }
3091 }
3092
3093 /**
3094 * Get options for a given contact field.
3095 * @see CRM_Core_DAO::buildOptions
3096 *
3097 * TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow?
3098 * TODO: In context of chainselect, what to return if e.g. a country has no states?
3099 *
3100 * @param String $fieldName
3101 * @param String $context: @see CRM_Core_DAO::buildOptionsContext
3102 * @param Array $props: whatever is known about this dao object
3103 */
3104 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3105 $params = array();
3106 // Special logic for fields whose options depend on context or properties
3107 switch ($fieldName) {
3108 case 'contact_sub_type':
3109 if (!empty($props['contact_type'])) {
3110 $params['condition'] = "parent_id = (SELECT id FROM civicrm_contact_type WHERE name='{$props['contact_type']}')";
3111 }
3112 break;
3113 }
3114 return CRM_Core_PseudoConstant::get(__CLASS__, $fieldName, $params, $context);
3115 }
3116
3117 /**
3118 * Delete a contact-related object that has an 'is_primary' field
3119 * Ensures that is_primary gets assigned to another object if available
3120 * Also calls pre/post hooks
3121 *
3122 * @var $type: object type
3123 * @var $id: object id
3124 */
3125 public static function deleteObjectWithPrimary($type, $id) {
3126 if (!$id || !is_numeric($id)) {
3127 return FALSE;
3128 }
3129 $daoName = "CRM_Core_DAO_$type";
3130 $obj = new $daoName();
3131 $obj->id = $id;
3132 $obj->find();
3133 if ($obj->fetch()) {
3134 CRM_Utils_Hook::pre('delete', $type, $id, CRM_Core_DAO::$_nullArray);
3135 $contactId = $obj->contact_id;
3136 $obj->delete();
3137 }
3138 else {
3139 return FALSE;
3140 }
3141 // is_primary is only relavent if this field belongs to a contact
3142 if ($contactId) {
3143 $dao = new $daoName();
3144 $dao->contact_id = $contactId;
3145 $dao->is_primary = 1;
3146 // Pick another record to be primary (if one isn't already)
3147 if (!$dao->find(TRUE)) {
3148 $dao->is_primary = 0;
3149 $dao->find();
3150 if ($dao->fetch()) {
3151 $dao->is_primary = 1;
3152 $dao->save();
3153 }
3154 }
3155 $dao->free();
3156 }
3157 CRM_Utils_Hook::post('delete', $type, $id, $obj);
3158 $obj->free();
3159 return TRUE;
3160 }
3161 }