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...
	getAllHandlers ()
	Returns all registered handlers as array( $name => array( $type => array( $priority => callback, ... More...
	hasHandler ($name, $type)
	Does the hook have a handler? More...

Protected Member Functions
	getOrderedHandlers ($name, $type)
	Returns an ordered array of handlers registered for $name and $type. More...
	describeCallable ($callable)
	Get a string description of a callback. More...

Protected Attributes
	$logger

Detailed Description

Definition at line 15 of file HooksRegistrationService.php.

Member Function Documentation

describeCallable()

Elgg\HooksRegistrationService::describeCallable (   $callable )

protected

Get a string description of a callback.

E.g. "function_name", "Static::method", "(ClassName)->method", "(Closure path/to/file.php:23)"

Parameters

mixed

$callable

The callable value to describe

Returns

string

Definition at line 159 of file HooksRegistrationService.php.

getAllHandlers()

Elgg\HooksRegistrationService::getAllHandlers

(

)

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

) )

@access private

Returns

array

Definition at line 103 of file HooksRegistrationService.php.

getOrderedHandlers()

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

protected

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

array

See also

\Elgg\HooksRegistrationService::getAllHandlers()

Definition at line 126 of file HooksRegistrationService.php.

hasHandler()

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

Does the hook have a handler?

Parameters

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

Returns

boolean

Definition at line 114 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

Definition at line 43 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 30 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 79 of file HooksRegistrationService.php.

Member Data Documentation

$logger

Elgg\HooksRegistrationService::$logger

protected

Definition at line 22 of file HooksRegistrationService.php.

---

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

• engine/classes/Elgg/HooksRegistrationService.php