3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
36 require_once 'CRM/Utils/DeprecatedUtils.php';
39 * class to parse membership csv files
41 class CRM_Event_Import_Parser_Participant
extends CRM_Event_Import_Parser
{
42 protected $_mapperKeys;
44 private $_contactIdIndex;
46 private $_participantStatusIndex;
47 private $_participantRoleIndex;
48 private $_eventTitleIndex;
51 * Array of successfully imported participants id's
55 protected $_newParticipants;
60 * @param array $mapperKeys
61 * @param null $mapperLocType
62 * @param null $mapperPhoneType
64 public function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) {
65 parent
::__construct();
66 $this->_mapperKeys
= &$mapperKeys;
70 * The initializer code, called before the processing.
72 public function init() {
73 $fields = CRM_Event_BAO_Participant
::importableFields($this->_contactType
, FALSE);
74 $fields['event_id']['title'] = 'Event ID';
75 $eventfields = &CRM_Event_BAO_Event
::fields();
76 $fields['event_title'] = $eventfields['event_title'];
78 foreach ($fields as $name => $field) {
79 $field['type'] = CRM_Utils_Array
::value('type', $field, CRM_Utils_Type
::T_INT
);
80 $field['dataPattern'] = CRM_Utils_Array
::value('dataPattern', $field, '//');
81 $field['headerPattern'] = CRM_Utils_Array
::value('headerPattern', $field, '//');
82 $this->addField($name, $field['title'], $field['type'], $field['headerPattern'], $field['dataPattern']);
85 $this->_newParticipants
= array();
86 $this->setActiveFields($this->_mapperKeys
);
88 // FIXME: we should do this in one place together with Form/MapField.php
89 $this->_contactIdIndex
= -1;
90 $this->_eventIndex
= -1;
91 $this->_participantStatusIndex
= -1;
92 $this->_participantRoleIndex
= -1;
93 $this->_eventTitleIndex
= -1;
96 foreach ($this->_mapperKeys
as $key) {
99 case 'participant_contact_id':
100 $this->_contactIdIndex
= $index;
104 $this->_eventIndex
= $index;
107 case 'participant_status':
108 case 'participant_status_id':
109 $this->_participantStatusIndex
= $index;
112 case 'participant_role_id':
113 $this->_participantRoleIndex
= $index;
117 $this->_eventTitleIndex
= $index;
125 * Handle the values in mapField mode.
127 * @param array $values
128 * The array of values belonging to this line.
132 public function mapField(&$values) {
133 return CRM_Import_Parser
::VALID
;
137 * Handle the values in preview mode.
139 * @param array $values
140 * The array of values belonging to this line.
143 * the result of this processing
145 public function preview(&$values) {
146 return $this->summary($values);
150 * Handle the values in summary mode.
152 * @param array $values
153 * The array of values belonging to this line.
156 * the result of this processing
158 public function summary(&$values) {
159 $erroneousField = NULL;
161 $response = $this->setActiveFieldValues($values, $erroneousField);
162 $errorRequired = FALSE;
165 if ($this->_eventIndex
> -1 && $this->_eventTitleIndex
> -1) {
166 array_unshift($values, ts('Select either EventID OR Event Title'));
167 return CRM_Import_Parser
::ERROR
;
169 elseif ($this->_eventTitleIndex
> -1) {
170 $index = $this->_eventTitleIndex
;
172 elseif ($this->_eventIndex
> -1) {
173 $index = $this->_eventIndex
;
175 $params = &$this->getActiveFieldParams();
177 if (!(($index < 0) ||
($this->_participantStatusIndex
< 0))) {
178 $errorRequired = !CRM_Utils_Array
::value($this->_participantStatusIndex
, $values);
179 if (empty($params['event_id']) && empty($params['event_title'])) {
180 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Event', $missingField);
182 if (empty($params['participant_status_id'])) {
183 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Status', $missingField);
187 $errorRequired = TRUE;
188 $missingField = NULL;
190 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Event', $missingField);
192 if ($this->_participantStatusIndex
< 0) {
193 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Status', $missingField);
197 if ($errorRequired) {
198 array_unshift($values, ts('Missing required field(s) :') . $missingField);
199 return CRM_Import_Parser
::ERROR
;
202 $errorMessage = NULL;
205 $session = CRM_Core_Session
::singleton();
206 $dateType = $session->get('dateTypes');
208 foreach ($params as $key => $val) {
209 if ($val && ($key == 'participant_register_date')) {
210 if ($dateValue = CRM_Utils_Date
::formatDate($params[$key], $dateType)) {
211 $params[$key] = $dateValue;
214 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Register Date', $errorMessage);
217 elseif ($val && ($key == 'participant_role_id' ||
$key == 'participant_role')) {
218 $roleIDs = CRM_Event_PseudoConstant
::participantRole();
219 $val = explode(',', $val);
220 if ($key == 'participant_role_id') {
221 foreach ($val as $role) {
222 if (!in_array(trim($role), array_keys($roleIDs))) {
223 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Role Id', $errorMessage);
229 foreach ($val as $role) {
230 if (!CRM_Contact_Import_Parser_Contact
::in_value(trim($role), $roleIDs)) {
231 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Role', $errorMessage);
237 elseif ($val && (($key == 'participant_status_id') ||
($key == 'participant_status'))) {
238 $statusIDs = CRM_Event_PseudoConstant
::participantStatus();
239 if ($key == 'participant_status_id') {
240 if (!in_array(trim($val), array_keys($statusIDs))) {
241 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Status Id', $errorMessage);
245 elseif (!CRM_Contact_Import_Parser_Contact
::in_value($val, $statusIDs)) {
246 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Status', $errorMessage);
251 //date-Format part ends
253 $params['contact_type'] = 'Participant';
254 //checking error in custom data
255 CRM_Contact_Import_Parser_Contact
::isErrorInCustomData($params, $errorMessage);
258 $tempMsg = "Invalid value for field(s) : $errorMessage";
259 array_unshift($values, $tempMsg);
260 $errorMessage = NULL;
261 return CRM_Import_Parser
::ERROR
;
263 return CRM_Import_Parser
::VALID
;
267 * Handle the values in import mode.
269 * @param int $onDuplicate
270 * The code for what action to take on duplicates.
271 * @param array $values
272 * The array of values belonging to this line.
275 * the result of this processing
277 public function import($onDuplicate, &$values) {
279 // first make sure this is a valid line
280 $response = $this->summary($values);
281 if ($response != CRM_Import_Parser
::VALID
) {
284 $params = &$this->getActiveFieldParams();
285 $session = CRM_Core_Session
::singleton();
286 $dateType = $session->get('dateTypes');
287 $formatted = array('version' => 3);
288 $customFields = CRM_Core_BAO_CustomField
::getFields(CRM_Utils_Array
::value('contact_type', $params));
290 // don't add to recent items, CRM-4399
291 $formatted['skipRecentView'] = TRUE;
293 foreach ($params as $key => $val) {
295 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
296 if ($customFields[$customFieldID]['data_type'] == 'Date') {
297 CRM_Contact_Import_Parser_Contact
::formatCustomDate($params, $formatted, $dateType, $key);
298 unset($params[$key]);
300 elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') {
301 $params[$key] = CRM_Utils_String
::strtoboolstr($val);
304 if ($key == 'participant_register_date') {
305 CRM_Utils_Date
::convertToDefaultDate($params, $dateType, 'participant_register_date');
306 $formatted['participant_register_date'] = CRM_Utils_Date
::processDate($params['participant_register_date']);
311 if (!(!empty($params['participant_role_id']) ||
!empty($params['participant_role']))) {
312 if (!empty($params['event_id'])) {
313 $params['participant_role_id'] = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $params['event_id'], 'default_role_id');
316 $eventTitle = $params['event_title'];
318 $dao = new CRM_Core_DAO();
319 $params['participant_role_id'] = $dao->singleValueQuery("SELECT default_role_id FROM civicrm_event WHERE title = '$eventTitle' ",
325 //date-Format part ends
326 static $indieFields = NULL;
327 if ($indieFields == NULL) {
328 $indieFields = CRM_Event_BAO_Participant
::import();
331 $formatValues = array();
332 foreach ($params as $key => $field) {
333 if ($field == NULL ||
$field === '') {
337 $formatValues[$key] = $field;
340 $formatError = $this->formatValues($formatted, $formatValues);
343 array_unshift($values, $formatError['error_message']);
344 return CRM_Import_Parser
::ERROR
;
347 if (!CRM_Utils_Rule
::integer($formatted['event_id'])) {
348 array_unshift($values, ts('Invalid value for Event ID'));
349 return CRM_Import_Parser
::ERROR
;
352 if ($onDuplicate != CRM_Import_Parser
::DUPLICATE_UPDATE
) {
353 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
359 if ($formatValues['participant_id']) {
360 $dao = new CRM_Event_BAO_Participant();
361 $dao->id
= $formatValues['participant_id'];
363 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
364 $formatValues['participant_id'],
367 if ($dao->find(TRUE)) {
369 'participant' => $formatValues['participant_id'],
370 'userId' => $session->get('userID'),
372 $participantValues = array();
373 //@todo calling api functions directly is not supported
374 $newParticipant = _civicrm_api3_deprecated_participant_check_params($formatted, $participantValues, FALSE);
375 if ($newParticipant['error_message']) {
376 array_unshift($values, $newParticipant['error_message']);
377 return CRM_Import_Parser
::ERROR
;
379 $newParticipant = CRM_Event_BAO_Participant
::create($formatted, $ids);
380 if (!empty($formatted['fee_level'])) {
381 $otherParams = array(
382 'fee_label' => $formatted['fee_level'],
383 'event_id' => $newParticipant->event_id
,
385 CRM_Price_BAO_LineItem
::syncLineItems($newParticipant->id
, 'civicrm_participant', $newParticipant->fee_amount
, $otherParams);
388 $this->_newParticipant
[] = $newParticipant->id
;
389 return CRM_Import_Parser
::VALID
;
392 array_unshift($values, 'Matching Participant record not found for Participant ID ' . $formatValues['participant_id'] . '. Row was skipped.');
393 return CRM_Import_Parser
::ERROR
;
398 if ($this->_contactIdIndex
< 0) {
399 $error = $this->checkContactDuplicate($formatValues);
401 if (CRM_Core_Error
::isAPIError($error, CRM_Core_ERROR
::DUPLICATE_CONTACT
)) {
402 $matchedIDs = explode(',', $error['error_message']['params'][0]);
403 if (count($matchedIDs) >= 1) {
404 foreach ($matchedIDs as $contactId) {
405 $formatted['contact_id'] = $contactId;
406 $formatted['version'] = 3;
407 $newParticipant = _civicrm_api3_deprecated_create_participant_formatted($formatted, $onDuplicate);
412 // Using new Dedupe rule.
414 'contact_type' => $this->_contactType
,
415 'used' => 'Unsupervised',
417 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
420 foreach ($fieldsArray as $value) {
421 if (array_key_exists(trim($value), $params)) {
422 $paramValue = $params[trim($value)];
423 if (is_array($paramValue)) {
424 $disp .= $params[trim($value)][0][trim($value)] . " ";
427 $disp .= $params[trim($value)] . " ";
432 if (!empty($params['external_identifier'])) {
434 $disp .= "AND {$params['external_identifier']}";
437 $disp = $params['external_identifier'];
441 array_unshift($values, 'No matching Contact found for (' . $disp . ')');
442 return CRM_Import_Parser
::ERROR
;
446 if (!empty($formatValues['external_identifier'])) {
447 $checkCid = new CRM_Contact_DAO_Contact();
448 $checkCid->external_identifier
= $formatValues['external_identifier'];
449 $checkCid->find(TRUE);
450 if ($checkCid->id
!= $formatted['contact_id']) {
451 array_unshift($values, 'Mismatch of External ID:' . $formatValues['external_identifier'] . ' and Contact Id:' . $formatted['contact_id']);
452 return CRM_Import_Parser
::ERROR
;
456 $newParticipant = _civicrm_api3_deprecated_create_participant_formatted($formatted, $onDuplicate);
459 if (is_array($newParticipant) && civicrm_error($newParticipant)) {
460 if ($onDuplicate == CRM_Import_Parser
::DUPLICATE_SKIP
) {
462 $contactID = CRM_Utils_Array
::value('contactID', $newParticipant);
463 $participantID = CRM_Utils_Array
::value('participantID', $newParticipant);
464 $url = CRM_Utils_System
::url('civicrm/contact/view/participant',
465 "reset=1&id={$participantID}&cid={$contactID}&action=view", TRUE
467 if (is_array($newParticipant['error_message']) &&
468 ($participantID == $newParticipant['error_message']['params'][0])
470 array_unshift($values, $url);
471 return CRM_Import_Parser
::DUPLICATE
;
473 elseif ($newParticipant['error_message']) {
474 array_unshift($values, $newParticipant['error_message']);
475 return CRM_Import_Parser
::ERROR
;
477 return CRM_Import_Parser
::ERROR
;
481 if (!(is_array($newParticipant) && civicrm_error($newParticipant))) {
482 $this->_newParticipants
[] = CRM_Utils_Array
::value('id', $newParticipant);
485 return CRM_Import_Parser
::VALID
;
489 * Get the array of successfully imported Participation ids.
493 public function &getImportedParticipations() {
494 return $this->_newParticipants
;
498 * The initializer code, called before the processing
502 public function fini() {
508 * @todo lots of tidy up needed here - very old function relocated.
510 * @param array $values
511 * @param array $params
515 protected function formatValues(&$values, $params) {
516 $fields = CRM_Event_DAO_Participant
::fields();
517 _civicrm_api3_store_values($fields, $params, $values);
519 $customFields = CRM_Core_BAO_CustomField
::getFields('Participant', FALSE, FALSE, NULL, NULL, FALSE, FALSE, FALSE);
521 foreach ($params as $key => $value) {
522 // ignore empty values or empty arrays etc
523 if (CRM_Utils_System
::isNull($value)) {
527 // Handling Custom Data
528 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
529 $values[$key] = $value;
530 $type = $customFields[$customFieldID]['html_type'];
531 if ($type == 'CheckBox' ||
$type == 'Multi-Select') {
532 $mulValues = explode(',', $value);
533 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
534 $values[$key] = array();
535 foreach ($mulValues as $v1) {
536 foreach ($customOption as $customValueID => $customLabel) {
537 $customValue = $customLabel['value'];
538 if ((strtolower(trim($customLabel['label'])) == strtolower(trim($v1))) ||
539 (strtolower(trim($customValue)) == strtolower(trim($v1)))
541 if ($type == 'CheckBox') {
542 $values[$key][$customValue] = 1;
545 $values[$key][] = $customValue;
551 elseif ($type == 'Select' ||
$type == 'Radio') {
552 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
553 foreach ($customOption as $customFldID => $customValue) {
554 $val = CRM_Utils_Array
::value('value', $customValue);
555 $label = CRM_Utils_Array
::value('label', $customValue);
556 $label = strtolower($label);
557 $value = strtolower(trim($value));
558 if (($value == $label) ||
($value == strtolower($val))) {
559 $values[$key] = $val;
566 case 'participant_contact_id':
567 if (!CRM_Utils_Rule
::integer($value)) {
568 return civicrm_api3_create_error("contact_id not valid: $value");
570 if (!CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_contact WHERE id = $value")) {
571 return civicrm_api3_create_error("Invalid Contact ID: There is no contact record with contact_id = $value.");
573 $values['contact_id'] = $values['participant_contact_id'];
574 unset($values['participant_contact_id']);
577 case 'participant_register_date':
578 if (!CRM_Utils_Rule
::dateTime($value)) {
579 return civicrm_api3_create_error("$key not a valid date: $value");
584 $id = CRM_Core_DAO
::getFieldValue("CRM_Event_DAO_Event", $value, 'id', 'title');
585 $values['event_id'] = $id;
589 if (!CRM_Utils_Rule
::integer($value)) {
590 return civicrm_api3_create_error("Event ID is not valid: $value");
592 $dao = new CRM_Core_DAO();
594 $svq = $dao->singleValueQuery("SELECT id FROM civicrm_event WHERE id = $value",
598 return civicrm_api3_create_error("Invalid Event ID: There is no event record with event_id = $value.");
602 case 'participant_status_id':
603 if (!CRM_Utils_Rule
::integer($value)) {
604 return civicrm_api3_create_error("Event Status ID is not valid: $value");
608 case 'participant_status':
609 $status = CRM_Event_PseudoConstant
::participantStatus();
610 $values['participant_status_id'] = CRM_Utils_Array
::key($value, $status);;
613 case 'participant_role_id':
614 case 'participant_role':
615 $role = CRM_Event_PseudoConstant
::participantRole();
616 $participantRoles = explode(",", $value);
617 foreach ($participantRoles as $k => $v) {
619 if ($key == 'participant_role') {
620 $participantRoles[$k] = CRM_Utils_Array
::key($v, $role);
623 $participantRoles[$k] = $v;
626 $values['role_id'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $participantRoles);
627 unset($values[$key]);
635 if (array_key_exists('participant_note', $params)) {
636 $values['participant_note'] = $params['participant_note'];
639 // CRM_Event_BAO_Participant::create() handles register_date,
640 // status_id and source. So, if $values contains
641 // participant_register_date, participant_status_id or participant_source,
642 // convert it to register_date, status_id or source
644 'participant_register_date' => 'register_date',
645 'participant_source' => 'source',
646 'participant_status_id' => 'status_id',
647 'participant_role_id' => 'role_id',
648 'participant_fee_level' => 'fee_level',
649 'participant_fee_amount' => 'fee_amount',
650 'participant_id' => 'id',
653 foreach ($changes as $orgVal => $changeVal) {
654 if (isset($values[$orgVal])) {
655 $values[$changeVal] = $values[$orgVal];
656 unset($values[$orgVal]);