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 * This class generates form components for offline membership form.
21 class CRM_Member_Form_Membership
extends CRM_Member_Form
{
23 protected $_memType = NULL;
27 public $_contributeMode = 'direct';
29 protected $_recurMembershipTypes;
31 protected $_memTypeSelected;
34 * Display name of the member.
38 protected $_memberDisplayName = NULL;
41 * email of the person paying for the membership (used for receipts)
44 protected $_memberEmail = NULL;
47 * Contact ID of the member.
51 public $_contactID = NULL;
54 * Display name of the person paying for the membership (used for receipts)
58 protected $_contributorDisplayName = NULL;
61 * Email of the person paying for the membership (used for receipts).
65 protected $_contributorEmail;
68 * email of the person paying for the membership (used for receipts)
72 protected $_contributorContactID = NULL;
75 * ID of the person the receipt is to go to.
79 protected $_receiptContactId = NULL;
82 * Keep a class variable for ALL membership IDs so
83 * postProcess hook function can do something with it
87 protected $_membershipIDs = [];
90 * Set entity fields to be assigned to the form.
92 protected function setEntityFields() {
93 $this->entityFields
= [
95 'name' => 'join_date',
96 'description' => ts('Member Since'),
99 'name' => 'start_date',
100 'description' => ts('Start Date'),
103 'name' => 'end_date',
104 'description' => ts('End Date'),
110 * Set the delete message.
112 * We do this from the constructor in order to do a translation.
114 public function setDeleteMessage() {
115 $this->deleteMessage
= '<span class="font-red bold">'
116 . ts('WARNING: Deleting this membership will also delete any related payment (contribution) records.' . ts('This action cannot be undone.')
118 . ts('Consider modifying the membership status instead if you want to maintain an audit trail and avoid losing payment data. You can set the status to Cancelled by editing the membership and clicking the Status Override checkbox.')
120 . ts("Click 'Delete' if you want to continue.") . '</p>');
124 * Overriding this entity trait function as not yet tested.
126 * We continue to rely on legacy handling.
128 public function addCustomDataToForm() {}
131 * Overriding this entity trait function as not yet tested.
133 * We continue to rely on legacy handling.
135 public function addFormButtons() {}
138 * Get selected membership type from the form values.
140 * @param array $priceSet
141 * @param array $params
144 * @throws \CRM_Core_Exception
146 public static function getSelectedMemberships($priceSet, $params) {
147 $memTypeSelected = [];
148 $priceFieldIDS = self
::getPriceFieldIDs($params, $priceSet);
149 if (isset($params['membership_type_id']) && !empty($params['membership_type_id'][1])) {
150 $memTypeSelected = [$params['membership_type_id'][1] => $params['membership_type_id'][1]];
153 foreach ($priceFieldIDS as $priceFieldId) {
154 if ($id = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id')) {
155 $memTypeSelected[$id] = $id;
159 return $memTypeSelected;
163 * Extract price set fields and values from $params.
165 * @param array $params
166 * @param array $priceSet
170 public static function getPriceFieldIDs($params, $priceSet) {
172 if (isset($priceSet['fields']) && is_array($priceSet['fields'])) {
173 foreach ($priceSet['fields'] as $fieldId => $field) {
174 if (!empty($params['price_' . $fieldId])) {
175 if (is_array($params['price_' . $fieldId])) {
176 foreach ($params['price_' . $fieldId] as $priceFldVal => $isSet) {
178 $priceFieldIDS[] = $priceFldVal;
182 elseif (!$field['is_enter_qty']) {
183 $priceFieldIDS[] = $params['price_' . $fieldId];
188 return $priceFieldIDS;
192 * Form preProcess function.
194 * @throws \CRM_Core_Exception
195 * @throws \CiviCRM_API3_Exception
197 public function preProcess() {
198 // This string makes up part of the class names, differentiating them (not sure why) from the membership fields.
199 $this->assign('formClass', 'membership');
200 parent
::preProcess();
203 $this->_priceSetId
= $_GET['priceSetId'] ??
NULL;
204 $this->set('priceSetId', $this->_priceSetId
);
205 $this->assign('priceSetId', $this->_priceSetId
);
207 if ($this->_action
& CRM_Core_Action
::DELETE
) {
208 $contributionID = CRM_Member_BAO_Membership
::getMembershipContributionId($this->_id
);
209 // check delete permission for contribution
210 if ($this->_id
&& $contributionID && !CRM_Core_Permission
::checkActionPermission('CiviContribute', $this->_action
)) {
211 CRM_Core_Error
::statusBounce(ts("This Membership is linked to a contribution. You must have 'delete in CiviContribute' permission in order to delete this record."));
215 if ($this->_action
& CRM_Core_Action
::ADD
) {
216 if ($this->_contactID
) {
217 //check whether contact has a current membership so we can alert user that they may want to do a renewal instead
218 $contactMemberships = [];
219 $memParams = ['contact_id' => $this->_contactID
];
220 CRM_Member_BAO_Membership
::getValues($memParams, $contactMemberships, TRUE);
222 foreach ($contactMemberships as $mem) {
223 $cMemTypes[] = $mem['membership_type_id'];
225 if (count($cMemTypes) > 0) {
226 foreach ($cMemTypes as $memTypeID) {
227 $memberorgs[$memTypeID] = CRM_Member_BAO_MembershipType
::getMembershipType($memTypeID)['member_of_contact_id'];
230 foreach ($contactMemberships as $mem) {
231 $mem['member_of_contact_id'] = $memberorgs[$mem['membership_type_id']] ??
NULL;
232 if (!empty($mem['membership_end_date'])) {
233 $mem['membership_end_date'] = CRM_Utils_Date
::customFormat($mem['membership_end_date']);
235 $mem['membership_type'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
236 $mem['membership_type_id'],
239 $mem['membership_status'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
243 $mem['renewUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
244 "reset=1&action=renew&cid={$this->_contactID}&id={$mem['id']}&context=membership&selectedChild=member"
245 . ($this->_mode ?
'&mode=live' : '')
247 $mem['membershipTab'] = CRM_Utils_System
::url('civicrm/contact/view',
248 "reset=1&force=1&cid={$this->_contactID}&selectedChild=member"
250 $mems_by_org[$mem['member_of_contact_id']] = $mem;
252 $this->assign('existingContactMemberships', $mems_by_org);
256 // In standalone mode we don't have a contact id yet so lookup will be done client-side with this script:
257 $resources = CRM_Core_Resources
::singleton();
258 $resources->addScriptFile('civicrm', 'templates/CRM/Member/Form/MembershipStandalone.js');
260 'typeorgs' => CRM_Member_BAO_MembershipType
::getMembershipTypeOrganization(),
261 'memtypes' => CRM_Core_PseudoConstant
::get('CRM_Member_BAO_Membership', 'membership_type_id'),
262 'statuses' => CRM_Core_PseudoConstant
::get('CRM_Member_BAO_Membership', 'status_id'),
264 $resources->addSetting(['existingMems' => $passthru]);
268 if (!$this->_memType
) {
269 $params = CRM_Utils_Request
::exportValues();
270 if (!empty($params['membership_type_id'][1])) {
271 $this->_memType
= $params['membership_type_id'][1];
275 // Add custom data to form
276 CRM_Custom_Form_CustomData
::addToForm($this, $this->_memType
);
277 $this->setPageTitle(ts('Membership'));
281 * Set default values for the form.
283 public function setDefaultValues() {
285 if ($this->_priceSetId
) {
286 return CRM_Price_BAO_PriceSet
::setDefaultPriceSet($this, $defaults);
289 $defaults = parent
::setDefaultValues();
291 //setting default join date and receive date
292 if ($this->_action
== CRM_Core_Action
::ADD
) {
293 $defaults['receive_date'] = CRM_Utils_Time
::date('Y-m-d H:i:s');
296 $defaults['num_terms'] = 1;
298 if (!empty($defaults['id'])) {
299 $contributionId = CRM_Core_DAO
::singleValueQuery("
300 SELECT contribution_id
301 FROM civicrm_membership_payment
302 WHERE membership_id = $this->_id
303 ORDER BY contribution_id
306 if ($contributionId) {
307 $defaults['record_contribution'] = $contributionId;
311 if ($this->_contactID
) {
312 $defaults['contact_id'] = $this->_contactID
;
316 //set Soft Credit Type to Gift by default
317 $scTypes = CRM_Core_OptionGroup
::values('soft_credit_type');
318 $defaults['soft_credit_type_id'] = CRM_Utils_Array
::value(ts('Gift'), array_flip($scTypes));
321 if (empty($defaults['payment_instrument_id'])) {
322 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
325 // User must explicitly choose to send a receipt in both add and update mode.
326 $defaults['send_receipt'] = 0;
328 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
329 // in this mode by default uncheck this checkbox
330 unset($defaults['record_contribution']);
333 $subscriptionCancelled = FALSE;
334 if (!empty($defaults['id'])) {
335 $subscriptionCancelled = CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_id
);
338 $alreadyAutoRenew = FALSE;
339 if (!empty($defaults['contribution_recur_id']) && !$subscriptionCancelled) {
340 $defaults['auto_renew'] = 1;
341 $alreadyAutoRenew = TRUE;
343 $this->assign('alreadyAutoRenew', $alreadyAutoRenew);
345 $this->assign('member_is_test', $defaults['member_is_test'] ??
NULL);
346 $this->assign('membership_status_id', $defaults['status_id'] ??
NULL);
347 $this->assign('is_pay_later', !empty($defaults['is_pay_later']));
350 $defaults = $this->getBillingDefaults($defaults);
353 //setting default join date if there is no join date
354 if (empty($defaults['join_date'])) {
355 $defaults['join_date'] = CRM_Utils_Time
::date('Y-m-d');
358 if (!empty($defaults['membership_end_date'])) {
359 $this->assign('endDate', $defaults['membership_end_date']);
366 * Build the form object.
368 * @throws \CRM_Core_Exception
370 public function buildQuickForm() {
372 $this->buildQuickEntityForm();
373 $this->assign('currency_symbol', CRM_Core_BAO_Country
::defaultCurrencySymbol());
374 $isUpdateToExistingRecurringMembership = $this->isUpdateToExistingRecurringMembership();
375 // build price set form.
376 $buildPriceSet = FALSE;
377 if ($this->_priceSetId ||
!empty($_POST['price_set_id'])) {
378 if (!empty($_POST['price_set_id'])) {
379 $buildPriceSet = TRUE;
381 $getOnlyPriceSetElements = TRUE;
382 if (!$this->_priceSetId
) {
383 $this->_priceSetId
= $_POST['price_set_id'];
384 $getOnlyPriceSetElements = FALSE;
387 $this->set('priceSetId', $this->_priceSetId
);
388 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
390 $optionsMembershipTypes = [];
391 foreach ($this->_priceSet
['fields'] as $pField) {
392 if (empty($pField['options'])) {
395 foreach ($pField['options'] as $opId => $opValues) {
396 $optionsMembershipTypes[$opId] = CRM_Utils_Array
::value('membership_type_id', $opValues, 0);
400 $this->assign('autoRenewOption', CRM_Price_BAO_PriceSet
::checkAutoRenewForPriceSet($this->_priceSetId
));
402 $this->assign('optionsMembershipTypes', $optionsMembershipTypes);
403 $this->assign('contributionType', CRM_Utils_Array
::value('financial_type_id', $this->_priceSet
));
405 // get only price set form elements.
406 if ($getOnlyPriceSetElements) {
411 // use to build form during form rule.
412 $this->assign('buildPriceSet', $buildPriceSet);
414 if ($this->_action
& CRM_Core_Action
::ADD
) {
415 $buildPriceSet = FALSE;
416 $priceSets = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviMember');
417 if (!empty($priceSets)) {
418 $buildPriceSet = TRUE;
421 if ($buildPriceSet) {
422 $this->add('select', 'price_set_id', ts('Choose price set'),
424 '' => ts('Choose price set'),
426 NULL, ['onchange' => "buildAmount( this.value );"]
429 $this->assign('hasPriceSets', $buildPriceSet);
432 if ($this->_action
& CRM_Core_Action
::DELETE
) {
436 'name' => ts('Delete'),
437 'spacing' => ' ',
442 'name' => ts('Cancel'),
448 $contactField = $this->addEntityRef('contact_id', ts('Member'), ['create' => TRUE, 'api' => ['extra' => ['email']]], TRUE);
449 if ($this->_context
!== 'standalone') {
450 $contactField->freeze();
453 $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
455 // Throw status bounce when no Membership type or priceset is present
456 if (empty($this->allMembershipTypeDetails
) && empty($priceSets)
458 CRM_Core_Error
::statusBounce(ts('You do not have all the permissions needed for this page.'));
460 // retrieve all memberships
461 $allMembershipInfo = [];
462 foreach ($this->allMembershipTypeDetails
as $key => $values) {
463 if ($this->_mode
&& empty($values['minimum_fee'])) {
467 $memberOfContactId = $values['member_of_contact_id'] ??
NULL;
468 if (empty($selMemTypeOrg[$memberOfContactId])) {
469 $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
475 $selOrgMemType[$memberOfContactId][0] = ts('- select -');
477 if (empty($selOrgMemType[$memberOfContactId][$key])) {
478 $selOrgMemType[$memberOfContactId][$key] = $values['name'] ??
NULL;
481 $totalAmount = $values['minimum_fee'] ??
NULL;
482 // build membership info array, which is used when membership type is selected to:
483 // - set the payment information block
484 // - set the max related block
485 $allMembershipInfo[$key] = [
486 'financial_type_id' => $values['financial_type_id'] ??
NULL,
487 'total_amount' => CRM_Utils_Money
::formatLocaleNumericRoundedForDefaultCurrency($totalAmount),
488 'total_amount_numeric' => $totalAmount,
489 'auto_renew' => $values['auto_renew'] ??
NULL,
490 'tax_rate' => $values['tax_rate'],
491 'has_related' => isset($values['relationship_type_id']),
492 'max_related' => $values['max_related'] ??
NULL,
496 $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
498 // show organization by default, if only one organization in
500 if (count($selMemTypeOrg) == 2) {
501 unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
503 //sort membership organization and type, CRM-6099
504 natcasesort($selMemTypeOrg);
505 foreach ($selOrgMemType as $index => $orgMembershipType) {
506 natcasesort($orgMembershipType);
507 $selOrgMemType[$index] = $orgMembershipType;
511 'onChange' => "buildMaxRelated(this.value,true); CRM.buildCustomData('Membership', this.value);",
514 if (!empty($this->_recurPaymentProcessors
)) {
515 $memTypeJs['onChange'] = "" . $memTypeJs['onChange'] . " buildAutoRenew(this.value, null, '{$this->_mode}');";
518 $this->add('text', 'max_related', ts('Max related'),
519 CRM_Core_DAO
::getAttribute('CRM_Member_DAO_Membership', 'max_related')
522 $sel = &$this->addElement('hierselect',
523 'membership_type_id',
524 ts('Membership Organization and Type'),
528 $sel->setOptions([$selMemTypeOrg, $selOrgMemType]);
530 if ($this->_action
& CRM_Core_Action
::ADD
) {
531 $this->add('number', 'num_terms', ts('Number of Terms'), ['size' => 6]);
534 $this->add('text', 'source', ts('Source'),
535 CRM_Core_DAO
::getAttribute('CRM_Member_DAO_Membership', 'source')
538 //CRM-7362 --add campaigns.
541 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'campaign_id');
543 CRM_Campaign_BAO_Campaign
::addCampaign($this, $campaignId);
546 $this->add('select', 'status_id', ts('Membership Status'),
547 ['' => ts('- select -')] + CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label')
550 $statusOverride = $this->addElement('select', 'is_override', ts('Status Override?'),
551 CRM_Member_StatusOverrideTypes
::getSelectOptions()
554 $this->add('datepicker', 'status_override_end_date', ts('Status Override End Date'), '', FALSE, ['minDate' => CRM_Utils_Time
::date('Y-m-d'), 'time' => FALSE]);
556 $this->addElement('checkbox', 'record_contribution', ts('Record Membership Payment?'));
558 $this->add('text', 'total_amount', ts('Amount'));
559 $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
561 $this->add('datepicker', 'receive_date', ts('Received'), [], FALSE, ['time' => TRUE]);
563 $this->add('select', 'payment_instrument_id',
564 ts('Payment Method'),
565 ['' => ts('- select -')] + CRM_Contribute_PseudoConstant
::paymentInstrument(),
566 FALSE, ['onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);"]
568 $this->add('text', 'trxn_id', ts('Transaction ID'));
569 $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
571 'CRM_Contribute_DAO_Contribution',
577 $this->add('select', 'contribution_status_id',
578 ts('Payment Status'), CRM_Contribute_BAO_Contribution_Utils
::getContributionStatuses('membership')
580 $this->add('text', 'check_number', ts('Check Number'),
581 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
585 //add field for amount to allow an amount to be entered that differs from minimum
586 $this->add('text', 'total_amount', ts('Amount'));
588 $this->add('select', 'financial_type_id',
589 ts('Financial Type'),
590 ['' => ts('- select -')] + CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes, $this->_action
)
593 $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different Contact?'));
595 $this->addSelect('soft_credit_type_id', ['entity' => 'contribution_soft']);
596 $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), ['create' => TRUE]);
598 $this->addElement('checkbox',
600 ts('Send Confirmation and Receipt?'), NULL,
601 ['onclick' => "showEmailOptions()"]
604 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
606 $this->add('textarea', 'receipt_text', ts('Receipt Message'));
608 // Retrieve the name and email of the contact - this will be the TO for receipt email
609 if ($this->_contactID
) {
610 [$this->_memberDisplayName
, $this->_memberEmail
] = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
612 $this->assign('emailExists', $this->_memberEmail
);
613 $this->assign('displayName', $this->_memberDisplayName
);
616 if ($isUpdateToExistingRecurringMembership && CRM_Member_BAO_Membership
::isCancelSubscriptionSupported($this->_id
)) {
617 $this->assign('cancelAutoRenew',
618 CRM_Utils_System
::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
622 $this->assign('isRecur', $isUpdateToExistingRecurringMembership);
624 $this->addFormRule(['CRM_Member_Form_Membership', 'formRule'], $this);
625 $mailingInfo = Civi
::settings()->get('mailing_backend');
626 $this->assign('isEmailEnabledForSite', ($mailingInfo['outBound_option'] != 2));
628 parent
::buildQuickForm();
634 * @param array $params
635 * (ref.) an assoc array of name/value pairs.
637 * @param array $files
638 * @param CRM_Member_Form_Membership $self
641 * mixed true or array of errors
643 * @throws \CRM_Core_Exception
644 * @throws CiviCRM_API3_Exception
646 public static function formRule($params, $files, $self) {
649 $priceSetId = $self->getPriceSetID($params);
650 $priceSetDetails = $self->getPriceSetDetails($params);
652 $selectedMemberships = self
::getSelectedMemberships($priceSetDetails[$priceSetId], $params);
654 if (!empty($params['price_set_id'])) {
655 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $params, $errors);
657 $priceFieldIDS = self
::getPriceFieldIDs($params, $priceSetDetails[$priceSetId]);
659 if (!empty($priceFieldIDS)) {
660 $ids = implode(',', $priceFieldIDS);
662 $count = CRM_Price_BAO_PriceSet
::getMembershipCount($ids);
663 foreach ($count as $occurrence) {
664 if ($occurrence > 1) {
665 $errors['_qf_default'] = ts('Select at most one option associated with the same membership type.');
669 // Return error if empty $self->_memTypeSelected
670 if (empty($errors) && empty($selectedMemberships)) {
671 $errors['_qf_default'] = ts('Select at least one membership option.');
673 if (!$self->_mode
&& empty($params['record_contribution'])) {
674 $errors['record_contribution'] = ts('Record Membership Payment is required when you use a price set.');
678 if (empty($params['membership_type_id'][1])) {
679 $errors['membership_type_id'] = ts('Please select a membership type.');
681 $numterms = $params['num_terms'] ??
NULL;
682 if ($numterms && intval($numterms) != $numterms) {
683 $errors['num_terms'] = ts('Please enter an integer for the number of terms.');
686 if (($self->_mode ||
isset($params['record_contribution'])) && empty($params['financial_type_id'])) {
687 $errors['financial_type_id'] = ts('Please enter the financial Type.');
691 if (!empty($errors) && (count($selectedMemberships) > 1)) {
692 $memberOfContacts = CRM_Member_BAO_MembershipType
::getMemberOfContactByMemTypes($selectedMemberships);
693 $duplicateMemberOfContacts = array_count_values($memberOfContacts);
694 foreach ($duplicateMemberOfContacts as $countDuplicate) {
695 if ($countDuplicate > 1) {
696 $errors['_qf_default'] = ts('Please do not select more than one membership associated with the same organization.');
701 if (!empty($errors)) {
705 if (!empty($params['record_contribution']) && empty($params['payment_instrument_id'])) {
706 $errors['payment_instrument_id'] = ts('Payment Method is a required field.');
709 if (!empty($params['is_different_contribution_contact'])) {
710 if (empty($params['soft_credit_type_id'])) {
711 $errors['soft_credit_type_id'] = ts('Please Select a Soft Credit Type');
713 if (empty($params['soft_credit_contact_id'])) {
714 $errors['soft_credit_contact_id'] = ts('Please select a contact');
718 if (!empty($params['payment_processor_id'])) {
719 // validate payment instrument (e.g. credit card number)
720 CRM_Core_Payment_Form
::validatePaymentInstrument($params['payment_processor_id'], $params, $errors, NULL);
724 if (!empty($params['join_date'])) {
726 $joinDate = CRM_Utils_Date
::processDate($params['join_date']);
728 foreach ($selectedMemberships as $memType) {
730 if (!empty($params['start_date'])) {
731 $startDate = CRM_Utils_Date
::processDate($params['start_date']);
734 // if end date is set, ensure that start date is also set
735 // and that end date is later than start date
737 if (!empty($params['end_date'])) {
738 $endDate = CRM_Utils_Date
::processDate($params['end_date']);
741 $membershipDetails = CRM_Member_BAO_MembershipType
::getMembershipType($memType);
742 if ($startDate && CRM_Utils_Array
::value('period_type', $membershipDetails) === 'rolling') {
743 if ($startDate < $joinDate) {
744 $errors['start_date'] = ts('Start date must be the same or later than Member since.');
749 if ($membershipDetails['duration_unit'] === 'lifetime') {
750 // Check if status is NOT cancelled or similar. For lifetime memberships, there is no automated
751 // process to update status based on end-date. The user must change the status now.
752 $result = civicrm_api3('MembershipStatus', 'get', [
754 'is_current_member' => 0,
756 $tmp_statuses = $result['values'];
758 foreach ($tmp_statuses as $cur_stat) {
759 $status_ids[] = $cur_stat['id'];
762 if (empty($params['status_id']) ||
in_array($params['status_id'], $status_ids) == FALSE) {
763 $errors['status_id'] = ts('Please enter a status that does NOT represent a current membership status.');
766 if (!empty($params['is_override']) && !CRM_Member_StatusOverrideTypes
::isPermanent($params['is_override'])) {
767 $errors['is_override'] = ts('Because you set an End Date for a lifetime membership, This must be set to "Override Permanently"');
772 $errors['start_date'] = ts('Start date must be set if end date is set.');
774 if ($endDate < $startDate) {
775 $errors['end_date'] = ts('End date must be the same or later than start date.');
780 // Default values for start and end dates if not supplied on the form.
781 $defaultDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
788 $startDate = CRM_Utils_Array
::value('start_date',
793 $endDate = CRM_Utils_Array
::value('end_date',
798 //CRM-3724, check for availability of valid membership status.
799 if ((empty($params['is_override']) || CRM_Member_StatusOverrideTypes
::isNo($params['is_override'])) && !isset($errors['_qf_default'])) {
800 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($startDate,
808 if (empty($calcStatus)) {
809 $url = CRM_Utils_System
::url('civicrm/admin/member/membershipStatus', 'reset=1&action=browse');
810 $errors['_qf_default'] = ts('There is no valid Membership Status available for selected membership dates.');
811 $status = ts('Oops, it looks like there is no valid membership status available for the given membership dates. You can <a href="%1">Configure Membership Status Rules</a>.', [1 => $url]);
813 $status .= ' ' . ts('OR You can sign up by setting Status Override? to something other than "NO".');
815 CRM_Core_Session
::setStatus($status, ts('Membership Status Error'), 'error');
821 $errors['join_date'] = ts('Please enter the Member Since.');
824 if (!empty($params['is_override']) && CRM_Member_StatusOverrideTypes
::isOverridden($params['is_override']) && empty($params['status_id'])) {
825 $errors['status_id'] = ts('Please enter the Membership status.');
828 if (!empty($params['is_override']) && CRM_Member_StatusOverrideTypes
::isUntilDate($params['is_override'])) {
829 if (empty($params['status_override_end_date'])) {
830 $errors['status_override_end_date'] = ts('Please enter the Membership override end date.');
834 //total amount condition arise when membership type having no
836 if (isset($params['record_contribution'])) {
837 if (CRM_Utils_System
::isNull($params['total_amount'])) {
838 $errors['total_amount'] = ts('Please enter the contribution.');
842 return empty($errors) ?
TRUE : $errors;
846 * Process the form submission.
848 * @throws \CRM_Core_Exception
849 * @throws \CiviCRM_API3_Exception
851 public function postProcess() {
852 if ($this->_action
& CRM_Core_Action
::DELETE
) {
853 CRM_Member_BAO_Membership
::del($this->_id
);
856 // get the submitted form values.
857 $this->_params
= $this->controller
->exportValues($this->_name
);
858 $this->prepareStatusOverrideValues();
862 $this->setUserContext();
866 * Prepares the values related to status override.
868 private function prepareStatusOverrideValues() {
869 $this->setOverrideDateValue();
870 $this->convertIsOverrideValue();
874 * Sets status override end date to empty value if
875 * the selected override option is not 'until date'.
877 private function setOverrideDateValue() {
878 if (!CRM_Member_StatusOverrideTypes
::isUntilDate(CRM_Utils_Array
::value('is_override', $this->_params
))) {
879 $this->_params
['status_override_end_date'] = '';
884 * Convert the value of selected (status override?)
885 * option to TRUE if it indicate an overridden status
886 * or FALSE otherwise.
888 private function convertIsOverrideValue() {
889 $this->_params
['is_override'] = CRM_Member_StatusOverrideTypes
::isOverridden($this->_params
['is_override'] ?? CRM_Member_StatusOverrideTypes
::NO
);
893 * Send email receipt.
895 * @param CRM_Core_Form $form
897 * @param array $formValues
898 * @param object $membership
902 * true if mail was sent successfully
903 * @throws \CRM_Core_Exception
906 * This function is shared with Batch_Entry which has limited overlap
907 * & needs rationalising.
910 public static function emailReceipt($form, &$formValues, $membership) {
911 // retrieve 'from email id' for acknowledgement
912 $receiptFrom = $formValues['from_email_address'] ??
NULL;
914 // @todo figure out how much of the stuff below is genuinely shared with the batch form & a logical shared place.
915 if (!empty($formValues['payment_instrument_id'])) {
916 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
917 $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
920 $form->assign('module', 'Membership');
921 $form->assign('contactID', $formValues['contact_id']);
923 $form->assign('membershipID', CRM_Utils_Array
::value('membership_id', $form->_params
, CRM_Utils_Array
::value('membership_id', $form->_defaultValues
)));
925 if (!empty($formValues['contribution_id'])) {
926 $form->assign('contributionID', $formValues['contribution_id']);
929 if (!empty($formValues['contribution_status_id'])) {
930 $form->assign('contributionStatusID', $formValues['contribution_status_id']);
931 $form->assign('contributionStatus', CRM_Contribute_PseudoConstant
::contributionStatus($formValues['contribution_status_id'], 'name'));
934 if (!empty($formValues['is_renew'])) {
935 $form->assign('receiptType', 'membership renewal');
938 $form->assign('receiptType', 'membership signup');
940 $form->assign('receive_date', CRM_Utils_Array
::value('receive_date', $formValues));
941 $form->assign('formValues', $formValues);
943 $form->assign('mem_start_date', CRM_Utils_Date
::formatDateOnlyLong($membership->start_date
));
944 if (!CRM_Utils_System
::isNull($membership->end_date
)) {
945 $form->assign('mem_end_date', CRM_Utils_Date
::formatDateOnlyLong($membership->end_date
));
947 $form->assign('membership_name', CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
));
949 // @todo - if we have to figure out if this is for batch processing it doesn't belong in the shared function.
950 $isBatchProcess = is_a($form, 'CRM_Batch_Form_Entry');
951 if ((empty($form->_contributorDisplayName
) ||
empty($form->_contributorEmail
)) ||
$isBatchProcess) {
952 // in this case the form is being called statically from the batch editing screen
953 // having one class in the form layer call another statically is not greate
954 // & we should aim to move this function to the BAO layer in future.
955 // however, we can assume that the contact_id passed in by the batch
956 // function will be the recipient
957 [$form->_contributorDisplayName
, $form->_contributorEmail
]
958 = CRM_Contact_BAO_Contact_Location
::getEmailDetails($formValues['contact_id']);
959 if (empty($form->_receiptContactId
) ||
$isBatchProcess) {
960 $form->_receiptContactId
= $formValues['contact_id'];
964 CRM_Core_BAO_MessageTemplate
::sendTemplate(
966 'groupName' => 'msg_tpl_workflow_membership',
967 'valueName' => 'membership_offline_receipt',
968 'contactId' => $form->_receiptContactId
,
969 'from' => $receiptFrom,
970 'toName' => $form->_contributorDisplayName
,
971 'toEmail' => $form->_contributorEmail
,
972 'PDFFilename' => ts('receipt') . '.pdf',
973 'isEmailPdf' => Civi
::settings()->get('invoicing') && Civi
::settings()->get('invoice_is_email_pdf'),
974 'contributionId' => $formValues['contribution_id'],
975 'isTest' => (bool) ($form->_action
& CRM_Core_Action
::PREVIEW
),
985 * This is also accessed by unit tests.
987 * @throws \CRM_Core_Exception
988 * @throws \CiviCRM_API3_Exception
990 public function submit(): void
{
991 $this->storeContactFields($this->_params
);
992 $this->beginPostProcess();
994 $membership = $calcDate = [];
996 $paymentInstrumentID = $this->_paymentProcessor
['object']->getPaymentInstrumentID();
997 $params = $softParams = $ids = [];
1000 $this->processBillingAddress();
1001 $formValues = $this->_params
;
1002 $formValues = $this->setPriceSetParameters($formValues);
1005 $ids['membership'] = $params['id'] = $this->_id
;
1008 // Set variables that we normally get from context.
1009 // In form mode these are set in preProcess.
1010 //TODO: set memberships, fixme
1011 $this->setContextVariables($formValues);
1013 $this->_memTypeSelected
= self
::getSelectedMemberships(
1017 $formValues['financial_type_id'] = $this->getFinancialTypeID();
1018 $membershipTypeValues = [];
1019 foreach ($this->_memTypeSelected
as $memType) {
1020 $membershipTypeValues[$memType]['membership_type_id'] = $memType;
1023 //take the required membership recur values.
1024 if ($this->_mode
&& !empty($formValues['auto_renew'])) {
1025 $params['is_recur'] = $formValues['is_recur'] = TRUE;
1028 foreach ($this->_memTypeSelected
as $memType) {
1029 $recurMembershipTypeValues = CRM_Utils_Array
::value($memType,
1030 $this->allMembershipTypeDetails
, []
1032 if (!$recurMembershipTypeValues['auto_renew']) {
1036 'frequency_interval' => 'duration_interval',
1037 'frequency_unit' => 'duration_unit',
1038 ] as $mapVal => $mapParam) {
1039 $membershipTypeValues[$memType][$mapVal] = $recurMembershipTypeValues[$mapParam];
1042 $formValues[$mapVal] = CRM_Utils_Array
::value($mapParam,
1043 $recurMembershipTypeValues
1051 $isQuickConfig = $this->_priceSet
['is_quick_config'];
1055 $lineItem = [$this->order
->getPriceSetID() => $this->order
->getLineItems()];
1057 $params['tax_amount'] = $this->order
->getTotalTaxAmount();
1058 $params['total_amount'] = $this->order
->getTotalAmount();
1059 if (!empty($lineItem[$this->_priceSetId
])) {
1060 foreach ($lineItem[$this->_priceSetId
] as &$li) {
1061 if (!empty($li['membership_type_id'])) {
1062 if (!empty($li['membership_num_terms'])) {
1063 $termsByType[$li['membership_type_id']] = $li['membership_num_terms'];
1067 ///CRM-11529 for quick config backoffice transactions
1068 //when financial_type_id is passed in form, update the
1069 //lineitems with the financial type selected in form
1070 $submittedFinancialType = $formValues['financial_type_id'] ??
NULL;
1071 if ($isQuickConfig && $submittedFinancialType) {
1072 $li['financial_type_id'] = $submittedFinancialType;
1077 $params['contact_id'] = $this->_contactID
;
1083 'status_override_end_date',
1087 foreach ($fields as $f) {
1088 $params[$f] = $formValues[$f] ??
NULL;
1092 // when is_override false ignore is_admin statuses during membership
1093 // status calculation. similarly we did fix for import in CRM-3570.
1094 if (empty($params['is_override'])) {
1095 $params['exclude_is_admin'] = TRUE;
1098 $joinDate = $formValues['join_date'];
1099 $startDate = $formValues['start_date'];
1100 $endDate = $formValues['end_date'];
1102 $memTypeNumTerms = empty($termsByType) ? CRM_Utils_Array
::value('num_terms', $formValues) : NULL;
1105 foreach ($this->_memTypeSelected
as $memType) {
1106 if (empty($memTypeNumTerms)) {
1107 $memTypeNumTerms = CRM_Utils_Array
::value($memType, $termsByType, 1);
1109 $calcDates[$memType] = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
1110 $joinDate, $startDate, $endDate, $memTypeNumTerms
1114 foreach ($calcDates as $memType => $calcDate) {
1115 foreach (['join_date', 'start_date', 'end_date'] as $d) {
1116 //first give priority to form values then calDates.
1117 $date = $formValues[$d] ??
NULL;
1119 $date = $calcDate[$d] ??
NULL;
1122 $membershipTypeValues[$memType][$d] = CRM_Utils_Date
::processDate($date);
1126 foreach ($this->_memTypeSelected
as $memType) {
1127 if (array_key_exists('max_related', $formValues)) {
1128 // max related memberships - take from form or inherit from membership type
1129 $membershipTypeValues[$memType]['max_related'] = $formValues['max_related'] ??
NULL;
1131 $membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField
::postProcess($formValues,
1137 // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1138 [$userName] = CRM_Contact_BAO_Contact_Location
::getEmailDetails(CRM_Core_Session
::getLoggedInContactID());
1140 //CRM-13981, allow different person as a soft-contributor of chosen type
1141 if ($this->_contributorContactID
!= $this->_contactID
) {
1142 $params['contribution_contact_id'] = $this->_contributorContactID
;
1143 if (!empty($formValues['soft_credit_type_id'])) {
1144 $softParams['soft_credit_type_id'] = $formValues['soft_credit_type_id'];
1145 $softParams['contact_id'] = $this->_contactID
;
1149 $pendingMembershipStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending');
1151 if (!empty($formValues['record_contribution'])) {
1152 $recordContribution = [
1154 'payment_instrument_id',
1156 'contribution_status_id',
1164 foreach ($recordContribution as $f) {
1165 $params[$f] = $formValues[$f] ??
NULL;
1167 $params['financial_type_id'] = $this->getFinancialTypeID();
1169 if (empty($formValues['source'])) {
1170 $params['contribution_source'] = ts('%1 Membership: Offline signup (by %2)', [
1171 1 => $this->getSelectedMembershipLabels(),
1176 $params['contribution_source'] = $formValues['source'];
1179 $completedContributionStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
1180 if (empty($params['is_override']) &&
1181 CRM_Utils_Array
::value('contribution_status_id', $params) != $completedContributionStatusId
1183 $params['status_id'] = $pendingMembershipStatusId;
1184 $params['skipStatusCal'] = TRUE;
1185 $params['is_pay_later'] = 1;
1186 $this->assign('is_pay_later', 1);
1189 if ($this->getSubmittedValue('send_receipt')) {
1190 $params['receipt_date'] = $formValues['receive_date'] ??
NULL;
1193 //insert financial type name in receipt.
1194 $formValues['contributionType_name'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType',
1195 $this->getFinancialTypeID()
1199 // process line items, until no previous line items.
1200 if (!empty($lineItem)) {
1201 $params['lineItems'] = $lineItem;
1202 $params['processPriceSet'] = TRUE;
1204 $createdMemberships = [];
1206 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $formValues, 0);
1208 //CRM-20264 : Store CC type and number (last 4 digit) during backoffice or online payment
1209 $params['card_type_id'] = $this->_params
['card_type_id'] ??
NULL;
1210 $params['pan_truncation'] = $this->_params
['pan_truncation'] ??
NULL;
1211 $params['financial_type_id'] = $this->getFinancialTypeID();
1213 //get the payment processor id as per mode. Try removing in favour of beginPostProcess.
1214 $params['payment_processor_id'] = $formValues['payment_processor_id'] = $this->_paymentProcessor
['id'];
1215 $params['register_date'] = CRM_Utils_Time
::date('YmdHis');
1217 // add all the additional payment params we need
1218 $formValues['amount'] = $params['total_amount'];
1219 $formValues['currencyID'] = $this->getCurrency();
1220 $formValues['description'] = ts("Contribution submitted by a staff person using member's credit card for signup");
1221 $formValues['invoiceID'] = $this->getInvoiceID();
1222 $formValues['financial_type_id'] = $this->getFinancialTypeID();
1224 // at this point we've created a contact and stored its address etc
1225 // all the payment processors expect the name and address to be in the
1226 // so we copy stuff over to first_name etc.
1227 $paymentParams = $formValues;
1228 $paymentParams['contactID'] = $this->_contributorContactID
;
1229 //CRM-10377 if payment is by an alternate contact then we need to set that person
1230 // as the contact in the payment params
1231 if ($this->_contributorContactID
!= $this->_contactID
) {
1232 if (!empty($formValues['soft_credit_type_id'])) {
1233 $softParams['contact_id'] = $params['contact_id'];
1234 $softParams['soft_credit_type_id'] = $formValues['soft_credit_type_id'];
1237 if ($this->getSubmittedValue('send_receipt')) {
1238 $paymentParams['email'] = $this->_contributorEmail
;
1241 // This is a candidate for shared beginPostProcess function.
1242 // @todo Do we need this now we have $this->formatParamsForPaymentProcessor() ?
1243 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $formValues, $paymentParams, TRUE);
1244 // CRM-7137 -for recurring membership,
1245 // we do need contribution and recurring records.
1247 if (!empty($paymentParams['is_recur'])) {
1248 $this->_params
= $formValues;
1250 $contribution = $this->processContribution(
1253 'contact_id' => $this->_contributorContactID
,
1254 'line_item' => $lineItem,
1255 'is_test' => $this->isTest(),
1256 'campaign_id' => $paymentParams['campaign_id'] ??
NULL,
1257 'source' => CRM_Utils_Array
::value('source', $paymentParams, CRM_Utils_Array
::value('description', $paymentParams)),
1258 'payment_instrument_id' => $paymentInstrumentID,
1259 'financial_type_id' => $this->getFinancialTypeID(),
1260 'receive_date' => CRM_Utils_Time
::date('YmdHis'),
1261 'tax_amount' => $params['tax_amount'] ??
NULL,
1262 'invoice_id' => $this->getInvoiceID(),
1263 'currency' => $this->getCurrency(),
1264 'is_pay_later' => $params['is_pay_later'] ??
0,
1265 'skipLineItem' => $params['skipLineItem'] ??
0,
1269 //create new soft-credit record, CRM-13981
1271 $softParams['contribution_id'] = $contribution->id
;
1272 $softParams['currency'] = $contribution->currency
;
1273 $softParams['amount'] = $contribution->total_amount
;
1274 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1277 $paymentParams['contactID'] = $this->_contactID
;
1278 $paymentParams['contributionID'] = $contribution->id
;
1279 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1280 $params['contribution_id'] = $paymentParams['contributionID'];
1281 $params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
1283 $paymentStatus = NULL;
1285 if ($params['total_amount'] > 0.0) {
1286 $payment = $this->_paymentProcessor
['object'];
1288 $result = $payment->doPayment($paymentParams);
1289 $formValues = array_merge($formValues, $result);
1290 $paymentStatus = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $formValues['payment_status_id']);
1291 // Assign amount to template if payment was successful.
1292 $this->assign('amount', $params['total_amount']);
1294 catch (\Civi\Payment\Exception\PaymentProcessorException
$e) {
1295 if (!empty($paymentParams['contributionID'])) {
1296 CRM_Contribute_BAO_Contribution
::failPayment($paymentParams['contributionID'], $this->_contactID
,
1299 if (!empty($paymentParams['contributionRecurID'])) {
1300 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($paymentParams['contributionRecurID']);
1303 CRM_Core_Session
::singleton()->setStatus($e->getMessage());
1304 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
1305 "reset=1&action=add&cid={$this->_contactID}&context=membership&mode={$this->_mode}"
1311 if ($paymentStatus !== 'Completed') {
1312 $params['status_id'] = $pendingMembershipStatusId;
1313 $params['skipStatusCal'] = TRUE;
1314 //as membership is pending set dates to null.
1315 foreach ($this->_memTypeSelected
as $memType) {
1316 $membershipTypeValues[$memType]['joinDate'] = NULL;
1317 $membershipTypeValues[$memType]['startDate'] = NULL;
1318 $membershipTypeValues[$memType]['endDate'] = NULL;
1320 $endDate = $startDate = NULL;
1322 $now = CRM_Utils_Time
::date('YmdHis');
1323 $params['receive_date'] = CRM_Utils_Time
::date('Y-m-d H:i:s');
1324 $params['invoice_id'] = $this->getInvoiceID();
1325 $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
1326 [1 => $this->getSelectedMembershipLabels(), 2 => $userName]
1328 $params['source'] = $formValues['source'] ?
: $params['contribution_source'];
1329 $params['trxn_id'] = $result['trxn_id'] ??
NULL;
1330 $params['is_test'] = $this->isTest();
1331 $params['receipt_date'] = NULL;
1332 if ($this->getSubmittedValue('send_receipt') && $paymentStatus === 'Completed') {
1333 // @todo this should be updated by the send function once sent rather than
1335 $params['receipt_date'] = $now;
1338 $this->set('params', $formValues);
1339 $this->assign('trxn_id', CRM_Utils_Array
::value('trxn_id', $result));
1340 $this->assign('receive_date',
1341 CRM_Utils_Date
::mysqlToIso($params['receive_date'])
1344 // required for creating membership for related contacts
1345 $params['action'] = $this->_action
;
1347 //create membership record.
1349 foreach ($this->_memTypeSelected
as $memType) {
1351 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1353 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1356 $membershipParams = array_merge($membershipTypeValues[$memType], $params);
1358 if (!empty($softParams) && empty($paymentParams['is_recur'])) {
1359 $membershipParams['soft_credit'] = $softParams;
1361 if (isset($result['fee_amount'])) {
1362 $membershipParams['fee_amount'] = $result['fee_amount'];
1364 // This is required to trigger the recording of the membership contribution in the
1365 // CRM_Member_BAO_Membership::Create function.
1366 // @todo stop setting this & 'teach' the create function to respond to something
1367 // appropriate as part of our 2-step always create the pending contribution & then finally add the payment
1369 // @see http://wiki.civicrm.org/confluence/pages/viewpage.action?pageId=261062657#Payments&AccountsRoadmap-Movetowardsalwaysusinga2-steppaymentprocess
1370 $membershipParams['contribution_status_id'] = $result['payment_status_id'] ??
NULL;
1371 if (!empty($paymentParams['is_recur'])) {
1372 // The earlier process created the line items (although we want to get rid of the earlier one in favour
1373 // of a single path!
1374 unset($membershipParams['lineItems']);
1376 $membershipParams['payment_instrument_id'] = $paymentInstrumentID;
1377 // @todo stop passing $ids (membership and userId only are set above)
1378 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1379 $params['contribution'] = $membershipParams['contribution'] ??
NULL;
1380 unset($params['lineItems']);
1381 $this->_membershipIDs
[] = $membership->id
;
1382 $createdMemberships[$memType] = $membership;
1388 $params['action'] = $this->_action
;
1389 foreach ($lineItem[$this->_priceSetId
] as $id => $lineItemValues) {
1390 if (empty($lineItemValues['membership_type_id'])) {
1394 // @todo figure out why recieve_date isn't being set right here.
1395 if (empty($params['receive_date'])) {
1396 $params['receive_date'] = CRM_Utils_Time
::date('Y-m-d H:i:s');
1398 $membershipParams = array_merge($params, $membershipTypeValues[$lineItemValues['membership_type_id']]);
1400 if (!empty($softParams)) {
1401 $membershipParams['soft_credit'] = $softParams;
1403 unset($membershipParams['contribution_status_id']);
1404 $membershipParams['skipLineItem'] = TRUE;
1405 unset($membershipParams['lineItems']);
1406 // @todo stop passing $ids (membership and userId only are set above)
1407 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1408 $lineItem[$this->_priceSetId
][$id]['entity_id'] = $membership->id
;
1409 $lineItem[$this->_priceSetId
][$id]['entity_table'] = 'civicrm_membership';
1411 $this->_membershipIDs
[] = $membership->id
;
1412 $createdMemberships[$membership->membership_type_id
] = $membership;
1414 $params['lineItems'] = $lineItem;
1415 if (!empty($formValues['record_contribution'])) {
1416 CRM_Member_BAO_Membership
::recordMembershipContribution($params);
1419 $isRecur = $params['is_recur'] ??
NULL;
1420 if (($this->_action
& CRM_Core_Action
::UPDATE
)) {
1421 $this->addStatusMessage($this->getStatusMessageForUpdate($membership, $endDate));
1423 elseif (($this->_action
& CRM_Core_Action
::ADD
)) {
1424 $this->addStatusMessage($this->getStatusMessageForCreate($endDate, $createdMemberships,
1425 $isRecur, $calcDates));
1428 // This would always be true as we always add price set id into both
1429 // quick config & non quick config price sets.
1430 if (!empty($lineItem[$this->_priceSetId
])) {
1431 $invoicing = Civi
::settings()->get('invoicing');
1433 $totalTaxAmount = 0;
1434 foreach ($lineItem[$this->_priceSetId
] as & $priceFieldOp) {
1435 if (!empty($priceFieldOp['membership_type_id'])) {
1436 $priceFieldOp['start_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date'] ? CRM_Utils_Date
::formatDateOnlyLong($membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date']) : '-';
1437 $priceFieldOp['end_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date'] ? CRM_Utils_Date
::formatDateOnlyLong($membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date']) : '-';
1440 $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1442 if ($invoicing && isset($priceFieldOp['tax_amount'])) {
1444 $totalTaxAmount +
= $priceFieldOp['tax_amount'];
1449 foreach ($lineItem[$this->_priceSetId
] as $key => $value) {
1450 if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
1451 if (isset($dataArray[$value['tax_rate']])) {
1452 $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $value);
1455 $dataArray[$value['tax_rate']] = $value['tax_amount'] ??
NULL;
1460 $this->assign('totalTaxAmount', $totalTaxAmount);
1461 // Not sure why would need this on Submit.... unless it's being used when sending mails in which case this is the wrong place
1462 $this->assign('taxTerm', $this->getSalesTaxTerm());
1464 $this->assign('dataArray', $dataArray);
1467 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1469 $receiptSend = FALSE;
1470 $contributionId = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
);
1471 $membershipIds = $this->_membershipIDs
;
1472 if ($contributionId && !empty($membershipIds)) {
1473 $contributionDetails = CRM_Contribute_BAO_Contribution
::getContributionDetails(
1474 CRM_Export_Form_Select
::MEMBER_EXPORT
, $this->_membershipIDs
);
1475 if ($contributionDetails[$membership->id
]['contribution_status'] === 'Completed') {
1476 $receiptSend = TRUE;
1480 $receiptSent = FALSE;
1481 if ($this->getSubmittedValue('send_receipt') && $receiptSend) {
1482 $formValues['contact_id'] = $this->_contactID
;
1483 $formValues['contribution_id'] = $contributionId;
1484 // We really don't need a distinct receipt_text_signup vs receipt_text_renewal as they are
1485 // handled in the receipt. But by setting one we avoid breaking templates for now
1486 // although at some point we should switch in the templates.
1487 $formValues['receipt_text_signup'] = $formValues['receipt_text'];
1488 // send email receipt
1489 $this->assignBillingName();
1490 $mailSend = $this->emailMembershipReceipt($formValues, $membership);
1491 $receiptSent = TRUE;
1494 // finally set membership id if already not set
1496 $this->_id
= $membership->id
;
1499 $this->updateContributionOnMembershipTypeChange($params, $membership);
1500 if ($receiptSent && $mailSend) {
1501 $this->addStatusMessage(ts('A membership confirmation and receipt has been sent to %1.', [1 => $this->_contributorEmail
]));
1504 CRM_Core_Session
::setStatus($this->getStatusMessage(), ts('Complete'), 'success');
1505 $this->setStatusMessage($membership);
1509 * Update related contribution of a membership if update_contribution_on_membership_type_change
1510 * contribution setting is enabled and type is changed on edit
1512 * @param array $inputParams
1513 * submitted form values
1514 * @param CRM_Member_DAO_Membership $membership
1515 * Updated membership object
1517 * @throws \CRM_Core_Exception
1518 * @throws \CiviCRM_API3_Exception
1520 protected function updateContributionOnMembershipTypeChange($inputParams, $membership) {
1521 if (Civi
::settings()->get('update_contribution_on_membership_type_change') &&
1523 ($this->_action
& CRM_Core_Action
::UPDATE
) &&
1526 // if selected membership doesn't match with earlier membership
1527 !in_array($this->_memType
, $this->_memTypeSelected
)
1529 if (!empty($inputParams['is_recur'])) {
1530 CRM_Core_Session
::setStatus(ts('Associated recurring contribution cannot be updated on membership type change.', ts('Error'), 'error'));
1534 // fetch lineitems by updated membership ID
1535 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($membership->id
, 'membership');
1536 // retrieve the related contribution ID
1537 $contributionID = CRM_Core_DAO
::getFieldValue(
1538 'CRM_Member_DAO_MembershipPayment',
1543 // get price fields of chosen price-set
1544 $priceSetDetails = CRM_Utils_Array
::value(
1546 CRM_Price_BAO_PriceSet
::getSetDetail(
1553 // add price field information in $inputParams
1554 self
::addPriceFieldByMembershipType($inputParams, $priceSetDetails['fields'], $membership->membership_type_id
);
1556 // update related contribution and financial records
1557 CRM_Price_BAO_LineItem
::changeFeeSelections(
1562 $priceSetDetails['fields'],
1565 CRM_Core_Session
::setStatus(ts('Associated contribution is updated on membership type change.'), ts('Success'), 'success');
1570 * Add selected price field information in $formValues
1572 * @param array $formValues
1573 * submitted form values
1574 * @param array $priceFields
1575 * Price fields of selected Priceset ID
1576 * @param int $membershipTypeID
1577 * Selected membership type ID
1580 public static function addPriceFieldByMembershipType(&$formValues, $priceFields, $membershipTypeID) {
1581 foreach ($priceFields as $priceFieldID => $priceField) {
1582 if (isset($priceField['options']) && count($priceField['options'])) {
1583 foreach ($priceField['options'] as $option) {
1584 if ($option['membership_type_id'] == $membershipTypeID) {
1585 $formValues["price_{$priceFieldID}"] = $option['id'];
1594 * Set context in session.
1596 protected function setUserContext() {
1597 $buttonName = $this->controller
->getButtonName();
1598 $session = CRM_Core_Session
::singleton();
1600 if ($buttonName == $this->getButtonName('upload', 'new')) {
1601 if ($this->_context
=== 'standalone') {
1602 $url = CRM_Utils_System
::url('civicrm/member/add',
1603 'reset=1&action=add&context=standalone'
1607 $url = CRM_Utils_System
::url('civicrm/contact/view/membership',
1608 "reset=1&action=add&context=membership&cid={$this->_contactID}"
1613 $url = CRM_Utils_System
::url('civicrm/contact/view',
1614 "reset=1&cid={$this->_contactID}&selectedChild=member"
1617 $session->replaceUserContext($url);
1621 * Get status message for updating membership.
1623 * @param CRM_Member_BAO_Membership $membership
1624 * @param string $endDate
1628 protected function getStatusMessageForUpdate($membership, $endDate) {
1629 // End date can be modified by hooks, so if end date is set then use it.
1630 $endDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1632 $statusMsg = ts('Membership for %1 has been updated.', [1 => $this->_memberDisplayName
]);
1633 if ($endDate && $endDate !== 'null') {
1634 $endDate = CRM_Utils_Date
::customFormat($endDate);
1635 $statusMsg .= ' ' . ts('The membership End Date is %1.', [1 => $endDate]);
1641 * Get status message for create action.
1643 * @param string $endDate
1644 * @param array $createdMemberships
1645 * @param bool $isRecur
1646 * @param array $calcDates
1648 * @return array|string
1650 protected function getStatusMessageForCreate($endDate, $createdMemberships,
1651 $isRecur, $calcDates) {
1652 // FIX ME: fix status messages
1655 foreach ($this->_memTypeSelected
as $membershipTypeID) {
1656 $statusMsg[$membershipTypeID] = ts('%1 membership for %2 has been added.', [
1657 1 => $this->allMembershipTypeDetails
[$membershipTypeID]['name'],
1658 2 => $this->_memberDisplayName
,
1661 $membership = $createdMemberships[$membershipTypeID];
1662 $memEndDate = $membership->end_date ?
: $endDate;
1664 //get the end date from calculated dates.
1665 if (!$memEndDate && !$isRecur) {
1666 $memEndDate = $calcDates[$membershipTypeID]['end_date'] ??
NULL;
1669 if ($memEndDate && $memEndDate !== 'null') {
1670 $memEndDate = CRM_Utils_Date
::formatDateOnlyLong($memEndDate);
1671 $statusMsg[$membershipTypeID] .= ' ' . ts('The new membership End Date is %1.', [1 => $memEndDate]);
1674 $statusMsg = implode('<br/>', $statusMsg);
1679 * @param $membership
1681 protected function setStatusMessage($membership) {
1683 // display message when membership type is changed
1684 if (($this->_action
& CRM_Core_Action
::UPDATE
) && $this->_id
&& !in_array($this->_memType
, $this->_memTypeSelected
)) {
1685 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->_id
, 'membership');
1686 $maxID = max(array_keys($lineItem));
1687 $lineItem = $lineItem[$maxID];
1688 $membershipTypeDetails = $this->allMembershipTypeDetails
[$membership->membership_type_id
];
1689 if ($membershipTypeDetails['financial_type_id'] != $lineItem['financial_type_id']) {
1690 CRM_Core_Session
::setStatus(
1691 ts('The financial types associated with the old and new membership types are different. You may want to edit the contribution associated with this membership to adjust its financial type.'),
1695 if ($membershipTypeDetails['minimum_fee'] != $lineItem['line_total']) {
1696 CRM_Core_Session
::setStatus(
1697 ts('The cost of the old and new membership types are different. You may want to edit the contribution associated with this membership to adjust its amount.'),
1706 * @throws \CRM_Core_Exception
1708 protected function isUpdateToExistingRecurringMembership() {
1710 if ($this->_action
& CRM_Core_Action
::UPDATE
1711 && CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->getEntityId(),
1712 'contribution_recur_id')
1713 && !CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->getEntityId())) {
1721 * Send a receipt for the membership.
1723 * @param array $formValues
1724 * @param \CRM_Member_BAO_Membership $membership
1727 * @throws \CRM_Core_Exception
1729 protected function emailMembershipReceipt($formValues, $membership) {
1730 $customValues = $this->getCustomValuesForReceipt($formValues, $membership);
1731 $this->assign('customValues', $customValues);
1734 // @todo move this outside shared code as Batch entry just doesn't
1735 $this->assign('address', CRM_Utils_Address
::getFormattedBillingAddressFieldsFromParameters(
1740 $valuesForForm = CRM_Contribute_Form_AbstractEditPayment
::formatCreditCardDetails($this->_params
);
1741 $this->assignVariables($valuesForForm, ['credit_card_exp_date', 'credit_card_type', 'credit_card_number']);
1742 $this->assign('is_pay_later', 0);
1743 $this->assign('isPrimary', 1);
1745 return self
::emailReceipt($this, $formValues, $membership);
1749 * Filter the custom values from the input parameters (for display in the email).
1751 * @todo figure out why the scary code this calls does & document.
1753 * @param array $formValues
1754 * @param \CRM_Member_BAO_Membership $membership
1757 protected function getCustomValuesForReceipt($formValues, $membership) {
1758 $customFields = $customValues = [];
1759 if (property_exists($this, '_groupTree')
1760 && !empty($this->_groupTree
)
1762 foreach ($this->_groupTree
as $groupID => $group) {
1763 if ($groupID === 'info') {
1766 foreach ($group['fields'] as $k => $field) {
1767 $field['title'] = $field['label'];
1768 $customFields["custom_{$k}"] = $field;
1773 $members = [['member_id', '=', $membership->id
, 0, 0]];
1774 // check whether its a test drive
1775 if ($this->_mode
=== 'test') {
1776 $members[] = ['member_test', '=', 1, 0, 0];
1779 CRM_Core_BAO_UFGroup
::getValues($formValues['contact_id'], $customFields, $customValues, FALSE, $members);
1780 return $customValues;
1784 * Get the selected memberships as a string of labels.
1788 protected function getSelectedMembershipLabels(): string {
1790 foreach ($this->_memTypeSelected
as $membershipTypeID) {
1791 $return[] = $this->allMembershipTypeDetails
[$membershipTypeID]['name'];
1793 return implode(', ', $return);
1797 * Legacy contribution processing function.
1799 * This is copied from a shared function in order to clean it up. Most of the
1800 * stuff in it, maybe all except the ContributionRecur create is
1801 * not applicable to this form & can be removed in follow up cleanup.
1803 * It's like the contribution create being done here is actively bad and
1804 * being fixed later.
1806 * @param array $params
1807 * @param array $contributionParams
1808 * Parameters to be passed to contribution create action.
1809 * This differs from params in that we are currently adding params to it and 1) ensuring they are being
1810 * passed consistently & 2) documenting them here.
1818 * @return \CRM_Contribute_DAO_Contribution
1820 * @throws \CRM_Core_Exception
1821 * @throws \CiviCRM_API3_Exception
1823 protected function processContribution(
1828 $transaction = new CRM_Core_Transaction();
1829 $contactID = $contributionParams['contact_id'];
1831 // add these values for the recurringContrib function ,CRM-10188
1832 $params['financial_type_id'] = $this->getFinancialTypeID();
1833 $params['is_recur'] = TRUE;
1834 $params['payment_instrument_id'] = $contributionParams['payment_instrument_id'] ??
NULL;
1835 $recurringContributionID = $this->legacyProcessRecurringContribution($params, $contactID);
1837 if ($this->getSubmittedValue('send_receipt')) {
1838 $contributionParams +
= [
1839 'receipt_date' => CRM_Utils_Time
::date('YmdHis'),
1843 if ($recurringContributionID) {
1844 $contributionParams['contribution_recur_id'] = $recurringContributionID;
1847 $contributionParams['contribution_status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
1849 // @todo this is the wrong place for this - it should be done as close to form submission
1851 $contributionParams['total_amount'] = $params['amount'];
1852 $contribution = CRM_Contribute_BAO_Contribution
::add($contributionParams);
1854 // lets store it in the form variable so postProcess hook can get to this and use it
1855 $form->_contributionID
= $contribution->id
;
1857 $transaction->commit();
1858 return $contribution;
1862 * Create the recurring contribution record.
1864 * This function was copied from another form & needs cleanup.
1866 * @param array $params
1867 * @param int $contactID
1871 protected function legacyProcessRecurringContribution(array $params, $contactID): int {
1873 $recurParams = ['contact_id' => $contactID];
1874 $recurParams['amount'] = $params['amount'] ??
NULL;
1875 $recurParams['auto_renew'] = $params['auto_renew'] ??
NULL;
1876 $recurParams['frequency_unit'] = $params['frequency_unit'] ??
NULL;
1877 $recurParams['frequency_interval'] = $params['frequency_interval'] ??
NULL;
1878 $recurParams['installments'] = $params['installments'] ??
NULL;
1879 $recurParams['financial_type_id'] = $this->getFinancialTypeID();
1880 $recurParams['currency'] = $params['currency'] ??
NULL;
1881 $recurParams['payment_instrument_id'] = $params['payment_instrument_id'];
1883 $recurParams['is_test'] = $this->isTest();
1885 $recurParams['start_date'] = $recurParams['create_date'] = $recurParams['modified_date'] = CRM_Utils_Time
::date('YmdHis');
1886 if (!empty($params['receive_date'])) {
1887 $recurParams['start_date'] = date('YmdHis', CRM_Utils_Time
::strtotime($params['receive_date']));
1889 $recurParams['invoice_id'] = $this->getInvoiceID();
1890 $recurParams['contribution_status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
1891 $recurParams['payment_processor_id'] = $params['payment_processor_id'] ??
NULL;
1892 $recurParams['is_email_receipt'] = (bool) $this->getSubmittedValue('send_receipt');
1893 // we need to add a unique trxn_id to avoid a unique key error
1894 // in paypal IPN we reset this when paypal sends us the real trxn id, CRM-2991
1895 $recurParams['trxn_id'] = $params['trxn_id'] ??
$this->getInvoiceID();
1897 $campaignId = $params['campaign_id'] ??
$this->_values
['campaign_id'] ??
NULL;
1898 $recurParams['campaign_id'] = $campaignId;
1899 return CRM_Contribute_BAO_ContributionRecur
::add($recurParams)->id
;
1903 * Is the form being submitted in test mode.
1907 protected function isTest(): int {
1908 return ($this->_mode
=== 'test') ?
TRUE : FALSE;
1912 * Get the financial type id relevant to the contribution.
1914 * Financial type id is optional when price sets are in use.
1915 * Otherwise they are required for the form to submit.
1919 protected function getFinancialTypeID(): int {
1920 return (int) $this->getSubmittedValue('financial_type_id') ?
: $this->order
->getFinancialTypeID();