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 Membership Renewal
21 class CRM_Member_Form_MembershipRenewal
extends CRM_Member_Form
{
24 * Display name of the member.
28 protected $_memberDisplayName = NULL;
31 * email of the person paying for the membership (used for receipts)
35 protected $_memberEmail = NULL;
38 * Contact ID of the member.
43 public $_contactID = NULL;
46 * Display name of the person paying for the membership (used for receipts)
50 protected $_contributorDisplayName = NULL;
53 * email of the person paying for the membership (used for receipts)
57 protected $_contributorEmail = NULL;
60 * email of the person paying for the membership (used for receipts)
64 protected $_contributorContactID = NULL;
67 * ID of the person the receipt is to go to
71 protected $_receiptContactId = NULL;
74 * context would be set to standalone if the contact is use is being selected from
75 * the form rather than in the URL
82 * Has an email been sent.
86 protected $isMailSent = FALSE;
89 * The name of the renewed membership type.
93 protected $membershipTypeName = '';
96 * Set entity fields to be assigned to the form.
98 protected function setEntityFields() {
102 * Set the delete message.
104 * We do this from the constructor in order to do a translation.
106 public function setDeleteMessage() {
110 * Set the renewal notification status message.
112 public function setRenewalMessage() {
113 $statusMsg = ts('%1 membership for %2 has been renewed.', [1 => $this->membershipTypeName
, 2 => $this->_memberDisplayName
]);
115 if ($this->isMailSent
) {
116 $statusMsg .= ' ' . ts('A renewal confirmation and receipt has been sent to %1.', [1 => $this->_contributorEmail
]);
118 CRM_Core_Session
::setStatus($statusMsg, ts('Complete'), 'success');
124 * @throws \CRM_Core_Exception
125 * @throws \CiviCRM_API3_Exception
127 public function preProcess() {
129 // This string makes up part of the class names, differentiating them (not sure why) from the membership fields.
130 $this->assign('formClass', 'membershiprenew');
131 parent
::preProcess();
133 // @todo - we should store this as a property & re-use in setDefaults - for now that's a bigger change.
134 $currentMembership = civicrm_api3('Membership', 'getsingle', ['id' => $this->_id
]);
135 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership);
137 $this->assign('endDate', $currentMembership['end_date']);
138 $this->assign('membershipStatus',
139 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus',
140 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership',
141 $this->_id
, 'status_id'
148 $membershipFee = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType
, 'minimum_fee');
149 if (!$membershipFee) {
150 $statusMsg = ts('Membership Renewal using a credit card requires a Membership fee. Since there is no fee associated with the selected membership type, you can use the normal renewal mode.');
151 CRM_Core_Session
::setStatus($statusMsg, '', 'info');
152 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
153 "reset=1&action=renew&cid={$this->_contactID}&id={$this->_id}&context=membership"
158 // when custom data is included in this page
159 if (!empty($_POST['hidden_custom'])) {
160 CRM_Custom_Form_CustomData
::preProcess($this, NULL, $this->_memType
, 1, 'Membership', $this->_id
);
161 CRM_Custom_Form_CustomData
::buildQuickForm($this);
162 CRM_Custom_Form_CustomData
::setDefaultValues($this);
165 CRM_Utils_System
::setTitle(ts('Renew Membership'));
167 parent
::preProcess();
171 * Set default values for the form.
172 * the default values are retrieved from the database
176 * @throws \CRM_Core_Exception
178 public function setDefaultValues() {
180 $defaults = parent
::setDefaultValues();
182 // set renewal_date and receive_date to today in correct input format (setDateDefaults uses today if no value passed)
183 $now = date('Y-m-d');
184 $defaults['renewal_date'] = $now;
185 $defaults['receive_date'] = $now . ' ' . date('H:i:s');
187 if ($defaults['id']) {
188 $defaults['record_contribution'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipPayment',
195 $defaults['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType
, 'financial_type_id');
198 if (empty($defaults['payment_instrument_id'])) {
199 $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup
::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
202 $defaults['total_amount'] = CRM_Utils_Money
::format(CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
207 $defaults['record_contribution'] = 0;
208 $defaults['num_terms'] = 1;
209 $defaults['send_receipt'] = 0;
211 //set Soft Credit Type to Gift by default
212 $scTypes = CRM_Core_OptionGroup
::values('soft_credit_type');
213 $defaults['soft_credit_type_id'] = CRM_Utils_Array
::value(ts('Gift'), array_flip($scTypes));
215 $renewalDate = $defaults['renewal_date'] ??
NULL;
216 $this->assign('renewalDate', $renewalDate);
217 $this->assign('member_is_test', CRM_Utils_Array
::value('member_is_test', $defaults));
220 $defaults = $this->getBillingDefaults($defaults);
226 * Build the form object.
228 * @throws \CRM_Core_Exception
230 public function buildQuickForm() {
232 parent
::buildQuickForm();
234 $defaults = parent
::setDefaultValues();
235 $this->assign('customDataType', 'Membership');
236 $this->assign('customDataSubType', $this->_memType
);
237 $this->assign('entityID', $this->_id
);
238 $selOrgMemType[0][0] = $selMemTypeOrg[0] = ts('- select -');
240 $allMembershipInfo = [];
243 if (is_array($defaults['membership_type_id'])) {
244 $defaults['membership_type_id'] = $defaults['membership_type_id'][1];
248 $taxRate = $this->getTaxRateForFinancialType($this->allMembershipTypeDetails
[$defaults['membership_type_id']]['financial_type_id']);
250 $contactField = $this->addEntityRef('contact_id', ts('Member'), ['create' => TRUE, 'api' => ['extra' => ['email']]], TRUE);
251 $contactField->freeze();
253 // auto renew options if enabled for the membership
254 $options = CRM_Core_SelectValues
::memberAutoRenew();
256 foreach ($this->allMembershipTypeDetails
as $key => $values) {
257 if (!empty($values['is_active'])) {
258 if ($this->_mode
&& empty($values['minimum_fee'])) {
262 $memberOfContactId = $values['member_of_contact_id'] ??
NULL;
263 if (empty($selMemTypeOrg[$memberOfContactId])) {
264 $selMemTypeOrg[$memberOfContactId] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
270 $selOrgMemType[$memberOfContactId][0] = ts('- select -');
272 if (empty($selOrgMemType[$memberOfContactId][$key])) {
273 $selOrgMemType[$memberOfContactId][$key] = $values['name'] ??
NULL;
279 $totalAmount = $values['minimum_fee'] ??
NULL;
280 // @todo - feels a bug - we use taxRate from the form default rather than from the specified type?!?
281 if ($this->getTaxRateForFinancialType($values['financial_type_id'])) {
282 $taxAmount = ($taxRate / 100) * CRM_Utils_Array
::value('minimum_fee', $values);
283 $totalAmount = $totalAmount +
$taxAmount;
286 // build membership info array, which is used to set the payment information block when
287 // membership type is selected.
288 $allMembershipInfo[$key] = [
289 'financial_type_id' => $values['financial_type_id'] ??
NULL,
290 'total_amount' => CRM_Utils_Money
::format($totalAmount, NULL, '%a'),
291 'total_amount_numeric' => $totalAmount,
292 'tax_message' => $taxAmount ?
ts("Includes %1 amount of %2", [1 => $this->getSalesTaxTerm(), 2 => CRM_Utils_Money
::format($taxAmount)]) : $taxAmount,
295 if (!empty($values['auto_renew'])) {
296 $allMembershipInfo[$key]['auto_renew'] = $options[$values['auto_renew']];
301 $this->assign('allMembershipInfo', json_encode($allMembershipInfo));
303 if ($this->_memType
) {
304 $this->assign('orgName', $selMemTypeOrg[$this->allMembershipTypeDetails
[$this->_memType
]['member_of_contact_id']]);
305 $this->assign('memType', $this->allMembershipTypeDetails
[$this->_memType
]['name']);
308 // force select of organization by default, if only one organization in
310 if (count($selMemTypeOrg) == 2) {
311 unset($selMemTypeOrg[0], $selOrgMemType[0][0]);
313 //sort membership organization and type, CRM-6099
314 natcasesort($selMemTypeOrg);
315 foreach ($selOrgMemType as $index => $orgMembershipType) {
316 natcasesort($orgMembershipType);
317 $selOrgMemType[$index] = $orgMembershipType;
320 $js = ['onChange' => "setPaymentBlock(); CRM.buildCustomData('Membership', this.value);"];
321 $sel = &$this->addElement('hierselect',
322 'membership_type_id',
323 ts('Renewal Membership Organization and Type'), $js
326 $sel->setOptions([$selMemTypeOrg, $selOrgMemType]);
332 $this->applyFilter('__ALL__', 'trim');
334 $this->add('datepicker', 'renewal_date', ts('Date Renewal Entered'), [], FALSE, ['time' => FALSE]);
336 $this->add('select', 'financial_type_id', ts('Financial Type'),
337 ['' => ts('- select -')] + CRM_Contribute_PseudoConstant
::financialType()
340 $this->add('number', 'num_terms', ts('Extend Membership by'), ['onchange' => "setPaymentBlock();"], TRUE);
341 $this->addRule('num_terms', ts('Please enter a whole number for how many periods to renew.'), 'integer');
343 if (CRM_Core_Permission
::access('CiviContribute') && !$this->_mode
) {
344 $this->addElement('checkbox', 'record_contribution', ts('Record Renewal Payment?'), NULL, ['onclick' => "checkPayment();"]);
346 $this->add('text', 'total_amount', ts('Amount'));
347 $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
349 $this->add('datepicker', 'receive_date', ts('Received'), [], FALSE, ['time' => TRUE]);
351 $this->add('select', 'payment_instrument_id', ts('Payment Method'),
352 ['' => ts('- select -')] + CRM_Contribute_PseudoConstant
::paymentInstrument(),
353 FALSE, ['onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);"]
356 $this->add('text', 'trxn_id', ts('Transaction ID'));
357 $this->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
358 'objectExists', ['CRM_Contribute_DAO_Contribution', $this->_id
, 'trxn_id']
361 $this->add('select', 'contribution_status_id', ts('Payment Status'),
362 CRM_Contribute_BAO_Contribution_Utils
::getContributionStatuses('membership')
365 $this->add('text', 'check_number', ts('Check Number'),
366 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
370 $this->add('text', 'total_amount', ts('Amount'));
371 $this->addRule('total_amount', ts('Please enter a valid amount.'), 'money');
373 $this->addElement('checkbox', 'send_receipt', ts('Send Confirmation and Receipt?'), NULL,
374 ['onclick' => "showHideByValue( 'send_receipt', '', 'notice', 'table-row', 'radio', false ); showHideByValue( 'send_receipt', '', 'fromEmail', 'table-row', 'radio',false);"]
377 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
379 $this->add('textarea', 'receipt_text_renewal', ts('Renewal Message'));
381 // Retrieve the name and email of the contact - this will be the TO for receipt email
382 list($this->_contributorDisplayName
,
383 $this->_contributorEmail
384 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
385 $this->assign('email', $this->_contributorEmail
);
386 // The member form uses emailExists. Assigning both while we transition / synchronise.
387 $this->assign('emailExists', $this->_contributorEmail
);
389 $mailingInfo = Civi
::settings()->get('mailing_backend');
390 $this->assign('outBound_option', $mailingInfo['outBound_option']);
392 if (CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'contribution_recur_id')) {
393 if (CRM_Member_BAO_Membership
::isCancelSubscriptionSupported($this->_id
)) {
394 $this->assign('cancelAutoRenew',
395 CRM_Utils_System
::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
399 $this->addFormRule(['CRM_Member_Form_MembershipRenewal', 'formRule'], $this);
400 $this->addElement('checkbox', 'is_different_contribution_contact', ts('Record Payment from a Different Contact?'));
401 $this->addSelect('soft_credit_type_id', ['entity' => 'contribution_soft']);
402 $this->addEntityRef('soft_credit_contact_id', ts('Payment From'), ['create' => TRUE]);
408 * @param array $params
409 * (ref.) an assoc array of name/value pairs.
414 * mixed true or array of errors
415 * @throws \CRM_Core_Exception
417 public static function formRule($params, $files, $self) {
419 if ($params['membership_type_id'][0] == 0) {
420 $errors['membership_type_id'] = ts('Oops. It looks like you are trying to change the membership type while renewing the membership. Please click the "change membership type" link, and select a Membership Organization.');
422 if ($params['membership_type_id'][1] == 0) {
423 $errors['membership_type_id'] = ts('Oops. It looks like you are trying to change the membership type while renewing the membership. Please click the "change membership type" link and select a Membership Type from the list.');
427 // Get the Join Date from Membership info as it is not available in the Renewal form
428 $joinDate = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $self->_id
, 'join_date');
430 // CRM-20571: Check if the renewal date is not before Join Date, if it is then add to 'errors' array
431 // The fields in Renewal form come into this routine in $params array. 'renewal_date' is in the form
432 // We process both the dates before comparison using CRM utils so that they are in same date format
433 if (isset($params['renewal_date'])) {
434 if ($params['renewal_date'] < $joinDate) {
435 $errors['renewal_date'] = ts('Renewal date must be the same or later than Member since (Join Date).');
439 //total amount condition arise when membership type having no
441 if (isset($params['record_contribution'])) {
442 if (!$params['financial_type_id']) {
443 $errors['financial_type_id'] = ts('Please select a Financial Type.');
445 if (!$params['total_amount']) {
446 $errors['total_amount'] = ts('Please enter a Contribution Amount.');
448 if (empty($params['payment_instrument_id'])) {
449 $errors['payment_instrument_id'] = ts('Payment Method is a required field.');
452 return empty($errors) ?
TRUE : $errors;
456 * Process the renewal form.
458 * @throws \CRM_Core_Exception
459 * @throws \CiviCRM_API3_Exception
461 public function postProcess() {
462 // get the submitted form values.
463 $this->_params
= $this->controller
->exportValues($this->_name
);
464 $this->assignBillingName();
468 $this->setRenewalMessage();
470 catch (\Civi\Payment\Exception\PaymentProcessorException
$e) {
471 CRM_Core_Session
::singleton()->setStatus($e->getMessage());
472 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/membership',
473 "reset=1&action=renew&cid={$this->_contactID}&id={$this->_id}&context=membership&mode={$this->_mode}"
479 * Process form submission.
481 * This function is also accessed by a unit test.
483 * @throws \CRM_Core_Exception
484 * @throws \CiviCRM_API3_Exception
486 protected function submit() {
487 $this->storeContactFields($this->_params
);
488 $this->beginPostProcess();
489 $now = CRM_Utils_Date
::getToday(NULL, 'YmdHis');
490 $this->assign('receive_date', CRM_Utils_Array
::value('receive_date', $this->_params
, date('Y-m-d H:i:s')));
491 $this->processBillingAddress();
493 $this->_params
['total_amount'] = CRM_Utils_Array
::value('total_amount', $this->_params
,
494 CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType
, 'minimum_fee')
496 $this->_membershipId
= $this->_id
;
497 $customFieldsFormatted = CRM_Core_BAO_CustomField
::postProcess($this->_params
,
501 if (empty($this->_params
['financial_type_id'])) {
502 $this->_params
['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $this->_memType
, 'financial_type_id');
504 $contributionRecurID = NULL;
505 $this->assign('membershipID', $this->_id
);
506 $this->assign('contactID', $this->_contactID
);
507 $this->assign('module', 'Membership');
508 $this->assign('receiptType', 'membership renewal');
509 $this->_params
['currencyID'] = CRM_Core_Config
::singleton()->defaultCurrency
;
510 $this->_params
['invoice_id'] = $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
512 if (!empty($this->_params
['send_receipt'])) {
513 $this->_params
['receipt_date'] = $now;
514 $this->assign('receipt_date', CRM_Utils_Date
::mysqlToIso($this->_params
['receipt_date']));
517 $this->_params
['receipt_date'] = NULL;
521 $this->_params
['register_date'] = $now;
522 $this->_params
['description'] = ts("Contribution submitted by a staff person using member's credit card for renewal");
523 $this->_params
['amount'] = $this->_params
['total_amount'];
524 $this->_params
['payment_instrument_id'] = $this->_paymentProcessor
['payment_instrument_id'];
525 $this->_params
['receive_date'] = $now;
527 // at this point we've created a contact and stored its address etc
528 // all the payment processors expect the name and address to be in the passed params
529 // so we copy stuff over to first_name etc.
530 $paymentParams = $this->_params
;
531 if (!empty($this->_params
['send_receipt'])) {
532 $paymentParams['email'] = $this->_contributorEmail
;
535 $paymentParams['contactID'] = $this->_contributorContactID
;
537 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
539 if (!empty($this->_params
['auto_renew'])) {
541 $contributionRecurParams = $this->processRecurringContribution([
542 'contact_id' => $this->_contributorContactID
,
543 'amount' => $this->_params
['total_amount'],
544 'contribution_status_id' => 'Pending',
545 'payment_processor_id' => $this->_params
['payment_processor_id'],
546 'financial_type_id' => $this->_params
['financial_type_id'],
547 'is_email_receipt' => !empty($this->_params
['send_receipt']),
548 'payment_instrument_id' => $this->_params
['payment_instrument_id'],
549 'invoice_id' => $this->_params
['invoice_id'],
550 ], $paymentParams['membership_type_id'][1]);
552 $contributionRecurID = $contributionRecurParams['contributionRecurID'];
553 $paymentParams = array_merge($paymentParams, $contributionRecurParams);
556 $payment = $this->_paymentProcessor
['object'];
557 $result = $payment->doPayment($paymentParams);
558 $this->_params
= array_merge($this->_params
, $result);
560 $this->_params
['contribution_status_id'] = $result['payment_status_id'];
561 $this->_params
['trxn_id'] = $result['trxn_id'];
562 $this->_params
['is_test'] = ($this->_mode
=== 'live') ?
0 : 1;
563 $this->set('params', $this->_params
);
564 $this->assign('trxn_id', $result['trxn_id']);
567 $renewalDate = !empty($this->_params
['renewal_date']) ?
$renewalDate = $this->_params
['renewal_date'] : NULL;
569 // chk for renewal for multiple terms CRM-8750
571 if (is_numeric(CRM_Utils_Array
::value('num_terms', $this->_params
))) {
572 $numRenewTerms = $this->_params
['num_terms'];
575 //if contribution status is pending then set pay later
576 $this->_params
['is_pay_later'] = FALSE;
577 if ($this->_params
['contribution_status_id'] == array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'label'))) {
578 $this->_params
['is_pay_later'] = 1;
581 $pending = ($this->_params
['contribution_status_id'] == CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending'));
583 $membershipParams = [
584 'id' => $this->_membershipId
,
585 'membership_type_id' => $this->_params
['membership_type_id'][1],
586 'modified_id' => $this->_contactID
,
587 'custom' => $customFieldsFormatted,
588 'membership_activity_status' => ($pending ||
$this->_params
['is_pay_later']) ?
'Scheduled' : 'Completed',
589 // Since we are renewing, make status override false.
590 'is_override' => FALSE,
592 if ($contributionRecurID) {
593 $membershipParams['contribution_recur_id'] = $contributionRecurID;
595 $membership = $this->processMembership($membershipParams, $renewalDate, $numRenewTerms, $pending);
597 if (!empty($this->_params
['record_contribution']) ||
$this->_mode
) {
599 [$userName] = CRM_Contact_BAO_Contact_Location
::getEmailDetails(CRM_Core_Session
::singleton()->get('userID'));
600 $this->membershipTypeName
= CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $membership->membership_type_id
,
602 $this->_params
['contribution_source'] = "{$this->membershipTypeName} Membership: Offline membership renewal (by {$userName})";
605 $this->_params
= $this->setPriceSetParameters($this->_params
);
607 $this->_params
= array_merge($this->_params
, $this->getOrderParams());
609 //assign contribution contact id to the field expected by recordMembershipContribution
610 if ($this->_contributorContactID
!= $this->_contactID
) {
611 $this->_params
['contribution_contact_id'] = $this->_contributorContactID
;
612 if (!empty($this->_params
['soft_credit_type_id'])) {
613 $this->_params
['soft_credit'] = [
614 'soft_credit_type_id' => $this->_params
['soft_credit_type_id'],
615 'contact_id' => $this->_contactID
,
619 $this->_params
['contact_id'] = $this->_contactID
;
620 //recordMembershipContribution receives params as a reference & adds one variable. This is
621 // not a great pattern & ideally it would not receive as a reference. We assign our params as a
622 // temporary variable to avoid e-notice & to make it clear to future refactorer that
623 // this function is NOT reliant on that var being set
624 $temporaryParams = array_merge($this->_params
, [
625 'membership_id' => $membership->id
,
626 'contribution_recur_id' => $contributionRecurID,
628 CRM_Member_BAO_Membership
::recordMembershipContribution($temporaryParams);
631 if (!empty($this->_params
['send_receipt'])) {
632 $this->sendReceipt($membership);
639 * @param array $membership
641 * @throws \CRM_Core_Exception
643 protected function sendReceipt($membership) {
644 $receiptFrom = $this->_params
['from_email_address'];
646 if (!empty($this->_params
['payment_instrument_id'])) {
647 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
648 $this->_params
['paidBy'] = $paymentInstrument[$this->_params
['payment_instrument_id']];
651 $this->_groupTree
= CRM_Core_BAO_CustomGroup
::getTree('Membership', NULL, $this->_id
, FALSE, $this->_memType
);
653 // retrieve custom data
654 $customFields = $customValues = $fo = [];
655 foreach ($this->_groupTree
as $groupID => $group) {
656 if ($groupID === 'info') {
659 foreach ($group['fields'] as $k => $field) {
660 $field['title'] = $field['label'];
661 $customFields["custom_{$k}"] = $field;
664 $members = [['member_id', '=', $this->_membershipId
, 0, 0]];
665 // check whether its a test drive
666 if ($this->_mode
=== 'test') {
667 $members[] = ['member_test', '=', 1, 0, 0];
669 CRM_Core_BAO_UFGroup
::getValues($this->_contactID
, $customFields, $customValues, FALSE, $members);
671 $this->assign_by_ref('formValues', $this->_params
);
672 if (!empty($this->_params
['contribution_id'])) {
673 $this->assign('contributionID', $this->_params
['contribution_id']);
676 $this->assign('membership_name', CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
677 $membership->membership_type_id
679 $this->assign('customValues', $customValues);
680 $this->assign('mem_start_date', CRM_Utils_Date
::formatDateOnlyLong($membership->start_date
));
681 $this->assign('mem_end_date', CRM_Utils_Date
::formatDateOnlyLong($membership->end_date
));
683 $this->assign('address', CRM_Utils_Address
::getFormattedBillingAddressFieldsFromParameters(
687 $this->assign('contributeMode', 'direct');
688 $this->assign('isAmountzero', 0);
689 $this->assign('is_pay_later', 0);
690 $this->assign('isPrimary', 1);
691 $this->assign('receipt_text_renewal', $this->_params
['receipt_text']);
692 if ($this->_mode
=== 'test') {
693 $this->assign('action', '1024');
697 list($this->isMailSent
) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
699 'groupName' => 'msg_tpl_workflow_membership',
700 'valueName' => 'membership_offline_receipt',
701 'contactId' => $this->_receiptContactId
,
702 'from' => $receiptFrom,
703 'toName' => $this->_contributorDisplayName
,
704 'toEmail' => $this->_contributorEmail
,
705 'isTest' => $this->_mode
=== 'test',
711 * Process membership.
713 * This is duplicated from the BAO class - on the basis that it's actually easier to divide & conquer when
714 * it comes to clearing up really bad code.
716 * @param array $memParams
717 * @param bool $changeToday
718 * @param $numRenewTerms
719 * @param bool $pending
721 * @return CRM_Member_BAO_Membership
722 * @throws \CRM_Core_Exception
723 * @throws \CiviCRM_API3_Exception
725 public function processMembership($memParams, $changeToday, $numRenewTerms, $pending) {
726 $allStatus = CRM_Member_PseudoConstant
::membershipStatus();
728 $currentMembership = civicrm_api3('Membership', 'getsingle', ['id' => $memParams['id']]);
730 // Do NOT do anything.
731 //1. membership with status : PENDING/CANCELLED (CRM-2395)
732 //2. Paylater/IPN renew. CRM-4556.
733 if ($pending ||
in_array($currentMembership['status_id'], [
734 array_search('Pending', $allStatus),
736 array_search('Cancelled', CRM_Member_PseudoConstant
::membershipStatus(NULL, " name = 'Cancelled' ", 'name', FALSE, TRUE)),
738 return CRM_Member_BAO_Membership
::create($memParams);
740 $memParams['join_date'] = date('Ymd', strtotime($currentMembership['join_date']));
741 $isMembershipCurrent = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipStatus', $currentMembership['status_id'], 'is_current_member');
743 // CRM-7297 Membership Upsell - calculate dates based on new membership type
744 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($currentMembership['id'],
746 $memParams['membership_type_id'],
749 $memParams = array_merge($memParams, [
750 'end_date' => $dates['end_date'] ??
NULL,
751 'start_date' => $isMembershipCurrent ?
$currentMembership['start_date'] : ($dates['start_date'] ??
NULL),
752 'log_start_date' => $dates['log_start_date'],
755 // Now Renew the membership
756 if ($isMembershipCurrent) {
757 // CURRENT Membership
758 if (!empty($currentMembership['id'])) {
759 $ids['membership'] = $currentMembership['id'];
763 // @todo stop passing $ids (membership and userId may be set by this point)
764 $membership = CRM_Member_BAO_Membership
::create($memParams, $ids);
766 // not sure why this statement is here, seems quite odd :( - Lobo: 12/26/2010
767 // related to: http://forum.civicrm.org/index.php/topic,11416.msg49072.html#msg49072
768 $membership->find(TRUE);