Commit | Line | Data |
---|---|---|
8adcd073 TO |
1 | <?php |
2 | namespace Civi\Token; | |
3 | ||
4 | use Civi\Token\Event\TokenRegisterEvent; | |
5 | use Civi\Token\Event\TokenRenderEvent; | |
6 | use Civi\Token\Event\TokenValueEvent; | |
7 | use Symfony\Component\EventDispatcher\EventDispatcherInterface; | |
8 | use Traversable; | |
9 | ||
10 | class TokenProcessor { | |
11 | ||
12 | /** | |
13 | * @var array | |
14 | * Description of the context in which the tokens are being processed. | |
15 | * Ex: Array('class'=>'CRM_Core_BAO_ActionSchedule', 'schedule' => $dao, 'mapping' => $dao). | |
16 | * Ex: Array('class'=>'CRM_Mailing_BAO_MailingJob', 'mailing' => $dao). | |
17 | * | |
18 | * For lack of a better place, here's a list of known/intended context values: | |
19 | * | |
20 | * - controller: string, the class which is managing the mail-merge. | |
21 | * - smarty: bool, whether to enable smarty support. | |
22 | * - contactId: int, the main person/org discussed in the message. | |
23 | * - contact: array, the main person/org discussed in the message. | |
24 | * (Optional for performance tweaking; if omitted, will load | |
25 | * automatically from contactId.) | |
26 | * - actionSchedule: DAO, the rule which triggered the mailing | |
27 | * [for CRM_Core_BAO_ActionScheduler]. | |
28 | */ | |
29 | public $context; | |
30 | ||
31 | /** | |
32 | * @var EventDispatcherInterface | |
33 | */ | |
34 | protected $dispatcher; | |
35 | ||
36 | /** | |
37 | * @var array | |
38 | * Each message is an array with keys: | |
39 | * - string: Unprocessed message (eg "Hello, {display_name}."). | |
40 | * - format: Media type (eg "text/plain"). | |
41 | * - tokens: List of tokens which are actually used in this message. | |
42 | */ | |
43 | protected $messages; | |
44 | ||
45 | /** | |
46 | * DO NOT access field this directly. Use TokenRow. This is | |
47 | * marked as public only to benefit TokenRow. | |
48 | * | |
49 | * @var array | |
50 | * Array(int $pos => array $keyValues); | |
51 | */ | |
52 | public $rowContexts; | |
53 | ||
54 | /** | |
55 | * DO NOT access field this directly. Use TokenRow. This is | |
56 | * marked as public only to benefit TokenRow. | |
57 | * | |
58 | * @var array | |
59 | * Ex: $rowValues[$rowPos][$format][$entity][$field] = 'something'; | |
60 | * Ex: $rowValues[3]['text/plain']['contact']['display_name'] = 'something'; | |
61 | */ | |
62 | public $rowValues; | |
63 | ||
64 | /** | |
65 | * A list of available tokens | |
66 | * @var array | |
67 | * Array(string $dottedName => array('entity'=>string, 'field'=>string, 'label'=>string)). | |
68 | */ | |
69 | protected $tokens = NULL; | |
70 | ||
1c4a04c9 AS |
71 | /** |
72 | * A list of available tokens formatted for display | |
73 | * @var array | |
74 | * Array('{' . $dottedName . '}' => 'labelString') | |
75 | */ | |
76 | protected $listTokens = NULL; | |
77 | ||
8adcd073 TO |
78 | protected $next = 0; |
79 | ||
80 | /** | |
81 | * @param EventDispatcherInterface $dispatcher | |
82 | * @param array $context | |
83 | */ | |
84 | public function __construct($dispatcher, $context) { | |
85 | $this->dispatcher = $dispatcher; | |
86 | $this->context = $context; | |
87 | } | |
88 | ||
89 | /** | |
90 | * Register a string for which we'll need to merge in tokens. | |
91 | * | |
92 | * @param string $name | |
93 | * Ex: 'subject', 'body_html'. | |
94 | * @param string $value | |
95 | * Ex: '<p>Hello {contact.name}</p>'. | |
96 | * @param string $format | |
97 | * Ex: 'text/html'. | |
4b350175 | 98 | * @return TokenProcessor |
8adcd073 TO |
99 | */ |
100 | public function addMessage($name, $value, $format) { | |
101 | $this->messages[$name] = array( | |
102 | 'string' => $value, | |
103 | 'format' => $format, | |
104 | 'tokens' => \CRM_Utils_Token::getTokens($value), | |
105 | ); | |
106 | return $this; | |
107 | } | |
108 | ||
109 | /** | |
110 | * Add a row of data. | |
111 | * | |
112 | * @return TokenRow | |
113 | */ | |
114 | public function addRow() { | |
115 | $key = $this->next++; | |
116 | $this->rowContexts[$key] = array(); | |
117 | $this->rowValues[$key] = array( | |
118 | 'text/plain' => array(), | |
119 | 'text/html' => array(), | |
120 | ); | |
121 | ||
122 | return new TokenRow($this, $key); | |
123 | } | |
124 | ||
125 | /** | |
126 | * @param array $params | |
127 | * Array with keys: | |
128 | * - entity: string, e.g. "profile". | |
129 | * - field: string, e.g. "viewUrl". | |
130 | * - label: string, e.g. "Default Profile URL (View Mode)". | |
4b350175 | 131 | * @return TokenProcessor |
8adcd073 TO |
132 | */ |
133 | public function addToken($params) { | |
134 | $key = $params['entity'] . '.' . $params['field']; | |
135 | $this->tokens[$key] = $params; | |
136 | return $this; | |
137 | } | |
138 | ||
139 | /** | |
140 | * @param string $name | |
141 | * @return array | |
142 | * Keys: | |
143 | * - string: Unprocessed message (eg "Hello, {display_name}."). | |
144 | * - format: Media type (eg "text/plain"). | |
145 | */ | |
146 | public function getMessage($name) { | |
147 | return $this->messages[$name]; | |
148 | } | |
149 | ||
150 | /** | |
151 | * Get a list of all tokens used in registered messages. | |
152 | * | |
153 | * @return array | |
154 | */ | |
155 | public function getMessageTokens() { | |
156 | $tokens = array(); | |
157 | foreach ($this->messages as $message) { | |
158 | $tokens = \CRM_Utils_Array::crmArrayMerge($tokens, $message['tokens']); | |
159 | } | |
160 | foreach (array_keys($tokens) as $e) { | |
161 | $tokens[$e] = array_unique($tokens[$e]); | |
162 | sort($tokens[$e]); | |
163 | } | |
164 | return $tokens; | |
165 | } | |
166 | ||
167 | public function getRow($key) { | |
168 | return new TokenRow($this, $key); | |
169 | } | |
170 | ||
171 | /** | |
172 | * @return \Traversable<TokenRow> | |
173 | */ | |
174 | public function getRows() { | |
175 | return new TokenRowIterator($this, new \ArrayIterator($this->rowContexts)); | |
176 | } | |
177 | ||
5d798402 AS |
178 | /** |
179 | * Get a list of all unique values for a given context field, | |
180 | * whether defined at the processor or row level. | |
181 | * | |
182 | * @param string $field | |
183 | * Ex: 'contactId'. | |
184 | * @return array | |
185 | * Ex: [12, 34, 56]. | |
186 | */ | |
8580ab67 | 187 | public function getContextValues($field, $subfield = NULL) { |
5d798402 AS |
188 | $values = []; |
189 | if (isset($this->context[$field])) { | |
8580ab67 AS |
190 | if ($subfield) { |
191 | if (isset($this->context[$field]->$subfield)) { | |
192 | $values[] = $this->context[$field]->$subfield; | |
193 | } | |
194 | } | |
195 | else { | |
196 | $values[] = $this->context[$field]; | |
197 | } | |
5d798402 AS |
198 | } |
199 | foreach ($this->getRows() as $row) { | |
200 | if (isset($row->context[$field])) { | |
8580ab67 AS |
201 | if ($subfield) { |
202 | if (isset($row->context[$field]->$subfield)) { | |
203 | $values[] = $row->context[$field]->$subfield; | |
204 | } | |
205 | } | |
206 | else { | |
207 | $values[] = $row->context[$field]; | |
208 | } | |
5d798402 AS |
209 | } |
210 | } | |
211 | $values = array_unique($values); | |
212 | return $values; | |
213 | } | |
214 | ||
8adcd073 TO |
215 | /** |
216 | * Get the list of available tokens. | |
217 | * | |
218 | * @return array | |
219 | * Ex: $tokens['event'] = array('location', 'start_date', 'end_date'). | |
220 | */ | |
221 | public function getTokens() { | |
222 | if ($this->tokens === NULL) { | |
223 | $this->tokens = array(); | |
224 | $event = new TokenRegisterEvent($this, array('entity' => 'undefined')); | |
225 | $this->dispatcher->dispatch(Events::TOKEN_REGISTER, $event); | |
226 | } | |
227 | return $this->tokens; | |
228 | } | |
229 | ||
1c4a04c9 AS |
230 | /** |
231 | * Get the list of available tokens, formatted for display | |
232 | * | |
233 | * @return array | |
234 | * Ex: $tokens[ '{token.name}' ] = "Token label" | |
235 | */ | |
236 | public function listTokens() { | |
237 | if ($this->listTokens === NULL) { | |
238 | $this->listTokens = array(); | |
239 | foreach ($this->getTokens() as $token => $values) { | |
240 | $this->listTokens['{' . $token . '}'] = $values['label']; | |
241 | } | |
242 | } | |
243 | return $this->listTokens; | |
244 | } | |
245 | ||
8adcd073 TO |
246 | /** |
247 | * Compute and store token values. | |
248 | */ | |
249 | public function evaluate() { | |
250 | $event = new TokenValueEvent($this); | |
251 | $this->dispatcher->dispatch(Events::TOKEN_EVALUATE, $event); | |
252 | return $this; | |
253 | } | |
254 | ||
255 | /** | |
256 | * Render a message. | |
257 | * | |
258 | * @param string $name | |
259 | * The name previously registered with addMessage(). | |
260 | * @param TokenRow|int $row | |
261 | * The object or ID for the row previously registered with addRow(). | |
262 | * @return string | |
263 | * Fully rendered message, with tokens merged. | |
264 | */ | |
265 | public function render($name, $row) { | |
266 | if (!is_object($row)) { | |
267 | $row = $this->getRow($row); | |
268 | } | |
269 | ||
270 | $message = $this->getMessage($name); | |
271 | $row->fill($message['format']); | |
272 | $useSmarty = !empty($row->context['smarty']); | |
273 | ||
274 | // FIXME preg_callback. | |
275 | $tokens = $this->rowValues[$row->tokenRow][$message['format']]; | |
276 | $flatTokens = array(); | |
277 | \CRM_Utils_Array::flatten($tokens, $flatTokens, '', '.'); | |
278 | $filteredTokens = array(); | |
279 | foreach ($flatTokens as $k => $v) { | |
280 | $filteredTokens['{' . $k . '}'] = ($useSmarty ? \CRM_Utils_Token::tokenEscapeSmarty($v) : $v); | |
281 | } | |
282 | ||
283 | $event = new TokenRenderEvent($this); | |
284 | $event->message = $message; | |
285 | $event->context = $row->context; | |
286 | $event->row = $row; | |
287 | $event->string = strtr($message['string'], $filteredTokens); | |
288 | $this->dispatcher->dispatch(Events::TOKEN_RENDER, $event); | |
289 | return $event->string; | |
290 | } | |
291 | ||
292 | } | |
293 | ||
294 | class TokenRowIterator extends \IteratorIterator { | |
295 | ||
296 | protected $tokenProcessor; | |
297 | ||
298 | /** | |
299 | * @param TokenProcessor $tokenProcessor | |
300 | * @param Traversable $iterator | |
301 | */ | |
302 | public function __construct(TokenProcessor $tokenProcessor, Traversable $iterator) { | |
303 | parent::__construct($iterator); // TODO: Change the autogenerated stub | |
304 | $this->tokenProcessor = $tokenProcessor; | |
305 | } | |
306 | ||
307 | public function current() { | |
308 | return new TokenRow($this->tokenProcessor, parent::key()); | |
309 | } | |
310 | ||
311 | } |