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