TeamSpeak3_Helper_Signal_Handler Class Reference

Helper class providing handler functions for signals. More...

List of all members.

Public Member Functions
	__construct ($signal, $callback)
	The TeamSpeak3_Helper_Signal_Handler constructor.
	call (array $args=array())
	Invoke the signal handler.
Protected Attributes
	$signal = null
	$callback = null

---

Detailed Description

Helper class providing handler functions for signals.

Definition at line 32 of file Handler.php.

---

Constructor & Destructor Documentation

TeamSpeak3_Helper_Signal_Handler::__construct	(	$	signal,
		$	callback
	)

The TeamSpeak3_Helper_Signal_Handler constructor.

Parameters:

string	$signal
mixed	$callback

Exceptions:

TeamSpeak3_Helper_Signal_Exception

Returns:

TeamSpeak3_Helper_Signal_Handler

Definition at line 56 of file Handler.php.

  {
    $this->signal = (string) $signal;

    if(!is_callable($callback))
    {
      throw new TeamSpeak3_Helper_Signal_Exception("invalid callback specified for signal '" . $signal . "'");
    }

    $this->callback = $callback;
  }

---

Member Function Documentation

TeamSpeak3_Helper_Signal_Handler::call

(

array $

args = array()

)

Invoke the signal handler.

Parameters:

array

$args

Returns:

mixed

Definition at line 74 of file Handler.php.

  {
    return call_user_func_array($this->callback, $args);
  }

---

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

• libraries/TeamSpeak3/Helper/Signal/Handler.php