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
37 require_once 'api/api.php';
40 * class to parse membership csv files
42 class CRM_Member_Import_Parser_Membership
extends CRM_Member_Import_Parser
{
44 protected $_mapperKeys;
46 private $_contactIdIndex;
47 private $_totalAmountIndex;
48 private $_membershipTypeIndex;
49 private $_membershipStatusIndex;
52 * Array of successfully imported membership id's
56 protected $_newMemberships;
62 * @param null $mapperLocType
63 * @param null $mapperPhoneType
65 public function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) {
66 parent
::__construct();
67 $this->_mapperKeys
= &$mapperKeys;
71 * The initializer code, called before the processing
75 public function init() {
76 $fields = CRM_Member_BAO_Membership
::importableFields($this->_contactType
, FALSE);
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->_newMemberships
= 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->_membershipTypeIndex
= -1;
92 $this->_membershipStatusIndex
= -1;
95 foreach ($this->_mapperKeys
as $key) {
97 case 'membership_contact_id':
98 $this->_contactIdIndex
= $index;
101 case 'membership_type_id':
102 $this->_membershipTypeIndex
= $index;
106 $this->_membershipStatusIndex
= $index;
114 * Handle the values in mapField mode.
116 * @param array $values
117 * The array of values belonging to this line.
121 public function mapField(&$values) {
122 return CRM_Import_Parser
::VALID
;
126 * Handle the values in preview mode.
128 * @param array $values
129 * The array of values belonging to this line.
132 * the result of this processing
134 public function preview(&$values) {
135 return $this->summary($values);
139 * Handle the values in summary mode.
141 * @param array $values
142 * The array of values belonging to this line.
145 * the result of this processing
147 public function summary(&$values) {
148 $erroneousField = NULL;
149 $response = $this->setActiveFieldValues($values, $erroneousField);
151 $errorRequired = FALSE;
153 if ($this->_membershipTypeIndex
< 0) {
154 $errorRequired = TRUE;
157 $errorRequired = !CRM_Utils_Array
::value($this->_membershipTypeIndex
, $values);
160 if ($errorRequired) {
161 array_unshift($values, ts('Missing required fields'));
162 return CRM_Import_Parser
::ERROR
;
165 $params = $this->getActiveFieldParams();
166 $errorMessage = NULL;
168 //To check whether start date or join date is provided
169 if (empty($params['membership_start_date']) && empty($params['join_date'])) {
170 $errorMessage = 'Membership Start Date is required to create a memberships.';
171 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Start Date', $errorMessage);
175 $session = CRM_Core_Session
::singleton();
176 $dateType = $session->get('dateTypes');
177 foreach ($params as $key => $val) {
182 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
183 if (!CRM_Utils_Rule
::date($params[$key])) {
184 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Member Since', $errorMessage);
188 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Member Since', $errorMessage);
192 case 'membership_start_date':
193 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
194 if (!CRM_Utils_Rule
::date($params[$key])) {
195 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Start Date', $errorMessage);
199 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Start Date', $errorMessage);
203 case 'membership_end_date':
204 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
205 if (!CRM_Utils_Rule
::date($params[$key])) {
206 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('End date', $errorMessage);
210 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('End date', $errorMessage);
214 case 'status_override_end_date':
215 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
216 if (!CRM_Utils_Rule
::date($params[$key])) {
217 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Status Override End Date', $errorMessage);
221 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Status Override End Date', $errorMessage);
225 case 'membership_type_id':
226 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
227 if (!CRM_Utils_Array
::crmInArray($val, $membershipTypes) &&
228 !array_key_exists($val, $membershipTypes)
230 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Membership Type', $errorMessage);
235 if (!CRM_Utils_Array
::crmInArray($val, CRM_Member_PseudoConstant
::membershipStatus())) {
236 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Membership Status', $errorMessage);
241 if (!CRM_Utils_Rule
::email($val)) {
242 CRM_Contact_Import_Parser_Contact
::addToErrorMsg('Email Address', $errorMessage);
247 //date-Format part ends
249 $params['contact_type'] = 'Membership';
251 //checking error in custom data
252 CRM_Contact_Import_Parser_Contact
::isErrorInCustomData($params, $errorMessage);
255 $tempMsg = "Invalid value for field(s) : $errorMessage";
256 array_unshift($values, $tempMsg);
257 $errorMessage = NULL;
258 return CRM_Import_Parser
::ERROR
;
261 return CRM_Import_Parser
::VALID
;
265 * Handle the values in import mode.
267 * @param int $onDuplicate
268 * The code for what action to take on duplicates.
269 * @param array $values
270 * The array of values belonging to this line.
273 * the result of this processing
275 public function import($onDuplicate, &$values) {
277 // first make sure this is a valid line
278 $response = $this->summary($values);
279 if ($response != CRM_Import_Parser
::VALID
) {
283 $params = $this->getActiveFieldParams();
285 //assign join date equal to start date if join date is not provided
286 if (empty($params['join_date']) && !empty($params['membership_start_date'])) {
287 $params['join_date'] = $params['membership_start_date'];
290 $session = CRM_Core_Session
::singleton();
291 $dateType = $session->get('dateTypes');
292 $formatted = array();
293 $customDataType = !empty($params['contact_type']) ?
$params['contact_type'] : 'Membership';
294 $customFields = CRM_Core_BAO_CustomField
::getFields($customDataType);
296 // don't add to recent items, CRM-4399
297 $formatted['skipRecentView'] = TRUE;
299 'join_date' => ts('Member Since'),
300 'membership_start_date' => ts('Start Date'),
301 'membership_end_date' => ts('End Date'),
303 foreach ($params as $key => $val) {
307 case 'membership_start_date':
308 case 'membership_end_date':
309 if (CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key)) {
310 if (!CRM_Utils_Rule
::date($params[$key])) {
311 CRM_Contact_Import_Parser_Contact
::addToErrorMsg($dateLabels[$key], $errorMessage);
315 CRM_Contact_Import_Parser_Contact
::addToErrorMsg($dateLabels[$key], $errorMessage);
319 case 'membership_type_id':
320 if (!is_numeric($val)) {
321 unset($params['membership_type_id']);
322 $params['membership_type'] = $val;
327 if (!is_numeric($val)) {
328 unset($params['status_id']);
329 $params['membership_status'] = $val;
334 $params[$key] = CRM_Utils_String
::strtobool($val);
337 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
338 if ($customFields[$customFieldID]['data_type'] == 'Date') {
339 CRM_Contact_Import_Parser_Contact
::formatCustomDate($params, $formatted, $dateType, $key);
340 unset($params[$key]);
342 elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') {
343 $params[$key] = CRM_Utils_String
::strtoboolstr($val);
348 //date-Format part ends
350 static $indieFields = NULL;
351 if ($indieFields == NULL) {
352 $tempIndieFields = CRM_Member_DAO_Membership
::import();
353 $indieFields = $tempIndieFields;
356 $formatValues = array();
357 foreach ($params as $key => $field) {
358 if ($field == NULL ||
$field === '') {
362 $formatValues[$key] = $field;
365 //format params to meet api v2 requirements.
366 //@todo find a way to test removing this formatting
367 $formatError = $this->membership_format_params($formatValues, $formatted, TRUE);
369 if ($onDuplicate != CRM_Import_Parser
::DUPLICATE_UPDATE
) {
370 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
376 //fix for CRM-2219 Update Membership
377 // onDuplicate == CRM_Import_Parser::DUPLICATE_UPDATE
378 if (!empty($formatted['is_override']) && empty($formatted['status_id'])) {
379 array_unshift($values, 'Required parameter missing: Status');
380 return CRM_Import_Parser
::ERROR
;
383 if (!empty($formatValues['membership_id'])) {
384 $dao = new CRM_Member_BAO_Membership();
385 $dao->id
= $formatValues['membership_id'];
386 $dates = array('join_date', 'start_date', 'end_date');
387 foreach ($dates as $v) {
388 if (empty($formatted[$v])) {
389 $formatted[$v] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $formatValues['membership_id'], $v);
393 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
394 $formatValues['membership_id'],
397 if ($dao->find(TRUE)) {
399 'membership' => $formatValues['membership_id'],
400 'userId' => $session->get('userID'),
403 if (empty($params['line_item']) && !empty($formatted['membership_type_id'])) {
404 CRM_Price_BAO_LineItem
::getLineItemArray($formatted, NULL, 'membership', $formatted['membership_type_id']);
407 $newMembership = CRM_Member_BAO_Membership
::create($formatted, $ids, TRUE);
408 if (civicrm_error($newMembership)) {
409 array_unshift($values, $newMembership['is_error'] . ' for Membership ID ' . $formatValues['membership_id'] . '. Row was skipped.');
410 return CRM_Import_Parser
::ERROR
;
413 $this->_newMemberships
[] = $newMembership->id
;
414 return CRM_Import_Parser
::VALID
;
418 array_unshift($values, 'Matching Membership record not found for Membership ID ' . $formatValues['membership_id'] . '. Row was skipped.');
419 return CRM_Import_Parser
::ERROR
;
425 $startDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('start_date', $formatted), '%Y-%m-%d');
426 $endDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('end_date', $formatted), '%Y-%m-%d');
427 $joinDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('join_date', $formatted), '%Y-%m-%d');
429 if ($this->_contactIdIndex
< 0) {
430 $error = $this->checkContactDuplicate($formatValues);
432 if (CRM_Core_Error
::isAPIError($error, CRM_Core_ERROR
::DUPLICATE_CONTACT
)) {
433 $matchedIDs = explode(',', $error['error_message']['params'][0]);
434 if (count($matchedIDs) > 1) {
435 array_unshift($values, 'Multiple matching contact records detected for this row. The membership was not imported');
436 return CRM_Import_Parser
::ERROR
;
439 $cid = $matchedIDs[0];
440 $formatted['contact_id'] = $cid;
443 $calcDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($formatted['membership_type_id'],
448 self
::formattedDates($calcDates, $formatted);
450 //fix for CRM-3570, exclude the statuses those having is_admin = 1
451 //now user can import is_admin if is override is true.
452 $excludeIsAdmin = FALSE;
453 if (empty($formatted['is_override'])) {
454 $formatted['exclude_is_admin'] = $excludeIsAdmin = TRUE;
456 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($startDate,
461 $formatted['membership_type_id'],
465 if (empty($formatted['status_id'])) {
466 $formatted['status_id'] = $calcStatus['id'];
468 elseif (empty($formatted['is_override'])) {
469 if (empty($calcStatus)) {
470 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.');
471 return CRM_Import_Parser
::ERROR
;
473 elseif ($formatted['status_id'] != $calcStatus['id']) {
474 //Status Hold" is either NOT mapped or is FALSE
475 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.');
476 return CRM_Import_Parser
::ERROR
;
480 $newMembership = civicrm_api3('membership', 'create', $formatted);
482 $this->_newMemberships
[] = $newMembership['id'];
483 return CRM_Import_Parser
::VALID
;
487 // Using new Dedupe rule.
489 'contact_type' => $this->_contactType
,
490 'used' => 'Unsupervised',
492 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
495 foreach ($fieldsArray as $value) {
496 if (array_key_exists(trim($value), $params)) {
497 $paramValue = $params[trim($value)];
498 if (is_array($paramValue)) {
499 $disp .= $params[trim($value)][0][trim($value)] . " ";
502 $disp .= $params[trim($value)] . " ";
507 if (!empty($params['external_identifier'])) {
509 $disp .= "AND {$params['external_identifier']}";
512 $disp = $params['external_identifier'];
516 array_unshift($values, 'No matching Contact found for (' . $disp . ')');
517 return CRM_Import_Parser
::ERROR
;
521 if (!empty($formatValues['external_identifier'])) {
522 $checkCid = new CRM_Contact_DAO_Contact();
523 $checkCid->external_identifier
= $formatValues['external_identifier'];
524 $checkCid->find(TRUE);
525 if ($checkCid->id
!= $formatted['contact_id']) {
526 array_unshift($values, 'Mismatch of External ID:' . $formatValues['external_identifier'] . ' and Contact Id:' . $formatted['contact_id']);
527 return CRM_Import_Parser
::ERROR
;
532 $calcDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($formatted['membership_type_id'],
537 self
::formattedDates($calcDates, $formatted);
538 //end of date calculation part
540 //fix for CRM-3570, exclude the statuses those having is_admin = 1
541 //now user can import is_admin if is override is true.
542 $excludeIsAdmin = FALSE;
543 if (empty($formatted['is_override'])) {
544 $formatted['exclude_is_admin'] = $excludeIsAdmin = TRUE;
546 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($startDate,
551 $formatted['membership_type_id'],
554 if (empty($formatted['status_id'])) {
555 $formatted['status_id'] = CRM_Utils_Array
::value('id', $calcStatus);
557 elseif (empty($formatted['is_override'])) {
558 if (empty($calcStatus)) {
559 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.');
560 return CRM_Import_Parser
::ERROR
;
562 elseif ($formatted['status_id'] != $calcStatus['id']) {
563 //Status Hold" is either NOT mapped or is FALSE
564 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.');
565 return CRM_Import_Parser
::ERROR
;
569 $newMembership = civicrm_api3('membership', 'create', $formatted);
571 $this->_newMemberships
[] = $newMembership['id'];
572 return CRM_Import_Parser
::VALID
;
575 catch (Exception
$e) {
576 array_unshift($values, $e->getMessage());
577 return CRM_Import_Parser
::ERROR
;
582 * Get the array of successfully imported membership id's
586 public function &getImportedMemberships() {
587 return $this->_newMemberships
;
591 * The initializer code, called before the processing
595 public function fini() {
599 * to calculate join, start and end dates
601 * @param array $calcDates
602 * Array of dates returned by getDatesForMembershipType().
607 public function formattedDates($calcDates, &$formatted) {
614 foreach ($dates as $d) {
615 if (isset($formatted[$d]) &&
616 !CRM_Utils_System
::isNull($formatted[$d])
618 $formatted[$d] = CRM_Utils_Date
::isoToMysql($formatted[$d]);
620 elseif (isset($calcDates[$d])) {
621 $formatted[$d] = CRM_Utils_Date
::isoToMysql($calcDates[$d]);
627 * @deprecated - this function formats params according to v2 standards but
628 * need to be sure about the impact of not calling it so retaining on the import class
629 * take the input parameter list as specified in the data model and
630 * convert it into the same format that we use in QF and BAO object
632 * @param array $params
633 * Associative array of property name/value.
634 * pairs to insert in new contact.
635 * @param array $values
636 * The reformatted properties that we can use internally.
638 * @param array|bool $create Is the formatted Values array going to
639 * be used for CRM_Member_BAO_Membership:create()
642 * @return array|error
644 public function membership_format_params($params, &$values, $create = FALSE) {
645 require_once 'api/v3/utils.php';
646 $fields = CRM_Member_DAO_Membership
::fields();
647 _civicrm_api3_store_values($fields, $params, $values);
649 $customFields = CRM_Core_BAO_CustomField
::getFields('Membership');
651 foreach ($params as $key => $value) {
652 // ignore empty values or empty arrays etc
653 if (CRM_Utils_System
::isNull($value)) {
657 //Handling Custom Data
658 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
659 $values[$key] = $value;
660 $type = $customFields[$customFieldID]['html_type'];
661 if ($type == 'CheckBox' ||
$type == 'Multi-Select') {
662 $mulValues = explode(',', $value);
663 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
664 $values[$key] = array();
665 foreach ($mulValues as $v1) {
666 foreach ($customOption as $customValueID => $customLabel) {
667 $customValue = $customLabel['value'];
668 if ((strtolower($customLabel['label']) == strtolower(trim($v1))) ||
669 (strtolower($customValue) == strtolower(trim($v1)))
671 if ($type == 'CheckBox') {
672 $values[$key][$customValue] = 1;
675 $values[$key][] = $customValue;
684 case 'membership_contact_id':
685 if (!CRM_Utils_Rule
::integer($value)) {
686 throw new Exception("contact_id not valid: $value");
688 $dao = new CRM_Core_DAO();
690 $svq = $dao->singleValueQuery("SELECT id FROM civicrm_contact WHERE id = $value",
694 throw new Exception("Invalid Contact ID: There is no contact record with contact_id = $value.");
696 $values['contact_id'] = $values['membership_contact_id'];
697 unset($values['membership_contact_id']);
700 case 'membership_type_id':
701 if (!CRM_Utils_Array
::value($value, CRM_Member_PseudoConstant
::membershipType())) {
702 throw new Exception('Invalid Membership Type Id');
704 $values[$key] = $value;
707 case 'membership_type':
708 $membershipTypeId = CRM_Utils_Array
::key(ucfirst($value),
709 CRM_Member_PseudoConstant
::membershipType()
711 if ($membershipTypeId) {
712 if (!empty($values['membership_type_id']) &&
713 $membershipTypeId != $values['membership_type_id']
715 throw new Exception('Mismatched membership Type and Membership Type Id');
719 throw new Exception('Invalid Membership Type');
721 $values['membership_type_id'] = $membershipTypeId;
725 if (!CRM_Utils_Array
::value($value, CRM_Member_PseudoConstant
::membershipStatus())) {
726 throw new Exception('Invalid Membership Status Id');
728 $values[$key] = $value;
731 case 'membership_status':
732 $membershipStatusId = CRM_Utils_Array
::key(ucfirst($value),
733 CRM_Member_PseudoConstant
::membershipStatus()
735 if ($membershipStatusId) {
736 if (!empty($values['status_id']) &&
737 $membershipStatusId != $values['status_id']
739 throw new Exception('Mismatched membership Status and Membership Status Id');
743 throw new Exception('Invalid Membership Status');
745 $values['status_id'] = $membershipStatusId;
753 _civicrm_api3_custom_format_params($params, $values, 'Membership');
756 // CRM_Member_BAO_Membership::create() handles membership_start_date,
757 // membership_end_date and membership_source. So, if $values contains
758 // membership_start_date, membership_end_date or membership_source,
759 // convert it to start_date, end_date or source
761 'membership_start_date' => 'start_date',
762 'membership_end_date' => 'end_date',
763 'membership_source' => 'source',
766 foreach ($changes as $orgVal => $changeVal) {
767 if (isset($values[$orgVal])) {
768 $values[$changeVal] = $values[$orgVal];
769 unset($values[$orgVal]);