From 792d2ee7f0393b3304f053f9410a45ec06d4ca59 Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Thu, 22 Jun 2023 17:17:47 -0700
Subject: [PATCH] GenericWorkflowMessage - Add template-related properties
 (TemplateTrait)

---
 .../GenericWorkflowMessage.php                |  4 ++
 Civi/WorkflowMessage/Traits/TemplateTrait.php | 53 +++++++++++++++++++
 2 files changed, 57 insertions(+)
 create mode 100644 Civi/WorkflowMessage/Traits/TemplateTrait.php

diff --git a/Civi/WorkflowMessage/GenericWorkflowMessage.php b/Civi/WorkflowMessage/GenericWorkflowMessage.php
index 7eb6a59b1c..efec672168 100644
--- a/Civi/WorkflowMessage/GenericWorkflowMessage.php
+++ b/Civi/WorkflowMessage/GenericWorkflowMessage.php
@@ -17,6 +17,7 @@ use Civi\WorkflowMessage\Traits\AddressingTrait;
 use Civi\WorkflowMessage\Traits\FinalHelperTrait;
 use Civi\WorkflowMessage\Traits\LocalizationTrait;
 use Civi\WorkflowMessage\Traits\ReflectiveWorkflowTrait;
+use Civi\WorkflowMessage\Traits\TemplateTrait;
 
 /**
  * Generic base-class for describing the inputs for a workflow email template.
@@ -48,6 +49,9 @@ class GenericWorkflowMessage implements WorkflowMessageInterface {
   // Implement setLocale(), etc
   use LocalizationTrait;
 
+  // Implement setTemplate(), etc
+  use TemplateTrait;
+
   /**
    * WorkflowMessage constructor.
    *
diff --git a/Civi/WorkflowMessage/Traits/TemplateTrait.php b/Civi/WorkflowMessage/Traits/TemplateTrait.php
new file mode 100644
index 0000000000..ede965d4dd
--- /dev/null
+++ b/Civi/WorkflowMessage/Traits/TemplateTrait.php
@@ -0,0 +1,53 @@
+<?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       |
+ +--------------------------------------------------------------------+
+ */
+
+namespace Civi\WorkflowMessage\Traits;
+
+/**
+ * @method getTemplate(): ?array
+ * @method setTemplate(?array $value): $this
+ * @method getTemplateId(): ?int
+ * @method setTemplateId(?int $value): $this
+ * @method getIsTest(): ?bool
+ * @method setIsTest(?bool $value): $this
+ */
+trait TemplateTrait {
+
+  abstract public function getLocale(): ?string;
+
+  abstract public function setLocale(?string $locale);
+
+  /**
+   * The content of the message-template.
+   *
+   * Ex: [
+   *   'msg_subject' => 'Hello {contact.first_name}',
+   *   'msg_html' => '<p>Greetings and salutations, {contact.display_name}!</p>'
+   * ]
+   *
+   * @var array|null
+   * @scope envelope as messageTemplate
+   */
+  protected $template;
+
+  /**
+   * @var int|null
+   * @scope envelope as messageTemplateID
+   */
+  protected $templateId;
+
+  /**
+   * @var bool
+   * @scope envelope
+   */
+  protected $isTest;
+
+}
-- 
2.25.1