PHP Class Resque\Event

Author: Chris Boulton ([email protected])

Protected Properties

Property	Type	Description
$events		containing all registered callbacks, indexed by event name

Method	Description
clear ( )	Clear all registered listeners.
eventName ( integer $event ) : string \| false	Returns the name of the given event from constant
fire ( string $event, mixed $data = null ) : true	Raise a given event with the supplied data.
forget ( string $event, mixed $callback ) : true	Stop a given callback from listening on a specific event.
listen ( string $event, mixed $callback ) : true	Listen in on a given event to have a specified callback fired.

Clear all registered listeners.

public static clear ( )

Returns the name of the given event from constant

public static eventName ( integer $event ) : string \| false
$event	integer	Event constant
return	string \| false

Raise a given event with the supplied data.

public static fire ( string $event, mixed $data = null ) : true
$event	string	Name of event to be raised
$data	mixed	Data that should be passed to each callback (optional)
return	true

Stop a given callback from listening on a specific event.

public static forget ( string $event, mixed $callback ) : true
$event	string	Name of event
$callback	mixed	The callback as defined when listen() was called
return	true

Listen in on a given event to have a specified callback fired.

public static listen ( string $event, mixed $callback ) : true
$event	string	Name of event to listen on.
$callback	mixed	Any callback callable by call_user_func_array
return	true

containing all registered callbacks, indexed by event name

protected static $events