1. class
  2. Civi
  3. Token
  4. TokenRow

TokenRow

class TokenRow

Class TokenRow

Properties

TokenProcessor $tokenProcessor
$tokenRow
$format
array|ArrayAccess $tokens
array|ArrayAccess $context

Methods

__construct( $tokenProcessor, $key)

No description

TokenRow
format(string $format)

No description

TokenRow
context(string|array $a = NULL, mixed $b = NULL)

Update the value of a context element.

TokenRow
tokens(string|array $a = NULL, string|array $b = NULL, mixed $c = NULL)

Update the value of a token.

TokenRow
customToken(string $entity, int $customFieldID, int $entityID)

Update the value of a custom field token.

TokenRow
dbToken(string $tokenEntity, string $tokenField, string $baoName, array $baoField, mixed $fieldValue)

Update the value of a token. Apply formatting based on DB schema.

TokenRow
fill(string $format = NULL)

Auto-convert between different formats

string
render(string $name)

Render a message.

Details

at line 65
__construct( $tokenProcessor, $key)

Parameters

$tokenProcessor
$key

at line 76
TokenRow format(string $format)

Parameters

string $format

Return Value

TokenRow

at line 89
TokenRow context(string|array $a = NULL, mixed $b = NULL)

Update the value of a context element.

Parameters

string|array $a
mixed $b

Return Value

TokenRow

at line 110
TokenRow tokens(string|array $a = NULL, string|array $b = NULL, mixed $c = NULL)

Update the value of a token.

Parameters

string|array $a
string|array $b
mixed $c

Return Value

TokenRow

at line 137
TokenRow customToken(string $entity, int $customFieldID, int $entityID)

Update the value of a custom field token.

Parameters

string $entity
int $customFieldID
int $entityID

Return Value

TokenRow

at line 163
TokenRow dbToken(string $tokenEntity, string $tokenField, string $baoName, array $baoField, mixed $fieldValue)

Update the value of a token. Apply formatting based on DB schema.

Parameters

string $tokenEntity
string $tokenField
string $baoName
array $baoField
mixed $fieldValue

Return Value

TokenRow

Exceptions

CRM_Core_Exception

at line 201
TokenRow fill(string $format = NULL)

Auto-convert between different formats

Parameters

string $format

Return Value

TokenRow

at line 262
string render(string $name)

Render a message.

Parameters

string $name The name previously registered with TokenProcessor::addMessage.

Return Value

string Fully rendered message, with tokens merged.