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;
25 protected $_onlinePendingContributionId;
29 public $_contributeMode = 'direct';
31 protected $_recurMembershipTypes;
33 protected $_memTypeSelected;
36 * Display name of the member.
40 protected $_memberDisplayName = NULL;
43 * email of the person paying for the membership (used for receipts)
46 protected $_memberEmail = NULL;
49 * Contact ID of the member.
53 public $_contactID = NULL;
56 * Display name of the person paying for the membership (used for receipts)
60 protected $_contributorDisplayName = NULL;
63 * email of the person paying for the membership (used for receipts)
66 protected $_contributorEmail = NULL;
69 * email of the person paying for the membership (used for receipts)
73 protected $_contributorContactID = NULL;
76 * ID of the person the receipt is to go to.
80 protected $_receiptContactId = NULL;
83 * Keep a class variable for ALL membership IDs so
84 * postProcess hook function can do something with it
88 protected $_membershipIDs = [];
91 * Set entity fields to be assigned to the form.
93 protected function setEntityFields() {
94 $this->entityFields
= [
96 'name' => 'join_date',
97 'description' => ts('Member Since'),
100 'name' => 'start_date',
101 'description' => ts('Start Date'),
104 'name' => 'end_date',
105 'description' => ts('End Date'),
111 * Set the delete message.
113 * We do this from the constructor in order to do a translation.
115 public function setDeleteMessage() {
116 $this->deleteMessage
= '<span class="font-red bold">'
117 . ts("WARNING: Deleting this membership will also delete any related payment (contribution) records." . ts("This action cannot be undone.")
119 . 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.")
121 . ts("Click 'Delete' if you want to continue.") . '</p>');
125 * Overriding this entity trait function as not yet tested.
127 * We continue to rely on legacy handling.
129 public function addCustomDataToForm() {}
132 * Overriding this entity trait function as not yet tested.
134 * We continue to rely on legacy handling.
136 public function addFormButtons() {}
139 * Get selected membership type from the form values.
141 * @param array $priceSet
142 * @param array $params
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 public function preProcess() {
195 // This string makes up part of the class names, differentiating them (not sure why) from the membership fields.
196 $this->assign('formClass', 'membership');
197 parent
::preProcess();
200 $this->_priceSetId
= CRM_Utils_Array
::value('priceSetId', $_GET);
201 $this->set('priceSetId', $this->_priceSetId
);
202 $this->assign('priceSetId', $this->_priceSetId
);
204 if ($this->_action
& CRM_Core_Action
::DELETE
) {
205 $contributionID = CRM_Member_BAO_Membership
::getMembershipContributionId($this->_id
);
206 // check delete permission for contribution
207 if ($this->_id
&& $contributionID && !CRM_Core_Permission
::checkActionPermission('CiviContribute', $this->_action
)) {
208 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."));
212 if ($this->_action
& CRM_Core_Action
::ADD
) {
213 if ($this->_contactID
) {
214 //check whether contact has a current membership so we can alert user that they may want to do a renewal instead
215 $contactMemberships = [];
216 $memParams = ['contact_id' => $this->_contactID
];
217 CRM_Member_BAO_Membership
::getValues($memParams, $contactMemberships, TRUE);
219 foreach ($contactMemberships as $mem) {
220 $cMemTypes[] = $mem['membership_type_id'];
222 if (count($cMemTypes) > 0) {
223 $memberorgs = CRM_Member_BAO_MembershipType
::getMemberOfContactByMemTypes($cMemTypes);
225 foreach ($contactMemberships as $mem) {
226 $mem['member_of_contact_id'] = CRM_Utils_Array
::value($mem['membership_type_id'], $memberorgs);
227 if (!empty($mem['membership_end_date'])) {
228 $mem['membership_end_date'] = CRM_Utils_Date
::customFormat($mem['membership_end_date']);
230 $mem['membership_type'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
231 $mem['membership_type_id'],
234 $mem['membership_status'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
238 $mem['renewUrl'] = CRM_Utils_System
::url('civicrm/contact/view/membership',
239 "reset=1&action=renew&cid={$this->_contactID}&id={$mem['id']}&context=membership&selectedChild=member"
240 . ($this->_mode ?
'&mode=live' : '')
242 $mem['membershipTab'] = CRM_Utils_System
::url('civicrm/contact/view',
243 "reset=1&force=1&cid={$this->_contactID}&selectedChild=member"
245 $mems_by_org[$mem['member_of_contact_id']] = $mem;
247 $this->assign('existingContactMemberships', $mems_by_org);
251 // In standalone mode we don't have a contact id yet so lookup will be done client-side with this script:
252 $resources = CRM_Core_Resources
::singleton();
253 $resources->addScriptFile('civicrm', 'templates/CRM/Member/Form/MembershipStandalone.js');
255 'typeorgs' => CRM_Member_BAO_MembershipType
::getMembershipTypeOrganization(),
256 'memtypes' => CRM_Core_PseudoConstant
::get('CRM_Member_BAO_Membership', 'membership_type_id'),
257 'statuses' => CRM_Core_PseudoConstant
::get('CRM_Member_BAO_Membership', 'status_id'),
259 $resources->addSetting(['existingMems' => $passthru]);
263 if (!$this->_memType
) {
264 $params = CRM_Utils_Request
::exportValues();
265 if (!empty($params['membership_type_id'][1])) {
266 $this->_memType
= $params['membership_type_id'][1];
270 // Add custom data to form
271 CRM_Custom_Form_CustomData
::addToForm($this, $this->_memType
);
273 // CRM-4395, get the online pending contribution id.
274 $this->_onlinePendingContributionId
= NULL;
275 if (!$this->_mode
&& $this->_id
&& ($this->_action
& CRM_Core_Action
::UPDATE
)) {
276 $this->_onlinePendingContributionId
= CRM_Contribute_BAO_Contribution
::checkOnlinePendingContribution($this->_id
,
280 $this->assign('onlinePendingContributionId', $this->_onlinePendingContributionId
);
282 $this->setPageTitle(ts('Membership'));
286 * Set default values for the form.
288 public function setDefaultValues() {
290 if ($this->_priceSetId
) {
291 return CRM_Price_BAO_PriceSet
::setDefaultPriceSet($this, $defaults);
294 $defaults = parent
::setDefaultValues();
296 //setting default join date and receive date
297 if ($this->_action
== CRM_Core_Action
::ADD
) {
298 $defaults['receive_date'] = date('Y-m-d H:i:s');
301 $defaults['num_terms'] = 1;
303 if (!empty($defaults['id'])) {
304 if ($this->_onlinePendingContributionId
) {
305 $defaults['record_contribution'] = $this->_onlinePendingContributionId
;
308 $contributionId = CRM_Core_DAO
::singleValueQuery("
309 SELECT contribution_id
310 FROM civicrm_membership_payment
311 WHERE membership_id = $this->_id
312 ORDER BY contribution_id
315 if ($contributionId) {
316 $defaults['record_contribution'] = $contributionId;
321 if ($this->_contactID
) {
322 $defaults['contact_id'] = $this->_contactID
;
326 //set Soft Credit Type to Gift by default
327 $scTypes = CRM_Core_OptionGroup
::values("soft_credit_type");
328 $defaults['soft_credit_type_id'] = CRM_Utils_Array
::value(ts('Gift'), array_flip($scTypes));
330 if (!empty($defaults['record_contribution']) && !$this->_mode
) {
331 $contributionParams = ['id' => $defaults['record_contribution']];
332 $contributionIds = [];
334 //keep main object campaign in hand.
335 $memberCampaignId = CRM_Utils_Array
::value('campaign_id', $defaults);
337 CRM_Contribute_BAO_Contribution
::getValues($contributionParams, $defaults, $contributionIds);
339 //get back original object campaign id.
340 $defaults['campaign_id'] = $memberCampaignId;
342 // Contribution::getValues() over-writes the membership record's source field value - so we need to restore it.
343 if (!empty($defaults['membership_source'])) {
344 $defaults['source'] = $defaults['membership_source'];
348 if (empty($defaults['payment_instrument_id'])) {
349 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
352 // User must explicitly choose to send a receipt in both add and update mode.
353 $defaults['send_receipt'] = 0;
355 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
356 // in this mode by default uncheck this checkbox
357 unset($defaults['record_contribution']);
360 $subscriptionCancelled = FALSE;
361 if (!empty($defaults['id'])) {
362 $subscriptionCancelled = CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->_id
);
365 $alreadyAutoRenew = FALSE;
366 if (!empty($defaults['contribution_recur_id']) && !$subscriptionCancelled) {
367 $defaults['auto_renew'] = 1;
368 $alreadyAutoRenew = TRUE;
370 $this->assign('alreadyAutoRenew', $alreadyAutoRenew);
372 $this->assign('member_is_test', CRM_Utils_Array
::value('member_is_test', $defaults));
374 $this->assign('membership_status_id', CRM_Utils_Array
::value('status_id', $defaults));
376 if (!empty($defaults['is_pay_later'])) {
377 $this->assign('is_pay_later', TRUE);
380 $defaults = $this->getBillingDefaults($defaults);
381 // hack to simplify credit card entry for testing
382 // $defaults['credit_card_type'] = 'Visa';
383 // $defaults['credit_card_number'] = '4807731747657838';
384 // $defaults['cvv2'] = '000';
385 // $defaults['credit_card_exp_date'] = array( 'Y' => '2012', 'M' => '05' );
388 //setting default join date if there is no join date
389 if (empty($defaults['join_date'])) {
390 $defaults['join_date'] = date('Y-m-d');
393 if (!empty($defaults['membership_end_date'])) {
394 $this->assign('endDate', $defaults['membership_end_date']);
401 * Build the form object.
403 public function buildQuickForm() {
405 $this->buildQuickEntityForm();
406 $this->assign('currency', CRM_Core_BAO_Country
::defaultCurrencySymbol());
407 $isUpdateToExistingRecurringMembership = $this->isUpdateToExistingRecurringMembership();
408 // build price set form.
409 $buildPriceSet = FALSE;
410 if ($this->_priceSetId ||
!empty($_POST['price_set_id'])) {
411 if (!empty($_POST['price_set_id'])) {
412 $buildPriceSet = TRUE;
414 $getOnlyPriceSetElements = TRUE;
415 if (!$this->_priceSetId
) {
416 $this->_priceSetId
= $_POST['price_set_id'];
417 $getOnlyPriceSetElements = FALSE;
420 $this->set('priceSetId', $this->_priceSetId
);
421 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
423 $optionsMembershipTypes = [];
424 foreach ($this->_priceSet
['fields'] as $pField) {
425 if (empty($pField['options'])) {
428 foreach ($pField['options'] as $opId => $opValues) {
429 $optionsMembershipTypes[$opId] = CRM_Utils_Array
::value('membership_type_id', $opValues, 0);
433 $this->assign('autoRenewOption', CRM_Price_BAO_PriceSet
::checkAutoRenewForPriceSet($this->_priceSetId
));
435 $this->assign('optionsMembershipTypes', $optionsMembershipTypes);
436 $this->assign('contributionType', CRM_Utils_Array
::value('financial_type_id', $this->_priceSet
));
438 // get only price set form elements.
439 if ($getOnlyPriceSetElements) {
444 // use to build form during form rule.
445 $this->assign('buildPriceSet', $buildPriceSet);
447 if ($this->_action
& CRM_Core_Action
::ADD
) {
448 $buildPriceSet = FALSE;
449 $priceSets = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviMember');
450 if (!empty($priceSets)) {
451 $buildPriceSet = TRUE;
454 if ($buildPriceSet) {
455 $this->add('select', 'price_set_id', ts('Choose price set'),
457 '' => ts('Choose price set'),
459 NULL, ['onchange' => "buildAmount( this.value );"]
462 $this->assign('hasPriceSets', $buildPriceSet);
465 if ($this->_action
& CRM_Core_Action
::DELETE
) {
469 'name' => ts('Delete'),
470 'spacing' => ' ',
475 'name' => ts('Cancel'),
481 $contactField = $this->addEntityRef('contact_id', ts('Member'), ['create' => TRUE, 'api' => ['extra' => ['email']]], TRUE);
482 if ($this->_context
!= 'standalone') {
483 $contactField->freeze();
486 $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
488 // Throw status bounce when no Membership type or priceset is present
489 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()
490 && empty($this->allMembershipTypeDetails
) && empty($priceSets)
492 CRM_Core_Error
::statusBounce(ts('You do not have all the permissions needed for this page.'));
494 // retrieve all memberships
495 $allMembershipInfo = [];
496 foreach ($this->allMembershipTypeDetails
as $key => $values) {
497 if ($this->_mode
&& empty($values['minimum_fee'])) {
501 $memberOfContactId = CRM_Utils_Array
::value('member_of_contact_id', $values);
502 if (empty($selMemTypeOrg[$memberOfContactId])) {
503 $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
509 $selOrgMemType[$memberOfContactId][0] = ts('- select -');
511 if (empty($selOrgMemType[$memberOfContactId][$key])) {
512 $selOrgMemType[$memberOfContactId][$key] = CRM_Utils_Array
::value('name', $values);
515 $totalAmount = CRM_Utils_Array
::value('minimum_fee', $values);
516 //CRM-18827 - override the default value if total_amount is submitted
517 if (!empty($this->_submitValues
['total_amount'])) {
518 $totalAmount = $this->_submitValues
['total_amount'];
520 // build membership info array, which is used when membership type is selected to:
521 // - set the payment information block
522 // - set the max related block
523 $allMembershipInfo[$key] = [
524 'financial_type_id' => CRM_Utils_Array
::value('financial_type_id', $values),
525 'total_amount' => CRM_Utils_Money
::format($totalAmount, NULL, '%a'),
526 'total_amount_numeric' => $totalAmount,
527 'auto_renew' => CRM_Utils_Array
::value('auto_renew', $values),
528 'has_related' => isset($values['relationship_type_id']),
529 'max_related' => CRM_Utils_Array
::value('max_related', $values),
533 $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
535 // show organization by default, if only one organization in
537 if (count($selMemTypeOrg) == 2) {
538 unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
540 //sort membership organization and type, CRM-6099
541 natcasesort($selMemTypeOrg);
542 foreach ($selOrgMemType as $index => $orgMembershipType) {
543 natcasesort($orgMembershipType);
544 $selOrgMemType[$index] = $orgMembershipType;
548 'onChange' => "buildMaxRelated(this.value,true); CRM.buildCustomData('Membership', this.value);",
551 if (!empty($this->_recurPaymentProcessors
)) {
552 $memTypeJs['onChange'] = "" . $memTypeJs['onChange'] . " buildAutoRenew(this.value, null, '{$this->_mode}');";
555 $this->add('text', 'max_related', ts('Max related'),
556 CRM_Core_DAO
::getAttribute('CRM_Member_DAO_Membership', 'max_related')
559 $sel = &$this->addElement('hierselect',
560 'membership_type_id',
561 ts('Membership Organization and Type'),
565 $sel->setOptions([$selMemTypeOrg, $selOrgMemType]);
566 if ($isUpdateToExistingRecurringMembership) {
570 if ($this->_action
& CRM_Core_Action
::ADD
) {
571 $this->add('number', 'num_terms', ts('Number of Terms'), ['size' => 6]);
574 $this->add('text', 'source', ts('Source'),
575 CRM_Core_DAO
::getAttribute('CRM_Member_DAO_Membership', 'source')
578 //CRM-7362 --add campaigns.
581 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'campaign_id');
583 CRM_Campaign_BAO_Campaign
::addCampaign($this, $campaignId);
586 $this->add('select', 'status_id', ts('Membership Status'),
587 ['' => ts('- select -')] + CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label')
590 $statusOverride = $this->addElement('select', 'is_override', ts('Status Override?'),
591 CRM_Member_StatusOverrideTypes
::getSelectOptions()
593 if ($statusOverride && $isUpdateToExistingRecurringMembership) {
594 $statusOverride->freeze();
597 $this->add('datepicker', 'status_override_end_date', ts('Status Override End Date'), '', FALSE, ['minDate' => time(), 'time' => FALSE]);
599 $this->addElement('checkbox', 'record_contribution', ts('Record Membership Payment?'));
601 $this->add('text', 'total_amount', ts('Amount'));
602 $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
604 $this->add('datepicker', 'receive_date', ts('Received'), [], FALSE, ['time' => TRUE]);
606 $this->add('select', 'payment_instrument_id',
607 ts('Payment Method'),
608 ['' => ts('- select -')] + CRM_Contribute_PseudoConstant
::paymentInstrument(),
609 FALSE, ['onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);"]
611 $this->add('text', 'trxn_id', ts('Transaction ID'));
612 $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
614 'CRM_Contribute_DAO_Contribution',
620 $this->add('select', 'contribution_status_id',
621 ts('Payment Status'), CRM_Contribute_BAO_Contribution_Utils
::getContributionStatuses('membership')
623 $this->add('text', 'check_number', ts('Check Number'),
624 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
628 //add field for amount to allow an amount to be entered that differs from minimum
629 $this->add('text', 'total_amount', ts('Amount'));
631 $this->add('select', 'financial_type_id',
632 ts('Financial Type'),
633 ['' => ts('- select -')] + CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes, $this->_action
)
636 $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different Contact?'));
638 $this->addSelect('soft_credit_type_id', ['entity' => 'contribution_soft']);
639 $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), ['create' => TRUE]);
641 $this->addElement('checkbox',
643 ts('Send Confirmation and Receipt?'), NULL,
644 ['onclick' => "showEmailOptions()"]
647 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
649 $this->add('textarea', 'receipt_text', ts('Receipt Message'));
651 // Retrieve the name and email of the contact - this will be the TO for receipt email
652 if ($this->_contactID
) {
653 list($this->_memberDisplayName
,
655 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
657 $this->assign('emailExists', $this->_memberEmail
);
658 $this->assign('displayName', $this->_memberDisplayName
);
661 if ($isUpdateToExistingRecurringMembership && CRM_Member_BAO_Membership
::isCancelSubscriptionSupported($this->_id
)) {
662 $this->assign('cancelAutoRenew',
663 CRM_Utils_System
::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
667 $this->assign('isRecur', $isUpdateToExistingRecurringMembership);
669 $this->addFormRule(['CRM_Member_Form_Membership', 'formRule'], $this);
670 $mailingInfo = Civi
::settings()->get('mailing_backend');
671 $this->assign('isEmailEnabledForSite', ($mailingInfo['outBound_option'] != 2));
673 parent
::buildQuickForm();
679 * @param array $params
680 * (ref.) an assoc array of name/value pairs.
682 * @param array $files
683 * @param CRM_Member_Form_Membership $self
685 * @throws CiviCRM_API3_Exception
687 * mixed true or array of errors
689 public static function formRule($params, $files, $self) {
692 $priceSetId = self
::getPriceSetID($params);
693 $priceSetDetails = self
::getPriceSetDetails($params);
695 $selectedMemberships = self
::getSelectedMemberships($priceSetDetails[$priceSetId], $params);
697 if (!empty($params['price_set_id'])) {
698 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $params, $errors);
700 $priceFieldIDS = self
::getPriceFieldIDs($params, $priceSetDetails[$priceSetId]);
702 if (!empty($priceFieldIDS)) {
703 $ids = implode(',', $priceFieldIDS);
705 $count = CRM_Price_BAO_PriceSet
::getMembershipCount($ids);
706 foreach ($count as $occurrence) {
707 if ($occurrence > 1) {
708 $errors['_qf_default'] = ts('Select at most one option associated with the same membership type.');
712 // Return error if empty $self->_memTypeSelected
713 if (empty($errors) && empty($selectedMemberships)) {
714 $errors['_qf_default'] = ts('Select at least one membership option.');
716 if (!$self->_mode
&& empty($params['record_contribution'])) {
717 $errors['record_contribution'] = ts('Record Membership Payment is required when you use a price set.');
721 if (empty($params['membership_type_id'][1])) {
722 $errors['membership_type_id'] = ts('Please select a membership type.');
724 $numterms = CRM_Utils_Array
::value('num_terms', $params);
725 if ($numterms && intval($numterms) != $numterms) {
726 $errors['num_terms'] = ts('Please enter an integer for the number of terms.');
729 if (($self->_mode ||
isset($params['record_contribution'])) && empty($params['financial_type_id'])) {
730 $errors['financial_type_id'] = ts('Please enter the financial Type.');
734 if (!empty($errors) && (count($selectedMemberships) > 1)) {
735 $memberOfContacts = CRM_Member_BAO_MembershipType
::getMemberOfContactByMemTypes($selectedMemberships);
736 $duplicateMemberOfContacts = array_count_values($memberOfContacts);
737 foreach ($duplicateMemberOfContacts as $countDuplicate) {
738 if ($countDuplicate > 1) {
739 $errors['_qf_default'] = ts('Please do not select more than one membership associated with the same organization.');
744 if (!empty($errors)) {
748 if (!empty($params['record_contribution']) && empty($params['payment_instrument_id'])) {
749 $errors['payment_instrument_id'] = ts('Payment Method is a required field.');
752 if (!empty($params['is_different_contribution_contact'])) {
753 if (empty($params['soft_credit_type_id'])) {
754 $errors['soft_credit_type_id'] = ts('Please Select a Soft Credit Type');
756 if (empty($params['soft_credit_contact_id'])) {
757 $errors['soft_credit_contact_id'] = ts('Please select a contact');
761 if (!empty($params['payment_processor_id'])) {
762 // validate payment instrument (e.g. credit card number)
763 CRM_Core_Payment_Form
::validatePaymentInstrument($params['payment_processor_id'], $params, $errors, NULL);
767 if (!empty($params['join_date'])) {
769 $joinDate = CRM_Utils_Date
::processDate($params['join_date']);
771 foreach ($selectedMemberships as $memType) {
773 if (!empty($params['start_date'])) {
774 $startDate = CRM_Utils_Date
::processDate($params['start_date']);
777 // if end date is set, ensure that start date is also set
778 // and that end date is later than start date
780 if (!empty($params['end_date'])) {
781 $endDate = CRM_Utils_Date
::processDate($params['end_date']);
784 $membershipDetails = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($memType);
786 if ($startDate && CRM_Utils_Array
::value('period_type', $membershipDetails) == 'rolling') {
787 if ($startDate < $joinDate) {
788 $errors['start_date'] = ts('Start date must be the same or later than Member since.');
793 if ($membershipDetails['duration_unit'] == 'lifetime') {
794 // Check if status is NOT cancelled or similar. For lifetime memberships, there is no automated
795 // process to update status based on end-date. The user must change the status now.
796 $result = civicrm_api3('MembershipStatus', 'get', [
798 'is_current_member' => 0,
800 $tmp_statuses = $result['values'];
802 foreach ($tmp_statuses as $cur_stat) {
803 $status_ids[] = $cur_stat['id'];
806 if (empty($params['status_id']) ||
in_array($params['status_id'], $status_ids) == FALSE) {
807 $errors['status_id'] = ts('Please enter a status that does NOT represent a current membership status.');
810 if (!empty($params['is_override']) && !CRM_Member_StatusOverrideTypes
::isPermanent($params['is_override'])) {
811 $errors['is_override'] = ts('Because you set an End Date for a lifetime membership, This must be set to "Override Permanently"');
816 $errors['start_date'] = ts('Start date must be set if end date is set.');
818 if ($endDate < $startDate) {
819 $errors['end_date'] = ts('End date must be the same or later than start date.');
824 // Default values for start and end dates if not supplied on the form.
825 $defaultDates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
832 $startDate = CRM_Utils_Array
::value('start_date',
837 $endDate = CRM_Utils_Array
::value('end_date',
842 //CRM-3724, check for availability of valid membership status.
843 if ((empty($params['is_override']) || CRM_Member_StatusOverrideTypes
::isNo($params['is_override'])) && !isset($errors['_qf_default'])) {
844 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($startDate,
852 if (empty($calcStatus)) {
853 $url = CRM_Utils_System
::url('civicrm/admin/member/membershipStatus', 'reset=1&action=browse');
854 $errors['_qf_default'] = ts('There is no valid Membership Status available for selected membership dates.');
855 $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]);
857 $status .= ' ' . ts('OR You can sign up by setting Status Override? to something other than "NO".');
859 CRM_Core_Session
::setStatus($status, ts('Membership Status Error'), 'error');
865 $errors['join_date'] = ts('Please enter the Member Since.');
868 if (!empty($params['is_override']) && CRM_Member_StatusOverrideTypes
::isOverridden($params['is_override']) && empty($params['status_id'])) {
869 $errors['status_id'] = ts('Please enter the Membership status.');
872 if (!empty($params['is_override']) && CRM_Member_StatusOverrideTypes
::isUntilDate($params['is_override'])) {
873 if (empty($params['status_override_end_date'])) {
874 $errors['status_override_end_date'] = ts('Please enter the Membership override end date.');
878 //total amount condition arise when membership type having no
880 if (isset($params['record_contribution'])) {
881 if (CRM_Utils_System
::isNull($params['total_amount'])) {
882 $errors['total_amount'] = ts('Please enter the contribution.');
886 // validate contribution status for 'Failed'.
887 if ($self->_onlinePendingContributionId
&& !empty($params['record_contribution']) &&
888 (CRM_Utils_Array
::value('contribution_status_id', $params) ==
889 array_search('Failed', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'))
892 $errors['contribution_status_id'] = ts('Please select a valid payment status before updating.');
895 return empty($errors) ?
TRUE : $errors;
899 * Process the form submission.
901 public function postProcess() {
902 if ($this->_action
& CRM_Core_Action
::DELETE
) {
903 CRM_Member_BAO_Membership
::del($this->_id
);
906 // get the submitted form values.
907 $this->_params
= $this->controller
->exportValues($this->_name
);
908 $this->prepareStatusOverrideValues();
912 $this->setUserContext();
916 * Prepares the values related to status override.
918 private function prepareStatusOverrideValues() {
919 $this->setOverrideDateValue();
920 $this->convertIsOverrideValue();
924 * Sets status override end date to empty value if
925 * the selected override option is not 'until date'.
927 private function setOverrideDateValue() {
928 if (!CRM_Member_StatusOverrideTypes
::isUntilDate(CRM_Utils_Array
::value('is_override', $this->_params
))) {
929 $this->_params
['status_override_end_date'] = '';
934 * Convert the value of selected (status override?)
935 * option to TRUE if it indicate an overridden status
936 * or FALSE otherwise.
938 private function convertIsOverrideValue() {
939 $this->_params
['is_override'] = CRM_Member_StatusOverrideTypes
::isOverridden($this->_params
['is_override']);
943 * Send email receipt.
946 * This function is shared with Batch_Entry which has limited overlap
947 * & needs rationalising.
949 * @param CRM_Core_Form $form
951 * @param array $formValues
952 * @param object $membership
954 * @param array $customValues
957 * true if mail was sent successfully
959 public static function emailReceipt(&$form, &$formValues, &$membership, $customValues = NULL) {
960 // retrieve 'from email id' for acknowledgement
961 $receiptFrom = CRM_Utils_Array
::value('from_email_address', $formValues);
963 // @todo figure out how much of the stuff below is genuinely shared with the batch form & a logical shared place.
964 if (!empty($formValues['payment_instrument_id'])) {
965 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
966 $formValues['paidBy'] = $paymentInstrument[$formValues['payment_instrument_id']];
969 $form->assign('customValues', $customValues);
972 // @todo move this outside shared code as Batch entry just doesn't
973 $form->assign('address', CRM_Utils_Address
::getFormattedBillingAddressFieldsFromParameters(
978 $date = CRM_Utils_Date
::format($form->_params
['credit_card_exp_date']);
979 $date = CRM_Utils_Date
::mysqlToIso($date);
980 $form->assign('credit_card_exp_date', $date);
981 $form->assign('credit_card_number',
982 CRM_Utils_System
::mungeCreditCard($form->_params
['credit_card_number'])
984 $form->assign('credit_card_type', $form->_params
['credit_card_type']);
985 $form->assign('contributeMode', 'direct');
986 $form->assign('isAmountzero', 0);
987 $form->assign('is_pay_later', 0);
988 $form->assign('isPrimary', 1);
991 $form->assign('module', 'Membership');
992 $form->assign('contactID', $formValues['contact_id']);
994 $form->assign('membershipID', CRM_Utils_Array
::value('membership_id', $form->_params
, CRM_Utils_Array
::value('membership_id', $form->_defaultValues
)));
996 if (!empty($formValues['contribution_id'])) {
997 $form->assign('contributionID', $formValues['contribution_id']);
999 elseif (isset($form->_onlinePendingContributionId
)) {
1000 $form->assign('contributionID', $form->_onlinePendingContributionId
);
1003 if (!empty($formValues['contribution_status_id'])) {
1004 $form->assign('contributionStatusID', $formValues['contribution_status_id']);
1005 $form->assign('contributionStatus', CRM_Contribute_PseudoConstant
::contributionStatus($formValues['contribution_status_id'], 'name'));
1008 if (!empty($formValues['is_renew'])) {
1009 $form->assign('receiptType', 'membership renewal');
1012 $form->assign('receiptType', 'membership signup');
1014 $form->assign('receive_date', CRM_Utils_Array
::value('receive_date', $formValues));
1015 $form->assign('formValues', $formValues);
1017 if (empty($lineItem)) {
1018 $form->assign('mem_start_date', CRM_Utils_Date
::customFormat($membership->start_date
, '%B %E%f, %Y'));
1019 if (!CRM_Utils_System
::isNull($membership->end_date
)) {
1020 $form->assign('mem_end_date', CRM_Utils_Date
::customFormat($membership->end_date
, '%B %E%f, %Y'));
1022 $form->assign('membership_name', CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
));
1025 // @todo - if we have to figure out if this is for batch processing it doesn't belong in the shared function.
1026 $isBatchProcess = is_a($form, 'CRM_Batch_Form_Entry');
1027 if ((empty($form->_contributorDisplayName
) ||
empty($form->_contributorEmail
)) ||
$isBatchProcess) {
1028 // in this case the form is being called statically from the batch editing screen
1029 // having one class in the form layer call another statically is not greate
1030 // & we should aim to move this function to the BAO layer in future.
1031 // however, we can assume that the contact_id passed in by the batch
1032 // function will be the recipient
1033 list($form->_contributorDisplayName
, $form->_contributorEmail
)
1034 = CRM_Contact_BAO_Contact_Location
::getEmailDetails($formValues['contact_id']);
1035 if (empty($form->_receiptContactId
) ||
$isBatchProcess) {
1036 $form->_receiptContactId
= $formValues['contact_id'];
1039 // @todo determine isEmailPdf in calling function.
1040 $template = CRM_Core_Smarty
::singleton();
1041 $taxAmt = $template->get_template_vars('dataArray');
1042 $eventTaxAmt = $template->get_template_vars('totalTaxAmount');
1043 $prefixValue = Civi
::settings()->get('contribution_invoice_settings');
1044 $invoicing = CRM_Utils_Array
::value('invoicing', $prefixValue);
1045 if ((!empty($taxAmt) ||
isset($eventTaxAmt)) && (isset($invoicing) && isset($prefixValue['is_email_pdf']))) {
1049 $isEmailPdf = FALSE;
1052 list($mailSend, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
1054 'groupName' => 'msg_tpl_workflow_membership',
1055 'valueName' => 'membership_offline_receipt',
1056 'contactId' => $form->_receiptContactId
,
1057 'from' => $receiptFrom,
1058 'toName' => $form->_contributorDisplayName
,
1059 'toEmail' => $form->_contributorEmail
,
1060 'PDFFilename' => ts('receipt') . '.pdf',
1061 'isEmailPdf' => $isEmailPdf,
1062 'contributionId' => $formValues['contribution_id'],
1063 'isTest' => (bool) ($form->_action
& CRM_Core_Action
::PREVIEW
),
1073 * This is also accessed by unit tests.
1075 public function submit() {
1076 $isTest = ($this->_mode
== 'test') ?
1 : 0;
1077 $this->storeContactFields($this->_params
);
1078 $this->beginPostProcess();
1079 $joinDate = $startDate = $endDate = NULL;
1080 $membershipTypes = $membership = $calcDate = [];
1081 $membershipType = NULL;
1082 $paymentInstrumentID = $this->_paymentProcessor
['object']->getPaymentInstrumentID();
1083 $params = $softParams = $ids = [];
1086 $this->processBillingAddress();
1087 $formValues = $this->_params
;
1088 $formValues = $this->setPriceSetParameters($formValues);
1091 $ids['membership'] = $params['id'] = $this->_id
;
1093 $ids['userId'] = CRM_Core_Session
::singleton()->get('userID');
1095 // Set variables that we normally get from context.
1096 // In form mode these are set in preProcess.
1097 //TODO: set memberships, fixme
1098 $this->setContextVariables($formValues);
1100 $this->_memTypeSelected
= self
::getSelectedMemberships(
1104 if (empty($formValues['financial_type_id'])) {
1105 $formValues['financial_type_id'] = $this->_priceSet
['financial_type_id'];
1108 $config = CRM_Core_Config
::singleton();
1110 $membershipTypeValues = [];
1111 foreach ($this->_memTypeSelected
as $memType) {
1112 $membershipTypeValues[$memType]['membership_type_id'] = $memType;
1115 //take the required membership recur values.
1116 if ($this->_mode
&& !empty($formValues['auto_renew'])) {
1117 $params['is_recur'] = $formValues['is_recur'] = TRUE;
1120 foreach ($this->_memTypeSelected
as $memType) {
1121 $recurMembershipTypeValues = CRM_Utils_Array
::value($memType,
1122 $this->allMembershipTypeDetails
, []
1124 if (!$recurMembershipTypeValues['auto_renew']) {
1128 'frequency_interval' => 'duration_interval',
1129 'frequency_unit' => 'duration_unit',
1130 ] as $mapVal => $mapParam) {
1131 $membershipTypeValues[$memType][$mapVal] = $recurMembershipTypeValues[$mapParam];
1134 $formValues[$mapVal] = CRM_Utils_Array
::value($mapParam,
1135 $recurMembershipTypeValues
1143 $isQuickConfig = $this->_priceSet
['is_quick_config'];
1147 $lineItem = [$this->_priceSetId
=> []];
1149 // BEGIN Fix for dev/core/issues/860
1150 // Prepare fee block and call buildAmount hook - based on CRM_Price_BAO_PriceSet::buildPriceSet().
1151 CRM_Price_BAO_PriceSet
::applyACLFinancialTypeStatusToFeeBlock($this->_priceSet
['fields']);
1152 CRM_Utils_Hook
::buildAmount('membership', $this, $this->_priceSet
['fields']);
1153 // END Fix for dev/core/issues/860
1155 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
1156 $formValues, $lineItem[$this->_priceSetId
], NULL, $this->_priceSetId
);
1158 if (!empty($formValues['tax_amount'])) {
1159 $params['tax_amount'] = $formValues['tax_amount'];
1161 $params['total_amount'] = CRM_Utils_Array
::value('amount', $formValues);
1162 if (!empty($lineItem[$this->_priceSetId
])) {
1163 foreach ($lineItem[$this->_priceSetId
] as &$li) {
1164 if (!empty($li['membership_type_id'])) {
1165 if (!empty($li['membership_num_terms'])) {
1166 $termsByType[$li['membership_type_id']] = $li['membership_num_terms'];
1170 ///CRM-11529 for quick config backoffice transactions
1171 //when financial_type_id is passed in form, update the
1172 //lineitems with the financial type selected in form
1173 $submittedFinancialType = CRM_Utils_Array
::value('financial_type_id', $formValues);
1174 if ($isQuickConfig && $submittedFinancialType) {
1175 $li['financial_type_id'] = $submittedFinancialType;
1180 $params['contact_id'] = $this->_contactID
;
1186 'status_override_end_date',
1190 foreach ($fields as $f) {
1191 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1195 // when is_override false ignore is_admin statuses during membership
1196 // status calculation. similarly we did fix for import in CRM-3570.
1197 if (empty($params['is_override'])) {
1198 $params['exclude_is_admin'] = TRUE;
1201 // process date params to mysql date format.
1203 'join_date' => 'joinDate',
1204 'start_date' => 'startDate',
1205 'end_date' => 'endDate',
1207 foreach ($dateTypes as $dateField => $dateVariable) {
1208 $
$dateVariable = CRM_Utils_Date
::processDate($formValues[$dateField]);
1211 $memTypeNumTerms = empty($termsByType) ? CRM_Utils_Array
::value('num_terms', $formValues) : NULL;
1214 foreach ($this->_memTypeSelected
as $memType) {
1215 if (empty($memTypeNumTerms)) {
1216 $memTypeNumTerms = CRM_Utils_Array
::value($memType, $termsByType, 1);
1218 $calcDates[$memType] = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($memType,
1219 $joinDate, $startDate, $endDate, $memTypeNumTerms
1223 foreach ($calcDates as $memType => $calcDate) {
1224 foreach (array_keys($dateTypes) as $d) {
1225 //first give priority to form values then calDates.
1226 $date = CRM_Utils_Array
::value($d, $formValues);
1228 $date = CRM_Utils_Array
::value($d, $calcDate);
1231 $membershipTypeValues[$memType][$d] = CRM_Utils_Date
::processDate($date);
1235 foreach ($this->_memTypeSelected
as $memType) {
1236 if (array_key_exists('max_related', $formValues)) {
1237 // max related memberships - take from form or inherit from membership type
1238 $membershipTypeValues[$memType]['max_related'] = CRM_Utils_Array
::value('max_related', $formValues);
1240 $membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField
::postProcess($formValues,
1244 $membershipTypes[$memType] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
1249 $membershipType = implode(', ', $membershipTypes);
1251 // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1252 list($userName) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($ids['userId']);
1254 //CRM-13981, allow different person as a soft-contributor of chosen type
1255 if ($this->_contributorContactID
!= $this->_contactID
) {
1256 $params['contribution_contact_id'] = $this->_contributorContactID
;
1257 if (!empty($formValues['soft_credit_type_id'])) {
1258 $softParams['soft_credit_type_id'] = $formValues['soft_credit_type_id'];
1259 $softParams['contact_id'] = $this->_contactID
;
1263 $pendingMembershipStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending');
1265 if (!empty($formValues['record_contribution'])) {
1266 $recordContribution = [
1268 'financial_type_id',
1269 'payment_instrument_id',
1271 'contribution_status_id',
1279 foreach ($recordContribution as $f) {
1280 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1283 if (!$this->_onlinePendingContributionId
) {
1284 if (empty($formValues['source'])) {
1285 $params['contribution_source'] = ts('%1 Membership: Offline signup (by %2)', [
1286 1 => $membershipType,
1291 $params['contribution_source'] = $formValues['source'];
1295 $completedContributionStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
1296 if (empty($params['is_override']) &&
1297 CRM_Utils_Array
::value('contribution_status_id', $params) != $completedContributionStatusId
1299 $params['status_id'] = $pendingMembershipStatusId;
1300 $params['skipStatusCal'] = TRUE;
1301 $params['is_pay_later'] = 1;
1302 $this->assign('is_pay_later', 1);
1305 if (!empty($formValues['send_receipt'])) {
1306 $params['receipt_date'] = CRM_Utils_Array
::value('receive_date', $formValues);
1309 //insert financial type name in receipt.
1310 $formValues['contributionType_name'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType',
1311 $formValues['financial_type_id']
1315 // process line items, until no previous line items.
1316 if (!empty($lineItem)) {
1317 $params['lineItems'] = $lineItem;
1318 $params['processPriceSet'] = TRUE;
1320 $createdMemberships = [];
1322 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $formValues, 0);
1324 //CRM-20264 : Store CC type and number (last 4 digit) during backoffice or online payment
1325 $params['card_type_id'] = CRM_Utils_Array
::value('card_type_id', $this->_params
);
1326 $params['pan_truncation'] = CRM_Utils_Array
::value('pan_truncation', $this->_params
);
1328 if (!$isQuickConfig) {
1329 $params['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet',
1335 $params['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $formValues);
1338 //get the payment processor id as per mode. Try removing in favour of beginPostProcess.
1339 $params['payment_processor_id'] = $formValues['payment_processor_id'] = $this->_paymentProcessor
['id'];
1340 $params['register_date'] = date('YmdHis');
1342 // add all the additional payment params we need
1343 $formValues['amount'] = $params['total_amount'];
1344 // @todo this is a candidate for beginPostProcessFunction.
1345 $formValues['currencyID'] = $config->defaultCurrency
;
1346 $formValues['description'] = ts("Contribution submitted by a staff person using member's credit card for signup");
1347 $formValues['invoiceID'] = md5(uniqid(rand(), TRUE));
1348 $formValues['financial_type_id'] = $params['financial_type_id'];
1350 // at this point we've created a contact and stored its address etc
1351 // all the payment processors expect the name and address to be in the
1352 // so we copy stuff over to first_name etc.
1353 $paymentParams = $formValues;
1354 $paymentParams['contactID'] = $this->_contributorContactID
;
1355 //CRM-10377 if payment is by an alternate contact then we need to set that person
1356 // as the contact in the payment params
1357 if ($this->_contributorContactID
!= $this->_contactID
) {
1358 if (!empty($formValues['soft_credit_type_id'])) {
1359 $softParams['contact_id'] = $params['contact_id'];
1360 $softParams['soft_credit_type_id'] = $formValues['soft_credit_type_id'];
1363 if (!empty($formValues['send_receipt'])) {
1364 $paymentParams['email'] = $this->_contributorEmail
;
1367 // This is a candidate for shared beginPostProcess function.
1368 // @todo Do we need this now we have $this->formatParamsForPaymentProcessor() ?
1369 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $formValues, $paymentParams, TRUE);
1370 // CRM-7137 -for recurring membership,
1371 // we do need contribution and recurring records.
1373 if (!empty($paymentParams['is_recur'])) {
1374 $financialType = new CRM_Financial_DAO_FinancialType();
1375 $financialType->id
= $params['financial_type_id'];
1376 $financialType->find(TRUE);
1377 $this->_params
= $formValues;
1379 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processFormContribution($this,
1383 'contact_id' => $this->_contributorContactID
,
1384 'line_item' => $lineItem,
1385 'is_test' => $isTest,
1386 'campaign_id' => CRM_Utils_Array
::value('campaign_id', $paymentParams),
1387 'contribution_page_id' => CRM_Utils_Array
::value('contribution_page_id', $formValues),
1388 'source' => CRM_Utils_Array
::value('source', $paymentParams, CRM_Utils_Array
::value('description', $paymentParams)),
1389 'thankyou_date' => CRM_Utils_Array
::value('thankyou_date', $paymentParams),
1390 'payment_instrument_id' => $paymentInstrumentID,
1398 //create new soft-credit record, CRM-13981
1400 $softParams['contribution_id'] = $contribution->id
;
1401 $softParams['currency'] = $contribution->currency
;
1402 $softParams['amount'] = $contribution->total_amount
;
1403 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1406 $paymentParams['contactID'] = $this->_contactID
;
1407 $paymentParams['contributionID'] = $contribution->id
;
1408 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1409 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1410 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1411 $params['contribution_id'] = $paymentParams['contributionID'];
1412 $params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
1414 $paymentStatus = NULL;
1416 if ($params['total_amount'] > 0.0) {
1417 $payment = $this->_paymentProcessor
['object'];
1419 $result = $payment->doPayment($paymentParams);
1420 $formValues = array_merge($formValues, $result);
1421 $paymentStatus = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $formValues['payment_status_id']);
1422 // Assign amount to template if payment was successful.
1423 $this->assign('amount', $params['total_amount']);
1425 catch (\Civi\Payment\Exception\PaymentProcessorException
$e) {
1426 if (!empty($paymentParams['contributionID'])) {
1427 CRM_Contribute_BAO_Contribution
::failPayment($paymentParams['contributionID'], $this->_contactID
,
1430 if (!empty($paymentParams['contributionRecurID'])) {
1431 CRM_Contribute_BAO_ContributionRecur
::deleteRecurContribution($paymentParams['contributionRecurID']);
1434 CRM_Core_Session
::singleton()->setStatus($e->getMessage());
1435 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
1436 "reset=1&action=add&cid={$this->_contactID}&context=membership&mode={$this->_mode}"
1442 if ($paymentStatus !== 'Completed') {
1443 $params['status_id'] = $pendingMembershipStatusId;
1444 $params['skipStatusCal'] = TRUE;
1445 // unset send-receipt option, since receipt will be sent when ipn is received.
1446 unset($formValues['send_receipt'], $formValues['send_receipt']);
1447 //as membership is pending set dates to null.
1449 'join_date' => 'joinDate',
1450 'start_date' => 'startDate',
1451 'end_date' => 'endDate',
1453 foreach ($memberDates as $dv) {
1455 foreach ($this->_memTypeSelected
as $memType) {
1456 $membershipTypeValues[$memType][$dv] = NULL;
1460 $now = date('YmdHis');
1461 $params['receive_date'] = date('Y-m-d H:i:s');
1462 $params['invoice_id'] = $formValues['invoiceID'];
1463 $params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
1464 [1 => $membershipType, 2 => $userName]
1466 $params['source'] = $formValues['source'] ?
$formValues['source'] : $params['contribution_source'];
1467 $params['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1468 $params['is_test'] = ($this->_mode
== 'live') ?
0 : 1;
1469 if (!empty($formValues['send_receipt'])) {
1470 $params['receipt_date'] = $now;
1473 $params['receipt_date'] = NULL;
1476 $this->set('params', $formValues);
1477 $this->assign('trxn_id', CRM_Utils_Array
::value('trxn_id', $result));
1478 $this->assign('receive_date',
1479 CRM_Utils_Date
::mysqlToIso($params['receive_date'])
1482 // required for creating membership for related contacts
1483 $params['action'] = $this->_action
;
1485 //create membership record.
1487 foreach ($this->_memTypeSelected
as $memType) {
1489 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1491 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1494 $membershipParams = array_merge($membershipTypeValues[$memType], $params);
1496 if (!empty($softParams) && empty($paymentParams['is_recur'])) {
1497 $membershipParams['soft_credit'] = $softParams;
1499 if (isset($result['fee_amount'])) {
1500 $membershipParams['fee_amount'] = $result['fee_amount'];
1502 // This is required to trigger the recording of the membership contribution in the
1503 // CRM_Member_BAO_Membership::Create function.
1504 // @todo stop setting this & 'teach' the create function to respond to something
1505 // appropriate as part of our 2-step always create the pending contribution & then finally add the payment
1507 // @see http://wiki.civicrm.org/confluence/pages/viewpage.action?pageId=261062657#Payments&AccountsRoadmap-Movetowardsalwaysusinga2-steppaymentprocess
1508 $membershipParams['contribution_status_id'] = CRM_Utils_Array
::value('payment_status_id', $result);
1509 if (!empty($paymentParams['is_recur'])) {
1510 // The earlier process created the line items (although we want to get rid of the earlier one in favour
1511 // of a single path!
1512 unset($membershipParams['lineItems']);
1514 $membershipParams['payment_instrument_id'] = $paymentInstrumentID;
1515 // @todo stop passing $ids (membership and userId only are set above)
1516 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1517 $params['contribution'] = CRM_Utils_Array
::value('contribution', $membershipParams);
1518 unset($params['lineItems']);
1519 $this->_membershipIDs
[] = $membership->id
;
1520 $createdMemberships[$memType] = $membership;
1526 $params['action'] = $this->_action
;
1527 if ($this->_onlinePendingContributionId
&& !empty($formValues['record_contribution'])) {
1529 // update membership as well as contribution object, CRM-4395
1530 $params['contribution_id'] = $this->_onlinePendingContributionId
;
1531 $params['componentId'] = $params['id'];
1532 $params['componentName'] = 'contribute';
1533 $result = CRM_Contribute_BAO_Contribution
::transitionComponents($params, TRUE);
1534 if (!empty($result) && !empty($params['contribution_id'])) {
1536 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($params['contribution_id']);
1537 $itemId = key($lineItems);
1538 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1540 $lineItems[$itemId]['unit_price'] = $params['total_amount'];
1541 $lineItems[$itemId]['line_total'] = $params['total_amount'];
1542 $lineItems[$itemId]['id'] = $itemId;
1543 $lineItem[$priceSetId] = $lineItems;
1544 $contributionBAO = new CRM_Contribute_BAO_Contribution();
1545 $contributionBAO->id
= $params['contribution_id'];
1546 $contributionBAO->contact_id
= $params['contact_id'];
1547 $contributionBAO->find();
1548 CRM_Price_BAO_LineItem
::processPriceSet($params['contribution_id'], $lineItem, $contributionBAO, 'civicrm_membership');
1550 //create new soft-credit record, CRM-13981
1552 $softParams['contribution_id'] = $params['contribution_id'];
1553 while ($contributionBAO->fetch()) {
1554 $softParams['currency'] = $contributionBAO->currency
;
1555 $softParams['amount'] = $contributionBAO->total_amount
;
1557 CRM_Contribute_BAO_ContributionSoft
::add($softParams);
1561 //carry updated membership object.
1562 $membership = new CRM_Member_DAO_Membership();
1563 $membership->id
= $this->_id
;
1564 $membership->find(TRUE);
1567 if ($membership->end_date
) {
1568 //display end date w/ status message.
1569 $endDate = $membership->end_date
;
1571 if (!in_array($membership->status_id
, [
1573 array_search('Cancelled', CRM_Member_PseudoConstant
::membershipStatus(NULL, " name = 'Cancelled' ", 'name', FALSE, TRUE)),
1574 array_search('Expired', CRM_Member_PseudoConstant
::membershipStatus()),
1580 // suppress form values in template.
1581 $this->assign('cancelled', $cancelled);
1583 $createdMemberships[] = $membership;
1587 foreach ($this->_memTypeSelected
as $memType) {
1588 if ($count && !empty($formValues['record_contribution']) &&
1589 ($relateContribution = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
))
1591 $membershipTypeValues[$memType]['relate_contribution_id'] = $relateContribution;
1594 // @todo figure out why recieve_date isn't being set right here.
1595 if (empty($params['receive_date'])) {
1596 $params['receive_date'] = date('Y-m-d H:i:s');
1598 $membershipParams = array_merge($params, $membershipTypeValues[$memType]);
1599 if (!empty($formValues['int_amount'])) {
1601 foreach ($formValues as $key => $value) {
1602 if (strstr($key, 'txt-price')) {
1603 $init_amount[$key] = $value;
1606 $membershipParams['init_amount'] = $init_amount;
1609 if (!empty($softParams)) {
1610 $membershipParams['soft_credit'] = $softParams;
1612 // @todo stop passing $ids (membership and userId only are set above)
1613 $membership = CRM_Member_BAO_Membership
::create($membershipParams, $ids);
1614 $params['contribution'] = CRM_Utils_Array
::value('contribution', $membershipParams);
1615 unset($params['lineItems']);
1616 // skip line item creation for next interation since line item(s) are already created.
1617 $params['skipLineItem'] = TRUE;
1619 $this->_membershipIDs
[] = $membership->id
;
1620 $createdMemberships[$memType] = $membership;
1625 $isRecur = CRM_Utils_Array
::value('is_recur', $params);
1626 if (($this->_action
& CRM_Core_Action
::UPDATE
)) {
1627 $this->addStatusMessage($this->getStatusMessageForUpdate($membership, $endDate));
1629 elseif (($this->_action
& CRM_Core_Action
::ADD
)) {
1630 $this->addStatusMessage($this->getStatusMessageForCreate($endDate, $membershipTypes, $createdMemberships,
1631 $isRecur, $calcDates));
1634 if (!empty($lineItem[$this->_priceSetId
])) {
1635 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
1636 $invoicing = CRM_Utils_Array
::value('invoicing', $invoiceSettings);
1638 $totalTaxAmount = 0;
1639 foreach ($lineItem[$this->_priceSetId
] as & $priceFieldOp) {
1640 if (!empty($priceFieldOp['membership_type_id'])) {
1641 $priceFieldOp['start_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date'] ? CRM_Utils_Date
::customFormat($membershipTypeValues[$priceFieldOp['membership_type_id']]['start_date'], '%B %E%f, %Y') : '-';
1642 $priceFieldOp['end_date'] = $membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date'] ? CRM_Utils_Date
::customFormat($membershipTypeValues[$priceFieldOp['membership_type_id']]['end_date'], '%B %E%f, %Y') : '-';
1645 $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1647 if ($invoicing && isset($priceFieldOp['tax_amount'])) {
1649 $totalTaxAmount +
= $priceFieldOp['tax_amount'];
1654 foreach ($lineItem[$this->_priceSetId
] as $key => $value) {
1655 if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
1656 if (isset($dataArray[$value['tax_rate']])) {
1657 $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $value);
1660 $dataArray[$value['tax_rate']] = CRM_Utils_Array
::value('tax_amount', $value);
1665 $this->assign('totalTaxAmount', $totalTaxAmount);
1666 // Not sure why would need this on Submit.... unless it's being used when sending mails in which case this is the wrong place
1667 $this->assign('taxTerm', $this->getSalesTaxTerm());
1669 $this->assign('dataArray', $dataArray);
1672 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1674 $receiptSend = FALSE;
1675 $contributionId = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
);
1676 $membershipIds = $this->_membershipIDs
;
1677 if ($contributionId && !empty($membershipIds)) {
1678 $contributionDetails = CRM_Contribute_BAO_Contribution
::getContributionDetails(
1679 CRM_Export_Form_Select
::MEMBER_EXPORT
, $this->_membershipIDs
);
1680 if ($contributionDetails[$membership->id
]['contribution_status'] == 'Completed') {
1681 $receiptSend = TRUE;
1685 $receiptSent = FALSE;
1686 if (!empty($formValues['send_receipt']) && $receiptSend) {
1687 $formValues['contact_id'] = $this->_contactID
;
1688 $formValues['contribution_id'] = $contributionId;
1689 // We really don't need a distinct receipt_text_signup vs receipt_text_renewal as they are
1690 // handled in the receipt. But by setting one we avoid breaking templates for now
1691 // although at some point we should switch in the templates.
1692 $formValues['receipt_text_signup'] = $formValues['receipt_text'];
1693 // send email receipt
1694 $this->assignBillingName();
1695 $mailSend = $this->emailMembershipReceipt($formValues, $membership);
1696 $receiptSent = TRUE;
1699 // finally set membership id if already not set
1701 $this->_id
= $membership->id
;
1704 $this->updateContributionOnMembershipTypeChange($params, $membership);
1705 if ($receiptSent && $mailSend) {
1706 $this->addStatusMessage(ts('A membership confirmation and receipt has been sent to %1.', [1 => $this->_contributorEmail
]));
1709 CRM_Core_Session
::setStatus($this->getStatusMessage(), ts('Complete'), 'success');
1710 $this->setStatusMessage($membership);
1714 * Update related contribution of a membership if update_contribution_on_membership_type_change
1715 * contribution setting is enabled and type is changed on edit
1717 * @param array $inputParams
1718 * submitted form values
1719 * @param CRM_Member_DAO_Membership $membership
1720 * Updated membership object
1723 protected function updateContributionOnMembershipTypeChange($inputParams, $membership) {
1724 if (Civi
::settings()->get('update_contribution_on_membership_type_change') &&
1726 ($this->_action
& CRM_Core_Action
::UPDATE
) &&
1729 // if selected membership doesn't match with earlier membership
1730 !in_array($this->_memType
, $this->_memTypeSelected
)
1732 if (!empty($inputParams['is_recur'])) {
1733 CRM_Core_Session
::setStatus(ts('Associated recurring contribution cannot be updated on membership type change.', ts('Error'), 'error'));
1737 // fetch lineitems by updated membership ID
1738 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($membership->id
, 'membership');
1739 // retrieve the related contribution ID
1740 $contributionID = CRM_Core_DAO
::getFieldValue(
1741 'CRM_Member_DAO_MembershipPayment',
1746 // get price fields of chosen price-set
1747 $priceSetDetails = CRM_Utils_Array
::value(
1749 CRM_Price_BAO_PriceSet
::getSetDetail(
1756 // add price field information in $inputParams
1757 self
::addPriceFieldByMembershipType($inputParams, $priceSetDetails['fields'], $membership->membership_type_id
);
1759 // update related contribution and financial records
1760 CRM_Price_BAO_LineItem
::changeFeeSelections(
1765 $priceSetDetails['fields'],
1768 CRM_Core_Session
::setStatus(ts('Associated contribution is updated on membership type change.'), ts('Success'), 'success');
1773 * Add selected price field information in $formValues
1775 * @param array $formValues
1776 * submitted form values
1777 * @param array $priceFields
1778 * Price fields of selected Priceset ID
1779 * @param int $membershipTypeID
1780 * Selected membership type ID
1783 public static function addPriceFieldByMembershipType(&$formValues, $priceFields, $membershipTypeID) {
1784 foreach ($priceFields as $priceFieldID => $priceField) {
1785 if (isset($priceField['options']) && count($priceField['options'])) {
1786 foreach ($priceField['options'] as $option) {
1787 if ($option['membership_type_id'] == $membershipTypeID) {
1788 $formValues["price_{$priceFieldID}"] = $option['id'];
1797 * Set context in session.
1799 protected function setUserContext() {
1800 $buttonName = $this->controller
->getButtonName();
1801 $session = CRM_Core_Session
::singleton();
1803 if ($this->_context
== 'standalone') {
1804 if ($buttonName == $this->getButtonName('upload', 'new')) {
1805 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/member/add',
1806 'reset=1&action=add&context=standalone'
1810 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1811 "reset=1&cid={$this->_contactID}&selectedChild=member"
1815 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1816 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/membership',
1817 "reset=1&action=add&context=membership&cid={$this->_contactID}"
1823 * Get status message for updating membership.
1825 * @param CRM_Member_BAO_Membership $membership
1826 * @param string $endDate
1830 protected function getStatusMessageForUpdate($membership, $endDate) {
1831 // End date can be modified by hooks, so if end date is set then use it.
1832 $endDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1834 $statusMsg = ts('Membership for %1 has been updated.', [1 => $this->_memberDisplayName
]);
1835 if ($endDate && $endDate !== 'null') {
1836 $endDate = CRM_Utils_Date
::customFormat($endDate);
1837 $statusMsg .= ' ' . ts('The membership End Date is %1.', [1 => $endDate]);
1843 * Get status message for create action.
1845 * @param string $endDate
1846 * @param array $membershipTypes
1847 * @param array $createdMemberships
1848 * @param bool $isRecur
1849 * @param array $calcDates
1851 * @return array|string
1853 protected function getStatusMessageForCreate($endDate, $membershipTypes, $createdMemberships,
1854 $isRecur, $calcDates) {
1855 // FIX ME: fix status messages
1858 foreach ($membershipTypes as $memType => $membershipType) {
1859 $statusMsg[$memType] = ts('%1 membership for %2 has been added.', [
1860 1 => $membershipType,
1861 2 => $this->_memberDisplayName
,
1864 $membership = $createdMemberships[$memType];
1865 $memEndDate = ($membership->end_date
) ?
$membership->end_date
: $endDate;
1867 //get the end date from calculated dates.
1868 if (!$memEndDate && !$isRecur) {
1869 $memEndDate = CRM_Utils_Array
::value('end_date', $calcDates[$memType]);
1872 if ($memEndDate && $memEndDate !== 'null') {
1873 $memEndDate = CRM_Utils_Date
::customFormat($memEndDate);
1874 $statusMsg[$memType] .= ' ' . ts('The new membership End Date is %1.', [1 => $memEndDate]);
1877 $statusMsg = implode('<br/>', $statusMsg);
1882 * @param $membership
1884 protected function setStatusMessage($membership) {
1886 // display message when membership type is changed
1887 if (($this->_action
& CRM_Core_Action
::UPDATE
) && $this->_id
&& !in_array($this->_memType
, $this->_memTypeSelected
)) {
1888 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->_id
, 'membership');
1889 $maxID = max(array_keys($lineItem));
1890 $lineItem = $lineItem[$maxID];
1891 $membershipTypeDetails = $this->allMembershipTypeDetails
[$membership->membership_type_id
];
1892 if ($membershipTypeDetails['financial_type_id'] != $lineItem['financial_type_id']) {
1893 CRM_Core_Session
::setStatus(
1894 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.'),
1898 if ($membershipTypeDetails['minimum_fee'] != $lineItem['line_total']) {
1899 CRM_Core_Session
::setStatus(
1900 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.'),
1910 protected function isUpdateToExistingRecurringMembership() {
1912 if ($this->_action
& CRM_Core_Action
::UPDATE
1913 && CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->getEntityId(),
1914 'contribution_recur_id')
1915 && !CRM_Member_BAO_Membership
::isSubscriptionCancelled($this->getEntityId())) {
1923 * Send a receipt for the membership.
1925 * @param array $formValues
1926 * @param \CRM_Member_BAO_Membership $membership
1930 protected function emailMembershipReceipt($formValues, $membership) {
1931 $customValues = $this->getCustomValuesForReceipt($formValues, $membership);
1933 return self
::emailReceipt($this, $formValues, $membership, $customValues);
1937 * Filter the custom values from the input parameters (for display in the email).
1939 * @todo figure out why the scary code this calls does & document.
1941 * @param array $formValues
1942 * @param \CRM_Member_BAO_Membership $membership
1945 protected function getCustomValuesForReceipt($formValues, $membership) {
1946 $customFields = $customValues = [];
1947 if (property_exists($this, '_groupTree')
1948 && !empty($this->_groupTree
)
1950 foreach ($this->_groupTree
as $groupID => $group) {
1951 if ($groupID == 'info') {
1954 foreach ($group['fields'] as $k => $field) {
1955 $field['title'] = $field['label'];
1956 $customFields["custom_{$k}"] = $field;
1961 $members = [['member_id', '=', $membership->id
, 0, 0]];
1962 // check whether its a test drive
1963 if ($this->_mode
== 'test') {
1964 $members[] = ['member_test', '=', 1, 0, 0];
1967 CRM_Core_BAO_UFGroup
::getValues($formValues['contact_id'], $customFields, $customValues, FALSE, $members);
1968 return $customValues;