TeamSpeak3_Helper_Signal Class Reference

Helper class for signal slots. More...

Public Member Functions
	clearHandlers ($signal)
	Clears all slots for a specified signal. More...
	emit ($signal, $params=null)
	Emits a signal with a given set of parameters. More...
	getCallbackHash ($callback)
	Generates a MD5 hash based on a given callback. More...
	getHandlers ($signal)
	Returns all slots for a specified signal. More...
	getSignals ()
	Returns all registered signals. More...
	hasHandlers ($signal)
	Returns TRUE there are slots subscribed for a specified signal. More...
	subscribe ($signal, $callback)
	Subscribes to a signal and returns the signal handler. More...
	unsubscribe ($signal, $callback=null)
	Unsubscribes from a signal. More...

Static Public Member Functions
static	getInstance ()
	Returns a singleton instance of TeamSpeak3_Helper_Signal. More...

Detailed Description

Helper class for signal slots.

Member Function Documentation

clearHandlers()

clearHandlers

(

$signal

)

Clears all slots for a specified signal.

Parameters

string

$signal

Returns

void

  {
    if(!$this->hasHandlers($signal))
    {
      unset($this->sigslots[$signal]);
    }
  }

emit()

emit	(		$signal,
			$params = null
	)

Emits a signal with a given set of parameters.

Parameters

string	$signal
mixed	$params

Returns

mixed

  {
    if(!$this->hasHandlers($signal))
    {
      return;
    }

    if(!is_array($params))
    {
      $params = func_get_args();
      $params = array_slice($params, 1);
    }

    foreach($this->sigslots[$signal] as $slot)
    {
      $return = $slot->call($params);
    }

    return $return;
  }

getCallbackHash()

getCallbackHash

(

$callback

)

Generates a MD5 hash based on a given callback.

Parameters

mixed	$callback
	string

Returns

void

  {
    if(!is_callable($callback, TRUE, $callable_name))
    {
      throw new TeamSpeak3_Helper_Signal_Exception("invalid callback specified");
    }
    
    return md5($callable_name);
  }

getHandlers()

getHandlers

(

$signal

)

Returns all slots for a specified signal.

Parameters

string

$signal

Returns

array

  {
    if(!$this->hasHandlers($signal))
    {
      return $this->sigslots[$signal];
    }

    return array();
  }

getInstance()

static getInstance ( )

static

Returns a singleton instance of TeamSpeak3_Helper_Signal.

Returns

TeamSpeak3_Helper_Signal

  {
    if(self::$instance === null)
    {
      self::$instance = new self();
    }

    return self::$instance;
  }

getSignals()

getSignals

(

)

Returns all registered signals.

Returns

array

  {
    return array_keys($this->sigslots);
  }

hasHandlers()

hasHandlers

(

$signal

)

Returns TRUE there are slots subscribed for a specified signal.

Parameters

string

$signal

Returns

boolean

  {
    return empty($this->sigslots[$signal]) ? FALSE : TRUE;
  }

subscribe()

subscribe	(		$signal,
			$callback
	)

Subscribes to a signal and returns the signal handler.

Parameters

string	$signal
mixed	$callback

Returns

TeamSpeak3_Helper_Signal_Handler

  {
    if(empty($this->sigslots[$signal]))
    {
      $this->sigslots[$signal] = array();
    }

    $index = $this->getCallbackHash($callback);

    if(!array_key_exists($index, $this->sigslots[$signal]))
    {
      $this->sigslots[$signal][$index] = new TeamSpeak3_Helper_Signal_Handler($signal, $callback);
    }

    return $this->sigslots[$signal][$index];
  }

unsubscribe()

unsubscribe	(		$signal,
			$callback = null
	)

Unsubscribes from a signal.

Parameters

string	$signal
mixed	$callback

Returns

void

  {
    if(!$this->hasHandlers($signal))
    {
      return;
    }

    if($callback !== null)
    {
      $index = $this->getCallbackHash($callback);

      if(!array_key_exists($index, $this->sigslots[$signal]))
      {
        return;
      }

      unset($this->sigslots[$signal][$index]);
    }
    else
    {
      unset($this->sigslots[$signal]);
    }
  }

---

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

• /Volumes/home/Repositories/planetteamspeak/ts3phpframework/libraries/TeamSpeak3/Helper/Signal.php