Fix display of pay later instructions on thankyou and skipping when payment on confirmation page #32502

mattwire · 2025-03-25T16:11:53Z

Overview

When a payment processor and pay later are enabled pay later instructions are always displayed on the ThankYou page.

Before

is_pay_later always set on ThankYou page.

After

Set per actual pay later status.

Technical Details

Explained via comments on this PR

Comments

civibot · 2025-03-25T16:11:56Z

🤖 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 🔗

mattwire · 2025-03-25T16:13:19Z

CRM/Event/Form/Registration.php

-    $this->assign('is_pay_later', $params['is_pay_later']);
-    $this->assign('pay_later_text', $params['is_pay_later'] ? $this->getPayLaterLabel() : FALSE);
-    $this->assign('pay_later_receipt', $params['is_pay_later'] ? $this->_values['event']['pay_later_receipt'] : NULL);
+    $isPayLater = ($this->_values['event']['is_pay_later'] ?? FALSE);


$params actually comes from the first event participant, we should be looking at the actual event data.
Also, $params seems to get reset to values from Register form (ie. throwing away changes on the Confirm form) when loaded on the ThankYou page so is_pay_later value is unreliable.

I've been using $this->getEventValue('is_pay_later') rather than _values - the former is a direct apiv4 lookup with some caching whereas the latter seems a bit magic to me

(also getEventValue() is supported for extensions to use so good to model it)

It's pretty horrible the way event/participant params are passed around those forms. The problem is that both participant params and event (_values) are modified during form submission. The database value of is_pay_later is 1 for the event because pay later is enabled. But by the time we get to this point is_pay_later has been set to FALSE because we've submitted the form with a paymentprocessor. If you use the event value from the DB/API4 then you get contributions etc. with is_pay_later set to true when they are not..
I'd love to find another way of getting the form submission is_pay_later value but I couldn't find anything that didn't involve a massive refactoring of the params being passed around.

oh that's dark - but does that mean is_pay_later === !$this->getSubmittedValue('payment_processor_id') ?

Oh, that's an idea.. getSubmittedValue() wasn't working properly but I fixed that as part of this PR so may now be a better option!

mattwire · 2025-03-25T16:16:10Z

CRM/Event/Form/Registration/Confirm.php

          // If we submitted with no payment processor then we must be pay later - set it here.
-          $params[$participantNum]['is_pay_later'] = 1;
+          $params[$participantNum]['is_pay_later'] = $this->_values['event']['is_pay_later'] = 1;


Set the pay later status based on the payment processor used on the confirm form

mattwire · 2025-03-25T16:16:25Z

settings/Event.setting.php

@@ -42,7 +42,7 @@
    'type' => 'Array',
    'default' => [],
    'add' => '5.58',
-    'title' => ts('EXPERIMENTAL: Show Event Payment on Confirm?'),
+    'title' => ts('Show Event Payment on Confirm?'),


Think it's time to remove the Experimental label...

mattwire · 2025-03-25T17:34:29Z

CRM/Event/Form/Registration.php

+    $this->assign('credit_card_type', $this->getSubmittedValue('credit_card_type'));
+    if ($this->getSubmittedValue('credit_card_exp_date')) {
+      $date = CRM_Utils_Date::format($this->getSubmittedValue('credit_card_exp_date'));
+      $date = CRM_Utils_Date::mysqlToIso($date);
+    }
+    $this->assign('credit_card_exp_date', $date ?? NULL);
+    $this->assign('credit_card_number',
+      CRM_Utils_System::mungeCreditCard($this->getSubmittedValue('credit_card_number') ?? '')
+    );


We should always be getting these fields from the original submitted values and not via a passed around $params array (which is actually first participant params with some extra sprinkled in)

mattwire · 2025-03-25T17:35:42Z

CRM/Event/Form/Registration.php

