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