Update Payment Notification to use greeting, remove text to 'Please print this confirmation for your records. #13655

eileenmcnaughton · 2019-02-21T02:02:27Z

Overview

Update Payment notification to use the value stored in email_greeting rather than display name (this has been done in other templates).

Also remove text to 'Please print this confirmation for your records.'

Before

Addressed by display name - eg. 'Dear Mr. Anthony Anderson II,'

Sentence Please print this confirmation for your records is present

After

Addressed by email greeting per site config & like other templates eg. 'Dear Anthony,'

Sentence Please print this confirmation for your records has gone

Technical Details

These changes are consistent with other changes. I also switched the parameters for when to include extra detail to deprecate contributeMode

Comments

Resolving inconsistency on greeting as pre-requisite for #13649

@magnolia61 I think this is probably one you'll be please to see

civibot · 2019-02-21T02:02: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 · 2019-02-21T02:03:47Z

xml/templates/message_templates/payment_or_refund_notification_html.tpl

@@ -160,7 +160,7 @@
            </td>
          </tr>
    {/if}
-    {if $contributeMode eq'direct' and !$isAmountzero}
+    {if $credit_card_number}


we would never have a card number here if it's not been used for a payment so we don't need contributeMode or to check the amount

eileenmcnaughton · 2019-02-21T02:04:41Z

xml/templates/message_templates/payment_or_refund_notification_html.tpl

@@ -147,7 +147,7 @@
    <tr>
      <td>
  <table style="border: 1px solid #999; margin: 1em 0em 1em; border-collapse: collapse; width:100%;">
-    {if $contributeMode eq 'direct' and !$isAmountzero}
+    {if $billingName || $address}


these are assigned in the processCreditCard code. I would have liked to load them for the db but we don't retain an address per payment - only per contribution - probably we should

These changes are consistent with other changes. I also switched the parameters for when to include extra detail to deprecate contributeMode

monishdeb · 2019-02-21T07:16:51Z

CRM/Financial/BAO/Payment.php

@@ -169,6 +169,8 @@ protected static function loadRelatedEntities($id) {
    $contactID = self::getPaymentContactID($contributionID);
    list($displayName, $email)  = CRM_Contact_BAO_Contact_Location::getEmailDetails($contactID);
    $entities['contact'] = ['id' => $contactID, 'display_name' => $displayName, 'email' => $email];
+    $contact = civicrm_api3('Contact', 'getsingle', ['id' => $contactID, 'return' => 'email_greeting']);
+    $entities['contact']['email_greeting'] = $contact['email_greeting_display'];


It seems $contact is not used anywhere below so can we change it to:

$entities['contact']['email_greeting'] = civicrm_api3('Contact', 'getvalue', ['id' => $contactID, 'return' => 'email_greeting_display']);

@monishdeb nope we can't - if it's empty getvalue will throw an error

monishdeb · 2019-02-21T07:17:08Z

CRM/Contribute/Form/AdditionalPayment.php

+      // These 2 rows are temporarily added for sequencing of adding commits. They won't be needed when we
+      // switch to Payment.send_confirmation api
+      $contact = civicrm_api3('Contact', 'getsingle', ['id' => $this->_contactId, 'return' => 'email_greeting']);
+      $this->assign('emailGreeting', $contact['email_greeting_display']);


Same as below!!

these 2 lines will go next pr

monishdeb · 2019-02-21T08:27:27Z

xml/templates/message_templates/payment_or_refund_notification_html.tpl

@@ -12,7 +12,8 @@
 {capture assign=emptyBlockStyle }style="padding: 10px; border-bottom: 1px solid #999;background-color: #f7f7f7;"{/capture}
 {capture assign=emptyBlockValueStyle }style="padding: 10px; border-bottom: 1px solid #999;"{/capture}

-<p>Dear {$contactDisplayName}</p>
+{if $emailGreeting}<p>{$emailGreeting},</p>{/if}
+
 <center>


monishdeb · 2019-02-21T08:34:13Z

Tested working fine. Also has an extended UT to assert billing address and card details

magnolia61 · 2019-02-22T10:29:08Z

Hi Eileen,
Indeed nice to see this one also move to the emailgreeting token. Maybe a good occasion also to move the greeting to within the first like in other templates. Now the greeting is left aligned outside of the table.

eileenmcnaughton · 2019-02-22T10:39:20Z

@magnolia61 indeed! having already set the upgrade script on this it's good to tweak that at the same time - are you able to to test the revisted tpl in #13669

magnolia61 · 2019-02-22T13:49:09Z

When I upgrade my dev site to the current master a fatal error get's thrown on the
UPDATE civicrm_msg_template:
You have an error in your SQL syntax; check the manual that corresponds to your MariaDB server version for the right syntax to use near ')' at line 1]"]

