Add participant tokens to pdf task #21695

eileenmcnaughton · 2021-10-01T22:50:28Z

Overview

Add participant tokens to pdf task

Before

Only contact tokens available in pdf letter task

After

contact, domain, participant tokens available

Technical Details

I've got this working - but I'm gonna try to break it down a bit into some more PRs just to convince myself all the parts are correct.

Comments

@demeritcowboy this is on the pdf side - but the email side would wind up similar with the only difference being that I think on the email side we would have to check for enitty -specific tokens & if none then group by the contact id - ie 2 emails for a 2 contributions doesn't make sense if all the fields are identical.

civibot · 2021-10-01T22:50:30Z

(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 · 2021-10-02T04:39:39Z

Fatal error: Cannot make non static method CRM_Core_Form_Task::getContactIds() static in class CRM_Contact_Form_Task in /home/jenkins/bknix-dfl/build/core-21695-3no2/web/sites/all/modules/civicrm/CRM/Contact/Form/Task.php on line 21

colemanw · 2021-10-03T17:44:28Z

@eileenmcnaughton needs rebase

eileenmcnaughton · 2021-10-03T19:35:34Z

@colemanw done - fyi #21696 is a sub-pr of this

eileenmcnaughton · 2021-10-05T03:44:41Z

This PR is the last in the 'pdf tokens' strand of work - looking for someone to test so we can get it merged - maybe @magnolia61 ?

magnolia61 · 2021-10-05T06:04:54Z

I am glad to try and get this one tested as well.

Probably the cause is in my setup somewhere but I get
Fatal error: Allowed memory size of 536870912 bytes exhausted
I'll continue to test and keep you posted here.

magnolia61 · 2021-10-05T06:21:21Z

Result with pdf print/merge:

Same template but using scheduled reminders:

eileenmcnaughton · 2021-10-05T06:28:58Z

@magnolia61 that's not good - can you past your message template text in here & I'll try it too

magnolia61 · 2021-10-05T06:30:02Z

<h2><strong>PARTICIPANT CORE</strong></h2>

<table border="1" bordercolor="#ccc" cellpadding="5" cellspacing="0" style="border-collapse: collapse; width: 100%;">
	<tbody>
		<tr>
			<td width="30%">Participant Rol</td>
			<td width="30%">participant.role : label</td>
			<td width="30%">{participant.role_id:label}</td>
		</tr>
		<tr>
			<td width="30%"> </td>
			<td width="30%">participant.role : name</td>
			<td width="30%">{participant.role_id:name}</td>
		</tr>
		<tr>
			<td width="30%">Participant Status</td>
			<td width="30%">participant.status : label</td>
			<td width="30%">{participant.status_id:label}</td>
		</tr>
		<tr>
			<td width="30%"> </td>
			<td width="30%">participant.status : name</td>
			<td width="30%">{participant.status_id:name}</td>
		</tr>
		<tr>
			<td width="30%">Participant Register Date</td>
			<td width="30%">participant.register_date</td>
			<td width="30%">{participant.register_date}</td>
		</tr>
		<tr>
			<td width="30%"> </td>
			<td width="30%">participant.register_date short</td>
			<td width="30%">{participant.register_date|crmDate:"shortdate"}</td>
		</tr>
		<tr>
			<td width="30%">Participant Wachtijst</td>
			<td width="30%">participant.must_wait</td>
			<td width="30%">{participant.must_wait}</td>
		</tr>
		<tr>
			<td width="30%">Participant Is_Paylater</td>
			<td width="30%">participant.is_pay_later</td>
			<td width="30%">{participant.is_pay_later}</td>
		</tr>
		<tr>
			<td width="30%">Participant ID</td>
			<td width="30%">participant.participant_id</td>
			<td width="30%">{participant.id}</td>
		</tr>
		<tr>
			<td width="30%">Participant Source</td>
			<td width="30%">participant.source</td>
			<td width="30%">{participant.source}</td>
		</tr>
		<tr>
			<td width="30%">Participant Is Test</td>
			<td width="30%">participant.is_test:label</td>
			<td width="30%">{participant.is_test:label}</td>
		</tr>
		<tr>
			<td width="30%"> </td>
			<td width="30%"> </td>
			<td width="30%"> </td>
		</tr>
	</tbody>
</table>

magnolia61 · 2021-10-05T06:32:24Z

I am glad to try and get this one tested as well.

Probably the cause is in my setup somewhere but I get Fatal error: Allowed memory size of 536870912 bytes exhausted I'll continue to test and keep you posted here.

This error only happens when I include the {participant.balance} token

magnolia61 · 2021-10-05T06:35:17Z

Same for event core tokens:

eileenmcnaughton · 2021-10-05T06:36:13Z

@magnolia61 - I'll have to recheck this -will try to put something up after dinner

This simplifies the code to 'listtokens' across most of the pdf & email classes. The case tokens are a bit of a hold out as ideally we would have one function on CRM_Case_Form_Task which email & pdf would use but we are still getting to that point - see civicrm#21688

eileenmcnaughton · 2021-10-05T07:00:36Z

@magnolia61 I think I found it

magnolia61 · 2021-10-05T07:06:10Z

Yeah! For the participant core tokens your latest changes work!

and also for participant custom tokens:

the event tokens remain empty though:

eileenmcnaughton · 2021-10-05T08:32:48Z

@magnolia61 I think that last update might fix the event tokens

magnolia61 · 2021-10-05T09:34:45Z

@magnolia61 I think that last update might fix the event tokens

They still render empty with me...

eileenmcnaughton · 2021-10-05T09:40:13Z

@magnolia61 looks like I had a change locally that I thought was extraneous - but wasn't - just pushed it in

magnolia61 · 2021-10-05T09:46:25Z

Bingo! that was it. Now also rendering event core and custom tokens

(only issue now is the empty custom date field anomaly listed here: https://lab.civicrm.org/dev/core/-/issues/2891 but that is not pdf creation specific)

eileenmcnaughton · 2021-10-05T09:54:09Z

Thanks @magnolia61 - hopefully if tests pass this time this will be mergeable (@colemanw )

eileenmcnaughton · 2021-10-05T10:16:11Z

@magnolia61 I think I found the fix for your date token issue - I've pushed a fix in + a test (cross fingers this doesn't send me down another round of test-whackamole :-)

magnolia61 · 2021-10-05T10:19:52Z

@magnolia61 I think I found the fix for your date token issue - I've pushed a fix in + a test (cross fingers this doesn't send me down another round of test-whackamole :-)

