PHP Класс Elgg\HooksRegistrationService

Use the elgg_* versions instead.
С версии: 1.9.0
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$logger Logger

Открытые методы

Метод Описание
backup ( ) : void Temporarily remove all event/hook registrations (before tests)
clearHandlers ( string $name, string $type ) : void Clears all handlers for a specific hook
getAllHandlers ( ) : array Returns all registered handlers as array( $name => array( $type => array( $priority => array( callback, callback, ) ) )
getOrderedHandlers ( string $name, string $type ) : callable[] Returns an ordered array of handlers registered for $name and $type.
hasHandler ( string $name, string $type ) : boolean Is a handler registered for this specific name and type? "all" handlers are not considered.
registerHandler ( $name, $type, $callback, $priority = 500 ) Registers a handler.
restore ( ) : void Restore backed up event/hook registrations (after tests)
setLogger ( Logger $logger = null ) : self Set a logger instance, e.g. for reporting uncallable handlers
unregisterHandler ( string $name, string $type, callable $callback ) : boolean Unregister a handler

Защищенные методы

Метод Описание
getMatcher ( callable $spec ) : elgg\MethodMatcher | null Create a matcher for the given callable (if it's for a static or dynamic method)

Описание методов

backup() публичный Метод

Call backup() before your tests and restore() after.
См. также: restore
public backup ( ) : void
Результат void

clearHandlers() публичный Метод

Clears all handlers for a specific hook
public clearHandlers ( string $name, string $type ) : void
$name string
$type string
Результат void

getAllHandlers() публичный Метод

Returns all registered handlers as array( $name => array( $type => array( $priority => array( callback, callback, ) ) )
public getAllHandlers ( ) : array
Результат array

getMatcher() защищенный Метод

Create a matcher for the given callable (if it's for a static or dynamic method)
protected getMatcher ( callable $spec ) : elgg\MethodMatcher | null
$spec callable Callable we're creating a matcher for
Результат elgg\MethodMatcher | null

getOrderedHandlers() публичный Метод

Returns an ordered array of handlers registered for $name and $type.
См. также: Elgg\HooksRegistrationService::getAllHandlers()
public getOrderedHandlers ( string $name, string $type ) : callable[]
$name string The name of the hook
$type string The type of the hook
Результат callable[]

hasHandler() публичный Метод

If you need to consider "all" handlers, you must check them independently, or use (bool)elgg_get_ordered_hook_handlers().
public hasHandler ( string $name, string $type ) : boolean
$name string The name of the hook
$type string The type of the hook
Результат boolean

registerHandler() публичный Метод

Registers a handler.
public registerHandler ( $name, $type, $callback, $priority = 500 )

restore() публичный Метод

Restore backed up event/hook registrations (after tests)
См. также: backup
public restore ( ) : void
Результат void

setLogger() публичный Метод

Set a logger instance, e.g. for reporting uncallable handlers
public setLogger ( Logger $logger = null ) : self
$logger Logger The logger
Результат self

unregisterHandler() публичный Метод

Unregister a handler
public unregisterHandler ( string $name, string $type, callable $callback ) : boolean
$name string
$type string
$callback callable
Результат boolean

Описание свойств

$logger защищенное свойство

protected Logger,Elgg $logger
Результат Logger