WIP Minor cleanup of Membership/Renewal form classes #12651
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -489,7 +489,6 @@ public function postProcess() { | |
| protected function submit() { | ||
| $this->storeContactFields($this->_params); | ||
| $this->beginPostProcess(); | ||
| $this->convertDateFieldsToMySQL($this->_params); | ||
| $this->assign('receive_date', $this->_params['receive_date']); | ||
| $this->processBillingAddress(); | ||
|
|
@@ -514,15 +513,15 @@ protected function submit() { | |
| $this->_params['invoice_id'] = $this->_params['invoiceID'] = md5(uniqid(rand(), TRUE)); | ||
|
|
||
| if (!empty($this->_params['send_receipt'])) { | ||
| $this->_params['receipt_date'] = date('YmdHis'); | ||
| $this->assign('receipt_date', CRM_Utils_Date::mysqlToIso($this->_params['receipt_date'])); | ||
| } | ||
| else { | ||
| $this->_params['receipt_date'] = NULL; | ||
| } | ||
|
|
||
| if ($this->_mode) { | ||
| $this->_params['register_date'] = date('YmdHis'); | ||
| $this->_params['description'] = ts("Contribution submitted by a staff person using member's credit card for renewal"); | ||
| $this->_params['amount'] = $this->_params['total_amount']; | ||
| $this->_params['payment_instrument_id'] = $this->_paymentProcessor['payment_instrument_id']; | ||
|
|
@@ -570,49 +569,56 @@ protected function submit() { | |
| } | ||
|
|
||
| //if contribution status is pending then set pay later | ||
| $pendingContributionStatusId = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending'); | ||
| $this->_params['is_pay_later'] = FALSE; | ||
| if ($this->_params['contribution_status_id'] == $pendingContributionStatusId) { | ||
| $this->_params['is_pay_later'] = 1; | ||
| } | ||
|
|
||
| // These variable sets prior to membership may not be required for this form. They were in | ||
| // a function this form shared with other forms. | ||
| $membershipSource = NULL; | ||
| if (!empty($this->_params['membership_source'])) { | ||
| $membershipSource = $this->_params['membership_source']; | ||
| } | ||
|
|
||
| $isPending = ($this->_params['contribution_status_id'] == $pendingContributionStatusId) ? TRUE : FALSE; | ||
|
|
||
|
There was a problem hiding this comment. This variable renaming is causing a lot of noise & would be better done before or after the other changes IMHO (I'm not 100% sure it's better TBH, although I see renew !== renewed which I would be more keen on) There was a problem hiding this comment. Yes, I'll update. I figured that it would be easier to merge Membership/MembershipRenewal forms in the future if the variable names match - and $renewMembership is a membership array that is not necessarily a renewal. There was a problem hiding this comment. Rename now in #12798 |
||
| list($membership) = CRM_Member_BAO_Membership::processMembership( | ||
| $this->_contactID, $this->_params['membership_type_id'][1], $isTestMembership, | ||
| $renewalDate, NULL, $customFieldsFormatted, $numRenewTerms, $this->_membershipId, | ||
| $isPending, | ||
| $contributionRecurID, $membershipSource, $this->_params['is_pay_later'], CRM_Utils_Array::value('campaign_id', | ||
| $this->_params) | ||
| ); | ||
|
|
||
| $this->endDate = CRM_Utils_Date::processDate($membership->end_date); | ||
|
|
||
| $this->membershipTypeName = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $membership->membership_type_id, | ||
| 'name'); | ||
|
|
||
| if (!empty($this->_params['record_contribution']) || $this->_mode) { | ||
| $this->_params['contribution_source'] = ts('%1 Membership: Offline membership renewal (by %2)', array( | ||
| 1 => $this->membershipTypeName, | ||
| 2 => $userName, | ||
| )); | ||
|
|
||
| //create line items | ||
| $lineItem = array(); | ||
| $this->_params = $this->setPriceSetParameters($this->_params); | ||
| CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'], | ||
| $this->_params, $lineItem[$this->_priceSetId], NULL, $this->_priceSetId | ||
| ); | ||
|
|
||
| if (!empty($lineItem[$this->_priceSetId])) { | ||
| $submittedFinancialType = CRM_Utils_Array::value('financial_type_id', $this->_params); | ||
| foreach ($lineItem[$this->_priceSetId] as &$li) { | ||
| //CRM-11529 for quick config backoffice transactions | ||
| //when financial_type_id is passed in form, update the | ||
| //line items with the financial type selected in form | ||
| if ($submittedFinancialType) { | ||
| $li['financial_type_id'] = $submittedFinancialType; | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -637,7 +643,7 @@ protected function submit() { | |
| // temporary variable to avoid e-notice & to make it clear to future refactorer that | ||
| // this function is NOT reliant on that var being set | ||
| $temporaryParams = array_merge($this->_params, array( | ||
| 'membership_id' => $membership->id, | ||
| 'contribution_recur_id' => $contributionRecurID, | ||
| )); | ||
| //Remove `tax_amount` if it is not calculated. | ||
|
|
@@ -648,72 +654,88 @@ protected function submit() { | |
| } | ||
|
|
||
| if (!empty($this->_params['send_receipt'])) { | ||
| self::emailReceipt($this, $this->_params, $membership); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Send email receipt. | ||
| * @deprecated | ||
| * TODO: Use CRM_Member_Form_Membership::emailReceipt instead | ||
| * | ||
| * @param CRM_Core_Form $form | ||
| * Form object. | ||
| * @param array $formValues | ||
| * @param object $membership | ||
| * Object. | ||
| * | ||
| * @return bool | ||
| * true if mail was sent successfully | ||
| */ | ||
| public static function emailReceipt(&$form, &$formValues, &$membership) { | ||
| $receiptFrom = $form->_params['from_email_address']; | ||
|
|
||
| if (!empty($form->_params['payment_instrument_id'])) { | ||
| $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument(); | ||
| $form->_params['paidBy'] = $paymentInstrument[$form->_params['payment_instrument_id']]; | ||
| } | ||
| //get the group Tree | ||
| $form->_groupTree = CRM_Core_BAO_CustomGroup::getTree('Membership', NULL, $form->_id, FALSE, $form->_memType); | ||
|
|
||
| // retrieve custom data | ||
| $customFields = $customValues = $fo = array(); | ||
| foreach ($form->_groupTree as $groupID => $group) { | ||
| if ($groupID == 'info') { | ||
| continue; | ||
| } | ||
| foreach ($group['fields'] as $k => $field) { | ||
| $field['title'] = $field['label']; | ||
| $customFields["custom_{$k}"] = $field; | ||
| } | ||
| } | ||
| $members = array(array('member_id', '=', $form->_membershipId, 0, 0)); | ||
| // check whether its a test drive | ||
| if ($form->_mode == 'test') { | ||
| $members[] = array('member_test', '=', 1, 0, 0); | ||
| } | ||
| CRM_Core_BAO_UFGroup::getValues($form->_contactID, $customFields, $customValues, FALSE, $members); | ||
|
|
||
| $form->assign_by_ref('formValues', $form->_params); | ||
| if (!empty($form->_params['contribution_id'])) { | ||
| $form->assign('contributionID', $form->_params['contribution_id']); | ||
| } | ||
|
|
||
| $form->assign('membership_name', CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', | ||
| $membership->membership_type_id | ||
| )); | ||
| $form->assign('customValues', $customValues); | ||
| $form->assign('mem_start_date', CRM_Utils_Date::customFormat($membership->start_date)); | ||
| $form->assign('mem_end_date', CRM_Utils_Date::customFormat($membership->end_date)); | ||
| if ($form->_mode) { | ||
| $form->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters( | ||
| $form->_params, | ||
| $form->_bltID | ||
| )); | ||
| $form->assign('contributeMode', 'direct'); | ||
| $form->assign('isAmountzero', 0); | ||
| $form->assign('is_pay_later', 0); | ||
| $form->assign('isPrimary', 1); | ||
| $form->assign('receipt_text_renewal', $form->_params['receipt_text']); | ||
| if ($form->_mode == 'test') { | ||
| $form->assign('action', '1024'); | ||
| } | ||
| } | ||
|
|
||
| list($form->isMailSent) = CRM_Core_BAO_MessageTemplate::sendTemplate( | ||
| array( | ||
| 'groupName' => 'msg_tpl_workflow_membership', | ||
| 'valueName' => 'membership_offline_receipt', | ||
| 'contactId' => $form->_receiptContactId, | ||
| 'from' => $receiptFrom, | ||
| 'toName' => $form->_contributorDisplayName, | ||
| 'toEmail' => $form->_contributorEmail, | ||
| 'isTest' => $form->_mode == 'test', | ||
| ) | ||
| ); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mattwire the other is merged & this can be rebased. I've checked all the changes down to this line so far & am OK with them so if you pull those into one PR I can merge that quickly