CRM_Mailing_ActionTokens

class CRM_Mailing_ActionTokens extends AbstractTokenSubscriber

Class CRM_Mailing_ActionTokens

Generate "action.*" tokens for mailings.

To activate these tokens, the TokenProcessor context must specify: "mailingJobId" (int) "mailingActionTarget" (array) with keys: 'id' => int, event queue ID 'hash' => string, event queue hash code 'contact_id' => int, contact_id, 'email' => string, email 'phone' => string, phone

Properties

string $entity from AbstractTokenSubscriber
array $tokenNames from AbstractTokenSubscriber

Methods

static 
getSubscribedEvents()

No description

from AbstractTokenSubscriber
__construct()

Class constructor.

bool
checkActive( $processor)

No description

registerTokens( $e)

Register the declared tokens.

from AbstractTokenSubscriber
array
getCustomTokens(string $entity)

Get all custom field tokens of $entity

from AbstractTokenSubscriber
alterActionScheduleQuery( $e)

Alter the query which prepopulates mailing data for scheduled reminders.

from AbstractTokenSubscriber
evaluateTokens( $e)

Populate the token data.

from AbstractTokenSubscriber
mixed
prefetch( $e)

To perform a bulk lookup before rendering tokens, override this function and return the prefetched data.

from AbstractTokenSubscriber
mixed
evaluateToken( $row, string $entity, string $field, mixed $prefetch = NULL)

No description

Details

in AbstractTokenSubscriber at line 57
static getSubscribedEvents()

at line 48
__construct()

Class constructor.

at line 67
bool checkActive( $processor)

Parameters

$processor

Return Value

bool

in AbstractTokenSubscriber at line 107
registerTokens( $e)

Register the declared tokens.

Parameters

$e The registration event. Add new tokens using register().

in AbstractTokenSubscriber at line 127
array getCustomTokens(string $entity)

Get all custom field tokens of $entity

Parameters

string $entity

Return Value

array $customTokens return custom field tokens in array('custom_N' => 'label') format

in AbstractTokenSubscriber at line 147
alterActionScheduleQuery( $e)

Alter the query which prepopulates mailing data for scheduled reminders.

This is method is not always appropriate, but if you're specifically focused on scheduled reminders, it can be convenient.

Parameters

$e The pending query which may be modified. See discussion on MailingQueryEvent::$query.

in AbstractTokenSubscriber at line 156
evaluateTokens( $e)

Populate the token data.

Parameters

$e The event, which includes a list of rows and tokens.

in AbstractTokenSubscriber at line 185
mixed prefetch( $e)

To perform a bulk lookup before rendering tokens, override this function and return the prefetched data.

Parameters

$e

Return Value

mixed

at line 74
mixed evaluateToken( $row, string $entity, string $field, mixed $prefetch = NULL)

Parameters

$row The record for which we want token values.
string $entity The name of the token entity.
string $field The name of the token field.
mixed $prefetch Any data that was returned by the prefetch().

Return Value

mixed