You did it. Empty custom date fields do not mess up the other tokens anymore
(and the other stuff still works as well)

eileenmcnaughton · 2021-10-05T10:24:47Z

@magnolia61 Yay - depending how this goes with getting merged & the other ones on the path (#21706 #21705 & #21688 & #21676) I might have a go at squeezing in participant tokens for email before the rc is cut - there is a bit of a gotcha there though https://lab.civicrm.org/dev/core/-/issues/2862

magnolia61 · 2021-10-05T15:13:08Z

Test passed ✅

colemanw · 2021-10-05T15:22:22Z

Merging based on review from @magnolia61

eileenmcnaughton · 2021-10-05T18:42:19Z

yay - thanks for your work on this @magnolia61

civibot bot added the master label Oct 1, 2021

eileenmcnaughton force-pushed the submit branch 3 times, most recently from 8b46a40 to 8683eaf Compare October 1, 2021 23:23

eileenmcnaughton force-pushed the submit branch from 8683eaf to 879153c Compare October 2, 2021 05:13

This was referenced Oct 2, 2021

dev/core#348 Participant tokens on scheduled reminders #21666

Merged

dev/core#2650 switch contact.individual_prefix tokens to contact.prefix_id:label (former still works) #21705

Merged

eileenmcnaughton force-pushed the submit branch 2 times, most recently from d74fa78 to 3264a32 Compare October 3, 2021 07:08

eileenmcnaughton force-pushed the submit branch from 3264a32 to b285aef Compare October 3, 2021 19:34

eileenmcnaughton mentioned this pull request Oct 3, 2021

Use Case form for case email action #21688

Merged

eileenmcnaughton force-pushed the submit branch from b285aef to fb994be Compare October 5, 2021 06:59

eileenmcnaughton force-pushed the submit branch from fb994be to dc7176c Compare October 5, 2021 08:32

Add participant tokens to pdf letter task

c32592e

eileenmcnaughton force-pushed the submit branch from dc7176c to c32592e Compare October 5, 2021 09:39

Fix null token render bug

2a7cae6

eileenmcnaughton force-pushed the submit branch from 5d2bcbf to 2a7cae6 Compare October 5, 2021 10:21

colemanw merged commit 110dbc7 into civicrm:master Oct 5, 2021

colemanw deleted the submit branch October 5, 2021 15:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add participant tokens to pdf task #21695

Add participant tokens to pdf task #21695

eileenmcnaughton commented Oct 1, 2021

civibot bot commented Oct 1, 2021

eileenmcnaughton commented Oct 2, 2021

colemanw commented Oct 3, 2021

eileenmcnaughton commented Oct 3, 2021

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021

magnolia61 commented Oct 5, 2021 •

edited

Loading

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021

magnolia61 commented Oct 5, 2021

magnolia61 commented Oct 5, 2021 •

edited

Loading

eileenmcnaughton commented Oct 5, 2021

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021 •

edited

Loading

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021

eileenmcnaughton commented Oct 5, 2021

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021 •

edited

Loading

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021

colemanw commented Oct 5, 2021

eileenmcnaughton commented Oct 5, 2021

Add participant tokens to pdf task #21695

Add participant tokens to pdf task #21695

Conversation

eileenmcnaughton commented Oct 1, 2021

Overview

Before

After

Technical Details

Comments

civibot bot commented Oct 1, 2021

eileenmcnaughton commented Oct 2, 2021

colemanw commented Oct 3, 2021

eileenmcnaughton commented Oct 3, 2021

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021

magnolia61 commented Oct 5, 2021 • edited Loading

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021

magnolia61 commented Oct 5, 2021

magnolia61 commented Oct 5, 2021 • edited Loading

eileenmcnaughton commented Oct 5, 2021

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021 • edited Loading

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021

eileenmcnaughton commented Oct 5, 2021

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021 • edited Loading

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021

colemanw commented Oct 5, 2021

eileenmcnaughton commented Oct 5, 2021

magnolia61 commented Oct 5, 2021 •

edited

Loading

magnolia61 commented Oct 5, 2021 •

edited

Loading

magnolia61 commented Oct 5, 2021 •

edited

Loading

magnolia61 commented Oct 5, 2021 •

edited

Loading