8 * A TokenRow is a helper providing simplified access to the
11 * A TokenRow combines two elements:
12 * - context: This is backend data provided by the controller.
13 * - tokens: This is frontend data that can be mail-merged.
15 * The context and tokens can be accessed using either methods
16 * or attributes. The methods are appropriate for updates
17 * (and generally accept a mix of arrays), and the attributes
18 * are appropriate for reads.
20 * To update the context or the tokens, use the methods.
21 * Note that the methods are fairly flexible about accepting
22 * single values or arrays. If given an array, the values
23 * will be merged recursively.
27 * ->context('contact_id', 123)
28 * ->context(array('contact_id' => 123))
29 * ->tokens('profile', array('viewUrl' => 'http://example.com'))
30 * ->tokens('profile', 'viewUrl, 'http://example.com');
32 * echo $row->context['contact_id'];
33 * echo $row->tokens['profile']['viewUrl'];
35 * $row->tokens('profile', array(
36 * 'viewUrl' => 'http://example.com/view/' . urlencode($row->context['contact_id'];
45 public $tokenProcessor;
52 * @var array|\ArrayAccess
53 * List of token values.
54 * Ex: array('contact' => array('display_name' => 'Alice')).
59 * @var array|\ArrayAccess
60 * List of context values.
61 * Ex: array('controller' => 'CRM_Foo_Bar').
65 public function __construct(TokenProcessor
$tokenProcessor, $key) {
66 $this->tokenProcessor
= $tokenProcessor;
67 $this->tokenRow
= $key;
68 $this->format('text/plain'); // Set a default.
69 $this->context
= new TokenRowContext($tokenProcessor, $key);
73 * @param string $format
76 public function format($format) {
77 $this->format
= $format;
78 $this->tokens
= &$this->tokenProcessor
->rowValues
[$this->tokenRow
][$format];
83 * Update the value of a context element.
85 * @param string|array $a
89 public function context($a = NULL, $b = NULL) {
91 \CRM_Utils_Array
::extend($this->tokenProcessor
->rowContexts
[$this->tokenRow
], $a);
93 elseif (is_array($b)) {
94 \CRM_Utils_Array
::extend($this->tokenProcessor
->rowContexts
[$this->tokenRow
][$a], $b);
97 $this->tokenProcessor
->rowContexts
[$this->tokenRow
][$a] = $b;
103 * Update the value of a token.
105 * @param string|array $a
106 * @param string|array $b
110 public function tokens($a = NULL, $b = NULL, $c = NULL) {
112 \CRM_Utils_Array
::extend($this->tokens
, $a);
114 elseif (is_array($b)) {
115 \CRM_Utils_Array
::extend($this->tokens
[$a], $b);
117 elseif (is_array($c)) {
118 \CRM_Utils_Array
::extend($this->tokens
[$a][$b], $c);
120 elseif ($c === NULL) {
121 $this->tokens
[$a] = $b;
124 $this->tokens
[$a][$b] = $c;
130 * Update the value of a custom field token.
132 * @param string $entity
133 * @param int $customFieldID
134 * @param int $entityID
137 public function customToken($entity, $customFieldID, $entityID) {
138 $customFieldName = "custom_" . $customFieldID;
139 $fieldValue = civicrm_api3($entity, 'getvalue', array(
140 'return' => $customFieldName,
144 // format the raw custom field value into proper display value
146 $fieldValue = \CRM_Core_BAO_CustomField
::displayValue($fieldValue, $customFieldID);
149 return $this->tokens($entity, $customFieldName, $fieldValue);
153 * Update the value of a token. Apply formatting based on DB schema.
155 * @param string $tokenEntity
156 * @param string $tokenField
157 * @param string $baoName
158 * @param array $baoField
159 * @param mixed $fieldValue
161 * @throws \CRM_Core_Exception
163 public function dbToken($tokenEntity, $tokenField, $baoName, $baoField, $fieldValue) {
164 if ($fieldValue === NULL ||
$fieldValue === '') {
165 return $this->tokens($tokenEntity, $tokenField, '');
168 $fields = $baoName::fields();
169 if (!empty($fields[$baoField]['pseudoconstant'])) {
170 $options = $baoName::buildOptions($baoField, 'get');
171 return $this->format('text/plain')->tokens($tokenEntity, $tokenField, $options[$fieldValue]);
174 switch ($fields[$baoField]['type']) {
175 case \CRM_Utils_Type
::T_DATE + \CRM_Utils_Type
::T_TIME
:
176 return $this->format('text/plain')->tokens($tokenEntity, $tokenField, \CRM_Utils_Date
::customFormat($fieldValue));
178 case \CRM_Utils_Type
::T_MONEY
:
179 // Is this something you should ever use? Seems like you need more context
180 // to know which currency to use.
181 return $this->format('text/plain')->tokens($tokenEntity, $tokenField, \CRM_Utils_Money
::format($fieldValue));
183 case \CRM_Utils_Type
::T_STRING
:
184 case \CRM_Utils_Type
::T_BOOLEAN
:
185 case \CRM_Utils_Type
::T_INT
:
186 case \CRM_Utils_Type
::T_TEXT
:
187 return $this->format('text/plain')->tokens($tokenEntity, $tokenField, $fieldValue);
191 throw new \
CRM_Core_Exception("Cannot format token for field '$baoField' in '$baoName'");
195 * Auto-convert between different formats
197 * @param string $format
201 public function fill($format = NULL) {
202 if ($format === NULL) {
203 $format = $this->format
;
206 if (!isset($this->tokenProcessor
->rowValues
[$this->tokenRow
]['text/html'])) {
207 $this->tokenProcessor
->rowValues
[$this->tokenRow
]['text/html'] = array();
209 if (!isset($this->tokenProcessor
->rowValues
[$this->tokenRow
]['text/plain'])) {
210 $this->tokenProcessor
->rowValues
[$this->tokenRow
]['text/plain'] = array();
213 $htmlTokens = &$this->tokenProcessor
->rowValues
[$this->tokenRow
]['text/html'];
214 $textTokens = &$this->tokenProcessor
->rowValues
[$this->tokenRow
]['text/plain'];
219 foreach ($textTokens as $entity => $values) {
220 foreach ($values as $field => $value) {
221 if (!isset($htmlTokens[$entity][$field])) {
222 // CRM-18420 - Activity Details Field are enclosed within <p>,
223 // hence if $body_text is empty, htmlentities will lead to
224 // conversion of these tags resulting in raw HTML.
225 if ($entity == 'activity' && $field == 'details') {
226 $htmlTokens[$entity][$field] = $value;
229 $htmlTokens[$entity][$field] = htmlentities($value);
238 foreach ($htmlTokens as $entity => $values) {
239 foreach ($values as $field => $value) {
240 if (!isset($textTokens[$entity][$field])) {
241 $textTokens[$entity][$field] = html_entity_decode(strip_tags($value));
248 throw new \
RuntimeException("Invalid format");
257 * @param string $name
258 * The name previously registered with TokenProcessor::addMessage.
260 * Fully rendered message, with tokens merged.
262 public function render($name) {
263 return $this->tokenProcessor
->render($name, $this);
269 * Class TokenRowContext
270 * @package Civi\Token
272 * Combine the row-context and general-context into a single array-like facade.
274 class TokenRowContext
implements \ArrayAccess
, \IteratorAggregate
, \Countable
{
277 * @var TokenProcessor
279 protected $tokenProcessor;
286 * @param array $tokenProcessor
287 * @param array $tokenRow
289 public function __construct($tokenProcessor, $tokenRow) {
290 $this->tokenProcessor
= $tokenProcessor;
291 $this->tokenRow
= $tokenRow;
297 * @param mixed $offset
301 public function offsetExists($offset) {
303 isset($this->tokenProcessor
->rowContexts
[$this->tokenRow
][$offset])
304 ||
isset($this->tokenProcessor
->context
[$offset]);
310 * @param string $offset
314 public function &offsetGet($offset) {
315 if (isset($this->tokenProcessor
->rowContexts
[$this->tokenRow
][$offset])) {
316 return $this->tokenProcessor
->rowContexts
[$this->tokenRow
][$offset];
318 if (isset($this->tokenProcessor
->context
[$offset])) {
319 return $this->tokenProcessor
->context
[$offset];
328 * @param string $offset
329 * @param mixed $value
331 public function offsetSet($offset, $value) {
332 $this->tokenProcessor
->rowContexts
[$this->tokenRow
][$offset] = $value;
338 * @param mixed $offset
340 public function offsetUnset($offset) {
341 unset($this->tokenProcessor
->rowContexts
[$this->tokenRow
][$offset]);
347 * @return \ArrayIterator
349 public function getIterator() {
350 return new \
ArrayIterator($this->createMergedArray());
358 public function count() {
359 return count($this->createMergedArray());
363 * Create merged array.
367 protected function createMergedArray() {
369 $this->tokenProcessor
->rowContexts
[$this->tokenRow
],
370 $this->tokenProcessor
->context