Merge pull request #24008 from seamuslee001/php8_1_message_templates

[REF][PHP8.1] Replace usage of the date_format modifer with crmDate t…
civicrm · Jul 29, 2022 · 2bfaf31 · 2bfaf31
2 parents ebd092e + 970cdb4
commit 2bfaf31
Show file tree

Hide file tree

Showing 19 changed files with 4,289 additions and 4,212 deletions.
diff --git a/CRM/Utils/Date.php b/CRM/Utils/Date.php
@@ -342,6 +342,9 @@ public static function customFormat($dateString, $format = NULL, $dateParts = NU
     $fullWeekdayNames = self::getFullWeekdayNames();
     $abbrWeekdayNames = self::getAbbrWeekdayNames();
 
+    // backwards compatability with %D being the equivilant of %m/%d/%y
+    $format = str_replace('%D', '%m/%d/%y', $format);
+
     if (!$format) {
       $config = CRM_Core_Config::singleton();
 
@@ -458,8 +461,10 @@ public static function customFormat($dateString, $format = NULL, $dateParts = NU
         '%p' => strtolower($type),
         '%P' => $type,
         '%Y' => $year,
+        '%y' => substr($year, 2),
         '%s' => str_pad($second, 2, 0, STR_PAD_LEFT),
         '%S' => str_pad($second, 2, 0, STR_PAD_LEFT),
+        '%Z' => date('T', strtotime($dateString)),
       ];
 
       return strtr($format, $date);

diff --git a/sql/civicrm_generated.mysql b/sql/civicrm_generated.mysql
diff --git a/tests/phpunit/CRM/Contribute/Form/Task/PDFLetterCommonTest.php b/tests/phpunit/CRM/Contribute/Form/Task/PDFLetterCommonTest.php
@@ -540,7 +540,7 @@ public function getHtmlMessage() {
   <!--
 {foreach from=$contributions item=contribution}
  {if $contribution.contact_id == $messageContactID}
- {assign var=\'date\' value=$contribution.receive_date|date_format:\'%d %B %Y\'}
+ {assign var=\'date\' value=$contribution.receive_date|crmDate:\'%d %B %Y\'}
  {assign var=contact_aggregate
 value=$contact_aggregate+$contribution.total_amount}
 -->

diff --git a/tests/phpunit/CRM/Utils/DateTest.php b/tests/phpunit/CRM/Utils/DateTest.php
@@ -254,6 +254,8 @@ public function testRelativeToAbsoluteFiscalYearRange() {
    * Test customFormat() function
    */
   public function testCustomFormat() {
+    $currentTimezone = date_default_timezone_get();
+    date_default_timezone_set('America/Los_Angeles');
     $dateTime = "2018-11-08 21:46:44";
     $this->assertEquals(CRM_Utils_Date::customFormat($dateTime, "%b"), "Nov");
     $this->assertEquals(CRM_Utils_Date::customFormat($dateTime, "%B"), "November");
@@ -273,12 +275,16 @@ public function testCustomFormat() {
     $this->assertEquals(CRM_Utils_Date::customFormat($dateTime, "%s"), "44");
     $this->assertEquals(CRM_Utils_Date::customFormat($dateTime, "%A"), "Thursday");
     $this->assertEquals(CRM_Utils_Date::customFormat($dateTime, "%a"), "Thu");
+    $this->assertEquals(CRM_Utils_Date::customFormat($dateTime, "%Z"), "PST");
+    date_default_timezone_set($currentTimezone);
   }
 
   /**
    * Test customFormat() function
    */
   public function testCustomFormatTs() {
+    $currentTimezone = date_default_timezone_get();
+    date_default_timezone_set('America/Los_Angeles');
     $ts = mktime(21, 46, 44, 11, 8, 2018);
     $this->assertEquals(CRM_Utils_Date::customFormatTs($ts, "%b"), "Nov");
     $this->assertEquals(CRM_Utils_Date::customFormatTs($ts, "%B"), "November");
@@ -297,6 +303,19 @@ public function testCustomFormatTs() {
     $this->assertEquals(CRM_Utils_Date::customFormatTs($ts, "%Y"), "2018");
     $this->assertEquals(CRM_Utils_Date::customFormatTs($ts, "%A"), "Thursday");
     $this->assertEquals(CRM_Utils_Date::customFormatTs($ts, "%a"), "Thu");
+    $this->assertEquals(CRM_Utils_Date::customFormatTs($ts, "%Z"), "PST");
+    date_default_timezone_set($currentTimezone);
+  }
+
+  /**
+   * Verify that the Timezone works for daylight savings based on the passed in date
+   */
+  public function testCustomFormatTimezoneDaylightSavings() {
+    $currentTimezone = date_default_timezone_get();
+    date_default_timezone_set('Australia/Sydney');
+    $dateTime = '2018-11-08 21:46:44';
+    $this->assertEquals("AEDT", CRM_Utils_Date::customFormat($dateTime, "%Z"));
+    date_default_timezone_set($currentTimezone);
   }
 
   /**

diff --git a/tests/templates/message_templates/event_online_receipt_text.tpl b/tests/templates/message_templates/event_online_receipt_text.tpl
@@ -33,8 +33,8 @@ isAdditionalParticipant:::{$isAdditionalParticipant}
 pay_later_receipt:::{$pay_later_receipt}
 {/if}
 event.event_title:::{$event.event_title}
-event.event_start_date:::{$event.event_start_date|date_format:"%A"}
-event.event_end_date:::{$event.event_end_date|date_format:"%Y%m%d"}
+event.event_start_date:::{$event.event_start_date|crmDate:"%A"}
+event.event_end_date:::{$event.event_end_date|crmDate:"%Y%m%d"}
 {if isset($event.is_monetary)}
 event.is_monetary:::{$event.is_monetary}
 {/if}

diff --git a/xml/templates/message_templates/event_offline_receipt_html.tpl b/xml/templates/message_templates/event_offline_receipt_html.tpl
@@ -53,7 +53,7 @@
      <tr>
       <td colspan="2" {$valueStyle}>
        {$event.event_title}<br />
-       {$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}
+       {$event.event_start_date|crmDate}{if $event.event_end_date}-{if $event.event_end_date|crmDate:"%Y%m%d" == $event.event_start_date|crmDate:"%Y%m%d"}{$event.event_end_date|crmDate:0:1}{else}{$event.event_end_date|crmDate}{/if}{/if}
       </td>
      </tr>
 

diff --git a/xml/templates/message_templates/event_offline_receipt_text.tpl b/xml/templates/message_templates/event_offline_receipt_text.tpl
@@ -42,7 +42,7 @@
 ==========================================================={if !empty($pricesetFieldsCount) }===================={/if}
 
 {$event.event_title}
-{$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}
+{$event.event_start_date|crmDate}{if $event.event_end_date}-{if $event.event_end_date|crmDate:"%Y%m%d" == $event.event_start_date|crmDate:"%Y%m%d"}{$event.event_end_date|crmDate:0:1}{else}{$event.event_end_date|crmDate}{/if}{/if}
 
 {if !empty($event.participant_role) and $event.participant_role neq 'Attendee' and empty($defaultRole)}
 {ts}Participant Role{/ts}: {$event.participant_role}

diff --git a/xml/templates/message_templates/event_online_receipt_html.tpl b/xml/templates/message_templates/event_online_receipt_html.tpl
@@ -64,7 +64,7 @@
      <tr>
       <td colspan="2" {$valueStyle}>
        {$event.event_title}<br />
-       {$event.event_start_date|date_format:"%A"} {$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|date_format:"%A"} {$event.event_end_date|crmDate}{/if}{/if}
+       {$event.event_start_date|crmDate:"%A"} {$event.event_start_date|crmDate}{if $event.event_end_date}-{if $event.event_end_date|crmDate:"%Y%m%d" == $event.event_start_date|crmDate:"%Y%m%d"}{$event.event_end_date|crmDate:0:1}{else}{$event.event_end_date|crmDate:"%A"} {$event.event_end_date|crmDate}{/if}{/if}
       </td>
      </tr>
 
@@ -79,9 +79,9 @@
        <td colspan="2" {$valueStyle}>
   {assign var='group_by_day' value='NA'}
   {foreach from=$conference_sessions item=session}
-   {if $session.start_date|date_format:"%Y/%m/%d" != $group_by_day|date_format:"%Y/%m/%d"}
+   {if $session.start_date|crmDate:"%Y/%m/%d" != $group_by_day|crmDate:"%Y/%m/%d"}
     {assign var='group_by_day' value=$session.start_date}
-          <em>{$group_by_day|date_format:"%m/%d/%Y"}</em><br />
+          <em>{$group_by_day|crmDate:"%m/%d/%Y"}</em><br />
    {/if}
    {$session.start_date|crmDate:0:1}{if $session.end_date}-{$session.end_date|crmDate:0:1}{/if} {$session.title}<br />
    {if $session.location}&nbsp;&nbsp;&nbsp;&nbsp;{$session.location}<br />{/if}

diff --git a/xml/templates/message_templates/event_online_receipt_text.tpl b/xml/templates/message_templates/event_online_receipt_text.tpl
@@ -47,17 +47,17 @@
 ==========================================================={if !empty($pricesetFieldsCount)}===================={/if}
 
 {$event.event_title}
-{$event.event_start_date|date_format:"%A"} {$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|date_format:"%A"} {$event.event_end_date|crmDate}{/if}{/if}
+{$event.event_start_date|crmDate:"%A"} {$event.event_start_date|crmDate}{if $event.event_end_date}-{if $event.event_end_date|crmDate:"%Y%m%d" == $event.event_start_date|crmDate:"%Y%m%d"}{$event.event_end_date|crmDate:0:1}{else}{$event.event_end_date|crmDate:"%A"} {$event.event_end_date|crmDate}{/if}{/if}
 {if !empty($conference_sessions)}
 
 
 {ts}Your schedule:{/ts}
 {assign var='group_by_day' value='NA'}
 {foreach from=$conference_sessions item=session}
-{if $session.start_date|date_format:"%Y/%m/%d" != $group_by_day|date_format:"%Y/%m/%d"}
+{if $session.start_date|crmDate:"%Y/%m/%d" != $group_by_day|crmDate:"%Y/%m/%d"}
 {assign var='group_by_day' value=$session.start_date}
 
-{$group_by_day|date_format:"%m/%d/%Y"}
+{$group_by_day|crmDate:"%m/%d/%Y"}
 
 
 {/if}

diff --git a/xml/templates/message_templates/event_registration_receipt_html.tpl b/xml/templates/message_templates/event_registration_receipt_html.tpl
@@ -25,7 +25,7 @@
     {/if}
 
     <p>Your order number is #{$transaction_id}. {if !empty($line_items) && empty($is_refund)} Information about the workshops will be sent separately to each participant.{/if}
-  Here's a summary of your transaction placed on {$transaction_date|date_format:"%D %I:%M %p %Z"}:</p>
+  Here's a summary of your transaction placed on {$transaction_date|crmDate:"%D %I:%M %p %Z"}:</p>
 
 {if $billing_name}
   <table class="billing-info">
@@ -90,11 +90,11 @@
   {foreach from=$line_items item=line_item}
   <tr>
     <td style="width: 220px">
-      {$line_item.event->title} ({$line_item.event->start_date|date_format:"%D"})<br />
+      {$line_item.event->title} ({$line_item.event->start_date|crmDate:"%D"})<br />
       {if $line_item.event->is_show_location}
         {$line_item.location.address.1.display|nl2br}
       {/if}{*End of isShowLocation condition*}<br /><br />
-      {$line_item.event->start_date|date_format:"%D %I:%M %p"} - {$line_item.event->end_date|date_format:"%I:%M %p"}
+      {$line_item.event->start_date|crmDate:"%D %I:%M %p"} - {$line_item.event->end_date|crmDate:"%I:%M %p"}
     </td>
     <td style="width: 180px">
     {$line_item.num_participants}

diff --git a/xml/templates/message_templates/event_registration_receipt_text.tpl b/xml/templates/message_templates/event_registration_receipt_text.tpl
@@ -11,7 +11,7 @@
 {/if}
 
   Your order number is #{$transaction_id}. {if !empty($line_items) && empty($is_refund)} Information about the workshops will be sent separately to each participant.{/if}
- Here's a summary of your transaction placed on {$transaction_date|date_format:"%D %I:%M %p %Z"}:
+ Here's a summary of your transaction placed on {$transaction_date|crmDate:"%D %I:%M %p %Z"}:
 
 {if $billing_name}
 ===========================================================
@@ -33,11 +33,11 @@
 
 
 {foreach from=$line_items item=line_item}
-{$line_item.event->title} ({$line_item.event->start_date|date_format:"%D"})
+{$line_item.event->title} ({$line_item.event->start_date|crmDate:"%D"})
 {if $line_item.event->is_show_location}
   {$line_item.location.address.1.display|strip_tags:false}
 {/if}{*End of isShowLocation condition*}
-{$line_item.event->start_date|date_format:"%D %I:%M %p"} - {$line_item.event->end_date|date_format:"%I:%M %p"}
+{$line_item.event->start_date|crmDate:"%D %I:%M %p"} - {$line_item.event->end_date|crmDate:"%I:%M %p"}
 
   Quantity: {$line_item.num_participants}
 

diff --git a/xml/templates/message_templates/participant_confirm_html.tpl b/xml/templates/message_templates/participant_confirm_html.tpl
@@ -53,7 +53,7 @@
      <tr>
       <td colspan="2" {$valueStyle}>
        {$event.event_title}<br />
-       {$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}
+       {$event.event_start_date|crmDate}{if $event.event_end_date}-{if $event.event_end_date|crmDate:"%Y%m%d" == $event.event_start_date|crmDate:"%Y%m%d"}{$event.event_end_date|crmDate:0:1}{else}{$event.event_end_date|crmDate}{/if}{/if}
       </td>
      </tr>
      {if $conference_sessions}
@@ -66,9 +66,9 @@
        <td colspan="2" {$valueStyle}>
   {assign var='group_by_day' value='NA'}
   {foreach from=$conference_sessions item=session}
-   {if $session.start_date|date_format:"%Y/%m/%d" != $group_by_day|date_format:"%Y/%m/%d"}
+   {if $session.start_date|crmDate:"%Y/%m/%d" != $group_by_day|crmDate:"%Y/%m/%d"}
     {assign var='group_by_day' value=$session.start_date}
-          <em>{$group_by_day|date_format:"%m/%d/%Y"}</em><br />
+          <em>{$group_by_day|crmDate:"%m/%d/%Y"}</em><br />
    {/if}
    {$session.start_date|crmDate:0:1}{if $session.end_date}-{$session.end_date|crmDate:0:1}{/if} {$session.title}<br />
    {if $session.location}&nbsp;&nbsp;&nbsp;&nbsp;{$session.location}<br />{/if}

diff --git a/xml/templates/message_templates/participant_confirm_text.tpl b/xml/templates/message_templates/participant_confirm_text.tpl
@@ -22,17 +22,17 @@ Click this link to go to a web page where you can confirm your registration onli
 
 ===========================================================
 {$event.event_title}
-{$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}
+{$event.event_start_date|crmDate}{if $event.event_end_date}-{if $event.event_end_date|crmDate:"%Y%m%d" == $event.event_start_date|crmDate:"%Y%m%d"}{$event.event_end_date|crmDate:0:1}{else}{$event.event_end_date|crmDate}{/if}{/if}
 {if $conference_sessions}
 
 
 {ts}Your schedule:{/ts}
 {assign var='group_by_day' value='NA'}
 {foreach from=$conference_sessions item=session}
-{if $session.start_date|date_format:"%Y/%m/%d" != $group_by_day|date_format:"%Y/%m/%d"}
+{if $session.start_date|crmDate:"%Y/%m/%d" != $group_by_day|crmDate:"%Y/%m/%d"}
 {assign var='group_by_day' value=$session.start_date}
 
-{$group_by_day|date_format:"%m/%d/%Y"}
+{$group_by_day|crmDate:"%m/%d/%Y"}
 
 
 {/if}

diff --git a/xml/templates/message_templates/participant_expired_html.tpl b/xml/templates/message_templates/participant_expired_html.tpl
@@ -38,7 +38,7 @@ or want to inquire about reinstating your registration for this event.{/ts}</p>
      <tr>
       <td colspan="2" {$valueStyle}>
        {$event.event_title}<br />
-       {$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}
+       {$event.event_start_date|crmDate}{if $event.event_end_date}-{if $event.event_end_date|crmDate:"%Y%m%d" == $event.event_start_date|crmDate:"%Y%m%d"}{$event.event_end_date|crmDate:0:1}{else}{$event.event_end_date|crmDate}{/if}{/if}
       </td>
      </tr>
      <tr>

diff --git a/xml/templates/message_templates/participant_expired_text.tpl b/xml/templates/message_templates/participant_expired_text.tpl
@@ -12,7 +12,7 @@ or want to inquire about reinstating your registration for this event.{/ts}
 
 ===========================================================
 {$event.event_title}
-{$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}
+{$event.event_start_date|crmDate}{if $event.event_end_date}-{if $event.event_end_date|crmDate:"%Y%m%d" == $event.event_start_date|crmDate:"%Y%m%d"}{$event.event_end_date|crmDate:0:1}{else}{$event.event_end_date|crmDate}{/if}{/if}
 
 {ts}Participant Role{/ts}: {$participant.role}
 

diff --git a/xml/templates/message_templates/participant_transferred_html.tpl b/xml/templates/message_templates/participant_transferred_html.tpl
@@ -35,7 +35,7 @@
      <tr>
       <td colspan="2" {$valueStyle}>
        {$event.event_title}<br />
-       {$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}
+       {$event.event_start_date|crmDate}{if $event.event_end_date}-{if $event.event_end_date|crmDate:"%Y%m%d" == $event.event_start_date|crmDate:"%Y%m%d"}{$event.event_end_date|crmDate:0:1}{else}{$event.event_end_date|crmDate}{/if}{/if}
       </td>
      </tr>
      <tr>

diff --git a/xml/templates/message_templates/participant_transferred_text.tpl b/xml/templates/message_templates/participant_transferred_text.tpl
@@ -7,7 +7,7 @@
 
 ===========================================================
 {$event.event_title}
-{$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}
+{$event.event_start_date|crmDate}{if $event.event_end_date}-{if $event.event_end_date|crmDate:"%Y%m%d" == $event.event_start_date|crmDate:"%Y%m%d"}{$event.event_end_date|crmDate:0:1}{else}{$event.event_end_date|crmDate}{/if}{/if}
 
 {ts}Participant Role{/ts}: {$participant.role}
 

diff --git a/xml/templates/message_templates/payment_or_refund_notification_html.tpl b/xml/templates/message_templates/payment_or_refund_notification_html.tpl
@@ -177,7 +177,7 @@
     <tr>
       <td colspan="2" {$valueStyle}>
          {$event.event_title}<br />
-        {$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}
+        {$event.event_start_date|crmDate}{if $event.event_end_date}-{if $event.event_end_date|crmDate:"%Y%m%d" == $event.event_start_date|crmDate:"%Y%m%d"}{$event.event_end_date|crmDate:0:1}{else}{$event.event_end_date|crmDate}{/if}{/if}
       </td>
     </tr>
 

diff --git a/xml/templates/message_templates/payment_or_refund_notification_text.tpl b/xml/templates/message_templates/payment_or_refund_notification_text.tpl
@@ -90,7 +90,7 @@
 ===============================================================================
 
 {$event.event_title}
-{$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}
+{$event.event_start_date|crmDate}{if $event.event_end_date}-{if $event.event_end_date|crmDate:"%Y%m%d" == $event.event_start_date|crmDate:"%Y%m%d"}{$event.event_end_date|crmDate:0:1}{else}{$event.event_end_date|crmDate}{/if}{/if}
 
 {if !empty($event.participant_role)}
 {ts}Participant Role{/ts}: {$event.participant_role}