Elgg
Version 4.3
|
Events service. More...
Public Member Functions | |
__construct (HandlersService $handlers) | |
Constructor. More... | |
getHandlersService () | |
Get the handlers service in use. More... | |
registerHandler ($name, $type, $callback, $priority=500) | |
{} More... | |
trigger ($name, $type, $object=null, array $options=[]) | |
Triggers an Elgg event. More... | |
triggerBefore ($event, $object_type, $object=null, array $options=[]) | |
Trigger a "Before event" indicating a process is about to begin. More... | |
triggerAfter ($event, $object_type, $object=null, array $options=[]) | |
Trigger an "After event" indicating a process has finished. More... | |
triggerSequence ($event, $object_type, $object=null, callable $callable=null, array $options=[]) | |
Trigger an sequence of <event>:before, <event>, and <event>:after handlers. More... | |
triggerDeprecated ($event, $object_type, $object=null, $message=null, $version=null) | |
Trigger an event sequence normally, but send a notice about deprecated use if any handlers are registered. More... | |
triggerDeprecatedSequence ($event, $object_type, $object=null, callable $callable=null, string $message=null, string $version=null) | |
Trigger an event normally, but send a notice about deprecated use if any handlers are registered. More... | |
![]() | |
registerHandler ($name, $type, $callback, $priority=500) | |
Register a callback as a plugin hook handler. More... | |
unregisterHandler ($name, $type, $callback) | |
Unregister a callback as a plugin hook of event handler. More... | |
clearHandlers ($name, $type) | |
Clears all callback registrations for a plugin hook. More... | |
getAllHandlers () | |
Returns all registered handlers as array( $name => array( $type => array( $priority => array( callback, callback, ) ) ) More... | |
hasHandler ($name, $type) | |
Is a handler registered for this specific name and type? "all" handlers are not considered. More... | |
getOrderedHandlers ($name, $type) | |
Returns an ordered array of handlers registered for $name and $type. More... | |
backup () | |
Temporarily remove all event/hook registrations (before tests) More... | |
restore () | |
Restore backed up event/hook registrations (after tests) More... | |
Public Attributes | |
const | OPTION_STOPPABLE = 'stoppable' |
![]() | |
const | REG_KEY_PRIORITY = 0 |
const | REG_KEY_INDEX = 1 |
const | REG_KEY_HANDLER = 2 |
const | OPTION_DEPRECATION_MESSAGE = 'deprecation_message' |
const | OPTION_DEPRECATION_VERSION = 'deprecation_version' |
Additional Inherited Members | |
![]() | |
getMatcher ($spec) | |
Create a matcher for the given callable (if it's for a static or dynamic method) More... | |
checkDeprecation ($name, $type, array $options=[]) | |
Check if handlers are registered on a deprecated hook/event. More... | |
Elgg\EventsService::__construct | ( | HandlersService | $handlers | ) |
Constructor.
HandlersService | $handlers | Handlers |
Definition at line 28 of file EventsService.php.
Elgg\EventsService::getHandlersService | ( | ) |
Get the handlers service in use.
Definition at line 38 of file EventsService.php.
Elgg\EventsService::registerHandler | ( | $name, | |
$type, | |||
$callback, | |||
$priority = 500 |
|||
) |
{}
Definition at line 45 of file EventsService.php.
Elgg\EventsService::trigger | ( | $name, | |
$type, | |||
$object = null , |
|||
array | $options = [] |
||
) |
Triggers an Elgg event.
string | $event | The event type |
string | $object_type | The object type |
mixed | $object | The object involved in the event |
array | $options | (internal) options for triggering the event |
Definition at line 69 of file EventsService.php.
Elgg\EventsService::triggerAfter | ( | $event, | |
$object_type, | |||
$object = null , |
|||
array | $options = [] |
||
) |
Trigger an "After event" indicating a process has finished.
Unlike regular events, all the handlers will be called, their return values ignored.
To register for an after event, append ":after" to the event name when registering.
string | $event | The event type. The fired event type will be appended with ":after". |
string | $object_type | The object type |
mixed | $object | The object involved in the event |
array | $options | (internal) options for triggering the event |
Definition at line 152 of file EventsService.php.
Elgg\EventsService::triggerBefore | ( | $event, | |
$object_type, | |||
$object = null , |
|||
array | $options = [] |
||
) |
Trigger a "Before event" indicating a process is about to begin.
Like regular events, a handler returning false will cancel the process and false will be returned.
To register for a before event, append ":before" to the event name when registering.
string | $event | The event type. The fired event type will be appended with ":before". |
string | $object_type | The object type |
mixed | $object | The object involved in the event |
array | $options | (internal) options for triggering the event |
Definition at line 130 of file EventsService.php.
Elgg\EventsService::triggerDeprecated | ( | $event, | |
$object_type, | |||
$object = null , |
|||
$message = null , |
|||
$version = null |
|||
) |
Trigger an event sequence normally, but send a notice about deprecated use if any handlers are registered.
string | $event | The event type |
string | $object_type | The object type |
mixed | $object | The object involved in the event |
string | $message | The deprecation message |
string | $version | Human-readable release version: 1.9, 1.10, ... |
Definition at line 205 of file EventsService.php.
Elgg\EventsService::triggerDeprecatedSequence | ( | $event, | |
$object_type, | |||
$object = null , |
|||
callable | $callable = null , |
||
string | $message = null , |
||
string | $version = null |
||
) |
Trigger an event normally, but send a notice about deprecated use if any handlers are registered.
string | $event | The event type |
string | $object_type | The object type |
mixed | $object | The object involved in the event |
callable | $callable | Callable to run on successful event, before event:after |
string | $message | The deprecation message |
string | $version | Human-readable release version: 1.9, 1.10, ... |
Definition at line 227 of file EventsService.php.
Elgg\EventsService::triggerSequence | ( | $event, | |
$object_type, | |||
$object = null , |
|||
callable | $callable = null , |
||
array | $options = [] |
||
) |
Trigger an sequence of <event>:before, <event>, and <event>:after handlers.
Allows <event>:before to terminate the sequence by returning false from a handler Allows running a callable on successful <event> before <event>:after is triggered Returns the result of the callable or bool
string | $event | The event type |
string | $object_type | The object type |
mixed | $object | The object involved in the event |
callable | $callable | Callable to run on successful event, before event:after |
array | $options | (internal) options for triggering the event |
Definition at line 172 of file EventsService.php.
const Elgg\EventsService::OPTION_STOPPABLE = 'stoppable' |
Definition at line 16 of file EventsService.php.