1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. XF
  7. \
  8. Event

Event

class Event

Class Event

Properties

$event_registry

Methods

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

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

No description

Details

at line 25
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 95
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 61
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