3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
35 * class to parse membership csv files
37 class CRM_Member_Import_Parser_Membership
extends CRM_Member_Import_Parser
{
39 protected $_mapperKeys;
41 private $_membershipTypeIndex;
42 private $_membershipStatusIndex;
45 * Array of metadata for all available fields.
49 protected $fieldMetadata = [];
52 * Array of successfully imported membership id's
56 protected $_newMemberships;
63 public function __construct($mapperKeys) {
64 parent
::__construct();
65 $this->_mapperKeys
= $mapperKeys;
69 * The initializer code, called before the processing
73 public function init() {
74 $this->fieldMetadata
= CRM_Member_BAO_Membership
::importableFields($this->_contactType
, FALSE);
76 foreach ($this->fieldMetadata
as $name => $field) {
77 // @todo - we don't really need to do all this.... fieldMetadata is just fine to use as is.
78 $field['type'] = CRM_Utils_Array
::value('type', $field, CRM_Utils_Type
::T_INT
);
79 $field['dataPattern'] = CRM_Utils_Array
::value('dataPattern', $field, '//');
80 $field['headerPattern'] = CRM_Utils_Array
::value('headerPattern', $field, '//');
81 $this->addField($name, $field['title'], $field['type'], $field['headerPattern'], $field['dataPattern']);
84 $this->_newMemberships
= [];
86 $this->setActiveFields($this->_mapperKeys
);
88 // FIXME: we should do this in one place together with Form/MapField.php
89 $this->_membershipTypeIndex
= -1;
90 $this->_membershipStatusIndex
= -1;
93 foreach ($this->_mapperKeys
as $key) {
96 case 'membership_type_id':
97 $this->_membershipTypeIndex
= $index;
101 $this->_membershipStatusIndex
= $index;
109 * Handle the values in mapField mode.
111 * @param array $values
112 * The array of values belonging to this line.
116 public function mapField(&$values) {
117 return CRM_Import_Parser
::VALID
;
121 * Handle the values in preview mode.
123 * @param array $values
124 * The array of values belonging to this line.
127 * the result of this processing
129 public function preview(&$values) {
130 return $this->summary($values);
134 * Handle the values in summary mode.
136 * @param array $values
137 * The array of values belonging to this line.
140 * the result of this processing
142 public function summary(&$values) {
143 $erroneousField = NULL;
144 $response = $this->setActiveFieldValues($values, $erroneousField);
146 $errorRequired = FALSE;
148 if ($this->_membershipTypeIndex
< 0) {
149 $errorRequired = TRUE;
152 $errorRequired = !CRM_Utils_Array
::value($this->_membershipTypeIndex
, $values);
155 if ($errorRequired) {
156 array_unshift($values, ts('Missing required fields'));
157 return CRM_Import_Parser
::ERROR
;
160 $params = $this->getActiveFieldParams();
161 $errorMessage = NULL;
163 //To check whether start date or join date is provided
164 if (empty($params['membership_start_date']) && empty($params['join_date'])) {
165 $errorMessage = 'Membership Start Date is required to create a memberships.';
166 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Start Date', $errorMessage);
170 $session = CRM_Core_Session
::singleton();
171 $dateType = $session->get('dateTypes');
172 foreach ($params as $key => $val) {
177 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
178 if (!CRM_Utils_Rule
::date($params[$key])) {
179 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Member Since', $errorMessage);
183 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Member Since', $errorMessage);
187 case 'membership_start_date':
188 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
189 if (!CRM_Utils_Rule
::date($params[$key])) {
190 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Start Date', $errorMessage);
194 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Start Date', $errorMessage);
198 case 'membership_end_date':
199 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
200 if (!CRM_Utils_Rule
::date($params[$key])) {
201 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('End date', $errorMessage);
205 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('End date', $errorMessage);
209 case 'status_override_end_date':
210 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
211 if (!CRM_Utils_Rule
::date($params[$key])) {
212 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Status Override End Date', $errorMessage);
216 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Status Override End Date', $errorMessage);
220 case 'membership_type_id':
221 // @todo - squish into membership status - can use same lines here too.
222 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
223 if (!CRM_Utils_Array
::crmInArray($val, $membershipTypes) &&
224 !array_key_exists($val, $membershipTypes)
226 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Membership Type', $errorMessage);
231 if (!empty($val) && !$this->parsePseudoConstantField($val, $this->fieldMetadata
[$key])) {
232 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Membership Status', $errorMessage);
237 if (!CRM_Utils_Rule
::email($val)) {
238 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Email Address', $errorMessage);
243 //date-Format part ends
245 $params['contact_type'] = 'Membership';
247 //checking error in custom data
248 CRM_Contact_Import_Parser_Contact
::isErrorInCustomData($params, $errorMessage);
251 $tempMsg = "Invalid value for field(s) : $errorMessage";
252 array_unshift($values, $tempMsg);
253 $errorMessage = NULL;
254 return CRM_Import_Parser
::ERROR
;
257 return CRM_Import_Parser
::VALID
;
261 * Handle the values in import mode.
263 * @param int $onDuplicate
264 * The code for what action to take on duplicates.
265 * @param array $values
266 * The array of values belonging to this line.
269 * the result of this processing
271 public function import($onDuplicate, &$values) {
273 // first make sure this is a valid line
274 $response = $this->summary($values);
275 if ($response != CRM_Import_Parser
::VALID
) {
279 $params = $this->getActiveFieldParams();
281 //assign join date equal to start date if join date is not provided
282 if (empty($params['join_date']) && !empty($params['membership_start_date'])) {
283 $params['join_date'] = $params['membership_start_date'];
286 $session = CRM_Core_Session
::singleton();
287 $dateType = $session->get('dateTypes');
289 $customDataType = !empty($params['contact_type']) ?
$params['contact_type'] : 'Membership';
290 $customFields = CRM_Core_BAO_CustomField
::getFields($customDataType);
292 // don't add to recent items, CRM-4399
293 $formatted['skipRecentView'] = TRUE;
295 'join_date' => ts('Member Since'),
296 'membership_start_date' => ts('Start Date'),
297 'membership_end_date' => ts('End Date'),
299 foreach ($params as $key => $val) {
303 case 'membership_start_date':
304 case 'membership_end_date':
305 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
306 if (!CRM_Utils_Rule
::date($params[$key])) {
307 CRM_Contact_Import_Parser_Contact
::addToErrorMsg($dateLabels[$key], $errorMessage);
311 CRM_Contact_Import_Parser_Contact
::addToErrorMsg($dateLabels[$key], $errorMessage);
315 case 'membership_type_id':
316 if (!is_numeric($val)) {
317 unset($params['membership_type_id']);
318 $params['membership_type'] = $val;
323 // @todo - we can do this based on the presence of 'pseudoconstant' in the metadata rather than field specific.
324 $params[$key] = $this->parsePseudoConstantField($val, $this->fieldMetadata
[$key]);
328 $params[$key] = CRM_Utils_String
::strtobool($val);
331 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
332 if ($customFields[$customFieldID]['data_type'] == 'Date') {
333 CRM_Contact_Import_Parser_Contact
::formatCustomDate($params, $formatted, $dateType, $key);
334 unset($params[$key]);
336 elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') {
337 $params[$key] = CRM_Utils_String
::strtoboolstr($val);
342 //date-Format part ends
345 foreach ($params as $key => $field) {
346 if ($field == NULL ||
$field === '') {
350 $formatValues[$key] = $field;
353 //format params to meet api v2 requirements.
354 //@todo find a way to test removing this formatting
355 $formatError = $this->membership_format_params($formatValues, $formatted, TRUE);
357 if ($onDuplicate != CRM_Import_Parser
::DUPLICATE_UPDATE
) {
358 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
364 //fix for CRM-2219 Update Membership
365 // onDuplicate == CRM_Import_Parser::DUPLICATE_UPDATE
366 if (!empty($formatted['is_override']) && empty($formatted['status_id'])) {
367 array_unshift($values, 'Required parameter missing: Status');
368 return CRM_Import_Parser
::ERROR
;
371 if (!empty($formatValues['membership_id'])) {
372 $dao = new CRM_Member_BAO_Membership();
373 $dao->id
= $formatValues['membership_id'];
374 $dates = ['join_date', 'start_date', 'end_date'];
375 foreach ($dates as $v) {
376 if (empty($formatted[$v])) {
377 $formatted[$v] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $formatValues['membership_id'], $v);
381 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
382 $formatValues['membership_id'],
385 if ($dao->find(TRUE)) {
386 if (empty($params['line_item']) && !empty($formatted['membership_type_id'])) {
387 CRM_Price_BAO_LineItem
::getLineItemArray($formatted, NULL, 'membership', $formatted['membership_type_id']);
390 // @todo stop passing $ids array (and put details in $formatted if required)
392 'membership' => $formatValues['membership_id'],
393 'userId' => $session->get('userID'),
395 $newMembership = CRM_Member_BAO_Membership
::create($formatted, $ids, TRUE);
396 if (civicrm_error($newMembership)) {
397 array_unshift($values, $newMembership['is_error'] . ' for Membership ID ' . $formatValues['membership_id'] . '. Row was skipped.');
398 return CRM_Import_Parser
::ERROR
;
401 $this->_newMemberships
[] = $newMembership->id
;
402 return CRM_Import_Parser
::VALID
;
406 array_unshift($values, 'Matching Membership record not found for Membership ID ' . $formatValues['membership_id'] . '. Row was skipped.');
407 return CRM_Import_Parser
::ERROR
;
413 $startDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('start_date', $formatted), '%Y-%m-%d');
414 $endDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('end_date', $formatted), '%Y-%m-%d');
415 $joinDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('join_date', $formatted), '%Y-%m-%d');
417 if (!$this->isContactIDColumnPresent()) {
418 $error = $this->checkContactDuplicate($formatValues);
420 if (CRM_Core_Error
::isAPIError($error, CRM_Core_ERROR
::DUPLICATE_CONTACT
)) {
421 $matchedIDs = explode(',', $error['error_message']['params'][0]);
422 if (count($matchedIDs) > 1) {
423 array_unshift($values, 'Multiple matching contact records detected for this row. The membership was not imported');
424 return CRM_Import_Parser
::ERROR
;
427 $cid = $matchedIDs[0];
428 $formatted['contact_id'] = $cid;
431 $calcDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($formatted['membership_type_id'],
436 self
::formattedDates($calcDates, $formatted);
438 //fix for CRM-3570, exclude the statuses those having is_admin = 1
439 //now user can import is_admin if is override is true.
440 $excludeIsAdmin = FALSE;
441 if (empty($formatted['is_override'])) {
442 $formatted['exclude_is_admin'] = $excludeIsAdmin = TRUE;
444 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($startDate,
449 $formatted['membership_type_id'],
453 if (empty($formatted['status_id'])) {
454 $formatted['status_id'] = $calcStatus['id'];
456 elseif (empty($formatted['is_override'])) {
457 if (empty($calcStatus)) {
458 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.');
459 return CRM_Import_Parser
::ERROR
;
461 elseif ($formatted['status_id'] != $calcStatus['id']) {
462 //Status Hold" is either NOT mapped or is FALSE
463 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.');
464 return CRM_Import_Parser
::ERROR
;
468 $newMembership = civicrm_api3('membership', 'create', $formatted);
470 $this->_newMemberships
[] = $newMembership['id'];
471 return CRM_Import_Parser
::VALID
;
475 // Using new Dedupe rule.
477 'contact_type' => $this->_contactType
,
478 'used' => 'Unsupervised',
480 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
483 foreach ($fieldsArray as $value) {
484 if (array_key_exists(trim($value), $params)) {
485 $paramValue = $params[trim($value)];
486 if (is_array($paramValue)) {
487 $disp .= $params[trim($value)][0][trim($value)] . " ";
490 $disp .= $params[trim($value)] . " ";
495 if (!empty($params['external_identifier'])) {
497 $disp .= "AND {$params['external_identifier']}";
500 $disp = $params['external_identifier'];
504 array_unshift($values, 'No matching Contact found for (' . $disp . ')');
505 return CRM_Import_Parser
::ERROR
;
509 if (!empty($formatValues['external_identifier'])) {
510 $checkCid = new CRM_Contact_DAO_Contact();
511 $checkCid->external_identifier
= $formatValues['external_identifier'];
512 $checkCid->find(TRUE);
513 if ($checkCid->id
!= $formatted['contact_id']) {
514 array_unshift($values, 'Mismatch of External ID:' . $formatValues['external_identifier'] . ' and Contact Id:' . $formatted['contact_id']);
515 return CRM_Import_Parser
::ERROR
;
520 $calcDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($formatted['membership_type_id'],
525 self
::formattedDates($calcDates, $formatted);
526 //end of date calculation part
528 //fix for CRM-3570, exclude the statuses those having is_admin = 1
529 //now user can import is_admin if is override is true.
530 $excludeIsAdmin = FALSE;
531 if (empty($formatted['is_override'])) {
532 $formatted['exclude_is_admin'] = $excludeIsAdmin = TRUE;
534 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($startDate,
539 $formatted['membership_type_id'],
542 if (empty($formatted['status_id'])) {
543 $formatted['status_id'] = CRM_Utils_Array
::value('id', $calcStatus);
545 elseif (empty($formatted['is_override'])) {
546 if (empty($calcStatus)) {
547 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.');
548 return CRM_Import_Parser
::ERROR
;
550 elseif ($formatted['status_id'] != $calcStatus['id']) {
551 //Status Hold" is either NOT mapped or is FALSE
552 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.');
553 return CRM_Import_Parser
::ERROR
;
557 $newMembership = civicrm_api3('membership', 'create', $formatted);
559 $this->_newMemberships
[] = $newMembership['id'];
560 return CRM_Import_Parser
::VALID
;
563 catch (Exception
$e) {
564 array_unshift($values, $e->getMessage());
565 return CRM_Import_Parser
::ERROR
;
570 * Get the array of successfully imported membership id's
574 public function &getImportedMemberships() {
575 return $this->_newMemberships
;
579 * The initializer code, called before the processing
583 public function fini() {
587 * to calculate join, start and end dates
589 * @param array $calcDates
590 * Array of dates returned by getDatesForMembershipType().
595 public function formattedDates($calcDates, &$formatted) {
602 foreach ($dates as $d) {
603 if (isset($formatted[$d]) &&
604 !CRM_Utils_System
::isNull($formatted[$d])
606 $formatted[$d] = CRM_Utils_Date
::isoToMysql($formatted[$d]);
608 elseif (isset($calcDates[$d])) {
609 $formatted[$d] = CRM_Utils_Date
::isoToMysql($calcDates[$d]);
615 * @deprecated - this function formats params according to v2 standards but
616 * need to be sure about the impact of not calling it so retaining on the import class
617 * take the input parameter list as specified in the data model and
618 * convert it into the same format that we use in QF and BAO object
620 * @param array $params
621 * Associative array of property name/value.
622 * pairs to insert in new contact.
623 * @param array $values
624 * The reformatted properties that we can use internally.
626 * @param array|bool $create Is the formatted Values array going to
627 * be used for CRM_Member_BAO_Membership:create()
630 * @return array|error
632 public function membership_format_params($params, &$values, $create = FALSE) {
633 require_once 'api/v3/utils.php';
634 $fields = CRM_Member_DAO_Membership
::fields();
635 _civicrm_api3_store_values($fields, $params, $values);
637 $customFields = CRM_Core_BAO_CustomField
::getFields('Membership');
639 foreach ($params as $key => $value) {
640 // ignore empty values or empty arrays etc
641 if (CRM_Utils_System
::isNull($value)) {
645 //Handling Custom Data
646 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
647 $values[$key] = $value;
648 $type = $customFields[$customFieldID]['html_type'];
649 if ($type == 'CheckBox' ||
$type == 'Multi-Select') {
650 $mulValues = explode(',', $value);
651 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
653 foreach ($mulValues as $v1) {
654 foreach ($customOption as $customValueID => $customLabel) {
655 $customValue = $customLabel['value'];
656 if ((strtolower($customLabel['label']) == strtolower(trim($v1))) ||
657 (strtolower($customValue) == strtolower(trim($v1)))
659 if ($type == 'CheckBox') {
660 $values[$key][$customValue] = 1;
663 $values[$key][] = $customValue;
672 case 'membership_contact_id':
673 if (!CRM_Utils_Rule
::integer($value)) {
674 throw new Exception("contact_id not valid: $value");
676 $dao = new CRM_Core_DAO();
678 $svq = $dao->singleValueQuery("SELECT id FROM civicrm_contact WHERE id = $value",
682 throw new Exception("Invalid Contact ID: There is no contact record with contact_id = $value.");
684 $values['contact_id'] = $values['membership_contact_id'];
685 unset($values['membership_contact_id']);
688 case 'membership_type_id':
689 if (!CRM_Utils_Array
::value($value, CRM_Member_PseudoConstant
::membershipType())) {
690 throw new Exception('Invalid Membership Type Id');
692 $values[$key] = $value;
695 case 'membership_type':
696 $membershipTypeId = CRM_Utils_Array
::key(ucfirst($value),
697 CRM_Member_PseudoConstant
::membershipType()
699 if ($membershipTypeId) {
700 if (!empty($values['membership_type_id']) &&
701 $membershipTypeId != $values['membership_type_id']
703 throw new Exception('Mismatched membership Type and Membership Type Id');
707 throw new Exception('Invalid Membership Type');
709 $values['membership_type_id'] = $membershipTypeId;
717 _civicrm_api3_custom_format_params($params, $values, 'Membership');
720 // CRM_Member_BAO_Membership::create() handles membership_start_date,
721 // membership_end_date and membership_source. So, if $values contains
722 // membership_start_date, membership_end_date or membership_source,
723 // convert it to start_date, end_date or source
725 'membership_start_date' => 'start_date',
726 'membership_end_date' => 'end_date',
727 'membership_source' => 'source',
730 foreach ($changes as $orgVal => $changeVal) {
731 if (isset($values[$orgVal])) {
732 $values[$changeVal] = $values[$orgVal];
733 unset($values[$orgVal]);
742 * Is the contact ID mapped.
746 protected function isContactIDColumnPresent(): bool {
747 return in_array('membership_contact_id', $this->_mapperKeys
, TRUE);