eileenmcnaughton · 2019-02-22T20:03:42Z

@magnolia61 is there any more info? That update script hasn't changed so it's a bit weird

magnolia61 · 2019-03-06T15:05:40Z

This is from the CiviCRM log: [debug_info]
UPDATE civicrm_msg_template SET msg_text = *'{if $emailGreeting}{$emailGreeting},\n{/if}{if $isRefund}\n{ts}A refund has been issued based on changes in your registration selections.{/ts}\n{else}\n{ts}A payment has been received.{/ts}\n{/if}\n\n{if $isRefund}\n===============================================================================\n\n{ts}Refund Details{/ts}\n\n===============================================================================\n{ts}Total Fees{/ts}: {$totalAmount|crmMoney}\n{ts}You Paid{/ts}: {$totalPaid|crmMoney}\n------------------------------------------------------------------------------------\n{ts}Refund Amount{/ts}: {$refundAmount|crmMoney}\n\n{else}\n===============================================================================\n\n{ts}Payment Details{/ts}\n\n===============================================================================\n{ts}Total Fees{/ts}: {$totalAmount|crmMoney}\n{ts}This Payment Amount{/ts}: {$paymentAmount|crmMoney}\n------------------------------------------------------------------------------------\n{ts}Balance Owed{/ts}: {$amountOwed|crmMoney} { This will be zero after final payment. *}\n\n{if $paymentsComplete}\n\n{ts}Thank you for completing payment.{/ts}\n{/if}\n{/if}\n{if $receive_date}\n{ts}Transaction Date{/ts}: {$receive_date|crmDate}\n{/if}\n{if $trxn_id}\n{ts}Transaction #{/ts}: {$trxn_id}\n{/if}\n{if $paidBy}\n{ts}Paid By{/ts}: {$paidBy}\n{/if}\n{if $checkNumber}\n{ts}Check Number{/ts}: {$checkNumber}\n{/if}\n{if $billingName || $address}\n\n===============================================================================\n\n{ts}Billing Name and Address{/ts}\n\n===============================================================================\n\n{$billingName}\n{$address}\n{/if}\n\n{if $credit_card_number}\n===========================================================\n{ts}Credit Card Information{/ts}\n\n===============================================================================\n\n{$credit_card_type}\n{$credit_card_number}\n{ts}Expires{/ts}: {$credit_card_exp_date|truncate:7:''|crmDate}\n{/if}\n{if $component eq 'event'}\n===============================================================================\n\n{ts}Event Information and Location{/ts}\n\n===============================================================================\n\n{$event.event_title}\n{$event.event_start_date|crmDate}{if $event.event_end_date}-{if $event.event_end_date|date_format:"%Y%m%d" == $event.event_start_date|date_format:"%Y%m%d"}{$event.event_end_date|crmDate:0:1}{else}{$event.event_end_date|crmDate}{/if}{/if}\n\n{if $event.participant_role}\n{ts}Participant Role{/ts}: {$event.participant_role}\n{/if}\n\n{if $isShowLocation}\n{$location.address.1.display|strip_tags:false}\n{/if}{End of isShowLocation condition}\n\n{if $location.phone.1.phone || $location.email.1.email}\n\n{ts}Event Contacts:{/ts}\n{foreach from=$location.phone item=phone}\n{if $phone.phone}\n\n{if $phone.phone_type}{$phone.phone_type_display}{else}{ts}Phone{/ts}{/if}: {$phone.phone}{/if} {if $phone.phone_ext} {ts}ext.{/ts} {$phone.phone_ext}{/if}\n{/foreach}\n{foreach from=$location.email item=eventEmail}\n{if $eventEmail.email}\n\n{ts}Email{/ts}: {$eventEmail.email}{/if}{/foreach}\n{/if}\n{/if}\n'**WHERE id IN () [nativecode=1064 ** You have an error in your SQL syntax; check the manual that corresponds to your MariaDB server version for the right syntax to use near ')' at line 1]

