class CompositeDispatcher implements DispatcherInterface, LoggerAwareInterface, ArrayAccess, Countable, IteratorAggregate (View source)

The CompositeDispatcher class.

Traits

The LoggerAwareTrait class.

Methods

setLogger(LoggerInterface $logger)

Sets a logger.

LoggerInterface
getLogger()

getLogger

__construct(array $dispatchers)

CompositeDispatcher constructor.

EventInterface
triggerEvent(EventInterface|string $event, array $args = array())

Trigger an event.

listen(string $event, callable $callable, int $priority = ListenerPriority::NORMAL)

Add single listener.

addListener(object|Closure $listener, array|integer $priorities = array())

Add a listener to this dispatcher, only if not already registered to these events.

EventInterface
triggerSubEvent(string $name, EventInterface|string $event, array $args = array())

triggerSubEvent

subListen(string $name, string $event, callable $callable, int $priority = ListenerPriority::NORMAL)

Add single listener.

$this
addSubListener(string $name, object|Closure $listener, array|integer $priorities = array())

addSubListener

addDispatcher(string $name, DispatcherInterface $dispatcher)

addDispatcher

Dispatcher
getDispatcher(string $name)

getDispatcher

removeDispatcher(string $name)

removeDispatcher

boolean
hasDispatcher(string $name)

hasDispatcher

Dispatcher[]
getDispatchers()

Method to get property Dispatchers

setDispatchers(array $dispatchers)

Method to set property dispatchers

getIterator()

Retrieve an external iterator

boolean
offsetExists(mixed $offset)

Is a property exists or not.

mixed
offsetGet(mixed $offset)

Get a property.

void
offsetSet(mixed $offset, mixed $value)

Set a value to property.

void
offsetUnset(mixed $offset)

Unset a property.

int
count()

Count this object.

Details

setLogger(LoggerInterface $logger)

Sets a logger.

Parameters

LoggerInterface $logger

LoggerInterface getLogger()

getLogger

Return Value

LoggerInterface

at line line 47
__construct(array $dispatchers)

CompositeDispatcher constructor.

Parameters

array $dispatchers

at line line 60
EventInterface triggerEvent(EventInterface|string $event, array $args = array())

Trigger an event.

Parameters

EventInterface|string $event The event object or name.
array $args The arguments.

Return Value

EventInterface The event after being passed through all listeners.

at line line 79
CompositeDispatcher listen(string $event, callable $callable, int $priority = ListenerPriority::NORMAL)

Add single listener.

Parameters

string $event
callable $callable
int $priority

Return Value

CompositeDispatcher

at line line 99
CompositeDispatcher addListener(object|Closure $listener, array|integer $priorities = array())

Add a listener to this dispatcher, only if not already registered to these events.

If no events are specified, it will be registered to all events matching it's methods name. In the case of a closure, you must specify at least one event name.

Parameters

object|Closure $listener The listener
array|integer $priorities An associative array of event names as keys and the corresponding listener priority as values.

Return Value

CompositeDispatcher This method is chainable.

Exceptions

InvalidArgumentException

at line line 118
EventInterface triggerSubEvent(string $name, EventInterface|string $event, array $args = array())

triggerSubEvent

Parameters

string $name The dispatcher name.
EventInterface|string $event The event object or name.
array $args The arguments.

Return Value

EventInterface

at line line 133
CompositeDispatcher subListen(string $name, string $event, callable $callable, int $priority = ListenerPriority::NORMAL)

Add single listener.

Parameters

string $name
string $event
callable $callable
int $priority

Return Value

CompositeDispatcher

at line line 148
$this addSubListener(string $name, object|Closure $listener, array|integer $priorities = array())

addSubListener

Parameters

string $name This dispatcher name.
object|Closure $listener The listener
array|integer $priorities An associative array of event names as keys and the corresponding listener priority as values.

Return Value

$this

at line line 163
CompositeDispatcher addDispatcher(string $name, DispatcherInterface $dispatcher)

addDispatcher

Parameters

string $name
DispatcherInterface $dispatcher

Return Value

CompositeDispatcher

at line line 181
Dispatcher getDispatcher(string $name)

getDispatcher

Parameters

string $name

Return Value

Dispatcher

at line line 200
CompositeDispatcher removeDispatcher(string $name)

removeDispatcher

Parameters

string $name

Return Value

CompositeDispatcher

at line line 219
boolean hasDispatcher(string $name)

hasDispatcher

Parameters

string $name

Return Value

boolean

at line line 231
Dispatcher[] getDispatchers()

Method to get property Dispatchers

Return Value

Dispatcher[]

at line line 243
CompositeDispatcher setDispatchers(array $dispatchers)

Method to set property dispatchers

Parameters

array $dispatchers

Return Value

CompositeDispatcher Return self to support chaining.

at line line 258
Traversable getIterator()

Retrieve an external iterator

Return Value

Traversable An instance of an object implementing Iterator or Traversable

at line line 270
boolean offsetExists(mixed $offset)

Is a property exists or not.

Parameters

mixed $offset Offset key.

Return Value

boolean

at line line 283
mixed offsetGet(mixed $offset)

Get a property.

Parameters

mixed $offset Offset key.

Return Value

mixed The value to return.

Exceptions

InvalidArgumentException

at line line 297
void offsetSet(mixed $offset, mixed $value)

Set a value to property.

Parameters

mixed $offset Offset key.
mixed $value The value to set.

Return Value

void

Exceptions

InvalidArgumentException

at line line 310
void offsetUnset(mixed $offset)

Unset a property.

Parameters

mixed $offset Offset key to unset.

Return Value

void

Exceptions

InvalidArgumentException

at line line 320
int count()

Count this object.

Return Value

int