Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
16 | */ |
17 | class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { | |
18 | ||
19 | /** | |
20 | * SQL function used to format the phone_numeric field via trigger. | |
f6b81482 | 21 | * |
6a488035 TO |
22 | * @see self::triggerInfo() |
23 | * | |
24 | * Note that this is also used by the 4.3 upgrade script. | |
25 | * @see CRM_Upgrade_Incremental_php_FourThree | |
26 | */ | |
27 | const DROP_STRIP_FUNCTION_43 = "DROP FUNCTION IF EXISTS civicrm_strip_non_numeric"; | |
f6b81482 | 28 | |
6a488035 | 29 | const CREATE_STRIP_FUNCTION_43 = " |
1858dee8 | 30 | CREATE FUNCTION civicrm_strip_non_numeric(input VARCHAR(255)) |
31 | RETURNS VARCHAR(255) | |
6a488035 TO |
32 | DETERMINISTIC |
33 | NO SQL | |
34 | BEGIN | |
1858dee8 | 35 | DECLARE output VARCHAR(255) DEFAULT ''; |
6a488035 TO |
36 | DECLARE iterator INT DEFAULT 1; |
37 | WHILE iterator < (LENGTH(input) + 1) DO | |
38 | IF SUBSTRING(input, iterator, 1) IN ('0', '1', '2', '3', '4', '5', '6', '7', '8', '9') THEN | |
39 | SET output = CONCAT(output, SUBSTRING(input, iterator, 1)); | |
40 | END IF; | |
41 | SET iterator = iterator + 1; | |
42 | END WHILE; | |
43 | RETURN output; | |
44 | END"; | |
45 | ||
46 | /** | |
fe482240 | 47 | * The types of communication preferences. |
6a488035 TO |
48 | * |
49 | * @var array | |
50 | */ | |
f6b81482 | 51 | public static $_commPrefs = [ |
22f80e87 EM |
52 | 'do_not_phone', |
53 | 'do_not_email', | |
54 | 'do_not_mail', | |
55 | 'do_not_sms', | |
56 | 'do_not_trade', | |
f6b81482 | 57 | ]; |
6a488035 TO |
58 | |
59 | /** | |
fe482240 | 60 | * Types of greetings. |
6a488035 TO |
61 | * |
62 | * @var array | |
63 | */ | |
f6b81482 | 64 | public static $_greetingTypes = [ |
22f80e87 EM |
65 | 'addressee', |
66 | 'email_greeting', | |
67 | 'postal_greeting', | |
f6b81482 | 68 | ]; |
6a488035 TO |
69 | |
70 | /** | |
fe482240 | 71 | * Static field for all the contact information that we can potentially import. |
6a488035 TO |
72 | * |
73 | * @var array | |
6a488035 | 74 | */ |
f6b81482 | 75 | public static $_importableFields = []; |
6a488035 TO |
76 | |
77 | /** | |
fe482240 | 78 | * Static field for all the contact information that we can potentially export. |
6a488035 TO |
79 | * |
80 | * @var array | |
6a488035 | 81 | */ |
69078420 | 82 | public static $_exportableFields = NULL; |
86538308 EM |
83 | |
84 | /** | |
22f80e87 | 85 | * Class constructor. |
86538308 | 86 | */ |
00be9182 | 87 | public function __construct() { |
6a488035 TO |
88 | parent::__construct(); |
89 | } | |
90 | ||
91 | /** | |
22f80e87 | 92 | * Takes an associative array and creates a contact object. |
6a488035 | 93 | * |
22f80e87 | 94 | * The function extracts all the params it needs to initialize the create a |
6a488035 TO |
95 | * contact object. the params array could contain additional unused name/value |
96 | * pairs | |
97 | * | |
77c5b619 | 98 | * @param array $params |
22f80e87 | 99 | * (reference) an assoc array of name/value pairs. |
6a488035 | 100 | * |
91c00d11 | 101 | * @return CRM_Contact_DAO_Contact|CRM_Core_Error|NULL |
22f80e87 EM |
102 | * Created or updated contact object or error object. |
103 | * (error objects are being phased out in favour of exceptions) | |
2d296f18 | 104 | * @throws \CRM_Core_Exception |
6a488035 | 105 | */ |
00be9182 | 106 | public static function add(&$params) { |
6a488035 | 107 | $contact = new CRM_Contact_DAO_Contact(); |
f748c073 | 108 | $contactID = $params['contact_id'] ?? NULL; |
6a488035 | 109 | if (empty($params)) { |
a1a2a83d | 110 | return NULL; |
6a488035 TO |
111 | } |
112 | ||
22f80e87 | 113 | // Fix for validate contact sub type CRM-5143. |
9bb77b8e TO |
114 | if (isset($params['contact_sub_type'])) { |
115 | if (empty($params['contact_sub_type'])) { | |
6a488035 TO |
116 | $params['contact_sub_type'] = 'null'; |
117 | } | |
c15b5652 | 118 | elseif ($params['contact_sub_type'] !== 'null') { |
6a488035 TO |
119 | if (!CRM_Contact_BAO_ContactType::isExtendsContactType($params['contact_sub_type'], |
120 | $params['contact_type'], TRUE | |
9bb77b8e TO |
121 | ) |
122 | ) { | |
6a488035 TO |
123 | // we'll need to fix tests to handle this |
124 | // CRM-7925 | |
bc660ddf | 125 | throw new CRM_Core_Exception(ts('The Contact Sub Type does not match the Contact type for this record')); |
6a488035 | 126 | } |
f2181617 | 127 | $params['contact_sub_type'] = CRM_Utils_Array::implodePadded($params['contact_sub_type']); |
6a488035 TO |
128 | } |
129 | } | |
6a488035 | 130 | |
37f7ae88 | 131 | if (isset($params['preferred_communication_method']) && is_array($params['preferred_communication_method'])) { |
132 | CRM_Utils_Array::formatArrayKeys($params['preferred_communication_method']); | |
133 | $contact->preferred_communication_method = CRM_Utils_Array::implodePadded($params['preferred_communication_method']); | |
6a488035 | 134 | unset($params['preferred_communication_method']); |
6a488035 TO |
135 | } |
136 | ||
fdb6d23b | 137 | $defaults = ['source' => $params['contact_source'] ?? NULL]; |
1bdbd4ec | 138 | if ($params['contact_type'] === 'Organization' && isset($params['organization_name'])) { |
139 | $defaults['display_name'] = $params['organization_name']; | |
140 | $defaults['sort_name'] = $params['organization_name']; | |
141 | } | |
142 | if ($params['contact_type'] === 'Household' && isset($params['household_name'])) { | |
143 | $defaults['display_name'] = $params['household_name']; | |
144 | $defaults['sort_name'] = $params['household_name']; | |
145 | } | |
146 | $params = array_merge($defaults, $params); | |
147 | ||
6a488035 TO |
148 | $allNull = $contact->copyValues($params); |
149 | ||
91c00d11 | 150 | $contact->id = $contactID; |
6a488035 | 151 | |
f6b81482 | 152 | if ($contact->contact_type === 'Individual') { |
6a488035 | 153 | $allNull = FALSE; |
1bdbd4ec | 154 | // @todo allow the lines below to be overridden by input or hooks & add tests, |
155 | // as has been done for households and organizations. | |
22f80e87 | 156 | // Format individual fields. |
6a488035 TO |
157 | CRM_Contact_BAO_Individual::format($params, $contact); |
158 | } | |
1bdbd4ec | 159 | |
3628dc86 | 160 | if (strlen($contact->display_name) > 128) { |
161 | $contact->display_name = substr($contact->display_name, 0, 128); | |
162 | } | |
163 | if (strlen($contact->sort_name) > 128) { | |
164 | $contact->sort_name = substr($contact->sort_name, 0, 128); | |
165 | } | |
6a488035 | 166 | |
f748c073 | 167 | $privacy = $params['privacy'] ?? NULL; |
fdb6d23b | 168 | if ($privacy && is_array($privacy)) { |
6a488035 TO |
169 | $allNull = FALSE; |
170 | foreach (self::$_commPrefs as $name) { | |
fdb6d23b | 171 | $contact->$name = $privacy[$name] ?? FALSE; |
6a488035 TO |
172 | } |
173 | } | |
174 | ||
22f80e87 EM |
175 | // Since hash was required, make sure we have a 0 value for it (CRM-1063). |
176 | // @todo - does this mean we can remove this block? | |
177 | // Fixed in 1.5 by making hash optional, only do this in create mode, not update. | |
770d8a40 | 178 | if ((!isset($contact->hash) || !$contact->hash) && !$contact->id) { |
6a488035 TO |
179 | $allNull = FALSE; |
180 | $contact->hash = md5(uniqid(rand(), TRUE)); | |
181 | } | |
182 | ||
183 | // Even if we don't need $employerId, it's important to call getFieldValue() before | |
184 | // the contact is saved because we want the existing value to be cached. | |
185 | // createCurrentEmployerRelationship() needs the old value not the updated one. CRM-10788 | |
91c00d11 | 186 | $employerId = (!$contactID || $contact->contact_type !== 'Individual') ? NULL : CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contact->id, 'employer_id'); |
6a488035 TO |
187 | |
188 | if (!$allNull) { | |
189 | $contact->save(); | |
190 | ||
191 | CRM_Core_BAO_Log::register($contact->id, | |
192 | 'civicrm_contact', | |
193 | $contact->id | |
194 | ); | |
195 | } | |
196 | ||
f6b81482 | 197 | if ($contact->contact_type === 'Individual' && (isset($params['current_employer']) || isset($params['employer_id']))) { |
22f80e87 | 198 | // Create current employer. |
fdb6d23b | 199 | $newEmployer = !empty($params['employer_id']) ? $params['employer_id'] : $params['current_employer'] ?? NULL; |
f06fc7d2 | 200 | |
fdb6d23b | 201 | $newContact = empty($params['contact_id']); |
fad0497c | 202 | if ($newEmployer) { |
6eae3162 | 203 | CRM_Contact_BAO_Contact_Utils::createCurrentEmployerRelationship($contact->id, $newEmployer, $employerId, $newContact); |
6a488035 | 204 | } |
fdb6d23b CW |
205 | elseif ($employerId) { |
206 | CRM_Contact_BAO_Contact_Utils::clearCurrentEmployer($contact->id, $employerId); | |
6a488035 TO |
207 | } |
208 | } | |
209 | ||
91c00d11 | 210 | // Update cached employer name if the name of an existing organization is being updated. |
211 | if ($contact->contact_type === 'Organization' && !empty($params['organization_name']) && $contactID) { | |
6a488035 TO |
212 | CRM_Contact_BAO_Contact_Utils::updateCurrentEmployer($contact->id); |
213 | } | |
214 | ||
215 | return $contact; | |
216 | } | |
217 | ||
218 | /** | |
22f80e87 EM |
219 | * Create contact. |
220 | * | |
6a488035 TO |
221 | * takes an associative array and creates a contact object and all the associated |
222 | * derived objects (i.e. individual, location, email, phone etc) | |
223 | * | |
224 | * This function is invoked from within the web form layer and also from the api layer | |
225 | * | |
77c5b619 TO |
226 | * @param array $params |
227 | * (reference ) an assoc array of name/value pairs. | |
228 | * @param bool $fixAddress | |
229 | * If we need to fix address. | |
230 | * @param bool $invokeHooks | |
231 | * If we need to invoke hooks. | |
6a488035 | 232 | * |
60fd90d8 DG |
233 | * @param bool $skipDelete |
234 | * Unclear parameter, passed to website create | |
235 | * | |
22f80e87 EM |
236 | * @return CRM_Contact_BAO_Contact|CRM_Core_Error |
237 | * Created or updated contribution object. We are deprecating returning an error in | |
238 | * favour of exceptions | |
f6b81482 | 239 | * |
17d8f8a8 | 240 | * @throws \CRM_Core_Exception |
241 | * @throws \CiviCRM_API3_Exception | |
242 | * @throws \Civi\API\Exception\UnauthorizedException | |
6a488035 | 243 | */ |
60fd90d8 | 244 | public static function &create(&$params, $fixAddress = TRUE, $invokeHooks = TRUE, $skipDelete = FALSE) { |
9bb77b8e TO |
245 | $contact = NULL; |
246 | if (empty($params['contact_type']) && empty($params['contact_id'])) { | |
247 | return $contact; | |
248 | } | |
6a488035 | 249 | |
9fa1f9b9 CW |
250 | $isEdit = !empty($params['contact_id']); |
251 | ||
252 | if ($isEdit && empty($params['contact_type'])) { | |
950feadd CW |
253 | $params['contact_type'] = self::getContactType($params['contact_id']); |
254 | } | |
255 | ||
9fa1f9b9 CW |
256 | if (!empty($params['check_permissions']) && isset($params['api_key']) |
257 | && !CRM_Core_Permission::check([['edit api keys', 'administer CiviCRM']]) | |
258 | && !($isEdit && CRM_Core_Permission::check('edit own api keys') && $params['contact_id'] == CRM_Core_Session::getLoggedInContactID()) | |
259 | ) { | |
260 | throw new \Civi\API\Exception\UnauthorizedException('Permission denied to modify api key'); | |
261 | } | |
262 | ||
9bb77b8e TO |
263 | if ($invokeHooks) { |
264 | if (!empty($params['contact_id'])) { | |
265 | CRM_Utils_Hook::pre('edit', $params['contact_type'], $params['contact_id'], $params); | |
266 | } | |
267 | else { | |
268 | CRM_Utils_Hook::pre('create', $params['contact_type'], NULL, $params); | |
6a488035 | 269 | } |
9bb77b8e | 270 | } |
6a488035 | 271 | |
63b7d442 | 272 | self::ensureGreetingParamsAreSet($params); |
6a488035 | 273 | |
22f80e87 | 274 | // CRM-6942: set preferred language to the current language if it’s unset (and we’re creating a contact). |
9bb77b8e | 275 | if (empty($params['contact_id'])) { |
9747df8a | 276 | // A case could be made for checking isset rather than empty but this is more consistent with previous behaviour. |
277 | if (empty($params['preferred_language']) && ($language = CRM_Core_I18n::getContactDefaultLanguage()) != FALSE) { | |
278 | $params['preferred_language'] = $language; | |
279 | } | |
280 | ||
054bda37 VV |
281 | // CRM-21041: set default 'Communication Style' if unset when creating a contact. |
282 | if (empty($params['communication_style_id'])) { | |
d8ccde47 VV |
283 | $defaultCommunicationStyleId = CRM_Core_OptionGroup::values('communication_style', TRUE, NULL, NULL, 'AND is_default = 1'); |
284 | $params['communication_style_id'] = array_pop($defaultCommunicationStyleId); | |
054bda37 | 285 | } |
9bb77b8e | 286 | } |
6a488035 | 287 | |
9bb77b8e | 288 | $transaction = new CRM_Core_Transaction(); |
6a488035 | 289 | |
9bb77b8e | 290 | $contact = self::add($params); |
6a488035 | 291 | |
9bb77b8e | 292 | $params['contact_id'] = $contact->id; |
6a488035 | 293 | |
aaffa79f | 294 | if (Civi::settings()->get('is_enabled')) { |
22f80e87 | 295 | // Enabling multisite causes the contact to be added to the domain group. |
9bb77b8e TO |
296 | $domainGroupID = CRM_Core_BAO_Domain::getGroupId(); |
297 | if (!empty($domainGroupID)) { | |
298 | if (!empty($params['group']) && is_array($params['group'])) { | |
299 | $params['group'][$domainGroupID] = 1; | |
6a488035 | 300 | } |
9bb77b8e | 301 | else { |
f6b81482 | 302 | $params['group'] = [$domainGroupID => 1]; |
6a488035 TO |
303 | } |
304 | } | |
9bb77b8e | 305 | } |
6a488035 | 306 | |
78d0090b | 307 | if (!empty($params['group'])) { |
f6b81482 | 308 | $contactIds = [$params['contact_id']]; |
9bb77b8e TO |
309 | foreach ($params['group'] as $groupId => $flag) { |
310 | if ($flag == 1) { | |
311 | CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $groupId); | |
312 | } | |
313 | elseif ($flag == -1) { | |
314 | CRM_Contact_BAO_GroupContact::removeContactsFromGroup($contactIds, $groupId); | |
315 | } | |
6a488035 | 316 | } |
9bb77b8e | 317 | } |
6a488035 | 318 | |
22f80e87 | 319 | // Add location Block data. |
9bb77b8e TO |
320 | $blocks = CRM_Core_BAO_Location::create($params, $fixAddress); |
321 | foreach ($blocks as $name => $value) { | |
322 | $contact->$name = $value; | |
323 | } | |
139a60f3 | 324 | if (!empty($params['updateBlankLocInfo'])) { |
325 | $skipDelete = TRUE; | |
326 | } | |
6a488035 | 327 | |
ebdf0a2c | 328 | if (isset($params['website'])) { |
329 | CRM_Core_BAO_Website::process($params['website'], $contact->id, $skipDelete); | |
330 | } | |
6a488035 | 331 | |
ec52a65a | 332 | $userID = CRM_Core_Session::singleton()->get('userID'); |
9bb77b8e TO |
333 | // add notes |
334 | if (!empty($params['note'])) { | |
335 | if (is_array($params['note'])) { | |
336 | foreach ($params['note'] as $note) { | |
6a488035 TO |
337 | $contactId = $contact->id; |
338 | if (isset($note['contact_id'])) { | |
339 | $contactId = $note['contact_id']; | |
340 | } | |
341 | //if logged in user, overwrite contactId | |
342 | if ($userID) { | |
343 | $contactId = $userID; | |
344 | } | |
345 | ||
f6b81482 | 346 | $noteParams = [ |
6a488035 TO |
347 | 'entity_id' => $contact->id, |
348 | 'entity_table' => 'civicrm_contact', | |
9bb77b8e | 349 | 'note' => $note['note'], |
6b409353 | 350 | 'subject' => $note['subject'] ?? NULL, |
6a488035 | 351 | 'contact_id' => $contactId, |
f6b81482 | 352 | ]; |
f8d813a7 | 353 | CRM_Core_BAO_Note::add($noteParams); |
6a488035 TO |
354 | } |
355 | } | |
9bb77b8e TO |
356 | else { |
357 | $contactId = $contact->id; | |
9bb77b8e TO |
358 | //if logged in user, overwrite contactId |
359 | if ($userID) { | |
360 | $contactId = $userID; | |
361 | } | |
6a488035 | 362 | |
f6b81482 | 363 | $noteParams = [ |
9bb77b8e TO |
364 | 'entity_id' => $contact->id, |
365 | 'entity_table' => 'civicrm_contact', | |
366 | 'note' => $params['note'], | |
6b409353 | 367 | 'subject' => $params['subject'] ?? NULL, |
9bb77b8e | 368 | 'contact_id' => $contactId, |
f6b81482 | 369 | ]; |
f8d813a7 | 370 | CRM_Core_BAO_Note::add($noteParams); |
6a488035 | 371 | } |
9bb77b8e | 372 | } |
6a488035 | 373 | |
9bb77b8e TO |
374 | // update the UF user_unique_id if that has changed |
375 | CRM_Core_BAO_UFMatch::updateUFName($contact->id); | |
376 | ||
377 | if (!empty($params['custom']) && | |
378 | is_array($params['custom']) | |
379 | ) { | |
380 | CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contact', $contact->id); | |
381 | } | |
382 | ||
9bb77b8e | 383 | $transaction->commit(); |
6a488035 | 384 | |
9bb77b8e TO |
385 | // CRM-6367: fetch the right label for contact type’s display |
386 | $contact->contact_type_display = CRM_Core_DAO::getFieldValue( | |
387 | 'CRM_Contact_DAO_ContactType', | |
388 | $contact->contact_type, | |
389 | 'label', | |
390 | 'name' | |
391 | ); | |
392 | ||
0626851e | 393 | CRM_Contact_BAO_Contact_Utils::clearContactCaches(); |
9bb77b8e TO |
394 | |
395 | if ($invokeHooks) { | |
396 | if ($isEdit) { | |
397 | CRM_Utils_Hook::post('edit', $params['contact_type'], $contact->id, $contact); | |
398 | } | |
399 | else { | |
400 | CRM_Utils_Hook::post('create', $params['contact_type'], $contact->id, $contact); | |
6a488035 | 401 | } |
9bb77b8e | 402 | } |
6a488035 | 403 | |
d29b0fe7 | 404 | // In order to prevent a series of expensive queries in intensive batch processing |
405 | // api calls may pass in skip_greeting_processing, probably doing it later via the | |
406 | // scheduled job. CRM-21551 | |
407 | if (empty($params['skip_greeting_processing'])) { | |
408 | self::processGreetings($contact); | |
409 | } | |
6a488035 | 410 | |
dc2add4f SL |
411 | if (!empty($params['check_permissions'])) { |
412 | $contacts = [&$contact]; | |
413 | self::unsetProtectedFields($contacts); | |
414 | } | |
415 | ||
f4cd6a9d | 416 | if (!empty($params['is_deceased'])) { |
417 | // Edit Membership Status | |
418 | $deceasedParams = [ | |
419 | 'contact_id' => $contact->id, | |
420 | 'is_deceased' => $params['is_deceased'], | |
421 | 'deceased_date' => $params['deceased_date'] ?? NULL, | |
422 | ]; | |
423 | CRM_Member_BAO_Membership::updateMembershipStatus($deceasedParams, $params['contact_type']); | |
424 | } | |
f9e6db84 | 425 | |
9bb77b8e | 426 | return $contact; |
6a488035 TO |
427 | } |
428 | ||
dc2add4f SL |
429 | /** |
430 | * Format the output of the create contact function | |
f6b81482 | 431 | * |
dc2add4f SL |
432 | * @param CRM_Contact_DAO_Contact[]|array[] $contacts |
433 | */ | |
434 | public static function unsetProtectedFields(&$contacts) { | |
435 | if (!CRM_Core_Permission::check([['edit api keys', 'administer CiviCRM']])) { | |
436 | $currentUser = CRM_Core_Session::getLoggedInContactID(); | |
437 | $editOwn = $currentUser && CRM_Core_Permission::check('edit own api keys'); | |
438 | foreach ($contacts as &$contact) { | |
fdb6d23b | 439 | $cid = is_object($contact) ? $contact->id : $contact['id'] ?? NULL; |
dc2add4f SL |
440 | if (!($editOwn && $cid == $currentUser)) { |
441 | if (is_object($contact)) { | |
442 | unset($contact->api_key); | |
443 | } | |
444 | else { | |
445 | unset($contact['api_key']); | |
446 | } | |
447 | } | |
448 | } | |
449 | } | |
450 | } | |
451 | ||
63b7d442 AS |
452 | /** |
453 | * Ensure greeting parameters are set. | |
454 | * | |
455 | * By always populating greetings here we can be sure they are set if required & avoid a call later. | |
456 | * (ie. knowing we have definitely tried disambiguates between NULL & not loaded.) | |
457 | * | |
458 | * @param array $params | |
f6b81482 | 459 | * |
460 | * @throws \CiviCRM_API3_Exception | |
63b7d442 AS |
461 | */ |
462 | public static function ensureGreetingParamsAreSet(&$params) { | |
f6b81482 | 463 | $allGreetingParams = ['addressee' => 'addressee_id', 'postal_greeting' => 'postal_greeting_id', 'email_greeting' => 'email_greeting_id']; |
464 | $missingGreetingParams = []; | |
63b7d442 AS |
465 | |
466 | foreach ($allGreetingParams as $greetingIndex => $greetingParam) { | |
467 | if (empty($params[$greetingParam])) { | |
468 | $missingGreetingParams[$greetingIndex] = $greetingParam; | |
469 | } | |
470 | } | |
471 | ||
472 | if (!empty($params['contact_id']) && !empty($missingGreetingParams)) { | |
f6b81482 | 473 | $savedGreetings = civicrm_api3('Contact', 'getsingle', [ |
63b7d442 | 474 | 'id' => $params['contact_id'], |
69078420 | 475 | 'return' => array_keys($missingGreetingParams), |
f6b81482 | 476 | ]); |
63b7d442 AS |
477 | |
478 | foreach (array_keys($missingGreetingParams) as $missingGreetingParam) { | |
479 | if (!empty($savedGreetings[$missingGreetingParam . '_custom'])) { | |
480 | $missingGreetingParams[$missingGreetingParam . '_custom'] = $missingGreetingParam . '_custom'; | |
481 | } | |
482 | } | |
483 | // Filter out other fields. | |
484 | $savedGreetings = array_intersect_key($savedGreetings, array_flip($missingGreetingParams)); | |
485 | $params = array_merge($params, $savedGreetings); | |
486 | } | |
487 | else { | |
488 | foreach ($missingGreetingParams as $greetingName => $greeting) { | |
489 | $params[$greeting] = CRM_Contact_BAO_Contact_Utils::defaultGreeting($params['contact_type'], $greetingName); | |
490 | } | |
491 | } | |
492 | ||
493 | foreach ($allGreetingParams as $greetingIndex => $greetingParam) { | |
494 | if ($params[$greetingParam] === 'null') { | |
495 | // If we are setting it to null then null out the display field. | |
496 | $params[$greetingIndex . '_display'] = 'null'; | |
497 | } | |
498 | } | |
499 | } | |
500 | ||
6a488035 | 501 | /** |
22f80e87 | 502 | * Get the display name and image of a contact. |
6a488035 | 503 | * |
77c5b619 TO |
504 | * @param int $id |
505 | * The contactId. | |
6a488035 | 506 | * |
22f80e87 EM |
507 | * @param bool $includeTypeInReturnParameters |
508 | * Should type be part of the returned array? | |
d9f93da9 | 509 | * |
a6c01b45 CW |
510 | * @return array |
511 | * the displayName and contactImage for this contact | |
6a488035 | 512 | */ |
22f80e87 | 513 | public static function getDisplayAndImage($id, $includeTypeInReturnParameters = FALSE) { |
95fec3ce | 514 | //CRM-14276 added the * on the civicrm_contact table so that we have all the contact info available |
250b3b1f | 515 | $sql = " |
95fec3ce | 516 | SELECT civicrm_contact.*, |
6a488035 TO |
517 | civicrm_email.email as email |
518 | FROM civicrm_contact | |
519 | LEFT JOIN civicrm_email ON civicrm_email.contact_id = civicrm_contact.id | |
520 | AND civicrm_email.is_primary = 1 | |
521 | WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); | |
522 | $dao = new CRM_Core_DAO(); | |
523 | $dao->query($sql); | |
524 | if ($dao->fetch()) { | |
525 | $image = CRM_Contact_BAO_Contact_Utils::getImage($dao->contact_sub_type ? | |
f6b81482 | 526 | $dao->contact_sub_type : $dao->contact_type, FALSE, $id |
6a488035 TO |
527 | ); |
528 | $imageUrl = CRM_Contact_BAO_Contact_Utils::getImage($dao->contact_sub_type ? | |
f6b81482 | 529 | $dao->contact_sub_type : $dao->contact_type, TRUE, $id |
6a488035 TO |
530 | ); |
531 | ||
532 | // use email if display_name is empty | |
533 | if (empty($dao->display_name)) { | |
250b3b1f | 534 | $displayName = $dao->email; |
535 | } | |
536 | else { | |
537 | $displayName = $dao->display_name; | |
538 | } | |
539 | ||
540 | CRM_Utils_Hook::alterDisplayName($displayName, $id, $dao); | |
95fec3ce | 541 | |
f6b81482 | 542 | return $includeTypeInReturnParameters ? [ |
967fddb5 | 543 | $displayName, |
250b3b1f | 544 | $image, |
545 | $dao->contact_type, | |
546 | $dao->contact_sub_type, | |
547 | $imageUrl, | |
f6b81482 | 548 | ] : [$displayName, $image, $imageUrl]; |
6a488035 TO |
549 | } |
550 | return NULL; | |
551 | } | |
552 | ||
870156d6 | 553 | /** |
554 | * Add billing fields to the params if appropriate. | |
555 | * | |
556 | * If we have ANY name fields then we want to ignore all the billing name fields. However, if we | |
f12392c8 | 557 | * don't then we should set the name fields to the billing fields AND add the preserveDBName |
870156d6 | 558 | * parameter (which will tell the BAO only to set those fields if none already exist. |
559 | * | |
560 | * We specifically don't want to set first name from billing and last name form an on-page field. Mixing & | |
561 | * matching is best done by hipsters. | |
562 | * | |
563 | * @param array $params | |
f12392c8 MWMC |
564 | * |
565 | * @fixme How does this relate to almost the same thing being done in CRM_Core_Form::formatParamsForPaymentProcessor() | |
870156d6 | 566 | */ |
567 | public static function addBillingNameFieldsIfOtherwiseNotSet(&$params) { | |
f6b81482 | 568 | $nameFields = ['first_name', 'middle_name', 'last_name', 'nick_name', 'prefix_id', 'suffix_id']; |
870156d6 | 569 | foreach ($nameFields as $field) { |
570 | if (!empty($params[$field])) { | |
571 | return; | |
572 | } | |
573 | } | |
574 | // There are only 3 - we can iterate through them twice :-) | |
575 | foreach ($nameFields as $field) { | |
576 | if (!empty($params['billing_' . $field])) { | |
577 | $params[$field] = $params['billing_' . $field]; | |
578 | } | |
579 | $params['preserveDBName'] = TRUE; | |
580 | } | |
581 | ||
582 | } | |
583 | ||
8ff43cf2 | 584 | /** |
585 | * Resolve a state province string (UT or Utah) to an ID. | |
586 | * | |
587 | * If country has been passed in we should select a state belonging to that country. | |
588 | * | |
589 | * Alternatively we should choose from enabled countries, prioritising the default country. | |
590 | * | |
591 | * @param array $values | |
e97c66ff | 592 | * @param int|null $countryID |
8ff43cf2 | 593 | * |
594 | * @return int|null | |
e97c66ff | 595 | * |
596 | * @throws \CRM_Core_Exception | |
8ff43cf2 | 597 | */ |
598 | protected static function resolveStateProvinceID($values, $countryID) { | |
599 | ||
600 | if ($countryID) { | |
601 | $stateProvinceList = CRM_Core_PseudoConstant::stateProvinceForCountry($countryID); | |
4352bd72 | 602 | if (CRM_Utils_Array::lookupValue($values, |
603 | 'state_province', | |
604 | $stateProvinceList, | |
605 | TRUE | |
606 | )) { | |
607 | return $values['state_province_id']; | |
608 | } | |
609 | $stateProvinceList = CRM_Core_PseudoConstant::stateProvinceForCountry($countryID, 'abbreviation'); | |
610 | if (CRM_Utils_Array::lookupValue($values, | |
611 | 'state_province', | |
612 | $stateProvinceList, | |
613 | TRUE | |
614 | )) { | |
615 | return $values['state_province_id']; | |
616 | } | |
617 | return NULL; | |
8ff43cf2 | 618 | } |
619 | else { | |
4352bd72 | 620 | // The underlying lookupValue function needs some de-fanging. Until that has been unravelled we |
621 | // continue to resolve stateprovince lists in descending order of preference & just 'keep trying'. | |
622 | // prefer matching country.. | |
f6b81482 | 623 | $stateProvinceList = CRM_Core_BAO_Address::buildOptions('state_province_id', NULL, ['country_id' => Civi::settings()->get('defaultContactCountry')]); |
4352bd72 | 624 | if (CRM_Utils_Array::lookupValue($values, |
625 | 'state_province', | |
626 | $stateProvinceList, | |
627 | TRUE | |
628 | )) { | |
629 | return $values['state_province_id']; | |
630 | } | |
631 | ||
8ff43cf2 | 632 | $stateProvinceList = CRM_Core_PseudoConstant::stateProvince(); |
4352bd72 | 633 | if (CRM_Utils_Array::lookupValue($values, |
634 | 'state_province', | |
635 | $stateProvinceList, | |
636 | TRUE | |
637 | )) { | |
638 | return $values['state_province_id']; | |
639 | } | |
8ff43cf2 | 640 | |
4352bd72 | 641 | $stateProvinceList = CRM_Core_PseudoConstant::stateProvinceAbbreviationForDefaultCountry(); |
642 | if (CRM_Utils_Array::lookupValue($values, | |
643 | 'state_province', | |
644 | $stateProvinceList, | |
645 | TRUE | |
646 | )) { | |
647 | return $values['state_province_id']; | |
648 | } | |
8ff43cf2 | 649 | $stateProvinceList = CRM_Core_PseudoConstant::stateProvinceAbbreviation(); |
4352bd72 | 650 | if (CRM_Utils_Array::lookupValue($values, |
651 | 'state_province', | |
652 | $stateProvinceList, | |
653 | TRUE | |
654 | )) { | |
655 | return $values['state_province_id']; | |
656 | } | |
8ff43cf2 | 657 | } |
4352bd72 | 658 | |
659 | return NULL; | |
8ff43cf2 | 660 | } |
661 | ||
b795cfc3 SV |
662 | /** |
663 | * Get the relevant location entity for the array key. | |
664 | * | |
665 | * Based on the field name we determine which location entity | |
666 | * we are dealing with. Apart from a few specific ones they | |
667 | * are mostly 'address' (the default). | |
668 | * | |
669 | * @param string $fieldName | |
670 | * | |
671 | * @return string | |
672 | */ | |
673 | protected static function getLocationEntityForKey($fieldName) { | |
674 | if (in_array($fieldName, ['email', 'phone', 'im', 'openid'])) { | |
675 | return $fieldName; | |
676 | } | |
677 | if ($fieldName === 'phone_ext') { | |
678 | return 'phone'; | |
679 | } | |
680 | return 'address'; | |
681 | } | |
682 | ||
844bdf39 | 683 | /** |
684 | * Soft delete a contact. | |
685 | * | |
686 | * Call this via the api, not directly. | |
687 | * | |
688 | * @param \CRM_Contact_BAO_Contact $contact | |
689 | * | |
690 | * @return bool | |
691 | * @throws \CRM_Core_Exception | |
692 | */ | |
693 | protected static function contactTrash($contact): bool { | |
694 | $updateParams = [ | |
695 | 'id' => $contact->id, | |
696 | 'is_deleted' => 1, | |
697 | ]; | |
698 | CRM_Utils_Hook::pre('update', $contact->contact_type, $contact->id, $updateParams); | |
699 | ||
700 | $params = [1 => [$contact->id, 'Integer']]; | |
701 | $query = 'DELETE FROM civicrm_uf_match WHERE contact_id = %1'; | |
702 | CRM_Core_DAO::executeQuery($query, $params); | |
703 | ||
704 | $contact->copyValues($updateParams); | |
705 | $contact->save(); | |
706 | CRM_Core_BAO_Log::register($contact->id, 'civicrm_contact', $contact->id); | |
707 | ||
708 | CRM_Utils_Hook::post('update', $contact->contact_type, $contact->id, $contact); | |
709 | ||
710 | return TRUE; | |
711 | } | |
712 | ||
688ad538 | 713 | /** |
22f80e87 EM |
714 | * Create last viewed link to recently updated contact. |
715 | * | |
77c5b619 | 716 | * @param array $crudLinkSpec |
55d2c6f1 EM |
717 | * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW] |
718 | * - entity_table: string, eg "civicrm_contact" | |
719 | * - entity_id: int | |
720 | * | |
72b3a70c | 721 | * @return array|NULL |
16b10e64 CW |
722 | * NULL if unavailable, or |
723 | * [path: string, query: string, title: string] | |
688ad538 TO |
724 | * @see CRM_Utils_System::createDefaultCrudLink |
725 | */ | |
726 | public function createDefaultCrudLink($crudLinkSpec) { | |
727 | switch ($crudLinkSpec['action']) { | |
728 | case CRM_Core_Action::VIEW: | |
f6b81482 | 729 | $result = [ |
688ad538 TO |
730 | 'title' => $this->display_name, |
731 | 'path' => 'civicrm/contact/view', | |
f6b81482 | 732 | 'query' => [ |
688ad538 TO |
733 | 'reset' => 1, |
734 | 'cid' => $this->id, | |
f6b81482 | 735 | ], |
736 | ]; | |
6c552737 | 737 | return $result; |
ea100cb5 | 738 | |
688ad538 | 739 | case CRM_Core_Action::UPDATE: |
f6b81482 | 740 | $result = [ |
688ad538 TO |
741 | 'title' => $this->display_name, |
742 | 'path' => 'civicrm/contact/add', | |
f6b81482 | 743 | 'query' => [ |
688ad538 TO |
744 | 'reset' => 1, |
745 | 'action' => 'update', | |
746 | 'cid' => $this->id, | |
f6b81482 | 747 | ], |
748 | ]; | |
6c552737 | 749 | return $result; |
688ad538 TO |
750 | } |
751 | return NULL; | |
752 | } | |
753 | ||
6a488035 | 754 | /** |
6a488035 TO |
755 | * Get the values for pseudoconstants for name->value and reverse. |
756 | * | |
f6b81482 | 757 | * @param array $defaults |
758 | * (reference) the default values, some of which need to be resolved. | |
759 | * @param bool $reverse | |
760 | * Always true as this function is only called from one place.. | |
761 | * | |
8ff43cf2 | 762 | * @deprecated |
763 | * | |
764 | * This is called specifically from the contact import parser & should be moved there | |
765 | * as it is not truly a generic function. | |
766 | * | |
6a488035 | 767 | */ |
00be9182 | 768 | public static function resolveDefaults(&$defaults, $reverse = FALSE) { |
22f80e87 | 769 | // Hack for birth_date. |
a7488080 | 770 | if (!empty($defaults['birth_date'])) { |
6a488035 TO |
771 | if (is_array($defaults['birth_date'])) { |
772 | $defaults['birth_date'] = CRM_Utils_Date::format($defaults['birth_date'], '-'); | |
773 | } | |
774 | } | |
775 | ||
e6c4755b CW |
776 | CRM_Utils_Array::lookupValue($defaults, 'prefix', CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id'), $reverse); |
777 | CRM_Utils_Array::lookupValue($defaults, 'suffix', CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'suffix_id'), $reverse); | |
26cf88b5 | 778 | CRM_Utils_Array::lookupValue($defaults, 'gender', CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id'), $reverse); |
aa62b355 | 779 | CRM_Utils_Array::lookupValue($defaults, 'communication_style', CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'communication_style_id'), $reverse); |
6a488035 TO |
780 | |
781 | //lookup value of email/postal greeting, addressee, CRM-4575 | |
782 | foreach (self::$_greetingTypes as $greeting) { | |
f6b81482 | 783 | $filterCondition = [ |
6b409353 | 784 | 'contact_type' => $defaults['contact_type'] ?? NULL, |
6a488035 | 785 | 'greeting_type' => $greeting, |
f6b81482 | 786 | ]; |
6a488035 TO |
787 | CRM_Utils_Array::lookupValue($defaults, $greeting, |
788 | CRM_Core_PseudoConstant::greeting($filterCondition), $reverse | |
789 | ); | |
790 | } | |
791 | ||
f6b81482 | 792 | $blocks = ['address', 'im', 'phone']; |
6a488035 TO |
793 | foreach ($blocks as $name) { |
794 | if (!array_key_exists($name, $defaults) || !is_array($defaults[$name])) { | |
795 | continue; | |
796 | } | |
797 | foreach ($defaults[$name] as $count => & $values) { | |
798 | ||
799 | //get location type id. | |
b2b0530a | 800 | CRM_Utils_Array::lookupValue($values, 'location_type', CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'), $reverse); |
6a488035 TO |
801 | |
802 | if ($name == 'address') { | |
803 | // FIXME: lookupValue doesn't work for vcard_name | |
a7488080 | 804 | if (!empty($values['location_type_id'])) { |
f6b81482 | 805 | $vcardNames = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id', ['labelColumn' => 'vcard_name']); |
6a488035 TO |
806 | $values['vcard_name'] = $vcardNames[$values['location_type_id']]; |
807 | } | |
808 | ||
809 | if (!CRM_Utils_Array::lookupValue($values, | |
810 | 'country', | |
811 | CRM_Core_PseudoConstant::country(), | |
812 | $reverse | |
813 | ) && | |
814 | $reverse | |
815 | ) { | |
816 | CRM_Utils_Array::lookupValue($values, | |
817 | 'country', | |
818 | CRM_Core_PseudoConstant::countryIsoCode(), | |
819 | $reverse | |
820 | ); | |
821 | } | |
fdb6d23b | 822 | $stateProvinceID = self::resolveStateProvinceID($values, $values['country_id'] ?? NULL); |
8ff43cf2 | 823 | if ($stateProvinceID) { |
824 | $values['state_province_id'] = $stateProvinceID; | |
6a488035 TO |
825 | } |
826 | ||
827 | if (!empty($values['state_province_id'])) { | |
828 | $countyList = CRM_Core_PseudoConstant::countyForState($values['state_province_id']); | |
829 | } | |
830 | else { | |
831 | $countyList = CRM_Core_PseudoConstant::county(); | |
832 | } | |
833 | CRM_Utils_Array::lookupValue($values, | |
834 | 'county', | |
835 | $countyList, | |
836 | $reverse | |
837 | ); | |
838 | } | |
839 | ||
840 | if ($name == 'im') { | |
841 | CRM_Utils_Array::lookupValue($values, | |
842 | 'provider', | |
e7e657f0 | 843 | CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id'), |
6a488035 TO |
844 | $reverse |
845 | ); | |
846 | } | |
847 | ||
848 | if ($name == 'phone') { | |
849 | CRM_Utils_Array::lookupValue($values, | |
850 | 'phone_type', | |
b4f964d9 | 851 | CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id'), |
6a488035 TO |
852 | $reverse |
853 | ); | |
854 | } | |
855 | ||
22f80e87 | 856 | // Kill the reference. |
6a488035 TO |
857 | unset($values); |
858 | } | |
859 | } | |
860 | } | |
861 | ||
862 | /** | |
0965e988 | 863 | * Fetch object based on array of properties. |
6a488035 | 864 | * |
77c5b619 TO |
865 | * @param array $params |
866 | * (reference ) an assoc array of name/value pairs. | |
867 | * @param array $defaults | |
868 | * (reference ) an assoc array to hold the name / value pairs. | |
6a488035 | 869 | * in a hierarchical manner |
77c5b619 TO |
870 | * @param bool $microformat |
871 | * For location in microformat. | |
6a488035 | 872 | * |
16b10e64 | 873 | * @return CRM_Contact_BAO_Contact |
6a488035 | 874 | */ |
00be9182 | 875 | public static function &retrieve(&$params, &$defaults, $microformat = FALSE) { |
6a488035 TO |
876 | if (array_key_exists('contact_id', $params)) { |
877 | $params['id'] = $params['contact_id']; | |
878 | } | |
879 | elseif (array_key_exists('id', $params)) { | |
880 | $params['contact_id'] = $params['id']; | |
881 | } | |
882 | ||
883 | $contact = self::getValues($params, $defaults); | |
884 | ||
885 | unset($params['id']); | |
886 | ||
887 | //get the block information for this contact | |
f6b81482 | 888 | $entityBlock = ['contact_id' => $params['contact_id']]; |
9bb77b8e TO |
889 | $blocks = CRM_Core_BAO_Location::getValues($entityBlock, $microformat); |
890 | $defaults = array_merge($defaults, $blocks); | |
891 | foreach ($blocks as $block => $value) { | |
892 | $contact->$block = $value; | |
893 | } | |
6a488035 TO |
894 | |
895 | if (!isset($params['noNotes'])) { | |
896 | $contact->notes = CRM_Core_BAO_Note::getValues($params, $defaults); | |
897 | } | |
898 | ||
899 | if (!isset($params['noRelationships'])) { | |
900 | $contact->relationship = CRM_Contact_BAO_Relationship::getValues($params, $defaults); | |
901 | } | |
902 | ||
903 | if (!isset($params['noGroups'])) { | |
904 | $contact->groupContact = CRM_Contact_BAO_GroupContact::getValues($params, $defaults); | |
905 | } | |
906 | ||
907 | if (!isset($params['noWebsite'])) { | |
908 | $contact->website = CRM_Core_BAO_Website::getValues($params, $defaults); | |
909 | } | |
910 | ||
911 | return $contact; | |
912 | } | |
913 | ||
914 | /** | |
0965e988 | 915 | * Get the display name of a contact. |
6a488035 | 916 | * |
77c5b619 TO |
917 | * @param int $id |
918 | * Id of the contact. | |
6a488035 | 919 | * |
72b3a70c CW |
920 | * @return null|string |
921 | * display name of the contact if found | |
6a488035 | 922 | */ |
00be9182 | 923 | public static function displayName($id) { |
6a488035 TO |
924 | $displayName = NULL; |
925 | if ($id) { | |
926 | $displayName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'display_name'); | |
927 | } | |
928 | ||
929 | return $displayName; | |
930 | } | |
931 | ||
932 | /** | |
55d2c6f1 | 933 | * Delete a contact and all its associated records. |
6a488035 | 934 | * |
77c5b619 TO |
935 | * @param int $id |
936 | * Id of the contact to delete. | |
937 | * @param bool $restore | |
938 | * Whether to actually restore, not delete. | |
939 | * @param bool $skipUndelete | |
940 | * Whether to force contact delete or not. | |
dbb0d30b | 941 | * @param bool $checkPermissions |
6a488035 | 942 | * |
55d2c6f1 EM |
943 | * @return bool |
944 | * Was contact deleted? | |
0bab639e | 945 | * |
946 | * @throws \CRM_Core_Exception | |
947 | * @throws \CiviCRM_API3_Exception | |
6a488035 | 948 | */ |
fa6448fa | 949 | public static function deleteContact($id, $restore = FALSE, $skipUndelete = FALSE, $checkPermissions = TRUE) { |
6a488035 | 950 | |
0bab639e | 951 | if (!$id || !is_numeric($id)) { |
952 | CRM_Core_Error::deprecatedFunctionWarning('calling delete contact without a valid contact ID is deprecated.'); | |
6a488035 TO |
953 | return FALSE; |
954 | } | |
b0033001 | 955 | // If trash is disabled in system settings then we always skip |
89595c92 | 956 | if (!Civi::settings()->get('contact_undelete')) { |
b0033001 CW |
957 | $skipUndelete = TRUE; |
958 | } | |
6a488035 TO |
959 | |
960 | // make sure we have edit permission for this contact | |
961 | // before we delete | |
fa6448fa | 962 | if ($checkPermissions && (($skipUndelete && !CRM_Core_Permission::check('delete contacts')) || |
f6b81482 | 963 | ($restore && !CRM_Core_Permission::check('access deleted contacts'))) |
6a488035 TO |
964 | ) { |
965 | return FALSE; | |
966 | } | |
2efcf0c2 | 967 | |
f182074e PN |
968 | // CRM-12929 |
969 | // Restrict contact to be delete if contact has financial trxns | |
970 | $error = NULL; | |
f6b81482 | 971 | if ($skipUndelete && CRM_Financial_BAO_FinancialItem::checkContactPresent([$id], $error)) { |
f182074e PN |
972 | return FALSE; |
973 | } | |
6a488035 TO |
974 | |
975 | // make sure this contact_id does not have any membership types | |
976 | $membershipTypeID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', | |
977 | $id, | |
978 | 'id', | |
979 | 'member_of_contact_id' | |
980 | ); | |
981 | if ($membershipTypeID) { | |
982 | return FALSE; | |
983 | } | |
984 | ||
985 | $contact = new CRM_Contact_DAO_Contact(); | |
986 | $contact->id = $id; | |
987 | if (!$contact->find(TRUE)) { | |
988 | return FALSE; | |
989 | } | |
990 | ||
991 | $contactType = $contact->contact_type; | |
690c56c3 | 992 | if ($restore) { |
8e12bf07 | 993 | // @todo deprecate calling contactDelete with the intention to restore. |
994 | $updateParams = [ | |
995 | 'id' => $contact->id, | |
996 | 'is_deleted' => FALSE, | |
997 | ]; | |
998 | self::create($updateParams); | |
999 | return TRUE; | |
690c56c3 | 1000 | } |
1001 | ||
6a488035 TO |
1002 | // start a new transaction |
1003 | $transaction = new CRM_Core_Transaction(); | |
1004 | ||
b0033001 | 1005 | if ($skipUndelete) { |
9d4c4ffd | 1006 | $hookParams = ['check_permissions' => $checkPermissions]; |
1007 | CRM_Utils_Hook::pre('delete', $contactType, $id, $hookParams); | |
6a488035 TO |
1008 | |
1009 | //delete billing address if exists. | |
1010 | CRM_Contribute_BAO_Contribution::deleteAddress(NULL, $id); | |
1011 | ||
1012 | // delete the log entries since we dont have triggers enabled as yet | |
1013 | $logDAO = new CRM_Core_DAO_Log(); | |
1014 | $logDAO->entity_table = 'civicrm_contact'; | |
1015 | $logDAO->entity_id = $id; | |
1016 | $logDAO->delete(); | |
1071730c | 1017 | |
c3d24ba7 PN |
1018 | // delete contact participants CRM-12155 |
1019 | CRM_Event_BAO_Participant::deleteContactParticipant($id); | |
6a488035 | 1020 | |
c3d24ba7 PN |
1021 | // delete contact contributions CRM-12155 |
1022 | CRM_Contribute_BAO_Contribution::deleteContactContribution($id); | |
1071730c | 1023 | |
6a488035 TO |
1024 | // do activity cleanup, CRM-5604 |
1025 | CRM_Activity_BAO_Activity::cleanupActivity($id); | |
1026 | ||
1027 | // delete all notes related to contact | |
1028 | CRM_Core_BAO_Note::cleanContactNotes($id); | |
1029 | ||
55033e60 PJ |
1030 | // delete cases related to contact |
1031 | $contactCases = CRM_Case_BAO_Case::retrieveCaseIdsByContactId($id); | |
1032 | if (!empty($contactCases)) { | |
d3b60a94 | 1033 | foreach ($contactCases as $caseId) { |
55033e60 PJ |
1034 | //check if case is associate with other contact or not. |
1035 | $caseContactId = CRM_Case_BAO_Case::getCaseClients($caseId); | |
d3b60a94 | 1036 | if (count($caseContactId) <= 1) { |
55033e60 PJ |
1037 | CRM_Case_BAO_Case::deleteCase($caseId); |
1038 | } | |
1039 | } | |
1040 | } | |
1041 | ||
6a488035 TO |
1042 | $contact->delete(); |
1043 | } | |
1044 | else { | |
844bdf39 | 1045 | self::contactTrash($contact); |
6a488035 | 1046 | } |
310c2031 | 1047 | // currently we only clear employer cache. |
1048 | // we are now deleting inherited membership if any. | |
1049 | if ($contact->contact_type == 'Organization') { | |
1050 | $action = $restore ? CRM_Core_Action::ENABLE : CRM_Core_Action::DISABLE; | |
1051 | $relationshipDtls = CRM_Contact_BAO_Relationship::getRelationship($id); | |
1052 | if (!empty($relationshipDtls)) { | |
1053 | foreach ($relationshipDtls as $rId => $details) { | |
1054 | CRM_Contact_BAO_Relationship::disableEnableRelationship($rId, $action); | |
1055 | } | |
1056 | } | |
1057 | CRM_Contact_BAO_Contact_Utils::clearAllEmployee($id); | |
1058 | } | |
6a488035 TO |
1059 | |
1060 | //delete the contact id from recently view | |
1061 | CRM_Utils_Recent::delContact($id); | |
ae44c3b9 | 1062 | self::updateContactCache($id, empty($restore)); |
6a488035 | 1063 | |
744b4e34 TO |
1064 | // delete any prevnext/dupe cache entry |
1065 | // These two calls are redundant in default deployments, but they're | |
1066 | // meaningful if "prevnext" is memory-backed. | |
1067 | Civi::service('prevnext')->deleteItem($id); | |
6a488035 TO |
1068 | CRM_Core_BAO_PrevNextCache::deleteItem($id); |
1069 | ||
1070 | $transaction->commit(); | |
1071 | ||
b0033001 CW |
1072 | if ($skipUndelete) { |
1073 | CRM_Utils_Hook::post('delete', $contactType, $contact->id, $contact); | |
1074 | } | |
6a488035 | 1075 | |
6a488035 TO |
1076 | return TRUE; |
1077 | } | |
1078 | ||
ae44c3b9 | 1079 | /** |
1080 | * Action to update any caches relating to a recently update contact. | |
1081 | * | |
1082 | * I was going to call this from delete as well as from create to ensure the delete is being | |
1083 | * done whenever a contact is set to is_deleted=1 BUT I found create is already over-aggressive in | |
1084 | * that regard so adding it to delete seems to be enough to remove it from CRM_Contact_BAO_Contact_Permission | |
1085 | * where the call involved a subquery that was locking the table. | |
1086 | * | |
1087 | * @param int $contactID | |
1088 | * @param bool $isTrashed | |
1089 | */ | |
1090 | public static function updateContactCache($contactID, $isTrashed = FALSE) { | |
1091 | ||
1092 | if ($isTrashed) { | |
1093 | CRM_Contact_BAO_GroupContactCache::removeContact($contactID); | |
1094 | // This has been moved to here from CRM_Contact_BAO_Contact_Permission as that was causing | |
1095 | // a table-locking query. It still seems a bit inadequate as it assumes the acl users can't see deleted | |
1096 | // but this should not cause any change as long as contacts are not being trashed outside the | |
1097 | // main functions for that. | |
f6b81482 | 1098 | CRM_Core_DAO::executeQuery('DELETE FROM civicrm_acl_contact_cache WHERE contact_id = %1', [1 => [$contactID, 'Integer']]); |
ae44c3b9 | 1099 | } |
1100 | else { | |
2b68a50c | 1101 | CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush(); |
ae44c3b9 | 1102 | } |
1103 | } | |
1104 | ||
6a488035 | 1105 | /** |
55d2c6f1 | 1106 | * Delete the image of a contact. |
6a488035 | 1107 | * |
77c5b619 TO |
1108 | * @param int $id |
1109 | * Id of the contact. | |
6a488035 | 1110 | * |
55d2c6f1 EM |
1111 | * @return bool |
1112 | * Was contact image deleted? | |
6a488035 TO |
1113 | */ |
1114 | public static function deleteContactImage($id) { | |
1115 | if (!$id) { | |
1116 | return FALSE; | |
1117 | } | |
50fb017d MD |
1118 | |
1119 | $contact = new self(); | |
1120 | $contact->id = $id; | |
1121 | $contact->image_URL = 'null'; | |
1122 | $contact->save(); | |
1123 | ||
6a488035 TO |
1124 | return TRUE; |
1125 | } | |
1126 | ||
6a488035 | 1127 | /** |
0965e988 | 1128 | * Return proportional height and width of the image. |
6a488035 | 1129 | * |
df8d3074 | 1130 | * @param int $imageWidth |
77c5b619 | 1131 | * Width of image. |
6a488035 | 1132 | * |
df8d3074 | 1133 | * @param int $imageHeight |
77c5b619 | 1134 | * Height of image. |
6a488035 | 1135 | * |
0965e988 EM |
1136 | * @return array |
1137 | * Thumb dimension of image | |
6a488035 TO |
1138 | */ |
1139 | public static function getThumbSize($imageWidth, $imageHeight) { | |
1140 | $thumbWidth = 100; | |
1141 | if ($imageWidth && $imageHeight) { | |
1142 | $imageRatio = $imageWidth / $imageHeight; | |
1143 | } | |
1144 | else { | |
1145 | $imageRatio = 1; | |
1146 | } | |
1147 | if ($imageRatio > 1) { | |
1148 | $imageThumbWidth = $thumbWidth; | |
1149 | $imageThumbHeight = round($thumbWidth / $imageRatio); | |
1150 | } | |
1151 | else { | |
1152 | $imageThumbHeight = $thumbWidth; | |
1153 | $imageThumbWidth = round($thumbWidth * $imageRatio); | |
1154 | } | |
1155 | ||
f6b81482 | 1156 | return [$imageThumbWidth, $imageThumbHeight]; |
6a488035 TO |
1157 | } |
1158 | ||
1159 | /** | |
0965e988 | 1160 | * Validate type of contact image. |
6a488035 | 1161 | * |
c490a46a | 1162 | * @param array $params |
d3e86119 | 1163 | * @param string $imageIndex |
77c5b619 | 1164 | * Index of image field. |
d3e86119 | 1165 | * @param string $statusMsg |
77c5b619 TO |
1166 | * Status message to be set after operation. |
1167 | * @param string $opType | |
1168 | * Type of operation like fatal, bounce etc. | |
6a488035 | 1169 | * |
0965e988 | 1170 | * @return bool |
a6c01b45 | 1171 | * true if valid image extension |
6a488035 | 1172 | */ |
9bb77b8e TO |
1173 | public static function processImageParams( |
1174 | &$params, | |
6a488035 | 1175 | $imageIndex = 'image_URL', |
9bb77b8e TO |
1176 | $statusMsg = NULL, |
1177 | $opType = 'status' | |
6a488035 | 1178 | ) { |
f6b81482 | 1179 | $mimeType = [ |
6a488035 TO |
1180 | 'image/jpeg', |
1181 | 'image/jpg', | |
1182 | 'image/png', | |
1183 | 'image/bmp', | |
1184 | 'image/p-jpeg', | |
1185 | 'image/gif', | |
1186 | 'image/x-png', | |
f6b81482 | 1187 | ]; |
6a488035 TO |
1188 | |
1189 | if (in_array($params[$imageIndex]['type'], $mimeType)) { | |
5da97e99 | 1190 | $photo = basename($params[$imageIndex]['name']); |
9bb77b8e | 1191 | $params[$imageIndex] = CRM_Utils_System::url('civicrm/contact/imagefile', 'photo=' . $photo, TRUE, NULL, TRUE, TRUE); |
6a488035 TO |
1192 | return TRUE; |
1193 | } | |
1194 | else { | |
1195 | unset($params[$imageIndex]); | |
1196 | if (!$statusMsg) { | |
1197 | $statusMsg = ts('Image could not be uploaded due to invalid type extension.'); | |
1198 | } | |
1199 | if ($opType == 'status') { | |
b7a21318 | 1200 | CRM_Core_Session::setStatus($statusMsg, ts('Error'), 'error'); |
6a488035 TO |
1201 | } |
1202 | // FIXME: additional support for fatal, bounce etc could be added. | |
1203 | return FALSE; | |
1204 | } | |
1205 | } | |
1206 | ||
1207 | /** | |
0965e988 | 1208 | * Extract contact id from url for deleting contact image. |
6a488035 TO |
1209 | */ |
1210 | public static function processImage() { | |
1211 | ||
1050d25c CW |
1212 | $action = CRM_Utils_Request::retrieve('action', 'String'); |
1213 | $cid = CRM_Utils_Request::retrieve('cid', 'Positive'); | |
6a488035 | 1214 | // retrieve contact id in case of Profile context |
1050d25c | 1215 | $id = CRM_Utils_Request::retrieve('id', 'Positive'); |
6a488035 TO |
1216 | $cid = $cid ? $cid : $id; |
1217 | if ($action & CRM_Core_Action::DELETE) { | |
1050d25c | 1218 | if (CRM_Utils_Request::retrieve('confirmed', 'Boolean')) { |
6a488035 TO |
1219 | CRM_Contact_BAO_Contact::deleteContactImage($cid); |
1220 | CRM_Core_Session::setStatus(ts('Contact image deleted successfully'), ts('Image Deleted'), 'success'); | |
1221 | $session = CRM_Core_Session::singleton(); | |
1222 | $toUrl = $session->popUserContext(); | |
1223 | CRM_Utils_System::redirect($toUrl); | |
1224 | } | |
1225 | } | |
1226 | } | |
1227 | ||
1228 | /** | |
0965e988 | 1229 | * Function to set is_delete true or restore deleted contact. |
6a488035 | 1230 | * |
b0033001 | 1231 | * @param CRM_Contact_DAO_Contact $contact |
d3e86119 TO |
1232 | * Contact DAO object. |
1233 | * @param bool $restore | |
1234 | * True to set the is_delete = 1 else false to restore deleted contact, | |
b0033001 CW |
1235 | * i.e. is_delete = 0 |
1236 | * | |
844bdf39 | 1237 | * @deprecated |
1238 | * | |
b0033001 | 1239 | * @return bool |
8e12bf07 | 1240 | * @throws \CRM_Core_Exception |
6a488035 | 1241 | */ |
00be9182 | 1242 | public static function contactTrashRestore($contact, $restore = FALSE) { |
844bdf39 | 1243 | CRM_Core_Error::deprecatedFunctionWarning('Use the api'); |
6a488035 | 1244 | |
8e12bf07 | 1245 | if ($restore) { |
1246 | CRM_Core_Error::deprecatedFunctionWarning('Use contact.create to restore - this does nothing much'); | |
1247 | // @todo deprecate calling contactDelete with the intention to restore. | |
1248 | $updateParams = [ | |
1249 | 'id' => $contact->id, | |
1250 | 'is_deleted' => FALSE, | |
1251 | ]; | |
1252 | self::create($updateParams); | |
1253 | return TRUE; | |
6a488035 | 1254 | } |
844bdf39 | 1255 | return self::contactTrash($contact); |
6a488035 TO |
1256 | } |
1257 | ||
1258 | /** | |
1259 | * Get contact type for a contact. | |
1260 | * | |
77c5b619 TO |
1261 | * @param int $id |
1262 | * Id of the contact whose contact type is needed. | |
6a488035 | 1263 | * |
a6c01b45 CW |
1264 | * @return string |
1265 | * contact_type if $id found else null "" | |
6a488035 TO |
1266 | */ |
1267 | public static function getContactType($id) { | |
1268 | return CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_type'); | |
1269 | } | |
1270 | ||
1271 | /** | |
1272 | * Get contact sub type for a contact. | |
1273 | * | |
77c5b619 TO |
1274 | * @param int $id |
1275 | * Id of the contact whose contact sub type is needed. | |
6a488035 | 1276 | * |
364c80f1 | 1277 | * @param string $implodeDelimiter |
dd244018 | 1278 | * |
a6c01b45 CW |
1279 | * @return string |
1280 | * contact_sub_type if $id found else null "" | |
6a488035 TO |
1281 | */ |
1282 | public static function getContactSubType($id, $implodeDelimiter = NULL) { | |
1283 | $subtype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_sub_type'); | |
1284 | if (!$subtype) { | |
f6b81482 | 1285 | return $implodeDelimiter ? NULL : []; |
6a488035 TO |
1286 | } |
1287 | ||
f2181617 | 1288 | $subtype = CRM_Utils_Array::explodePadded($subtype); |
6a488035 TO |
1289 | |
1290 | if ($implodeDelimiter) { | |
1291 | $subtype = implode($implodeDelimiter, $subtype); | |
1292 | } | |
1293 | return $subtype; | |
1294 | } | |
1295 | ||
1296 | /** | |
1297 | * Get pair of contact-type and sub-type for a contact. | |
1298 | * | |
77c5b619 TO |
1299 | * @param int $id |
1300 | * Id of the contact whose contact sub/contact type is needed. | |
6a488035 TO |
1301 | * |
1302 | * @return array | |
6a488035 TO |
1303 | */ |
1304 | public static function getContactTypes($id) { | |
f6b81482 | 1305 | $params = ['id' => $id]; |
1306 | $details = []; | |
6a488035 TO |
1307 | $contact = CRM_Core_DAO::commonRetrieve('CRM_Contact_DAO_Contact', |
1308 | $params, | |
1309 | $details, | |
f6b81482 | 1310 | ['contact_type', 'contact_sub_type'] |
6a488035 TO |
1311 | ); |
1312 | ||
1313 | if ($contact) { | |
f6b81482 | 1314 | $contactTypes = []; |
0965e988 | 1315 | if ($contact->contact_sub_type) { |
f2181617 | 1316 | $contactTypes = CRM_Utils_Array::explodePadded($contact->contact_sub_type); |
0965e988 | 1317 | } |
6a488035 TO |
1318 | array_unshift($contactTypes, $contact->contact_type); |
1319 | ||
1320 | return $contactTypes; | |
1321 | } | |
1322 | else { | |
2d296f18 | 1323 | throw new CRM_Core_Exception(); |
6a488035 TO |
1324 | } |
1325 | } | |
1326 | ||
1327 | /** | |
0965e988 | 1328 | * Combine all the importable fields from the lower levels object. |
6a488035 TO |
1329 | * |
1330 | * The ordering is important, since currently we do not have a weight | |
1071730c | 1331 | * scheme. Adding weight is super important |
6a488035 | 1332 | * |
dd244018 | 1333 | * @param int|string $contactType contact Type |
77c5b619 TO |
1334 | * @param bool $status |
1335 | * Status is used to manipulate first title. | |
1336 | * @param bool $showAll | |
1337 | * If true returns all fields (includes disabled fields). | |
1338 | * @param bool $isProfile | |
1339 | * If its profile mode. | |
1340 | * @param bool $checkPermission | |
1341 | * If false, do not include permissioning clause (for custom data). | |
6a488035 | 1342 | * |
dd244018 EM |
1343 | * @param bool $withMultiCustomFields |
1344 | * | |
a6c01b45 CW |
1345 | * @return array |
1346 | * array of importable Fields | |
6a488035 | 1347 | */ |
5c9ff055 | 1348 | public static function importableFields( |
9bb77b8e TO |
1349 | $contactType = 'Individual', |
1350 | $status = FALSE, | |
1351 | $showAll = FALSE, | |
1352 | $isProfile = FALSE, | |
6a488035 TO |
1353 | $checkPermission = TRUE, |
1354 | $withMultiCustomFields = FALSE | |
1355 | ) { | |
1356 | if (empty($contactType)) { | |
1357 | $contactType = 'All'; | |
1358 | } | |
1359 | ||
1360 | $cacheKeyString = "importableFields $contactType"; | |
1361 | $cacheKeyString .= $status ? '_1' : '_0'; | |
1362 | $cacheKeyString .= $showAll ? '_1' : '_0'; | |
1363 | $cacheKeyString .= $isProfile ? '_1' : '_0'; | |
1364 | $cacheKeyString .= $checkPermission ? '_1' : '_0'; | |
f4de748f | 1365 | $cacheKeyString .= '_' . CRM_Core_Config::domainID() . '_'; |
6a488035 | 1366 | |
fdb6d23b | 1367 | $fields = self::$_importableFields[$cacheKeyString] ?? Civi::cache('fields')->get($cacheKeyString); |
6a488035 TO |
1368 | |
1369 | if (!$fields) { | |
1370 | $fields = CRM_Contact_DAO_Contact::import(); | |
1371 | ||
1372 | // get the fields thar are meant for contact types | |
f6b81482 | 1373 | if (in_array($contactType, [ |
9bb77b8e TO |
1374 | 'Individual', |
1375 | 'Household', | |
1376 | 'Organization', | |
21dfd5f5 | 1377 | 'All', |
f6b81482 | 1378 | ])) { |
6a488035 TO |
1379 | $fields = array_merge($fields, CRM_Core_OptionValue::getFields('', $contactType)); |
1380 | } | |
1381 | ||
1382 | $locationFields = array_merge(CRM_Core_DAO_Address::import(), | |
1383 | CRM_Core_DAO_Phone::import(), | |
1384 | CRM_Core_DAO_Email::import(), | |
1385 | CRM_Core_DAO_IM::import(TRUE), | |
1386 | CRM_Core_DAO_OpenID::import() | |
1387 | ); | |
1388 | ||
1389 | $locationFields = array_merge($locationFields, | |
1390 | CRM_Core_BAO_CustomField::getFieldsForImport('Address', | |
1391 | FALSE, | |
1392 | FALSE, | |
1393 | FALSE, | |
1394 | FALSE | |
1395 | ) | |
1396 | ); | |
1397 | ||
1398 | foreach ($locationFields as $key => $field) { | |
1399 | $locationFields[$key]['hasLocationType'] = TRUE; | |
1400 | } | |
1401 | ||
1402 | $fields = array_merge($fields, $locationFields); | |
1403 | ||
1071730c DL |
1404 | $fields = array_merge($fields, CRM_Contact_DAO_Contact::import()); |
1405 | $fields = array_merge($fields, CRM_Core_DAO_Note::import()); | |
6a488035 TO |
1406 | |
1407 | //website fields | |
1408 | $fields = array_merge($fields, CRM_Core_DAO_Website::import()); | |
887e764d | 1409 | $fields['url']['hasWebsiteType'] = TRUE; |
6a488035 TO |
1410 | |
1411 | if ($contactType != 'All') { | |
1412 | $fields = array_merge($fields, | |
1413 | CRM_Core_BAO_CustomField::getFieldsForImport($contactType, | |
1414 | $showAll, | |
1415 | TRUE, | |
1416 | FALSE, | |
1417 | FALSE, | |
1418 | $withMultiCustomFields | |
1419 | ) | |
1420 | ); | |
b383d043 CW |
1421 | // Unset the fields which are not related to their contact type. |
1422 | foreach (CRM_Contact_DAO_Contact::import() as $name => $value) { | |
1423 | if (!empty($value['contactType']) && $value['contactType'] !== $contactType) { | |
1424 | unset($fields[$name]); | |
1425 | } | |
6a488035 TO |
1426 | } |
1427 | } | |
1428 | else { | |
b383d043 | 1429 | foreach (CRM_Contact_BAO_ContactType::basicTypes() as $type) { |
6a488035 TO |
1430 | $fields = array_merge($fields, |
1431 | CRM_Core_BAO_CustomField::getFieldsForImport($type, | |
1432 | $showAll, | |
1433 | FALSE, | |
1434 | FALSE, | |
1435 | FALSE, | |
1436 | $withMultiCustomFields | |
1437 | ) | |
1438 | ); | |
1439 | } | |
1440 | } | |
1441 | ||
1442 | if ($isProfile) { | |
f6b81482 | 1443 | $fields = array_merge($fields, [ |
1444 | 'group' => [ | |
8c77c68b KJ |
1445 | 'title' => ts('Group(s)'), |
1446 | 'name' => 'group', | |
f6b81482 | 1447 | ], |
1448 | 'tag' => [ | |
8c77c68b KJ |
1449 | 'title' => ts('Tag(s)'), |
1450 | 'name' => 'tag', | |
f6b81482 | 1451 | ], |
1452 | 'note' => [ | |
752a6732 | 1453 | 'title' => ts('Note'), |
8c77c68b | 1454 | 'name' => 'note', |
f6b81482 | 1455 | ], |
1456 | 'communication_style_id' => [ | |
d4dcd180 | 1457 | 'title' => ts('Communication Style'), |
1458 | 'name' => 'communication_style_id', | |
f6b81482 | 1459 | ], |
1460 | ]); | |
6a488035 TO |
1461 | } |
1462 | ||
1463 | //Sorting fields in alphabetical order(CRM-1507) | |
1464 | $fields = CRM_Utils_Array::crmArraySortByField($fields, 'title'); | |
1465 | ||
9cdf85c1 | 1466 | Civi::cache('fields')->set($cacheKeyString, $fields); |
6a488035 TO |
1467 | } |
1468 | ||
1469 | self::$_importableFields[$cacheKeyString] = $fields; | |
1470 | ||
1471 | if (!$isProfile) { | |
1472 | if (!$status) { | |
f6b81482 | 1473 | $fields = array_merge(['do_not_import' => ['title' => ts('- do not import -')]], |
6a488035 TO |
1474 | self::$_importableFields[$cacheKeyString] |
1475 | ); | |
1476 | } | |
1477 | else { | |
f6b81482 | 1478 | $fields = array_merge(['' => ['title' => ts('- Contact Fields -')]], |
6a488035 TO |
1479 | self::$_importableFields[$cacheKeyString] |
1480 | ); | |
1481 | } | |
1482 | } | |
1483 | return $fields; | |
1484 | } | |
1485 | ||
1486 | /** | |
0965e988 | 1487 | * Combine all the exportable fields from the lower levels object. |
6a488035 | 1488 | * |
0965e988 | 1489 | * Currently we are using importable fields as exportable fields |
6a488035 | 1490 | * |
8232cf2d | 1491 | * @param int|string $contactType contact Type |
77c5b619 TO |
1492 | * @param bool $status |
1493 | * True while exporting primary contacts. | |
1494 | * @param bool $export | |
1495 | * True when used during export. | |
1496 | * @param bool $search | |
1497 | * True when used during search, might conflict with export param?. | |
6a488035 | 1498 | * |
8232cf2d | 1499 | * @param bool $withMultiRecord |
69078420 | 1500 | * @param bool $checkPermissions |
f6b81482 | 1501 | * |
a6c01b45 CW |
1502 | * @return array |
1503 | * array of exportable Fields | |
6a488035 | 1504 | */ |
5837835b | 1505 | public static function &exportableFields($contactType = 'Individual', $status = FALSE, $export = FALSE, $search = FALSE, $withMultiRecord = FALSE, $checkPermissions = TRUE) { |
6a488035 TO |
1506 | if (empty($contactType)) { |
1507 | $contactType = 'All'; | |
1508 | } | |
1509 | ||
1510 | $cacheKeyString = "exportableFields $contactType"; | |
1511 | $cacheKeyString .= $export ? '_1' : '_0'; | |
1512 | $cacheKeyString .= $status ? '_1' : '_0'; | |
1513 | $cacheKeyString .= $search ? '_1' : '_0'; | |
df671bc5 | 1514 | $cacheKeyString .= '_' . (bool) $checkPermissions; |
bb341097 EM |
1515 | //CRM-14501 it turns out that the impact of permissioning here is sometimes inconsistent. The field that |
1516 | //calculates custom fields takes into account the logged in user & caches that for all users | |
1517 | //as an interim fix we will cache the fields by contact | |
1518 | $cacheKeyString .= '_' . CRM_Core_Session::getLoggedInContactID(); | |
6a488035 | 1519 | |
fdb6d23b | 1520 | if (!self::$_exportableFields || empty(self::$_exportableFields[$cacheKeyString])) { |
6a488035 | 1521 | if (!self::$_exportableFields) { |
f6b81482 | 1522 | self::$_exportableFields = []; |
6a488035 TO |
1523 | } |
1524 | ||
1525 | // check if we can retrieve from database cache | |
9cdf85c1 | 1526 | $fields = Civi::cache('fields')->get($cacheKeyString); |
6a488035 TO |
1527 | |
1528 | if (!$fields) { | |
6a488035 TO |
1529 | $fields = CRM_Contact_DAO_Contact::export(); |
1530 | ||
5c9ff055 | 1531 | // The fields are meant for contact types. |
f6b81482 | 1532 | if (in_array($contactType, [ |
5c9ff055 EM |
1533 | 'Individual', |
1534 | 'Household', | |
1535 | 'Organization', | |
1536 | 'All', | |
f6b81482 | 1537 | ])) { |
6a488035 TO |
1538 | $fields = array_merge($fields, CRM_Core_OptionValue::getFields('', $contactType)); |
1539 | } | |
1540 | // add current employer for individuals | |
f6b81482 | 1541 | $fields = array_merge($fields, [ |
6a488035 | 1542 | 'current_employer' => |
f6b81482 | 1543 | [ |
6a488035 TO |
1544 | 'name' => 'organization_name', |
1545 | 'title' => ts('Current Employer'), | |
e64435f1 | 1546 | 'type' => CRM_Utils_Type::T_STRING, |
f6b81482 | 1547 | ], |
1548 | ]); | |
6a488035 | 1549 | |
e64435f1 | 1550 | // This probably would be added anyway by appendPseudoConstantsToFields. |
f6b81482 | 1551 | $locationType = [ |
1552 | 'location_type' => [ | |
8c77c68b | 1553 | 'name' => 'location_type', |
6a488035 TO |
1554 | 'where' => 'civicrm_location_type.name', |
1555 | 'title' => ts('Location Type'), | |
e64435f1 | 1556 | 'type' => CRM_Utils_Type::T_STRING, |
f6b81482 | 1557 | ], |
1558 | ]; | |
6a488035 | 1559 | |
f6b81482 | 1560 | $IMProvider = [ |
1561 | 'im_provider' => [ | |
8c77c68b | 1562 | 'name' => 'im_provider', |
6a488035 TO |
1563 | 'where' => 'civicrm_im.provider_id', |
1564 | 'title' => ts('IM Provider'), | |
e64435f1 | 1565 | 'type' => CRM_Utils_Type::T_STRING, |
f6b81482 | 1566 | ], |
1567 | ]; | |
6a488035 | 1568 | |
0b23ab2b | 1569 | $phoneFields = CRM_Core_DAO_Phone::export(); |
1570 | // This adds phone_type to the exportable fields and make it available for export. | |
1571 | // with testing the same can be done to the other entities. | |
1572 | CRM_Core_DAO::appendPseudoConstantsToFields($phoneFields); | |
6a488035 TO |
1573 | $locationFields = array_merge($locationType, |
1574 | CRM_Core_DAO_Address::export(), | |
0b23ab2b | 1575 | $phoneFields, |
6a488035 TO |
1576 | CRM_Core_DAO_Email::export(), |
1577 | $IMProvider, | |
1578 | CRM_Core_DAO_IM::export(TRUE), | |
1579 | CRM_Core_DAO_OpenID::export() | |
1580 | ); | |
1581 | ||
1582 | $locationFields = array_merge($locationFields, | |
1583 | CRM_Core_BAO_CustomField::getFieldsForImport('Address') | |
1584 | ); | |
1585 | ||
1586 | foreach ($locationFields as $key => $field) { | |
1587 | $locationFields[$key]['hasLocationType'] = TRUE; | |
1588 | } | |
1589 | ||
1590 | $fields = array_merge($fields, $locationFields); | |
1591 | ||
1592 | //add world region | |
1593 | $fields = array_merge($fields, | |
1594 | CRM_Core_DAO_Worldregion::export() | |
1595 | ); | |
1596 | ||
6a488035 TO |
1597 | $fields = array_merge($fields, |
1598 | CRM_Contact_DAO_Contact::export() | |
1599 | ); | |
1600 | ||
1601 | //website fields | |
1602 | $fields = array_merge($fields, CRM_Core_DAO_Website::export()); | |
1603 | ||
1604 | if ($contactType != 'All') { | |
1605 | $fields = array_merge($fields, | |
5837835b | 1606 | CRM_Core_BAO_CustomField::getFieldsForImport($contactType, $status, FALSE, $search, $checkPermissions, $withMultiRecord) |
6a488035 TO |
1607 | ); |
1608 | } | |
1609 | else { | |
b383d043 | 1610 | foreach (CRM_Contact_BAO_ContactType::basicTypes() as $type) { |
6a488035 | 1611 | $fields = array_merge($fields, |
5837835b | 1612 | CRM_Core_BAO_CustomField::getFieldsForImport($type, FALSE, FALSE, $search, $checkPermissions, $withMultiRecord) |
6a488035 TO |
1613 | ); |
1614 | } | |
1615 | } | |
6a488035 TO |
1616 | //fix for CRM-791 |
1617 | if ($export) { | |
f6b81482 | 1618 | $fields = array_merge($fields, [ |
1619 | 'groups' => [ | |
8c77c68b KJ |
1620 | 'title' => ts('Group(s)'), |
1621 | 'name' => 'groups', | |
f6b81482 | 1622 | ], |
1623 | 'tags' => [ | |
8c77c68b KJ |
1624 | 'title' => ts('Tag(s)'), |
1625 | 'name' => 'tags', | |
f6b81482 | 1626 | ], |
1627 | 'notes' => [ | |
8c77c68b KJ |
1628 | 'title' => ts('Note(s)'), |
1629 | 'name' => 'notes', | |
f6b81482 | 1630 | ], |
1631 | ]); | |
6a488035 TO |
1632 | } |
1633 | else { | |
f6b81482 | 1634 | $fields = array_merge($fields, [ |
1635 | 'group' => [ | |
8c77c68b KJ |
1636 | 'title' => ts('Group(s)'), |
1637 | 'name' => 'group', | |
f6b81482 | 1638 | ], |
1639 | 'tag' => [ | |
8c77c68b KJ |
1640 | 'title' => ts('Tag(s)'), |
1641 | 'name' => 'tag', | |
f6b81482 | 1642 | ], |
1643 | 'note' => [ | |
8c77c68b KJ |
1644 | 'title' => ts('Note(s)'), |
1645 | 'name' => 'note', | |
f6b81482 | 1646 | ], |
1647 | ]); | |
6a488035 TO |
1648 | } |
1649 | ||
1650 | //Sorting fields in alphabetical order(CRM-1507) | |
1651 | foreach ($fields as $k => $v) { | |
f748c073 | 1652 | $sortArray[$k] = $v['title'] ?? NULL; |
6a488035 TO |
1653 | } |
1654 | ||
1655 | $fields = array_merge($sortArray, $fields); | |
1656 | //unset the field which are not related to their contact type. | |
1657 | if ($contactType != 'All') { | |
f6b81482 | 1658 | $commonValues = [ |
1659 | 'Individual' => [ | |
8c77c68b KJ |
1660 | 'household_name', |
1661 | 'legal_name', | |
1662 | 'sic_code', | |
1663 | 'organization_name', | |
1664 | 'email_greeting_custom', | |
1665 | 'postal_greeting_custom', | |
6a488035 | 1666 | 'addressee_custom', |
f6b81482 | 1667 | ], |
1668 | 'Household' => [ | |
8c77c68b KJ |
1669 | 'first_name', |
1670 | 'middle_name', | |
1671 | 'last_name', | |
e171748b | 1672 | 'formal_title', |
8c77c68b | 1673 | 'job_title', |
04ffef8d CW |
1674 | 'gender_id', |
1675 | 'prefix_id', | |
1676 | 'suffix_id', | |
8c77c68b KJ |
1677 | 'birth_date', |
1678 | 'organization_name', | |
1679 | 'legal_name', | |
1680 | 'legal_identifier', | |
1681 | 'sic_code', | |
1682 | 'home_URL', | |
1683 | 'is_deceased', | |
1684 | 'deceased_date', | |
1685 | 'current_employer', | |
1686 | 'email_greeting_custom', | |
1687 | 'postal_greeting_custom', | |
1688 | 'addressee_custom', | |
1689 | 'prefix_id', | |
21dfd5f5 | 1690 | 'suffix_id', |
f6b81482 | 1691 | ], |
1692 | 'Organization' => [ | |
8c77c68b KJ |
1693 | 'first_name', |
1694 | 'middle_name', | |
1695 | 'last_name', | |
e171748b | 1696 | 'formal_title', |
8c77c68b | 1697 | 'job_title', |
04ffef8d CW |
1698 | 'gender_id', |
1699 | 'prefix_id', | |
1700 | 'suffix_id', | |
8c77c68b KJ |
1701 | 'birth_date', |
1702 | 'household_name', | |
6a488035 | 1703 | 'email_greeting_custom', |
8c77c68b KJ |
1704 | 'postal_greeting_custom', |
1705 | 'prefix_id', | |
1706 | 'suffix_id', | |
1707 | 'gender_id', | |
1708 | 'addressee_custom', | |
1709 | 'is_deceased', | |
1710 | 'deceased_date', | |
1711 | 'current_employer', | |
f6b81482 | 1712 | ], |
1713 | ]; | |
6a488035 TO |
1714 | foreach ($commonValues[$contactType] as $value) { |
1715 | unset($fields[$value]); | |
1716 | } | |
1717 | } | |
1718 | ||
9cdf85c1 | 1719 | Civi::cache('fields')->set($cacheKeyString, $fields); |
6a488035 TO |
1720 | } |
1721 | self::$_exportableFields[$cacheKeyString] = $fields; | |
1722 | } | |
1723 | ||
1724 | if (!$status) { | |
1725 | $fields = self::$_exportableFields[$cacheKeyString]; | |
1726 | } | |
1727 | else { | |
f6b81482 | 1728 | $fields = array_merge(['' => ['title' => ts('- Contact Fields -')]], |
6a488035 TO |
1729 | self::$_exportableFields[$cacheKeyString] |
1730 | ); | |
1731 | } | |
1732 | ||
1733 | return $fields; | |
1734 | } | |
1735 | ||
1736 | /** | |
0965e988 | 1737 | * Get the all contact details (Hierarchical). |
6a488035 | 1738 | * |
77c5b619 TO |
1739 | * @param int $contactId |
1740 | * Contact id. | |
1741 | * @param array $fields | |
1742 | * Fields array. | |
6a488035 | 1743 | * |
0965e988 EM |
1744 | * @return array |
1745 | * Contact details | |
6a488035 | 1746 | */ |
098b1bb3 | 1747 | public static function getHierContactDetails($contactId, $fields) { |
f6b81482 | 1748 | $params = [['contact_id', '=', $contactId, 0, 0]]; |
6a488035 TO |
1749 | |
1750 | $returnProperties = self::makeHierReturnProperties($fields, $contactId); | |
1751 | ||
5c9ff055 EM |
1752 | // We don't know the contents of return properties, but we need the lower |
1753 | // level ids of the contact so add a few fields. | |
6c552737 TO |
1754 | $returnProperties['first_name'] = 1; |
1755 | $returnProperties['organization_name'] = 1; | |
1756 | $returnProperties['household_name'] = 1; | |
1757 | $returnProperties['contact_type'] = 1; | |
9bb77b8e | 1758 | $returnProperties['contact_sub_type'] = 1; |
00bb741c | 1759 | list($query) = CRM_Contact_BAO_Query::apiQuery($params, $returnProperties); |
1760 | return $query; | |
6a488035 TO |
1761 | } |
1762 | ||
1763 | /** | |
db7de9c1 EM |
1764 | * Given a set of flat profile style field names, create a hierarchy. |
1765 | * | |
1766 | * This is for the query to use, create the right sql. | |
6a488035 | 1767 | * |
8232cf2d | 1768 | * @param $fields |
77c5b619 TO |
1769 | * @param int $contactId |
1770 | * Contact id. | |
6a488035 | 1771 | * |
a6c01b45 | 1772 | * @return array |
db7de9c1 | 1773 | * A hierarchical property tree if appropriate |
6a488035 | 1774 | */ |
00be9182 | 1775 | public static function &makeHierReturnProperties($fields, $contactId = NULL) { |
4961a325 | 1776 | $locationTypes = CRM_Core_BAO_Address::buildOptions('location_type_id', 'validate'); |
6a488035 | 1777 | |
f6b81482 | 1778 | $returnProperties = []; |
6a488035 | 1779 | |
f6b81482 | 1780 | $multipleFields = ['website' => 'url']; |
6a488035 TO |
1781 | foreach ($fields as $name => $dontCare) { |
1782 | if (strpos($name, '-') !== FALSE) { | |
1783 | list($fieldName, $id, $type) = CRM_Utils_System::explode('-', $name, 3); | |
1784 | ||
1785 | if (!in_array($fieldName, $multipleFields)) { | |
1786 | if ($id == 'Primary') { | |
1787 | $locationTypeName = 1; | |
1788 | } | |
1789 | else { | |
f748c073 | 1790 | $locationTypeName = $locationTypes[$id] ?? NULL; |
6a488035 TO |
1791 | if (!$locationTypeName) { |
1792 | continue; | |
1793 | } | |
1794 | } | |
1795 | ||
a7488080 | 1796 | if (empty($returnProperties['location'])) { |
f6b81482 | 1797 | $returnProperties['location'] = []; |
6a488035 | 1798 | } |
a7488080 | 1799 | if (empty($returnProperties['location'][$locationTypeName])) { |
f6b81482 | 1800 | $returnProperties['location'][$locationTypeName] = []; |
6a488035 TO |
1801 | $returnProperties['location'][$locationTypeName]['location_type'] = $id; |
1802 | } | |
f6b81482 | 1803 | if (in_array($fieldName, [ |
9bb77b8e TO |
1804 | 'phone', |
1805 | 'im', | |
1806 | 'email', | |
1807 | 'openid', | |
21dfd5f5 | 1808 | 'phone_ext', |
f6b81482 | 1809 | ])) { |
6a488035 TO |
1810 | if ($type) { |
1811 | $returnProperties['location'][$locationTypeName][$fieldName . '-' . $type] = 1; | |
1812 | } | |
1813 | else { | |
1814 | $returnProperties['location'][$locationTypeName][$fieldName] = 1; | |
1815 | } | |
1816 | } | |
1817 | elseif (substr($fieldName, 0, 14) === 'address_custom') { | |
1818 | $returnProperties['location'][$locationTypeName][substr($fieldName, 8)] = 1; | |
1819 | } | |
1820 | else { | |
1821 | $returnProperties['location'][$locationTypeName][$fieldName] = 1; | |
1822 | } | |
1823 | } | |
1824 | else { | |
1825 | $returnProperties['website'][$id][$fieldName] = 1; | |
1826 | } | |
1827 | } | |
1828 | else { | |
1829 | $returnProperties[$name] = 1; | |
1830 | } | |
1831 | } | |
1832 | ||
1833 | return $returnProperties; | |
1834 | } | |
1835 | ||
1836 | /** | |
57507ae6 | 1837 | * Return the primary location type of a contact. |
6a488035 TO |
1838 | * |
1839 | * $params int $contactId contact_id | |
1840 | * $params boolean $isPrimaryExist if true, return primary contact location type otherwise null | |
1841 | * $params boolean $skipDefaultPriamry if true, return primary contact location type otherwise null | |
1842 | * | |
100fef9d | 1843 | * @param int $contactId |
8232cf2d E |
1844 | * @param bool $skipDefaultPriamry |
1845 | * @param null $block | |
1846 | * | |
a6c01b45 CW |
1847 | * @return int |
1848 | * $locationType location_type_id | |
6a488035 | 1849 | */ |
00be9182 | 1850 | public static function getPrimaryLocationType($contactId, $skipDefaultPriamry = FALSE, $block = NULL) { |
9bb77b8e | 1851 | if ($block) { |
f6b81482 | 1852 | $entityBlock = ['contact_id' => $contactId]; |
9bb77b8e TO |
1853 | $blocks = CRM_Core_BAO_Location::getValues($entityBlock); |
1854 | foreach ($blocks[$block] as $key => $value) { | |
1855 | if (!empty($value['is_primary'])) { | |
f748c073 | 1856 | $locationType = $value['location_type_id'] ?? NULL; |
6a488035 TO |
1857 | } |
1858 | } | |
1859 | } | |
1860 | else { | |
1861 | $query = " | |
1862 | SELECT | |
1863 | IF ( civicrm_email.location_type_id IS NULL, | |
1864 | IF ( civicrm_address.location_type_id IS NULL, | |
1865 | IF ( civicrm_phone.location_type_id IS NULL, | |
1866 | IF ( civicrm_im.location_type_id IS NULL, | |
1867 | IF ( civicrm_openid.location_type_id IS NULL, null, civicrm_openid.location_type_id) | |
1868 | ,civicrm_im.location_type_id) | |
1869 | ,civicrm_phone.location_type_id) | |
1870 | ,civicrm_address.location_type_id) | |
1871 | ,civicrm_email.location_type_id) as locationType | |
1872 | FROM civicrm_contact | |
1873 | LEFT JOIN civicrm_email ON ( civicrm_email.is_primary = 1 AND civicrm_email.contact_id = civicrm_contact.id ) | |
1874 | LEFT JOIN civicrm_address ON ( civicrm_address.is_primary = 1 AND civicrm_address.contact_id = civicrm_contact.id) | |
1875 | LEFT JOIN civicrm_phone ON ( civicrm_phone.is_primary = 1 AND civicrm_phone.contact_id = civicrm_contact.id) | |
1876 | LEFT JOIN civicrm_im ON ( civicrm_im.is_primary = 1 AND civicrm_im.contact_id = civicrm_contact.id) | |
1877 | LEFT JOIN civicrm_openid ON ( civicrm_openid.is_primary = 1 AND civicrm_openid.contact_id = civicrm_contact.id) | |
1878 | WHERE civicrm_contact.id = %1 "; | |
1879 | ||
f6b81482 | 1880 | $params = [1 => [$contactId, 'Integer']]; |
6a488035 TO |
1881 | |
1882 | $dao = CRM_Core_DAO::executeQuery($query, $params); | |
1883 | ||
1884 | $locationType = NULL; | |
1885 | if ($dao->fetch()) { | |
1886 | $locationType = $dao->locationType; | |
1887 | } | |
1888 | } | |
1889 | if (isset($locationType)) { | |
1890 | return $locationType; | |
1891 | } | |
1892 | elseif ($skipDefaultPriamry) { | |
1893 | // if there is no primary contact location then return null | |
1894 | return NULL; | |
1895 | } | |
1896 | else { | |
1897 | // if there is no primart contact location, then return default | |
1898 | // location type of the system | |
1899 | $defaultLocationType = CRM_Core_BAO_LocationType::getDefault(); | |
1900 | return $defaultLocationType->id; | |
1901 | } | |
1902 | } | |
1903 | ||
1904 | /** | |
57507ae6 | 1905 | * Get the display name, primary email and location type of a contact. |
6a488035 | 1906 | * |
77c5b619 TO |
1907 | * @param int $id |
1908 | * Id of the contact. | |
6a488035 | 1909 | * |
a6c01b45 | 1910 | * @return array |
16b10e64 | 1911 | * Array of display_name, email if found, do_not_email or (null,null,null) |
6a488035 | 1912 | */ |
00be9182 | 1913 | public static function getContactDetails($id) { |
6a488035 TO |
1914 | // check if the contact type |
1915 | $contactType = self::getContactType($id); | |
1916 | ||
1917 | $nameFields = ($contactType == 'Individual') ? "civicrm_contact.first_name, civicrm_contact.last_name, civicrm_contact.display_name" : "civicrm_contact.display_name"; | |
1918 | ||
1919 | $sql = " | |
1920 | SELECT $nameFields, civicrm_email.email, civicrm_contact.do_not_email, civicrm_email.on_hold, civicrm_contact.is_deceased | |
1921 | FROM civicrm_contact LEFT JOIN civicrm_email ON (civicrm_contact.id = civicrm_email.contact_id) | |
1922 | WHERE civicrm_contact.id = %1 | |
1923 | ORDER BY civicrm_email.is_primary DESC"; | |
f6b81482 | 1924 | $params = [1 => [$id, 'Integer']]; |
6a488035 TO |
1925 | $dao = CRM_Core_DAO::executeQuery($sql, $params); |
1926 | ||
1927 | if ($dao->fetch()) { | |
1928 | if ($contactType == 'Individual') { | |
1929 | if ($dao->first_name || $dao->last_name) { | |
1930 | $name = "{$dao->first_name} {$dao->last_name}"; | |
1931 | } | |
1932 | else { | |
1933 | $name = $dao->display_name; | |
1934 | } | |
1935 | } | |
1936 | else { | |
1937 | $name = $dao->display_name; | |
1938 | } | |
9bb77b8e | 1939 | $email = $dao->email; |
dc0aa487 CW |
1940 | $doNotEmail = (bool) $dao->do_not_email; |
1941 | $onHold = (bool) $dao->on_hold; | |
1942 | $isDeceased = (bool) $dao->is_deceased; | |
f6b81482 | 1943 | return [$name, $email, $doNotEmail, $onHold, $isDeceased]; |
6a488035 | 1944 | } |
f6b81482 | 1945 | return [NULL, NULL, NULL, NULL, NULL]; |
6a488035 TO |
1946 | } |
1947 | ||
1948 | /** | |
100fef9d | 1949 | * Add/edit/register contacts through profile. |
6a488035 | 1950 | * |
77c5b619 TO |
1951 | * @param array $params |
1952 | * Array of profile fields to be edited/added. | |
1953 | * @param array $fields | |
1954 | * Array of fields from UFGroup. | |
1955 | * @param int $contactID | |
1956 | * Id of the contact to be edited/added. | |
1957 | * @param int $addToGroupID | |
1958 | * Specifies the default group to which contact is added. | |
1959 | * @param int $ufGroupId | |
1960 | * Uf group id (profile id). | |
57507ae6 | 1961 | * @param string $ctype |
77c5b619 TO |
1962 | * @param bool $visibility |
1963 | * Basically lets us know where this request is coming from. | |
6a488035 TO |
1964 | * if via a profile from web, we restrict what groups are changed |
1965 | * | |
a6c01b45 CW |
1966 | * @return int |
1967 | * contact id created/edited | |
59b317a3 | 1968 | * |
1969 | * @throws \CRM_Core_Exception | |
1970 | * @throws \CiviCRM_API3_Exception | |
1971 | * @throws \Civi\API\Exception\UnauthorizedException | |
6a488035 | 1972 | */ |
57507ae6 | 1973 | public static function createProfileContact( |
6a488035 | 1974 | &$params, |
59b317a3 | 1975 | $fields = [], |
6a488035 TO |
1976 | $contactID = NULL, |
1977 | $addToGroupID = NULL, | |
1978 | $ufGroupId = NULL, | |
9bb77b8e TO |
1979 | $ctype = NULL, |
1980 | $visibility = FALSE | |
6a488035 TO |
1981 | ) { |
1982 | // add ufGroupID to params array ( CRM-2012 ) | |
1983 | if ($ufGroupId) { | |
1984 | $params['uf_group_id'] = $ufGroupId; | |
1985 | } | |
870156d6 | 1986 | self::addBillingNameFieldsIfOtherwiseNotSet($params); |
6a488035 | 1987 | |
85c882c5 | 1988 | // If a user has logged in, or accessed via a checksum |
1989 | // Then deliberately 'blanking' a value in the profile should remove it from their record | |
1990 | $session = CRM_Core_Session::singleton(); | |
1991 | $params['updateBlankLocInfo'] = TRUE; | |
1992 | if (($session->get('authSrc') & (CRM_Core_Permission::AUTH_SRC_CHECKSUM + CRM_Core_Permission::AUTH_SRC_LOGIN)) == 0) { | |
1993 | $params['updateBlankLocInfo'] = FALSE; | |
1994 | } | |
1995 | ||
6a488035 TO |
1996 | if ($contactID) { |
1997 | $editHook = TRUE; | |
1998 | CRM_Utils_Hook::pre('edit', 'Profile', $contactID, $params); | |
1999 | } | |
2000 | else { | |
2001 | $editHook = FALSE; | |
2002 | CRM_Utils_Hook::pre('create', 'Profile', NULL, $params); | |
2003 | } | |
2004 | ||
2005 | list($data, $contactDetails) = self::formatProfileContactParams($params, $fields, $contactID, $ufGroupId, $ctype); | |
2006 | ||
2007 | // manage is_opt_out | |
2008 | if (array_key_exists('is_opt_out', $fields) && array_key_exists('is_opt_out', $params)) { | |
fdb6d23b CW |
2009 | $wasOptOut = $contactDetails['is_opt_out'] ?? FALSE; |
2010 | $isOptOut = $params['is_opt_out']; | |
6a488035 TO |
2011 | $data['is_opt_out'] = $isOptOut; |
2012 | // on change, create new civicrm_subscription_history entry | |
8cc574cf | 2013 | if (($wasOptOut != $isOptOut) && !empty($contactDetails['contact_id'])) { |
f6b81482 | 2014 | $shParams = [ |
6a488035 TO |
2015 | 'contact_id' => $contactDetails['contact_id'], |
2016 | 'status' => $isOptOut ? 'Removed' : 'Added', | |
2017 | 'method' => 'Web', | |
f6b81482 | 2018 | ]; |
6a488035 TO |
2019 | CRM_Contact_BAO_SubscriptionHistory::create($shParams); |
2020 | } | |
2021 | } | |
2022 | ||
2023 | $contact = self::create($data); | |
2024 | ||
2025 | // contact is null if the profile does not have any contact fields | |
2026 | if ($contact) { | |
2027 | $contactID = $contact->id; | |
2028 | } | |
2029 | ||
2030 | if (empty($contactID)) { | |
2d296f18 | 2031 | throw new CRM_Core_Exception('Cannot proceed without a valid contact id'); |
6a488035 TO |
2032 | } |
2033 | ||
2034 | // Process group and tag | |
f329c0ca | 2035 | if (isset($params['group'])) { |
6a488035 TO |
2036 | $method = 'Admin'; |
2037 | // this for sure means we are coming in via profile since i added it to fix | |
2038 | // removing contacts from user groups -- lobo | |
2039 | if ($visibility) { | |
2040 | $method = 'Web'; | |
2041 | } | |
2042 | CRM_Contact_BAO_GroupContact::create($params['group'], $contactID, $visibility, $method); | |
2043 | } | |
2044 | ||
88be9dc2 CW |
2045 | if (!empty($fields['tag']) && array_key_exists('tag', $params)) { |
2046 | // Convert comma separated form values from select2 v3 | |
2047 | $tags = is_array($params['tag']) ? $params['tag'] : array_fill_keys(array_filter(explode(',', $params['tag'])), 1); | |
2048 | CRM_Core_BAO_EntityTag::create($tags, 'civicrm_contact', $contactID); | |
6a488035 TO |
2049 | } |
2050 | ||
2051 | //to add profile in default group | |
2052 | if (is_array($addToGroupID)) { | |
f6b81482 | 2053 | $contactIds = [$contactID]; |
6a488035 TO |
2054 | foreach ($addToGroupID as $groupId) { |
2055 | CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $groupId); | |
2056 | } | |
2057 | } | |
2058 | elseif ($addToGroupID) { | |
f6b81482 | 2059 | $contactIds = [$contactID]; |
6a488035 TO |
2060 | CRM_Contact_BAO_GroupContact::addContactsToGroup($contactIds, $addToGroupID); |
2061 | } | |
2062 | ||
6a488035 TO |
2063 | if ($editHook) { |
2064 | CRM_Utils_Hook::post('edit', 'Profile', $contactID, $params); | |
2065 | } | |
2066 | else { | |
2067 | CRM_Utils_Hook::post('create', 'Profile', $contactID, $params); | |
2068 | } | |
2069 | return $contactID; | |
2070 | } | |
2071 | ||
86538308 | 2072 | /** |
57507ae6 EM |
2073 | * Format profile contact parameters. |
2074 | * | |
c490a46a | 2075 | * @param array $params |
86538308 | 2076 | * @param $fields |
100fef9d CW |
2077 | * @param int $contactID |
2078 | * @param int $ufGroupId | |
86538308 EM |
2079 | * @param null $ctype |
2080 | * @param bool $skipCustom | |
2081 | * | |
2082 | * @return array | |
2083 | */ | |
57507ae6 | 2084 | public static function formatProfileContactParams( |
6a488035 | 2085 | &$params, |
098b1bb3 | 2086 | $fields, |
6a488035 TO |
2087 | $contactID = NULL, |
2088 | $ufGroupId = NULL, | |
2089 | $ctype = NULL, | |
2090 | $skipCustom = FALSE | |
2091 | ) { | |
2092 | ||
f6b81482 | 2093 | $data = $contactDetails = []; |
6a488035 TO |
2094 | |
2095 | // get the contact details (hier) | |
2096 | if ($contactID) { | |
00bb741c | 2097 | $details = self::getHierContactDetails($contactID, $fields); |
6a488035 TO |
2098 | |
2099 | $contactDetails = $details[$contactID]; | |
f748c073 | 2100 | $data['contact_type'] = $contactDetails['contact_type'] ?? NULL; |
2101 | $data['contact_sub_type'] = $contactDetails['contact_sub_type'] ?? NULL; | |
6a488035 TO |
2102 | } |
2103 | else { | |
2104 | //we should get contact type only if contact | |
2105 | if ($ufGroupId) { | |
2106 | $data['contact_type'] = CRM_Core_BAO_UFField::getProfileType($ufGroupId); | |
2107 | ||
2108 | //special case to handle profile with only contact fields | |
2109 | if ($data['contact_type'] == 'Contact') { | |
2110 | $data['contact_type'] = 'Individual'; | |
2111 | } | |
2112 | elseif (CRM_Contact_BAO_ContactType::isaSubType($data['contact_type'])) { | |
2113 | $data['contact_type'] = CRM_Contact_BAO_ContactType::getBasicType($data['contact_type']); | |
2114 | } | |
2115 | } | |
2116 | elseif ($ctype) { | |
2117 | $data['contact_type'] = $ctype; | |
2118 | } | |
2119 | else { | |
2120 | $data['contact_type'] = 'Individual'; | |
2121 | } | |
2122 | } | |
2123 | ||
2124 | //fix contact sub type CRM-5125 | |
2125 | if (array_key_exists('contact_sub_type', $params) && | |
2126 | !empty($params['contact_sub_type']) | |
2127 | ) { | |
f2181617 | 2128 | $data['contact_sub_type'] = CRM_Utils_Array::implodePadded($params['contact_sub_type']); |
6a488035 TO |
2129 | } |
2130 | elseif (array_key_exists('contact_sub_type_hidden', $params) && | |
2131 | !empty($params['contact_sub_type_hidden']) | |
2132 | ) { | |
2133 | // if profile was used, and had any subtype, we obtain it from there | |
aa7a7a14 | 2134 | //CRM-13596 - add to existing contact types, rather than overwriting |
fec7a2da MWMC |
2135 | if (empty($data['contact_sub_type'])) { |
2136 | // If we don't have a contact ID the $data['contact_sub_type'] will not be defined... | |
2137 | $data['contact_sub_type'] = CRM_Utils_Array::implodePadded($params['contact_sub_type_hidden']); | |
2138 | } | |
2139 | else { | |
2140 | $data_contact_sub_type_arr = CRM_Utils_Array::explodePadded($data['contact_sub_type']); | |
2141 | if (!in_array($params['contact_sub_type_hidden'], $data_contact_sub_type_arr)) { | |
2142 | //CRM-20517 - make sure contact_sub_type gets the correct delimiters | |
2143 | $data['contact_sub_type'] = trim($data['contact_sub_type'], CRM_Core_DAO::VALUE_SEPARATOR); | |
2144 | $data['contact_sub_type'] = CRM_Core_DAO::VALUE_SEPARATOR . $data['contact_sub_type'] . CRM_Utils_Array::implodePadded($params['contact_sub_type_hidden']); | |
2145 | } | |
aa7a7a14 | 2146 | } |
6a488035 TO |
2147 | } |
2148 | ||
2149 | if ($ctype == 'Organization') { | |
f748c073 | 2150 | $data['organization_name'] = $contactDetails['organization_name'] ?? NULL; |
6a488035 TO |
2151 | } |
2152 | elseif ($ctype == 'Household') { | |
f748c073 | 2153 | $data['household_name'] = $contactDetails['household_name'] ?? NULL; |
6a488035 TO |
2154 | } |
2155 | ||
f6b81482 | 2156 | $locationType = []; |
6a488035 TO |
2157 | $count = 1; |
2158 | ||
2159 | if ($contactID) { | |
2160 | //add contact id | |
2161 | $data['contact_id'] = $contactID; | |
2162 | $primaryLocationType = self::getPrimaryLocationType($contactID); | |
2163 | } | |
2164 | else { | |
2165 | $defaultLocation = CRM_Core_BAO_LocationType::getDefault(); | |
2166 | $defaultLocationId = $defaultLocation->id; | |
2167 | } | |
2168 | ||
b576d770 | 2169 | $billingLocationTypeId = CRM_Core_BAO_LocationType::getBilling(); |
6a488035 | 2170 | |
f6b81482 | 2171 | $blocks = ['email', 'phone', 'im', 'openid']; |
6a488035 | 2172 | |
f6b81482 | 2173 | $multiplFields = ['url']; |
6a488035 TO |
2174 | // prevent overwritten of formatted array, reset all block from |
2175 | // params if it is not in valid format (since import pass valid format) | |
2176 | foreach ($blocks as $blk) { | |
2177 | if (array_key_exists($blk, $params) && | |
2178 | !is_array($params[$blk]) | |
2179 | ) { | |
2180 | unset($params[$blk]); | |
2181 | } | |
2182 | } | |
2183 | ||
2184 | $primaryPhoneLoc = NULL; | |
ece0bc24 | 2185 | $session = CRM_Core_Session::singleton(); |
6a488035 | 2186 | foreach ($params as $key => $value) { |
6a488035 TO |
2187 | list($fieldName, $locTypeId, $typeId) = CRM_Utils_System::explode('-', $key, 3); |
2188 | ||
6a488035 TO |
2189 | if ($locTypeId == 'Primary') { |
2190 | if ($contactID) { | |
9bb77b8e | 2191 | if (in_array($fieldName, $blocks)) { |
6a488035 TO |
2192 | $locTypeId = self::getPrimaryLocationType($contactID, FALSE, $fieldName); |
2193 | } | |
9bb77b8e | 2194 | else { |
6a488035 TO |
2195 | $locTypeId = self::getPrimaryLocationType($contactID, FALSE, 'address'); |
2196 | } | |
2197 | $primaryLocationType = $locTypeId; | |
2198 | } | |
2199 | else { | |
2200 | $locTypeId = $defaultLocationId; | |
2201 | } | |
2202 | } | |
2203 | ||
2204 | if (is_numeric($locTypeId) && | |
2205 | !in_array($fieldName, $multiplFields) && | |
2206 | substr($fieldName, 0, 7) != 'custom_' | |
2207 | ) { | |
2208 | $index = $locTypeId; | |
2209 | ||
2210 | if (is_numeric($typeId)) { | |
2211 | $index .= '-' . $typeId; | |
2212 | } | |
2213 | if (!in_array($index, $locationType)) { | |
2214 | $locationType[$count] = $index; | |
2215 | $count++; | |
2216 | } | |
2217 | ||
2218 | $loc = CRM_Utils_Array::key($index, $locationType); | |
2219 | ||
b795cfc3 | 2220 | $blockName = self::getLocationEntityForKey($fieldName); |
6a488035 TO |
2221 | |
2222 | $data[$blockName][$loc]['location_type_id'] = $locTypeId; | |
2223 | ||
2224 | //set is_billing true, for location type "Billing" | |
2225 | if ($locTypeId == $billingLocationTypeId) { | |
2226 | $data[$blockName][$loc]['is_billing'] = 1; | |
2227 | } | |
2228 | ||
2229 | if ($contactID) { | |
2230 | //get the primary location type | |
2231 | if ($locTypeId == $primaryLocationType) { | |
2232 | $data[$blockName][$loc]['is_primary'] = 1; | |
2233 | } | |
2234 | } | |
2235 | elseif ($locTypeId == $defaultLocationId) { | |
2236 | $data[$blockName][$loc]['is_primary'] = 1; | |
2237 | } | |
2238 | ||
f6b81482 | 2239 | if (in_array($fieldName, ['phone'])) { |
6a488035 TO |
2240 | if ($typeId) { |
2241 | $data['phone'][$loc]['phone_type_id'] = $typeId; | |
2242 | } | |
2243 | else { | |
2244 | $data['phone'][$loc]['phone_type_id'] = ''; | |
2245 | } | |
2246 | $data['phone'][$loc]['phone'] = $value; | |
2247 | ||
2248 | //special case to handle primary phone with different phone types | |
2249 | // in this case we make first phone type as primary | |
2250 | if (isset($data['phone'][$loc]['is_primary']) && !$primaryPhoneLoc) { | |
2251 | $primaryPhoneLoc = $loc; | |
2252 | } | |
2253 | ||
2254 | if ($loc != $primaryPhoneLoc) { | |
2255 | unset($data['phone'][$loc]['is_primary']); | |
2256 | } | |
2257 | } | |
6a488035 TO |
2258 | elseif ($fieldName == 'email') { |
2259 | $data['email'][$loc]['email'] = $value; | |
0c043d46 | 2260 | if (empty($contactID)) { |
2261 | $data['email'][$loc]['is_primary'] = 1; | |
2262 | } | |
6a488035 TO |
2263 | } |
2264 | elseif ($fieldName == 'im') { | |
2265 | if (isset($params[$key . '-provider_id'])) { | |
2266 | $data['im'][$loc]['provider_id'] = $params[$key . '-provider_id']; | |
2267 | } | |
2268 | if (strpos($key, '-provider_id') !== FALSE) { | |
2269 | $data['im'][$loc]['provider_id'] = $params[$key]; | |
2270 | } | |
2271 | else { | |
2272 | $data['im'][$loc]['name'] = $value; | |
2273 | } | |
2274 | } | |
2275 | elseif ($fieldName == 'openid') { | |
2276 | $data['openid'][$loc]['openid'] = $value; | |
2277 | } | |
2278 | else { | |
2279 | if ($fieldName === 'state_province') { | |
2280 | // CRM-3393 | |
2281 | if (is_numeric($value) && ((int ) $value) >= 1000) { | |
2282 | $data['address'][$loc]['state_province_id'] = $value; | |
2283 | } | |
2284 | elseif (empty($value)) { | |
2285 | $data['address'][$loc]['state_province_id'] = ''; | |
2286 | } | |
2287 | else { | |
2288 | $data['address'][$loc]['state_province'] = $value; | |
2289 | } | |
2290 | } | |
2291 | elseif ($fieldName === 'country') { | |
2292 | // CRM-3393 | |
2293 | if (is_numeric($value) && ((int ) $value) >= 1000 | |
2294 | ) { | |
2295 | $data['address'][$loc]['country_id'] = $value; | |
2296 | } | |
2297 | elseif (empty($value)) { | |
2298 | $data['address'][$loc]['country_id'] = ''; | |
2299 | } | |
2300 | else { | |
2301 | $data['address'][$loc]['country'] = $value; | |
2302 | } | |
2303 | } | |
2304 | elseif ($fieldName === 'county') { | |
2305 | $data['address'][$loc]['county_id'] = $value; | |
2306 | } | |
2307 | elseif ($fieldName == 'address_name') { | |
2308 | $data['address'][$loc]['name'] = $value; | |
2309 | } | |
2310 | elseif (substr($fieldName, 0, 14) === 'address_custom') { | |
2311 | $data['address'][$loc][substr($fieldName, 8)] = $value; | |
2312 | } | |
2313 | else { | |
b795cfc3 | 2314 | $data[$blockName][$loc][$fieldName] = $value; |
6a488035 TO |
2315 | } |
2316 | } | |
2317 | } | |
2318 | else { | |
2319 | if (substr($key, 0, 4) === 'url-') { | |
2320 | $websiteField = explode('-', $key); | |
887e764d PN |
2321 | $data['website'][$websiteField[1]]['website_type_id'] = $websiteField[1]; |
2322 | $data['website'][$websiteField[1]]['url'] = $value; | |
6a488035 | 2323 | } |
6a488035 | 2324 | elseif (in_array($key, self::$_greetingTypes, TRUE)) { |
41665e8f | 2325 | //save email/postal greeting and addressee values if any, CRM-4575 |
6a488035 TO |
2326 | $data[$key . '_id'] = $value; |
2327 | } | |
2328 | elseif (!$skipCustom && ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($key))) { | |
2329 | // for autocomplete transfer hidden value instead of label | |
2330 | if ($params[$key] && isset($params[$key . '_id'])) { | |
2331 | $value = $params[$key . '_id']; | |
2332 | } | |
2333 | ||
2334 | // we need to append time with date | |
2335 | if ($params[$key] && isset($params[$key . '_time'])) { | |
2336 | $value .= ' ' . $params[$key . '_time']; | |
2337 | } | |
2338 | ||
ece0bc24 DS |
2339 | // if auth source is not checksum / login && $value is blank, do not proceed - CRM-10128 |
2340 | if (($session->get('authSrc') & (CRM_Core_Permission::AUTH_SRC_CHECKSUM + CRM_Core_Permission::AUTH_SRC_LOGIN)) == 0 && | |
9bb77b8e TO |
2341 | ($value == '' || !isset($value)) |
2342 | ) { | |
ece0bc24 | 2343 | continue; |
69739cb8 | 2344 | } |
ece0bc24 | 2345 | |
6a488035 | 2346 | $valueId = NULL; |
a7488080 | 2347 | if (!empty($params['customRecordValues'])) { |
6a488035 TO |
2348 | if (is_array($params['customRecordValues']) && !empty($params['customRecordValues'])) { |
2349 | foreach ($params['customRecordValues'] as $recId => $customFields) { | |
2350 | if (is_array($customFields) && !empty($customFields)) { | |
2351 | foreach ($customFields as $customFieldName) { | |
2352 | if ($customFieldName == $key) { | |
2353 | $valueId = $recId; | |
2354 | break; | |
2355 | } | |
2356 | } | |
2357 | } | |
2358 | } | |
2359 | } | |
2360 | } | |
2361 | ||
aa7a7a14 AW |
2362 | //CRM-13596 - check for contact_sub_type_hidden first |
2363 | if (array_key_exists('contact_sub_type_hidden', $params)) { | |
2364 | $type = $params['contact_sub_type_hidden']; | |
9c302451 | 2365 | } |
aa7a7a14 AW |
2366 | else { |
2367 | $type = $data['contact_type']; | |
2368 | if (!empty($data['contact_sub_type'])) { | |
77896892 | 2369 | $type = CRM_Utils_Array::explodePadded($data['contact_sub_type']); |
aa7a7a14 | 2370 | } |
6a488035 TO |
2371 | } |
2372 | ||
2373 | CRM_Core_BAO_CustomField::formatCustomField($customFieldId, | |
2374 | $data['custom'], | |
2375 | $value, | |
2376 | $type, | |
2377 | $valueId, | |
c8f7094b | 2378 | $contactID, |
2379 | FALSE, | |
2380 | FALSE | |
6a488035 TO |
2381 | ); |
2382 | } | |
f6b81482 | 2383 | elseif ($key === 'edit') { |
6a488035 TO |
2384 | continue; |
2385 | } | |
2386 | else { | |
f6b81482 | 2387 | if ($key === 'location') { |
6a488035 TO |
2388 | foreach ($value as $locationTypeId => $field) { |
2389 | foreach ($field as $block => $val) { | |
f6b81482 | 2390 | if ($block === 'address' && array_key_exists('address_name', $val)) { |
6a488035 TO |
2391 | $value[$locationTypeId][$block]['name'] = $value[$locationTypeId][$block]['address_name']; |
2392 | } | |
2393 | } | |
2394 | } | |
2395 | } | |
f6b81482 | 2396 | if ($key === 'phone' && isset($params['phone_ext'])) { |
6a488035 | 2397 | $data[$key] = $value; |
9bb77b8e TO |
2398 | foreach ($value as $cnt => $phoneBlock) { |
2399 | if ($params[$key][$cnt]['location_type_id'] == $params['phone_ext'][$cnt]['location_type_id']) { | |
6a488035 TO |
2400 | $data[$key][$cnt]['phone_ext'] = CRM_Utils_Array::retrieveValueRecursive($params['phone_ext'][$cnt], 'phone_ext'); |
2401 | } | |
2402 | } | |
2403 | } | |
f6b81482 | 2404 | elseif (in_array($key, ['nick_name', 'job_title', 'middle_name', 'birth_date', 'gender_id', 'current_employer', 'prefix_id', 'suffix_id']) |
2405 | && ($value == '' || !isset($value)) && | |
2406 | ($session->get('authSrc') & (CRM_Core_Permission::AUTH_SRC_CHECKSUM + CRM_Core_Permission::AUTH_SRC_LOGIN)) == 0 || | |
2407 | ($key === 'current_employer' && empty($params['current_employer']))) { | |
69078420 SL |
2408 | // CRM-10128: if auth source is not checksum / login && $value is blank, do not fill $data with empty value |
2409 | // to avoid update with empty values | |
2410 | continue; | |
69739cb8 | 2411 | } |
6a488035 TO |
2412 | else { |
2413 | $data[$key] = $value; | |
2414 | } | |
2415 | } | |
2416 | } | |
2417 | } | |
2418 | ||
2419 | if (!isset($data['contact_type'])) { | |
2420 | $data['contact_type'] = 'Individual'; | |
2421 | } | |
2422 | ||
2423 | //set the values for checkboxes (do_not_email, do_not_mail, do_not_trade, do_not_phone) | |
2424 | $privacy = CRM_Core_SelectValues::privacy(); | |
2425 | foreach ($privacy as $key => $value) { | |
2426 | if (array_key_exists($key, $fields)) { | |
29748d00 | 2427 | // do not reset values for existing contacts, if fields are added to a profile |
6a488035 TO |
2428 | if (array_key_exists($key, $params)) { |
2429 | $data[$key] = $params[$key]; | |
29748d00 C |
2430 | if (empty($params[$key])) { |
2431 | $data[$key] = 0; | |
2432 | } | |
6a488035 TO |
2433 | } |
2434 | elseif (!$contactID) { | |
2435 | $data[$key] = 0; | |
2436 | } | |
2437 | } | |
2438 | } | |
2439 | ||
f6b81482 | 2440 | return [$data, $contactDetails]; |
6a488035 TO |
2441 | } |
2442 | ||
2443 | /** | |
57507ae6 EM |
2444 | * Find the get contact details. |
2445 | * | |
2446 | * This function does not respect ACLs for now, which might need to be rectified at some | |
2447 | * stage based on how its used. | |
6a488035 | 2448 | * |
77c5b619 TO |
2449 | * @param string $mail |
2450 | * Primary email address of the contact. | |
2451 | * @param string $ctype | |
2452 | * Contact type. | |
6a488035 | 2453 | * |
1273d77c | 2454 | * @return object|null |
a6c01b45 | 2455 | * $dao contact details |
6a488035 | 2456 | */ |
1273d77c | 2457 | public static function matchContactOnEmail($mail, $ctype = NULL) { |
6a488035 | 2458 | $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower'; |
9bb77b8e TO |
2459 | $mail = $strtolower(trim($mail)); |
2460 | $query = " | |
6a488035 TO |
2461 | SELECT civicrm_contact.id as contact_id, |
2462 | civicrm_contact.hash as hash, | |
2463 | civicrm_contact.contact_type as contact_type, | |
2464 | civicrm_contact.contact_sub_type as contact_sub_type | |
2465 | FROM civicrm_contact | |
2466 | INNER JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id )"; | |
2467 | ||
aaffa79f | 2468 | if (Civi::settings()->get('uniq_email_per_site')) { |
6a488035 TO |
2469 | // try to find a match within a site (multisite). |
2470 | $groups = CRM_Core_BAO_Domain::getChildGroupIds(); | |
2471 | if (!empty($groups)) { | |
2472 | $query .= " | |
2473 | INNER JOIN civicrm_group_contact gc ON | |
2474 | (civicrm_contact.id = gc.contact_id AND gc.status = 'Added' AND gc.group_id IN (" . implode(',', $groups) . "))"; | |
2475 | } | |
2476 | } | |
2477 | ||
2478 | $query .= " | |
2479 | WHERE civicrm_email.email = %1 AND civicrm_contact.is_deleted=0"; | |
f6b81482 | 2480 | $p = [1 => [$mail, 'String']]; |
6a488035 TO |
2481 | |
2482 | if ($ctype) { | |
2483 | $query .= " AND civicrm_contact.contact_type = %3"; | |
f6b81482 | 2484 | $p[3] = [$ctype, 'String']; |
6a488035 TO |
2485 | } |
2486 | ||
2487 | $query .= " ORDER BY civicrm_email.is_primary DESC"; | |
2488 | ||
2489 | $dao = CRM_Core_DAO::executeQuery($query, $p); | |
2490 | ||
2491 | if ($dao->fetch()) { | |
2492 | return $dao; | |
2493 | } | |
1273d77c | 2494 | return NULL; |
6a488035 TO |
2495 | } |
2496 | ||
2497 | /** | |
57507ae6 | 2498 | * Find the contact details associated with an OpenID. |
6a488035 | 2499 | * |
77c5b619 TO |
2500 | * @param string $openId |
2501 | * OpenId of the contact. | |
2502 | * @param string $ctype | |
2503 | * Contact type. | |
6a488035 | 2504 | * |
1273d77c | 2505 | * @return object|null |
a6c01b45 | 2506 | * $dao contact details |
6a488035 | 2507 | */ |
1273d77c | 2508 | public static function matchContactOnOpenId($openId, $ctype = NULL) { |
6a488035 | 2509 | $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower'; |
9bb77b8e TO |
2510 | $openId = $strtolower(trim($openId)); |
2511 | $query = " | |
6a488035 TO |
2512 | SELECT civicrm_contact.id as contact_id, |
2513 | civicrm_contact.hash as hash, | |
2514 | civicrm_contact.contact_type as contact_type, | |
2515 | civicrm_contact.contact_sub_type as contact_sub_type | |
2516 | FROM civicrm_contact | |
2517 | INNER JOIN civicrm_openid ON ( civicrm_contact.id = civicrm_openid.contact_id ) | |
2518 | WHERE civicrm_openid.openid = %1"; | |
f6b81482 | 2519 | $p = [1 => [$openId, 'String']]; |
6a488035 TO |
2520 | |
2521 | if ($ctype) { | |
2522 | $query .= " AND civicrm_contact.contact_type = %3"; | |
f6b81482 | 2523 | $p[3] = [$ctype, 'String']; |
6a488035 TO |
2524 | } |
2525 | ||
2526 | $query .= " ORDER BY civicrm_openid.is_primary DESC"; | |
2527 | ||
2528 | $dao = CRM_Core_DAO::executeQuery($query, $p); | |
2529 | ||
2530 | if ($dao->fetch()) { | |
2531 | return $dao; | |
2532 | } | |
1273d77c | 2533 | return NULL; |
6a488035 TO |
2534 | } |
2535 | ||
2536 | /** | |
57507ae6 | 2537 | * Get primary email of the contact. |
6a488035 | 2538 | * |
77c5b619 TO |
2539 | * @param int $contactID |
2540 | * Contact id. | |
157e2097 AH |
2541 | * @param bool $polite |
2542 | * Whether to only pull an email if it's okay to send to it--that is, if it | |
2543 | * is not on_hold and the contact is not do_not_email. | |
6a488035 | 2544 | * |
a6c01b45 | 2545 | * @return string |
57507ae6 | 2546 | * Email address if present else null |
6a488035 | 2547 | */ |
157e2097 | 2548 | public static function getPrimaryEmail($contactID, $polite = FALSE) { |
6a488035 TO |
2549 | // fetch the primary email |
2550 | $query = " | |
2551 | SELECT civicrm_email.email as email | |
2552 | FROM civicrm_contact | |
2553 | LEFT JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id ) | |
2554 | WHERE civicrm_email.is_primary = 1 | |
2555 | AND civicrm_contact.id = %1"; | |
157e2097 AH |
2556 | if ($polite) { |
2557 | $query .= ' | |
2558 | AND civicrm_contact.do_not_email = 0 | |
2559 | AND civicrm_email.on_hold = 0'; | |
2560 | } | |
f6b81482 | 2561 | $p = [1 => [$contactID, 'Integer']]; |
6a488035 TO |
2562 | $dao = CRM_Core_DAO::executeQuery($query, $p); |
2563 | ||
2564 | $email = NULL; | |
2565 | if ($dao->fetch()) { | |
2566 | $email = $dao->email; | |
2567 | } | |
6a488035 TO |
2568 | return $email; |
2569 | } | |
2570 | ||
6a488035 | 2571 | /** |
57507ae6 | 2572 | * Fetch the object and store the values in the values array. |
6a488035 | 2573 | * |
77c5b619 TO |
2574 | * @param array $params |
2575 | * Input parameters to find object. | |
2576 | * @param array $values | |
2577 | * Output values of the object. | |
6a488035 | 2578 | * |
57507ae6 EM |
2579 | * @return CRM_Contact_BAO_Contact|null |
2580 | * The found object or null | |
6a488035 TO |
2581 | */ |
2582 | public static function getValues(&$params, &$values) { | |
2583 | $contact = new CRM_Contact_BAO_Contact(); | |
2584 | ||
2585 | $contact->copyValues($params); | |
2586 | ||
2587 | if ($contact->find(TRUE)) { | |
2588 | ||
2589 | CRM_Core_DAO::storeValues($contact, $values); | |
2590 | ||
f6b81482 | 2591 | $privacy = []; |
6a488035 TO |
2592 | foreach (self::$_commPrefs as $name) { |
2593 | if (isset($contact->$name)) { | |
2594 | $privacy[$name] = $contact->$name; | |
2595 | } | |
2596 | } | |
2597 | ||
2598 | if (!empty($privacy)) { | |
2599 | $values['privacy'] = $privacy; | |
2600 | } | |
2601 | ||
2602 | // communication Prefferance | |
f6b81482 | 2603 | $preffComm = $comm = []; |
6a488035 TO |
2604 | $comm = explode(CRM_Core_DAO::VALUE_SEPARATOR, |
2605 | $contact->preferred_communication_method | |
2606 | ); | |
2607 | foreach ($comm as $value) { | |
2608 | $preffComm[$value] = 1; | |
2609 | } | |
f6b81482 | 2610 | $temp = ['preferred_communication_method' => $contact->preferred_communication_method]; |
6a488035 | 2611 | |
f6b81482 | 2612 | $names = [ |
2613 | 'preferred_communication_method' => [ | |
9bb77b8e | 2614 | 'newName' => 'preferred_communication_method_display', |
6a488035 | 2615 | 'groupName' => 'preferred_communication_method', |
f6b81482 | 2616 | ], |
2617 | ]; | |
6a488035 | 2618 | |
ed0ca248 | 2619 | // @todo This can be figured out from metadata & we can avoid the uncached query. |
6a488035 TO |
2620 | CRM_Core_OptionGroup::lookupValues($temp, $names, FALSE); |
2621 | ||
2622 | $values['preferred_communication_method'] = $preffComm; | |
f748c073 | 2623 | $values['preferred_communication_method_display'] = $temp['preferred_communication_method_display'] ?? NULL; |
6a488035 | 2624 | |
cd223eef | 2625 | if ($contact->preferred_mail_format) { |
2626 | $preferredMailingFormat = CRM_Core_SelectValues::pmf(); | |
2627 | $values['preferred_mail_format'] = $preferredMailingFormat[$contact->preferred_mail_format]; | |
2628 | } | |
6a488035 TO |
2629 | |
2630 | // get preferred languages | |
2631 | if (!empty($contact->preferred_language)) { | |
a8c23526 | 2632 | $values['preferred_language'] = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $contact->preferred_language); |
6a488035 TO |
2633 | } |
2634 | ||
2635 | // Calculating Year difference | |
2636 | if ($contact->birth_date) { | |
2637 | $birthDate = CRM_Utils_Date::customFormat($contact->birth_date, '%Y%m%d'); | |
2638 | if ($birthDate < date('Ymd')) { | |
9bb77b8e | 2639 | $age = CRM_Utils_Date::calculateAge($birthDate); |
f748c073 | 2640 | $values['age']['y'] = $age['years'] ?? NULL; |
2641 | $values['age']['m'] = $age['months'] ?? NULL; | |
6a488035 | 2642 | } |
6a488035 TO |
2643 | } |
2644 | ||
2645 | $contact->contact_id = $contact->id; | |
2646 | ||
2647 | return $contact; | |
2648 | } | |
2649 | return NULL; | |
2650 | } | |
2651 | ||
2652 | /** | |
db7de9c1 | 2653 | * Given the component name and returns the count of participation of contact. |
6a488035 | 2654 | * |
77c5b619 TO |
2655 | * @param string $component |
2656 | * Input component name. | |
2657 | * @param int $contactId | |
2658 | * Input contact id. | |
2659 | * @param string $tableName | |
2660 | * Optional tableName if component is custom group. | |
6a488035 | 2661 | * |
72b3a70c CW |
2662 | * @return int |
2663 | * total number in database | |
6a488035 | 2664 | */ |
00be9182 | 2665 | public static function getCountComponent($component, $contactId, $tableName = NULL) { |
6a488035 TO |
2666 | $object = NULL; |
2667 | switch ($component) { | |
2668 | case 'tag': | |
2669 | return CRM_Core_BAO_EntityTag::getContactTags($contactId, TRUE); | |
2670 | ||
2671 | case 'rel': | |
6c552737 | 2672 | $result = CRM_Contact_BAO_Relationship::getRelationship($contactId, |
468da094 | 2673 | CRM_Contact_BAO_Relationship::CURRENT, |
b7d19957 | 2674 | 0, 1, 0, |
a93664c8 | 2675 | NULL, NULL, |
2676 | TRUE | |
6a488035 | 2677 | ); |
b7d19957 | 2678 | return $result; |
6a488035 TO |
2679 | |
2680 | case 'group': | |
468da094 | 2681 | |
234855ae | 2682 | return CRM_Contact_BAO_GroupContact::getContactGroup($contactId, "Added", NULL, TRUE, FALSE, FALSE, TRUE, NULL, TRUE); |
6a488035 TO |
2683 | |
2684 | case 'log': | |
2685 | if (CRM_Core_BAO_Log::useLoggingReport()) { | |
2686 | return FALSE; | |
2687 | } | |
2688 | return CRM_Core_BAO_Log::getContactLogCount($contactId); | |
2689 | ||
2690 | case 'note': | |
2691 | return CRM_Core_BAO_Note::getContactNoteCount($contactId); | |
2692 | ||
2693 | case 'contribution': | |
2694 | return CRM_Contribute_BAO_Contribution::contributionCount($contactId); | |
2695 | ||
2696 | case 'membership': | |
2697 | return CRM_Member_BAO_Membership::getContactMembershipCount($contactId, TRUE); | |
2698 | ||
2699 | case 'participant': | |
2700 | return CRM_Event_BAO_Participant::getContactParticipantCount($contactId); | |
2701 | ||
2702 | case 'pledge': | |
2703 | return CRM_Pledge_BAO_Pledge::getContactPledgeCount($contactId); | |
2704 | ||
2705 | case 'case': | |
2706 | return CRM_Case_BAO_Case::caseCount($contactId); | |
2707 | ||
2708 | case 'grant': | |
2709 | return CRM_Grant_BAO_Grant::getContactGrantCount($contactId); | |
2710 | ||
2711 | case 'activity': | |
f6b81482 | 2712 | $input = [ |
6a488035 TO |
2713 | 'contact_id' => $contactId, |
2714 | 'admin' => FALSE, | |
2715 | 'caseId' => NULL, | |
2716 | 'context' => 'activity', | |
f6b81482 | 2717 | ]; |
6e793248 | 2718 | return CRM_Activity_BAO_Activity::getActivitiesCount($input); |
6a488035 | 2719 | |
36bb946c | 2720 | case 'mailing': |
f6b81482 | 2721 | $params = ['contact_id' => $contactId]; |
553f116a | 2722 | return CRM_Mailing_BAO_Mailing::getContactMailingsCount($params); |
36bb946c | 2723 | |
6a488035 TO |
2724 | default: |
2725 | $custom = explode('_', $component); | |
2726 | if ($custom['0'] = 'custom') { | |
2727 | if (!$tableName) { | |
2728 | $tableName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $custom['1'], 'table_name'); | |
2729 | } | |
2730 | $queryString = "SELECT count(id) FROM {$tableName} WHERE entity_id = {$contactId}"; | |
2731 | return CRM_Core_DAO::singleValueQuery($queryString); | |
2732 | } | |
2733 | } | |
2734 | } | |
2735 | ||
63b7d442 AS |
2736 | /** |
2737 | * Update contact greetings if an update has resulted in a custom field change. | |
2738 | * | |
2739 | * @param array $updatedFields | |
2740 | * Array of fields that have been updated e.g array('first_name', 'prefix_id', 'custom_2'); | |
2741 | * @param array $contactParams | |
2742 | * Parameters known about the contact. At minimum array('contact_id' => x). | |
2743 | * Fields in this array will take precedence over DB fields (so far only | |
2744 | * in the case of greeting id fields). | |
2745 | */ | |
2746 | public static function updateGreetingsOnTokenFieldChange($updatedFields, $contactParams) { | |
2747 | $contactID = $contactParams['contact_id']; | |
2748 | CRM_Contact_BAO_Contact::ensureGreetingParamsAreSet($contactParams); | |
2749 | $tokens = CRM_Contact_BAO_Contact_Utils::getTokensRequiredForContactGreetings($contactParams); | |
2750 | if (!empty($tokens['all']['contact'])) { | |
2751 | $affectedTokens = array_intersect_key($updatedFields[$contactID], array_flip($tokens['all']['contact'])); | |
2752 | if (!empty($affectedTokens)) { | |
2753 | // @todo this is still reloading the whole contact -fix to be more selective & use pre-loaded. | |
2754 | $contact = new CRM_Contact_BAO_Contact(); | |
2755 | $contact->id = $contactID; | |
2756 | CRM_Contact_BAO_Contact::processGreetings($contact); | |
2757 | } | |
2758 | } | |
2759 | } | |
2760 | ||
6a488035 | 2761 | /** |
567b2076 | 2762 | * Process greetings and cache. |
6a488035 | 2763 | * |
77c5b619 TO |
2764 | * @param object $contact |
2765 | * Contact object after save. | |
6a488035 | 2766 | */ |
5f35a2d9 | 2767 | public static function processGreetings(&$contact) { |
6a488035 | 2768 | |
63b7d442 AS |
2769 | //@todo this function does a lot of unnecessary loading. |
2770 | // ensureGreetingParamsAreSet now makes sure that the contact is | |
2771 | // loaded and using updateGreetingsOnTokenFieldChange | |
2772 | // allows us the possibility of only doing an update if required. | |
2773 | ||
663cc0b4 J |
2774 | // The contact object has not always required the |
2775 | // fields that are required to calculate greetings | |
2776 | // so we need to retrieve it again. | |
9bb77b8e | 2777 | if ($contact->_query !== FALSE) { |
1a902da0 BS |
2778 | $contact->find(TRUE); |
2779 | } | |
6a488035 TO |
2780 | |
2781 | // store object values to an array | |
f6b81482 | 2782 | $contactDetails = []; |
6a488035 | 2783 | CRM_Core_DAO::storeValues($contact, $contactDetails); |
f6b81482 | 2784 | $contactDetails = [[$contact->id => $contactDetails]]; |
6a488035 TO |
2785 | |
2786 | $emailGreetingString = $postalGreetingString = $addresseeString = NULL; | |
f6b81482 | 2787 | $updateQueryString = []; |
6a488035 TO |
2788 | |
2789 | //cache email and postal greeting to greeting display | |
2790 | if ($contact->email_greeting_custom != 'null' && $contact->email_greeting_custom) { | |
2791 | $emailGreetingString = $contact->email_greeting_custom; | |
2792 | } | |
2793 | elseif ($contact->email_greeting_id != 'null' && $contact->email_greeting_id) { | |
2794 | // the filter value for Individual contact type is set to 1 | |
f6b81482 | 2795 | $filter = [ |
6a488035 TO |
2796 | 'contact_type' => $contact->contact_type, |
2797 | 'greeting_type' => 'email_greeting', | |
f6b81482 | 2798 | ]; |
6a488035 | 2799 | |
9bb77b8e | 2800 | $emailGreeting = CRM_Core_PseudoConstant::greeting($filter); |
6a488035 TO |
2801 | $emailGreetingString = $emailGreeting[$contact->email_greeting_id]; |
2802 | $updateQueryString[] = " email_greeting_custom = NULL "; | |
2803 | } | |
2804 | else { | |
5f35a2d9 | 2805 | if ($contact->email_greeting_custom) { |
6a488035 TO |
2806 | $updateQueryString[] = " email_greeting_display = NULL "; |
2807 | } | |
2808 | } | |
2809 | ||
2810 | if ($emailGreetingString) { | |
73d64eb6 | 2811 | CRM_Contact_BAO_Contact_Utils::processGreetingTemplate($emailGreetingString, |
6a488035 TO |
2812 | $contactDetails, |
2813 | $contact->id, | |
2814 | 'CRM_Contact_BAO_Contact' | |
2815 | ); | |
2816 | $emailGreetingString = CRM_Core_DAO::escapeString(CRM_Utils_String::stripSpaces($emailGreetingString)); | |
2817 | $updateQueryString[] = " email_greeting_display = '{$emailGreetingString}'"; | |
2818 | } | |
2819 | ||
2820 | //postal greetings | |
f6b81482 | 2821 | if ($contact->postal_greeting_custom !== 'null' && $contact->postal_greeting_custom) { |
6a488035 TO |
2822 | $postalGreetingString = $contact->postal_greeting_custom; |
2823 | } | |
f6b81482 | 2824 | elseif ($contact->postal_greeting_id !== 'null' && $contact->postal_greeting_id) { |
2825 | $filter = [ | |
6a488035 TO |
2826 | 'contact_type' => $contact->contact_type, |
2827 | 'greeting_type' => 'postal_greeting', | |
f6b81482 | 2828 | ]; |
6a488035 TO |
2829 | $postalGreeting = CRM_Core_PseudoConstant::greeting($filter); |
2830 | $postalGreetingString = $postalGreeting[$contact->postal_greeting_id]; | |
2831 | $updateQueryString[] = " postal_greeting_custom = NULL "; | |
2832 | } | |
2833 | else { | |
5f35a2d9 | 2834 | if ($contact->postal_greeting_custom) { |
6a488035 TO |
2835 | $updateQueryString[] = " postal_greeting_display = NULL "; |
2836 | } | |
2837 | } | |
2838 | ||
2839 | if ($postalGreetingString) { | |
73d64eb6 | 2840 | CRM_Contact_BAO_Contact_Utils::processGreetingTemplate($postalGreetingString, |
6a488035 TO |
2841 | $contactDetails, |
2842 | $contact->id, | |
2843 | 'CRM_Contact_BAO_Contact' | |
2844 | ); | |
2845 | $postalGreetingString = CRM_Core_DAO::escapeString(CRM_Utils_String::stripSpaces($postalGreetingString)); | |
2846 | $updateQueryString[] = " postal_greeting_display = '{$postalGreetingString}'"; | |
2847 | } | |
2848 | ||
2849 | // addressee | |
f6b81482 | 2850 | if ($contact->addressee_custom !== 'null' && $contact->addressee_custom) { |
6a488035 TO |
2851 | $addresseeString = $contact->addressee_custom; |
2852 | } | |
f6b81482 | 2853 | elseif ($contact->addressee_id !== 'null' && $contact->addressee_id) { |
2854 | $filter = [ | |
6a488035 TO |
2855 | 'contact_type' => $contact->contact_type, |
2856 | 'greeting_type' => 'addressee', | |
f6b81482 | 2857 | ]; |
6a488035 | 2858 | |
9bb77b8e TO |
2859 | $addressee = CRM_Core_PseudoConstant::greeting($filter); |
2860 | $addresseeString = $addressee[$contact->addressee_id]; | |
6a488035 TO |
2861 | $updateQueryString[] = " addressee_custom = NULL "; |
2862 | } | |
2863 | else { | |
5f35a2d9 | 2864 | if ($contact->addressee_custom) { |
6a488035 TO |
2865 | $updateQueryString[] = " addressee_display = NULL "; |
2866 | } | |
2867 | } | |
2868 | ||
2869 | if ($addresseeString) { | |
73d64eb6 | 2870 | CRM_Contact_BAO_Contact_Utils::processGreetingTemplate($addresseeString, |
6a488035 TO |
2871 | $contactDetails, |
2872 | $contact->id, | |
2873 | 'CRM_Contact_BAO_Contact' | |
2874 | ); | |
2875 | $addresseeString = CRM_Core_DAO::escapeString(CRM_Utils_String::stripSpaces($addresseeString)); | |
2876 | $updateQueryString[] = " addressee_display = '{$addresseeString}'"; | |
2877 | } | |
2878 | ||
2879 | if (!empty($updateQueryString)) { | |
2880 | $updateQueryString = implode(',', $updateQueryString); | |
2881 | $queryString = "UPDATE civicrm_contact SET {$updateQueryString} WHERE id = {$contact->id}"; | |
2882 | CRM_Core_DAO::executeQuery($queryString); | |
2883 | } | |
2884 | } | |
2885 | ||
2886 | /** | |
100fef9d | 2887 | * Retrieve loc block ids w/ given condition. |
6a488035 | 2888 | * |
77c5b619 TO |
2889 | * @param int $contactId |
2890 | * Contact id. | |
2891 | * @param array $criteria | |
2892 | * Key => value pair which should be. | |
6a488035 | 2893 | * fulfill by return record ids. |
77c5b619 TO |
2894 | * @param string $condOperator |
2895 | * Operator use for grouping multiple conditions. | |
6a488035 | 2896 | * |
a6c01b45 CW |
2897 | * @return array |
2898 | * loc block ids which fulfill condition. | |
6a488035 | 2899 | */ |
f6b81482 | 2900 | public static function getLocBlockIds($contactId, $criteria = [], $condOperator = 'AND') { |
2901 | $locBlockIds = []; | |
6a488035 TO |
2902 | if (!$contactId) { |
2903 | return $locBlockIds; | |
2904 | } | |
2905 | ||
f6b81482 | 2906 | foreach (['Email', 'OpenID', 'Phone', 'Address', 'IM'] as $block) { |
6a488035 | 2907 | $name = strtolower($block); |
46a4f1e9 CW |
2908 | $className = "CRM_Core_DAO_$block"; |
2909 | $blockDAO = new $className(); | |
6a488035 TO |
2910 | |
2911 | // build the condition. | |
2912 | if (is_array($criteria)) { | |
46a4f1e9 | 2913 | $fields = $blockDAO->fields(); |
f6b81482 | 2914 | $conditions = []; |
6a488035 TO |
2915 | foreach ($criteria as $field => $value) { |
2916 | if (array_key_exists($field, $fields)) { | |
2917 | $cond = "( $field = $value )"; | |
2918 | // value might be zero or null. | |
f6b81482 | 2919 | if (!$value || strtolower($value) === 'null') { |
6a488035 TO |
2920 | $cond = "( $field = 0 OR $field IS NULL )"; |
2921 | } | |
2922 | $conditions[] = $cond; | |
2923 | } | |
2924 | } | |
2925 | if (!empty($conditions)) { | |
2926 | $blockDAO->whereAdd(implode(" $condOperator ", $conditions)); | |
2927 | } | |
2928 | } | |
2929 | ||
2930 | $blockDAO->contact_id = $contactId; | |
2931 | $blockDAO->find(); | |
2932 | while ($blockDAO->fetch()) { | |
2933 | $locBlockIds[$name][] = $blockDAO->id; | |
2934 | } | |
6a488035 TO |
2935 | } |
2936 | ||
2937 | return $locBlockIds; | |
2938 | } | |
2939 | ||
2940 | /** | |
100fef9d | 2941 | * Build context menu items. |
6a488035 | 2942 | * |
100fef9d | 2943 | * @param int $contactId |
77b97be7 | 2944 | * |
a6c01b45 | 2945 | * @return array |
16b10e64 | 2946 | * Array of context menu for logged in user. |
6a488035 | 2947 | */ |
00be9182 | 2948 | public static function contextMenu($contactId = NULL) { |
f6b81482 | 2949 | $menu = [ |
2950 | 'view' => [ | |
9309f5c6 E |
2951 | 'title' => ts('View Contact'), |
2952 | 'weight' => 0, | |
2953 | 'ref' => 'view-contact', | |
2954 | 'class' => 'no-popup', | |
2955 | 'key' => 'view', | |
f6b81482 | 2956 | 'permissions' => ['view all contacts'], |
2957 | ], | |
2958 | 'add' => [ | |
9309f5c6 E |
2959 | 'title' => ts('Edit Contact'), |
2960 | 'weight' => 0, | |
2961 | 'ref' => 'edit-contact', | |
2962 | 'class' => 'no-popup', | |
2963 | 'key' => 'add', | |
f6b81482 | 2964 | 'permissions' => ['edit all contacts'], |
2965 | ], | |
2966 | 'delete' => [ | |
9309f5c6 E |
2967 | 'title' => ts('Delete Contact'), |
2968 | 'weight' => 0, | |
2969 | 'ref' => 'delete-contact', | |
2970 | 'key' => 'delete', | |
f6b81482 | 2971 | 'permissions' => ['access deleted contacts', 'delete contacts'], |
2972 | ], | |
2973 | 'contribution' => [ | |
9309f5c6 E |
2974 | 'title' => ts('Add Contribution'), |
2975 | 'weight' => 5, | |
2976 | 'ref' => 'new-contribution', | |
2977 | 'key' => 'contribution', | |
2978 | 'tab' => 'contribute', | |
2979 | 'component' => 'CiviContribute', | |
2980 | 'href' => CRM_Utils_System::url('civicrm/contact/view/contribution', | |
2981 | 'reset=1&action=add&context=contribution' | |
6a488035 | 2982 | ), |
f6b81482 | 2983 | 'permissions' => [ |
9309f5c6 E |
2984 | 'access CiviContribute', |
2985 | 'edit contributions', | |
f6b81482 | 2986 | ], |
2987 | ], | |
2988 | 'participant' => [ | |
9309f5c6 E |
2989 | 'title' => ts('Register for Event'), |
2990 | 'weight' => 10, | |
2991 | 'ref' => 'new-participant', | |
2992 | 'key' => 'participant', | |
2993 | 'tab' => 'participant', | |
2994 | 'component' => 'CiviEvent', | |
2995 | 'href' => CRM_Utils_System::url('civicrm/contact/view/participant', 'reset=1&action=add&context=participant'), | |
f6b81482 | 2996 | 'permissions' => [ |
9309f5c6 E |
2997 | 'access CiviEvent', |
2998 | 'edit event participants', | |
f6b81482 | 2999 | ], |
3000 | ], | |
3001 | 'activity' => [ | |
9309f5c6 E |
3002 | 'title' => ts('Record Activity'), |
3003 | 'weight' => 35, | |
3004 | 'ref' => 'new-activity', | |
3005 | 'key' => 'activity', | |
f6b81482 | 3006 | 'permissions' => ['edit all contacts'], |
3007 | ], | |
3008 | 'pledge' => [ | |
9309f5c6 E |
3009 | 'title' => ts('Add Pledge'), |
3010 | 'weight' => 15, | |
3011 | 'ref' => 'new-pledge', | |
3012 | 'key' => 'pledge', | |
3013 | 'tab' => 'pledge', | |
3014 | 'href' => CRM_Utils_System::url('civicrm/contact/view/pledge', | |
3015 | 'reset=1&action=add&context=pledge' | |
6a488035 | 3016 | ), |
9309f5c6 | 3017 | 'component' => 'CiviPledge', |
f6b81482 | 3018 | 'permissions' => [ |
9309f5c6 E |
3019 | 'access CiviPledge', |
3020 | 'edit pledges', | |
f6b81482 | 3021 | ], |
3022 | ], | |
3023 | 'membership' => [ | |
9309f5c6 E |
3024 | 'title' => ts('Add Membership'), |
3025 | 'weight' => 20, | |
3026 | 'ref' => 'new-membership', | |
3027 | 'key' => 'membership', | |
3028 | 'tab' => 'member', | |
3029 | 'component' => 'CiviMember', | |
3030 | 'href' => CRM_Utils_System::url('civicrm/contact/view/membership', | |
3031 | 'reset=1&action=add&context=membership' | |
1fb73100 | 3032 | ), |
f6b81482 | 3033 | 'permissions' => [ |
9309f5c6 E |
3034 | 'access CiviMember', |
3035 | 'edit memberships', | |
f6b81482 | 3036 | ], |
3037 | ], | |
3038 | 'case' => [ | |
9309f5c6 E |
3039 | 'title' => ts('Add Case'), |
3040 | 'weight' => 25, | |
3041 | 'ref' => 'new-case', | |
3042 | 'key' => 'case', | |
3043 | 'tab' => 'case', | |
3044 | 'component' => 'CiviCase', | |
3045 | 'href' => CRM_Utils_System::url('civicrm/case/add', 'reset=1&action=add&context=case'), | |
f6b81482 | 3046 | 'permissions' => ['add cases'], |
3047 | ], | |
3048 | 'grant' => [ | |
9309f5c6 E |
3049 | 'title' => ts('Add Grant'), |
3050 | 'weight' => 26, | |
3051 | 'ref' => 'new-grant', | |
3052 | 'key' => 'grant', | |
3053 | 'tab' => 'grant', | |
3054 | 'component' => 'CiviGrant', | |
3055 | 'href' => CRM_Utils_System::url('civicrm/contact/view/grant', | |
3056 | 'reset=1&action=add&context=grant' | |
1fb73100 | 3057 | ), |
f6b81482 | 3058 | 'permissions' => ['edit grants'], |
3059 | ], | |
3060 | 'rel' => [ | |
9309f5c6 E |
3061 | 'title' => ts('Add Relationship'), |
3062 | 'weight' => 30, | |
3063 | 'ref' => 'new-relationship', | |
3064 | 'key' => 'rel', | |
3065 | 'tab' => 'rel', | |
3066 | 'href' => CRM_Utils_System::url('civicrm/contact/view/rel', | |
3067 | 'reset=1&action=add' | |
1fb73100 | 3068 | ), |
f6b81482 | 3069 | 'permissions' => ['edit all contacts'], |
3070 | ], | |
3071 | 'note' => [ | |
9309f5c6 E |
3072 | 'title' => ts('Add Note'), |
3073 | 'weight' => 40, | |
3074 | 'ref' => 'new-note', | |
3075 | 'key' => 'note', | |
3076 | 'tab' => 'note', | |
3077 | 'class' => 'medium-popup', | |
3078 | 'href' => CRM_Utils_System::url('civicrm/contact/view/note', | |
3079 | 'reset=1&action=add' | |
6a488035 | 3080 | ), |
f6b81482 | 3081 | 'permissions' => ['edit all contacts'], |
3082 | ], | |
3083 | 'email' => [ | |
9309f5c6 E |
3084 | 'title' => ts('Send an Email'), |
3085 | 'weight' => 45, | |
3086 | 'ref' => 'new-email', | |
3087 | 'key' => 'email', | |
f6b81482 | 3088 | 'permissions' => ['view all contacts'], |
3089 | ], | |
3090 | 'group' => [ | |
9309f5c6 E |
3091 | 'title' => ts('Add to Group'), |
3092 | 'weight' => 50, | |
3093 | 'ref' => 'group-add-contact', | |
3094 | 'key' => 'group', | |
3095 | 'tab' => 'group', | |
f6b81482 | 3096 | 'permissions' => ['edit groups'], |
3097 | ], | |
3098 | 'tag' => [ | |
9309f5c6 E |
3099 | 'title' => ts('Tag Contact'), |
3100 | 'weight' => 55, | |
3101 | 'ref' => 'tag-contact', | |
3102 | 'key' => 'tag', | |
3103 | 'tab' => 'tag', | |
f6b81482 | 3104 | 'permissions' => ['edit all contacts'], |
3105 | ], | |
3106 | ]; | |
9309f5c6 | 3107 | |
f6b81482 | 3108 | $menu['otherActions'] = [ |
3109 | 'print' => [ | |
9309f5c6 E |
3110 | 'title' => ts('Print Summary'), |
3111 | 'description' => ts('Printer-friendly view of this page.'), | |
3112 | 'weight' => 5, | |
3113 | 'ref' => 'crm-contact-print', | |
3114 | 'key' => 'print', | |
3115 | 'tab' => 'print', | |
3116 | 'href' => CRM_Utils_System::url('civicrm/contact/view/print', | |
3117 | "reset=1&print=1" | |
1fb73100 | 3118 | ), |
9309f5c6 E |
3119 | 'class' => 'print', |
3120 | 'icon' => 'crm-i fa-print', | |
f6b81482 | 3121 | ], |
3122 | 'vcard' => [ | |
9309f5c6 E |
3123 | 'title' => ts('vCard'), |
3124 | 'description' => ts('vCard record for this contact.'), | |
3125 | 'weight' => 10, | |
3126 | 'ref' => 'crm-contact-vcard', | |
3127 | 'key' => 'vcard', | |
3128 | 'tab' => 'vcard', | |
3129 | 'href' => CRM_Utils_System::url('civicrm/contact/view/vcard', | |
3130 | "reset=1" | |
1fb73100 | 3131 | ), |
9309f5c6 E |
3132 | 'class' => 'vcard', |
3133 | 'icon' => 'crm-i fa-list-alt', | |
f6b81482 | 3134 | ], |
3135 | ]; | |
6a488035 | 3136 | |
9309f5c6 | 3137 | if (CRM_Core_Permission::check('access Contact Dashboard')) { |
f6b81482 | 3138 | $menu['otherActions']['dashboard'] = [ |
1fb73100 E |
3139 | 'title' => ts('Contact Dashboard'), |
3140 | 'description' => ts('Contact Dashboard'), | |
3141 | 'weight' => 15, | |
3142 | 'ref' => 'crm-contact-dashboard', | |
3143 | 'key' => 'dashboard', | |
3144 | 'tab' => 'dashboard', | |
3145 | 'class' => 'dashboard', | |
9309f5c6 E |
3146 | // NOTE: As an alternative you can also build url on CMS specific way |
3147 | // as CRM_Core_Config::singleton()->userSystem->getUserRecordUrl($contactId) | |
3148 | 'href' => CRM_Utils_System::url('civicrm/user', "reset=1&id={$contactId}"), | |
1fb73100 | 3149 | 'icon' => 'crm-i fa-tachometer', |
f6b81482 | 3150 | ]; |
1fb73100 E |
3151 | } |
3152 | ||
9309f5c6 E |
3153 | $uid = CRM_Core_BAO_UFMatch::getUFId($contactId); |
3154 | if ($uid) { | |
f6b81482 | 3155 | $menu['otherActions']['user-record'] = [ |
1fb73100 E |
3156 | 'title' => ts('User Record'), |
3157 | 'description' => ts('User Record'), | |
3158 | 'weight' => 20, | |
3159 | 'ref' => 'crm-contact-user-record', | |
3160 | 'key' => 'user-record', | |
3161 | 'tab' => 'user-record', | |
3162 | 'class' => 'user-record', | |
9309f5c6 | 3163 | 'href' => CRM_Core_Config::singleton()->userSystem->getUserRecordUrl($contactId), |
1fb73100 | 3164 | 'icon' => 'crm-i fa-user', |
f6b81482 | 3165 | ]; |
1fb73100 | 3166 | } |
9309f5c6 | 3167 | elseif (CRM_Core_Config::singleton()->userSystem->checkPermissionAddUser()) { |
f6b81482 | 3168 | $menu['otherActions']['user-add'] = [ |
1fb73100 E |
3169 | 'title' => ts('Create User Record'), |
3170 | 'description' => ts('Create User Record'), | |
3171 | 'weight' => 25, | |
3172 | 'ref' => 'crm-contact-user-add', | |
3173 | 'key' => 'user-add', | |
3174 | 'tab' => 'user-add', | |
3175 | 'class' => 'user-add', | |
9309f5c6 | 3176 | 'href' => CRM_Utils_System::url('civicrm/contact/view/useradd', 'reset=1&action=add&cid=' . $contactId), |
1fb73100 | 3177 | 'icon' => 'crm-i fa-user-plus', |
f6b81482 | 3178 | ]; |
1fb73100 E |
3179 | } |
3180 | ||
6a488035 TO |
3181 | CRM_Utils_Hook::summaryActions($menu, $contactId); |
3182 | //1. check for component is active. | |
3183 | //2. check for user permissions. | |
3184 | //3. check for acls. | |
3185 | //3. edit and view contact are directly accessible to user. | |
3186 | ||
f6b81482 | 3187 | $aclPermissionedTasks = [ |
9bb77b8e TO |
3188 | 'view-contact', |
3189 | 'edit-contact', | |
3190 | 'new-activity', | |
3191 | 'new-email', | |
3192 | 'group-add-contact', | |
3193 | 'tag-contact', | |
3194 | 'delete-contact', | |
f6b81482 | 3195 | ]; |
6a488035 TO |
3196 | $corePermission = CRM_Core_Permission::getPermission(); |
3197 | ||
f6b81482 | 3198 | $contextMenu = []; |
9309f5c6 | 3199 | foreach ($menu as $key => $values) { |
f6b81482 | 3200 | if ($key !== 'otherActions') { |
6a488035 | 3201 | |
1fb73100 | 3202 | // user does not have necessary permissions. |
9309f5c6 | 3203 | if (!self::checkUserMenuPermissions($aclPermissionedTasks, $corePermission, $values)) { |
1fb73100 E |
3204 | continue; |
3205 | } | |
1fb73100 | 3206 | // build directly accessible action menu. |
f6b81482 | 3207 | if (in_array($values['ref'], [ |
1fb73100 E |
3208 | 'view-contact', |
3209 | 'edit-contact', | |
f6b81482 | 3210 | ])) { |
3211 | $contextMenu['primaryActions'][$key] = [ | |
1fb73100 E |
3212 | 'title' => $values['title'], |
3213 | 'ref' => $values['ref'], | |
6b409353 | 3214 | 'class' => $values['class'] ?? NULL, |
1fb73100 | 3215 | 'key' => $values['key'], |
f6b81482 | 3216 | ]; |
1fb73100 E |
3217 | continue; |
3218 | } | |
3219 | ||
3220 | // finally get menu item for -more- action widget. | |
f6b81482 | 3221 | $contextMenu['moreActions'][$values['weight']] = [ |
6a488035 TO |
3222 | 'title' => $values['title'], |
3223 | 'ref' => $values['ref'], | |
6b409353 CW |
3224 | 'href' => $values['href'] ?? NULL, |
3225 | 'tab' => $values['tab'] ?? NULL, | |
3226 | 'class' => $values['class'] ?? NULL, | |
6a488035 | 3227 | 'key' => $values['key'], |
f6b81482 | 3228 | ]; |
6a488035 | 3229 | } |
9309f5c6 E |
3230 | else { |
3231 | foreach ($values as $value) { | |
3232 | // user does not have necessary permissions. | |
3233 | if (!self::checkUserMenuPermissions($aclPermissionedTasks, $corePermission, $value)) { | |
3234 | continue; | |
3235 | } | |
3236 | ||
3237 | // finally get menu item for -more- action widget. | |
f6b81482 | 3238 | $contextMenu['otherActions'][$value['weight']] = [ |
9309f5c6 E |
3239 | 'title' => $value['title'], |
3240 | 'ref' => $value['ref'], | |
6b409353 CW |
3241 | 'href' => $value['href'] ?? NULL, |
3242 | 'tab' => $value['tab'] ?? NULL, | |
3243 | 'class' => $value['class'] ?? NULL, | |
3244 | 'icon' => $value['icon'] ?? NULL, | |
9309f5c6 | 3245 | 'key' => $value['key'], |
f6b81482 | 3246 | ]; |
9309f5c6 E |
3247 | } |
3248 | } | |
6a488035 TO |
3249 | } |
3250 | ||
3251 | ksort($contextMenu['moreActions']); | |
1fb73100 | 3252 | ksort($contextMenu['otherActions']); |
6a488035 TO |
3253 | |
3254 | return $contextMenu; | |
3255 | } | |
3256 | ||
9309f5c6 E |
3257 | /** |
3258 | * Check if user has permissions to access items in action menu. | |
3259 | * | |
3260 | * @param array $aclPermissionedTasks | |
3261 | * Array containing ACL related tasks. | |
3262 | * @param string $corePermission | |
3263 | * The permission of the user (edit or view or null). | |
3264 | * @param array $menuOptions | |
3265 | * Array containing params of the menu (title, href, etc). | |
3266 | * | |
3267 | * @return bool | |
3268 | * TRUE if user has all permissions, FALSE if otherwise. | |
3269 | */ | |
3270 | public static function checkUserMenuPermissions($aclPermissionedTasks, $corePermission, $menuOptions) { | |
f748c073 | 3271 | $componentName = $menuOptions['component'] ?? NULL; |
9309f5c6 E |
3272 | |
3273 | // if component action - make sure component is enable. | |
3274 | if ($componentName && !in_array($componentName, CRM_Core_Config::singleton()->enableComponents)) { | |
3275 | return FALSE; | |
3276 | } | |
3277 | ||
3278 | // make sure user has all required permissions. | |
3279 | $hasAllPermissions = FALSE; | |
3280 | ||
f748c073 | 3281 | $permissions = $menuOptions['permissions'] ?? NULL; |
9309f5c6 E |
3282 | if (!is_array($permissions) || empty($permissions)) { |
3283 | $hasAllPermissions = TRUE; | |
3284 | } | |
3285 | ||
3286 | // iterate for required permissions in given permissions array. | |
3287 | if (!$hasAllPermissions) { | |
3288 | $hasPermissions = 0; | |
3289 | foreach ($permissions as $permission) { | |
3290 | if (CRM_Core_Permission::check($permission)) { | |
3291 | $hasPermissions++; | |
3292 | } | |
3293 | } | |
3294 | ||
3295 | if (count($permissions) == $hasPermissions) { | |
3296 | $hasAllPermissions = TRUE; | |
3297 | } | |
3298 | ||
3299 | // if still user does not have required permissions, check acl. | |
f6b81482 | 3300 | if (!$hasAllPermissions && $menuOptions['ref'] !== 'delete-contact') { |
c2463857 | 3301 | if (in_array($menuOptions['ref'], $aclPermissionedTasks) && |
f6b81482 | 3302 | $corePermission == CRM_Core_Permission::EDIT |
3303 | ) { | |
9309f5c6 E |
3304 | $hasAllPermissions = TRUE; |
3305 | } | |
f6b81482 | 3306 | elseif (in_array($menuOptions['ref'], [ |
9309f5c6 | 3307 | 'new-email', |
f6b81482 | 3308 | ])) { |
9309f5c6 E |
3309 | // grant permissions for these tasks. |
3310 | $hasAllPermissions = TRUE; | |
3311 | } | |
3312 | } | |
3313 | } | |
3314 | ||
3315 | return $hasAllPermissions; | |
3316 | } | |
3317 | ||
6a488035 | 3318 | /** |
567b2076 EM |
3319 | * Retrieve display name of contact that address is shared. |
3320 | * | |
3321 | * This is based on $masterAddressId or $contactId . | |
6a488035 | 3322 | * |
77c5b619 TO |
3323 | * @param int $masterAddressId |
3324 | * Master id. | |
3325 | * @param int $contactId | |
77544f6f | 3326 | * Contact id. (deprecated - do not use) |
6a488035 | 3327 | * |
72b3a70c CW |
3328 | * @return string|null |
3329 | * the found display name or null. | |
6a488035 | 3330 | */ |
00be9182 | 3331 | public static function getMasterDisplayName($masterAddressId = NULL, $contactId = NULL) { |
6a488035 | 3332 | $masterDisplayName = NULL; |
77544f6f | 3333 | if (!$masterAddressId) { |
6a488035 TO |
3334 | return $masterDisplayName; |
3335 | } | |
3336 | ||
77544f6f | 3337 | $sql = " |
6a488035 TO |
3338 | SELECT display_name from civicrm_contact |
3339 | LEFT JOIN civicrm_address ON ( civicrm_address.contact_id = civicrm_contact.id ) | |
3340 | WHERE civicrm_address.id = " . $masterAddressId; | |
6a488035 TO |
3341 | |
3342 | $masterDisplayName = CRM_Core_DAO::singleValueQuery($sql); | |
3343 | return $masterDisplayName; | |
3344 | } | |
3345 | ||
3346 | /** | |
567b2076 | 3347 | * Get the creation/modification times for a contact. |
6a488035 | 3348 | * |
100fef9d | 3349 | * @param int $contactId |
77b97be7 | 3350 | * |
567b2076 | 3351 | * @return array |
5c766a0b | 3352 | * Dates - ('created_date' => $, 'modified_date' => $) |
77b97be7 | 3353 | */ |
00be9182 | 3354 | public static function getTimestamps($contactId) { |
6a488035 TO |
3355 | $timestamps = CRM_Core_DAO::executeQuery( |
3356 | 'SELECT created_date, modified_date | |
3357 | FROM civicrm_contact | |
3358 | WHERE id = %1', | |
f6b81482 | 3359 | [ |
3360 | 1 => [$contactId, 'Integer'], | |
3361 | ] | |
6a488035 TO |
3362 | ); |
3363 | if ($timestamps->fetch()) { | |
f6b81482 | 3364 | return [ |
6a488035 TO |
3365 | 'created_date' => $timestamps->created_date, |
3366 | 'modified_date' => $timestamps->modified_date, | |
f6b81482 | 3367 | ]; |
6a488035 TO |
3368 | } |
3369 | else { | |
3370 | return NULL; | |
3371 | } | |
3372 | } | |
3373 | ||
3374 | /** | |
db7de9c1 | 3375 | * Get a list of triggers for the contact table. |
6a488035 | 3376 | * |
2e2605fe EM |
3377 | * @param $info |
3378 | * @param null $tableName | |
f6b81482 | 3379 | * |
3380 | * @see http://issues.civicrm.org/jira/browse/CRM-10554 | |
3381 | * | |
3382 | * @see hook_civicrm_triggerInfo | |
3383 | * @see CRM_Core_DAO::triggerRebuild | |
6a488035 | 3384 | */ |
00be9182 | 3385 | public static function triggerInfo(&$info, $tableName = NULL) { |
6a488035 | 3386 | |
6050e9ad TO |
3387 | // Modifications to these records should update the contact timestamps. |
3388 | \Civi\Core\SqlTrigger\TimestampTriggers::create('civicrm_contact', 'Contact') | |
f6b81482 | 3389 | ->setRelations([ |
3390 | ['table' => 'civicrm_address', 'column' => 'contact_id'], | |
3391 | ['table' => 'civicrm_email', 'column' => 'contact_id'], | |
3392 | ['table' => 'civicrm_im', 'column' => 'contact_id'], | |
3393 | ['table' => 'civicrm_phone', 'column' => 'contact_id'], | |
3394 | ['table' => 'civicrm_website', 'column' => 'contact_id'], | |
3395 | ]) | |
6050e9ad | 3396 | ->alterTriggerInfo($info, $tableName); |
6a488035 TO |
3397 | |
3398 | // Update phone table to populate phone_numeric field | |
3399 | if (!$tableName || $tableName == 'civicrm_phone') { | |
3400 | // Define stored sql function needed for phones | |
1b31daf6 | 3401 | $sqlTriggers = Civi::service('sql_triggers'); |
3402 | $sqlTriggers->enqueueQuery(self::DROP_STRIP_FUNCTION_43); | |
3403 | $sqlTriggers->enqueueQuery(self::CREATE_STRIP_FUNCTION_43); | |
f6b81482 | 3404 | $info[] = [ |
3405 | 'table' => ['civicrm_phone'], | |
6a488035 | 3406 | 'when' => 'BEFORE', |
f6b81482 | 3407 | 'event' => ['INSERT', 'UPDATE'], |
6a488035 | 3408 | 'sql' => "\nSET NEW.phone_numeric = civicrm_strip_non_numeric(NEW.phone);\n", |
f6b81482 | 3409 | ]; |
6a488035 TO |
3410 | } |
3411 | } | |
3412 | ||
3413 | /** | |
db7de9c1 | 3414 | * Check if contact is being used in civicrm_domain based on $contactId. |
6a488035 | 3415 | * |
77c5b619 TO |
3416 | * @param int $contactId |
3417 | * Contact id. | |
6a488035 | 3418 | * |
a6c01b45 CW |
3419 | * @return bool |
3420 | * true if present else false. | |
6a488035 | 3421 | */ |
00be9182 | 3422 | public static function checkDomainContact($contactId) { |
db7de9c1 | 3423 | if (!$contactId) { |
6a488035 | 3424 | return FALSE; |
db7de9c1 | 3425 | } |
9bb77b8e | 3426 | $domainId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Domain', $contactId, 'id', 'contact_id'); |
6a488035 TO |
3427 | |
3428 | if ($domainId) { | |
3429 | return TRUE; | |
9bb77b8e TO |
3430 | } |
3431 | else { | |
6a488035 TO |
3432 | return FALSE; |
3433 | } | |
3434 | } | |
12445e1c | 3435 | |
dc86f881 CW |
3436 | /** |
3437 | * Get options for a given contact field. | |
db7de9c1 | 3438 | * |
77c5b619 TO |
3439 | * @param string $fieldName |
3440 | * @param string $context | |
77c5b619 | 3441 | * @param array $props |
16b10e64 | 3442 | * whatever is known about this dao object. |
77b97be7 | 3443 | * |
5c766a0b | 3444 | * @return array|bool |
f6b81482 | 3445 | * @see CRM_Core_DAO::buildOptions |
3446 | * | |
3447 | * TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow? | |
3448 | * TODO: In context of chainselect, what to return if e.g. a country has no states? | |
3449 | * | |
3450 | * @see CRM_Core_DAO::buildOptionsContext | |
dc86f881 | 3451 | */ |
f6b81482 | 3452 | public static function buildOptions($fieldName, $context = NULL, $props = []) { |
3453 | $params = []; | |
dc86f881 CW |
3454 | // Special logic for fields whose options depend on context or properties |
3455 | switch ($fieldName) { | |
3456 | case 'contact_sub_type': | |
3457 | if (!empty($props['contact_type'])) { | |
3458 | $params['condition'] = "parent_id = (SELECT id FROM civicrm_contact_type WHERE name='{$props['contact_type']}')"; | |
3459 | } | |
3460 | break; | |
ea100cb5 | 3461 | |
bee6039a CW |
3462 | case 'contact_type': |
3463 | if ($context == 'search') { | |
76773c5a CW |
3464 | // CRM-15495 - EntityRef filters and basic search forms expect this format |
3465 | // FIXME: Search builder does not | |
bee6039a CW |
3466 | return CRM_Contact_BAO_ContactType::getSelectElements(); |
3467 | } | |
3468 | break; | |
985f4890 CW |
3469 | |
3470 | // The contact api supports some related entities so we'll honor that by fetching their options | |
3471 | case 'group_id': | |
3472 | case 'group': | |
3473 | return CRM_Contact_BAO_GroupContact::buildOptions('group_id', $context, $props); | |
3474 | ||
3475 | case 'tag_id': | |
3476 | case 'tag': | |
3477 | $props['entity_table'] = 'civicrm_contact'; | |
3478 | return CRM_Core_BAO_EntityTag::buildOptions('tag_id', $context, $props); | |
3479 | ||
3493947a | 3480 | case 'state_province_id': |
d0bfb983 | 3481 | case 'state_province': |
3482 | case 'state_province_name': | |
3493947a | 3483 | case 'country_id': |
d0bfb983 | 3484 | case 'country': |
3493947a | 3485 | case 'county_id': |
3486 | case 'worldregion': | |
3487 | case 'worldregion_id': | |
3488 | return CRM_Core_BAO_Address::buildOptions($fieldName, 'get', $props); | |
3489 | ||
dc86f881 | 3490 | } |
786ad6e1 | 3491 | return CRM_Core_PseudoConstant::get(__CLASS__, $fieldName, $params, $context); |
dc86f881 | 3492 | } |
1071730c | 3493 | |
12445e1c | 3494 | /** |
db7de9c1 EM |
3495 | * Delete a contact-related object that has an 'is_primary' field. |
3496 | * | |
12445e1c CW |
3497 | * Ensures that is_primary gets assigned to another object if available |
3498 | * Also calls pre/post hooks | |
3499 | * | |
f47539f6 | 3500 | * @param string $type |
3501 | * @param int $id | |
f6b81482 | 3502 | * |
77b97be7 | 3503 | * @return bool |
12445e1c CW |
3504 | */ |
3505 | public static function deleteObjectWithPrimary($type, $id) { | |
3506 | if (!$id || !is_numeric($id)) { | |
a65e2e55 | 3507 | return FALSE; |
12445e1c CW |
3508 | } |
3509 | $daoName = "CRM_Core_DAO_$type"; | |
3510 | $obj = new $daoName(); | |
3511 | $obj->id = $id; | |
3512 | $obj->find(); | |
31bdda9e | 3513 | $hookParams = []; |
12445e1c | 3514 | if ($obj->fetch()) { |
31bdda9e | 3515 | CRM_Utils_Hook::pre('delete', $type, $id, $hookParams); |
12445e1c CW |
3516 | $contactId = $obj->contact_id; |
3517 | $obj->delete(); | |
3518 | } | |
3519 | else { | |
a65e2e55 | 3520 | return FALSE; |
12445e1c | 3521 | } |
50fa40e8 CW |
3522 | // is_primary is only relavent if this field belongs to a contact |
3523 | if ($contactId) { | |
3524 | $dao = new $daoName(); | |
3525 | $dao->contact_id = $contactId; | |
3526 | $dao->is_primary = 1; | |
3527 | // Pick another record to be primary (if one isn't already) | |
3528 | if (!$dao->find(TRUE)) { | |
3529 | $dao->is_primary = 0; | |
3530 | $dao->find(); | |
3531 | if ($dao->fetch()) { | |
3532 | $dao->is_primary = 1; | |
3533 | $dao->save(); | |
3534 | } | |
3535 | } | |
12445e1c | 3536 | } |
12445e1c | 3537 | CRM_Utils_Hook::post('delete', $type, $id, $obj); |
a65e2e55 | 3538 | return TRUE; |
12445e1c | 3539 | } |
96025800 | 3540 | |
d343069c CW |
3541 | /** |
3542 | * @inheritDoc | |
3543 | */ | |
20e41014 | 3544 | public function addSelectWhereClause() { |
0b80f0b4 CW |
3545 | // We always return an array with these keys, even if they are empty, |
3546 | // because this tells the query builder that we have considered these fields for acls | |
f6b81482 | 3547 | $clauses = [ |
0b80f0b4 | 3548 | 'id' => (array) CRM_Contact_BAO_Contact_Permission::cacheSubquery(), |
f6b81482 | 3549 | 'is_deleted' => CRM_Core_Permission::check('access deleted contacts') ? [] : ['!= 1'], |
3550 | ]; | |
032346cc CW |
3551 | CRM_Utils_Hook::selectWhereClause($this, $clauses); |
3552 | return $clauses; | |
d343069c CW |
3553 | } |
3554 | ||
fedc3428 | 3555 | /** |
3556 | * Get any existing duplicate contacts based on the input parameters. | |
3557 | * | |
3558 | * @param array $input | |
3559 | * Input parameters to be matched. | |
3560 | * @param string $contactType | |
3561 | * @param string $rule | |
3562 | * - Supervised | |
3563 | * - Unsupervised | |
3564 | * @param $excludedContactIDs | |
3565 | * An array of ids not to be included in the results. | |
3566 | * @param bool $checkPermissions | |
3567 | * @param int $ruleGroupID | |
3568 | * ID of the rule group to be used if an override is desirable. | |
b8cb7e46 MWMC |
3569 | * @param array $contextParams |
3570 | * The context if relevant, eg. ['event_id' => X] | |
fedc3428 | 3571 | * |
3572 | * @return array | |
3573 | */ | |
b8cb7e46 | 3574 | public static function getDuplicateContacts($input, $contactType, $rule = 'Unsupervised', $excludedContactIDs = [], $checkPermissions = TRUE, $ruleGroupID = NULL, $contextParams = []) { |
fedc3428 | 3575 | $dedupeParams = CRM_Dedupe_Finder::formatParams($input, $contactType); |
3576 | $dedupeParams['check_permission'] = $checkPermissions; | |
b8cb7e46 MWMC |
3577 | $dedupeParams['contact_type'] = $contactType; |
3578 | $dedupeParams['rule'] = $rule; | |
3579 | $dedupeParams['rule_group_id'] = $ruleGroupID; | |
3580 | $dedupeParams['excluded_contact_ids'] = $excludedContactIDs; | |
3581 | $dedupeResults['ids'] = []; | |
3582 | $dedupeResults['handled'] = FALSE; | |
3583 | CRM_Utils_Hook::findDuplicates($dedupeParams, $dedupeResults, $contextParams); | |
3584 | if (!$dedupeResults['handled']) { | |
3585 | $dedupeResults['ids'] = CRM_Dedupe_Finder::dupesByParams($dedupeParams, $contactType, $rule, $excludedContactIDs, $ruleGroupID); | |
3586 | } | |
3587 | return $dedupeResults['ids']; | |
fedc3428 | 3588 | } |
3589 | ||
3590 | /** | |
3591 | * Get the first duplicate contacts based on the input parameters. | |
3592 | * | |
3593 | * @param array $input | |
3594 | * Input parameters to be matched. | |
3595 | * @param string $contactType | |
3596 | * @param string $rule | |
3597 | * - Supervised | |
3598 | * - Unsupervised | |
3599 | * @param $excludedContactIDs | |
3600 | * An array of ids not to be included in the results. | |
3601 | * @param bool $checkPermissions | |
3602 | * @param int $ruleGroupID | |
3603 | * ID of the rule group to be used if an override is desirable. | |
b8cb7e46 MWMC |
3604 | * @param array $contextParams |
3605 | * The context if relevant, eg. ['event_id' => X] | |
fedc3428 | 3606 | * |
e97c66ff | 3607 | * @return int|null |
fedc3428 | 3608 | */ |
b8cb7e46 MWMC |
3609 | public static function getFirstDuplicateContact($input, $contactType, $rule = 'Unsupervised', $excludedContactIDs = [], $checkPermissions = TRUE, $ruleGroupID = NULL, $contextParams = []) { |
3610 | $ids = self::getDuplicateContacts($input, $contactType, $rule, $excludedContactIDs, $checkPermissions, $ruleGroupID, $contextParams); | |
fedc3428 | 3611 | if (empty($ids)) { |
3612 | return NULL; | |
3613 | } | |
3614 | return $ids[0]; | |
3615 | } | |
3616 | ||
6ebecfea | 3617 | /** |
3618 | * Check if a field is associated with an entity that has a location type. | |
3619 | * | |
3620 | * (ie. is an address, phone, email etc field). | |
3621 | * | |
3622 | * @param string $fieldTitle | |
3623 | * Title of the field (not the name - create a new function for that if required). | |
3624 | * | |
3625 | * @return bool | |
3626 | */ | |
3627 | public static function isFieldHasLocationType($fieldTitle) { | |
3628 | foreach (CRM_Contact_BAO_Contact::importableFields() as $key => $field) { | |
3629 | if ($field['title'] === $fieldTitle) { | |
914d3734 | 3630 | return $field['hasLocationType'] ?? NULL; |
6ebecfea | 3631 | } |
3632 | } | |
3633 | return FALSE; | |
3634 | } | |
3635 | ||
8dbd6052 | 3636 | /** |
e695ee7c CW |
3637 | * @param array $appendProfiles |
3638 | * Name of profile(s) to append to each link. | |
8dbd6052 | 3639 | * |
e695ee7c | 3640 | * @return array |
8dbd6052 | 3641 | */ |
e695ee7c CW |
3642 | public static function getEntityRefCreateLinks($appendProfiles = []) { |
3643 | // You'd think that "create contacts" would be the permission to check, | |
3644 | // But new contact popups are profile forms and those use their own permissions. | |
3645 | if (!CRM_Core_Permission::check([['profile create', 'profile listings and forms']])) { | |
3646 | return FALSE; | |
3647 | } | |
3648 | $profiles = []; | |
3649 | foreach (CRM_Contact_BAO_ContactType::basicTypes() as $contactType) { | |
3650 | $profiles[] = 'new_' . strtolower($contactType); | |
3651 | } | |
3652 | $retrieved = civicrm_api3('uf_group', 'get', [ | |
3653 | 'name' => ['IN' => array_merge($profiles, (array) $appendProfiles)], | |
3654 | 'is_active' => 1, | |
3655 | ]); | |
3656 | $links = $append = []; | |
3657 | if (!empty($retrieved['values'])) { | |
3658 | $icons = [ | |
3659 | 'individual' => 'fa-user', | |
3660 | 'organization' => 'fa-building', | |
3661 | 'household' => 'fa-home', | |
3662 | ]; | |
3663 | foreach ($retrieved['values'] as $id => $profile) { | |
3664 | if (in_array($profile['name'], $profiles)) { | |
f6b81482 | 3665 | $links[] = [ |
e695ee7c CW |
3666 | 'label' => $profile['title'], |
3667 | 'url' => CRM_Utils_System::url('civicrm/profile/create', "reset=1&context=dialog&gid=$id", | |
3668 | NULL, NULL, FALSE, FALSE, TRUE), | |
3669 | 'type' => ucfirst(str_replace('new_', '', $profile['name'])), | |
fdb6d23b | 3670 | 'icon' => $icons[str_replace('new_', '', $profile['name'])] ?? NULL, |
f6b81482 | 3671 | ]; |
e695ee7c CW |
3672 | } |
3673 | else { | |
3674 | $append[] = $id; | |
3675 | } | |
3676 | } | |
3677 | foreach ($append as $id) { | |
3678 | foreach ($links as &$link) { | |
3679 | $link['url'] .= ",$id"; | |
3680 | } | |
3681 | } | |
3682 | } | |
3683 | return $links; | |
8dbd6052 CW |
3684 | } |
3685 | ||
1d6f94ab CW |
3686 | /** |
3687 | * @return array | |
3688 | */ | |
3689 | public static function getEntityRefFilters() { | |
3690 | return [ | |
3691 | ['key' => 'contact_type', 'value' => ts('Contact Type')], | |
2229cf4f CW |
3692 | ['key' => 'group', 'value' => ts('Group'), 'entity' => 'GroupContact'], |
3693 | ['key' => 'tag', 'value' => ts('Tag'), 'entity' => 'EntityTag'], | |
ffeb940d | 3694 | ['key' => 'city', 'value' => ts('City'), 'type' => 'text', 'entity' => 'Address'], |
3695 | ['key' => 'postal_code', 'value' => ts('Postal Code'), 'type' => 'text', 'entity' => 'Address'], | |
2229cf4f CW |
3696 | ['key' => 'state_province', 'value' => ts('State/Province'), 'entity' => 'Address'], |
3697 | ['key' => 'country', 'value' => ts('Country'), 'entity' => 'Address'], | |
24e58348 | 3698 | ['key' => 'first_name', 'value' => ts('First Name'), 'type' => 'text', 'condition' => ['contact_type' => 'Individual']], |
3699 | ['key' => 'last_name', 'value' => ts('Last Name'), 'type' => 'text', 'condition' => ['contact_type' => 'Individual']], | |
3700 | ['key' => 'nick_name', 'value' => ts('Nick Name'), 'type' => 'text', 'condition' => ['contact_type' => 'Individual']], | |
3701 | ['key' => 'organization_name', 'value' => ts('Employer name'), 'type' => 'text', 'condition' => ['contact_type' => 'Individual']], | |
1d6f94ab CW |
3702 | ['key' => 'gender_id', 'value' => ts('Gender'), 'condition' => ['contact_type' => 'Individual']], |
3703 | ['key' => 'is_deceased', 'value' => ts('Deceased'), 'condition' => ['contact_type' => 'Individual']], | |
3704 | ['key' => 'contact_id', 'value' => ts('Contact ID'), 'type' => 'text'], | |
3705 | ['key' => 'external_identifier', 'value' => ts('External ID'), 'type' => 'text'], | |
3706 | ['key' => 'source', 'value' => ts('Contact Source'), 'type' => 'text'], | |
3707 | ]; | |
3708 | } | |
3709 | ||
6a488035 | 3710 | } |