TeamSpeak3_Helper_Signal_Handler Class Reference

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

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

Detailed Description

Helper class providing handler functions for signals.

Constructor & Destructor Documentation

__construct()

__construct	(		$signal,
			$callback
	)

The TeamSpeak3_Helper_Signal_Handler constructor.

Parameters

string	$signal
mixed	$callback

Exceptions

TeamSpeak3_Helper_Signal_Exception

Returns

TeamSpeak3_Helper_Signal_Handler

  {
    $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

call()

call

(

array

$args = array()

)

Invoke the signal handler.

Parameters

array

$args

Returns

mixed

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

---

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

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