Deprecate calls to createCreditNoteId

createCreditNoteId is called from BAO_Contribution::add whenever the contribution
status is 'Cancelled' or 'Refunded.

A few lines later recordFinancialAccounts is called, so by the time recordFinancialAccounts is called
it is already set & the empty check will prevent these lines being hit.

All 4 places where updateFinancialAccounts are called in the
code are from recordFinancialAccounts.

Record financial accounts is called from Contribution Create & Payment create.

contribution.create does not rely on these lines to set the creditnote_id, as discussed.

In the BAO_Payment there are 2 scenarios
1) payment is positive
2) payment is negative - in this case recordRefundPayment is called.

It's logically OK for the code to  NOT to create a credit note when being called from payment.create
 because payment.create is NOT cancelling the contribution or refunding it and the funtion NEVER changes
 the contribution status to Refunded, Cancelled, Chargeback (those are 'business' statuses).

Payment.create updates contribution status to reflect a payment has been made - eg change from
Pending to partially paid or various payment-related-statuses to 'Completed'.

ie Payment.create is
- only adding payments (or refunds) to an order
- and the decision as to whether something is being credited back & warrants a credit note id or
whether the payment is being returned due to overpayment or other payment related concerns does
not belong in the payment code.

Payment create never changes contribution
status to Refunded, Cancelled or ChargeBack so the lines would never be hit from payment.create

This leaves us with the conclusion the lines are never hit. For safety/sanity we can deprectate them rather
than remove them by now. That way if the above analysis is wrong a test will fail.

Less likely (given financial test coverage) the deprecation notice will show up in the wild in the next few months.

