PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal Class Reference

Helper class for signal slots. More...

Public Member Functions
	emit (string $signal, mixed $params=null)
	getCallbackHash (mixed $callback)
	subscribe (string $signal, mixed $callback)
	unsubscribe (string $signal, mixed $callback=null)
	getSignals ()
	hasHandlers (string $signal)
	getHandlers (string $signal)
	clearHandlers (string $signal)

Static Public Member Functions
static	getInstance ()

Protected Attributes
array	$sigslots = []

Static Protected Attributes
static Signal	$instance = null

Detailed Description

Helper class for signal slots.

Definition at line 15 of file Signal.php.

Member Function Documentation

clearHandlers()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::clearHandlers

(

string

$signal

)

Clears all slots for a specified signal.

Parameters

string

$signal

Returns

void

Definition at line 167 of file Signal.php.

emit()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::emit	(	string	$signal,
		mixed	$params = null )

Emits a signal with a given set of parameters.

Parameters

string	$signal
mixed | null	$params

Returns

mixed

Todo

: Confirm / fix $return is set to last $slot->call() return value. It appears all previous calls before last are lost / ignored.

Definition at line 41 of file Signal.php.

getCallbackHash()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getCallbackHash

(

mixed

$callback

)

Generates a MD5 hash based on a given callback.

Parameters

mixed

$callback

Returns

string

Exceptions

HelperException

Definition at line 66 of file Signal.php.

getHandlers()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getHandlers

(

string

$signal

)

Returns all slots for a specified signal.

Parameters

string

$signal

Returns

array

Definition at line 152 of file Signal.php.

getInstance()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance ( )

static

Returns a singleton instance of PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal.

Returns

Signal|null

Definition at line 179 of file Signal.php.

getSignals()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getSignals

(

)

Returns all registered signals.

Returns

array

Definition at line 130 of file Signal.php.

hasHandlers()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::hasHandlers

(

string

$signal

)

Returns TRUE there are slots subscribed for a specified signal.

Parameters

string

$signal

Returns

boolean

Definition at line 141 of file Signal.php.

subscribe()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::subscribe	(	string	$signal,
		mixed	$callback )

Subscribes to a signal and returns the signal handler.

Parameters

string	$signal
mixed	$callback

Returns

Handler

Exceptions

HelperException

Definition at line 83 of file Signal.php.

unsubscribe()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::unsubscribe	(	string	$signal,
		mixed	$callback = null )

Unsubscribes from a signal.

Parameters

string	$signal
mixed | null	$callback

Returns

void

Exceptions

HelperException

Definition at line 106 of file Signal.php.

Member Data Documentation

$instance

Signal PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::$instance = null

staticprotected

Definition at line 22 of file Signal.php.

$sigslots

array PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::$sigslots = []

protected

Definition at line 29 of file Signal.php.

---

The documentation for this class was generated from the following file:

• src/Helper/Signal.php