projects / civicrm-core.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
remove newly introduced trailing spaces & tabs, new windows line-breaks also present...
[civicrm-core.git] / CRM / Contact / BAO / Contact.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
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']
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('household_name', 'legal_name', 'sic_code', 'organization_name'),
1181 'Household' => array(
1182 'first_name', 'middle_name', 'last_name', 'job_title',
1183 'gender_id', 'birth_date', 'organization_name', 'legal_name',
1184 'legal_identifier', 'sic_code', 'home_URL', 'is_deceased',
1185 'deceased_date',
1186 ),
1187 'Organization' => array(
1188 'first_name', 'middle_name', 'last_name', 'job_title',
1189 'gender_id', 'birth_date', 'household_name', 'is_deceased', 'deceased_date',
1190 ),
1191 );
1192 foreach ($commonValues[$contactType] as $value) {
1193 unset($fields[$value]);
1194 }
1195 }
1196 else {
1197 foreach (array(
1198 'Individual', 'Household', 'Organization') as $type) {
1199 $fields = array_merge($fields,
1200 CRM_Core_BAO_CustomField::getFieldsForImport($type,
1201 $showAll,
1202 FALSE,
1203 FALSE,
1204 FALSE,
1205 $withMultiCustomFields
1206 )
1207 );
1208 }
1209 }
1210
1211 if ($isProfile) {
1212 $fields = array_merge($fields, array('group' => array('title' => ts('Group(s)'),
1213 'name' => 'group',
1214 ),
1215 'tag' => array('title' => ts('Tag(s)'),
1216 'name' => 'tag',
1217 ),
1218 'note' => array('title' => ts('Note(s)'),
1219 'name' => 'note',
1220 ),
1221 ));
1222 }
1223
1224 //Sorting fields in alphabetical order(CRM-1507)
1225 $fields = CRM_Utils_Array::crmArraySortByField($fields, 'title');
1226
1227 CRM_Core_BAO_Cache::setItem($fields, 'contact fields', $cacheKeyString);
1228 }
1229
1230 self::$_importableFields[$cacheKeyString] = $fields;
1231
1232 if (!$isProfile) {
1233 if (!$status) {
1234 $fields = array_merge(array('do_not_import' => array('title' => ts('- do not import -'))),
1235 self::$_importableFields[$cacheKeyString]
1236 );
1237 }
1238 else {
1239 $fields = array_merge(array('' => array('title' => ts('- Contact Fields -'))),
1240 self::$_importableFields[$cacheKeyString]
1241 );
1242 }
1243 }
1244 return $fields;
1245 }
1246
1247 /**
1248 * combine all the exportable fields from the lower levels object
1249 *
1250 * currentlty we are using importable fields as exportable fields
1251 *
1252 * @param int $contactType contact Type
1253 * @param boolean $status true while exporting primary contacts
1254 * @param boolean $export true when used during export
1255 * @param boolean $search true when used during search, might conflict with export param?
1256 *
1257 * @return array array of exportable Fields
1258 * @access public
1259 * @static
1260 */
1261 static function &exportableFields($contactType = 'Individual', $status = FALSE, $export = FALSE, $search = FALSE, $withMultiRecord = FALSE) {
1262 if (empty($contactType)) {
1263 $contactType = 'All';
1264 }
1265
1266 $cacheKeyString = "exportableFields $contactType";
1267 $cacheKeyString .= $export ? '_1' : '_0';
1268 $cacheKeyString .= $status ? '_1' : '_0';
1269 $cacheKeyString .= $search ? '_1' : '_0';
1270
1271 if (!self::$_exportableFields || !CRM_Utils_Array::value($cacheKeyString, self::$_exportableFields)) {
1272 if (!self::$_exportableFields) {
1273 self::$_exportableFields = array();
1274 }
1275
1276 // check if we can retrieve from database cache
1277 $fields = CRM_Core_BAO_Cache::getItem('contact fields', $cacheKeyString);
1278
1279 if (!$fields) {
1280 $fields = array();
1281 $fields = CRM_Contact_DAO_Contact::export();
1282
1283 // the fields are meant for contact types
1284 if (
1285 in_array(
1286 $contactType,
1287 array('Individual', 'Household', 'Organization', 'All')
1288 )
1289 ) {
1290 $fields = array_merge($fields, CRM_Core_OptionValue::getFields('', $contactType));
1291 }
1292 // add current employer for individuals
1293 $fields = array_merge($fields, array(
1294 'current_employer' =>
1295 array(
1296 'name' => 'organization_name',
1297 'title' => ts('Current Employer'),
1298 ),
1299 ));
1300
1301 $locationType = array(
1302 'location_type' => array('name' => 'location_type',
1303 'where' => 'civicrm_location_type.name',
1304 'title' => ts('Location Type'),
1305 ));
1306
1307 $IMProvider = array(
1308 'im_provider' => array('name' => 'im_provider',
1309 'where' => 'civicrm_im.provider_id',
1310 'title' => ts('IM Provider'),
1311 ));
1312
1313 $locationFields = array_merge($locationType,
1314 CRM_Core_DAO_Address::export(),
1315 CRM_Core_DAO_Phone::export(),
1316 CRM_Core_DAO_Email::export(),
1317 $IMProvider,
1318 CRM_Core_DAO_IM::export(TRUE),
1319 CRM_Core_DAO_OpenID::export()
1320 );
1321
1322 $locationFields = array_merge($locationFields,
1323 CRM_Core_BAO_CustomField::getFieldsForImport('Address')
1324 );
1325
1326 foreach ($locationFields as $key => $field) {
1327 $locationFields[$key]['hasLocationType'] = TRUE;
1328 }
1329
1330 $fields = array_merge($fields, $locationFields);
1331
1332 //add world region
1333 $fields = array_merge($fields,
1334 CRM_Core_DAO_Worldregion::export()
1335 );
1336
1337
1338 $fields = array_merge($fields,
1339 CRM_Contact_DAO_Contact::export()
1340 );
1341
1342 //website fields
1343 $fields = array_merge($fields, CRM_Core_DAO_Website::export());
1344
1345 if ($contactType != 'All') {
1346 $fields = array_merge($fields,
1347 CRM_Core_BAO_CustomField::getFieldsForImport($contactType, $status, TRUE, $search, TRUE, $withMultiRecord)
1348 );
1349 }
1350 else {
1351 foreach (array(
1352 'Individual', 'Household', 'Organization') as $type) {
1353 $fields = array_merge($fields,
1354 CRM_Core_BAO_CustomField::getFieldsForImport($type, FALSE, FALSE, $search, TRUE, $withMultiRecord)
1355 );
1356 }
1357 }
1358
1359 //fix for CRM-791
1360 if ($export) {
1361 $fields = array_merge($fields, array('groups' => array('title' => ts('Group(s)'),
1362 'name' => 'groups',
1363 ),
1364 'tags' => array('title' => ts('Tag(s)'),
1365 'name' => 'tags',
1366 ),
1367 'notes' => array('title' => ts('Note(s)'),
1368 'name' => 'notes',
1369 ),
1370 ));
1371 }
1372 else {
1373 $fields = array_merge($fields, array('group' => array('title' => ts('Group(s)'),
1374 'name' => 'group',
1375 ),
1376 'tag' => array('title' => ts('Tag(s)'),
1377 'name' => 'tag',
1378 ),
1379 'note' => array('title' => ts('Note(s)'),
1380 'name' => 'note',
1381 ),
1382 ));
1383 }
1384
1385 //Sorting fields in alphabetical order(CRM-1507)
1386 foreach ($fields as $k => $v) {
1387 $sortArray[$k] = CRM_Utils_Array::value('title', $v);
1388 }
1389
1390 $fields = array_merge($sortArray, $fields);
1391 //unset the field which are not related to their contact type.
1392 if ($contactType != 'All') {
1393 $commonValues = array(
1394 'Individual' => array('household_name', 'legal_name', 'sic_code', 'organization_name',
1395 'email_greeting_custom', 'postal_greeting_custom',
1396 'addressee_custom',
1397 ),
1398 'Household' => array(
1399 'first_name', 'middle_name', 'last_name', 'job_title',
1400 'gender_id', 'birth_date', 'organization_name', 'legal_name',
1401 'legal_identifier', 'sic_code', 'home_URL', 'is_deceased',
1402 'deceased_date', 'current_employer', 'email_greeting_custom',
1403 'postal_greeting_custom', 'addressee_custom',
1404 'prefix_id', 'suffix_id'
1405 ),
1406 'Organization' => array(
1407 'first_name', 'middle_name', 'last_name', 'job_title',
1408 'gender_id', 'birth_date', 'household_name',
1409 'email_greeting_custom',
1410 'postal_greeting_custom', 'prefix_id',
1411 'suffix_id', 'gender_id', 'addressee_custom',
1412 'is_deceased', 'deceased_date', 'current_employer',
1413 ),
1414 );
1415 foreach ($commonValues[$contactType] as $value) {
1416 unset($fields[$value]);
1417 }
1418 }
1419
1420 CRM_Core_BAO_Cache::setItem($fields, 'contact fields', $cacheKeyString);
1421 }
1422 self::$_exportableFields[$cacheKeyString] = $fields;
1423 }
1424
1425 if (!$status) {
1426 $fields = self::$_exportableFields[$cacheKeyString];
1427 }
1428 else {
1429 $fields = array_merge(array('' => array('title' => ts('- Contact Fields -'))),
1430 self::$_exportableFields[$cacheKeyString]
1431 );
1432 }
1433
1434 return $fields;
1435 }
1436
1437 /**
1438 * Function to get the all contact details(Hierarchical)
1439 *
1440 * @param int $contactId contact id
1441 * @param array $fields fields array
1442 *
1443 * @return $values array contains the contact details
1444 * @static
1445 * @access public
1446 */
1447 static function getHierContactDetails($contactId, &$fields) {
1448 $params = array(array('contact_id', '=', $contactId, 0, 0));
1449 $options = array();
1450
1451 $returnProperties = self::makeHierReturnProperties($fields, $contactId);
1452
1453 // we dont know the contents of return properties, but we need the lower level ids of the contact
1454 // so add a few fields
1455 $returnProperties['first_name'] =
1456 $returnProperties['organization_name'] =
1457 $returnProperties['household_name'] =
1458 $returnProperties['contact_type'] =
1459 $returnProperties['contact_sub_type'] = 1;
1460 return list($query, $options) = CRM_Contact_BAO_Query::apiQuery($params, $returnProperties, $options);
1461 }
1462
1463 /**
1464 * given a set of flat profile style field names, create a hierarchy
1465 * for query to use and crete the right sql
1466 *
1467 * @param array $properties a flat return properties name value array
1468 * @param int $contactId contact id
1469 *
1470 * @return array a hierarchical property tree if appropriate
1471 * @access public
1472 * @static
1473 */
1474 static function &makeHierReturnProperties($fields, $contactId = NULL) {
1475 $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
1476
1477 $returnProperties = array();
1478
1479 $multipleFields = array('website' => 'url');
1480 foreach ($fields as $name => $dontCare) {
1481 if (strpos($name, '-') !== FALSE) {
1482 list($fieldName, $id, $type) = CRM_Utils_System::explode('-', $name, 3);
1483
1484 if (!in_array($fieldName, $multipleFields)) {
1485 if ($id == 'Primary') {
1486 $locationTypeName = 1;
1487 }
1488 else {
1489 $locationTypeName = CRM_Utils_Array::value($id, $locationTypes);
1490 if (!$locationTypeName) {
1491 continue;
1492 }
1493 }
1494
1495 if (!CRM_Utils_Array::value('location', $returnProperties)) {
1496 $returnProperties['location'] = array();
1497 }
1498 if (!CRM_Utils_Array::value($locationTypeName, $returnProperties['location'])) {
1499 $returnProperties['location'][$locationTypeName] = array();
1500 $returnProperties['location'][$locationTypeName]['location_type'] = $id;
1501 }
1502 if (in_array($fieldName, array(
1503 'phone', 'im', 'email', 'openid', 'phone_ext'))) {
1504 if ($type) {
1505 $returnProperties['location'][$locationTypeName][$fieldName . '-' . $type] = 1;
1506 }
1507 else {
1508 $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1509 }
1510 }
1511 elseif (substr($fieldName, 0, 14) === 'address_custom') {
1512 $returnProperties['location'][$locationTypeName][substr($fieldName, 8)] = 1;
1513 }
1514 else {
1515 $returnProperties['location'][$locationTypeName][$fieldName] = 1;
1516 }
1517 }
1518 else {
1519 $returnProperties['website'][$id][$fieldName] = 1;
1520 }
1521 }
1522 else {
1523 $returnProperties[$name] = 1;
1524 }
1525 }
1526
1527 return $returnProperties;
1528 }
1529
1530 /**
1531 * Function to return the primary location type of a contact
1532 *
1533 * $params int $contactId contact_id
1534 * $params boolean $isPrimaryExist if true, return primary contact location type otherwise null
1535 * $params boolean $skipDefaultPriamry if true, return primary contact location type otherwise null
1536 *
1537 * @return int $locationType location_type_id
1538 * @access public
1539 * @static
1540 */
1541 static function getPrimaryLocationType($contactId, $skipDefaultPriamry = FALSE, $block = NULL) {
1542 if($block){
1543 $entityBlock = array('contact_id' => $contactId);
1544 $blocks = CRM_Core_BAO_Location::getValues($entityBlock);
1545 foreach($blocks[$block] as $key => $value){
1546 if (CRM_Utils_Array::value('is_primary', $value)){
1547 $locationType = CRM_Utils_Array::value('location_type_id',$value);
1548 }
1549 }
1550 }
1551 else {
1552 $query = "
1553 SELECT
1554 IF ( civicrm_email.location_type_id IS NULL,
1555 IF ( civicrm_address.location_type_id IS NULL,
1556 IF ( civicrm_phone.location_type_id IS NULL,
1557 IF ( civicrm_im.location_type_id IS NULL,
1558 IF ( civicrm_openid.location_type_id IS NULL, null, civicrm_openid.location_type_id)
1559 ,civicrm_im.location_type_id)
1560 ,civicrm_phone.location_type_id)
1561 ,civicrm_address.location_type_id)
1562 ,civicrm_email.location_type_id) as locationType
1563 FROM civicrm_contact
1564 LEFT JOIN civicrm_email ON ( civicrm_email.is_primary = 1 AND civicrm_email.contact_id = civicrm_contact.id )
1565 LEFT JOIN civicrm_address ON ( civicrm_address.is_primary = 1 AND civicrm_address.contact_id = civicrm_contact.id)
1566 LEFT JOIN civicrm_phone ON ( civicrm_phone.is_primary = 1 AND civicrm_phone.contact_id = civicrm_contact.id)
1567 LEFT JOIN civicrm_im ON ( civicrm_im.is_primary = 1 AND civicrm_im.contact_id = civicrm_contact.id)
1568 LEFT JOIN civicrm_openid ON ( civicrm_openid.is_primary = 1 AND civicrm_openid.contact_id = civicrm_contact.id)
1569 WHERE civicrm_contact.id = %1 ";
1570
1571 $params = array(1 => array($contactId, 'Integer'));
1572
1573 $dao = CRM_Core_DAO::executeQuery($query, $params);
1574
1575 $locationType = NULL;
1576 if ($dao->fetch()) {
1577 $locationType = $dao->locationType;
1578 }
1579 }
1580 if (isset($locationType)) {
1581 return $locationType;
1582 }
1583 elseif ($skipDefaultPriamry) {
1584 // if there is no primary contact location then return null
1585 return NULL;
1586 }
1587 else {
1588 // if there is no primart contact location, then return default
1589 // location type of the system
1590 $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
1591 return $defaultLocationType->id;
1592 }
1593 }
1594
1595 /**
1596 * function to get the display name, primary email and location type of a contact
1597 *
1598 * @param int $id id of the contact
1599 *
1600 * @return array of display_name, email if found, do_not_email or (null,null,null)
1601 * @static
1602 * @access public
1603 */
1604 static function getContactDetails($id) {
1605 // check if the contact type
1606 $contactType = self::getContactType($id);
1607
1608 $nameFields = ($contactType == 'Individual') ? "civicrm_contact.first_name, civicrm_contact.last_name, civicrm_contact.display_name" : "civicrm_contact.display_name";
1609
1610 $sql = "
1611 SELECT $nameFields, civicrm_email.email, civicrm_contact.do_not_email, civicrm_email.on_hold, civicrm_contact.is_deceased
1612 FROM civicrm_contact LEFT JOIN civicrm_email ON (civicrm_contact.id = civicrm_email.contact_id)
1613 WHERE civicrm_contact.id = %1
1614 ORDER BY civicrm_email.is_primary DESC";
1615 $params = array(1 => array($id, 'Integer'));
1616 $dao = CRM_Core_DAO::executeQuery($sql, $params);
1617
1618 if ($dao->fetch()) {
1619 if ($contactType == 'Individual') {
1620 if ($dao->first_name || $dao->last_name) {
1621 $name = "{$dao->first_name} {$dao->last_name}";
1622 }
1623 else {
1624 $name = $dao->display_name;
1625 }
1626 }
1627 else {
1628 $name = $dao->display_name;
1629 }
1630 $email = $dao->email;
1631 $doNotEmail = $dao->do_not_email ? TRUE : FALSE;
1632 $onHold = $dao->on_hold ? TRUE : FALSE;
1633 $isDeceased = $dao->is_deceased ? TRUE : FALSE;
1634 return array($name, $email, $doNotEmail, $onHold, $isDeceased);
1635 }
1636 return array(NULL, NULL, NULL, NULL, NULL);
1637 }
1638
1639 /**
1640 * function to add/edit/register contacts through profile.
1641 *
1642 * @params array $params Array of profile fields to be edited/added.
1643 * @params int $contactID contact_id of the contact to be edited/added.
1644 * @params array $fields array of fields from UFGroup
1645 * @params int $addToGroupID specifies the default group to which contact is added.
1646 * @params int $ufGroupId uf group id (profile id)
1647 * @param string $ctype contact type
1648 * @param boolean $visibility basically lets us know where this request is coming from
1649 * if via a profile from web, we restrict what groups are changed
1650 *
1651 * @return int contact id created/edited
1652 * @static
1653 * @access public
1654 */
1655 static function createProfileContact(
1656 &$params,
1657 &$fields,
1658 $contactID = NULL,
1659 $addToGroupID = NULL,
1660 $ufGroupId = NULL,
1661 $ctype = NULL,
1662 $visibility = FALSE
1663 ) {
1664 // add ufGroupID to params array ( CRM-2012 )
1665 if ($ufGroupId) {
1666 $params['uf_group_id'] = $ufGroupId;
1667 }
1668
1669 if ($contactID) {
1670 $editHook = TRUE;
1671 CRM_Utils_Hook::pre('edit', 'Profile', $contactID, $params);
1672 }
1673 else {
1674 $editHook = FALSE;
1675 CRM_Utils_Hook::pre('create', 'Profile', NULL, $params);
1676 }
1677
1678 list($data, $contactDetails) = self::formatProfileContactParams($params, $fields, $contactID, $ufGroupId, $ctype);
1679
1680 // manage is_opt_out
1681 if (array_key_exists('is_opt_out', $fields) && array_key_exists('is_opt_out', $params)) {
1682 $wasOptOut = CRM_Utils_Array::value('is_opt_out', $contactDetails, FALSE);
1683 $isOptOut = CRM_Utils_Array::value('is_opt_out', $params, FALSE);
1684 $data['is_opt_out'] = $isOptOut;
1685 // on change, create new civicrm_subscription_history entry
1686 if (($wasOptOut != $isOptOut) &&
1687 CRM_Utils_Array::value('contact_id', $contactDetails)
1688 ) {
1689 $shParams = array(
1690 'contact_id' => $contactDetails['contact_id'],
1691 'status' => $isOptOut ? 'Removed' : 'Added',
1692 'method' => 'Web',
1693 );
1694 CRM_Contact_BAO_SubscriptionHistory::create($shParams);
1695 }
1696 }
1697
1698 $contact = self::create($data);
1699
1700 // contact is null if the profile does not have any contact fields
1701 if ($contact) {
1702 $contactID = $contact->id;
1703 }
1704
1705 if (empty($contactID)) {
1706 CRM_Core_Error::fatal('Cannot proceed without a valid contact id');
1707 }
1708
1709 // Process group and tag
1710 if (CRM_Utils_Array::value('group', $fields)) {
1711 $method = 'Admin';
1712 // this for sure means we are coming in via profile since i added it to fix
1713 // removing contacts from user groups -- lobo
1714 if ($visibility) {
1715 $method = 'Web';
1716 }
1717 CRM_Contact_BAO_GroupContact::create($params['group'], $contactID, $visibility, $method);
1718 }
1719
1720 if (CRM_Utils_Array::value('tag', $fields)) {
1721 CRM_Core_BAO_EntityTag::create($params['tag'], 'civicrm_contact', $contactID);
1722 }
1723
1724 //to add profile in default group
1725 if (is_array($addToGroupID)) {
1726 $contactIds = array($contactID);
1727 foreach ($addToGroupID as $groupId) {
1728 CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $groupId);
1729 }
1730 }
1731 elseif ($addToGroupID) {
1732 $contactIds = array($contactID);
1733 CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $addToGroupID);
1734 }
1735
1736 // reset the group contact cache for this group
1737 CRM_Contact_BAO_GroupContactCache::remove();
1738
1739 if ($editHook) {
1740 CRM_Utils_Hook::post('edit', 'Profile', $contactID, $params);
1741 }
1742 else {
1743 CRM_Utils_Hook::post('create', 'Profile', $contactID, $params);
1744 }
1745 return $contactID;
1746 }
1747
1748 static function formatProfileContactParams(
1749 &$params,
1750 &$fields,
1751 $contactID = NULL,
1752 $ufGroupId = NULL,
1753 $ctype = NULL,
1754 $skipCustom = FALSE
1755 ) {
1756
1757 $data = $contactDetails = array();
1758
1759 // get the contact details (hier)
1760 if ($contactID) {
1761 list($details, $options) = self::getHierContactDetails($contactID, $fields);
1762
1763 $contactDetails = $details[$contactID];
1764 $data['contact_type'] = CRM_Utils_Array::value('contact_type', $contactDetails);
1765 $data['contact_sub_type'] = CRM_Utils_Array::value('contact_sub_type', $contactDetails);
1766 }
1767 else {
1768 //we should get contact type only if contact
1769 if ($ufGroupId) {
1770 $data['contact_type'] = CRM_Core_BAO_UFField::getProfileType($ufGroupId);
1771
1772 //special case to handle profile with only contact fields
1773 if ($data['contact_type'] == 'Contact') {
1774 $data['contact_type'] = 'Individual';
1775 }
1776 elseif (CRM_Contact_BAO_ContactType::isaSubType($data['contact_type'])) {
1777 $data['contact_type'] = CRM_Contact_BAO_ContactType::getBasicType($data['contact_type']);
1778 }
1779 }
1780 elseif ($ctype) {
1781 $data['contact_type'] = $ctype;
1782 }
1783 else {
1784 $data['contact_type'] = 'Individual';
1785 }
1786 }
1787
1788 //fix contact sub type CRM-5125
1789 if (array_key_exists('contact_sub_type', $params) &&
1790 !empty($params['contact_sub_type'])
1791 ) {
1792 $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;
1793 }
1794 elseif (array_key_exists('contact_sub_type_hidden', $params) &&
1795 !empty($params['contact_sub_type_hidden'])
1796 ) {
1797 // if profile was used, and had any subtype, we obtain it from there
1798 $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;
1799 }
1800
1801 if ($ctype == 'Organization') {
1802 $data['organization_name'] = CRM_Utils_Array::value('organization_name', $contactDetails);
1803 }
1804 elseif ($ctype == 'Household') {
1805 $data['household_name'] = CRM_Utils_Array::value('household_name', $contactDetails);
1806 }
1807
1808 $locationType = array();
1809 $count = 1;
1810
1811 if ($contactID) {
1812 //add contact id
1813 $data['contact_id'] = $contactID;
1814 $primaryLocationType = self::getPrimaryLocationType($contactID);
1815 }
1816 else {
1817 $defaultLocation = CRM_Core_BAO_LocationType::getDefault();
1818 $defaultLocationId = $defaultLocation->id;
1819 }
1820
1821 // get the billing location type
1822 $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
1823 $billingLocationTypeId = array_search('Billing', $locationTypes);
1824
1825 $blocks = array('email', 'phone', 'im', 'openid');
1826
1827 $multiplFields = array('url');
1828 // prevent overwritten of formatted array, reset all block from
1829 // params if it is not in valid format (since import pass valid format)
1830 foreach ($blocks as $blk) {
1831 if (array_key_exists($blk, $params) &&
1832 !is_array($params[$blk])
1833 ) {
1834 unset($params[$blk]);
1835 }
1836 }
1837
1838 $primaryPhoneLoc = NULL;
1839 foreach ($params as $key => $value) {
1840 $fieldName = $locTypeId = $typeId = NULL;
1841 list($fieldName, $locTypeId, $typeId) = CRM_Utils_System::explode('-', $key, 3);
1842
1843 //store original location type id
1844 $actualLocTypeId = $locTypeId;
1845
1846 if ($locTypeId == 'Primary') {
1847 if ($contactID) {
1848 if(in_array( $fieldName, $blocks)){
1849 $locTypeId = self::getPrimaryLocationType($contactID, FALSE, $fieldName);
1850 }
1851 else{
1852 $locTypeId = self::getPrimaryLocationType($contactID, FALSE, 'address');
1853 }
1854 $primaryLocationType = $locTypeId;
1855 }
1856 else {
1857 $locTypeId = $defaultLocationId;
1858 }
1859 }
1860
1861 if (is_numeric($locTypeId) &&
1862 !in_array($fieldName, $multiplFields) &&
1863 substr($fieldName, 0, 7) != 'custom_'
1864 ) {
1865 $index = $locTypeId;
1866
1867 if (is_numeric($typeId)) {
1868 $index .= '-' . $typeId;
1869 }
1870 if (!in_array($index, $locationType)) {
1871 $locationType[$count] = $index;
1872 $count++;
1873 }
1874
1875 $loc = CRM_Utils_Array::key($index, $locationType);
1876
1877 $blockName = in_array( $fieldName, $blocks) ? $fieldName : 'address';
1878
1879 $data[$blockName][$loc]['location_type_id'] = $locTypeId;
1880
1881 //set is_billing true, for location type "Billing"
1882 if ($locTypeId == $billingLocationTypeId) {
1883 $data[$blockName][$loc]['is_billing'] = 1;
1884 }
1885
1886 if ($contactID) {
1887 //get the primary location type
1888 if ($locTypeId == $primaryLocationType) {
1889 $data[$blockName][$loc]['is_primary'] = 1;
1890 }
1891 }
1892 elseif ($locTypeId == $defaultLocationId) {
1893 $data[$blockName][$loc]['is_primary'] = 1;
1894 }
1895
1896 if ( in_array($fieldName, array('phone'))) {
1897 if ($typeId) {
1898 $data['phone'][$loc]['phone_type_id'] = $typeId;
1899 }
1900 else {
1901 $data['phone'][$loc]['phone_type_id'] = '';
1902 }
1903 $data['phone'][$loc]['phone'] = $value;
1904
1905 //special case to handle primary phone with different phone types
1906 // in this case we make first phone type as primary
1907 if (isset($data['phone'][$loc]['is_primary']) && !$primaryPhoneLoc) {
1908 $primaryPhoneLoc = $loc;
1909 }
1910
1911 if ($loc != $primaryPhoneLoc) {
1912 unset($data['phone'][$loc]['is_primary']);
1913 }
1914 }
1915 elseif ($fieldName == 'phone_ext') {
1916 $data['phone'][$loc]['phone_ext'] = $value;
1917 }
1918 elseif ($fieldName == 'email') {
1919 $data['email'][$loc]['email'] = $value;
1920 }
1921 elseif ($fieldName == 'im') {
1922 if (isset($params[$key . '-provider_id'])) {
1923 $data['im'][$loc]['provider_id'] = $params[$key . '-provider_id'];
1924 }
1925 if (strpos($key, '-provider_id') !== FALSE) {
1926 $data['im'][$loc]['provider_id'] = $params[$key];
1927 }
1928 else {
1929 $data['im'][$loc]['name'] = $value;
1930 }
1931 }
1932 elseif ($fieldName == 'openid') {
1933 $data['openid'][$loc]['openid'] = $value;
1934 }
1935 else {
1936 if ($fieldName === 'state_province') {
1937 // CRM-3393
1938 if (is_numeric($value) && ((int ) $value) >= 1000) {
1939 $data['address'][$loc]['state_province_id'] = $value;
1940 }
1941 elseif (empty($value)) {
1942 $data['address'][$loc]['state_province_id'] = '';
1943 }
1944 else {
1945 $data['address'][$loc]['state_province'] = $value;
1946 }
1947 }
1948 elseif ($fieldName === 'country') {
1949 // CRM-3393
1950 if (is_numeric($value) && ((int ) $value) >= 1000
1951 ) {
1952 $data['address'][$loc]['country_id'] = $value;
1953 }
1954 elseif (empty($value)) {
1955 $data['address'][$loc]['country_id'] = '';
1956 }
1957 else {
1958 $data['address'][$loc]['country'] = $value;
1959 }
1960 }
1961 elseif ($fieldName === 'county') {
1962 $data['address'][$loc]['county_id'] = $value;
1963 }
1964 elseif ($fieldName == 'address_name') {
1965 $data['address'][$loc]['name'] = $value;
1966 }
1967 elseif (substr($fieldName, 0, 14) === 'address_custom') {
1968 $data['address'][$loc][substr($fieldName, 8)] = $value;
1969 }
1970 else {
1971 $data['address'][$loc][$fieldName] = $value;
1972 }
1973 }
1974 }
1975 else {
1976 if (substr($key, 0, 4) === 'url-') {
1977 $websiteField = explode('-', $key);
1978 if (isset($websiteField[2])) {
1979 $data['website'][$websiteField[1]]['website_type_id'] = $value;
1980 }
1981 else {
1982 $data['website'][$websiteField[1]]['url'] = $value;
1983 }
1984 }
1985 elseif ($key === 'individual_suffix') {
1986 $data['suffix_id'] = $value;
1987 }
1988 elseif ($key === 'individual_prefix') {
1989 $data['prefix_id'] = $value;
1990 }
1991 elseif ($key === 'gender') {
1992 $data['gender_id'] = $value;
1993 }
1994 //save email/postal greeting and addressee values if any, CRM-4575
1995 elseif (in_array($key, self::$_greetingTypes, TRUE)) {
1996 $data[$key . '_id'] = $value;
1997 }
1998 elseif (!$skipCustom && ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($key))) {
1999 // for autocomplete transfer hidden value instead of label
2000 if ($params[$key] && isset($params[$key . '_id'])) {
2001 $value = $params[$key . '_id'];
2002 }
2003
2004 // we need to append time with date
2005 if ($params[$key] && isset($params[$key . '_time'])) {
2006 $value .= ' ' . $params[$key . '_time'];
2007 }
2008
2009 $valueId = NULL;
2010 if (CRM_Utils_Array::value('customRecordValues', $params)) {
2011 if (is_array($params['customRecordValues']) && !empty($params['customRecordValues'])) {
2012 foreach ($params['customRecordValues'] as $recId => $customFields) {
2013 if (is_array($customFields) && !empty($customFields)) {
2014 foreach ($customFields as $customFieldName) {
2015 if ($customFieldName == $key) {
2016 $valueId = $recId;
2017 break;
2018 }
2019 }
2020 }
2021 }
2022 }
2023 }
2024
2025 $type = $data['contact_type'];
2026 if ( CRM_Utils_Array::value('contact_sub_type', $data) ) {
2027 $type = $data['contact_sub_type'];
2028 $type = explode(CRM_Core_DAO::VALUE_SEPARATOR, trim($type, CRM_Core_DAO::VALUE_SEPARATOR));
2029 // generally a contact even if, has multiple subtypes the parent-type is going to be one only
2030 // and since formatCustomField() would be interested in parent type, lets consider only one subtype
2031 // as the results going to be same.
2032 $type = $type[0];
2033 }
2034
2035 CRM_Core_BAO_CustomField::formatCustomField($customFieldId,
2036 $data['custom'],
2037 $value,
2038 $type,
2039 $valueId,
2040 $contactID
2041 );
2042 }
2043 elseif ($key == 'edit') {
2044 continue;
2045 }
2046 else {
2047 if ($key == 'location') {
2048 foreach ($value as $locationTypeId => $field) {
2049 foreach ($field as $block => $val) {
2050 if ($block == 'address' && array_key_exists('address_name', $val)) {
2051 $value[$locationTypeId][$block]['name'] = $value[$locationTypeId][$block]['address_name'];
2052 }
2053 }
2054 }
2055 }
2056 if($key == 'phone' && isset($params['phone_ext'])){
2057 $data[$key] = $value;
2058 foreach($value as $cnt => $phoneBlock){
2059 if($params[$key][$cnt]['location_type_id'] == $params['phone_ext'][$cnt]['location_type_id']){
2060 $data[$key][$cnt]['phone_ext'] = CRM_Utils_Array::retrieveValueRecursive($params['phone_ext'][$cnt], 'phone_ext');
2061 }
2062 }
2063 }
2064 else {
2065 $data[$key] = $value;
2066 }
2067 }
2068 }
2069 }
2070
2071 if (!isset($data['contact_type'])) {
2072 $data['contact_type'] = 'Individual';
2073 }
2074
2075 //set the values for checkboxes (do_not_email, do_not_mail, do_not_trade, do_not_phone)
2076 $privacy = CRM_Core_SelectValues::privacy();
2077 foreach ($privacy as $key => $value) {
2078 if (array_key_exists($key, $fields)) {
2079 if (array_key_exists($key, $params)) {
2080 $data[$key] = $params[$key];
2081 // dont reset it for existing contacts
2082 }
2083 elseif (!$contactID) {
2084 $data[$key] = 0;
2085 }
2086 }
2087 }
2088
2089 return array($data, $contactDetails);
2090 }
2091
2092 /**
2093 * Function to find the get contact details
2094 * does not respect ACLs for now, which might need to be rectified at some
2095 * stage based on how its used
2096 *
2097 * @param string $mail primary email address of the contact
2098 * @param string $ctype contact type
2099 *
2100 * @return object $dao contact details
2101 * @static
2102 */
2103 static function &matchContactOnEmail($mail, $ctype = NULL) {
2104 $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
2105 $mail = $strtolower(trim($mail));
2106 $query = "
2107 SELECT civicrm_contact.id as contact_id,
2108 civicrm_contact.hash as hash,
2109 civicrm_contact.contact_type as contact_type,
2110 civicrm_contact.contact_sub_type as contact_sub_type
2111 FROM civicrm_contact
2112 INNER JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id )";
2113
2114
2115 if (CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MULTISITE_PREFERENCES_NAME,
2116 'uniq_email_per_site'
2117 )) {
2118 // try to find a match within a site (multisite).
2119 $groups = CRM_Core_BAO_Domain::getChildGroupIds();
2120 if (!empty($groups)) {
2121 $query .= "
2122 INNER JOIN civicrm_group_contact gc ON
2123 (civicrm_contact.id = gc.contact_id AND gc.status = 'Added' AND gc.group_id IN (" . implode(',', $groups) . "))";
2124 }
2125 }
2126
2127 $query .= "
2128 WHERE civicrm_email.email = %1 AND civicrm_contact.is_deleted=0";
2129 $p = array(1 => array($mail, 'String'));
2130
2131 if ($ctype) {
2132 $query .= " AND civicrm_contact.contact_type = %3";
2133 $p[3] = array($ctype, 'String');
2134 }
2135
2136 $query .= " ORDER BY civicrm_email.is_primary DESC";
2137
2138 $dao = CRM_Core_DAO::executeQuery($query, $p);
2139
2140 if ($dao->fetch()) {
2141 return $dao;
2142 }
2143 return CRM_Core_DAO::$_nullObject;
2144 }
2145
2146 /**
2147 * Function to find the contact details associated with an OpenID
2148 *
2149 * @param string $openId openId of the contact
2150 * @param string $ctype contact type
2151 *
2152 * @return object $dao contact details
2153 * @static
2154 */
2155 static function &matchContactOnOpenId($openId, $ctype = NULL) {
2156 $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
2157 $openId = $strtolower(trim($openId));
2158 $query = "
2159 SELECT civicrm_contact.id as contact_id,
2160 civicrm_contact.hash as hash,
2161 civicrm_contact.contact_type as contact_type,
2162 civicrm_contact.contact_sub_type as contact_sub_type
2163 FROM civicrm_contact
2164 INNER JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id )
2165 WHERE civicrm_openid.openid = %1";
2166 $p = array(1 => array($openId, 'String'));
2167
2168 if ($ctype) {
2169 $query .= " AND civicrm_contact.contact_type = %3";
2170 $p[3] = array($ctype, 'String');
2171 }
2172
2173 $query .= " ORDER BY civicrm_openid.is_primary DESC";
2174
2175 $dao = CRM_Core_DAO::executeQuery($query, $p);
2176
2177 if ($dao->fetch()) {
2178 return $dao;
2179 }
2180 return CRM_Core_DAO::$_nullObject;
2181 }
2182
2183 /**
2184 * Funtion to get primary email of the contact
2185 *
2186 * @param int $contactID contact id
2187 *
2188 * @return string $dao->email email address if present else null
2189 * @static
2190 * @access public
2191 */
2192 public static function getPrimaryEmail($contactID) {
2193 // fetch the primary email
2194 $query = "
2195 SELECT civicrm_email.email as email
2196 FROM civicrm_contact
2197 LEFT JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id )
2198 WHERE civicrm_email.is_primary = 1
2199 AND civicrm_contact.id = %1";
2200 $p = array(1 => array($contactID, 'Integer'));
2201 $dao = CRM_Core_DAO::executeQuery($query, $p);
2202
2203 $email = NULL;
2204 if ($dao->fetch()) {
2205 $email = $dao->email;
2206 }
2207 $dao->free();
2208 return $email;
2209 }
2210
2211 /**
2212 * Funtion to get primary OpenID of the contact
2213 *
2214 * @param int $contactID contact id
2215 *
2216 * @return string $dao->openid OpenID if present else null
2217 * @static
2218 * @access public
2219 */
2220 public static function getPrimaryOpenId($contactID) {
2221 // fetch the primary OpenID
2222 $query = "
2223 SELECT civicrm_openid.openid as openid
2224 FROM civicrm_contact
2225 LEFT JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id )
2226 WHERE civicrm_contact.id = %1
2227 AND civicrm_openid.is_primary = 1";
2228 $p = array(1 => array($contactID, 'Integer'));
2229 $dao = CRM_Core_DAO::executeQuery($query, $p);
2230
2231 $openId = NULL;
2232 if ($dao->fetch()) {
2233 $openId = $dao->openid;
2234 }
2235 $dao->free();
2236 return $openId;
2237 }
2238
2239 /**
2240 * Given the list of params in the params array, fetch the object
2241 * and store the values in the values array
2242 *
2243 * @param array $params input parameters to find object
2244 * @param array $values output values of the object
2245 *
2246 * @return CRM_Contact_BAO_Contact|null the found object or null
2247 * @access public
2248 * @static
2249 */
2250 public static function getValues(&$params, &$values) {
2251 $contact = new CRM_Contact_BAO_Contact();
2252
2253 $contact->copyValues($params);
2254
2255 if ($contact->find(TRUE)) {
2256
2257 CRM_Core_DAO::storeValues($contact, $values);
2258
2259 $privacy = array();
2260 foreach (self::$_commPrefs as $name) {
2261 if (isset($contact->$name)) {
2262 $privacy[$name] = $contact->$name;
2263 }
2264 }
2265
2266 if (!empty($privacy)) {
2267 $values['privacy'] = $privacy;
2268 }
2269
2270 // communication Prefferance
2271 $preffComm = $comm = array();
2272 $comm = explode(CRM_Core_DAO::VALUE_SEPARATOR,
2273 $contact->preferred_communication_method
2274 );
2275 foreach ($comm as $value) {
2276 $preffComm[$value] = 1;
2277 }
2278 $temp = array('preferred_communication_method' => $contact->preferred_communication_method);
2279
2280 $names = array(
2281 'preferred_communication_method' => array('newName' => 'preferred_communication_method_display',
2282 'groupName' => 'preferred_communication_method',
2283 ));
2284
2285 CRM_Core_OptionGroup::lookupValues($temp, $names, FALSE);
2286
2287 $values['preferred_communication_method'] = $preffComm;
2288 $values['preferred_communication_method_display'] = CRM_Utils_Array::value('preferred_communication_method_display', $temp);
2289
2290 CRM_Contact_DAO_Contact::addDisplayEnums($values);
2291
2292 // get preferred languages
2293 if (!empty($contact->preferred_language)) {
2294 $values['preferred_language'] = CRM_Core_PseudoConstant::getValue('CRM_Contact_DAO_Contact', 'preferred_language', $contact->preferred_language);
2295 }
2296
2297 // Calculating Year difference
2298 if ($contact->birth_date) {
2299 $birthDate = CRM_Utils_Date::customFormat($contact->birth_date, '%Y%m%d');
2300 if ($birthDate < date('Ymd')) {
2301 $age = CRM_Utils_Date::calculateAge($birthDate);
2302 $values['age']['y'] = CRM_Utils_Array::value('years', $age);
2303 $values['age']['m'] = CRM_Utils_Array::value('months', $age);
2304 }
2305
2306 list($values['birth_date']) = CRM_Utils_Date::setDateDefaults($contact->birth_date, 'birth');
2307 $values['birth_date_display'] = $contact->birth_date;
2308 }
2309
2310 if ($contact->deceased_date) {
2311 list($values['deceased_date']) = CRM_Utils_Date::setDateDefaults($contact->deceased_date, 'birth');
2312 $values['deceased_date_display'] = $contact->deceased_date;
2313 }
2314
2315 $contact->contact_id = $contact->id;
2316
2317 return $contact;
2318 }
2319 return NULL;
2320 }
2321
2322 /**
2323 * Given the component name and returns
2324 * the count of participation of contact
2325 *
2326 * @param string $component input component name
2327 * @param integer $contactId input contact id
2328 * @param string $tableName optional tableName if component is custom group
2329 *
2330 * @return total number of count of occurence in database
2331 * @access public
2332 * @static
2333 */
2334 static function getCountComponent($component, $contactId, $tableName = NULL) {
2335 $object = NULL;
2336 switch ($component) {
2337 case 'tag':
2338 return CRM_Core_BAO_EntityTag::getContactTags($contactId, TRUE);
2339
2340 case 'rel':
2341 return CRM_Contact_BAO_Relationship::getRelationship($contactId,
2342 CRM_Contact_BAO_Relationship::CURRENT,
2343 0, 1
2344 );
2345
2346 case 'group':
2347 return CRM_Contact_BAO_GroupContact::getContactGroup($contactId, "Added", NULL, TRUE);
2348
2349 case 'log':
2350 if (CRM_Core_BAO_Log::useLoggingReport()) {
2351 return FALSE;
2352 }
2353 return CRM_Core_BAO_Log::getContactLogCount($contactId);
2354
2355 case 'note':
2356 return CRM_Core_BAO_Note::getContactNoteCount($contactId);
2357
2358 case 'contribution':
2359 return CRM_Contribute_BAO_Contribution::contributionCount($contactId);
2360
2361 case 'membership':
2362 return CRM_Member_BAO_Membership::getContactMembershipCount($contactId, TRUE);
2363
2364 case 'participant':
2365 return CRM_Event_BAO_Participant::getContactParticipantCount($contactId);
2366
2367 case 'pledge':
2368 return CRM_Pledge_BAO_Pledge::getContactPledgeCount($contactId);
2369
2370 case 'case':
2371 return CRM_Case_BAO_Case::caseCount($contactId);
2372
2373 case 'grant':
2374 return CRM_Grant_BAO_Grant::getContactGrantCount($contactId);
2375
2376 case 'activity':
2377 $input = array(
2378 'contact_id' => $contactId,
2379 'admin' => FALSE,
2380 'caseId' => NULL,
2381 'context' => 'activity',
2382 );
2383 return CRM_Activity_BAO_Activity::getActivitiesCount($input);
2384
2385 case 'mailing':
2386 $params = array(
2387 'contact_id' => $contactId,
2388 'admin' => FALSE,
2389 );
2390 return CRM_Mailing_BAO_Mailing::getContactMailingsCount($params);
2391
2392 default:
2393 $custom = explode('_', $component);
2394 if ($custom['0'] = 'custom') {
2395 if (!$tableName) {
2396 $tableName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $custom['1'], 'table_name');
2397 }
2398 $queryString = "SELECT count(id) FROM {$tableName} WHERE entity_id = {$contactId}";
2399 return CRM_Core_DAO::singleValueQuery($queryString);
2400 }
2401 }
2402 }
2403
2404 /**
2405 * Function to process greetings and cache
2406 *
2407 * @param object $contact contact object after save
2408 * @param boolean $useDefaults use default greeting values
2409 *
2410 * @return void
2411 * @access public
2412 * @static
2413 */
2414 static function processGreetings(&$contact, $useDefaults = FALSE) {
2415 if ($useDefaults) {
2416 //retrieve default greetings
2417 $defaultGreetings = CRM_Core_PseudoConstant::greetingDefaults();
2418 $contactDefaults = $defaultGreetings[$contact->contact_type];
2419 }
2420
2421 // note that contact object not always has required greeting related
2422 // fields that are required to calculate greeting and
2423 // also other fields used in tokens etc,
2424 // hence we need to retrieve it again.
2425 $contact->find(TRUE);
2426
2427 // store object values to an array
2428 $contactDetails = array();
2429 CRM_Core_DAO::storeValues($contact, $contactDetails);
2430 $contactDetails = array(array($contact->id => $contactDetails));
2431
2432 $emailGreetingString = $postalGreetingString = $addresseeString = NULL;
2433 $updateQueryString = array();
2434
2435 //cache email and postal greeting to greeting display
2436 if ($contact->email_greeting_custom != 'null' && $contact->email_greeting_custom) {
2437 $emailGreetingString = $contact->email_greeting_custom;
2438 }
2439 elseif ($contact->email_greeting_id != 'null' && $contact->email_greeting_id) {
2440 // the filter value for Individual contact type is set to 1
2441 $filter = array(
2442 'contact_type' => $contact->contact_type,
2443 'greeting_type' => 'email_greeting',
2444 );
2445
2446 $emailGreeting = CRM_Core_PseudoConstant::greeting($filter);
2447 $emailGreetingString = $emailGreeting[$contact->email_greeting_id];
2448 $updateQueryString[] = " email_greeting_custom = NULL ";
2449 }
2450 else {
2451 if ($useDefaults) {
2452 reset($contactDefaults['email_greeting']);
2453 $emailGreetingID = key($contactDefaults['email_greeting']);
2454 $emailGreetingString = $contactDefaults['email_greeting'][$emailGreetingID];
2455 $updateQueryString[] = " email_greeting_id = $emailGreetingID ";
2456 $updateQueryString[] = " email_greeting_custom = NULL ";
2457 }
2458 elseif ($contact->email_greeting_custom) {
2459 $updateQueryString[] = " email_greeting_display = NULL ";
2460 }
2461 }
2462
2463 if ($emailGreetingString) {
2464 CRM_Utils_Token::replaceGreetingTokens($emailGreetingString,
2465 $contactDetails,
2466 $contact->id,
2467 'CRM_Contact_BAO_Contact'
2468 );
2469 $emailGreetingString = CRM_Core_DAO::escapeString(CRM_Utils_String::stripSpaces($emailGreetingString));
2470 $updateQueryString[] = " email_greeting_display = '{$emailGreetingString}'";
2471 }
2472
2473 //postal greetings
2474 if ($contact->postal_greeting_custom != 'null' && $contact->postal_greeting_custom) {
2475 $postalGreetingString = $contact->postal_greeting_custom;
2476 }
2477 elseif ($contact->postal_greeting_id != 'null' && $contact->postal_greeting_id) {
2478 $filter = array(
2479 'contact_type' => $contact->contact_type,
2480 'greeting_type' => 'postal_greeting',
2481 );
2482 $postalGreeting = CRM_Core_PseudoConstant::greeting($filter);
2483 $postalGreetingString = $postalGreeting[$contact->postal_greeting_id];
2484 $updateQueryString[] = " postal_greeting_custom = NULL ";
2485 }
2486 else {
2487 if ($useDefaults) {
2488 reset($contactDefaults['postal_greeting']);
2489 $postalGreetingID = key($contactDefaults['postal_greeting']);
2490 $postalGreetingString = $contactDefaults['postal_greeting'][$postalGreetingID];
2491 $updateQueryString[] = " postal_greeting_id = $postalGreetingID ";
2492 $updateQueryString[] = " postal_greeting_custom = NULL ";
2493 }
2494 elseif ($contact->postal_greeting_custom) {
2495 $updateQueryString[] = " postal_greeting_display = NULL ";
2496 }
2497 }
2498
2499 if ($postalGreetingString) {
2500 CRM_Utils_Token::replaceGreetingTokens($postalGreetingString,
2501 $contactDetails,
2502 $contact->id,
2503 'CRM_Contact_BAO_Contact'
2504 );
2505 $postalGreetingString = CRM_Core_DAO::escapeString(CRM_Utils_String::stripSpaces($postalGreetingString));
2506 $updateQueryString[] = " postal_greeting_display = '{$postalGreetingString}'";
2507 }
2508
2509 // addressee
2510 if ($contact->addressee_custom != 'null' && $contact->addressee_custom) {
2511 $addresseeString = $contact->addressee_custom;
2512 }
2513 elseif ($contact->addressee_id != 'null' && $contact->addressee_id) {
2514 $filter = array(
2515 'contact_type' => $contact->contact_type,
2516 'greeting_type' => 'addressee',
2517 );
2518
2519 $addressee = CRM_Core_PseudoConstant::greeting($filter);
2520 $addresseeString = $addressee[$contact->addressee_id];
2521 $updateQueryString[] = " addressee_custom = NULL ";
2522 }
2523 else {
2524 if ($useDefaults) {
2525 reset($contactDefaults['addressee']);
2526 $addresseeID = key($contactDefaults['addressee']);
2527 $addresseeString = $contactDefaults['addressee'][$addresseeID];
2528 $updateQueryString[] = " addressee_id = $addresseeID ";
2529 $updateQueryString[] = " addressee_custom = NULL ";
2530 }
2531 elseif ($contact->addressee_custom) {
2532 $updateQueryString[] = " addressee_display = NULL ";
2533 }
2534 }
2535
2536 if ($addresseeString) {
2537 CRM_Utils_Token::replaceGreetingTokens($addresseeString,
2538 $contactDetails,
2539 $contact->id,
2540 'CRM_Contact_BAO_Contact'
2541 );
2542 $addresseeString = CRM_Core_DAO::escapeString(CRM_Utils_String::stripSpaces($addresseeString));
2543 $updateQueryString[] = " addressee_display = '{$addresseeString}'";
2544 }
2545
2546 if (!empty($updateQueryString)) {
2547 $updateQueryString = implode(',', $updateQueryString);
2548 $queryString = "UPDATE civicrm_contact SET {$updateQueryString} WHERE id = {$contact->id}";
2549 CRM_Core_DAO::executeQuery($queryString);
2550 }
2551 }
2552
2553 /**
2554 * Function to retrieve loc block ids w/ given condition.
2555 *
2556 * @param int $contactId contact id.
2557 * @param array $criteria key => value pair which should be
2558 * fulfill by return record ids.
2559 * @param string $condOperator operator use for grouping multiple conditions.
2560 *
2561 * @return array $locBlockIds loc block ids which fulfill condition.
2562 * @static
2563 */
2564 static function getLocBlockIds($contactId, $criteria = array(), $condOperator = 'AND') {
2565 $locBlockIds = array();
2566 if (!$contactId) {
2567 return $locBlockIds;
2568 }
2569
2570 foreach (array('Email', 'OpenID', 'Phone', 'Address', 'IM') as $block) {
2571 $name = strtolower($block);
2572 $className = "CRM_Core_DAO_$block";
2573 $blockDAO = new $className();
2574
2575 // build the condition.
2576 if (is_array($criteria)) {
2577 $fields = $blockDAO->fields();
2578 $conditions = array();
2579 foreach ($criteria as $field => $value) {
2580 if (array_key_exists($field, $fields)) {
2581 $cond = "( $field = $value )";
2582 // value might be zero or null.
2583 if (!$value || strtolower($value) == 'null') {
2584 $cond = "( $field = 0 OR $field IS NULL )";
2585 }
2586 $conditions[] = $cond;
2587 }
2588 }
2589 if (!empty($conditions)) {
2590 $blockDAO->whereAdd(implode(" $condOperator ", $conditions));
2591 }
2592 }
2593
2594 $blockDAO->contact_id = $contactId;
2595 $blockDAO->find();
2596 while ($blockDAO->fetch()) {
2597 $locBlockIds[$name][] = $blockDAO->id;
2598 }
2599 $blockDAO->free();
2600 }
2601
2602 return $locBlockIds;
2603 }
2604
2605 /**
2606 * Function to build context menu items.
2607 *
2608 * @return array of context menu for logged in user.
2609 * @static
2610 */
2611 static function contextMenu($contactId = NULL) {
2612 $menu = array(
2613 'view' => array('title' => ts('View Contact'),
2614 'weight' => 0,
2615 'ref' => 'view-contact',
2616 'key' => 'view',
2617 'permissions' => array('view all contacts'),
2618 ),
2619 'add' => array('title' => ts('Edit Contact'),
2620 'weight' => 0,
2621 'ref' => 'edit-contact',
2622 'key' => 'add',
2623 'permissions' => array('edit all contacts'),
2624 ),
2625 'delete' => array('title' => ts('Delete Contact'),
2626 'weight' => 0,
2627 'ref' => 'delete-contact',
2628 'key' => 'delete',
2629 'permissions' => array('access deleted contacts', 'delete contacts'),
2630 ),
2631 'contribution' => array('title' => ts('Add Contribution'),
2632 'weight' => 5,
2633 'ref' => 'new-contribution',
2634 'key' => 'contribution',
2635 'component' => 'CiviContribute',
2636 'href' => CRM_Utils_System::url('civicrm/contact/view/contribution',
2637 'reset=1&action=add&context=contribution'
2638 ),
2639 'permissions' => array(
2640 'access CiviContribute',
2641 'edit contributions',
2642 ),
2643 ),
2644 'participant' => array('title' => ts('Register for Event'),
2645 'weight' => 10,
2646 'ref' => 'new-participant',
2647 'key' => 'participant',
2648 'component' => 'CiviEvent',
2649 'href' => CRM_Utils_System::url('civicrm/contact/view/participant', 'reset=1&action=add&context=participant'),
2650 'permissions' => array(
2651 'access CiviEvent',
2652 'edit event participants',
2653 ),
2654 ),
2655 'activity' => array('title' => ts('Record Activity'),
2656 'weight' => 35,
2657 'ref' => 'new-activity',
2658 'key' => 'activity',
2659 'permissions' => array('edit all contacts'),
2660 ),
2661 'pledge' => array('title' => ts('Add Pledge'),
2662 'weight' => 15,
2663 'ref' => 'new-pledge',
2664 'key' => 'pledge',
2665 'href' => CRM_Utils_System::url('civicrm/contact/view/pledge',
2666 'reset=1&action=add&context=pledge'
2667 ),
2668 'component' => 'CiviPledge',
2669 'permissions' => array(
2670 'access CiviPledge',
2671 'edit pledges',
2672 ),
2673 ),
2674 'membership' => array('title' => ts('Add Membership'),
2675 'weight' => 20,
2676 'ref' => 'new-membership',
2677 'key' => 'membership',
2678 'component' => 'CiviMember',
2679 'href' => CRM_Utils_System::url('civicrm/contact/view/membership',
2680 'reset=1&action=add&context=membership'
2681 ),
2682 'permissions' => array(
2683 'access CiviMember',
2684 'edit memberships',
2685 ),
2686 ),
2687 'case' => array('title' => ts('Add Case'),
2688 'weight' => 25,
2689 'ref' => 'new-case',
2690 'key' => 'case',
2691 'component' => 'CiviCase',
2692 'href' => CRM_Utils_System::url('civicrm/case/add', 'reset=1&action=add&context=case'),
2693 'permissions' => array('add cases'),
2694 ),
2695 'grant' => array('title' => ts('Add Grant'),
2696 'weight' => 26,
2697 'ref' => 'new-grant',
2698 'key' => 'grant',
2699 'component' => 'CiviGrant',
2700 'href' => CRM_Utils_System::url('civicrm/contact/view/grant',
2701 'reset=1&action=add&context=grant'
2702 ),
2703 'permissions' => array('edit grants'),
2704 ),
2705 'rel' => array('title' => ts('Add Relationship'),
2706 'weight' => 30,
2707 'ref' => 'new-relationship',
2708 'key' => 'rel',
2709 'href' => CRM_Utils_System::url('civicrm/contact/view/rel',
2710 'reset=1&action=add'
2711 ),
2712 'permissions' => array('edit all contacts'),
2713 ),
2714 'note' => array('title' => ts('Add Note'),
2715 'weight' => 40,
2716 'ref' => 'new-note',
2717 'key' => 'note',
2718 'href' => CRM_Utils_System::url('civicrm/contact/view/note',
2719 'reset=1&action=add'
2720 ),
2721 'permissions' => array('edit all contacts'),
2722 ),
2723 'email' => array('title' => ts('Send an Email'),
2724 'weight' => 45,
2725 'ref' => 'new-email',
2726 'key' => 'email',
2727 'permissions' => array('view all contacts'),
2728 ),
2729 'group' => array('title' => ts('Add to Group'),
2730 'weight' => 50,
2731 'ref' => 'group-add-contact',
2732 'key' => 'group',
2733 'permissions' => array('edit groups'),
2734 ),
2735 'tag' => array('title' => ts('Tag'),
2736 'weight' => 55,
2737 'ref' => 'tag-contact',
2738 'key' => 'tag',
2739 'permissions' => array('edit all contacts'),
2740 ),
2741 );
2742
2743 CRM_Utils_Hook::summaryActions($menu, $contactId);
2744 //1. check for component is active.
2745 //2. check for user permissions.
2746 //3. check for acls.
2747 //3. edit and view contact are directly accessible to user.
2748
2749 $aclPermissionedTasks = array(
2750 'view-contact', 'edit-contact', 'new-activity',
2751 'new-email', 'group-add-contact', 'tag-contact', 'delete-contact',
2752 );
2753 $corePermission = CRM_Core_Permission::getPermission();
2754
2755 $config = CRM_Core_Config::singleton();
2756
2757 $contextMenu = array();
2758 foreach ($menu as $key => $values) {
2759 $componentName = CRM_Utils_Array::value('component', $values);
2760
2761 // if component action - make sure component is enable.
2762 if ($componentName && !in_array($componentName, $config->enableComponents)) {
2763 continue;
2764 }
2765
2766 // make sure user has all required permissions.
2767 $hasAllPermissions = FALSE;
2768
2769 $permissions = CRM_Utils_Array::value('permissions', $values);
2770 if (!is_array($permissions) || empty($permissions)) {
2771 $hasAllPermissions = TRUE;
2772 }
2773
2774 // iterate for required permissions in given permissions array.
2775 if (!$hasAllPermissions) {
2776 $hasPermissions = 0;
2777 foreach ($permissions as $permission) {
2778 if (CRM_Core_Permission::check($permission)) {
2779 $hasPermissions++;
2780 }
2781 }
2782
2783 if (count($permissions) == $hasPermissions) {
2784 $hasAllPermissions = TRUE;
2785 }
2786
2787 // if still user does not have required permissions, check acl.
2788 if (!$hasAllPermissions && $values['ref'] != 'delete-contact') {
2789 if (in_array($values['ref'], $aclPermissionedTasks) &&
2790 $corePermission == CRM_Core_Permission::EDIT
2791 ) {
2792 $hasAllPermissions = TRUE;
2793 }
2794 elseif (in_array($values['ref'], array(
2795 'new-email'))) {
2796 // grant permissions for these tasks.
2797 $hasAllPermissions = TRUE;
2798 }
2799 }
2800 }
2801
2802 // user does not have necessary permissions.
2803 if (!$hasAllPermissions) {
2804 continue;
2805 }
2806
2807 // build directly accessible action menu.
2808 if (in_array($values['ref'], array(
2809 'view-contact', 'edit-contact'))) {
2810 $contextMenu['primaryActions'][$key] = array(
2811 'title' => $values['title'],
2812 'ref' => $values['ref'],
2813 'key' => $values['key'],
2814 );
2815 continue;
2816 }
2817
2818 // finally get menu item for -more- action widget.
2819 $contextMenu['moreActions'][$values['weight']] = array(
2820 'title' => $values['title'],
2821 'ref' => $values['ref'],
2822 'href' => CRM_Utils_Array::value('href', $values),
2823 'key' => $values['key'],
2824 );
2825 }
2826
2827 ksort($contextMenu['moreActions']);
2828
2829 return $contextMenu;
2830 }
2831
2832 /**
2833 * Function to retrieve display name of contact that address is shared
2834 * based on $masterAddressId or $contactId .
2835 *
2836 * @param int $masterAddressId master id.
2837 * @param int $contactId contact id.
2838 *
2839 * @return display name |null the found display name or null.
2840 * @access public
2841 * @static
2842 */
2843 static function getMasterDisplayName($masterAddressId = NULL, $contactId = NULL) {
2844 $masterDisplayName = NULL;
2845 $sql = NULL;
2846 if (!$masterAddressId && !$contactId) {
2847 return $masterDisplayName;
2848 }
2849
2850 if ($masterAddressId) {
2851 $sql = "
2852 SELECT display_name from civicrm_contact
2853 LEFT JOIN civicrm_address ON ( civicrm_address.contact_id = civicrm_contact.id )
2854 WHERE civicrm_address.id = " . $masterAddressId;
2855 }
2856 elseif ($contactId) {
2857 $sql = "
2858 SELECT display_name from civicrm_contact cc, civicrm_address add1
2859 LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id )
2860 WHERE cc.id = add2.contact_id AND add1.contact_id = " . $contactId;
2861 }
2862
2863 $masterDisplayName = CRM_Core_DAO::singleValueQuery($sql);
2864 return $masterDisplayName;
2865 }
2866
2867 /**
2868 * Get the creation/modification times for a contact
2869 *
2870 * @return array('created_date' => $, 'modified_date' => $)
2871 */
2872 static function getTimestamps($contactId) {
2873 $timestamps = CRM_Core_DAO::executeQuery(
2874 'SELECT created_date, modified_date
2875 FROM civicrm_contact
2876 WHERE id = %1',
2877 array(
2878 1 => array($contactId, 'Integer'),
2879 )
2880 );
2881 if ($timestamps->fetch()) {
2882 return array(
2883 'created_date' => $timestamps->created_date,
2884 'modified_date' => $timestamps->modified_date,
2885 );
2886 }
2887 else {
2888 return NULL;
2889 }
2890 }
2891
2892 /**
2893 * Get a list of triggers for the contact table
2894 *
2895 * @see hook_civicrm_triggerInfo
2896 * @see CRM_Core_DAO::triggerRebuild
2897 * @see http://issues.civicrm.org/jira/browse/CRM-10554
2898 */
2899 static function triggerInfo(&$info, $tableName = NULL) {
2900 //during upgrade, first check for valid version and then create triggers
2901 //i.e the columns created_date and modified_date are introduced in 4.3.alpha1 so dont create triggers for older version
2902 if (CRM_Core_Config::isUpgradeMode()) {
2903 $currentVer = CRM_Core_BAO_Domain::version(TRUE);
2904 //if current version is less than 4.3.alpha1 dont create below triggers
2905 if (version_compare($currentVer, '4.3.alpha1') < 0) {
2906 return;
2907 }
2908 }
2909
2910 if ($tableName == NULL || $tableName == self::getTableName()) {
2911 $info[] = array(
2912 'table' => array(self::getTableName()),
2913 'when' => 'BEFORE',
2914 'event' => array('INSERT'),
2915 'sql' => "\nSET NEW.created_date = CURRENT_TIMESTAMP;\n",
2916 );
2917 }
2918
2919 // Update timestamp when modifying closely related core tables
2920 $relatedTables = array(
2921 'civicrm_address',
2922 'civicrm_email',
2923 'civicrm_im',
2924 'civicrm_phone',
2925 'civicrm_website',
2926 );
2927 $info[] = array(
2928 'table' => $relatedTables,
2929 'when' => 'AFTER',
2930 'event' => array('INSERT', 'UPDATE'),
2931 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.contact_id;\n",
2932 );
2933 $info[] = array(
2934 'table' => $relatedTables,
2935 'when' => 'AFTER',
2936 'event' => array('DELETE'),
2937 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = OLD.contact_id;\n",
2938 );
2939
2940 // Update timestamp when modifying related custom-data tables
2941 $customGroupTables = array();
2942 $customGroupDAO = CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity('Contact');
2943 $customGroupDAO->is_multiple = 0;
2944 $customGroupDAO->find();
2945 while ($customGroupDAO->fetch()) {
2946 $customGroupTables[] = $customGroupDAO->table_name;
2947 }
2948 if (!empty($customGroupTables)) {
2949 $info[] = array(
2950 'table' => $customGroupTables,
2951 'when' => 'AFTER',
2952 'event' => array('INSERT', 'UPDATE'),
2953 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = NEW.entity_id;\n",
2954 );
2955 $info[] = array(
2956 'table' => $customGroupTables,
2957 'when' => 'AFTER',
2958 'event' => array('DELETE'),
2959 'sql' => "\nUPDATE civicrm_contact SET modified_date = CURRENT_TIMESTAMP WHERE id = OLD.entity_id;\n",
2960 );
2961 }
2962
2963 // Update phone table to populate phone_numeric field
2964 if (!$tableName || $tableName == 'civicrm_phone') {
2965 // Define stored sql function needed for phones
2966 CRM_Core_DAO::executeQuery(self::DROP_STRIP_FUNCTION_43);
2967 CRM_Core_DAO::executeQuery(self::CREATE_STRIP_FUNCTION_43);
2968 $info[] = array(
2969 'table' => array('civicrm_phone'),
2970 'when' => 'BEFORE',
2971 'event' => array('INSERT', 'UPDATE'),
2972 'sql' => "\nSET NEW.phone_numeric = civicrm_strip_non_numeric(NEW.phone);\n",
2973 );
2974 }
2975 }
2976
2977 /**
2978 * Function to check if contact is being used in civicrm_domain
2979 * based on $contactId
2980 *
2981 * @param int $contactId contact id.
2982 *
2983 * @return true if present else false.
2984 * @access public
2985 * @static
2986 */
2987 static function checkDomainContact($contactId) {
2988 if (!$contactId)
2989 return FALSE;
2990 $domainId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Domain', $contactId, 'id', 'contact_id');
2991
2992 if ($domainId) {
2993 return TRUE;
2994 } else {
2995 return FALSE;
2996 }
2997 }
2998
2999 /**
3000 * Get options for a given contact field.
3001 * @see CRM_Core_DAO::buildOptions
3002 *
3003 * TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow?
3004 * TODO: In context of chainselect, what to return if e.g. a country has no states?
3005 *
3006 * @param String $fieldName
3007 * @param String $context: @see CRM_Core_DAO::buildOptionsContext
3008 * @param Array $props: whatever is known about this dao object
3009 */
3010 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3011 $params = array();
3012 // Special logic for fields whose options depend on context or properties
3013 switch ($fieldName) {
3014 case 'contact_sub_type':
3015 if (!empty($props['contact_type'])) {
3016 $params['condition'] = "parent_id = (SELECT id FROM civicrm_contact_type WHERE name='{$props['contact_type']}')";
3017 }
3018 break;
3019 }
3020 return CRM_Core_PseudoConstant::get(__CLASS__, $fieldName, $params, $context);
3021 }
3022
3023 /**
3024 * Delete a contact-related object that has an 'is_primary' field
3025 * Ensures that is_primary gets assigned to another object if available
3026 * Also calls pre/post hooks
3027 *
3028 * @var $type: object type
3029 * @var $id: object id
3030 */
3031 public static function deleteObjectWithPrimary($type, $id) {
3032 if (!$id || !is_numeric($id)) {
3033 return FALSE;
3034 }
3035 $daoName = "CRM_Core_DAO_$type";
3036 $obj = new $daoName();
3037 $obj->id = $id;
3038 $obj->find();
3039 if ($obj->fetch()) {
3040 CRM_Utils_Hook::pre('delete', $type, $id, CRM_Core_DAO::$_nullArray);
3041 $contactId = $obj->contact_id;
3042 $obj->delete();
3043 }
3044 else {
3045 return FALSE;
3046 }
3047 // is_primary is only relavent if this field belongs to a contact
3048 if ($contactId) {
3049 $dao = new $daoName();
3050 $dao->contact_id = $contactId;
3051 $dao->is_primary = 1;
3052 // Pick another record to be primary (if one isn't already)
3053 if (!$dao->find(TRUE)) {
3054 $dao->is_primary = 0;
3055 $dao->find();
3056 if ($dao->fetch()) {
3057 $dao->is_primary = 1;
3058 $dao->save();
3059 }
3060 }
3061 $dao->free();
3062 }
3063 CRM_Utils_Hook::post('delete', $type, $id, $obj);
3064 $obj->free();
3065 return TRUE;
3066 }
3067 }