TeamSpeak 3 PHP Framework  1.1.23
Copyright © Planet TeamSpeak. All rights reserved.
 All Classes Namespaces Files Functions Variables Pages
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...
 

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.

57  {
58  $this->signal = (string) $signal;
59 
60  if(!is_callable($callback))
61  {
62  throw new TeamSpeak3_Helper_Signal_Exception("invalid callback specified for signal '" . $signal . "'");
63  }
64 
65  $this->callback = $callback;
66  }

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.

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

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