Commit | Line | Data |
---|---|---|
43ceab3f TO |
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['contact'])) { | |
53 | $params = array( | |
54 | array('contact_id', '=', $row->context['contactId'], 0, 0), | |
55 | ); | |
56 | list($contact, $_) = \CRM_Contact_BAO_Query::apiQuery($params); | |
57 | $contact = reset($contact); //CRM-4524 | |
58 | if (!$contact || is_a($contact, 'CRM_Core_Error')) { | |
59 | // FIXME: Need to differentiate errors which kill the batch vs the individual row. | |
60 | throw new TokenException("Failed to generate token data. Invalid contact ID: " . $row->context['contactId']); | |
61 | } | |
62 | } | |
63 | else { | |
64 | $contact = $row->context['contact']; | |
65 | } | |
66 | ||
67 | if (!empty($row->context['tmpTokenParams'])) { | |
68 | // merge activity tokens with contact array | |
69 | // this is pretty weird. | |
70 | $contact = array_merge($contact, $row->context['tmpTokenParams']); | |
71 | } | |
72 | ||
73 | // Note: This is a small contract change from the past; data should be missing | |
74 | // less randomly. | |
75 | //\CRM_Utils_Hook::tokenValues($contact, $row->context['contactId']); | |
76 | \CRM_Utils_Hook::tokenValues($contact, | |
77 | $row->context['contactId'], | |
78 | empty($row->context['mailingJob']) ? NULL : $row->context['mailingJob']->id, | |
79 | $messageTokens, | |
80 | $row->context['controller'] | |
81 | ); | |
82 | ||
83 | $row->context('contact', $contact); | |
84 | } | |
85 | } | |
86 | ||
87 | /** | |
88 | * Apply the various CRM_Utils_Token helpers. | |
89 | * | |
90 | * @param TokenRenderEvent $e | |
91 | */ | |
92 | public function onRender(TokenRenderEvent $e) { | |
93 | $isHtml = ($e->message['format'] == 'text/html'); | |
94 | $useSmarty = !empty($e->context['smarty']); | |
95 | ||
43ceab3f TO |
96 | $e->string = \CRM_Utils_Token::replaceDomainTokens($e->string, \CRM_Core_BAO_Domain::getDomain(), $isHtml, $e->message['tokens'], $useSmarty); |
97 | ||
98 | if (!empty($e->context['contact'])) { | |
99 | $e->string = \CRM_Utils_Token::replaceContactTokens($e->string, $e->context['contact'], $isHtml, $e->message['tokens'], FALSE, $useSmarty); | |
43ceab3f TO |
100 | |
101 | // FIXME: This may depend on $contact being merged with hook values. | |
102 | $e->string = \CRM_Utils_Token::replaceHookTokens($e->string, $e->context['contact'], $e->context['hookTokenCategories'], $isHtml, $useSmarty); | |
e66cb98f TO |
103 | |
104 | \CRM_Utils_Token::replaceGreetingTokens($e->string, NULL, $e->context['contact']['contact_id'], NULL, $useSmarty); | |
43ceab3f TO |
105 | } |
106 | ||
107 | if ($useSmarty) { | |
108 | $smarty = \CRM_Core_Smarty::singleton(); | |
109 | $e->string = $smarty->fetch("string:" . $e->string); | |
110 | } | |
111 | } | |
112 | ||
113 | } |