PHP Trait PHPDaemon\Traits\EventHandlers

Author: Vasily Zorin ([email protected])

Protected Properties

Property	Type	Description
$addThisToEvents		Unshift $this to arguments of callback?
$eventHandlers		Event handlers
$lastEventName		Last called event name

Method	Description
bind ( string \| array $event, callable $cb ) : this	Bind event or events
event ( string $name, $args ) : this	Propagate event
getLastEventName ( ) : string	Use it to define event name, when one callback was bind to more than one events
off ( string \| array $event, callable $cb = null ) : this	Unbind event(s) or callback from event(s)
on ( string \| array $event, callable $cb ) : this	Bind event or events
trigger ( string $name, $args ) : this	Propagate event
triggerAndCount ( string $name, $args ) : integer	Propagate event
unbind ( string \| array $event, callable $cb = null ) : this	Unbind event(s) or callback from event(s)

Method	Description
cleanupEventHandlers ( ) : void	Clean up all events

Bind event or events

public bind ( string \| array $event, callable $cb ) : this
$event	string \| array	Event name
$cb	callable	Callback
return	this

Clean up all events

protected cleanupEventHandlers ( ) : void
return	void

Propagate event

public event ( string $name, $args ) : this
$name	string	Event name
$args		Arguments
return	this

Use it to define event name, when one callback was bind to more than one events

public getLastEventName ( ) : string
return	string

Unbind event(s) or callback from event(s)

public off ( string \| array $event, callable $cb = null ) : this
$event	string \| array	Event name
$cb	callable	Callback, optional
return	this

Bind event or events

public on ( string \| array $event, callable $cb ) : this
$event	string \| array	Event name
$cb	callable	Callback
return	this

Propagate event

public trigger ( string $name, $args ) : this
$name	string	Event name
$args		Arguments
return	this

Propagate event

public triggerAndCount ( string $name, $args ) : integer
$name	string	Event name
$args		Arguments
return	integer

Unbind event(s) or callback from event(s)

public unbind ( string \| array $event, callable $cb = null ) : this
$event	string \| array	Event name
$cb	callable	Callback, optional
return	this

Unshift $this to arguments of callback?

protected $addThisToEvents

Event handlers

protected $eventHandlers

Last called event name

protected $lastEventName