From 8b8fad1b1e5bb77641f09127507febd41d54668a Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <emcnaughton@wikimedia.org>
Date: Sat, 2 Dec 2023 19:31:00 +1300
Subject: [PATCH] Add support for financial trxn tokens

---
 CRM/Financial/FinancialTrxnTokens.php         | 29 +++++++++++++++++++
 Civi/Core/Container.php                       |  5 ++++
 .../CRM/Utils/TokenConsistencyTest.php        |  4 +++
 3 files changed, 38 insertions(+)
 create mode 100644 CRM/Financial/FinancialTrxnTokens.php

diff --git a/CRM/Financial/FinancialTrxnTokens.php b/CRM/Financial/FinancialTrxnTokens.php
new file mode 100644
index 0000000000..236be716f1
--- /dev/null
+++ b/CRM/Financial/FinancialTrxnTokens.php
@@ -0,0 +1,29 @@
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ * Class CRM_Event_Tokens
+ *
+ * Generate "event.*" tokens.
+ */
+class CRM_Financial_FinancialTrxnTokens extends CRM_Core_EntityTokens {
+
+  /**
+   * Get the entity name for api v4 calls.
+   *
+   * @return string
+   */
+  protected function getApiEntityName(): string {
+    return 'FinancialTrxn';
+  }
+
+}
diff --git a/Civi/Core/Container.php b/Civi/Core/Container.php
index bdc23796dc..8ea153495c 100644
--- a/Civi/Core/Container.php
+++ b/Civi/Core/Container.php
@@ -364,6 +364,11 @@ class Container {
         []
       ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
     }
+    $container->setDefinition("crm_financial_trxn_tokens", new Definition(
+      'CRM_Financial_FinancialTrxnTokens',
+      []
+    ))->addTag('kernel.event_subscriber')->setPublic(TRUE);
+
     $container->setDefinition('civi_token_impliedcontext', new Definition(
       'Civi\Token\ImpliedContextSubscriber',
       []
diff --git a/tests/phpunit/CRM/Utils/TokenConsistencyTest.php b/tests/phpunit/CRM/Utils/TokenConsistencyTest.php
index 06dca14555..e9d2b0bcaf 100644
--- a/tests/phpunit/CRM/Utils/TokenConsistencyTest.php
+++ b/tests/phpunit/CRM/Utils/TokenConsistencyTest.php
@@ -9,6 +9,7 @@
  +--------------------------------------------------------------------+
  */
 
+use Civi\Api4\FinancialTrxn;
 use Civi\Token\TokenProcessor;
 use Civi\Api4\LocBlock;
 use Civi\Api4\Email;
@@ -304,6 +305,9 @@ Czech Republic<br />', $html);
 The End
 Czech Republic
 ', $text);
+    $financialTrxn = FinancialTrxn::get()->addWhere('is_payment', '=', TRUE)->execute()->first();
+    $text = $this->renderText(['financial_trxnId' => $financialTrxn['id']], '{financial_trxn.total_amount}', [], FALSE);
+    $this->assertEquals('$100.00', $text);
   }
 
   /**
-- 
2.25.1