3 trait CRM_Core_TokenTrait
{
6 private $customFieldTokens;
9 * CRM_Entity_Tokens constructor.
11 public function __construct() {
12 parent
::__construct($this->getEntityName(), array_merge(
13 $this->getBasicTokens(),
14 $this->getCustomFieldTokens()
21 public function checkActive(\Civi\Token\TokenProcessor
$processor) {
22 return in_array($this->getEntityContextSchema(), $processor->context
['schema']) ||
23 (!empty($processor->context
['actionMapping'])
24 && $processor->context
['actionMapping']->getEntity() === $this->getEntityTableName());
30 public function getActiveTokens(\Civi\Token\Event\TokenValueEvent
$e) {
31 $messageTokens = $e->getTokenProcessor()->getMessageTokens();
32 if (!isset($messageTokens[$this->entity
])) {
37 // if message token contains '_\d+_', then treat as '_N_'
38 foreach ($messageTokens[$this->entity
] as $msgToken) {
39 if (array_key_exists($msgToken, $this->tokenNames
)) {
40 $activeTokens[] = $msgToken;
43 $altToken = preg_replace('/_\d+_/', '_N_', $msgToken);
44 if (array_key_exists($altToken, $this->tokenNames
)) {
45 $activeTokens[] = $msgToken;
49 return array_unique($activeTokens);
53 * Find the fields that we need to get to construct the tokens requested.
54 * @param array $activeTokens list of active tokens
55 * @return array list of fields needed to generate those tokens
57 public function getReturnFields($activeTokens) {
58 // Make sure we always return something
61 $tokensInUse = array_intersect(
63 array_merge(array_keys(self
::getBasicTokens()), array_keys(self
::getCustomFieldTokens()))
65 foreach ($tokensInUse as $token) {
66 if (isset(self
::$fieldMapping[$token])) {
67 $fields = array_merge($fields, self
::$fieldMapping[$token]);
73 return array_unique($fields);
77 * Get the tokens for custom fields
78 * @return array token name => token label
80 protected function getCustomFieldTokens() {
81 if (!isset($this->customFieldTokens
)) {
82 $this->customFieldTokens
= \CRM_Utils_Token
::getCustomFieldTokens(ucfirst($this->getEntityName()));
84 return $this->customFieldTokens
;