magnolia61 · 2019-03-06T16:34:52Z

Solved it! For some reason a former upgrade did not work well and left me with a double entry in the civicrm_option_value table for the payment_or_refund_notification template. When I removed the redundant ones, the upgrade worked like a charm.

eileenmcnaughton · 2019-03-06T20:00:57Z

thanks - & phew

civibot bot added the master label Feb 21, 2019

eileenmcnaughton commented Feb 21, 2019

View reviewed changes

Update Payment Notification to use greeting, to not encourage printing

1e477c5

These changes are consistent with other changes. I also switched the parameters for when to include extra detail to deprecate contributeMode

eileenmcnaughton force-pushed the payment_receipt branch from 46ce020 to 1e477c5 Compare February 21, 2019 05:32

eileenmcnaughton changed the title ~~Update Payment Notification to use greeting, to not encourage printing~~ Update Payment Notification to use greeting, remove text to 'Please print this confirmation for your records. Feb 21, 2019

monishdeb reviewed Feb 21, 2019

View reviewed changes

monishdeb merged commit 7ae65a0 into civicrm:master Feb 21, 2019

eileenmcnaughton deleted the payment_receipt branch February 21, 2019 08:41

eileenmcnaughton mentioned this pull request Feb 22, 2019

Payment notification formatting, move greeting into table #13669

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Payment Notification to use greeting, remove text to 'Please print this confirmation for your records. #13655

Update Payment Notification to use greeting, remove text to 'Please print this confirmation for your records. #13655

eileenmcnaughton commented Feb 21, 2019

civibot bot commented Feb 21, 2019

eileenmcnaughton Feb 21, 2019

monishdeb Feb 21, 2019

eileenmcnaughton Feb 21, 2019

monishdeb Feb 21, 2019

eileenmcnaughton Feb 21, 2019

monishdeb Feb 21, 2019

eileenmcnaughton Feb 21, 2019

monishdeb Feb 21, 2019

monishdeb commented Feb 21, 2019

magnolia61 commented Feb 22, 2019

eileenmcnaughton commented Feb 22, 2019

magnolia61 commented Feb 22, 2019

eileenmcnaughton commented Feb 22, 2019

magnolia61 commented Mar 6, 2019 •

edited

Loading

magnolia61 commented Mar 6, 2019

eileenmcnaughton commented Mar 6, 2019

Update Payment Notification to use greeting, remove text to 'Please print this confirmation for your records. #13655

Update Payment Notification to use greeting, remove text to 'Please print this confirmation for your records. #13655

Conversation

eileenmcnaughton commented Feb 21, 2019

Overview

Before

After

Technical Details

Comments

civibot bot commented Feb 21, 2019

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

monishdeb commented Feb 21, 2019

magnolia61 commented Feb 22, 2019

eileenmcnaughton commented Feb 22, 2019

magnolia61 commented Feb 22, 2019

eileenmcnaughton commented Feb 22, 2019

magnolia61 commented Mar 6, 2019 • edited Loading

magnolia61 commented Mar 6, 2019

eileenmcnaughton commented Mar 6, 2019

magnolia61 commented Mar 6, 2019 •

edited

Loading