class Events

The API kernel dispatches a series of events while processing each API request.

For a successful API request, the sequence is RESOLVE => AUTHORIZE => PREPARE => RESPOND. If an exception arises in any stage, then the sequence is aborted and the EXCEPTION event is dispatched.

Event subscribers which are concerned about the order of execution should assign a weight to their subscription (such as W_EARLY, W_MIDDLE, or W_LATE). W_LATE).

Constants

AUTHORIZE

Determine whether the API request is allowed for the current user.

For successful execution, at least one listener must invoke $event->authorize().

RESOLVE

Determine which API provider executes the given request. For successful execution, at least one listener must invoke $event->setProvider($provider).

PREPARE

Apply pre-execution logic

RESPOND

Apply post-execution logic

EXCEPTION

Handle any exceptions.

W_EARLY

Weight - Early

W_MIDDLE

Weight - Middle

W_LATE

Weight - Late

Methods

static array
allEvents()

No description

static 
hookEventDefs(GenericHookEvent $e)

No description

Details

at line 98
static array allEvents()

Return Value

array

at line 112
static hookEventDefs(GenericHookEvent $e)

Parameters

GenericHookEvent $e

See also

\CRM_Utils_Hook::eventDefs