1. class
  2. Civi
  3. Token
  4. Event
  5. TokenRegisterEvent

TokenRegisterEvent

class TokenRegisterEvent extends TokenEvent

Class TokenRegisterEvent

Properties

protected $tokenProcessor from TokenEvent
protected array $defaults Default values to put in new registrations.

Methods

__construct($tokenProcessor, $defaults)

No description

TokenProcessor
getTokenProcessor()

No description

from TokenEvent
TokenRegisterEvent
entity(string $entity)

Set the default entity name.

TokenRegisterEvent
register(array|string $paramsOrField, NULL|string $label = NULL)

Register a new token.

Details

at line 31
__construct($tokenProcessor, $defaults)

Parameters

$tokenProcessor
$defaults

in TokenEvent at line 21
TokenProcessor getTokenProcessor()

Return Value

TokenProcessor

at line 42
TokenRegisterEvent entity(string $entity)

Set the default entity name.

Parameters

string $entity

Return Value

TokenRegisterEvent

at line 55
TokenRegisterEvent register(array|string $paramsOrField, NULL|string $label = NULL)

Register a new token.

Parameters

array|string $paramsOrField
NULL|string $label

Return Value

TokenRegisterEvent