PHP Interface Kraken\Event\EventEmitterInterface

Datei anzeigen Open project: kraken-php/framework Interface Usage Examples

Public Methods

Method Description
copyEvent ( Kraken\Event\EventEmitterInterface $emitter, string $event ) : EventListener Forward event to another emitter.
copyEvents ( Kraken\Event\EventEmitterInterface $emitter, string[] $events ) : EventListener[] Forward set of events to another emitter.
delay ( string $event, integer $ticks, callable $listener ) : EventListener Set listener for event that will start to be invoked after $ticks number of events is emitted. This method returns EventListener.
delayOnce ( string $event, integer $ticks, callable $listener ) : EventListener Set listener for event that will fire only once after $ticks number of events is emitted. This method returns EventListener
delayTimes ( string $event, $ticks, integer $limit, callable $listener ) : EventListener Set listener for event that will fire at most as many times as $limit is set to, but only after $ticks number of events is emitted. This method returns EventListener
discardEvents ( Kraken\Event\EventEmitterInterface $emitter ) : Kraken\Event\EventEmitterInterface Discard events previously forwarded to another emitter.
emit ( string $event, mixed[] $arguments = [] ) Emit event with specified arguments.
findListener ( string $event, callable $listener ) : integer | null Find listener for event.
flushListeners ( ) Remove all listeners.
forwardEvents ( Kraken\Event\EventEmitterInterface $emitter ) : Kraken\Event\EventEmitterInterface Forward all events to another emitter.
getMode ( ) : integer Returns mode of EventEmitter behaviour.
on ( string $event, callable $listener ) : EventListener Set listener for event. This method returns EventListener.
once ( string $event, callable $listener ) : EventListener Set listener for event that will fire only once. This method returns EventListener
removeListener ( string $event, callable $listener ) Remove existing listener for event.
removeListeners ( string $event ) Remove all listeners for event.
setMode ( integer $emitterMode ) Set mode for EventEmitter behaviour.
times ( string $event, integer $limit, callable $listener ) : EventListener Set listener for event that will fire at most as many times as set limit to. This method returns EventListener

Method Details

copyEvent() public method

Forward event to another emitter.
public copyEvent ( Kraken\Event\EventEmitterInterface $emitter, string $event ) : EventListener
$emitter Kraken\Event\EventEmitterInterface
$event string
return EventListener

copyEvents() public method

Forward set of events to another emitter.
public copyEvents ( Kraken\Event\EventEmitterInterface $emitter, string[] $events ) : EventListener[]
$emitter Kraken\Event\EventEmitterInterface
$events string[]
return EventListener[]

delay() public method

Set listener for event that will start to be invoked after $ticks number of events is emitted. This method returns EventListener.
public delay ( string $event, integer $ticks, callable $listener ) : EventListener
$event string
$ticks integer
$listener callable
return EventListener

delayOnce() public method

Set listener for event that will fire only once after $ticks number of events is emitted. This method returns EventListener
public delayOnce ( string $event, integer $ticks, callable $listener ) : EventListener
$event string
$ticks integer
$listener callable
return EventListener

delayTimes() public method

Set listener for event that will fire at most as many times as $limit is set to, but only after $ticks number of events is emitted. This method returns EventListener
public delayTimes ( string $event, $ticks, integer $limit, callable $listener ) : EventListener
$event string
$limit integer
$listener callable
return EventListener

discardEvents() public method

Discard events previously forwarded to another emitter.
public discardEvents ( Kraken\Event\EventEmitterInterface $emitter ) : Kraken\Event\EventEmitterInterface
$emitter Kraken\Event\EventEmitterInterface
return Kraken\Event\EventEmitterInterface

emit() public method

Emit event with specified arguments.
public emit ( string $event, mixed[] $arguments = [] )
$event string
$arguments mixed[]

findListener() public method

Find listener for event. Returns int greater or equal 0 if listener is found or null if not.
public findListener ( string $event, callable $listener ) : integer | null
$event string
$listener callable
return integer | null

flushListeners() public method

Remove all listeners.
public flushListeners ( )

forwardEvents() public method

Forward all events to another emitter.
public forwardEvents ( Kraken\Event\EventEmitterInterface $emitter ) : Kraken\Event\EventEmitterInterface
$emitter Kraken\Event\EventEmitterInterface
return Kraken\Event\EventEmitterInterface

getMode() public method

Returns mode of EventEmitter behaviour.
See also: setMode
public getMode ( ) : integer
return integer

on() public method

Set listener for event. This method returns EventListener.
public on ( string $event, callable $listener ) : EventListener
$event string
$listener callable
return EventListener

once() public method

Set listener for event that will fire only once. This method returns EventListener
public once ( string $event, callable $listener ) : EventListener
$event string
$listener callable
return EventListener

removeListener() public method

Remove existing listener for event.
public removeListener ( string $event, callable $listener )
$event string
$listener callable

removeListeners() public method

Remove all listeners for event.
public removeListeners ( string $event )
$event string

setMode() public method

Set mode for EventEmitter behaviour. $emitterMode can be one of: EventEmitter::EVENTS_FORWARD Allows all events to be forwarded (Default) EventEmitter::EVENTS_DISCARD Disallows all events from being forwarded EventEmitter::EVENTS_DISCARD_INCOMING Discards only listeners attached to $this emitter EventEmitter::EVENTS_DISCARD_OUTCOMING Discards only further emits on forwarder
public setMode ( integer $emitterMode )
$emitterMode integer

times() public method

Set listener for event that will fire at most as many times as set limit to. This method returns EventListener
public times ( string $event, integer $limit, callable $listener ) : EventListener
$event string
$limit integer
$listener callable
return EventListener