(It's rather unclear how it DOES fit in since it feels like creditnote_id only applies if the entire
contribution is being refunded & really should be generated at the point at which, for example, the event
fees associated with it are changed - however, complaints to date about creditnote_id have all focussed
on performance issues, not logic issues

Merge pull request #15144 from JKingsnorth/copying-events-contribution-pages

Improvements to copying events and contribution pages

Merge pull request #15315 from MegaphoneJon/reporting-20

reporting-20: don't display soft credits by default when force=1

Merge pull request #15323 from elisseck/dev/core/1266

dev/core/1266 widget header tab next state to pcp tab

Merge pull request #15223 from seamuslee001/when_package_upgrade

Upgrade When package to the lastest version

Merge pull request #15472 from ejegg/contribStatusUpdate

dev/financial#72 Filter contribution status lists for batch creation and update

Merge pull request #15470 from ejegg/filterContribStatus

dev/financial#72 Filter contribution status dropdowns in search and report

Merge pull request #15458 from eileenmcnaughton/excetp

[REF] move definition of important values & retrieval outside payment…

Merge pull request #14919 from eileenmcnaughton/mem_review

[Membership-backoffice] Reduce reliance on multiple specific but confusing class variables

Merge pull request #15293 from ixiam/dev#issue-826

dev/core#826

Merge pull request #15421 from artfulrobot/queue-safety

Fix bug in SQL queue that can cause tasks to be run twice in a multiprocess environment

Merge pull request #15468 from aydun/add_order_reference

dev/financial#57 Add order_reference field

Merge pull request #15488 from eileenmcnaughton/fin_acc

[REF] Minor cleanup to determine taxterm with a helper function.

Merge pull request #15489 from eileenmcnaughton/credit_dep

[REF] Replace deprecated function call with a more readable alternative

Merge pull request #15490 from eileenmcnaughton/fn_ref

[REF] improve function signature on updateFinancialAccountsOnContributionStatusChange

[REF] improve function signature on updateFinancialAccountsOnContributionStatusChange

This private function is only called from one place. The conditional before it is called is
if ($context == 'changedStatus') {

Ergo $context is ALWAYS changedStatus when this function is called.

As a result I have removed context from the function signature & the if that checks it is
equal to 'changedStatus'

Replace deprecated function call with a more readable alternative

This adds a wrapper to getting financial accounts with the type. We could call the other directly but it's less
readable & requires the account name to be specified which feels like a look-up for devs

Minor cleanup to determine taxterm with a helper function.

Simple cleanup to reduce the lines of code and make it more greppable

Merge pull request #15476 from mattwire/paymentprocessorpay_typo

Fix typo in parameter description for PaymentProcessor.pay

Merge pull request #15482 from seamuslee001/fix_merge_array

Fixes an issue where the two arrays weren't always being merged correctly

Fix merge hook arrays

Fix typo in parameter description for PaymentProcessor.pay

Merge pull request #15474 from artfulrobot/fix-missing-contribution-charts

Fix missing/broken contribution charts

Merge pull request #15339 from seamuslee001/hook_before_boot

Do no invoke Hooks via UF unless container has been built or it is a …

Merge pull request #15473 from demeritcowboy/too-loopy

The loop doth process too much, methinks

Fix missing/broken contribution charts

Merge pull request #15442 from artfulrobot/fix-select2-height-followup-from-15403

Fix CSS for public select2 elements regardless of parent theme box-si…

be less loopy

dev/financial#72 Filter contribution status in create/update

Replacing pseudoconstant calls in batch creation/update using
CRM_Contribute_BAO_Contribution_Utils::getContributionStatuses().

This actually changes the list of options offered, but all the
ones it removes should probably already have been gone.

dev/financial#72 Filter contrib status search selects

Replacing pseudoConstant calls with BAO buildOptions in 'search'
context.

This commit is only intended to touch places where we are building
a list of options to offer to the user, not places where we are
displaying results.

In practice this doesn't remove any currently available statuses,
but now we can filter our the proposed 'Template' status.

Merge pull request #15232 from eileenmcnaughton/credit

Respect calling code passing in 'null'  for creditnote_id.

Reuse larger size more typical for public facing forms

Merge pull request #15322 from alifrumin/removePrintIcon

Remove Print Icon

Merge pull request #15373 from eileenmcnaughton/case_url_support

Extract contribution search functions to help with case search improvements

Respect calling code passing in 'null
 for creditnote_id.

The credit note code was implemented in core quite a while ago, before we were really pushing these things
out to extensions. It was implemented such that it iterates through all credit notes & has performance
implications in order to meet a use case that is not common to all.

Ideally we would move it to an extension, but short of that we can at least respect
calling code setting the value to 'null' in order to override it.

There is no precedent anywhere in our code for the BAO to deliberately override efforts by
calling code to null out a value & in this case it solves a performance problem too

Probably we should longer term simply have a hook

hook::getCreditNoteID() & more this function to an extension called by that hook

Merge pull request #15407 from mattwire/membershippayment_2

Further cleanup and clarification on MembershipPayment

Merge pull request #15291 from mattwire/formatpaymentparams_addccip

REF Move ipAddress and CC expiry date to prepareParamsForPaymentProcessor

Merge pull request #15469 from wmortada/patch-1

Update my organisation

Update my organisation

Merge pull request #15283 from christianwach/lab-1200-3

Restrict inactive Dashlet query to Dashlets in the current domain

dev/financial#57 Add order_reference field

Extract code for handling forced search

Merge pull request #15465 from eileenmcnaughton/dep_fn

[REF] remove call to deprecated function

Merge pull request #15462 from eileenmcnaughton/event_api

[REF] Fix typos and remove unused variables

Merge pull request #15456 from aydun/change_getTemplateContrib

dev/financial#72 Modify getTemplateContribution() to use is_template field

Merge pull request #15463 from eileenmcnaughton/status_fix

[REF] Improve signature on updateFinancialAccountsOnContributionStatusChange

[REF] remove call to deprecated function

getPartialPaymentType basically just calls CRM_Contribute_BAO_Contribution::getContributionBalance
& then returns the  balance in a different array key depending on the value.

This switches to calling it directly & completes the work of removing all calls to it & more heavily deprecating it

Merge pull request #15461 from civicrm/5.19

5.19

Merge pull request #15464 from seamuslee001/5.19

5.18.2 release notes

Fix typos and remove unused variables

Merge pull request #15448 from artfulrobot/replace-openflash-charts

Replace openflash charts with charts that work

Update release-notes.md

Update 5.18.2.md

Update release notes following recent merges

Update release notes for fix for dev/core#1269

Add in release notes for 5.18.2

Merge pull request #15460 from eileenmcnaughton/event_transact

[REF] Remove transaction as part of minor code cleanup

Change getTemplateContribution to prefer is_template contrib
Add test

Improve signature on updateFinancialAccountsOnContributionStatusChange

Merge pull request #15459 from eileenmcnaughton/event_clean

[ref] Simplify function signature as parameter is not used

Pass contact ID as param to executeQuery()

Tidy up charts code, including avoiding js error on tabular data view

[REF] Remove transaction.

@mattwire proposed moving this in
https://github.com/civicrm/civicrm-core/pull/15446/commits/8f76cfacf156cfbd11e280b9a86926e0a5082c27

However, I believe removing it is the correct action. The usefullness of transactions is to maintain integrity
by rolling back the creation of a bunch of related entities together if one fails.

However in this case it's not rolling back the contribution or participant record or non discount line items so
if it worked (which I doubt) it would reduce rather than increase db integrity

Make getTemplateContribution match is_test
- non-test recurs should only pick up non-test templates
- test recurs should only pick up test templates
Add test

Simplify function signature as parameter is not used

[REF] move definition of important values & retrieval outside payment-object 'if' clauses

The concepts of billingMode is deprecated - goal is not to have separate handling for each one

Merge pull request #15453 from eileenmcnaughton/import_campaign

dev/core#1285 import support for campaign_id (& other fields where it could be an id, a name or a label.

Merge pull request #15454 from demeritcowboy/custom-fieldspec-bao

dev/core#1305 - fieldspec bao not defined for custom fields

Merge pull request #15444 from civicrm/5.19

5.19

Convert getTemplateContribution to api4

dev/core#1305

dev/core#1285 import support for campaign_id (& other fields where it could be an id, a name or a label.

After digging into https://lab.civicrm.org/dev/core/issues/1285 it feels a little arguable what we should support but issues in
gitlab indicate there is at least some demand for id & label so it now will
- accept id if input matches an id
- accept name if input matches a name
- accept label if input matches a label.

This means for payment instrument it would accept '1', 'Check' or 'Cheque' (in that order if name were renamed).

This should apply to a few fields - payment instrument, constribution status & per the issue campaign
(on contribution). There are 'some' on membership too I think

WIP checkin

WIP: bar chart sort of working now

Pie and Bar charts working, with download in SVG and PNG links

oops remove accidental inclusion

remove accidentally included crap

remove 3d barchart as unnecessary (and unimplemented)

Merge pull request #15321 from yashodha/dev_1065

(dev/core#1065) Pledge in Edit mode needs to be shown consistently

Merge pull request #15443 from eileenmcnaughton/ex_merge

dev/core#1302 fix regression on exported when merging addresses with specified fields

Merge pull request #15433 from aydun/add_contribution_is_template

dev/financial#72 Add is_template field to contribution entity

 dev/core#1302 fix regression on merge export

Fix example

Merge pull request #15447 from seamuslee001/dev_core_1269

dev/core#1269 Add in fix for undefined index bao in parsePseudoConst…

Merge pull request #14891 from eileenmcnaughton/saved_search

[Code-quality] remove references to where_tables, where_clause

Merge pull request #15439 from eileenmcnaughton/ex_bug

dev/core#1293 Fix regression on  export filtering for postal address only

dev/core#1269 Add in fix for underfined index bao in parsePseudoConstantField for Import Parser

Add ipAddress and creditcard expiry date to prepareParamsForPaymentProcessor

Add is_template field to contribution entity
Update tests and examples

Merge pull request #15440 from eileenmcnaughton/ex_zero

dev/core#1293 Still output csv file on export, even if no rows are in it

Fix CSS for public select2 elements regardless of parent theme box-sizing

Merge pull request #15438 from demeritcowboy/emailprocessor-still-hungry-alt

dev/core#1270 - fix email processor dropping attachments - ALTERNATE

Merge pull request #15281 from mattwire/formatpaymentparams_useprepare

REF Use the new prepareParamsForPaymentProcessor function in more places

dev/core#1293 Fix regression on  export filtering for postal address only

Still output csv file, even if no rows are in it

Merge pull request #15425 from eileenmcnaughton/loc_clean

[NFC] minor simplification

Merge pull request #15418 from seamuslee001/frontend_contribution_page_title

Add in frontend_title field for Contribution Pages to allow site mana…

Fix queue code to use CiviCRM's version of what the time is, instead of server's.

fix email processor dropping attachments

[NFC] minor simplification

This just changes how return vars are handled to make it clearer that ONLY contact::Create
cares about location_block::create return values

Merge pull request #15434 from civicrm/5.19

5.19 to master

Merge pull request #15428 from greenpeace-cee/fix-status-check

Fix status check not rendering before 5.19 migrations

Merge pull request #15411 from systopia/dev_l10nx

Allow custom ts functions in extensions; defer custom ts calls until booted

Merge pull request #15430 from civicrm/5.19

5.19

Merge pull request #15412 from demeritcowboy/fly-backwards

Minor a_b/b_a mixup on case type edit screen