abstract class AbstractTokenSubscriber implements EventSubscriberInterface

Class AbstractTokenSubscriber

Properties

string $entity
array $tokenNames
array $activeTokens

Methods

static 
getSubscribedEvents()

No description

__construct($entity, array $tokenNames = [])

No description

bool
checkActive(TokenProcessor $processor)

Determine whether this token-handler should be used with the given processor.

registerTokens(TokenRegisterEvent $e)

Register the declared tokens.

alterActionScheduleQuery(MailingQueryEvent $e)

Alter the query which prepopulates mailing data for scheduled reminders.

evaluateTokens(TokenValueEvent $e)

Populate the token data.

mixed
getActiveTokens(TokenValueEvent $e)

To handle variable tokens, override this function and return the active tokens.

mixed
prefetch(TokenValueEvent $e)

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

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

Evaluate the content of a single token.

Details

at line 58
static getSubscribedEvents()

at line 91
__construct($entity, array $tokenNames = [])

Parameters

$entity
array $tokenNames Array(string $tokenName => string $label).

at line 106
bool checkActive(TokenProcessor $processor)

Determine whether this token-handler should be used with the given processor.

To short-circuit token-processing in irrelevant contexts, override this.

Parameters

TokenProcessor $processor

Return Value

bool

at line 116
registerTokens(TokenRegisterEvent $e)

Register the declared tokens.

Parameters

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

at line 140
alterActionScheduleQuery(MailingQueryEvent $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

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

at line 149
evaluateTokens(TokenValueEvent $e)

Populate the token data.

Parameters

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

at line 174
mixed getActiveTokens(TokenValueEvent $e)

To handle variable tokens, override this function and return the active tokens.

Parameters

TokenValueEvent $e

Return Value

mixed

at line 190
mixed prefetch(TokenValueEvent $e)

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

Parameters

TokenValueEvent $e

Return Value

mixed

at line 207
abstract mixed evaluateToken(TokenRow $row, string $entity, string $field, mixed $prefetch = NULL)

Evaluate the content of a single token.

Parameters

TokenRow $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