CRM/Core/TokenTrait.php

   1 <?php
   2
   3 use Civi\Token\Event\TokenValueEvent;
   4 use Civi\Token\TokenProcessor;
   5
   6 trait CRM_Core_TokenTrait {
   7
   8   private $basicTokens;
   9   private $customFieldTokens;
  10
  11   /**
  12    * CRM_Entity_Tokens constructor.
  13    */
  14   public function __construct() {
  15     parent::__construct($this->getEntityName(), array_merge(
  16       $this->getBasicTokens(),
  17       $this->getCustomFieldTokens()
  18     ));
  19   }
  20
  21   /**
  22    * Check if the token processor is active.
  23    *
  24    * @param \Civi\Token\TokenProcessor $processor
  25    *
  26    * @return bool
  27    */
  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());
  32   }
  33
  34   /**
  35    * @inheritDoc
  36    */
  37   public function getActiveTokens(TokenValueEvent $e) {
  38     $messageTokens = $e->getTokenProcessor()->getMessageTokens();
  39     if (!isset($messageTokens[$this->entity])) {
  40       return NULL;
  41     }
  42
  43     $activeTokens = [];
  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;
  48       }
  49       else {
  50         $altToken = preg_replace('/_\d+_/', '_N_', $msgToken);
  51         if (array_key_exists($altToken, $this->tokenNames)) {
  52           $activeTokens[] = $msgToken;
  53         }
  54       }
  55     }
  56     return array_unique($activeTokens);
  57   }
  58
  59   /**
  60    * Find the fields that we need to get to construct the tokens requested.
  61    * @param  array $activeTokens list of active tokens
  62    * @return array         list of fields needed to generate those tokens
  63    */
  64   public function getReturnFields($activeTokens) {
  65     // Make sure we always return something
  66     $fields = ['id'];
  67
  68     $tokensInUse = array_intersect(
  69       $activeTokens,
  70       array_merge(array_keys(self::getBasicTokens()), array_keys(self::getCustomFieldTokens()))
  71     );
  72     foreach ($tokensInUse as $token) {
  73       if (isset(self::$fieldMapping[$token])) {
  74         $fields = array_merge($fields, self::$fieldMapping[$token]);
  75       }
  76       else {
  77         $fields[] = $token;
  78       }
  79     }
  80     return array_unique($fields);
  81   }
  82
  83   /**
  84    * Get the tokens for custom fields
  85    * @return array token name => token label
  86    */
  87   protected function getCustomFieldTokens(): array {
  88     if (!isset($this->customFieldTokens)) {
  89       $this->customFieldTokens = \CRM_Utils_Token::getCustomFieldTokens(ucfirst($this->getEntityName()));
  90     }
  91     return $this->customFieldTokens;
  92   }
  93
  94 }