class Event

Class Event

Properties

$event_registry

Methods

add_hook_listener($src, $event, $hook_instance, $hook_name, $params = array())

No description

int|int[]
add_listener(object $src, string|string[] $event, callable $event_handler = false, array $params = array())

No description

bool
remove_listener(int $evt_id)

No description

setup_hook_listeners()

hook triggers will be queried from db an copied into the $event_registry array

bool
trigger(object $src, string|string[] $event, mixed $eventObject = null)

No description

Details

at line 113
add_hook_listener($src, $event, $hook_instance, $hook_name, $params = array())

No description

Parameters

$src
$event
$hook_instance
$hook_name
$params

at line 78
int|int[] add_listener(object $src, string|string[] $event, callable $event_handler = false, array $params = array())

No description

Parameters

object $src

Event Object [e.g. xui_form]

string|string[] $event

Event [e.g. xui_form: 'beforeSave', 'afterSave', ...?]

callable $event_handler

Callback Eventhandler e.g. array($o,'function')

array $params

Callback Params

Return Value

int|int[]

Event ID

at line 210
bool remove_listener(int $evt_id)

No description

Parameters

int $evt_id

EventID

Return Value

bool

success if event was found and successfully removed, false if not found

at line 26
setup_hook_listeners()

hook triggers will be queried from db an copied into the $event_registry array

at line 136
bool trigger(object $src, string|string[] $event, mixed $eventObject = null)

No description

Parameters

object $src

Event Object

string|string[] $event

Event Identifier (e.g. onSave) - can also contain multiple events as array to register for multiple at once

mixed $eventObject

Return Value

bool