CRM-16734 participant tokens in participant pdf

[johanv]

Continued @mallezie's work for CRM-16734 (participant tokens in PDF letters for participants). This pull request is a continuation of #8258, which provides event tokens for PDF letters to participants (CRM-16599). Now you can create PDF letters like this:

Hi {contact.first_name},

This is your letter. You subscribed for {event.title}; the event fee amount was {participant.participant_fee_amount}.

---

• CRM-16734: Add participant tokens to participant pdf action
• CRM-16599: Add event tokens to participant pdf creation

[agh1]

There is no key participant_id in the $params array.

[agh1]

Thanks @johanv and @mallezie for all of this. This looks super-promising.

Unfortunately, it has some buggy things that should be worked out. I'm happy to help with these, but I don't think this will be ready to go for 4.7.8. Some things to address:

• The {participant.participant_status_id} token gives you an integer, and there's no way to get the actual role label.
• The {participant.participant_register_date} token is in the format YYYY-MM-DD HH:MM:SS. While different people might want different formats, that is probably the one format that nobody wants.
• {participant.participant_fee_amount} could be combined with {participant.currency}, but CiviCRM has better ways to localize the amount. Currently, the token just gives you a number.
• {event.location} is presented all in one line. I wonder if this could be broken into multiple tokens.
• {event.fee_amount} is blank, at least in all of my examples. I notice a comment that it was removed: I wonder if it just needs to be excluded from the tokens list.
• {event.balance} causes a fatal error (due to the issue in the note above). Anyway, the balance will be per-participant.
• The miscellaneous small things in the inline notes should be resolved.

Looking through this, I feel like this and other token use cases need test coverage. It doesn't appear that there's anything at the moment.

[agh1]

One separate note: I don't think this has anything to do with this issue, but I was getting an error trying to generate a PDF at all because vendor/dompdf/dompdf/lib/html5lib/Parser.php requires vendor/dompdf/dompdf/lib/html5lib/TreeBuilder.php, but TreeBuilder.php is deleted in tools/scripts/composer/dompdf-cleanup.sh. Commenting out the line in Parser.php that requires TreeBuilder.php makes everything work just fine, however.

[totten]

@agh1 @xurizaemon - the TreeBuilder.php comment seems like a recent regression from #7991. Since it's tangential to this PR, suggest any further follow-up on TreeBuilder.php be on proposed fix #8419.

[eileenmcnaughton]

@agh1 Can you check this again?

[jitendrapurohit]

While working on QA for this PR, I found some minor issues related to the above changes after the update-

1. Use of participant.role, participant.role_id tokens is displayed as Array and not the values for it.
2. The {participant.participant_status_id} token gives you an integer. It should actually display as label.
3. participant.transferred_to_contact_id token doesn't seem to be working.
4. event.fee_amount is blank as @agh1 mentioned.
5. Found some set of e-notices - http://goo.gl/iD1C8P

[johanv]

I will look at @jitendrapurohit 's comments, probably next week, but i will do some cleanup in this code first.

[eileenmcnaughton]

It would be great if you would do a rebase -i on this & squash some patches

[johanv]

This PR is replaced by #9038.