3 use Civi\Token\Event\TokenValueEvent
;
4 use Civi\Token\TokenProcessor
;
6 trait CRM_Core_TokenTrait
{
9 private $customFieldTokens;
12 * CRM_Entity_Tokens constructor.
14 public function __construct() {
15 parent
::__construct($this->getEntityName(), array_merge(
16 $this->getBasicTokens(),
17 $this->getCustomFieldTokens()
22 * Check if the token processor is active.
24 * @param \Civi\Token\TokenProcessor $processor
28 public function checkActive(TokenProcessor
$processor) {
29 return in_array($this->getEntityContextSchema(), $processor->context
['schema']) ||
30 (!empty($processor->context
['actionMapping'])
31 && $processor->context
['actionMapping']->getEntity() === $this->getEntityTableName());
37 public function getActiveTokens(TokenValueEvent
$e) {
38 $messageTokens = $e->getTokenProcessor()->getMessageTokens();
39 if (!isset($messageTokens[$this->entity
])) {
44 // if message token contains '_\d+_', then treat as '_N_'
45 foreach ($messageTokens[$this->entity
] as $msgToken) {
46 if (array_key_exists($msgToken, $this->tokenNames
)) {
47 $activeTokens[] = $msgToken;
50 return array_unique($activeTokens);
54 * Find the fields that we need to get to construct the tokens requested.
56 * @return array list of fields needed to generate those tokens
58 public function getReturnFields(): array {
59 // Make sure we always return something
63 array_merge(array_keys(self
::getBasicTokens()), array_keys(self
::getCustomFieldTokens()));
64 foreach ($tokensInUse as $token) {
65 if (isset(self
::$fieldMapping[$token])) {
66 $fields = array_merge($fields, self
::$fieldMapping[$token]);
72 return array_unique($fields);
76 * Get the tokens for custom fields
77 * @return array token name => token label
79 protected function getCustomFieldTokens(): array {
80 if (!isset($this->customFieldTokens
)) {
81 $this->customFieldTokens
= [];
82 foreach (CRM_Core_BAO_CustomField
::getFields(ucfirst($this->getEntityName())) as $id => $info) {
83 $this->customFieldTokens
['custom_' . $id] = $info['label'] . ' :: ' . $info['groupTitle'];
86 return $this->customFieldTokens
;