dev/core#893 - fix misfiled case print/merge pdfs (alternate to PR 15609/15364)

[demeritcowboy]

Overview

This is the mostly the same as #15609 and the intent of #15364 but with some cleanup and a unit test.
@ray-wright @mattwire

Before

When doing a pdf document merge on case search results, if the order of the case ids as passed in from search results differed from the order that mysql naturally returns internally, the documents get filed incorrectly. See lab ticket and other PR for more detail.

After

Filed properly.

Technical Details

As discussed at #15364 (comment), this takes a step towards removing a static function with parameters and instead using the CRM_Core_Form_Task base class and overriding variables in the subclass. Also allowing for component-specific ordering where needed.

The copied function getContactIDsFromComponent() is exactly the same as the one from CRM_Core_DAO except for lines 244 and 250 where the $orderBy is used.

Comments

If you comment out the orderBy function in Case/Form/Task.php so that it functions the same as it was before without ordering and run the test, it shows how the contact ids didn't match up to case_ids.

[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]

I'll let others weigh in / test but the code approach looks sensible & I don't see any red flags

[ray-wright]

Just tested and this works - PDFs are filed on the proper case including the proper "with" contact. Thank you all for all your help working through this fix!

[demeritcowboy]

Thanks @ray-wright for testing and for working out the issue/patch.

[seamuslee001]

Merging based on the r-run of @ray-wright and @eileenmcnaughton 's code review