Documentation

CheckSendableEvent extends GenericHookEvent
in package

Class CheckSendableEvent

Table of Contents

Properties

$context  : array<string|int, mixed>
$errors  : array<string|int, mixed>
$hookFields  : array<string|int, mixed>
$hookFieldsFlip  : array<string|int, mixed>
$hookValues  : array<string|int, mixed>
$BLACKLIST  : array<string|int, mixed>
List of field names that are prohibited due to conflicts in the class-hierarchy.
$returnValues  : mixed
Some legacy hooks expect listener-functions to return a value.

Methods

__construct()  : mixed
CheckSendableEvent constructor.
__get()  : mixed
__isset()  : mixed
__set()  : mixed
__unset()  : mixed
addReturnValues()  : GenericHookEvent
create()  : GenericHookEvent
Create a GenericHookEvent using key-value pairs.
createOrdered()  : GenericHookEvent
Create a GenericHookEvent using ordered parameters.
getAttachments()  : array<string|int, mixed>|null
getErrors()  : mixed
getFullBody()  : string|null
Get the full, combined content of the header, body, and footer.
getHookValues()  : array<string|int, mixed>
getMailing()  : CRM_Mailing_BAO_Mailing
getReturnValues()  : mixed
hasField()  : bool
Determine whether the hook supports the given field.
setError()  : mixed
assertValidHookFields()  : mixed

Properties

$context

public array<string|int, mixed> $context

An array which must define options:

  • mailing: \CRM_Mailing_BAO_Mailing
  • attachments: array

$errors

protected array<string|int, mixed> $errors = []

A list of error messages. Ex: array('subject' => 'The Subject field is blank'). Example keys: 'subject', 'name', 'from_name', 'from_email', 'body', 'body_html:unsubscribeUrl'.

$hookFields

protected array<string|int, mixed> $hookFields

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

$hookFieldsFlip

protected array<string|int, mixed> $hookFieldsFlip

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

$hookValues

protected array<string|int, mixed> $hookValues

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

$BLACKLIST

List of field names that are prohibited due to conflicts in the class-hierarchy.

private static array<string|int, mixed> $BLACKLIST = ['name', 'dispatcher', 'propagationStopped', 'hookBlacklist', 'hookValues', 'hookFields', 'hookFieldsFlip']

$returnValues

Some legacy hooks expect listener-functions to return a value.

private mixed $returnValues = []

OOP listeners may set the $returnValue.

This field is not recommended for use in new hooks. The return-value convention is not portable across different implementations of the hook system. Instead, it's more portable to provide an alterable, named field.

Methods

__construct()

CheckSendableEvent constructor.

public __construct(array<string|int, mixed> $context) : mixed
Parameters
$context : array<string|int, mixed>

__get()

public & __get(mixed $name) : mixed
Parameters
$name : mixed
Tags
inheritDoc

__isset()

public __isset(mixed $name) : mixed
Parameters
$name : mixed
Tags
inheritDoc

__set()

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed
Tags
inheritDoc

__unset()

public __unset(mixed $name) : mixed
Parameters
$name : mixed
Tags
inheritDoc

create()

Create a GenericHookEvent using key-value pairs.

public static create(array<string|int, mixed> $params) : GenericHookEvent
Parameters
$params : array<string|int, mixed>

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

Return values
GenericHookEvent

createOrdered()

Create a GenericHookEvent using ordered parameters.

public static createOrdered(array<string|int, mixed> $hookFields, array<string|int, mixed> $hookValues) : GenericHookEvent
Parameters
$hookFields : array<string|int, mixed>

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

$hookValues : array<string|int, mixed>

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

Return values
GenericHookEvent

getAttachments()

public getAttachments() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getFullBody()

Get the full, combined content of the header, body, and footer.

public getFullBody(string $field) : string|null
Parameters
$field : string

Name of the field -- either 'body_text' or 'body_html'.

Return values
string|null —

Either the combined header+body+footer, or NULL if there is no body.

getHookValues()

public getHookValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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

hasField()

Determine whether the hook supports the given field.

public hasField(string $name) : bool

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

Parameters
$name : string
Return values
bool

setError()

public setError(mixed $key, mixed $message) : mixed
Parameters
$key : mixed
$message : mixed

assertValidHookFields()

private static assertValidHookFields(array<string|int, mixed> $fields) : mixed
Parameters
$fields : array<string|int, mixed>

List of field names.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results