From da3ea3d086cb580608f35bfcb436e6305d9e6e7d Mon Sep 17 00:00:00 2001
From: Seamus Lee <seamuslee001@gmail.com>
Date: Sun, 13 Jun 2021 22:59:20 +0000
Subject: [PATCH] [php8-compact]  Fix PDF Letter Test by ensuring that all
 actual DB fields are in the tokens array and also by resetting the static
 cache of tokens

Remove uncessary function call
---
 CRM/Utils/Token.php                                 | 13 +++++++++----
 .../Contribute/Form/Task/PDFLetterCommonTest.php    |  1 +
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/CRM/Utils/Token.php b/CRM/Utils/Token.php
index 2dd76bf4f8..ce10fce61c 100644
--- a/CRM/Utils/Token.php
+++ b/CRM/Utils/Token.php
@@ -1559,10 +1559,16 @@ class CRM_Utils_Token {
   protected static function _buildContributionTokens() {
     $key = 'contribution';
     if (self::$_tokens[$key] == NULL) {
-      self::$_tokens[$key] = array_keys(array_merge(CRM_Contribute_BAO_Contribution::exportableFields('All'),
-        ['campaign', 'financial_type'],
+      $tokens = array_merge(CRM_Contribute_BAO_Contribution::exportableFields('All'),
+        ['campaign' => [], 'financial_type' => [], 'payment_instrument' => []],
         self::getCustomFieldTokens('Contribution')
-      ));
+      );
+      foreach ($tokens as $token) {
+        if (!empty($token['name'])) {
+          $tokens[$token['name']] = [];
+        }
+      }
+      self::$_tokens[$key] = array_keys($tokens);
     }
   }
 
@@ -1680,7 +1686,6 @@ class CRM_Utils_Token {
       //early return
       return $str;
     }
-    self::_buildContributionTokens();
 
     // here we intersect with the list of pre-configured valid tokens
     // so that we remove anything we do not recognize
diff --git a/tests/phpunit/CRM/Contribute/Form/Task/PDFLetterCommonTest.php b/tests/phpunit/CRM/Contribute/Form/Task/PDFLetterCommonTest.php
index 8fc99b14f8..7b9cfa124f 100644
--- a/tests/phpunit/CRM/Contribute/Form/Task/PDFLetterCommonTest.php
+++ b/tests/phpunit/CRM/Contribute/Form/Task/PDFLetterCommonTest.php
@@ -49,6 +49,7 @@ class CRM_Contribute_Form_Task_PDFLetterCommonTest extends CiviUnitTestCase {
    * @throws \CiviCRM_API3_Exception
    */
   public function tearDown(): void {
+    CRM_Utils_Token::$_tokens['contribution'] = NULL;
     $this->quickCleanUpFinancialEntities();
     $this->quickCleanup(['civicrm_uf_match', 'civicrm_campaign'], TRUE);
     CRM_Utils_Hook::singleton()->reset();
-- 
2.25.1