[REF] Prelminary tidy up to support fix for dev/core#2344

[eileenmcnaughton]

Overview

This is all the formatting, doc block & test support fixes to support my fix for the regression https://lab.civicrm.org/dev/core/-/issues/2344 - that patch is a bit of reading so splitting this off

It should all be NFC - the key change is better test support for when pdfs or docs
are generated - we now throw an exception that can be handled in the test.

Before

Tests need to pass in 'is_unit_test' & we use weird return

After

Our preferred method is used - ie throwing a prematureExitException which the tests can catch

• use of [] rather than list[] formatting (this happens every time I save so getting it merged first helps keep things sane) and minor test cleanups

Technical Details

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]

@seamuslee001 what do you think the test issue is?

[seamuslee001]

Jenkins re test this please

[eileenmcnaughton]

The test stuff was causing other problems so this really is just the nfc changes to help keep the code in order - trying to figure out how to proceed with the tests....