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