[REF] Extract logical functions from sendTemplate

[eileenmcnaughton]

Overview

[REF] Extract logical functions from sendTemplate

Before

Long chunk of code - hard to figure out the component parts

After

Component parts are in their own functions

Technical Details

This simply makes it clear what the main chunks of code are doing

Comments

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[eileenmcnaughton]

Looks like I made a mistake - on the bright side we now have a list of the 193 tests that provide cover for this function

api_v3_ContributionPageTest.testSubmitMembershipBlockIsSeparatePaymentPaymentProcessorNowChargesCorrectAmounts with data set #0
api_v3_ContributionPageTest.testSubmitMembershipBlockIsSeparatePaymentPaymentProcessorNowChargesCorrectAmounts with data set #1
api_v3_ContributionPageTest.testSubmitContributionPageWithPriceSet with data set #0
api_v3_ContributionPageTest.testSubmitContributionPageWithPriceSet with data set #1
api_v3_ContributionPageTest.testSubmitContributionPageWithPriceSetQuantity with data set #0
api_v3_ContributionPageTest.testSubmitContributionPageWithPriceSetQuantity with data set #1
api_v3_ContributionPageTest.testSubmit
api_v3_ContributionPageTest.testSubmitZeroDollar
api_v3_ContributionPageTest.testSubmitNewBillingNameData
api_v3_ContributionPageTest.testSubmitNewBillingNameDoNotOverwrite
api_v3_ContributionPageTest.testSubmitRecurMultiProcessorInstantPayment
api_v3_ContributionPageTest.testSubmitMembershipBlockNotSeparatePayment
api_v3_ContributionPageTest.testSubmitMembershipBlockNotSeparatePaymentProcessorInstantRenew
api_v3_ContributionPageTest.testSubmitMembershipBlockNotSeparatePaymentWithEmail
api_v3_ContributionPageTest.testSubmitMembershipBlockNotSeparatePaymentZeroDollarsWithEmail
api_v3_ContributionPageTest.testSubmitMembershipBlockIsSeparatePaymentPayLaterWithEmail
api_v3_ContributionPageTest.testSubmitMembershipBlockIsSeparatePayment
api_v3_ContributionPageTest.testSubmitMembershipBlockIsSeparatePaymentWithPayLater
api_v3_ContributionPageTest.testSubmitMembershipBlockIsSeparatePaymentWithEmail
api_v3_ContributionPageTest.testSubmitMembershipBlockIsSeparatePaymentZeroDollarsPayLaterWithEmail
api_v3_ContributionPageTest.testSubmitMembershipBlockTwoTypesIsSeparatePayment
api_v3_ContributionPageTest.testSubmitMembershipBlockIsSeparatePaymentPaymentProcessorNow
api_v3_ContributionPageTest.testSubmitMembershipPriceSetPaymentPaymentProcessorRecurInstantPaymentYear
api_v3_ContributionPageTest.testSubmitMembershipPriceSetPaymentPaymentProcessorRecurInstantPaymentMonth
api_v3_ContributionPageTest.testSubmitMembershipComplexNonPriceSetPaymentPaymentProcessorRecurInstantPayment
api_v3_ContributionPageTest.testSubmitMembershipPriceSetPaymentPaymentProcessorSeparatePaymentRecurInstantPayment
api_v3_ContributionPageTest.testSubmitMembershipPriceSetPaymentPaymentProcessorRecurDelayed
api_v3_ContributionPageTest.testSubmitMembershipIsSeparatePaymentNotRecur
api_v3_ContributionPageTest.testSubmitPledgePayment
api_v3_ContributionTest.testCheckTaxAmount with data set #0
api_v3_ContributionTest.testCheckTaxAmount with data set #1
api_v3_ContributionTest.testRepeatTransactionMembershipRenewContributionNotCompleted with data set #1
api_v3_ContributionTest.testRepeatTransactionMembershipRenewContributionNotCompleted with data set #2
api_v3_ContributionTest.testRepeatTransactionMembershipRenewContributionNotCompleted with data set #3
api_v3_ContributionTest.testRepeatTransactionMembershipRenewContributionNotCompleted with data set #5
api_v3_ContributionTest.testRepeatTransactionMembershipRenewContributionNotCompleted with data set #6
api_v3_ContributionTest.testRepeatTransactionMembershipRenewContributionNotCompleted with data set #8
api_v3_ContributionTest.testRepeatTransactionMembershipRenewContributionNotCompleted with data set #9
api_v3_ContributionTest.testRepeatTransactionMembershipRenewContributionNotCompleted with data set #10
api_v3_ContributionTest.testCompleteTransactionSetStatusToInProgress with data set #0
api_v3_ContributionTest.testCompleteTransactionSetStatusToInProgress with data set #1
api_v3_ContributionTest.testCompleteTransactionSetStatusToInProgress with data set #2
api_v3_ContributionTest.testCompleteTransactionSetStatusToInProgress with data set "receive_date_includes_time"
api_v3_ContributionTest.testRepeatTransactionUpdateNextSchedContributionDate with data set "receive_date_includes_time_with_installments"
api_v3_ContributionTest.testRepeatTransactionUpdateNextSchedContributionDate with data set "receive_date_includes_time_no_installments"
api_v3_ContributionTest.testCompleteTransaction
api_v3_ContributionTest.testCompleteTransactionEuro
api_v3_ContributionTest.testPayLater
api_v3_ContributionTest.testBillingAddress
api_v3_ContributionTest.testCompleteTransactionFeeAmount
api_v3_ContributionTest.testRepeatTransaction
api_v3_ContributionTest.testRepeatTransactionWithCustomData
api_v3_ContributionTest.testRepeatTransactionLineItems
api_v3_ContributionTest.testRepeatTransactionIsTest
api_v3_ContributionTest.testRepeatTransactionPassedInStatus
api_v3_ContributionTest.testRepeatTransactionAcceptRecurID
api_v3_ContributionTest.testRepeatTransactionTestRecurId
api_v3_ContributionTest.testRepeatTransactionMembershipRenewCompletedContribution
api_v3_ContributionTest.testRepeattransactionRenewMembershipOldMembership
api_v3_ContributionTest.testRepeatTransactionAlteredAmount
api_v3_ContributionTest.testRepeatTransactionPassedInFinancialType
api_v3_ContributionTest.testContributionOrder
api_v3_ContributionTest.testRepeatTransactionPassedInFinancialTypeTwoLineItems
api_v3_ContributionTest.testRepeatTransactionUpdatedFinancialType
api_v3_ContributionTest.testRepeatTransactionPassedInCampaign
api_v3_ContributionTest.testRepeatTransactionUpdatedCampaign
api_v3_ContributionTest.testRepeatTransactionUpdatedFinancialTypeAndNotEquals
api_v3_ContributionTest.testCompleteTransactionNetAmountOK
api_v3_ContributionTest.testCompleteTransactionWithReceiptDateSet
api_v3_ContributionTest.testCompleteTransactionForRecurring
api_v3_ContributionTest.testCompleteTransactionWithEmailReceiptInputTrue
api_v3_ContributionTest.testCompleteTransactionWithTestTemplate
api_v3_ContributionTest.testCompleteTransactionContributionPageFromAddress
api_v3_ContributionTest.testCompleteTransactionUpdatePledgePayment
api_v3_ContributionTest.testCompleteTransactionWithParticipantRecord
api_v3_ContributionTest.testCompleteTransactionMembershipPriceSetTwoTerms
api_v3_ContributionTest.testSendMail
api_v3_ContributionTest.testSendconfirmationPayLater
api_v3_ContributionTest.testSendMailEvent
api_v3_ContributionTest.testRepeatTransactionWithNonCreditCardDefault
api_v3_ContributionTest.testRepeatTransactionMembershipCreatePendingContribution
api_v3_ContributionTest.testSendMailWithAPISetFromDetails
api_v3_ContributionTest.testSendMailWithNoFromSetFallToDomain
api_v3_ContributionTest.testSendMailWithRepeatTransactionAPIFalltoDomain
api_v3_ContributionTest.testSendMailWithRepeatTransactionAPIFalltoContributionPage
api_v3_ContributionTest.testSendMailWithRepeatTransactionAPIFalltoSystemFromNoDefaultFrom
api_v3_ContributionTest.testRepeatTransactionWithDifferenceCurrency
api_v3_ContributionTest.testRepeatContributionWithTaxAmount
api_v3_ContributionTest.testPaymentDontChangeReceiveDate
api_v3_ContributionTest.testPaymentVerifyPaymentInstrumentChange
api_v3_MembershipTest.testMultipleMembershipContribution
api_v3_OrderTest.testCreateWithChainedPayment
api_v3_PaymentTest.testRefundEmailReceipt with data set #0
api_v3_PaymentTest.testRefundEmailReceipt with data set #1
api_v3_PaymentTest.testMultiplePaymentsForContribution
api_v3_PaymentTest.testPaymentSendContributionReceipt
api_v3_PaymentTest.testPaymentEmailReceipt
api_v3_PaymentTest.testPaymentEmailReceiptFullyPaid
api_v3_PaymentTest.testCreatePaymentNoLineItems
api_v3_PaymentTest.testCreatePaymentLineItems
api_v3_PaymentTest.testCreatePaymentPayLater
api_v3_PaymentTest.testCreatePaymentOnFailedContribution
api_v3_PaymentTest.testCreatePaymentPayLaterPartialPayment
api_v3_PaymentTest.testPaymentCreateTrxnIdAndDates
CRM_Activity_Form_ActivityTest.testActivityCreate
CRM_Contact_BAO_QueryTest.testGetSummaryQueryWithFinancialACLDisabled
CRM_Contact_BAO_QueryTest.testGetSummaryQueryWithFinancialACLEnabled
CRM_Contribute_BAO_ContributionRecurTest.testGetTemplateContributionNewTemplate
CRM_Contribute_BAO_ContributionRecurTest.testAutoRenewalWhenOneMemberIsDeceased
CRM_Contribute_BAO_ContributionTest.testAnnualWithMultipleLineItems
CRM_Contribute_BAO_ContributionTest.testSendMailUpdateReceiptDate
CRM_Contribute_BAO_ContributionTest.testCancelOrderWithPledge
CRM_Contribute_Form_Contribution_ConfirmTest.testPayNowPayment
CRM_Contribute_Form_Task_InvoiceTest.testInvoiceForDueDate
CRM_Contribute_Form_Task_InvoiceTest.testInvoiceForLineItems
CRM_Contribute_Form_Task_InvoiceTest.testThatInvoiceShowTheActuallContributionCurrencyInsteadOfTheDefaultOne
CRM_Contribute_Form_Task_StatusTest.testUpdatePendingContributionWithSendingEmail
CRM_Contribute_Form_AdditionalPaymentTest.testAddPaymentUsingCreditCardForPartiallyPaidContribution
CRM_Contribute_Form_AdditionalPaymentTest.testMultiplePaymentForPartiallyPaidContributionWithOneCreditCardPayment
CRM_Contribute_Form_AdditionalPaymentTest.testAddPaymentUsingCreditCardForPendingPayLaterContribution
CRM_Contribute_Form_ContributionTest.testReSubmitSaleTax with data set #0
CRM_Contribute_Form_ContributionTest.testReSubmitSaleTax with data set #1
CRM_Contribute_Form_ContributionTest.testReSubmitSaleTaxAlteredAmount with data set #0
CRM_Contribute_Form_ContributionTest.testReSubmitSaleTaxAlteredAmount with data set #1
CRM_Contribute_Form_ContributionTest.testSubmitCreditCardPayPal
CRM_Contribute_Form_ContributionTest.testSubmitCreditCardWithEmailReceipt
CRM_Contribute_Form_ContributionTest.testSubmitEmailReceipt
CRM_Contribute_Form_ContributionTest.testSubmitEmailReceiptUserEmailFromAddress
CRM_Contribute_Form_ContributionTest.testEmailReceiptOnPayLater
CRM_Contribute_Form_ContributionTest.testPremiumUpdate
CRM_Contribute_Form_ContributionTest.testPremiumUpdateCreditCard
CRM_Contribute_Form_ContributionTest.testSubmitWithPCP
CRM_Core_BAO_FinancialTrxnTest.testCreateDeferredTrxn
CRM_Core_BAO_MessageTemplateTest.testCaseActivityCopyTemplate
CRM_Core_Payment_AuthorizeNetIPNTest.testIPNPaymentRecurSuccess
CRM_Core_Payment_AuthorizeNetIPNTest.testIPNPaymentRecurSuccessMultiAuthNetProcessor
CRM_Core_Payment_AuthorizeNetIPNTest.testIPNPaymentRecurSuccessSuppliedReceiveDate
CRM_Core_Payment_AuthorizeNetIPNTest.testIPNPaymentMembershipRecurSuccess
CRM_Core_Payment_AuthorizeNetIPNTest.testIPNPaymentMembershipRecurSuccessNoLeakage
CRM_Core_Payment_AuthorizeNetIPNTest.testIPNPaymentMembershipRecurSuccessNoLeakageOnlineThenOffline
CRM_Core_Payment_BaseIPNTest.testSendMailMembershipObjects
CRM_Core_Payment_BaseIPNTest.testSendMailMembershipObjectsNoLeakage
CRM_Core_Payment_BaseIPNTest.testSendMailMembershipWithoutLoadObjects
CRM_Core_Payment_BaseIPNTest.testComposeMailParticipant
CRM_Core_Payment_BaseIPNTest.testComposeMailParticipantObjects
CRM_Core_Payment_BaseIPNTest.testSendMailParticipantObjectsCheckLog
CRM_Core_Payment_BaseIPNTest.testsendMailParticipantObjectsNoMail
CRM_Core_Payment_BaseIPNTest.testSendMailPledge
CRM_Core_Payment_PayPalIPNTest.testInvoiceSentOnIPNPaymentSuccess
CRM_Core_Payment_PayPalIPNTest.testIPNPaymentRecurSuccess
CRM_Core_Payment_PayPalIPNTest.testIPNPaymentMembershipRecurSuccess
CRM_Core_Payment_PayPalIPNTest.testIPNPaymentInputMembershipRecurSuccess
CRM_Core_Payment_PayPalIPNTest.testhookAlterIPNDataOnIPNPaymentSuccess
CRM_Core_Payment_PayPalIPNTest.testPayPalIPNSuccessDeletedContact
CRM_Core_Payment_PayPalProIPNTest.testIPNPaymentRecurSuccess
CRM_Core_Payment_PayPalProIPNTest.testIPNPaymentMembershipRecurSuccess
CRM_Core_Payment_PayPalProIPNTest.testIPNPaymentCRM13743
CRM_Event_BAO_AdditionalPaymentTest.testTransactionInfo
CRM_Event_BAO_ChangeFeeSelectionTest.testCRM19273
CRM_Event_BAO_ChangeFeeSelectionTest.testCRM20611
CRM_Event_BAO_ChangeFeeSelectionTest.testCRM17151
CRM_Event_BAO_ChangeFeeSelectionTest.testRefundWithFeeAmount0
CRM_Event_BAO_ChangeFeeSelectionTest.testPartialPaymentEntries
CRM_Event_BAO_ChangeFeeSelectionTest.testRefundPaymentEntries
CRM_Event_Form_Registration_ConfirmTest.testPaidSubmit with data set #0
CRM_Event_Form_Registration_ConfirmTest.testPaidSubmit with data set #1
CRM_Event_Form_Registration_ConfirmTest.testSubmit
CRM_Event_Form_Registration_ConfirmTest.testTaxMultipleParticipant
CRM_Event_Form_Registration_ConfirmTest.testOnlineRegNoPrice
CRM_Event_Form_Registration_ConfirmTest.testNoteSubmission
CRM_Event_Form_Task_BatchTest.testSubmitCancel
CRM_Event_Form_ParticipantTest.testSubmitWithPayment with data set #0
CRM_Event_Form_ParticipantTest.testSubmitWithPayment with data set #1
CRM_Event_Form_ParticipantTest.testParticipantOfflineReceipt with data set #0
CRM_Event_Form_ParticipantTest.testParticipantOfflineReceipt with data set #1
CRM_Event_Form_ParticipantTest.testSubmitPartialPayment with data set #0
CRM_Event_Form_ParticipantTest.testSubmitPartialPayment with data set #1
CRM_Event_Form_ParticipantTest.testSubmitPendingPartiallyPaidAddPayment with data set #0
CRM_Event_Form_ParticipantTest.testSubmitPendingPartiallyPaidAddPayment with data set #1
CRM_Event_Form_ParticipantTest.testSubmitPendingAddPayment with data set #0
CRM_Event_Form_ParticipantTest.testSubmitPendingAddPayment with data set #1
CRM_Event_Form_ParticipantTest.testPaymentAllocationOnMultiLineItemEvent
CRM_Event_Form_ParticipantTest.testTransferParticipantRegistration
CRM_Financial_Form_PaymentEditTest.testSubmitOnPaymentInstrumentChange
CRM_Financial_Form_PaymentFormsTest.testEventPaymentForms
CRM_Member_BAO_MembershipTest.testMembershipPaymentForSingleContributionMultipleMembership
CRM_Member_Form_MembershipRenewalTest.testSubmitRecurCompleteInstantWithMail with data set #0
CRM_Member_Form_MembershipRenewalTest.testSubmitRecurCompleteInstantWithMail with data set #1
CRM_Member_Form_MembershipRenewalTest.testSubmitRecur
CRM_Member_Form_MembershipRenewalTest.testSubmitRenewExpired
CRM_Member_Form_MembershipTest.testSubmit with data set #0
CRM_Member_Form_MembershipTest.testSubmit with data set #1
CRM_Member_Form_MembershipTest.testSubmitRecurCompleteInstant

[eileenmcnaughton]

thanks @mattwire