3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
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 $_totalAmountIndex;
49 private $_participantStatusIndex;
50 private $_participantRoleIndex;
51 private $_eventTitleIndex;
54 * Array of successfully imported participants id's
58 protected $_newParticipants;
63 public function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) {
64 parent
::__construct();
65 $this->_mapperKeys
= &$mapperKeys;
69 * The initializer code, called before the processing
73 public function init() {
74 $fields = CRM_Event_BAO_Participant
::importableFields($this->_contactType
, FALSE);
75 $fields['event_id']['title'] = 'Event ID';
76 $eventfields = &CRM_Event_BAO_Event
::fields();
77 $fields['event_title'] = $eventfields['event_title'];
79 foreach ($fields as $name => $field) {
80 $field['type'] = CRM_Utils_Array
::value('type', $field, CRM_Utils_Type
::T_INT
);
81 $field['dataPattern'] = CRM_Utils_Array
::value('dataPattern', $field, '//');
82 $field['headerPattern'] = CRM_Utils_Array
::value('headerPattern', $field, '//');
83 $this->addField($name, $field['title'], $field['type'], $field['headerPattern'], $field['dataPattern']);
86 $this->_newParticipants
= array();
87 $this->setActiveFields($this->_mapperKeys
);
89 // FIXME: we should do this in one place together with Form/MapField.php
90 $this->_contactIdIndex
= -1;
91 $this->_eventIndex
= -1;
92 $this->_participantStatusIndex
= -1;
93 $this->_participantRoleIndex
= -1;
94 $this->_eventTitleIndex
= -1;
97 foreach ($this->_mapperKeys
as $key) {
100 case 'participant_contact_id':
101 $this->_contactIdIndex
= $index;
105 $this->_eventIndex
= $index;
108 case 'participant_status':
109 case 'participant_status_id':
110 $this->_participantStatusIndex
= $index;
113 case 'participant_role_id':
114 $this->_participantRoleIndex
= $index;
118 $this->_eventTitleIndex
= $index;
126 * Handle the values in mapField mode
128 * @param array $values
129 * The array of values belonging to this line.
133 public function mapField(&$values) {
134 return CRM_Import_Parser
::VALID
;
138 * Handle the values in preview mode
140 * @param array $values
141 * The array of values belonging to this line.
144 * the result of this processing
146 public function preview(&$values) {
147 return $this->summary($values);
151 * Handle the values in summary mode
153 * @param array $values
154 * The array of values belonging to this line.
157 * the result of this processing
159 public function summary(&$values) {
160 $erroneousField = NULL;
162 $response = $this->setActiveFieldValues($values, $erroneousField);
163 $errorRequired = FALSE;
166 if ($this->_eventIndex
> -1 && $this->_eventTitleIndex
> -1) {
167 array_unshift($values, ts('Select either EventID OR Event Title'));
168 return CRM_Import_Parser
::ERROR
;
170 elseif ($this->_eventTitleIndex
> -1) {
171 $index = $this->_eventTitleIndex
;
173 elseif ($this->_eventIndex
> -1) {
174 $index = $this->_eventIndex
;
176 $params = &$this->getActiveFieldParams();
178 if (!(($index < 0) ||
($this->_participantStatusIndex
< 0))) {
179 $errorRequired = !CRM_Utils_Array
::value($this->_participantStatusIndex
, $values);
180 if (empty($params['event_id']) && empty($params['event_title'])) {
181 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Event', $missingField);
183 if (empty($params['participant_status_id'])) {
184 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Status', $missingField);
188 $errorRequired = TRUE;
189 $missingField = NULL;
191 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Event', $missingField);
193 if ($this->_participantStatusIndex
< 0) {
194 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Status', $missingField);
198 if ($errorRequired) {
199 array_unshift($values, ts('Missing required field(s) :') . $missingField);
200 return CRM_Import_Parser
::ERROR
;
203 $errorMessage = NULL;
206 $session = CRM_Core_Session
::singleton();
207 $dateType = $session->get('dateTypes');
209 foreach ($params as $key => $val) {
210 if ($val && ($key == 'participant_register_date')) {
211 if ($dateValue = CRM_Utils_Date
::formatDate($params[$key], $dateType)) {
212 $params[$key] = $dateValue;
215 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Register Date', $errorMessage);
218 elseif ($val && ($key == 'participant_role_id' ||
$key == 'participant_role')) {
219 $roleIDs = CRM_Event_PseudoConstant
::participantRole();
220 $val = explode(',', $val);
221 if ($key == 'participant_role_id') {
222 foreach ($val as $role) {
223 if (!in_array(trim($role), array_keys($roleIDs))) {
224 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Role Id', $errorMessage);
230 foreach ($val as $role) {
231 if (!CRM_Contact_Import_Parser_Contact
::in_value(trim($role), $roleIDs)) {
232 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Role', $errorMessage);
238 elseif ($val && (($key == 'participant_status_id') ||
($key == 'participant_status'))) {
239 $statusIDs = CRM_Event_PseudoConstant
::participantStatus();
240 if ($key == 'participant_status_id') {
241 if (!in_array(trim($val), array_keys($statusIDs))) {
242 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Status Id', $errorMessage);
246 elseif (!CRM_Contact_Import_Parser_Contact
::in_value($val, $statusIDs)) {
247 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Participant Status', $errorMessage);
252 //date-Format part ends
254 $params['contact_type'] = 'Participant';
255 //checking error in custom data
256 CRM_Contact_Import_Parser_Contact
::isErrorInCustomData($params, $errorMessage);
259 $tempMsg = "Invalid value for field(s) : $errorMessage";
260 array_unshift($values, $tempMsg);
261 $errorMessage = NULL;
262 return CRM_Import_Parser
::ERROR
;
264 return CRM_Import_Parser
::VALID
;
268 * Handle the values in import mode
270 * @param int $onDuplicate
271 * The code for what action to take on duplicates.
272 * @param array $values
273 * The array of values belonging to this line.
276 * the result of this processing
278 public function import($onDuplicate, &$values) {
280 // first make sure this is a valid line
281 $response = $this->summary($values);
282 if ($response != CRM_Import_Parser
::VALID
) {
285 $params = &$this->getActiveFieldParams();
286 $session = CRM_Core_Session
::singleton();
287 $dateType = $session->get('dateTypes');
288 $formatted = array('version' => 3);
289 $customFields = CRM_Core_BAO_CustomField
::getFields(CRM_Utils_Array
::value('contact_type', $params));
291 // don't add to recent items, CRM-4399
292 $formatted['skipRecentView'] = TRUE;
294 foreach ($params as $key => $val) {
296 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
297 if ($customFields[$customFieldID]['data_type'] == 'Date') {
298 CRM_Contact_Import_Parser_Contact
::formatCustomDate($params, $formatted, $dateType, $key);
299 unset($params[$key]);
301 elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') {
302 $params[$key] = CRM_Utils_String
::strtoboolstr($val);
305 if ($key == 'participant_register_date') {
306 CRM_Utils_Date
::convertToDefaultDate($params, $dateType, 'participant_register_date');
307 $formatted['participant_register_date'] = CRM_Utils_Date
::processDate($params['participant_register_date']);
312 if (!(!empty($params['participant_role_id']) ||
!empty($params['participant_role']))) {
313 if (!empty($params['event_id'])) {
314 $params['participant_role_id'] = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $params['event_id'], 'default_role_id');
317 $eventTitle = $params['event_title'];
319 $dao = new CRM_Core_DAO();
320 $params['participant_role_id'] = $dao->singleValueQuery("SELECT default_role_id FROM civicrm_event WHERE title = '$eventTitle' ",
326 //date-Format part ends
327 static $indieFields = NULL;
328 if ($indieFields == NULL) {
329 $indieFields = CRM_Event_BAO_Participant
::import();
332 $formatValues = array();
333 foreach ($params as $key => $field) {
334 if ($field == NULL ||
$field === '') {
338 $formatValues[$key] = $field;
341 $formatError = _civicrm_api3_deprecated_participant_formatted_param($formatValues, $formatted, TRUE);
344 array_unshift($values, $formatError['error_message']);
345 return CRM_Import_Parser
::ERROR
;
348 if (!CRM_Utils_Rule
::integer($formatted['event_id'])) {
349 array_unshift($values, ts('Invalid value for Event ID'));
350 return CRM_Import_Parser
::ERROR
;
353 if ($onDuplicate != CRM_Import_Parser
::DUPLICATE_UPDATE
) {
354 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
355 CRM_Core_DAO
::$_nullObject,
361 if ($formatValues['participant_id']) {
362 $dao = new CRM_Event_BAO_Participant();
363 $dao->id
= $formatValues['participant_id'];
365 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
366 CRM_Core_DAO
::$_nullObject,
367 $formatValues['participant_id'],
370 if ($dao->find(TRUE)) {
372 'participant' => $formatValues['participant_id'],
373 'userId' => $session->get('userID'),
375 $participantValues = array();
376 //@todo calling api functions directly is not supported
377 $newParticipant = _civicrm_api3_deprecated_participant_check_params($formatted, $participantValues, FALSE);
378 if ($newParticipant['error_message']) {
379 array_unshift($values, $newParticipant['error_message']);
380 return CRM_Import_Parser
::ERROR
;
382 $newParticipant = CRM_Event_BAO_Participant
::create($formatted, $ids);
383 if (!empty($formatted['fee_level'])) {
384 $otherParams = array(
385 'fee_label' => $formatted['fee_level'],
386 'event_id' => $newParticipant->event_id
,
388 CRM_Price_BAO_LineItem
::syncLineItems($newParticipant->id
, 'civicrm_participant', $newParticipant->fee_amount
, $otherParams);
391 $this->_newParticipant
[] = $newParticipant->id
;
392 return CRM_Import_Parser
::VALID
;
395 array_unshift($values, 'Matching Participant record not found for Participant ID ' . $formatValues['participant_id'] . '. Row was skipped.');
396 return CRM_Import_Parser
::ERROR
;
401 if ($this->_contactIdIndex
< 0) {
403 //retrieve contact id using contact dedupe rule
404 $formatValues['contact_type'] = $this->_contactType
;
405 $formatValues['version'] = 3;
406 $error = _civicrm_api3_deprecated_check_contact_dedupe($formatValues);
408 if (CRM_Core_Error
::isAPIError($error, CRM_Core_ERROR
::DUPLICATE_CONTACT
)) {
409 $matchedIDs = explode(',', $error['error_message']['params'][0]);
410 if (count($matchedIDs) >= 1) {
411 foreach ($matchedIDs as $contactId) {
412 $formatted['contact_id'] = $contactId;
413 $formatted['version'] = 3;
414 $newParticipant = _civicrm_api3_deprecated_create_participant_formatted($formatted, $onDuplicate);
419 // Using new Dedupe rule.
421 'contact_type' => $this->_contactType
,
422 'used' => 'Unsupervised',
424 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
427 foreach ($fieldsArray as $value) {
428 if (array_key_exists(trim($value), $params)) {
429 $paramValue = $params[trim($value)];
430 if (is_array($paramValue)) {
431 $disp .= $params[trim($value)][0][trim($value)] . " ";
434 $disp .= $params[trim($value)] . " ";
439 if (!empty($params['external_identifier'])) {
441 $disp .= "AND {$params['external_identifier']}";
444 $disp = $params['external_identifier'];
448 array_unshift($values, 'No matching Contact found for (' . $disp . ')');
449 return CRM_Import_Parser
::ERROR
;
453 if (!empty($formatValues['external_identifier'])) {
454 $checkCid = new CRM_Contact_DAO_Contact();
455 $checkCid->external_identifier
= $formatValues['external_identifier'];
456 $checkCid->find(TRUE);
457 if ($checkCid->id
!= $formatted['contact_id']) {
458 array_unshift($values, 'Mismatch of External identifier :' . $formatValues['external_identifier'] . ' and Contact Id:' . $formatted['contact_id']);
459 return CRM_Import_Parser
::ERROR
;
463 $newParticipant = _civicrm_api3_deprecated_create_participant_formatted($formatted, $onDuplicate);
466 if (is_array($newParticipant) && civicrm_error($newParticipant)) {
467 if ($onDuplicate == CRM_Import_Parser
::DUPLICATE_SKIP
) {
469 $contactID = CRM_Utils_Array
::value('contactID', $newParticipant);
470 $participantID = CRM_Utils_Array
::value('participantID', $newParticipant);
471 $url = CRM_Utils_System
::url('civicrm/contact/view/participant',
472 "reset=1&id={$participantID}&cid={$contactID}&action=view", TRUE
474 if (is_array($newParticipant['error_message']) &&
475 ($participantID == $newParticipant['error_message']['params'][0])
477 array_unshift($values, $url);
478 return CRM_Import_Parser
::DUPLICATE
;
480 elseif ($newParticipant['error_message']) {
481 array_unshift($values, $newParticipant['error_message']);
482 return CRM_Import_Parser
::ERROR
;
484 return CRM_Import_Parser
::ERROR
;
488 if (!(is_array($newParticipant) && civicrm_error($newParticipant))) {
489 $this->_newParticipants
[] = CRM_Utils_Array
::value('id', $newParticipant);
492 return CRM_Import_Parser
::VALID
;
496 * Get the array of successfully imported Participation ids
500 public function &getImportedParticipations() {
501 return $this->_newParticipants
;
505 * The initializer code, called before the processing
509 public function fini() {