dev/core#3962 Add 'boolean' as a filter for tokens

[eileenmcnaughton]

Overview

dev/core#3962 Add 'boolean' as a filter for tokens

Before

Per https://lab.civicrm.org/dev/core/-/issues/3962 it is very difficult to combine smarty with tokens in text/plain messages as appostrophes break our existing work-around of using `{if '{contact.first_name}'}{/if}'

After

New modifier added |boolean e.g `{if '{contact.first_name|boolean}'}{/if}'

Technical Details

I was originally going to use the shorter 'bool' on the basis bool is a well established shortening of boolean within code. But of course not everyone reading it is familiar with that, or English speaking. I decided that as usual the marginal benefits of using an abbreviation don't stack up compared with the advantage of using an actual word that most people will understand (even if they don't understand the syntax)

Comments

The PR is mostly tests :-)

[civibot]

No issue was found matching the number given in the pull request title. Please check the issue number.

[civibot]

(Standard links)

• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[eileenmcnaughton]

PR #24923: dev/core#3962 Add 'boolean'...

	No changes.
	GitHub pull request #24923 of commit 80f3f6c, no merge conflicts.
	CheckStyle: No warningsNo issues for 6 builds, i.e. since build: #52238Reference build: CiviCRM-Core-PR #52242
	Test Result (1 failure / +1)api_v3_JobTest.testCallUpdateGreetingCommaSeparatedParamsSuccess

PR #24923: dev/core#3962 Add 'boolean'...
No changes.
GitHub pull request #24923 of commit 80f3f6c, no merge conflicts.

CheckStyle: No warnings

No issues for 6 builds, i.e. since build: #52238
Reference build: CiviCRM-Core-PR #52242
Test Result (1 failure / +1)
api_v3_JobTest.testCallUpdateGreetingCommaSeparatedParamsSuccess

[eileenmcnaughton]

@demeritcowboy I finally fought test hell on this - are you OK to merge it? Good test to code ratio :-)

[demeritcowboy]

Good job fighting tests. I'll take a look later.
(To ponder: Why do we still support text format?)

[eileenmcnaughton]

@demeritcowboy for example greetings - ie "Dear Dave" not "Dear Dave" ( special characters are a better example)

[demeritcowboy]

Some minor r-tech thoughts:

• As per the comment at the top of the function this function is creeping towards looking like old-timey civi code.
• I can see some potential for this filter to be mis-used, but you can do that with anything.

r-doc:

• I don't see these filters documented anywhere but am maybe missing it. There's https://docs.civicrm.org/dev/en/latest/framework/token/ and https://docs.civicrm.org/user/en/latest/common-workflows/tokens-and-mail-merge/ and https://docs.civicrm.org/sysadmin/en/latest/upgrade/version-specific/#civicrm-543 but other than a brief mention of crmDate I don't see anywhere.