Civi/Token/TokenCompatSubscriber.php

   1 <?php
   2 namespace Civi\Token;
   3
   4 use Civi\Token\Event\TokenRenderEvent;
   5 use Civi\Token\Event\TokenValueEvent;
   6 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
   7
   8 /**
   9  * Class TokenCompatSubscriber
  10  * @package Civi\Token
  11  *
  12  * This class provides a compatibility layer for using CRM_Utils_Token
  13  * helpers within TokenProcessor.
  14  *
  15  * THIS IS NOT A GOOD EXAMPLE TO EMULATE. The class exists to two
  16  * bridge two different designs. CRM_Utils_Token has some
  17  * undesirable elements (like iterative token substitution).
  18  * However, if you're refactor CRM_Utils_Token or improve the
  19  * bridge, then it makes sense to update this class.
  20  */
  21 class TokenCompatSubscriber implements EventSubscriberInterface {
  22
  23   /**
  24    * @inheritDoc
  25    */
  26   public static function getSubscribedEvents() {
  27     return array(
  28       Events::TOKEN_EVALUATE => 'onEvaluate',
  29       Events::TOKEN_RENDER => 'onRender',
  30     );
  31   }
  32
  33   /**
  34    * Load token data.
  35    *
  36    * @param TokenValueEvent $e
  37    * @throws TokenException
  38    */
  39   public function onEvaluate(TokenValueEvent $e) {
  40     // For reasons unknown, replaceHookTokens requires a pre-computed list of
  41     // hook *categories* (aka entities aka namespaces). We'll cache
  42     // this in the TokenProcessor's context.
  43
  44     $hookTokens = array();
  45     \CRM_Utils_Hook::tokens($hookTokens);
  46     $categories = array_keys($hookTokens);
  47     $e->getTokenProcessor()->context['hookTokenCategories'] = $categories;
  48
  49     $messageTokens = $e->getTokenProcessor()->getMessageTokens();
  50
  51     foreach ($e->getRows() as $row) {
  52       if (empty($row->context['contactId'])) {
  53         continue;
  54       }
  55       /** @var int $contactId */
  56       $contactId = $row->context['contactId'];
  57       if (empty($row->context['contact'])) {
  58         $params = array(
  59           array('contact_id', '=', $contactId, 0, 0),
  60         );
  61         list($contact, $_) = \CRM_Contact_BAO_Query::apiQuery($params);
  62         $contact = reset($contact); //CRM-4524
  63         if (!$contact || is_a($contact, 'CRM_Core_Error')) {
  64           // FIXME: Need to differentiate errors which kill the batch vs the individual row.
  65           throw new TokenException("Failed to generate token data. Invalid contact ID: " . $row->context['contactId']);
  66         }
  67
  68         //update value of custom field token
  69         if (!empty($messageTokens['contact'])) {
  70           foreach ($messageTokens['contact'] as $token) {
  71             if (\CRM_Core_BAO_CustomField::getKeyID($token)) {
  72               $contact[$token] = civicrm_api3('Contact', 'getvalue', array(
  73                 'return' => $token,
  74                 'id' => $contactId,
  75               ));
  76             }
  77           }
  78         }
  79       }
  80       else {
  81         $contact = $row->context['contact'];
  82       }
  83
  84       if (!empty($row->context['tmpTokenParams'])) {
  85         // merge activity tokens with contact array
  86         // this is pretty weird.
  87         $contact = array_merge($contact, $row->context['tmpTokenParams']);
  88       }
  89
  90       $contactArray = !is_array($contactId) ? array($contactId => $contact) : $contact;
  91
  92       // Note: This is a small contract change from the past; data should be missing
  93       // less randomly.
  94       \CRM_Utils_Hook::tokenValues($contactArray,
  95         (array) $contactId,
  96         empty($row->context['mailingJobId']) ? NULL : $row->context['mailingJobId'],
  97         $messageTokens,
  98         $row->context['controller']
  99       );
 100
 101       // merge the custom tokens in the $contact array
 102       if (!empty($contactArray[$contactId])) {
 103         $contact = array_merge($contact, $contactArray[$contactId]);
 104       }
 105       $row->context('contact', $contact);
 106     }
 107   }
 108
 109   /**
 110    * Apply the various CRM_Utils_Token helpers.
 111    *
 112    * @param TokenRenderEvent $e
 113    */
 114   public function onRender(TokenRenderEvent $e) {
 115     $isHtml = ($e->message['format'] == 'text/html');
 116     $useSmarty = !empty($e->context['smarty']);
 117
 118     $domain = \CRM_Core_BAO_Domain::getDomain();
 119     $e->string = \CRM_Utils_Token::replaceDomainTokens($e->string, $domain, $isHtml, $e->message['tokens'], $useSmarty);
 120
 121     if (!empty($e->context['contact'])) {
 122       $e->string = \CRM_Utils_Token::replaceContactTokens($e->string, $e->context['contact'], $isHtml, $e->message['tokens'], TRUE, $useSmarty);
 123
 124       // FIXME: This may depend on $contact being merged with hook values.
 125       $e->string = \CRM_Utils_Token::replaceHookTokens($e->string, $e->context['contact'], $e->context['hookTokenCategories'], $isHtml, $useSmarty);
 126
 127       \CRM_Utils_Token::replaceGreetingTokens($e->string, $e->context['contact'], $e->context['contact']['contact_id'], NULL, $useSmarty);
 128     }
 129
 130     if ($useSmarty) {
 131       $smarty = \CRM_Core_Smarty::singleton();
 132       $e->string = $smarty->fetch("string:" . $e->string);
 133     }
 134   }
 135
 136 }