3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * These functions have been deprecated out of API v3 Utils folder as they are not part of the
30 * API. Calling API functions directly is not supported & these functions are not called by any
31 * part of the API so are not really part of the api
35 require_once 'api/v3/utils.php';
38 * take the input parameter list as specified in the data model and
39 * convert it into the same format that we use in QF and BAO object
41 * @param array $params Associative array of property name/value
42 * pairs to insert in new contact.
43 * @param array $values The reformatted properties that we can use internally
45 * @param array|bool $create Is the formatted Values array going to
46 * be used for CRM_vent_BAO_Participant:create()
48 * @return array|CRM_Error
51 function _civicrm_api3_deprecated_participant_formatted_param($params, &$values, $create = FALSE) {
52 $fields = CRM_Event_DAO_Participant
::fields();
53 _civicrm_api3_store_values($fields, $params, $values);
55 require_once 'CRM/Core/OptionGroup.php';
56 $customFields = CRM_Core_BAO_CustomField
::getFields('Participant', FALSE, FALSE, NULL, NULL, FALSE, FALSE, FALSE);
58 foreach ($params as $key => $value) {
59 // ignore empty values or empty arrays etc
60 if (CRM_Utils_System
::isNull($value)) {
64 //Handling Custom Data
65 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
66 $values[$key] = $value;
67 $type = $customFields[$customFieldID]['html_type'];
68 if ($type == 'CheckBox' ||
$type == 'Multi-Select') {
69 $mulValues = explode(',', $value);
70 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
71 $values[$key] = array();
72 foreach ($mulValues as $v1) {
73 foreach ($customOption as $customValueID => $customLabel) {
74 $customValue = $customLabel['value'];
75 if ((strtolower(trim($customLabel['label'])) == strtolower(trim($v1))) ||
76 (strtolower(trim($customValue)) == strtolower(trim($v1)))
78 if ($type == 'CheckBox') {
79 $values[$key][$customValue] = 1;
82 $values[$key][] = $customValue;
88 elseif ($type == 'Select' ||
$type == 'Radio') {
89 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
90 foreach ($customOption as $customFldID => $customValue) {
91 $val = CRM_Utils_Array
::value('value', $customValue);
92 $label = CRM_Utils_Array
::value('label', $customValue);
93 $label = strtolower($label);
94 $value = strtolower(trim($value));
95 if (($value == $label) ||
($value == strtolower($val))) {
103 case 'participant_contact_id':
104 if (!CRM_Utils_Rule
::integer($value)) {
105 return civicrm_api3_create_error("contact_id not valid: $value");
107 $dao = new CRM_Core_DAO();
109 $svq = $dao->singleValueQuery("SELECT id FROM civicrm_contact WHERE id = $value",
113 return civicrm_api3_create_error("Invalid Contact ID: There is no contact record with contact_id = $value.");
115 $values['contact_id'] = $values['participant_contact_id'];
116 unset($values['participant_contact_id']);
119 case 'participant_register_date':
120 if (!CRM_Utils_Rule
::dateTime($value)) {
121 return civicrm_api3_create_error("$key not a valid date: $value");
126 $id = CRM_Core_DAO
::getFieldValue("CRM_Event_DAO_Event", $value, 'id', 'title');
127 $values['event_id'] = $id;
131 if (!CRM_Utils_Rule
::integer($value)) {
132 return civicrm_api3_create_error("Event ID is not valid: $value");
134 $dao = new CRM_Core_DAO();
136 $svq = $dao->singleValueQuery("SELECT id FROM civicrm_event WHERE id = $value",
140 return civicrm_api3_create_error("Invalid Event ID: There is no event record with event_id = $value.");
144 case 'participant_status_id':
145 if (!CRM_Utils_Rule
::integer($value)) {
146 return civicrm_api3_create_error("Event Status ID is not valid: $value");
150 case 'participant_status':
151 $status = CRM_Event_PseudoConstant
::participantStatus();
152 $values['participant_status_id'] = CRM_Utils_Array
::key($value, $status);;
155 case 'participant_role_id':
156 case 'participant_role':
157 $role = CRM_Event_PseudoConstant
::participantRole();
158 $participantRoles = explode(",", $value);
159 foreach ($participantRoles as $k => $v) {
161 if ($key == 'participant_role') {
162 $participantRoles[$k] = CRM_Utils_Array
::key($v, $role);
165 $participantRoles[$k] = $v;
168 require_once 'CRM/Core/DAO.php';
169 $values['role_id'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $participantRoles);
170 unset($values[$key]);
178 if (array_key_exists('participant_note', $params)) {
179 $values['participant_note'] = $params['participant_note'];
183 // CRM_Event_BAO_Participant::create() handles register_date,
184 // status_id and source. So, if $values contains
185 // participant_register_date, participant_status_id or participant_source,
186 // convert it to register_date, status_id or source
188 'participant_register_date' => 'register_date',
189 'participant_source' => 'source',
190 'participant_status_id' => 'status_id',
191 'participant_role_id' => 'role_id',
192 'participant_fee_level' => 'fee_level',
193 'participant_fee_amount' => 'fee_amount',
194 'participant_id' => 'id',
197 foreach ($changes as $orgVal => $changeVal) {
198 if (isset($values[$orgVal])) {
199 $values[$changeVal] = $values[$orgVal];
200 unset($values[$orgVal]);
209 * take the input parameter list as specified in the data model and
210 * convert it into the same format that we use in QF and BAO object
212 * @param array $params Associative array of property name/value
213 * pairs to insert in new contact.
214 * @param array $values The reformatted properties that we can use internally
217 * @param bool $create
218 * @param null $onDuplicate
220 * @return array|CRM_Error
223 function _civicrm_api3_deprecated_formatted_param($params, &$values, $create = FALSE, $onDuplicate = Null) {
224 // copy all the contribution fields as is
226 $fields = CRM_Contribute_DAO_Contribution
::fields();
228 _civicrm_api3_store_values($fields, $params, $values);
230 require_once 'CRM/Core/OptionGroup.php';
231 $customFields = CRM_Core_BAO_CustomField
::getFields('Contribution', FALSE, FALSE, NULL, NULL, FALSE, FALSE, FALSE);
233 foreach ($params as $key => $value) {
234 // ignore empty values or empty arrays etc
235 if (CRM_Utils_System
::isNull($value)) {
239 //Handling Custom Data
240 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
241 $values[$key] = $value;
242 $type = $customFields[$customFieldID]['html_type'];
243 if ($type == 'CheckBox' ||
$type == 'Multi-Select') {
244 $mulValues = explode(',', $value);
245 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
246 $values[$key] = array();
247 foreach ($mulValues as $v1) {
248 foreach ($customOption as $customValueID => $customLabel) {
249 $customValue = $customLabel['value'];
250 if ((strtolower($customLabel['label']) == strtolower(trim($v1))) ||
251 (strtolower($customValue) == strtolower(trim($v1)))
253 if ($type == 'CheckBox') {
254 $values[$key][$customValue] = 1;
257 $values[$key][] = $customValue;
263 elseif ($type == 'Select' ||
$type == 'Radio' ||
264 ($type == 'Autocomplete-Select' &&
265 $customFields[$customFieldID]['data_type'] == 'String'
268 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
269 foreach ($customOption as $customFldID => $customValue) {
270 $val = CRM_Utils_Array
::value('value', $customValue);
271 $label = CRM_Utils_Array
::value('label', $customValue);
272 $label = strtolower($label);
273 $value = strtolower(trim($value));
274 if (($value == $label) ||
($value == strtolower($val))) {
275 $values[$key] = $val;
282 case 'contribution_contact_id':
283 if (!CRM_Utils_Rule
::integer($value)) {
284 return civicrm_api3_create_error("contact_id not valid: $value");
286 $dao = new CRM_Core_DAO();
288 $svq = $dao->singleValueQuery("SELECT id FROM civicrm_contact WHERE id = $value",
292 return civicrm_api3_create_error("Invalid Contact ID: There is no contact record with contact_id = $value.");
295 $values['contact_id'] = $values['contribution_contact_id'];
296 unset($values['contribution_contact_id']);
300 //import contribution record according to select contact type
301 require_once 'CRM/Contact/DAO/Contact.php';
302 $contactType = new CRM_Contact_DAO_Contact();
303 //when insert mode check contact id or external identifier
304 if (!empty($params['contribution_contact_id']) ||
!empty($params['external_identifier'])) {
305 if (!empty($params['contribution_contact_id'])) {
306 $contactType->id
= CRM_Utils_Array
::value('contribution_contact_id', $params);
308 elseif (!empty($params['external_identifier'])) {
309 $contactType->external_identifier
= $params['external_identifier'];
311 if ($contactType->find(TRUE)) {
312 if ($params['contact_type'] != $contactType->contact_type
) {
313 return civicrm_api3_create_error("Contact Type is wrong: $contactType->contact_type");
317 elseif (!empty($params['contribution_id']) ||
!empty($params['trxn_id']) ||
!empty($params['invoice_id'])) {
318 //when update mode check contribution id or trxn id or
320 $contactId = new CRM_Contribute_DAO_Contribution();
321 if (!empty($params['contribution_id'])) {
322 $contactId->id
= $params['contribution_id'];
324 elseif (!empty($params['trxn_id'])) {
325 $contactId->trxn_id
= $params['trxn_id'];
327 elseif (!empty($params['invoice_id'])) {
328 $contactId->invoice_id
= $params['invoice_id'];
330 if ($contactId->find(TRUE)) {
331 $contactType->id
= $contactId->contact_id
;
332 if ($contactType->find(TRUE)) {
333 if ($params['contact_type'] != $contactType->contact_type
) {
334 return civicrm_api3_create_error("Contact Type is wrong: $contactType->contact_type");
340 if ($onDuplicate == CRM_Import_Parser
::DUPLICATE_UPDATE
) {
341 return civicrm_api3_create_error("Empty Contribution and Invoice and Transaction ID. Row was skipped.");
344 return civicrm_api3_create_error("Empty Contact and External ID. Row was skipped.");
352 case 'thankyou_date':
353 if (!CRM_Utils_Rule
::dateTime($value)) {
354 return civicrm_api3_create_error("$key not a valid date: $value");
358 case 'non_deductible_amount':
362 if (!CRM_Utils_Rule
::money($value)) {
363 return civicrm_api3_create_error("$key not a valid amount: $value");
368 if (!CRM_Utils_Rule
::currencyCode($value)) {
369 return civicrm_api3_create_error("currency not a valid code: $value");
373 case 'financial_type':
374 require_once 'CRM/Contribute/PseudoConstant.php';
375 $contriTypes = CRM_Contribute_PseudoConstant
::financialType();
376 foreach ($contriTypes as $val => $type) {
377 if (strtolower($value) == strtolower($type)) {
378 $values['financial_type_id'] = $val;
382 if (empty($values['financial_type_id'])) {
383 return civicrm_api3_create_error("Financial Type is not valid: $value");
387 case 'payment_instrument':
388 require_once 'CRM/Core/OptionGroup.php';
389 $values['payment_instrument_id'] = CRM_Core_OptionGroup
::getValue('payment_instrument', $value);
390 if (empty($values['payment_instrument_id'])) {
391 return civicrm_api3_create_error("Payment Instrument is not valid: $value");
395 case 'contribution_status_id':
396 require_once 'CRM/Core/OptionGroup.php';
397 if (!$values['contribution_status_id'] = CRM_Core_OptionGroup
::getValue('contribution_status', $value)) {
398 return civicrm_api3_create_error("Contribution Status is not valid: $value");
403 //import contribution record according to select contact type
404 // validate contact id and external identifier.
405 $value[$key] = $mismatchContactType = $softCreditContactIds = '';
406 if (isset($params[$key]) && is_array($params[$key])) {
407 foreach ($params[$key] as $softKey => $softParam) {
408 $contactId = CRM_Utils_Array
::value('contact_id', $softParam);
409 $externalId = CRM_Utils_Array
::value('external_identifier', $softParam);
410 $email = CRM_Utils_Array
::value('email', $softParam);
411 if ($contactId ||
$externalId) {
412 require_once 'CRM/Contact/DAO/Contact.php';
413 $contact = new CRM_Contact_DAO_Contact();
414 $contact->id
= $contactId;
415 $contact->external_identifier
= $externalId;
417 if (!$contact->find(TRUE)) {
418 $field = $contactId ?
ts('Contact ID') : ts('External ID');
419 $errorMsg = ts("Soft Credit %1 - %2 doesn't exist. Row was skipped.",
420 array(1 => $field, 2 => $contactId ?
$contactId : $externalId));
424 return civicrm_api3_create_error($errorMsg, $value[$key]);
427 // finally get soft credit contact id.
428 $values[$key][$softKey] = $softParam;
429 $values[$key][$softKey]['contact_id'] = $contact->id
;
432 if (!CRM_Utils_Rule
::email($email)) {
433 return civicrm_api3_create_error("Invalid email address $email provided for Soft Credit. Row was skipped");
436 // get the contact id from duplicate contact rule, if more than one contact is returned
437 // we should return error, since current interface allows only one-one mapping
438 $emailParams = array('email' => $email, 'contact_type' => $params['contact_type']);
439 $checkDedupe = _civicrm_api3_deprecated_duplicate_formatted_contact($emailParams);
440 if (!$checkDedupe['is_error']) {
441 return civicrm_api3_create_error("Invalid email address(doesn't exist) $email for Soft Credit. Row was skipped");
444 $matchingContactIds = explode(',', $checkDedupe['error_message']['params'][0]);
445 if (count($matchingContactIds) > 1) {
446 return civicrm_api3_create_error("Invalid email address(duplicate) $email for Soft Credit. Row was skipped");
448 elseif (count($matchingContactIds) == 1) {
449 $contactId = $matchingContactIds[0];
450 unset($softParam['email']);
451 $values[$key][$softKey] = $softParam +
array('contact_id' => $contactId);
459 case 'pledge_payment':
462 //giving respect to pledge_payment flag.
463 if (empty($params['pledge_payment'])) {
467 //get total amount of from import fields
468 $totalAmount = CRM_Utils_Array
::value('total_amount', $params);
470 $onDuplicate = CRM_Utils_Array
::value('onDuplicate', $params);
472 //we need to get contact id $contributionContactID to
473 //retrieve pledge details as well as to validate pledge ID
475 //first need to check for update mode
476 if ($onDuplicate == CRM_Import_Parser
::DUPLICATE_UPDATE
&&
477 ($params['contribution_id'] ||
$params['trxn_id'] ||
$params['invoice_id'])
479 $contribution = new CRM_Contribute_DAO_Contribution();
480 if ($params['contribution_id']) {
481 $contribution->id
= $params['contribution_id'];
483 elseif ($params['trxn_id']) {
484 $contribution->trxn_id
= $params['trxn_id'];
486 elseif ($params['invoice_id']) {
487 $contribution->invoice_id
= $params['invoice_id'];
490 if ($contribution->find(TRUE)) {
491 $contributionContactID = $contribution->contact_id
;
493 $totalAmount = $contribution->total_amount
;
497 return civicrm_api3_create_error('No match found for specified contact in contribution data. Row was skipped.', 'pledge_payment');
501 // first get the contact id for given contribution record.
502 if (!empty($params['contribution_contact_id'])) {
503 $contributionContactID = $params['contribution_contact_id'];
505 elseif (!empty($params['external_identifier'])) {
506 require_once 'CRM/Contact/DAO/Contact.php';
507 $contact = new CRM_Contact_DAO_Contact();
508 $contact->external_identifier
= $params['external_identifier'];
509 if ($contact->find(TRUE)) {
510 $contributionContactID = $params['contribution_contact_id'] = $values['contribution_contact_id'] = $contact->id
;
513 return civicrm_api3_create_error('No match found for specified contact in contribution data. Row was skipped.', 'pledge_payment');
517 // we need to get contribution contact using de dupe
518 $error = _civicrm_api3_deprecated_check_contact_dedupe($params);
520 if (isset($error['error_message']['params'][0])) {
521 $matchedIDs = explode(',', $error['error_message']['params'][0]);
523 // check if only one contact is found
524 if (count($matchedIDs) > 1) {
525 return civicrm_api3_create_error($error['error_message']['message'], 'pledge_payment');
528 $contributionContactID = $params['contribution_contact_id'] = $values['contribution_contact_id'] = $matchedIDs[0];
532 return civicrm_api3_create_error('No match found for specified contact in contribution data. Row was skipped.', 'pledge_payment');
537 if (!empty($params['pledge_id'])) {
538 if (CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_Pledge', $params['pledge_id'], 'contact_id') != $contributionContactID) {
539 return civicrm_api3_create_error('Invalid Pledge ID provided. Contribution row was skipped.', 'pledge_payment');
541 $values['pledge_id'] = $params['pledge_id'];
544 //check if there are any pledge related to this contact, with payments pending or in progress
545 require_once 'CRM/Pledge/BAO/Pledge.php';
546 $pledgeDetails = CRM_Pledge_BAO_Pledge
::getContactPledges($contributionContactID);
548 if (empty($pledgeDetails)) {
549 return civicrm_api3_create_error('No open pledges found for this contact. Contribution row was skipped.', 'pledge_payment');
551 elseif (count($pledgeDetails) > 1) {
552 return civicrm_api3_create_error('This contact has more than one open pledge. Unable to determine which pledge to apply the contribution to. Contribution row was skipped.', 'pledge_payment');
555 // this mean we have only one pending / in progress pledge
556 $values['pledge_id'] = $pledgeDetails[0];
559 //we need to check if oldest payment amount equal to contribution amount
560 require_once 'CRM/Pledge/BAO/PledgePayment.php';
561 $pledgePaymentDetails = CRM_Pledge_BAO_PledgePayment
::getOldestPledgePayment($values['pledge_id']);
563 if ($pledgePaymentDetails['amount'] == $totalAmount) {
564 $values['pledge_payment_id'] = $pledgePaymentDetails['id'];
567 return civicrm_api3_create_error('Contribution and Pledge Payment amount mismatch for this record. Contribution row was skipped.', 'pledge_payment');
576 if (array_key_exists('note', $params)) {
577 $values['note'] = $params['note'];
581 // CRM_Contribute_BAO_Contribution::add() handles contribution_source
582 // So, if $values contains contribution_source, convert it to source
583 $changes = array('contribution_source' => 'source');
585 foreach ($changes as $orgVal => $changeVal) {
586 if (isset($values[$orgVal])) {
587 $values[$changeVal] = $values[$orgVal];
588 unset($values[$orgVal]);
597 * Function to check duplicate contacts based on de-deupe parameters
599 function _civicrm_api3_deprecated_check_contact_dedupe($params) {
600 static $cIndieFields = NULL;
601 static $defaultLocationId = NULL;
603 $contactType = $params['contact_type'];
604 if ($cIndieFields == NULL) {
605 require_once 'CRM/Contact/BAO/Contact.php';
606 $cTempIndieFields = CRM_Contact_BAO_Contact
::importableFields($contactType);
607 $cIndieFields = $cTempIndieFields;
609 require_once "CRM/Core/BAO/LocationType.php";
610 $defaultLocation = CRM_Core_BAO_LocationType
::getDefault();
612 //set the value to default location id else set to 1
613 if (!$defaultLocationId = (int)$defaultLocation->id
) {
614 $defaultLocationId = 1;
618 require_once 'CRM/Contact/BAO/Query.php';
619 $locationFields = CRM_Contact_BAO_Query
::$_locationSpecificFields;
621 $contactFormatted = array();
622 foreach ($params as $key => $field) {
623 if ($field == NULL ||
$field === '') {
626 if (is_array($field)) {
627 foreach ($field as $value) {
629 if (is_array($value)) {
630 foreach ($value as $name => $testForEmpty) {
631 if ($name !== 'phone_type' &&
632 ($testForEmpty === '' ||
$testForEmpty == NULL)
643 _civicrm_api3_deprecated_add_formatted_param($value, $contactFormatted);
649 $value = array($key => $field);
651 // check if location related field, then we need to add primary location type
652 if (in_array($key, $locationFields)) {
653 $value['location_type_id'] = $defaultLocationId;
655 elseif (array_key_exists($key, $cIndieFields)) {
656 $value['contact_type'] = $contactType;
659 _civicrm_api3_deprecated_add_formatted_param($value, $contactFormatted);
662 $contactFormatted['contact_type'] = $contactType;
664 return _civicrm_api3_deprecated_duplicate_formatted_contact($contactFormatted);
668 * take the input parameter list as specified in the data model and
669 * convert it into the same format that we use in QF and BAO object
671 * @param array $params Associative array of property name/value
672 * pairs to insert in new contact.
673 * @param array $values The reformatted properties that we can use internally
675 * @param array|bool $create Is the formatted Values array going to
676 * be used for CRM_Activity_BAO_Activity::create()
678 * @return array|CRM_Error
681 function _civicrm_api3_deprecated_activity_formatted_param(&$params, &$values, $create = FALSE) {
682 // copy all the activity fields as is
683 $fields = CRM_Activity_DAO_Activity
::fields();
684 _civicrm_api3_store_values($fields, $params, $values);
686 require_once 'CRM/Core/OptionGroup.php';
687 $customFields = CRM_Core_BAO_CustomField
::getFields('Activity');
689 foreach ($params as $key => $value) {
690 // ignore empty values or empty arrays etc
691 if (CRM_Utils_System
::isNull($value)) {
695 //Handling Custom Data
696 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
697 $values[$key] = $value;
698 $type = $customFields[$customFieldID]['html_type'];
699 if ($type == 'CheckBox' ||
$type == 'Multi-Select') {
700 $mulValues = explode(',', $value);
701 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
702 $values[$key] = array();
703 foreach ($mulValues as $v1) {
704 foreach ($customOption as $customValueID => $customLabel) {
705 $customValue = $customLabel['value'];
706 if ((strtolower(trim($customLabel['label'])) == strtolower(trim($v1))) ||
707 (strtolower(trim($customValue)) == strtolower(trim($v1)))
709 if ($type == 'CheckBox') {
710 $values[$key][$customValue] = 1;
713 $values[$key][] = $customValue;
719 elseif ($type == 'Select' ||
$type == 'Radio') {
720 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
721 foreach ($customOption as $customFldID => $customValue) {
722 $val = CRM_Utils_Array
::value('value', $customValue);
723 $label = CRM_Utils_Array
::value('label', $customValue);
724 $label = strtolower($label);
725 $value = strtolower(trim($value));
726 if (($value == $label) ||
($value == strtolower($val))) {
727 $values[$key] = $val;
733 if ($key == 'target_contact_id') {
734 if (!CRM_Utils_Rule
::integer($value)) {
735 return civicrm_api3_create_error("contact_id not valid: $value");
737 $contactID = CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_contact WHERE id = $value");
739 return civicrm_api3_create_error("Invalid Contact ID: There is no contact record with contact_id = $value.");
747 * This function adds the contact variable in $values to the
748 * parameter list $params. For most cases, $values should have length 1. If
749 * the variable being added is a child of Location, a location_type_id must
750 * also be included. If it is a child of phone, a phone_type must be included.
752 * @param array $values The variable(s) to be added
753 * @param array $params The structured parameter list
755 * @return bool|CRM_Utils_Error
758 function _civicrm_api3_deprecated_add_formatted_param(&$values, &$params) {
759 /* Crawl through the possible classes:
773 /* Cache the various object fields */
774 static $fields = NULL;
776 if ($fields == NULL) {
780 //first add core contact values since for other Civi modules they are not added
781 require_once 'CRM/Contact/BAO/Contact.php';
782 $contactFields = CRM_Contact_DAO_Contact
::fields();
783 _civicrm_api3_store_values($contactFields, $values, $params);
785 if (isset($values['contact_type'])) {
786 /* we're an individual/household/org property */
788 $fields[$values['contact_type']] = CRM_Contact_DAO_Contact
::fields();
790 _civicrm_api3_store_values($fields[$values['contact_type']], $values, $params);
794 if (isset($values['individual_prefix'])) {
795 if (!empty($params['prefix_id'])) {
796 $prefixes = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'prefix_id');
797 $params['prefix'] = $prefixes[$params['prefix_id']];
800 $params['prefix'] = $values['individual_prefix'];
805 if (isset($values['individual_suffix'])) {
806 if (!empty($params['suffix_id'])) {
807 $suffixes = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'suffix_id');
808 $params['suffix'] = $suffixes[$params['suffix_id']];
811 $params['suffix'] = $values['individual_suffix'];
817 if (isset($values['email_greeting'])) {
818 if (!empty($params['email_greeting_id'])) {
819 $emailGreetingFilter = array(
820 'contact_type' => CRM_Utils_Array
::value('contact_type', $params),
821 'greeting_type' => 'email_greeting',
823 $emailGreetings = CRM_Core_PseudoConstant
::greeting($emailGreetingFilter);
824 $params['email_greeting'] = $emailGreetings[$params['email_greeting_id']];
827 $params['email_greeting'] = $values['email_greeting'];
833 if (isset($values['postal_greeting'])) {
834 if (!empty($params['postal_greeting_id'])) {
835 $postalGreetingFilter = array(
836 'contact_type' => CRM_Utils_Array
::value('contact_type', $params),
837 'greeting_type' => 'postal_greeting',
839 $postalGreetings = CRM_Core_PseudoConstant
::greeting($postalGreetingFilter);
840 $params['postal_greeting'] = $postalGreetings[$params['postal_greeting_id']];
843 $params['postal_greeting'] = $values['postal_greeting'];
848 if (isset($values['addressee'])) {
849 if (!empty($params['addressee_id'])) {
850 $addresseeFilter = array(
851 'contact_type' => CRM_Utils_Array
::value('contact_type', $params),
852 'greeting_type' => 'addressee',
854 $addressee = CRM_Core_PseudoConstant
::addressee($addresseeFilter);
855 $params['addressee'] = $addressee[$params['addressee_id']];
858 $params['addressee'] = $values['addressee'];
863 if (isset($values['gender'])) {
864 if (!empty($params['gender_id'])) {
865 $genders = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id');
866 $params['gender'] = $genders[$params['gender_id']];
869 $params['gender'] = $values['gender'];
874 if (!empty($values['preferred_communication_method'])) {
876 $pcm = array_change_key_case(array_flip(CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method')), CASE_LOWER
);
878 $preffComm = explode(',', $values['preferred_communication_method']);
879 foreach ($preffComm as $v) {
880 $v = strtolower(trim($v));
881 if (array_key_exists($v, $pcm)) {
886 $params['preferred_communication_method'] = $comm;
890 //format the website params.
891 if (!empty($values['url'])) {
892 static $websiteFields;
893 if (!is_array($websiteFields)) {
894 require_once 'CRM/Core/DAO/Website.php';
895 $websiteFields = CRM_Core_DAO_Website
::fields();
897 if (!array_key_exists('website', $params) ||
898 !is_array($params['website'])
900 $params['website'] = array();
903 $websiteCount = count($params['website']);
904 _civicrm_api3_store_values($websiteFields, $values,
905 $params['website'][++
$websiteCount]
911 // get the formatted location blocks into params - w/ 3.0 format, CRM-4605
912 if (!empty($values['location_type_id'])) {
913 _civicrm_api3_deprecated_add_formatted_location_blocks($values, $params);
917 if (isset($values['note'])) {
918 /* add a note field */
919 if (!isset($params['note'])) {
920 $params['note'] = array();
922 $noteBlock = count($params['note']) +
1;
924 $params['note'][$noteBlock] = array();
925 if (!isset($fields['Note'])) {
926 $fields['Note'] = CRM_Core_DAO_Note
::fields();
929 // get the current logged in civicrm user
930 $session = CRM_Core_Session
::singleton();
931 $userID = $session->get('userID');
934 $values['contact_id'] = $userID;
937 _civicrm_api3_store_values($fields['Note'], $values, $params['note'][$noteBlock]);
942 /* Check for custom field values */
944 if (empty($fields['custom'])) {
945 $fields['custom'] = &CRM_Core_BAO_CustomField
::getFields(CRM_Utils_Array
::value('contact_type', $values),
946 FALSE, FALSE, NULL, NULL, FALSE, FALSE, FALSE
950 foreach ($values as $key => $value) {
951 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
952 /* check if it's a valid custom field id */
954 if (!array_key_exists($customFieldID, $fields['custom'])) {
955 return civicrm_api3_create_error('Invalid custom field ID');
958 $params[$key] = $value;
965 * This function format location blocks w/ v3.0 format.
967 * @param array $values The variable(s) to be added
968 * @param array $params The structured parameter list
973 function _civicrm_api3_deprecated_add_formatted_location_blocks(&$values, &$params) {
974 static $fields = NULL;
975 if ($fields == NULL) {
980 'Phone', 'Email', 'IM', 'OpenID','Phone_Ext') as $block) {
981 $name = strtolower($block);
982 if (!array_key_exists($name, $values)) {
986 if($name == 'phone_ext'){
990 // block present in value array.
991 if (!array_key_exists($name, $params) ||
!is_array($params[$name])) {
992 $params[$name] = array();
995 if (!array_key_exists($block, $fields)) {
996 $className = "CRM_Core_DAO_$block";
997 $fields[$block] =& $className::fields( );
1000 $blockCnt = count($params[$name]);
1002 // copy value to dao field name.
1003 if ($name == 'im') {
1004 $values['name'] = $values[$name];
1007 _civicrm_api3_store_values($fields[$block], $values,
1008 $params[$name][++
$blockCnt]
1011 if (empty($params['id']) && ($blockCnt == 1)) {
1012 $params[$name][$blockCnt]['is_primary'] = TRUE;
1015 // we only process single block at a time.
1019 // handle address fields.
1020 if (!array_key_exists('address', $params) ||
!is_array($params['address'])) {
1021 $params['address'] = array();
1025 foreach ($params['address'] as $cnt => $addressBlock) {
1026 if (CRM_Utils_Array
::value('location_type_id', $values) ==
1027 CRM_Utils_Array
::value('location_type_id', $addressBlock)
1035 if (!array_key_exists('Address', $fields)) {
1036 require_once 'CRM/Core/DAO/Address.php';
1037 $fields['Address'] = CRM_Core_DAO_Address
::fields();
1040 // Note: we doing multiple value formatting here for address custom fields, plus putting into right format.
1041 // The actual formatting (like date, country ..etc) for address custom fields is taken care of while saving
1042 // the address in CRM_Core_BAO_Address::create method
1043 if (!empty($values['location_type_id'])) {
1044 static $customFields = array();
1045 if (empty($customFields)) {
1046 $customFields = CRM_Core_BAO_CustomField
::getFields('Address');
1048 // make a copy of values, as we going to make changes
1049 $newValues = $values;
1050 foreach ($values as $key => $val) {
1051 $customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key);
1052 if ($customFieldID && array_key_exists($customFieldID, $customFields)) {
1053 // mark an entry in fields array since we want the value of custom field to be copied
1054 $fields['Address'][$key] = null;
1056 $htmlType = CRM_Utils_Array
::value( 'html_type', $customFields[$customFieldID] );
1057 switch ( $htmlType ) {
1059 case 'AdvMulti-Select':
1060 case 'Multi-Select':
1062 $mulValues = explode( ',', $val );
1063 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption( $customFieldID, true );
1064 $newValues[$key] = array( );
1065 foreach ( $mulValues as $v1 ) {
1066 foreach ( $customOption as $v2 ) {
1067 if ( ( strtolower( $v2['label'] ) == strtolower( trim( $v1 ) ) ) ||
1068 ( strtolower( $v2['value'] ) == strtolower( trim( $v1 ) ) ) ) {
1069 if ( $htmlType == 'CheckBox' ) {
1070 $newValues[$key][$v2['value']] = 1;
1072 $newValues[$key][] = $v2['value'];
1082 // consider new values
1083 $values = $newValues;
1086 _civicrm_api3_store_values($fields['Address'], $values, $params['address'][$addressCnt]);
1088 $addressFields = array(
1089 'county', 'country', 'state_province',
1090 'supplemental_address_1', 'supplemental_address_2',
1091 'StateProvince.name',
1094 foreach ($addressFields as $field) {
1095 if (array_key_exists($field, $values)) {
1096 if (!array_key_exists('address', $params)) {
1097 $params['address'] = array();
1099 $params['address'][$addressCnt][$field] = $values[$field];
1103 if ($addressCnt == 1) {
1105 $params['address'][$addressCnt]['is_primary'] = TRUE;
1113 * @param <type> $params
1115 * @return array <type>
1117 function _civicrm_api3_deprecated_duplicate_formatted_contact($params) {
1118 $id = CRM_Utils_Array
::value('id', $params);
1119 $externalId = CRM_Utils_Array
::value('external_identifier', $params);
1120 if ($id ||
$externalId) {
1121 $contact = new CRM_Contact_DAO_Contact();
1124 $contact->external_identifier
= $externalId;
1126 if ($contact->find(TRUE)) {
1127 if ($params['contact_type'] != $contact->contact_type
) {
1128 return civicrm_api3_create_error("Mismatched contact IDs OR Mismatched contact Types");
1131 $error = CRM_Core_Error
::createError("Found matching contacts: $contact->id",
1132 CRM_Core_Error
::DUPLICATE_CONTACT
,
1133 'Fatal', $contact->id
1135 return civicrm_api3_create_error($error->pop());
1139 require_once 'CRM/Dedupe/Finder.php';
1140 $dedupeParams = CRM_Dedupe_Finder
::formatParams($params, $params['contact_type']);
1141 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, $params['contact_type'], 'Unsupervised');
1144 $ids = implode(',', $ids);
1145 $error = CRM_Core_Error
::createError("Found matching contacts: $ids",
1146 CRM_Core_Error
::DUPLICATE_CONTACT
,
1149 return civicrm_api3_create_error($error->pop());
1152 return civicrm_api3_create_success(TRUE);
1156 * Validate a formatted contact parameter list.
1158 * @param array $params Structured parameter list (as in crm_format_params)
1160 * @return bool|CRM_Core_Error
1163 function _civicrm_api3_deprecated_validate_formatted_contact(&$params) {
1164 /* Look for offending email addresses */
1166 if (array_key_exists('email', $params)) {
1167 foreach ($params['email'] as $count => $values) {
1168 if (!is_array($values)) {
1171 if ($email = CRM_Utils_Array
::value('email', $values)) {
1172 //validate each email
1173 if (!CRM_Utils_Rule
::email($email)) {
1174 return civicrm_api3_create_error('No valid email address');
1177 //check for loc type id.
1178 if (empty($values['location_type_id'])) {
1179 return civicrm_api3_create_error('Location Type Id missing.');
1185 /* Validate custom data fields */
1186 if (array_key_exists('custom', $params) && is_array($params['custom'])) {
1187 foreach ($params['custom'] as $key => $custom) {
1188 if (is_array($custom)) {
1189 foreach ($custom as $fieldId => $value) {
1190 $valid = CRM_Core_BAO_CustomValue
::typecheck(CRM_Utils_Array
::value('type', $value),
1191 CRM_Utils_Array
::value('value', $value)
1193 if (!$valid && $value['is_required']) {
1194 return civicrm_api3_create_error('Invalid value for custom field \'' .
1195 CRM_Utils_Array
::value('name', $custom) . '\''
1198 if (CRM_Utils_Array
::value('type', $custom) == 'Date') {
1199 $params['custom'][$key][$fieldId]['value'] = str_replace('-', '', $params['custom'][$key][$fieldId]['value']);
1206 return civicrm_api3_create_success(TRUE);
1211 * @deprecated - this is part of the import parser not the API & needs to be moved on out
1214 * @param $onDuplicate
1216 * @internal param $ <type> $params
1217 * @internal param $ <type> $onDuplicate
1219 * @return array|bool <type>
1221 function _civicrm_api3_deprecated_create_participant_formatted($params, $onDuplicate) {
1222 require_once 'CRM/Event/Import/Parser.php';
1223 if ($onDuplicate != CRM_Import_Parser
::DUPLICATE_NOCHECK
) {
1224 CRM_Core_Error
::reset();
1225 $error = _civicrm_api3_deprecated_participant_check_params($params, TRUE);
1226 if (civicrm_error($error)) {
1230 require_once "api/v3/Participant.php";
1231 return civicrm_api3_participant_create($params);
1236 * @param <type> $params
1238 * @param bool $checkDuplicate
1240 * @return array|bool <type>
1242 function _civicrm_api3_deprecated_participant_check_params($params, $checkDuplicate = FALSE) {
1244 //check if participant id is valid or not
1245 if (!empty($params['id'])) {
1246 $participant = new CRM_Event_BAO_Participant();
1247 $participant->id
= $params['id'];
1248 if (!$participant->find(TRUE)) {
1249 return civicrm_api3_create_error(ts('Participant id is not valid'));
1252 require_once 'CRM/Contact/BAO/Contact.php';
1253 //check if contact id is valid or not
1254 if (!empty($params['contact_id'])) {
1255 $contact = new CRM_Contact_BAO_Contact();
1256 $contact->id
= $params['contact_id'];
1257 if (!$contact->find(TRUE)) {
1258 return civicrm_api3_create_error(ts('Contact id is not valid'));
1262 //check that event id is not an template
1263 if (!empty($params['event_id'])) {
1264 $isTemplate = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $params['event_id'], 'is_template');
1265 if (!empty($isTemplate)) {
1266 return civicrm_api3_create_error(ts('Event templates are not meant to be registered.'));
1271 if ($checkDuplicate) {
1272 if (CRM_Event_BAO_Participant
::checkDuplicate($params, $result)) {
1273 $participantID = array_pop($result);
1275 $error = CRM_Core_Error
::createError("Found matching participant record.",
1276 CRM_Core_Error
::DUPLICATE_PARTICIPANT
,
1277 'Fatal', $participantID
1280 return civicrm_api3_create_error($error->pop(),
1282 'contactID' => $params['contact_id'],
1283 'participantID' => $participantID,
1292 * Ensure that we have the right input parameters for custom data
1294 * @param array $params Associative array of property name/value
1295 * pairs to insert in new contact.
1296 * @param string $csType contact subtype if exists/passed.
1298 * @return null on success, error message otherwise
1301 function _civicrm_api3_deprecated_contact_check_custom_params($params, $csType = NULL) {
1302 empty($csType) ?
$onlyParent = TRUE : $onlyParent = FALSE;
1304 require_once 'CRM/Core/BAO/CustomField.php';
1305 $customFields = CRM_Core_BAO_CustomField
::getFields($params['contact_type'],
1315 foreach ($params as $key => $value) {
1316 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
1317 /* check if it's a valid custom field id */
1318 if (!array_key_exists($customFieldID, $customFields)) {
1320 $errorMsg = "Invalid Custom Field Contact Type: {$params['contact_type']}";
1321 if (!empty($csType)) {
1322 $errorMsg .= " or Mismatched SubType: " . implode(', ', (array)$csType);
1324 return civicrm_api3_create_error($errorMsg);
1332 * @param bool $dupeCheck
1333 * @param bool $dupeErrorArray
1334 * @param bool $requiredCheck
1335 * @param null $dedupeRuleGroupID
1337 * @return array|null
1339 function _civicrm_api3_deprecated_contact_check_params(
1342 $dupeErrorArray = FALSE,
1343 $requiredCheck = TRUE,
1344 $dedupeRuleGroupID = NULL) {
1345 if (isset($params['id']) && is_numeric($params['id'])) {
1346 $requiredCheck = FALSE;
1348 if ($requiredCheck) {
1349 if (isset($params['id'])) {
1350 $required = array('Individual', 'Household', 'Organization');
1353 'Individual' => array(
1354 array('first_name', 'last_name'),
1357 'Household' => array(
1360 'Organization' => array(
1361 'organization_name',
1366 // contact_type has a limited number of valid values
1367 if(empty($params['contact_type'])) {
1368 return civicrm_api3_create_error("No Contact Type");
1370 $fields = CRM_Utils_Array
::value($params['contact_type'], $required);
1371 if ($fields == NULL) {
1372 return civicrm_api3_create_error("Invalid Contact Type: {$params['contact_type']}");
1375 if ($csType = CRM_Utils_Array
::value('contact_sub_type', $params)) {
1376 if (!(CRM_Contact_BAO_ContactType
::isExtendsContactType($csType, $params['contact_type']))) {
1377 return civicrm_api3_create_error("Invalid or Mismatched Contact Subtype: " . implode(', ', (array)$csType));
1381 if (empty($params['contact_id']) && !empty($params['id'])) {
1384 foreach ($fields as $field) {
1385 if (is_array($field)) {
1387 foreach ($field as $element) {
1388 if (empty($params[$element])) {
1396 if (!empty($params[$field])) {
1406 return civicrm_api3_create_error("Required fields not found for {$params['contact_type']} : $error");
1412 // check for record already existing
1413 require_once 'CRM/Dedupe/Finder.php';
1414 $dedupeParams = CRM_Dedupe_Finder
::formatParams($params, $params['contact_type']);
1417 // setting 'check_permission' here means that the dedupe checking will be carried out even if the
1418 // person does not have permission to carry out de-dupes
1419 // this is similar to the front end form
1420 if (isset($params['check_permission'])) {
1421 $dedupeParams['check_permission'] = $params['check_permission'];
1424 $ids = implode(',', CRM_Dedupe_Finder
::dupesByParams($dedupeParams, $params['contact_type'], 'Unsupervised', array(), $dedupeRuleGroupID));
1427 if ($dupeErrorArray) {
1428 $error = CRM_Core_Error
::createError("Found matching contacts: $ids",
1429 CRM_Core_Error
::DUPLICATE_CONTACT
,
1432 return civicrm_api3_create_error($error->pop());
1435 return civicrm_api3_create_error("Found matching contacts: $ids");
1439 //check for organisations with same name
1440 if (!empty($params['current_employer'])) {
1441 $organizationParams = array();
1442 $organizationParams['organization_name'] = $params['current_employer'];
1444 require_once 'CRM/Dedupe/Finder.php';
1445 $dedupParams = CRM_Dedupe_Finder
::formatParams($organizationParams, 'Organization');
1447 $dedupParams['check_permission'] = FALSE;
1448 $dupeIds = CRM_Dedupe_Finder
::dupesByParams($dedupParams, 'Organization', 'Supervised');
1450 // check for mismatch employer name and id
1451 if (!empty($params['employer_id']) && !in_array($params['employer_id'], $dupeIds)
1453 return civicrm_api3_create_error('Employer name and Employer id Mismatch');
1456 // show error if multiple organisation with same name exist
1457 if (empty($params['employer_id']) && (count($dupeIds) > 1)
1459 return civicrm_api3_create_error('Found more than one Organisation with same Name.');
1469 * @param $activityTypeID
1471 * @internal param $ <type> $result
1472 * @internal param $ <type> $activityTypeID
1474 * @return array <type> $params
1476 function _civicrm_api3_deprecated_activity_buildmailparams($result, $activityTypeID) {
1477 // get ready for collecting data about activity to be created
1480 $params['activity_type_id'] = $activityTypeID;
1482 $params['status_id'] = 2;
1483 $params['source_contact_id'] = $params['assignee_contact_id'] = $result['from']['id'];
1484 $params['target_contact_id'] = array();
1485 $keys = array('to', 'cc', 'bcc');
1486 foreach ($keys as $key) {
1487 if (is_array($result[$key])) {
1488 foreach ($result[$key] as $key => $keyValue) {
1489 if (!empty($keyValue['id'])) {
1490 $params['target_contact_id'][] = $keyValue['id'];
1495 $params['subject'] = $result['subject'];
1496 $params['activity_date_time'] = $result['date'];
1497 $params['details'] = $result['body'];
1499 for ($i = 1; $i <= 5; $i++
) {
1500 if (isset($result["attachFile_$i"])) {
1501 $params["attachFile_$i"] = $result["attachFile_$i"];