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
18 require_once 'CRM/Utils/DeprecatedUtils.php';
21 * class to parse membership csv files
23 class CRM_Event_Import_Parser_Participant
extends CRM_Event_Import_Parser
{
24 protected $_mapperKeys;
26 private $_contactIdIndex;
28 private $_participantStatusIndex;
29 private $_participantRoleIndex;
30 private $_eventTitleIndex;
33 * Array of successfully imported participants id's
37 protected $_newParticipants;
42 * @param array $mapperKeys
44 public function __construct(&$mapperKeys) {
45 parent
::__construct();
46 $this->_mapperKeys
= &$mapperKeys;
50 * The initializer code, called before the processing.
52 public function init() {
53 $fields = CRM_Event_BAO_Participant
::importableFields($this->_contactType
, FALSE);
54 $fields['event_id']['title'] = 'Event ID';
55 $eventfields = &CRM_Event_BAO_Event
::fields();
56 $fields['event_title'] = $eventfields['event_title'];
58 foreach ($fields as $name => $field) {
59 $field['type'] = CRM_Utils_Array
::value('type', $field, CRM_Utils_Type
::T_INT
);
60 $field['dataPattern'] = CRM_Utils_Array
::value('dataPattern', $field, '//');
61 $field['headerPattern'] = CRM_Utils_Array
::value('headerPattern', $field, '//');
62 $this->addField($name, $field['title'], $field['type'], $field['headerPattern'], $field['dataPattern']);
65 $this->_newParticipants
= [];
66 $this->setActiveFields($this->_mapperKeys
);
68 // FIXME: we should do this in one place together with Form/MapField.php
69 $this->_contactIdIndex
= -1;
70 $this->_eventIndex
= -1;
71 $this->_participantStatusIndex
= -1;
72 $this->_participantRoleIndex
= -1;
73 $this->_eventTitleIndex
= -1;
76 foreach ($this->_mapperKeys
as $key) {
79 case 'participant_contact_id':
80 $this->_contactIdIndex
= $index;
84 $this->_eventIndex
= $index;
87 case 'participant_status':
88 case 'participant_status_id':
89 $this->_participantStatusIndex
= $index;
92 case 'participant_role_id':
93 $this->_participantRoleIndex
= $index;
97 $this->_eventTitleIndex
= $index;
105 * Handle the values in mapField mode.
107 * @param array $values
108 * The array of values belonging to this line.
112 public function mapField(&$values) {
113 return CRM_Import_Parser
::VALID
;
117 * Handle the values in preview mode.
119 * @param array $values
120 * The array of values belonging to this line.
123 * the result of this processing
125 public function preview(&$values) {
126 return $this->summary($values);
130 * Handle the values in summary mode.
132 * @param array $values
133 * The array of values belonging to this line.
136 * the result of this processing
138 public function summary(&$values) {
139 $erroneousField = NULL;
141 $response = $this->setActiveFieldValues($values, $erroneousField);
142 $errorRequired = FALSE;
145 if ($this->_eventIndex
> -1 && $this->_eventTitleIndex
> -1) {
146 array_unshift($values, ts('Select either EventID OR Event Title'));
147 return CRM_Import_Parser
::ERROR
;
149 elseif ($this->_eventTitleIndex
> -1) {
150 $index = $this->_eventTitleIndex
;
152 elseif ($this->_eventIndex
> -1) {
153 $index = $this->_eventIndex
;
155 $params = &$this->getActiveFieldParams();
157 if (!(($index < 0) ||
($this->_participantStatusIndex
< 0))) {
158 $errorRequired = !CRM_Utils_Array
::value($this->_participantStatusIndex
, $values);
159 if (empty($params['event_id']) && empty($params['event_title'])) {
160 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Event', $missingField);
162 if (empty($params['participant_status_id'])) {
163 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Status', $missingField);
167 $errorRequired = TRUE;
168 $missingField = NULL;
170 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Event', $missingField);
172 if ($this->_participantStatusIndex
< 0) {
173 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Status', $missingField);
177 if ($errorRequired) {
178 array_unshift($values, ts('Missing required field(s) :') . $missingField);
179 return CRM_Import_Parser
::ERROR
;
182 $errorMessage = NULL;
185 $session = CRM_Core_Session
::singleton();
186 $dateType = $session->get('dateTypes');
188 foreach ($params as $key => $val) {
189 if ($val && ($key == 'participant_register_date')) {
190 if ($dateValue = CRM_Utils_Date
::formatDate($params[$key], $dateType)) {
191 $params[$key] = $dateValue;
194 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Register Date', $errorMessage);
197 elseif ($val && ($key == 'participant_role_id' ||
$key == 'participant_role')) {
198 $roleIDs = CRM_Event_PseudoConstant
::participantRole();
199 $val = explode(',', $val);
200 if ($key == 'participant_role_id') {
201 foreach ($val as $role) {
202 if (!array_key_exists(trim($role), $roleIDs)) {
203 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Role Id', $errorMessage);
209 foreach ($val as $role) {
210 if (!CRM_Contact_Import_Parser_Contact
::in_value(trim($role), $roleIDs)) {
211 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Role', $errorMessage);
217 elseif ($val && (($key == 'participant_status_id') ||
($key == 'participant_status'))) {
218 $statusIDs = CRM_Event_PseudoConstant
::participantStatus();
219 if ($key == 'participant_status_id') {
220 if (!array_key_exists(trim($val), $statusIDs)) {
221 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Status Id', $errorMessage);
225 elseif (!CRM_Contact_Import_Parser_Contact
::in_value($val, $statusIDs)) {
226 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Status', $errorMessage);
231 //date-Format part ends
233 $params['contact_type'] = 'Participant';
234 //checking error in custom data
235 CRM_Contact_Import_Parser_Contact
::isErrorInCustomData($params, $errorMessage);
238 $tempMsg = "Invalid value for field(s) : $errorMessage";
239 array_unshift($values, $tempMsg);
240 $errorMessage = NULL;
241 return CRM_Import_Parser
::ERROR
;
243 return CRM_Import_Parser
::VALID
;
247 * Handle the values in import mode.
249 * @param int $onDuplicate
250 * The code for what action to take on duplicates.
251 * @param array $values
252 * The array of values belonging to this line.
255 * the result of this processing
257 public function import($onDuplicate, &$values) {
259 // first make sure this is a valid line
260 $response = $this->summary($values);
261 if ($response != CRM_Import_Parser
::VALID
) {
264 $params = &$this->getActiveFieldParams();
265 $session = CRM_Core_Session
::singleton();
266 $dateType = $session->get('dateTypes');
267 $formatted = ['version' => 3];
268 $customFields = CRM_Core_BAO_CustomField
::getFields('Participant');
270 // don't add to recent items, CRM-4399
271 $formatted['skipRecentView'] = TRUE;
273 foreach ($params as $key => $val) {
275 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
276 if ($customFields[$customFieldID]['data_type'] == 'Date') {
277 CRM_Contact_Import_Parser_Contact
::formatCustomDate($params, $formatted, $dateType, $key);
278 unset($params[$key]);
280 elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') {
281 $params[$key] = CRM_Utils_String
::strtoboolstr($val);
284 if ($key == 'participant_register_date') {
285 CRM_Utils_Date
::convertToDefaultDate($params, $dateType, 'participant_register_date');
286 $formatted['participant_register_date'] = CRM_Utils_Date
::processDate($params['participant_register_date']);
291 if (!(!empty($params['participant_role_id']) ||
!empty($params['participant_role']))) {
292 if (!empty($params['event_id'])) {
293 $params['participant_role_id'] = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $params['event_id'], 'default_role_id');
296 $eventTitle = $params['event_title'];
298 $dao = new CRM_Core_DAO();
299 $params['participant_role_id'] = $dao->singleValueQuery("SELECT default_role_id FROM civicrm_event WHERE title = '$eventTitle' ",
305 //date-Format part ends
306 static $indieFields = NULL;
307 if ($indieFields == NULL) {
308 $indieFields = CRM_Event_BAO_Participant
::import();
312 foreach ($params as $key => $field) {
313 if ($field == NULL ||
$field === '') {
317 $formatValues[$key] = $field;
320 $formatError = $this->formatValues($formatted, $formatValues);
323 array_unshift($values, $formatError['error_message']);
324 return CRM_Import_Parser
::ERROR
;
327 if (!CRM_Utils_Rule
::integer($formatted['event_id'])) {
328 array_unshift($values, ts('Invalid value for Event ID'));
329 return CRM_Import_Parser
::ERROR
;
332 if ($onDuplicate != CRM_Import_Parser
::DUPLICATE_UPDATE
) {
333 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
339 if ($formatValues['participant_id']) {
340 $dao = new CRM_Event_BAO_Participant();
341 $dao->id
= $formatValues['participant_id'];
343 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
344 $formatValues['participant_id'],
347 if ($dao->find(TRUE)) {
349 'participant' => $formatValues['participant_id'],
350 'userId' => $session->get('userID'),
352 $participantValues = [];
353 //@todo calling api functions directly is not supported
354 $newParticipant = $this->deprecated_participant_check_params($formatted, $participantValues, FALSE);
355 if ($newParticipant['error_message']) {
356 array_unshift($values, $newParticipant['error_message']);
357 return CRM_Import_Parser
::ERROR
;
359 $newParticipant = CRM_Event_BAO_Participant
::create($formatted, $ids);
360 if (!empty($formatted['fee_level'])) {
362 'fee_label' => $formatted['fee_level'],
363 'event_id' => $newParticipant->event_id
,
365 CRM_Price_BAO_LineItem
::syncLineItems($newParticipant->id
, 'civicrm_participant', $newParticipant->fee_amount
, $otherParams);
368 $this->_newParticipant
[] = $newParticipant->id
;
369 return CRM_Import_Parser
::VALID
;
372 array_unshift($values, 'Matching Participant record not found for Participant ID ' . $formatValues['participant_id'] . '. Row was skipped.');
373 return CRM_Import_Parser
::ERROR
;
378 if ($this->_contactIdIndex
< 0) {
379 $error = $this->checkContactDuplicate($formatValues);
381 if (CRM_Core_Error
::isAPIError($error, CRM_Core_ERROR
::DUPLICATE_CONTACT
)) {
382 $matchedIDs = explode(',', $error['error_message']['params'][0]);
383 if (count($matchedIDs) >= 1) {
384 foreach ($matchedIDs as $contactId) {
385 $formatted['contact_id'] = $contactId;
386 $formatted['version'] = 3;
387 $newParticipant = $this->deprecated_create_participant_formatted($formatted, $onDuplicate);
392 // Using new Dedupe rule.
394 'contact_type' => $this->_contactType
,
395 'used' => 'Unsupervised',
397 $fieldsArray = CRM_Dedupe_BAO_DedupeRule
::dedupeRuleFields($ruleParams);
400 foreach ($fieldsArray as $value) {
401 if (array_key_exists(trim($value), $params)) {
402 $paramValue = $params[trim($value)];
403 if (is_array($paramValue)) {
404 $disp .= $params[trim($value)][0][trim($value)] . " ";
407 $disp .= $params[trim($value)] . " ";
412 if (!empty($params['external_identifier'])) {
414 $disp .= "AND {$params['external_identifier']}";
417 $disp = $params['external_identifier'];
421 array_unshift($values, 'No matching Contact found for (' . $disp . ')');
422 return CRM_Import_Parser
::ERROR
;
426 if (!empty($formatValues['external_identifier'])) {
427 $checkCid = new CRM_Contact_DAO_Contact();
428 $checkCid->external_identifier
= $formatValues['external_identifier'];
429 $checkCid->find(TRUE);
430 if ($checkCid->id
!= $formatted['contact_id']) {
431 array_unshift($values, 'Mismatch of External ID:' . $formatValues['external_identifier'] . ' and Contact Id:' . $formatted['contact_id']);
432 return CRM_Import_Parser
::ERROR
;
436 $newParticipant = $this->deprecated_create_participant_formatted($formatted, $onDuplicate);
439 if (is_array($newParticipant) && civicrm_error($newParticipant)) {
440 if ($onDuplicate == CRM_Import_Parser
::DUPLICATE_SKIP
) {
442 $contactID = $newParticipant['contactID'] ??
NULL;
443 $participantID = $newParticipant['participantID'] ??
NULL;
444 $url = CRM_Utils_System
::url('civicrm/contact/view/participant',
445 "reset=1&id={$participantID}&cid={$contactID}&action=view", TRUE
447 if (is_array($newParticipant['error_message']) &&
448 ($participantID == $newParticipant['error_message']['params'][0])
450 array_unshift($values, $url);
451 return CRM_Import_Parser
::DUPLICATE
;
453 elseif ($newParticipant['error_message']) {
454 array_unshift($values, $newParticipant['error_message']);
455 return CRM_Import_Parser
::ERROR
;
457 return CRM_Import_Parser
::ERROR
;
461 if (!(is_array($newParticipant) && civicrm_error($newParticipant))) {
462 $this->_newParticipants
[] = $newParticipant['id'] ??
NULL;
465 return CRM_Import_Parser
::VALID
;
469 * Get the array of successfully imported Participation ids.
473 public function &getImportedParticipations() {
474 return $this->_newParticipants
;
478 * The initializer code, called before the processing
482 public function fini() {
488 * @todo lots of tidy up needed here - very old function relocated.
490 * @param array $values
491 * @param array $params
495 protected function formatValues(&$values, $params) {
496 $fields = CRM_Event_DAO_Participant
::fields();
497 _civicrm_api3_store_values($fields, $params, $values);
499 $customFields = CRM_Core_BAO_CustomField
::getFields('Participant', FALSE, FALSE, NULL, NULL, FALSE, FALSE, FALSE);
501 foreach ($params as $key => $value) {
502 // ignore empty values or empty arrays etc
503 if (CRM_Utils_System
::isNull($value)) {
507 // Handling Custom Data
508 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
509 $values[$key] = $value;
510 $type = $customFields[$customFieldID]['html_type'];
511 if (CRM_Core_BAO_CustomField
::isSerialized($customFields[$customFieldID])) {
512 $values[$key] = self
::unserializeCustomValue($customFieldID, $value, $type);
514 elseif ($type == 'Select' ||
$type == 'Radio') {
515 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
516 foreach ($customOption as $customFldID => $customValue) {
517 $val = $customValue['value'] ??
NULL;
518 $label = $customValue['label'] ??
NULL;
519 $label = strtolower($label);
520 $value = strtolower(trim($value));
521 if (($value == $label) ||
($value == strtolower($val))) {
522 $values[$key] = $val;
529 case 'participant_contact_id':
530 if (!CRM_Utils_Rule
::integer($value)) {
531 return civicrm_api3_create_error("contact_id not valid: $value");
533 if (!CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_contact WHERE id = $value")) {
534 return civicrm_api3_create_error("Invalid Contact ID: There is no contact record with contact_id = $value.");
536 $values['contact_id'] = $values['participant_contact_id'];
537 unset($values['participant_contact_id']);
540 case 'participant_register_date':
541 if (!CRM_Utils_Rule
::dateTime($value)) {
542 return civicrm_api3_create_error("$key not a valid date: $value");
547 $id = CRM_Core_DAO
::getFieldValue("CRM_Event_DAO_Event", $value, 'id', 'title');
548 $values['event_id'] = $id;
552 if (!CRM_Utils_Rule
::integer($value)) {
553 return civicrm_api3_create_error("Event ID is not valid: $value");
555 $dao = new CRM_Core_DAO();
557 $svq = $dao->singleValueQuery("SELECT id FROM civicrm_event WHERE id = $value",
561 return civicrm_api3_create_error("Invalid Event ID: There is no event record with event_id = $value.");
565 case 'participant_status_id':
566 if (!CRM_Utils_Rule
::integer($value)) {
567 return civicrm_api3_create_error("Event Status ID is not valid: $value");
571 case 'participant_status':
572 $status = CRM_Event_PseudoConstant
::participantStatus();
573 $values['participant_status_id'] = CRM_Utils_Array
::key($value, $status);
576 case 'participant_role_id':
577 case 'participant_role':
578 $role = CRM_Event_PseudoConstant
::participantRole();
579 $participantRoles = explode(",", $value);
580 foreach ($participantRoles as $k => $v) {
582 if ($key == 'participant_role') {
583 $participantRoles[$k] = CRM_Utils_Array
::key($v, $role);
586 $participantRoles[$k] = $v;
589 $values['role_id'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $participantRoles);
590 unset($values[$key]);
598 if (array_key_exists('participant_note', $params)) {
599 $values['participant_note'] = $params['participant_note'];
602 // CRM_Event_BAO_Participant::create() handles register_date,
603 // status_id and source. So, if $values contains
604 // participant_register_date, participant_status_id or participant_source,
605 // convert it to register_date, status_id or source
607 'participant_register_date' => 'register_date',
608 'participant_source' => 'source',
609 'participant_status_id' => 'status_id',
610 'participant_role_id' => 'role_id',
611 'participant_fee_level' => 'fee_level',
612 'participant_fee_amount' => 'fee_amount',
613 'participant_id' => 'id',
616 foreach ($changes as $orgVal => $changeVal) {
617 if (isset($values[$orgVal])) {
618 $values[$changeVal] = $values[$orgVal];
619 unset($values[$orgVal]);
627 * @param array $params
628 * @param $onDuplicate
632 * @throws \CiviCRM_API3_Exception
633 * @deprecated - this is part of the import parser not the API & needs to be
637 protected function deprecated_create_participant_formatted($params, $onDuplicate) {
638 if ($onDuplicate != CRM_Import_Parser
::DUPLICATE_NOCHECK
) {
639 CRM_Core_Error
::reset();
640 $error = $this->deprecated_participant_check_params($params, TRUE);
641 if (civicrm_error($error)) {
645 return civicrm_api3('Participant', 'create', $params);
649 * Formatting that was written a long time ago and may not make sense now.
651 * @param array $params
653 * @param bool $checkDuplicate
657 protected function deprecated_participant_check_params($params, $checkDuplicate = FALSE) {
659 // check if participant id is valid or not
660 if (!empty($params['id'])) {
661 $participant = new CRM_Event_BAO_Participant();
662 $participant->id
= $params['id'];
663 if (!$participant->find(TRUE)) {
664 return civicrm_api3_create_error(ts('Participant id is not valid'));
668 // check if contact id is valid or not
669 if (!empty($params['contact_id'])) {
670 $contact = new CRM_Contact_BAO_Contact();
671 $contact->id
= $params['contact_id'];
672 if (!$contact->find(TRUE)) {
673 return civicrm_api3_create_error(ts('Contact id is not valid'));
677 // check that event id is not an template
678 if (!empty($params['event_id'])) {
679 $isTemplate = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $params['event_id'], 'is_template');
680 if (!empty($isTemplate)) {
681 return civicrm_api3_create_error(ts('Event templates are not meant to be registered.'));
686 if ($checkDuplicate) {
687 if (CRM_Event_BAO_Participant
::checkDuplicate($params, $result)) {
688 $participantID = array_pop($result);
690 $error = CRM_Core_Error
::createError("Found matching participant record.",
691 CRM_Core_Error
::DUPLICATE_PARTICIPANT
,
692 'Fatal', $participantID
695 return civicrm_api3_create_error($error->pop(),
697 'contactID' => $params['contact_id'],
698 'participantID' => $participantID,