CRM_Contribute_Tokens

class CRM_Contribute_Tokens extends AbstractTokenSubscriber

Class CRM_Contribute_Tokens

Generate "contribution.*" tokens.

At time of writing, we don't have any particularly special tokens -- we just do some basic formatting based on the corresponding DB field.

Properties

string $entity from AbstractTokenSubscriber
array $tokenNames from AbstractTokenSubscriber
array $activeTokens from AbstractTokenSubscriber

Methods

static 
getSubscribedEvents()

No description

from AbstractTokenSubscriber
__construct()

Class constructor.

bool
checkActive(TokenProcessor $processor)

Check if the token processor is active.

registerTokens(TokenRegisterEvent $e)

Register the declared tokens.

from AbstractTokenSubscriber
alterActionScheduleQuery(MailingQueryEvent $e)

Alter action schedule query.

evaluateTokens(TokenValueEvent $e)

Populate the token data.

from AbstractTokenSubscriber
mixed
getActiveTokens(TokenValueEvent $e)

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

from AbstractTokenSubscriber
mixed
prefetch(TokenValueEvent $e)

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

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

No description

array
getPassthruTokens()

Get a list of tokens whose name and title match the DB fields.

array
getAliasTokens()

Get alias tokens.

Details

in AbstractTokenSubscriber at line 58
static getSubscribedEvents()

at line 79
__construct()

Class constructor.

at line 100
bool checkActive(TokenProcessor $processor)

Check if the token processor is active.

Parameters

TokenProcessor $processor

Return Value

bool

in AbstractTokenSubscriber at line 116
registerTokens(TokenRegisterEvent $e)

Register the declared tokens.

Parameters

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

at line 110
alterActionScheduleQuery(MailingQueryEvent $e)

Alter action schedule query.

Parameters

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

in AbstractTokenSubscriber at line 149
evaluateTokens(TokenValueEvent $e)

Populate the token data.

Parameters

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

in AbstractTokenSubscriber 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

in AbstractTokenSubscriber 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 127
mixed evaluateToken(TokenRow $row, string $entity, string $field, mixed $prefetch = NULL)

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

at line 43
protected array getPassthruTokens()

Get a list of tokens whose name and title match the DB fields.

Return Value

array

at line 65
protected array getAliasTokens()

Get alias tokens.

Return Value

array