(NFC) MessageTemplate - Add "INTERNAL" disclaimers for messageTemplate and tokenContext
authorTim Otten <totten@civicrm.org>
Mon, 9 Aug 2021 23:47:13 +0000 (16:47 -0700)
committerTim Otten <totten@civicrm.org>
Mon, 9 Aug 2021 23:47:13 +0000 (16:47 -0700)
CRM/Core/BAO/MessageTemplate.php

index 15b3012f8765d75cc00defa1ade7e1c1e7be7ef0..0025b80e5472d5cdaa2119b16596a302dd00743d 100644 (file)
@@ -383,12 +383,14 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
       'messageTemplateID' => NULL,
       // content of the message template
       // Ex: ['msg_subject' => 'Hello {contact.display_name}', 'msg_html' => '...', 'msg_text' => '...']
+      // INTERNAL: 'messageTemplate' is currently only intended for use within civicrm-core only. For downstream usage, future updates will provide comparable public APIs.
       'messageTemplate' => NULL,
       // contact id if contact tokens are to be replaced
       'contactId' => NULL,
       // additional template params (other than the ones already set in the template singleton)
       'tplParams' => [],
       // additional token params (passed to the TokenProcessor)
+      // INTERNAL: 'tokenContext' is currently only intended for use within civicrm-core only. For downstream usage, future updates will provide comparable public APIs.
       'tokenContext' => [],
       // the From: header
       'from' => NULL,