Update online_event_template to use workflow message

This updates the default online event template to use the variables assigned by
the workflow template

This works to standardise the variables previously in dataArray
, lineItem, totalAmount, taxAmount to reflect the
approach in other templates per
https://docs.civicrm.org/user/en/latest/email/message-templates/#variables-and-tokens-in-workflow-message-templates

However, for participants, per the helpful discussion at
civicrm#24576

the expectation is that the primaryParticipant gets the values for
all participants whereas the others only get line items,
tax breakdowns, totals that relate to them.

Hence I have assigned an array participants that holds detials for all participants
and the template iterates through them showing all or just the
one that relates to the assigned participant id depending on
whether it is primary.

This allows the template to display in the Message preview and should
also mean that those values that I have addressed will always reflect
the participantID being used. This also addresses some notices
and incompatibility with secure smarty.

However, there are still values I haven't made sense of, or otherwise left
out of the scope of this PR in the template.

Also note I updated the taxBreakdown in the contribution trait - I decided it
was cloberring the amount as it iterated through the line items - rather than
doing a running total.

CRM/Contribute/WorkflowMessage/ContributionTrait.php

@@ -4,7 +4,7 @@
 
 /**
  * @method array getContribution()
- * @method ?int getContributionID()
+ * @method int|null getContributionID()
  * @method $this setContributionID(?int $contributionId)
  */
 trait CRM_Contribute_WorkflowMessage_ContributionTrait {
@@ -70,6 +70,11 @@ private function getOrder(): ?CRM_Financial_BAO_Order {
     if (!$this->order && $this->contributionID) {
       $this->order = new CRM_Financial_BAO_Order();
       $this->order->setTemplateContributionID($this->contributionID);
+      if (!empty($this->eventID)) {
+        // Temporary support for tests that are making a mess of this.
+        // It should always be possible to get this from the line items.
+        $this->order->setPriceSetIDByEventPageID($this->eventID);
+      }
     }
     return $this->order;
   }
@@ -147,11 +152,20 @@ public function getTaxRateBreakdown(): array {
     }
     $this->taxRateBreakdown = [];
     foreach ($this->getLineItems() as $lineItem) {
-      $this->taxRateBreakdown[$lineItem['tax_rate']] = [
-        'amount' => $lineItem['tax_amount'] ?? 0,
-        'rate' => $lineItem['tax_rate'],
-        'percentage' => sprintf('%.2f', $lineItem['tax_rate']),
-      ];
+      if (!isset($this->taxRateBreakdown[$lineItem['tax_rate']])) {
+        $this->taxRateBreakdown[$lineItem['tax_rate']] = [
+          'amount' => 0,
+          'rate' => $lineItem['tax_rate'],
+          'percentage' => sprintf('%.2f', $lineItem['tax_rate']),
+        ];
+      }
+      $this->taxRateBreakdown[$lineItem['tax_rate']]['amount'] += $lineItem['tax_amount'] ?? 0;
+    }
+    // Remove the rates with no value.
+    foreach ($this->taxRateBreakdown as $rate => $details) {
+      if ($details['amount'] === 0.0) {
+        unset($this->taxRateBreakdown[$rate]);
+      }
     }
     if (array_keys($this->taxRateBreakdown) === [0]) {
       // If the only tax rate charged is 0% then no tax breakdown is returned.

CRM/Event/WorkflowMessage/ParticipantTrait.php

@@ -1,9 +1,13 @@
 <?php
 
+use Civi\Api4\LineItem;
 use Civi\Api4\Participant;
 
 /**
  * Trait for participant workflow classes.
+ *
+ * @method int getParticipantID()
+ * @method int getEventID()
  */
 trait CRM_Event_WorkflowMessage_ParticipantTrait {
 
@@ -83,6 +87,34 @@ public function setEventID(int $eventID): self {
     return $this;
   }
 
+  /**
+   * @throws \Civi\API\Exception\UnauthorizedException
+   * @throws \CRM_Core_Exception
+   */
+  public function setParticipantID(int $participantID) {
+    $this->participantID = $participantID;
+    if (!$this->getContributionID()) {
+      $lineItem = LineItem::get(FALSE)
+        ->addWhere('entity_table', '=', 'civicrm_participant')
+        ->addWhere('id', '=', $participantID)
+        ->addSelect('contribution_id')
+        ->execute()->first();
+      if (!empty($lineItem)) {
+        $this->setContributionID($lineItem['contribution_id']);
+      }
+      // It might be bad data on the site - let's do a noisy fall back to participant payment
+      // (the relationship between contribution & participant should be in the line item but
+      // some integrations might mess this up - if they are not using the order api).
+      $participantPayment = civicrm_api3('ParticipantPayment', 'get', ['participant_id' => $participantID])['values'];
+      if (!empty($participantPayment)) {
+        $participantPayment = reset($participantPayment);
+        $this->setContributionID((int) $participantPayment['contribution_id']);
+        CRM_Core_Session::setStatus('There might be a data problem, contribution id could not be loaded from the line item');
+      }
+    }
+    return $this;
+  }
+
   /**
    * Is the participant the primary participant.
    *
@@ -110,7 +142,7 @@ public function getPrimaryParticipantID(): int {
   public function setParticipant(array $participant): self {
     $this->participant = $participant;
     if (!empty($participant['id'])) {
-      $this->participantID = $participant['id'];
+      $this->setParticipantID($participant['id']);
     }
     if (!empty($participant['event_id'])) {
       $this->eventID = $participant['event_id'];
@@ -149,7 +181,7 @@ public function getParticipants(): array {
         return [];
       }
       // Initiate with the current participant to ensure they are first.
-      $participants = [$this->participantID => ['id' => $this->participantID]];
+      $participants = [$this->participantID => ['id' => $this->participantID, 'tax_rate_breakdown' => []]];
       foreach ($this->getLineItems() as $lineItem) {
         if ($lineItem['entity_table'] === 'civicrm_participant') {
           $participantID = $lineItem['entity_id'];
@@ -167,6 +199,9 @@ public function getParticipants(): array {
         $participants[$participantID]['totals']['total_amount_exclusive'] += $lineItem['line_total'];
         $participants[$participantID]['totals']['tax_amount'] += $lineItem['tax_amount'];
         $participants[$participantID]['totals']['total_amount_inclusive'] += ($lineItem['line_total'] + $lineItem['tax_amount']);
+        if (!isset($participants[$participantID]['tax_rate_breakdown'])) {
+          $participants[$participantID]['tax_rate_breakdown'] = [];
+        }
         if (!isset($participants[$participantID]['tax_rate_breakdown'][$lineItem['tax_rate']])) {
           $participants[$participantID]['tax_rate_breakdown'][$lineItem['tax_rate']] = [
             'amount' => 0,
@@ -182,7 +217,7 @@ public function getParticipants(): array {
         $participant['id'] = $participantID;
         $participant['index'] = $count;
         $participant['contact'] = $this->getParticipantContact($participantID);
-        foreach ($participant['tax_rate_breakdown'] as $rate => $details) {
+        foreach ($participant['tax_rate_breakdown'] ?? [] as $rate => $details) {
           if ($details['amount'] === 0.0) {
             unset($participant['tax_rate_breakdown'][$rate]);
           }