class CRM_Member_Tokens extends AbstractTokenSubscriber

Class CRM_Member_Tokens

Generate "member.*" tokens.

This TokenSubscriber was produced by refactoring the code from the scheduled-reminder system with the goal of making that system more flexible. The current implementation is still coupled to scheduled-reminders. It would be good to figure out a more generic implementation which is not tied to scheduled reminders, although that is outside the current scope.

Properties

string $entity from AbstractTokenSubscriber
array $tokenNames from AbstractTokenSubscriber

Methods

static 
getSubscribedEvents()

No description

__construct()

Class constructor.

bool
checkActive( $processor)

No description

registerTokens( $e)

Register the declared tokens.

array
getCustomTokens(string $entity)

Get all custom field tokens of $entity

alterActionScheduleQuery( $e)

Alter action schedule query.

evaluateTokens( $e)

Populate the token data.

mixed
prefetch( $e)

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

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

No description

Details

static getSubscribedEvents()

at line 46
__construct()

Class constructor.

at line 64
bool checkActive( $processor)

Parameters

$processor

Return Value

bool

registerTokens( $e)

Register the declared tokens.

Parameters

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

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

at line 76
alterActionScheduleQuery( $e)

Alter action schedule query.

Parameters

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

evaluateTokens( $e)

Populate the token data.

Parameters

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

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 92
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