1. class
  2. Civi
  3. \
  4. Core
  5. \
  6. Event
  7. \
  8. GenericHookEvent

GenericHookEvent

class GenericHookEvent extends Event

Class GenericHookEvent

Properties

protected array $hookValues
protected array $hookFields
protected array $hookFieldsFlip

Methods

static GenericHookEvent
create(array $params)

Create a GenericHookEvent using key-value pairs.

static GenericHookEvent
createOrdered(array $hookFields, array $hookValues)

Create a GenericHookEvent using ordered parameters.

array
getHookValues()

No description

mixed
getReturnValues() deprecated

No description

GenericHookEvent
addReturnValues(mixed $fResult) deprecated

No description

__get($name)

No description

__set($name, $value)

No description

__isset($name)

No description

__unset($name)

No description

bool
hasField(string $name)

Determine whether the hook supports the given field.

Details

at line 136
static GenericHookEvent create(array $params)

Create a GenericHookEvent using key-value pairs.

Parameters

array $params Ex: array('contactID' => &$contactID, 'contentPlacement' => &$contentPlacement).

Return Value

GenericHookEvent

at line 154
static GenericHookEvent createOrdered(array $hookFields, array $hookValues)

Create a GenericHookEvent using ordered parameters.

Parameters

array $hookFields Ex: array(0 => 'contactID', 1 => 'contentPlacement').
array $hookValues Ex: array(0 => &$contactID, 1 => &$contentPlacement).

Return Value

GenericHookEvent

at line 182
array getHookValues()

Return Value

array Ex: array(0 => &$contactID, 1 => &$contentPlacement).

at line 190
mixed getReturnValues() deprecated

deprecated

Return Value

mixed

at line 199
GenericHookEvent addReturnValues(mixed $fResult) deprecated

deprecated

Parameters

mixed $fResult

Return Value

GenericHookEvent

at line 209
__get($name)

Parameters

$name

at line 218
__set($name, $value)

Parameters

$name
$value

at line 227
__isset($name)

Parameters

$name

at line 235
__unset($name)

Parameters

$name

at line 251
bool hasField(string $name)

Determine whether the hook supports the given field.

The field may or may not be empty. Use isset() or empty() to check that.

Parameters

string $name

Return Value

bool