3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * class to parse membership csv files
21 class CRM_Member_Import_Parser_Membership
extends CRM_Member_Import_Parser
{
23 protected $_mapperKeys;
25 private $_membershipTypeIndex;
26 private $_membershipStatusIndex;
29 * Array of metadata for all available fields.
33 protected $fieldMetadata = [];
36 * Array of successfully imported membership id's
40 protected $_newMemberships;
47 public function __construct($mapperKeys) {
48 parent
::__construct();
49 $this->_mapperKeys
= $mapperKeys;
53 * The initializer code, called before the processing
57 public function init() {
58 $this->fieldMetadata
= CRM_Member_BAO_Membership
::importableFields($this->_contactType
, FALSE);
60 foreach ($this->fieldMetadata
as $name => $field) {
61 // @todo - we don't really need to do all this.... fieldMetadata is just fine to use as is.
62 $field['type'] = CRM_Utils_Array
::value('type', $field, CRM_Utils_Type
::T_INT
);
63 $field['dataPattern'] = CRM_Utils_Array
::value('dataPattern', $field, '//');
64 $field['headerPattern'] = CRM_Utils_Array
::value('headerPattern', $field, '//');
65 $this->addField($name, $field['title'], $field['type'], $field['headerPattern'], $field['dataPattern']);
68 $this->_newMemberships
= [];
70 $this->setActiveFields($this->_mapperKeys
);
72 // FIXME: we should do this in one place together with Form/MapField.php
73 $this->_membershipTypeIndex
= -1;
74 $this->_membershipStatusIndex
= -1;
77 foreach ($this->_mapperKeys
as $key) {
80 case 'membership_type_id':
81 $this->_membershipTypeIndex
= $index;
85 $this->_membershipStatusIndex
= $index;
93 * Handle the values in mapField mode.
95 * @param array $values
96 * The array of values belonging to this line.
100 public function mapField(&$values) {
101 return CRM_Import_Parser
::VALID
;
105 * Handle the values in preview mode.
107 * @param array $values
108 * The array of values belonging to this line.
111 * the result of this processing
113 public function preview(&$values) {
114 return $this->summary($values);
118 * Handle the values in summary mode.
120 * @param array $values
121 * The array of values belonging to this line.
124 * the result of this processing
126 public function summary(&$values) {
127 $erroneousField = NULL;
128 $this->setActiveFieldValues($values, $erroneousField);
130 $errorRequired = FALSE;
132 if ($this->_membershipTypeIndex
< 0) {
133 $errorRequired = TRUE;
136 $errorRequired = !CRM_Utils_Array
::value($this->_membershipTypeIndex
, $values);
139 if ($errorRequired) {
140 array_unshift($values, ts('Missing required fields'));
141 return CRM_Import_Parser
::ERROR
;
144 $params = $this->getActiveFieldParams();
145 $errorMessage = NULL;
147 //To check whether start date or join date is provided
148 if (empty($params['membership_start_date']) && empty($params['membership_join_date'])) {
149 $errorMessage = 'Membership Start Date is required to create a memberships.';
150 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Start Date', $errorMessage);
154 $session = CRM_Core_Session
::singleton();
155 $dateType = $session->get('dateTypes');
156 foreach ($params as $key => $val) {
160 case 'membership_join_date':
161 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
162 if (!CRM_Utils_Rule
::date($params[$key])) {
163 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Member Since', $errorMessage);
167 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Member Since', $errorMessage);
171 case 'membership_start_date':
172 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
173 if (!CRM_Utils_Rule
::date($params[$key])) {
174 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Start Date', $errorMessage);
178 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Start Date', $errorMessage);
182 case 'membership_end_date':
183 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
184 if (!CRM_Utils_Rule
::date($params[$key])) {
185 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('End date', $errorMessage);
189 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('End date', $errorMessage);
193 case 'status_override_end_date':
194 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
195 if (!CRM_Utils_Rule
::date($params[$key])) {
196 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Status Override End Date', $errorMessage);
200 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Status Override End Date', $errorMessage);
204 case 'membership_type_id':
205 // @todo - squish into membership status - can use same lines here too.
206 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
207 if (!CRM_Utils_Array
::crmInArray($val, $membershipTypes) &&
208 !array_key_exists($val, $membershipTypes)
210 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Membership Type', $errorMessage);
215 if (!empty($val) && !$this->parsePseudoConstantField($val, $this->fieldMetadata
[$key])) {
216 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Membership Status', $errorMessage);
221 if (!CRM_Utils_Rule
::email($val)) {
222 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Email Address', $errorMessage);
227 //date-Format part ends
229 $params['contact_type'] = 'Membership';
231 //checking error in custom data
232 CRM_Contact_Import_Parser_Contact
::isErrorInCustomData($params, $errorMessage);
235 $tempMsg = "Invalid value for field(s) : $errorMessage";
236 array_unshift($values, $tempMsg);
237 $errorMessage = NULL;
238 return CRM_Import_Parser
::ERROR
;
241 return CRM_Import_Parser
::VALID
;
245 * Handle the values in import mode.
247 * @param int $onDuplicate
248 * The code for what action to take on duplicates.
249 * @param array $values
250 * The array of values belonging to this line.
253 * the result of this processing
255 public function import($onDuplicate, &$values) {
257 // first make sure this is a valid line
258 $response = $this->summary($values);
259 if ($response != CRM_Import_Parser
::VALID
) {
263 $params = $this->getActiveFieldParams();
265 //assign join date equal to start date if join date is not provided
266 if (empty($params['membership_join_date']) && !empty($params['membership_start_date'])) {
267 $params['membership_join_date'] = $params['membership_start_date'];
270 $session = CRM_Core_Session
::singleton();
271 $dateType = CRM_Core_Session
::singleton()->get('dateTypes');
273 $customDataType = !empty($params['contact_type']) ?
$params['contact_type'] : 'Membership';
274 $customFields = CRM_Core_BAO_CustomField
::getFields($customDataType);
276 // don't add to recent items, CRM-4399
277 $formatted['skipRecentView'] = TRUE;
279 'membership_join_date' => ts('Member Since'),
280 'membership_start_date' => ts('Start Date'),
281 'membership_end_date' => ts('End Date'),
283 foreach ($params as $key => $val) {
286 case 'membership_join_date':
287 case 'membership_start_date':
288 case 'membership_end_date':
289 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
290 if (!CRM_Utils_Rule
::date($params[$key])) {
291 CRM_Contact_Import_Parser_Contact
::addToErrorMsg($dateLabels[$key], $errorMessage);
295 CRM_Contact_Import_Parser_Contact
::addToErrorMsg($dateLabels[$key], $errorMessage);
299 case 'membership_type_id':
300 if (!is_numeric($val)) {
301 unset($params['membership_type_id']);
302 $params['membership_type'] = $val;
307 // @todo - we can do this based on the presence of 'pseudoconstant' in the metadata rather than field specific.
308 $params[$key] = $this->parsePseudoConstantField($val, $this->fieldMetadata
[$key]);
312 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
313 if ($customFields[$customFieldID]['data_type'] == 'Date') {
314 CRM_Contact_Import_Parser_Contact
::formatCustomDate($params, $formatted, $dateType, $key);
315 unset($params[$key]);
317 elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') {
318 $params[$key] = CRM_Utils_String
::strtoboolstr($val);
323 //date-Format part ends
326 foreach ($params as $key => $field) {
327 if ($field == NULL ||
$field === '') {
331 $formatValues[$key] = $field;
334 //format params to meet api v2 requirements.
335 //@todo find a way to test removing this formatting
336 $formatError = $this->membership_format_params($formatValues, $formatted, TRUE);
338 if ($onDuplicate != CRM_Import_Parser
::DUPLICATE_UPDATE
) {
339 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
345 //fix for CRM-2219 Update Membership
346 // onDuplicate == CRM_Import_Parser::DUPLICATE_UPDATE
347 if (!empty($formatted['member_is_override']) && empty($formatted['status_id'])) {
348 array_unshift($values, 'Required parameter missing: Status');
349 return CRM_Import_Parser
::ERROR
;
352 if (!empty($formatValues['membership_id'])) {
353 $dao = new CRM_Member_BAO_Membership();
354 $dao->id
= $formatValues['membership_id'];
355 $dates = ['join_date', 'start_date', 'end_date'];
356 foreach ($dates as $v) {
357 if (empty($formatted[$v])) {
358 $formatted[$v] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $formatValues['membership_id'], $v);
362 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
363 $formatValues['membership_id'],
366 if ($dao->find(TRUE)) {
367 if (empty($params['line_item']) && !empty($formatted['membership_type_id'])) {
368 CRM_Price_BAO_LineItem
::getLineItemArray($formatted, NULL, 'membership', $formatted['membership_type_id']);
371 $newMembership = civicrm_api3('Membership', 'create', $formatted);
372 $this->_newMemberships
[] = $newMembership['id'];
373 return CRM_Import_Parser
::VALID
;
376 array_unshift($values, 'Matching Membership record not found for Membership ID ' . $formatValues['membership_id'] . '. Row was skipped.');
377 return CRM_Import_Parser
::ERROR
;
383 $startDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('start_date', $formatted), '%Y-%m-%d');
384 $endDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('end_date', $formatted), '%Y-%m-%d');
385 $joinDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('join_date', $formatted), '%Y-%m-%d');
387 if (!$this->isContactIDColumnPresent()) {
388 $error = $this->checkContactDuplicate($formatValues);
390 if (CRM_Core_Error
::isAPIError($error, CRM_Core_ERROR
::DUPLICATE_CONTACT
)) {
391 $matchedIDs = explode(',', $error['error_message']['params'][0]);
392 if (count($matchedIDs) > 1) {
393 array_unshift($values, 'Multiple matching contact records detected for this row. The membership was not imported');
394 return CRM_Import_Parser
::ERROR
;
397 $cid = $matchedIDs[0];
398 $formatted['contact_id'] = $cid;
401 $calcDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($formatted['membership_type_id'],
406 self
::formattedDates($calcDates, $formatted);
408 //fix for CRM-3570, exclude the statuses those having is_admin = 1
409 //now user can import is_admin if is override is true.
410 $excludeIsAdmin = FALSE;
411 if (empty($formatted['member_is_override'])) {
412 $formatted['exclude_is_admin'] = $excludeIsAdmin = TRUE;
414 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($startDate,
419 $formatted['membership_type_id'],
423 if (empty($formatted['status_id'])) {
424 $formatted['status_id'] = $calcStatus['id'];
426 elseif (empty($formatted['member_is_override'])) {
427 if (empty($calcStatus)) {
428 array_unshift($values, 'Status in import row (' . $formatValues['status_id'] . ') does not match calculated status based on your configured Membership Status Rules. Record was not imported.');
429 return CRM_Import_Parser
::ERROR
;
431 elseif ($formatted['status_id'] != $calcStatus['id']) {
432 //Status Hold" is either NOT mapped or is FALSE
433 array_unshift($values, 'Status in import row (' . $formatValues['status_id'] . ') does not match calculated status based on your configured Membership Status Rules (' . $calcStatus['name'] . '). Record was not imported.');
434 return CRM_Import_Parser
::ERROR
;
438 $newMembership = civicrm_api3('membership', 'create', $formatted);
440 $this->_newMemberships
[] = $newMembership['id'];
441 return CRM_Import_Parser
::VALID
;
445 // Using new Dedupe rule.
447 'contact_type' => $this->_contactType
,
448 'used' => 'Unsupervised',
450 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
453 foreach ($fieldsArray as $value) {
454 if (array_key_exists(trim($value), $params)) {
455 $paramValue = $params[trim($value)];
456 if (is_array($paramValue)) {
457 $disp .= $params[trim($value)][0][trim($value)] . " ";
460 $disp .= $params[trim($value)] . " ";
465 if (!empty($params['external_identifier'])) {
467 $disp .= "AND {$params['external_identifier']}";
470 $disp = $params['external_identifier'];
474 array_unshift($values, 'No matching Contact found for (' . $disp . ')');
475 return CRM_Import_Parser
::ERROR
;
479 if (!empty($formatValues['external_identifier'])) {
480 $checkCid = new CRM_Contact_DAO_Contact();
481 $checkCid->external_identifier
= $formatValues['external_identifier'];
482 $checkCid->find(TRUE);
483 if ($checkCid->id
!= $formatted['contact_id']) {
484 array_unshift($values, 'Mismatch of External ID:' . $formatValues['external_identifier'] . ' and Contact Id:' . $formatted['contact_id']);
485 return CRM_Import_Parser
::ERROR
;
490 $calcDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($formatted['membership_type_id'],
495 self
::formattedDates($calcDates, $formatted);
496 //end of date calculation part
498 //fix for CRM-3570, exclude the statuses those having is_admin = 1
499 //now user can import is_admin if is override is true.
500 $excludeIsAdmin = FALSE;
501 if (empty($formatted['member_is_override'])) {
502 $formatted['exclude_is_admin'] = $excludeIsAdmin = TRUE;
504 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($startDate,
509 $formatted['membership_type_id'],
512 if (empty($formatted['status_id'])) {
513 $formatted['status_id'] = $calcStatus['id'] ??
NULL;
515 elseif (empty($formatted['member_is_override'])) {
516 if (empty($calcStatus)) {
517 array_unshift($values, 'Status in import row (' . CRM_Utils_Array
::value('status_id', $formatValues) . ') does not match calculated status based on your configured Membership Status Rules. Record was not imported.');
518 return CRM_Import_Parser
::ERROR
;
520 elseif ($formatted['status_id'] != $calcStatus['id']) {
521 //Status Hold" is either NOT mapped or is FALSE
522 array_unshift($values, 'Status in import row (' . CRM_Utils_Array
::value('status_id', $formatValues) . ') does not match calculated status based on your configured Membership Status Rules (' . $calcStatus['name'] . '). Record was not imported.');
523 return CRM_Import_Parser
::ERROR
;
527 $newMembership = civicrm_api3('membership', 'create', $formatted);
529 $this->_newMemberships
[] = $newMembership['id'];
530 return CRM_Import_Parser
::VALID
;
533 catch (Exception
$e) {
534 array_unshift($values, $e->getMessage());
535 return CRM_Import_Parser
::ERROR
;
540 * Get the array of successfully imported membership id's
544 public function &getImportedMemberships() {
545 return $this->_newMemberships
;
549 * The initializer code, called before the processing
553 public function fini() {
557 * to calculate join, start and end dates
559 * @param array $calcDates
560 * Array of dates returned by getDatesForMembershipType().
565 public function formattedDates($calcDates, &$formatted) {
572 foreach ($dates as $d) {
573 if (isset($formatted[$d]) &&
574 !CRM_Utils_System
::isNull($formatted[$d])
576 $formatted[$d] = CRM_Utils_Date
::isoToMysql($formatted[$d]);
578 elseif (isset($calcDates[$d])) {
579 $formatted[$d] = CRM_Utils_Date
::isoToMysql($calcDates[$d]);
585 * @deprecated - this function formats params according to v2 standards but
586 * need to be sure about the impact of not calling it so retaining on the import class
587 * take the input parameter list as specified in the data model and
588 * convert it into the same format that we use in QF and BAO object
590 * @param array $params
591 * Associative array of property name/value.
592 * pairs to insert in new contact.
593 * @param array $values
594 * The reformatted properties that we can use internally.
596 * @param array|bool $create Is the formatted Values array going to
597 * be used for CRM_Member_BAO_Membership:create()
600 * @return array|error
602 public function membership_format_params($params, &$values, $create = FALSE) {
603 require_once 'api/v3/utils.php';
604 $fields = CRM_Member_DAO_Membership
::fields();
605 _civicrm_api3_store_values($fields, $params, $values);
607 $customFields = CRM_Core_BAO_CustomField
::getFields('Membership');
609 foreach ($params as $key => $value) {
610 // ignore empty values or empty arrays etc
611 if (CRM_Utils_System
::isNull($value)) {
615 //Handling Custom Data
616 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
617 $values[$key] = $value;
618 $type = $customFields[$customFieldID]['html_type'];
619 if (CRM_Core_BAO_CustomField
::isSerialized($customFields[$customFieldID])) {
620 $values[$key] = self
::unserializeCustomValue($customFieldID, $value, $type);
625 case 'membership_contact_id':
626 if (!CRM_Utils_Rule
::integer($value)) {
627 throw new Exception("contact_id not valid: $value");
629 $dao = new CRM_Core_DAO();
631 $svq = $dao->singleValueQuery("SELECT id FROM civicrm_contact WHERE id = $value",
635 throw new Exception("Invalid Contact ID: There is no contact record with contact_id = $value.");
637 $values['contact_id'] = $values['membership_contact_id'];
638 unset($values['membership_contact_id']);
641 case 'membership_type_id':
642 if (!array_key_exists($value, CRM_Member_PseudoConstant
::membershipType())) {
643 throw new Exception('Invalid Membership Type Id');
645 $values[$key] = $value;
648 case 'membership_type':
649 $membershipTypeId = CRM_Utils_Array
::key(ucfirst($value),
650 CRM_Member_PseudoConstant
::membershipType()
652 if ($membershipTypeId) {
653 if (!empty($values['membership_type_id']) &&
654 $membershipTypeId != $values['membership_type_id']
656 throw new Exception('Mismatched membership Type and Membership Type Id');
660 throw new Exception('Invalid Membership Type');
662 $values['membership_type_id'] = $membershipTypeId;
670 _civicrm_api3_custom_format_params($params, $values, 'Membership');
673 // CRM_Member_BAO_Membership::create() handles membership_start_date, membership_join_date,
674 // membership_end_date and membership_source. So, if $values contains
675 // membership_start_date, membership_end_date, membership_join_date or membership_source,
676 // convert it to start_date, end_date, join_date or source
678 'membership_join_date' => 'join_date',
679 'membership_start_date' => 'start_date',
680 'membership_end_date' => 'end_date',
681 'membership_source' => 'source',
684 foreach ($changes as $orgVal => $changeVal) {
685 if (isset($values[$orgVal])) {
686 $values[$changeVal] = $values[$orgVal];
687 unset($values[$orgVal]);
696 * Is the contact ID mapped.
700 protected function isContactIDColumnPresent(): bool {
701 return in_array('membership_contact_id', $this->_mapperKeys
, TRUE);