+      $value = $this->controller->exportValue('Register', $fieldName);
+    }
+    if (!isset($value)) {
+      $value = parent::getSubmittedValue($fieldName);


Fallback to generic function if we didn't find what we needed.

mattwire · 2025-03-25T17:36:06Z

CRM/Event/Form/Registration.php

-    // were on the Register Page so we return them
-    $value = $this->controller->exportValue('Register', $fieldName);
+    if ($this->isShowPaymentOnConfirm() && in_array($this->getName(), ['Confirm', 'ThankYou'], TRUE)) {
+      $value = $this->controller->exportValue('Confirm', $fieldName);


We'll find payment fields on Confirm if payment was made on Confirm. Otherwise they'll be on Register

mattwire · 2025-03-25T17:36:57Z

CRM/Event/Form/Registration/Confirm.php

@@ -252,6 +252,7 @@ public function buildQuickForm() {
        $this->assign('pay_later_receipt', '');
        // @fixme These functions all seem to do similar things but take one away and the house of cards falls down..
        $this->assignPaymentProcessor($this->_values['event']['is_pay_later']);
+        $this->preProcessPaymentOptions();


This is required only after the form is submitted to repopulate form fields so that eg. credit card fields can be retrieved via getSubmittedValue() from the ThankYou page. Otherwise they are lost.

@mattwire maybe we need an incode comment to that effect?

@eileenmcnaughton good idea. Added

mattwire · 2025-03-25T17:37:21Z

templates/CRM/Event/Form/Registration/ThankYou.tpl

+            <div class="content credit_card_type">{$credit_card_type}</div>
+            <div class="content credit_card_number">{$credit_card_number}</div>
+            <div class="content credit_card_exp_date">{if $credit_card_exp_date}{ts}Expires{/ts}: {$credit_card_exp_date|truncate:7:''|crmDate}{/if}</div>


Purely cosmetic but seems nice to be able to target each field separately.

…ayment on confirmation page

eileenmcnaughton · 2025-03-26T20:21:18Z

Just one thing outstanding - possible improvement of the code comments per comment above

…akes card details info show correctly on ThankYou page)

marcusjwilson · 2025-03-28T14:00:27Z

Tested this patch on localdev and on a staging site, and it seems to work as expected and resolve the issue. Thank You, Both!

eileenmcnaughton · 2025-03-28T14:31:38Z

thanks for testing @marcusjwilson

civibot bot added the master label Mar 25, 2025

mattwire commented Mar 25, 2025

View reviewed changes

mattwire force-pushed the eventpaylater branch from 847179a to a97c95c Compare March 25, 2025 17:33

mattwire commented Mar 25, 2025

View reviewed changes

mattwire marked this pull request as ready for review March 25, 2025 19:16

Fix display of pay later instructions on thankyou and skipping when p…

c27d278

…ayment on confirmation page

mattwire force-pushed the eventpaylater branch from a97c95c to 2460e95 Compare March 26, 2025 10:28

eileenmcnaughton added the merge ready PR will be merged after a few days if there are no objections label Mar 26, 2025

mattwire added 3 commits March 26, 2025 22:52

Allow passing through payment fields when entered on event confirm (m…

2ef6c26

…akes card details info show correctly on ThankYou page)

Add additional selectors to credit_card fields

0cd76f3

Remove experimental from label

dfff2fc

mattwire force-pushed the eventpaylater branch from 2460e95 to dfff2fc Compare March 26, 2025 22:52

eileenmcnaughton merged commit 85ca7d0 into civicrm:master Mar 28, 2025
1 check passed

mattwire deleted the eventpaylater branch March 28, 2025 14:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix display of pay later instructions on thankyou and skipping when payment on confirmation page #32502

Fix display of pay later instructions on thankyou and skipping when payment on confirmation page #32502

mattwire commented Mar 25, 2025 •

edited

Loading

civibot bot commented Mar 25, 2025

mattwire Mar 25, 2025 •

edited

Loading

eileenmcnaughton Mar 25, 2025

eileenmcnaughton Mar 25, 2025

mattwire Mar 25, 2025

eileenmcnaughton Mar 25, 2025

mattwire Mar 25, 2025

mattwire Mar 25, 2025

mattwire Mar 25, 2025

mattwire Mar 25, 2025

mattwire Mar 25, 2025

mattwire Mar 25, 2025

mattwire Mar 25, 2025

eileenmcnaughton Mar 26, 2025

mattwire Mar 26, 2025

mattwire Mar 25, 2025

eileenmcnaughton commented Mar 26, 2025

marcusjwilson commented Mar 28, 2025

eileenmcnaughton commented Mar 28, 2025

Fix display of pay later instructions on thankyou and skipping when payment on confirmation page #32502

Fix display of pay later instructions on thankyou and skipping when payment on confirmation page #32502

Conversation

mattwire commented Mar 25, 2025 • edited Loading

Overview

Before

After

Technical Details

Comments

civibot bot commented Mar 25, 2025

mattwire Mar 25, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eileenmcnaughton commented Mar 26, 2025

marcusjwilson commented Mar 28, 2025

eileenmcnaughton commented Mar 28, 2025

mattwire commented Mar 25, 2025 •

edited

Loading

mattwire Mar 25, 2025 •

edited

Loading