PHP Класс Imbo\EventManager\EventManager

Автор: Christer Edvartsen ([email protected])
Показать файл Открыть проект Примеры использования класса

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

Метод Описание
addCallbacks ( string $name, array $events, array $users = [] ) : self Add one or more callbacks
addEventHandler ( string $name, mixed $handler, array $params = [] ) : self Register an event handler
addInitializer ( Imbo\EventListener\Initializer\InitializerInterface $initializer ) : self Add an event listener initializer
getHandlerInstance ( string $name ) : Imbo\EventListener\ListenerInterface Get a handler instance
hasListenersForEvent ( string $eventName ) : boolean Whether or not the manager has event listeners that subscribes to a specific event
setEventTemplate ( Imbo\EventManager\EventInterface $event ) : self Set the event template
trigger ( string $eventName, array $params = [] ) : EventManager Trigger a given event

Приватные методы

Метод Описание
getEventNameParts ( string $event ) Get all parts of an event name
getListenersForEvent ( string $event ) : PriorityQueue[] Get all listeners that listens for an event, including wildcard listeners
triggersFor ( string $user = null, array $filter = [] ) : boolean Check if a listener will trigger for a given user

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

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

Add one or more callbacks
public addCallbacks ( string $name, array $events, array $users = [] ) : self
$name string The name of the handler that owns the callback
$events array Which events the callback will trigger for
$users array User filter for the events
Результат self

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

Register an event handler
public addEventHandler ( string $name, mixed $handler, array $params = [] ) : self
$name string The name of the handler
$handler mixed The handler itself
$params array Parameters for the handler if $handler is a string
Результат self

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

Add an event listener initializer
public addInitializer ( Imbo\EventListener\Initializer\InitializerInterface $initializer ) : self
$initializer Imbo\EventListener\Initializer\InitializerInterface An initializer instance
Результат self

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

Get a handler instance
public getHandlerInstance ( string $name ) : Imbo\EventListener\ListenerInterface
$name string The name of the handler
Результат Imbo\EventListener\ListenerInterface

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

Whether or not the manager has event listeners that subscribes to a specific event
public hasListenersForEvent ( string $eventName ) : boolean
$eventName string The name of the event to check
Результат boolean

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

This event instance will be cloned for each use of the trigger method
public setEventTemplate ( Imbo\EventManager\EventInterface $event ) : self
$event Imbo\EventManager\EventInterface A configured event instance
Результат self

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

Trigger a given event
public trigger ( string $eventName, array $params = [] ) : EventManager
$eventName string The name of the event to trigger
$params array Extra parameters for the event
Результат EventManager