Elgg\HooksRegistrationService Class Reference

Inheritance diagram for Elgg\HooksRegistrationService:

Public Member Functions
	setLogger (\Elgg\Logger $logger=null)
	Set a logger instance, e.g. More...
	registerHandler ($name, $type, $callback, $priority=500)
	Registers a handler. More...
	unregisterHandler ($name, $type, $callback)
	Unregister a handler. More...
	clearHandlers ($name, $type)
	Clears all handlers for a specific 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	REG_KEY_PRIORITY = 0
const	REG_KEY_INDEX = 1
const	REG_KEY_HANDLER = 2

Protected Member Functions
	getMatcher ($spec)
	Create a matcher for the given callable (if it's for a static or dynamic method) More...

Protected Attributes
	$logger

Detailed Description

Examples

/root/Elgg/engine/lib/output.php, and /root/Elgg/engine/lib/views.php.

Definition at line 15 of file HooksRegistrationService.php.

Member Function Documentation

backup()

Elgg\HooksRegistrationService::backup

(

)

Temporarily remove all event/hook registrations (before tests)

Call backup() before your tests and restore() after.

Note

This behaves like a stack. You must call restore() for each backup() call.

Returns

void

See also

restore @access private

Definition at line 263 of file HooksRegistrationService.php.

clearHandlers()

Elgg\HooksRegistrationService::clearHandlers	(		$name,
			$type
	)

Clears all handlers for a specific hook.

Parameters

string	$name
string	$type

Returns

void @access private

Definition at line 124 of file HooksRegistrationService.php.

getAllHandlers()

Elgg\HooksRegistrationService::getAllHandlers

(

)

Returns all registered handlers as array( $name => array( $type => array( $priority => array( callback, callback, ) ) )

@access private

Returns

array

Definition at line 142 of file HooksRegistrationService.php.

getMatcher()

Elgg\HooksRegistrationService::getMatcher (   $spec )

protected

Create a matcher for the given callable (if it's for a static or dynamic method)

Parameters

callable

$spec

Callable we're creating a matcher for

Returns

MethodMatcher|null

Definition at line 230 of file HooksRegistrationService.php.

getOrderedHandlers()

Elgg\HooksRegistrationService::getOrderedHandlers	(		$name,
			$type
	)

Returns an ordered array of handlers registered for $name and $type.

Parameters

string	$name	The name of the hook
string	$type	The type of the hook

Returns

callable[]

See also

\Elgg\HooksRegistrationService::getAllHandlers()

@access private

Definition at line 181 of file HooksRegistrationService.php.

hasHandler()

Elgg\HooksRegistrationService::hasHandler	(		$name,
			$type
	)

Is a handler registered for this specific name and type? "all" handlers are not considered.

If you need to consider "all" handlers, you must check them independently, or use (bool)elgg_get_ordered_hook_handlers().

Parameters

string	$name	The name of the hook
string	$type	The type of the hook

Returns

boolean

Definition at line 167 of file HooksRegistrationService.php.

registerHandler()

Elgg\HooksRegistrationService::registerHandler	(		$name,
			$type,
			$callback,
			$priority = 500
	)

Registers a handler.

Warning

This doesn't check if a callback is valid to be called, only if it is in the correct format as a callable.

@access private

Reimplemented in Elgg\PluginHooksService, and Elgg\EventsService.

Definition at line 60 of file HooksRegistrationService.php.

restore()

Elgg\HooksRegistrationService::restore

(

)

Restore backed up event/hook registrations (after tests)

Returns

void

See also

backup @access private

Definition at line 276 of file HooksRegistrationService.php.

setLogger()

Elgg\HooksRegistrationService::setLogger

(

\Elgg\Logger

$logger = null

)

Set a logger instance, e.g.

for reporting uncallable handlers

Parameters

\Elgg\Logger

$logger

The logger

Returns

self

Definition at line 47 of file HooksRegistrationService.php.

unregisterHandler()

Elgg\HooksRegistrationService::unregisterHandler	(		$name,
			$type,
			$callback
	)

Unregister a handler.

Parameters

string	$name
string	$type
callable	$callback

Returns

bool @access private

Definition at line 85 of file HooksRegistrationService.php.

Member Data Documentation

$logger

Elgg\HooksRegistrationService::$logger

protected

Definition at line 39 of file HooksRegistrationService.php.

REG_KEY_HANDLER

const Elgg\HooksRegistrationService::REG_KEY_HANDLER = 2

Definition at line 19 of file HooksRegistrationService.php.

REG_KEY_INDEX

const Elgg\HooksRegistrationService::REG_KEY_INDEX = 1

Definition at line 18 of file HooksRegistrationService.php.

REG_KEY_PRIORITY

const Elgg\HooksRegistrationService::REG_KEY_PRIORITY = 0

Definition at line 17 of file HooksRegistrationService.php.

---

The documentation for this class was generated from the following file:

• engine/classes/Elgg/HooksRegistrationService.php