3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * These functions have been deprecated out of API v3 Utils folder as they are not part of the
20 * API. Calling API functions directly is not supported & these functions are not called by any
21 * part of the API so are not really part of the api
25 require_once 'api/v3/utils.php';
28 * Check duplicate contacts based on de-dupe parameters.
30 * @param array $params
34 function _civicrm_api3_deprecated_check_contact_dedupe($params) {
35 static $cIndieFields = NULL;
36 static $defaultLocationId = NULL;
38 $contactType = $params['contact_type'];
39 if ($cIndieFields == NULL) {
40 require_once 'CRM/Contact/BAO/Contact.php';
41 $cTempIndieFields = CRM_Contact_BAO_Contact
::importableFields($contactType);
42 $cIndieFields = $cTempIndieFields;
44 require_once "CRM/Core/BAO/LocationType.php";
45 $defaultLocation = CRM_Core_BAO_LocationType
::getDefault();
47 // set the value to default location id else set to 1
48 if (!$defaultLocationId = (int) $defaultLocation->id
) {
49 $defaultLocationId = 1;
53 require_once 'CRM/Contact/BAO/Query.php';
54 $locationFields = CRM_Contact_BAO_Query
::$_locationSpecificFields;
56 $contactFormatted = [];
57 foreach ($params as $key => $field) {
58 if ($field == NULL ||
$field === '') {
61 // CRM-17040, Considering only primary contact when importing contributions. So contribution inserts into primary contact
62 // instead of soft credit contact.
63 if (is_array($field) && $key != "soft_credit") {
64 foreach ($field as $value) {
66 if (is_array($value)) {
67 foreach ($value as $name => $testForEmpty) {
68 if ($name !== 'phone_type' &&
69 ($testForEmpty === '' ||
$testForEmpty == NULL)
80 _civicrm_api3_deprecated_add_formatted_param($value, $contactFormatted);
86 $value = [$key => $field];
88 // check if location related field, then we need to add primary location type
89 if (in_array($key, $locationFields)) {
90 $value['location_type_id'] = $defaultLocationId;
92 elseif (array_key_exists($key, $cIndieFields)) {
93 $value['contact_type'] = $contactType;
96 _civicrm_api3_deprecated_add_formatted_param($value, $contactFormatted);
99 $contactFormatted['contact_type'] = $contactType;
101 return _civicrm_api3_deprecated_duplicate_formatted_contact($contactFormatted);
105 * take the input parameter list as specified in the data model and
106 * convert it into the same format that we use in QF and BAO object
108 * @param array $params
109 * Associative array of property name/value.
110 * pairs to insert in new contact.
111 * @param array $values
112 * The reformatted properties that we can use internally.
114 * @param array|bool $create Is the formatted Values array going to
115 * be used for CRM_Activity_BAO_Activity::create()
117 * @return array|CRM_Error
119 function _civicrm_api3_deprecated_activity_formatted_param(&$params, &$values, $create = FALSE) {
120 // copy all the activity fields as is
121 $fields = CRM_Activity_DAO_Activity
::fields();
122 _civicrm_api3_store_values($fields, $params, $values);
124 require_once 'CRM/Core/OptionGroup.php';
125 $customFields = CRM_Core_BAO_CustomField
::getFields('Activity');
127 foreach ($params as $key => $value) {
128 // ignore empty values or empty arrays etc
129 if (CRM_Utils_System
::isNull($value)) {
133 //Handling Custom Data
134 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
135 $values[$key] = $value;
136 $type = $customFields[$customFieldID]['html_type'];
137 if (CRM_Core_BAO_CustomField
::isSerialized($customFields[$customFieldID])) {
138 $values[$key] = CRM_Import_Parser
::unserializeCustomValue($customFieldID, $value, $type);
140 elseif ($type == 'Select' ||
$type == 'Radio') {
141 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
142 foreach ($customOption as $customFldID => $customValue) {
143 $val = $customValue['value'] ??
NULL;
144 $label = $customValue['label'] ??
NULL;
145 $label = strtolower($label);
146 $value = strtolower(trim($value));
147 if (($value == $label) ||
($value == strtolower($val))) {
148 $values[$key] = $val;
154 if ($key == 'target_contact_id') {
155 if (!CRM_Utils_Rule
::integer($value)) {
156 return civicrm_api3_create_error("contact_id not valid: $value");
158 $contactID = CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_contact WHERE id = $value");
160 return civicrm_api3_create_error("Invalid Contact ID: There is no contact record with contact_id = $value.");
168 * This function adds the contact variable in $values to the
169 * parameter list $params. For most cases, $values should have length 1. If
170 * the variable being added is a child of Location, a location_type_id must
171 * also be included. If it is a child of phone, a phone_type must be included.
173 * @param array $values
174 * The variable(s) to be added.
175 * @param array $params
176 * The structured parameter list.
178 * @return bool|CRM_Utils_Error
180 function _civicrm_api3_deprecated_add_formatted_param(&$values, &$params) {
181 // Crawl through the possible classes:
194 // Cache the various object fields
195 static $fields = NULL;
197 if ($fields == NULL) {
201 // first add core contact values since for other Civi modules they are not added
202 require_once 'CRM/Contact/BAO/Contact.php';
203 $contactFields = CRM_Contact_DAO_Contact
::fields();
204 _civicrm_api3_store_values($contactFields, $values, $params);
206 if (isset($values['contact_type'])) {
207 // we're an individual/household/org property
209 $fields[$values['contact_type']] = CRM_Contact_DAO_Contact
::fields();
211 _civicrm_api3_store_values($fields[$values['contact_type']], $values, $params);
215 if (isset($values['individual_prefix'])) {
216 if (!empty($params['prefix_id'])) {
217 $prefixes = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'prefix_id');
218 $params['prefix'] = $prefixes[$params['prefix_id']];
221 $params['prefix'] = $values['individual_prefix'];
226 if (isset($values['individual_suffix'])) {
227 if (!empty($params['suffix_id'])) {
228 $suffixes = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'suffix_id');
229 $params['suffix'] = $suffixes[$params['suffix_id']];
232 $params['suffix'] = $values['individual_suffix'];
238 if (isset($values['email_greeting'])) {
239 if (!empty($params['email_greeting_id'])) {
240 $emailGreetingFilter = [
241 'contact_type' => $params['contact_type'] ??
NULL,
242 'greeting_type' => 'email_greeting',
244 $emailGreetings = CRM_Core_PseudoConstant
::greeting($emailGreetingFilter);
245 $params['email_greeting'] = $emailGreetings[$params['email_greeting_id']];
248 $params['email_greeting'] = $values['email_greeting'];
254 if (isset($values['postal_greeting'])) {
255 if (!empty($params['postal_greeting_id'])) {
256 $postalGreetingFilter = [
257 'contact_type' => $params['contact_type'] ??
NULL,
258 'greeting_type' => 'postal_greeting',
260 $postalGreetings = CRM_Core_PseudoConstant
::greeting($postalGreetingFilter);
261 $params['postal_greeting'] = $postalGreetings[$params['postal_greeting_id']];
264 $params['postal_greeting'] = $values['postal_greeting'];
269 if (isset($values['addressee'])) {
270 if (!empty($params['addressee_id'])) {
272 'contact_type' => $params['contact_type'] ??
NULL,
273 'greeting_type' => 'addressee',
275 $addressee = CRM_Core_PseudoConstant
::addressee($addresseeFilter);
276 $params['addressee'] = $addressee[$params['addressee_id']];
279 $params['addressee'] = $values['addressee'];
284 if (isset($values['gender'])) {
285 if (!empty($params['gender_id'])) {
286 $genders = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id');
287 $params['gender'] = $genders[$params['gender_id']];
290 $params['gender'] = $values['gender'];
295 if (!empty($values['preferred_communication_method'])) {
297 $pcm = array_change_key_case(array_flip(CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method')), CASE_LOWER
);
299 $preffComm = explode(',', $values['preferred_communication_method']);
300 foreach ($preffComm as $v) {
301 $v = strtolower(trim($v));
302 if (array_key_exists($v, $pcm)) {
307 $params['preferred_communication_method'] = $comm;
311 // format the website params.
312 if (!empty($values['url'])) {
313 static $websiteFields;
314 if (!is_array($websiteFields)) {
315 require_once 'CRM/Core/DAO/Website.php';
316 $websiteFields = CRM_Core_DAO_Website
::fields();
318 if (!array_key_exists('website', $params) ||
319 !is_array($params['website'])
321 $params['website'] = [];
324 $websiteCount = count($params['website']);
325 _civicrm_api3_store_values($websiteFields, $values,
326 $params['website'][++
$websiteCount]
332 // get the formatted location blocks into params - w/ 3.0 format, CRM-4605
333 if (!empty($values['location_type_id'])) {
334 static $fields = NULL;
335 if ($fields == NULL) {
346 $name = strtolower($block);
347 if (!array_key_exists($name, $values)) {
351 if ($name == 'phone_ext') {
355 // block present in value array.
356 if (!array_key_exists($name, $params) ||
!is_array($params[$name])) {
360 if (!array_key_exists($block, $fields)) {
361 $className = "CRM_Core_DAO_$block";
362 $fields[$block] =& $className::fields();
365 $blockCnt = count($params[$name]);
367 // copy value to dao field name.
369 $values['name'] = $values[$name];
372 _civicrm_api3_store_values($fields[$block], $values,
373 $params[$name][++
$blockCnt]
376 if (empty($params['id']) && ($blockCnt == 1)) {
377 $params[$name][$blockCnt]['is_primary'] = TRUE;
380 // we only process single block at a time.
384 // handle address fields.
385 if (!array_key_exists('address', $params) ||
!is_array($params['address'])) {
386 $params['address'] = [];
390 foreach ($params['address'] as $cnt => $addressBlock) {
391 if (CRM_Utils_Array
::value('location_type_id', $values) ==
392 CRM_Utils_Array
::value('location_type_id', $addressBlock)
400 if (!array_key_exists('Address', $fields)) {
401 $fields['Address'] = CRM_Core_DAO_Address
::fields();
404 // Note: we doing multiple value formatting here for address custom fields, plus putting into right format.
405 // The actual formatting (like date, country ..etc) for address custom fields is taken care of while saving
406 // the address in CRM_Core_BAO_Address::create method
407 if (!empty($values['location_type_id'])) {
408 static $customFields = [];
409 if (empty($customFields)) {
410 $customFields = CRM_Core_BAO_CustomField
::getFields('Address');
412 // make a copy of values, as we going to make changes
413 $newValues = $values;
414 foreach ($values as $key => $val) {
415 $customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key);
416 if ($customFieldID && array_key_exists($customFieldID, $customFields)) {
417 // mark an entry in fields array since we want the value of custom field to be copied
418 $fields['Address'][$key] = NULL;
420 $htmlType = $customFields[$customFieldID]['html_type'] ??
NULL;
421 if (CRM_Core_BAO_CustomField
::isSerialized($customFields[$customFieldID]) && $val) {
422 $mulValues = explode(',', $val);
423 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
424 $newValues[$key] = [];
425 foreach ($mulValues as $v1) {
426 foreach ($customOption as $v2) {
427 if ((strtolower($v2['label']) == strtolower(trim($v1))) ||
428 (strtolower($v2['value']) == strtolower(trim($v1)))
430 if ($htmlType == 'CheckBox') {
431 $newValues[$key][$v2['value']] = 1;
434 $newValues[$key][] = $v2['value'];
442 // consider new values
443 $values = $newValues;
446 _civicrm_api3_store_values($fields['Address'], $values, $params['address'][$addressCnt]);
452 'supplemental_address_1',
453 'supplemental_address_2',
454 'supplemental_address_3',
455 'StateProvince.name',
458 foreach ($addressFields as $field) {
459 if (array_key_exists($field, $values)) {
460 if (!array_key_exists('address', $params)) {
461 $params['address'] = [];
463 $params['address'][$addressCnt][$field] = $values[$field];
467 if ($addressCnt == 1) {
469 $params['address'][$addressCnt]['is_primary'] = TRUE;
474 if (isset($values['note'])) {
476 if (!isset($params['note'])) {
477 $params['note'] = [];
479 $noteBlock = count($params['note']) +
1;
481 $params['note'][$noteBlock] = [];
482 if (!isset($fields['Note'])) {
483 $fields['Note'] = CRM_Core_DAO_Note
::fields();
486 // get the current logged in civicrm user
487 $session = CRM_Core_Session
::singleton();
488 $userID = $session->get('userID');
491 $values['contact_id'] = $userID;
494 _civicrm_api3_store_values($fields['Note'], $values, $params['note'][$noteBlock]);
499 // Check for custom field values
501 if (empty($fields['custom'])) {
502 $fields['custom'] = &CRM_Core_BAO_CustomField
::getFields(CRM_Utils_Array
::value('contact_type', $values),
503 FALSE, FALSE, NULL, NULL, FALSE, FALSE, FALSE
507 foreach ($values as $key => $value) {
508 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
509 // check if it's a valid custom field id
511 if (!array_key_exists($customFieldID, $fields['custom'])) {
512 return civicrm_api3_create_error('Invalid custom field ID');
515 $params[$key] = $value;
523 * @param array $params
528 function _civicrm_api3_deprecated_duplicate_formatted_contact($params) {
529 $id = $params['id'] ??
NULL;
530 $externalId = $params['external_identifier'] ??
NULL;
531 if ($id ||
$externalId) {
532 $contact = new CRM_Contact_DAO_Contact();
535 $contact->external_identifier
= $externalId;
537 if ($contact->find(TRUE)) {
538 if ($params['contact_type'] != $contact->contact_type
) {
539 return civicrm_api3_create_error("Mismatched contact IDs OR Mismatched contact Types");
542 $error = CRM_Core_Error
::createError("Found matching contacts: $contact->id",
543 CRM_Core_Error
::DUPLICATE_CONTACT
,
544 'Fatal', $contact->id
546 return civicrm_api3_create_error($error->pop());
550 $ids = CRM_Contact_BAO_Contact
::getDuplicateContacts($params, $params['contact_type'], 'Unsupervised');
553 $ids = implode(',', $ids);
554 $error = CRM_Core_Error
::createError("Found matching contacts: $ids",
555 CRM_Core_Error
::DUPLICATE_CONTACT
,
558 return civicrm_api3_create_error($error->pop());
561 return civicrm_api3_create_success(TRUE);
565 * Validate a formatted contact parameter list.
567 * @param array $params
568 * Structured parameter list (as in crm_format_params).
570 * @return bool|CRM_Core_Error
572 function _civicrm_api3_deprecated_validate_formatted_contact(&$params) {
573 // Look for offending email addresses
575 if (array_key_exists('email', $params)) {
576 foreach ($params['email'] as $count => $values) {
577 if (!is_array($values)) {
580 if ($email = CRM_Utils_Array
::value('email', $values)) {
581 // validate each email
582 if (!CRM_Utils_Rule
::email($email)) {
583 return civicrm_api3_create_error('No valid email address');
586 // check for loc type id.
587 if (empty($values['location_type_id'])) {
588 return civicrm_api3_create_error('Location Type Id missing.');
594 // Validate custom data fields
595 if (array_key_exists('custom', $params) && is_array($params['custom'])) {
596 foreach ($params['custom'] as $key => $custom) {
597 if (is_array($custom)) {
598 foreach ($custom as $fieldId => $value) {
599 $valid = CRM_Core_BAO_CustomValue
::typecheck(CRM_Utils_Array
::value('type', $value),
600 CRM_Utils_Array
::value('value', $value)
602 if (!$valid && $value['is_required']) {
603 return civicrm_api3_create_error('Invalid value for custom field \'' .
604 CRM_Utils_Array
::value('name', $custom) . '\''
607 if (CRM_Utils_Array
::value('type', $custom) == 'Date') {
608 $params['custom'][$key][$fieldId]['value'] = str_replace('-', '', $params['custom'][$key][$fieldId]['value']);
615 return civicrm_api3_create_success(TRUE);
619 * @deprecated - this is part of the import parser not the API & needs to be moved on out
621 * @param array $params
622 * @param $onDuplicate
627 function _civicrm_api3_deprecated_create_participant_formatted($params, $onDuplicate) {
628 require_once 'CRM/Event/Import/Parser.php';
629 if ($onDuplicate != CRM_Import_Parser
::DUPLICATE_NOCHECK
) {
630 CRM_Core_Error
::reset();
631 $error = _civicrm_api3_deprecated_participant_check_params($params, TRUE);
632 if (civicrm_error($error)) {
636 require_once "api/v3/Participant.php";
637 return civicrm_api3_participant_create($params);
642 * @param array $params
644 * @param bool $checkDuplicate
649 function _civicrm_api3_deprecated_participant_check_params($params, $checkDuplicate = FALSE) {
651 // check if participant id is valid or not
652 if (!empty($params['id'])) {
653 $participant = new CRM_Event_BAO_Participant();
654 $participant->id
= $params['id'];
655 if (!$participant->find(TRUE)) {
656 return civicrm_api3_create_error(ts('Participant id is not valid'));
659 require_once 'CRM/Contact/BAO/Contact.php';
660 // check if contact id is valid or not
661 if (!empty($params['contact_id'])) {
662 $contact = new CRM_Contact_BAO_Contact();
663 $contact->id
= $params['contact_id'];
664 if (!$contact->find(TRUE)) {
665 return civicrm_api3_create_error(ts('Contact id is not valid'));
669 // check that event id is not an template
670 if (!empty($params['event_id'])) {
671 $isTemplate = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $params['event_id'], 'is_template');
672 if (!empty($isTemplate)) {
673 return civicrm_api3_create_error(ts('Event templates are not meant to be registered.'));
678 if ($checkDuplicate) {
679 if (CRM_Event_BAO_Participant
::checkDuplicate($params, $result)) {
680 $participantID = array_pop($result);
682 $error = CRM_Core_Error
::createError("Found matching participant record.",
683 CRM_Core_Error
::DUPLICATE_PARTICIPANT
,
684 'Fatal', $participantID
687 return civicrm_api3_create_error($error->pop(),
689 'contactID' => $params['contact_id'],
690 'participantID' => $participantID,
699 * @param array $params
700 * @param bool $dupeCheck
701 * @param int $dedupeRuleGroupID
705 function _civicrm_api3_deprecated_contact_check_params(
708 $dedupeRuleGroupID = NULL) {
710 $requiredCheck = TRUE;
712 if (isset($params['id']) && is_numeric($params['id'])) {
713 $requiredCheck = FALSE;
715 if ($requiredCheck) {
716 if (isset($params['id'])) {
717 $required = ['Individual', 'Household', 'Organization'];
721 ['first_name', 'last_name'],
732 // contact_type has a limited number of valid values
733 if (empty($params['contact_type'])) {
734 return civicrm_api3_create_error("No Contact Type");
736 $fields = $required[$params['contact_type']] ??
NULL;
737 if ($fields == NULL) {
738 return civicrm_api3_create_error("Invalid Contact Type: {$params['contact_type']}");
741 if ($csType = CRM_Utils_Array
::value('contact_sub_type', $params)) {
742 if (!(CRM_Contact_BAO_ContactType
::isExtendsContactType($csType, $params['contact_type']))) {
743 return civicrm_api3_create_error("Invalid or Mismatched Contact Subtype: " . implode(', ', (array) $csType));
747 if (empty($params['contact_id']) && !empty($params['id'])) {
750 foreach ($fields as $field) {
751 if (is_array($field)) {
753 foreach ($field as $element) {
754 if (empty($params[$element])) {
762 if (!empty($params[$field])) {
772 return civicrm_api3_create_error("Required fields not found for {$params['contact_type']} : $error");
778 // @todo switch to using api version
779 // $dupes = civicrm_api3('Contact', 'duplicatecheck', (array('match' => $params, 'dedupe_rule_id' => $dedupeRuleGroupID)));
780 // $ids = $dupes['count'] ? implode(',', array_keys($dupes['values'])) : NULL;
781 $ids = CRM_Contact_BAO_Contact
::getDuplicateContacts($params, $params['contact_type'], 'Unsupervised', [], CRM_Utils_Array
::value('check_permissions', $params), $dedupeRuleGroupID);
783 $error = CRM_Core_Error
::createError("Found matching contacts: " . implode(',', $ids),
784 CRM_Core_Error
::DUPLICATE_CONTACT
,
787 return civicrm_api3_create_error($error->pop());
791 // check for organisations with same name
792 if (!empty($params['current_employer'])) {
793 $organizationParams = ['organization_name' => $params['current_employer']];
794 $dupeIds = CRM_Contact_BAO_Contact
::getDuplicateContacts($organizationParams, 'Organization', 'Supervised', [], FALSE);
796 // check for mismatch employer name and id
797 if (!empty($params['employer_id']) && !in_array($params['employer_id'], $dupeIds)
799 return civicrm_api3_create_error('Employer name and Employer id Mismatch');
802 // show error if multiple organisation with same name exist
803 if (empty($params['employer_id']) && (count($dupeIds) > 1)
805 return civicrm_api3_create_error('Found more than one Organisation with same Name.');
814 * @param int $activityTypeID
819 function _civicrm_api3_deprecated_activity_buildmailparams($result, $activityTypeID) {
820 // get ready for collecting data about activity to be created
823 $params['activity_type_id'] = $activityTypeID;
825 $params['status_id'] = 'Completed';
826 if (!empty($result['from']['id'])) {
827 $params['source_contact_id'] = $params['assignee_contact_id'] = $result['from']['id'];
829 $params['target_contact_id'] = [];
830 $keys = ['to', 'cc', 'bcc'];
831 foreach ($keys as $key) {
832 if (is_array($result[$key])) {
833 foreach ($result[$key] as $key => $keyValue) {
834 if (!empty($keyValue['id'])) {
835 $params['target_contact_id'][] = $keyValue['id'];
840 $params['subject'] = $result['subject'];
841 $params['activity_date_time'] = $result['date'];
842 $params['details'] = $result['body'];
844 $numAttachments = Civi
::settings()->get('max_attachments_backend') ?? CRM_Core_BAO_File
::DEFAULT_MAX_ATTACHMENTS_BACKEND
;
845 for ($i = 1; $i <= $numAttachments; $i++
) {
846 if (isset($result["attachFile_$i"])) {
847 $params["attachFile_$i"] = $result["attachFile_$i"];
850 // No point looping 100 times if there's only one attachment