Commit | Line | Data |
---|---|---|
8adcd073 TO |
1 | <?php |
2 | namespace Civi\Token\Event; | |
3 | ||
4 | /** | |
5 | * Class TokenRenderEvent | |
6 | * @package Civi\Token\Event | |
7 | * | |
8 | * A TokenRenderEvent is fired after the TokenProcessor has rendered | |
9 | * a message. | |
10 | * | |
11 | * The render event may be used for post-processing the text, but | |
12 | * it's very difficult to do substantive work in a secure, robust | |
13 | * way within this event. The event primarily exists to facilitate | |
14 | * a transition of some legacy code. | |
15 | */ | |
16 | class TokenRenderEvent extends TokenEvent { | |
17 | ||
18 | /** | |
19 | * @var array|\ArrayAccess | |
20 | */ | |
21 | public $context; | |
22 | ||
23 | /** | |
24 | * @var array|\ArrayAccess | |
25 | * | |
26 | * The original message template. | |
27 | */ | |
28 | public $message; | |
29 | ||
30 | /** | |
31 | * @var \Civi\Token\TokenRow | |
32 | * | |
33 | * The record for which we're generating date | |
34 | */ | |
35 | public $row; | |
36 | ||
37 | /** | |
38 | * @var string | |
39 | * | |
40 | * The rendered string, with tokens replaced. | |
41 | */ | |
42 | public $string; | |
43 | ||
44 | } |