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