dev/core#5578 Adding Recurring tokens to Contribution/Membership toke…

[shaneonabike]

Overview

As it stands there a few Recurring Contribution tokens that are either excluded or not added as tokens for Scheduled Reminders. In our case, we have a client who would (in a scheduled reminder) like to let people know when their payment will go through, which I think is pretty cool. Then I was also thinking that letting them know if there are failed attempts is a pretty good token to have as well.

• Next Scheduled Contribution Date
• Failure Count (to check and display something if it's true)
• Failure Retry Date

Example use-case

1. Setup a Scheduled Reminder
2. Set it for a Membership with a Auto-renewal
3. Add the appropriate tokens to indicate when the transaction will occur

Current behaviour

None of these tokens are available

Modifications made

Exposed the Next Schedule Date, Failure Count, and Failure Retry Date for both Contributions and Memberships.

I realized later that the last two are fairly important as well considering setting up automated messages on failures is pretty helpful at times (and something potentially my client would like).

At some point, someone might request that we also expose Installments because I could see that being a useful bit of information to report to people if they signed up for that.

[civibot]

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...

• If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
• A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
• A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
• If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
• Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
• A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
• To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
• For more information about contributing, see CONTRIBUTING.md.

Quick links for reviewers...

• ➡️ PR Demo site (can be rebuilt with the command test this please).
• 📖 Review standards
• 🗒️ Review template (brief or verbose)

➡️ Online demo of this PR 🔗

[civibot]

The issue associated with the Pull Request can be viewed at https://lab.civicrm.org/dev/core/-/issues/5578

[mattwire]

Hmm, I'm pretty sure you should be able to access recurring tokens automatically if the contribution/membership is linked to a recur. But I can't remember the syntax.

[mattwire]

Edit, at least for membership the relevant code is here: https://github.com/civicrm/civicrm-core/blob/master/CRM/Member/Tokens.php#L148

[shaneonabike]

@mattwire Take a look at the line just above

    $hiddenTokens = ['modified_date', 'create_date', 'trxn_id', 'invoice_id', 'is_test', 'payment_token_id', 'payment_processor_id', 'payment_instrument_id', 'cycle_day', 'installments', 'processor_id', 'next_sched_contribution_date', 'failure_count', 'failure_retry_date', 'auto_renew', 'is_email_receipt', 'contribution_status_id'];

It's indicating that it should crop those entries via hiddenTokens from being returned. My fix is to remove them from the hidden tokens thus allowing someone to select them as a token in the dropdown. Pretty simple fix with a nice impact.

[mattwire]

Ah, makes sense @shaneonabike . So there is some history here: #25563

I'm happy with this change but you need to fix tests to support the new tokens