Factory class all for TeamSpeak 3 PHP Framework objects. More...

Static Public Member Functions
static	factory ($uri)
	Factory for TeamSpeak3_Adapter_Abstract classes.

static	autoload ($class)
	spl_autoload() suitable implementation for supporting class autoloading.

static	init ()
	Checks for required PHP features, enables autoloading and starts a default profiler.

static	getEscapePatterns ()
	Returns an assoc array containing all escape patterns available on a TeamSpeak 3 Server.

static	dump ($var, $echo=TRUE)
	Debug helper function.

Public Attributes
const	READY = "TS3"
	TeamSpeak 3 protocol welcome message.

const	GREET = "Welcome"
	TeamSpeak 3 protocol greeting message prefix.

const	ERROR = "error"
	TeamSpeak 3 protocol error message prefix.

const	EVENT = "notify"
	TeamSpeak 3 protocol event message prefix.

const	SCHID = "selected"
	TeamSpeak 3 protocol server connection handler ID prefix.

const	LIB_VERSION = "1.1.16"
	TeamSpeak 3 PHP Framework version.

const	SEPARATOR_LINE = "\n"
	protocol line separator

const	SEPARATOR_LIST = "\|"
	protocol list separator

const	SEPARATOR_CELL = " "
	protocol cell separator

const	SEPARATOR_PAIR = "="
	protocol pair separator

const	LOGLEVEL_CRITICAL = 0x00
	0: these messages stop the program

const	LOGLEVEL_ERROR = 0x01
	1: everything that is really bad

const	LOGLEVEL_WARNING = 0x02
	2: everything that might be bad

const	LOGLEVEL_DEBUG = 0x03
	3: output that might help find a problem

const	LOGLEVEL_INFO = 0x04
	4: informational output

const	LOGLEVEL_DEVEL = 0x05
	5: development output

const	TOKEN_SERVERGROUP = 0x00
	0: server group token (id1={groupID} id2=0)

const	TOKEN_CHANNELGROUP = 0x01
	1: channel group token (id1={groupID} id2={channelID})

const	CODEC_SPEEX_NARROWBAND = 0x00
	0: speex narrowband (mono, 16bit, 8kHz)

const	CODEC_SPEEX_WIDEBAND = 0x01
	1: speex wideband (mono, 16bit, 16kHz)

const	CODEC_SPEEX_ULTRAWIDEBAND = 0x02
	2: speex ultra-wideband (mono, 16bit, 32kHz)

const	CODEC_CELT_MONO = 0x03
	3: celt mono (mono, 16bit, 48kHz)

const	CODEC_CRYPT_INDIVIDUAL = 0x00
	0: configure per channel

const	CODEC_CRYPT_DISABLED = 0x01
	1: globally disabled

const	CODEC_CRYPT_ENABLED = 0x02
	2: globally enabled

const	KICK_CHANNEL = 0x04
	4: kick client from channel

const	KICK_SERVER = 0x05
	5: kick client from server

const	TEXTMSG_CLIENT = 0x01
	1: target is a client

const	TEXTMSG_CHANNEL = 0x02
	2: target is a channel

const	TEXTMSG_SERVER = 0x03
	3: target is a virtual server

const	HOSTMSG_NONE = 0x00
	0: display no message

const	HOSTMSG_LOG = 0x01
	1: display message in chatlog

const	HOSTMSG_MODAL = 0x02
	2: display message in modal dialog

const	HOSTMSG_MODALQUIT = 0x03
	3: display message in modal dialog and close connection

const	HOSTBANNER_NO_ADJUST = 0x00
	0: do not adjust

const	HOSTBANNER_IGNORE_ASPECT = 0x01
	1: adjust but ignore aspect ratio

const	HOSTBANNER_KEEP_ASPECT = 0x02
	2: adjust and keep aspect ratio

const	CLIENT_TYPE_REGULAR = 0x00
	0: regular client

const	CLIENT_TYPE_SERVERQUERY = 0x01
	1: query client

const	GROUP_DBTYPE_TEMPLATE = 0x00
	0: template group (used for new virtual servers)

const	GROUP_DBTYPE_REGULAR = 0x01
	1: regular group (used for regular clients)

const	GROUP_DBTYPE_SERVERQUERY = 0x02
	2: global query group (used for ServerQuery clients)

const	GROUP_NAMEMODE_HIDDEN = 0x00
	0: display no name

const	GROUP_NAMEMODE_BEFORE = 0x01
	1: display name before client nickname

const	GROUP_NAMEMODE_BEHIND = 0x02
	2: display name after client nickname

const	GROUP_IDENTIFIY_STRONGEST = 0x01
	1: identify most powerful group

const	GROUP_IDENTIFIY_WEAKEST = 0x02
	2: identify weakest group

const	PERM_TYPE_SERVERGROUP = 0x00
	0: server group permission

const	PERM_TYPE_CLIENT = 0x01
	1: client specific permission

const	PERM_TYPE_CHANNEL = 0x02
	2: channel specific permission

const	PERM_TYPE_CHANNELGROUP = 0x03
	3: channel group permission

const	PERM_TYPE_CHANNELCLIENT = 0x04
	4: channel-client specific permission

const	PERM_CAT_GLOBAL = 0x10
	00010000: global permissions

const	PERM_CAT_GLOBAL_INFORMATION = 0x11
	00010001: global permissions -> global information

const	PERM_CAT_GLOBAL_SERVER_MGMT = 0x12
	00010010: global permissions -> virtual server management

const	PERM_CAT_GLOBAL_ADM_ACTIONS = 0x13
	00010011: global permissions -> global administrative actions

const	PERM_CAT_GLOBAL_SETTINGS = 0x14
	00010100: global permissions -> global settings

const	PERM_CAT_SERVER = 0x20
	00100000: virtual server permissions

const	PERM_CAT_SERVER_INFORMATION = 0x21
	00100001: virtual server permissions -> virtual server information

const	PERM_CAT_SERVER_ADM_ACTIONS = 0x22
	00100010: virtual server permissions -> virtual server administrative actions

const	PERM_CAT_SERVER_SETTINGS = 0x23
	00100011: virtual server permissions -> virtual server settings

const	PERM_CAT_CHANNEL = 0x30
	00110000: channel permissions

const	PERM_CAT_CHANNEL_INFORMATION = 0x31
	00110001: channel permissions -> channel information

const	PERM_CAT_CHANNEL_CREATE = 0x32
	00110010: channel permissions -> create channels

const	PERM_CAT_CHANNEL_MODIFY = 0x33
	00110011: channel permissions -> edit channels

const	PERM_CAT_CHANNEL_DELETE = 0x34
	00110100: channel permissions -> delete channels

const	PERM_CAT_CHANNEL_ACCESS = 0x35
	00110101: channel permissions -> access channels

const	PERM_CAT_GROUP = 0x40
	01000000: group permissions

const	PERM_CAT_GROUP_INFORMATION = 0x41
	01000001: group permissions -> group information

const	PERM_CAT_GROUP_CREATE = 0x42
	01000010: group permissions -> create groups

const	PERM_CAT_GROUP_MODIFY = 0x43
	01000011: group permissions -> edit groups

const	PERM_CAT_GROUP_DELETE = 0x44
	01000100: group permissions -> delete groups

const	PERM_CAT_CLIENT = 0x50
	01010000: client permissions

const	PERM_CAT_CLIENT_INFORMATION = 0x51
	01010001: client permissions -> client information

const	PERM_CAT_CLIENT_ADM_ACTIONS = 0x52
	01010010: client permissions -> client administrative actions

const	PERM_CAT_CLIENT_BASICS = 0x53
	01010011: client permissions -> client basic communication

const	PERM_CAT_CLIENT_MODIFY = 0x54
	01010100: client permissions -> edit clients

const	PERM_CAT_FILETRANSFER = 0x60
	01100000: file transfer permissions

const	PERM_CAT_NEEDED_MODIFY_POWER = 0xFF
	11111111: needed permission modify power (grant) permissions

const	FILE_TYPE_DIRECTORY = 0x00
	0: file is directory

const	FILE_TYPE_REGULAR = 0x01
	1: file is regular

const	SNAPSHOT_STRING = 0x00
	0: default string

const	SNAPSHOT_BASE64 = 0x01
	1: base64 string

const	SNAPSHOT_HEXDEC = 0x02
	2: hexadecimal string

const	SPACER_SOLIDLINE = 0x00
	0: solid line

const	SPACER_DASHLINE = 0x01
	1: dash line

const	SPACER_DOTLINE = 0x02
	2: dot line

const	SPACER_DASHDOTLINE = 0x03
	3: dash dot line

const	SPACER_DASHDOTDOTLINE = 0x04
	4: dash dot dot line

const	SPACER_CUSTOM = 0x05
	5: custom format

const	SPACER_ALIGN_LEFT = 0x00
	0: alignment left

const	SPACER_ALIGN_RIGHT = 0x01
	1: alignment right

const	SPACER_ALIGN_CENTER = 0x02
	2: alignment center

const	SPACER_ALIGN_REPEAT = 0x03
	3: repeat until the whole line is filled

const	REASON_NONE = 0x00
	0: no reason

const	REASON_MOVE = 0x01
	1: channel switched or moved

const	REASON_SUBSCRIPTION = 0x02
	2: subscription added or removed

const	REASON_TIMEOUT = 0x03
	3: client connection timed out

const	REASON_CHANNEL_KICK = 0x04
	4: client kicked from channel

const	REASON_SERVER_KICK = 0x05
	5: client kicked from server

const	REASON_SERVER_BAN = 0x06
	6: client banned from server

const	REASON_SERVER_STOP = 0x07
	7: server stopped

const	REASON_DISCONNECT = 0x08
	8: client disconnected

const	REASON_CHANNEL_UPDATE = 0x09
	9: channel information updated

const	REASON_CHANNEL_EDIT = 0x0A
	10: channel information edited

const	REASON_DISCONNECT_SHUTDOWN = 0x0B
	11: client disconnected on server shutdown

Static Protected Member Functions
static	loadClass ($class)
	Loads a class from a PHP file.

static	getFilePath ($name)
	Generates a possible file path for $name.

static	getAdapterName ($name, $namespace="TeamSpeak3_Adapter_")
	Returns the name of an adapter class by $name.

Static Protected Attributes
static	$escape_patterns

Detailed Description

Factory class all for TeamSpeak 3 PHP Framework objects.

Definition at line 32 of file TeamSpeak3.php.

Member Function Documentation

static TeamSpeak3::factory ( $uri )

static

Factory for TeamSpeak3_Adapter_Abstract classes.

$uri must be formatted as "<adapter>://<user>:<pass>@<host>:<port>/<options>#<flags>". All parameters except adapter, host and port are optional.

=== Supported Options ===

timeout
blocking
nickname
no_query_clients
use_offline_as_virtual
clients_before_channels
server_id|server_uid|server_port|server_name|server_tsdns
channel_id|channel_name
client_id|client_uid|client_name

=== Supported Flags (only one per $uri) ===

no_query_clients
use_offline_as_virtual
clients_before_channels

=== URI Examples ===

serverquery://127.0.0.1:10011/
serverquery://127.0.0.1:10011/?server_port=9987&channel_id=1
serverquery://127.0.0.1:10011/?server_port=9987&channel_id=1#no_query_clients
serverquery://127.0.0.1:10011/?server_port=9987&client_name=ScP
filetransfer://127.0.0.1:30011/
blacklist
update

Parameters

string $uri

Returns: TeamSpeak3_Adapter_Abstract; TeamSpeak3_Node_Abstract

Definition at line 299 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Client\avatarDownload(), TeamSpeak3_Viewer_Html\getSuffixIconChannel(), TeamSpeak3_Viewer_Html\getSuffixIconClient(), TeamSpeak3_Viewer_Html\getSuffixIconServer(), TeamSpeak3_Node_Channelgroup\iconDownload(), TeamSpeak3_Node_Servergroup\iconDownload(), TeamSpeak3_Node_Client\iconDownload(), TeamSpeak3_Node_Channel\iconDownload(), TeamSpeak3_Node_Server\iconDownload(), TeamSpeak3_Node_Server\iconUpload(), and TeamSpeak3_Node_Host\serverGetByTSDNS().

  {
    self::init();
    $uri = new TeamSpeak3_Helper_Uri($uri);
    $adapter = self::getAdapterName($uri->getScheme());
    $options = array("host" => $uri->getHost(), "port" => $uri->getPort(), "timeout" => intval($uri->getQueryVar("timeout", 10)), "blocking" => intval($uri->getQueryVar("blocking", 1)));
    self::loadClass($adapter);
    $object = new $adapter($options);
    if($object instanceof TeamSpeak3_Adapter_ServerQuery)
    {
      $node = $object->getHost();
      if($uri->hasUser() && $uri->hasPass())
      {
        $node->login($uri->getUser(), $uri->getPass());
      }
      /* option to pre-define nickname */
      if($uri->hasQueryVar("nickname"))
      {
        $node->setPredefinedQueryName($uri->getQueryVar("nickname"));
      }
      /* flag to use offline servers in virtual mode */
      if($uri->getFragment() == "use_offline_as_virtual")
      {
        $node->setUseOfflineAsVirtual(TRUE);
      }
      elseif($uri->hasQueryVar("use_offline_as_virtual"))
      {
        $node->setUseOfflineAsVirtual($uri->getQueryVar("use_offline_as_virtual") ? TRUE : FALSE);
      }
      /* flag to fetch clients before sub-channels */
      if($uri->getFragment() == "clients_before_channels")
      {
        $node->setLoadClientlistFirst(TRUE);
      }
      elseif($uri->hasQueryVar("clients_before_channels"))
      {
        $node->setLoadClientlistFirst($uri->getQueryVar("clients_before_channels") ? TRUE : FALSE);
      }
      /* flag to hide ServerQuery clients */
      if($uri->getFragment() == "no_query_clients")
      {
        $node->setExcludeQueryClients(TRUE);
      }
      elseif($uri->hasQueryVar("no_query_clients"))
      {
        $node->setExcludeQueryClients($uri->getQueryVar("no_query_clients") ? TRUE : FALSE);
      }
      /* access server node object */
      if($uri->hasQueryVar("server_id"))
      {
        $node = $node->serverGetById($uri->getQueryVar("server_id"));
      }
      elseif($uri->hasQueryVar("server_uid"))
      {
        $node = $node->serverGetByUid($uri->getQueryVar("server_uid"));
      }
      elseif($uri->hasQueryVar("server_port"))
      {
        $node = $node->serverGetByPort($uri->getQueryVar("server_port"));
      }
      elseif($uri->hasQueryVar("server_name"))
      {
        $node = $node->serverGetByName($uri->getQueryVar("server_name"));
      }
      elseif($uri->hasQueryVar("server_tsdns"))
      {
        $node = $node->serverGetByTSDNS($uri->getQueryVar("server_tsdns"));
      }
      /* direct access to node objects */
      if($node instanceof TeamSpeak3_Node_Server)
      {
        /* access channel node object */
        if($uri->hasQueryVar("channel_id"))
        {
          $node = $node->channelGetById($uri->getQueryVar("channel_id"));
        }
        elseif($uri->hasQueryVar("channel_name"))
        {
          $node = $node->channelGetByName($uri->getQueryVar("channel_name"));
        }
        /* access client node object */
        if($uri->hasQueryVar("client_id"))
        {
          $node = $node->clientGetById($uri->getQueryVar("client_id"));
        }
        if($uri->hasQueryVar("client_uid"))
        {
          $node = $node->clientGetByUid($uri->getQueryVar("client_uid"));
        }
        elseif($uri->hasQueryVar("client_name"))
        {
          $node = $node->clientGetByName($uri->getQueryVar("client_name"));
        }
      }
      return $node;
    }
    return $object;
  }

static TeamSpeak3::loadClass ( $class )

staticprotected

Loads a class from a PHP file.

The filename must be formatted as "$class.php".

include() is not prefixed with the @ operator because if the file is loaded and contains a parse error, execution will halt silently and this is difficult to debug.

Parameters

string $class

Exceptions

LogicException

Returns: boolean

Definition at line 423 of file TeamSpeak3.php.

  {
    if(class_exists($class, FALSE) || interface_exists($class, FALSE))
    {
      return;
    }
    if(preg_match("/[^a-z0-9\\/\\\\_.-]/i", $class))
    {
      throw new LogicException("illegal characters in classname '" . $class . "'");
    }
    $file = self::getFilePath($class) . ".php";
    if(!file_exists($file) || !is_readable($file))
    {
      throw new LogicException("file '" . $file . "' does not exist or is not readable");
    }
    if(class_exists($class, FALSE) || interface_exists($class, FALSE))
    {
      throw new LogicException("class '" . $class . "' does not exist");
    }
    return include_once($file);
  }

static TeamSpeak3::getFilePath ( $name )

staticprotected

Generates a possible file path for $name.

Parameters

string $name

Returns: string

Definition at line 456 of file TeamSpeak3.php.

  {
    $path = str_replace("_", DIRECTORY_SEPARATOR, $name);
    $path = str_replace(__CLASS__, dirname(__FILE__), $path);
    return $path;
  }

static TeamSpeak3::getAdapterName	(	$name,
		$namespace = `"TeamSpeak3_Adapter_"`
	)

staticprotected

Returns the name of an adapter class by $name.

Parameters

string	$name
string	$namespace

Exceptions

TeamSpeak3_Adapter_Exception

Returns: string

Definition at line 472 of file TeamSpeak3.php.

References TeamSpeak3_Helper_String\factory().

  {
    $path = self::getFilePath($namespace);
    $scan = scandir($path);
    foreach($scan as $node)
    {
      $file = TeamSpeak3_Helper_String::factory($node)->toLower();
      if($file->startsWith($name) && $file->endsWith(".php"))
      {
        return $namespace . str_replace(".php", "", $node);
      }
    }
    throw new TeamSpeak3_Adapter_Exception("adapter '" . $name . "' does not exist");
  }

static TeamSpeak3::autoload ( $class )

static

spl_autoload() suitable implementation for supporting class autoloading.

Parameters

string $class

Returns: boolean

Definition at line 496 of file TeamSpeak3.php.

  {
    if(substr($class, 0, strlen(__CLASS__)) != __CLASS__) return;
    try
    {
      self::loadClass($class);
      return TRUE;
    }
    catch(Exception $e)
    {
      return FALSE;
    }
  }

static TeamSpeak3::init ( )

static

Checks for required PHP features, enables autoloading and starts a default profiler.

Exceptions

LogicException

Returns: void

Definition at line 518 of file TeamSpeak3.php.

References TeamSpeak3_Helper_Profiler\start().

  {
    if(version_compare(phpversion(), "5.2.1") == -1)
    {
      throw new LogicException("this particular software cannot be used with the installed version of PHP");
    }
    if(!function_exists("stream_socket_client"))
    {
      throw new LogicException("network functions are not available in this PHP installation");
    }
    if(!function_exists("spl_autoload_register"))
    {
      throw new LogicException("autoload functions are not available in this PHP installation");
    }
    if(!class_exists("TeamSpeak3_Helper_Profiler"))
    {
      spl_autoload_register(array(__CLASS__, "autoload"));
    }
    TeamSpeak3_Helper_Profiler::start();
  }

static TeamSpeak3::getEscapePatterns ( )

static

Returns an assoc array containing all escape patterns available on a TeamSpeak 3 Server.

Returns: array

Definition at line 549 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_String\escape(), and TeamSpeak3_Helper_String\unescape().

  {
    return self::$escape_patterns;
  }

static TeamSpeak3::dump	(	$var,
		$echo = `TRUE`
	)

static

Debug helper function.

This is a wrapper for var_dump() that adds the pre-format tags, cleans up newlines and indents, and runs htmlentities() before output.

Parameters

mixed	$var
bool	$echo

Returns: string

Definition at line 562 of file TeamSpeak3.php.

  {
    ob_start();
    var_dump($var);
    $output = ob_get_clean();
    $output = preg_replace("/\]\=>\n(\s+)/m", "] => ", $output);
    if(PHP_SAPI == "cli")
    {
      $output = PHP_EOL . PHP_EOL . $output . PHP_EOL;
    }
    else
    {
      $output = "<pre>" . htmlspecialchars($output, ENT_QUOTES) . "</pre>";
    }
    if($echo) echo($output);
    return $output;
  }

Member Data Documentation

const TeamSpeak3::READY = "TS3"

TeamSpeak 3 protocol welcome message.

Definition at line 37 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Adapter_ServerQuery\syn().

const TeamSpeak3::GREET = "Welcome"

TeamSpeak 3 protocol greeting message prefix.

Definition at line 42 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Adapter_ServerQuery_Reply\fetchReply().

const TeamSpeak3::ERROR = "error"

TeamSpeak 3 protocol error message prefix.

Definition at line 47 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Adapter_ServerQuery_Event\__construct(), and TeamSpeak3_Adapter_ServerQuery\request().

const TeamSpeak3::EVENT = "notify"

TeamSpeak 3 protocol event message prefix.

Definition at line 52 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Adapter_ServerQuery_Event\__construct(), TeamSpeak3_Adapter_ServerQuery_Reply\fetchReply(), and TeamSpeak3_Adapter_ServerQuery\wait().

const TeamSpeak3::SCHID = "selected"

TeamSpeak 3 protocol server connection handler ID prefix.

Definition at line 57 of file TeamSpeak3.php.

const TeamSpeak3::LIB_VERSION = "1.1.16"

TeamSpeak 3 PHP Framework version.

Definition at line 62 of file TeamSpeak3.php.

const TeamSpeak3::SEPARATOR_LINE = "\n"

protocol line separator

Definition at line 67 of file TeamSpeak3.php.

const TeamSpeak3::SEPARATOR_LIST = "|"

protocol list separator

Definition at line 68 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Adapter_ServerQuery_Reply\fetchReply(), TeamSpeak3_Adapter_ServerQuery\prepare(), and TeamSpeak3_Adapter_ServerQuery_Reply\toLines().

const TeamSpeak3::SEPARATOR_CELL = " "

protocol cell separator

Definition at line 69 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Adapter_ServerQuery_Event\__construct(), TeamSpeak3_Adapter_ServerQuery_Reply\fetchError(), TeamSpeak3_Adapter_ServerQuery\prepare(), TeamSpeak3_Adapter_ServerQuery\request(), TeamSpeak3_Adapter_ServerQuery_Reply\toTable(), and TeamSpeak3_Adapter_ServerQuery\wait().

const TeamSpeak3::SEPARATOR_PAIR = "="

protocol pair separator

Definition at line 70 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Adapter_ServerQuery_Event\__construct(), TeamSpeak3_Adapter_ServerQuery_Reply\fetchError(), TeamSpeak3_Adapter_ServerQuery\prepare(), and TeamSpeak3_Adapter_ServerQuery_Reply\toArray().

const TeamSpeak3::LOGLEVEL_CRITICAL = 0x00

0: these messages stop the program

Definition at line 75 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\logLevel().

const TeamSpeak3::LOGLEVEL_ERROR = 0x01

1: everything that is really bad

Definition at line 76 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\logEntry(), and TeamSpeak3_Helper_Convert\logLevel().

const TeamSpeak3::LOGLEVEL_WARNING = 0x02

2: everything that might be bad

Definition at line 77 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\logLevel().

const TeamSpeak3::LOGLEVEL_DEBUG = 0x03

3: output that might help find a problem

Definition at line 78 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\logLevel().

const TeamSpeak3::LOGLEVEL_INFO = 0x04

4: informational output

Definition at line 79 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\logLevel().

const TeamSpeak3::LOGLEVEL_DEVEL = 0x05

5: development output

Definition at line 80 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\logLevel().

const TeamSpeak3::TOKEN_SERVERGROUP = 0x00

0: server group token (id1={groupID} id2=0)

Definition at line 85 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Servergroup\privilegeKeyCreate().

const TeamSpeak3::TOKEN_CHANNELGROUP = 0x01

1: channel group token (id1={groupID} id2={channelID})

Definition at line 86 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Channelgroup\privilegeKeyCreate().

const TeamSpeak3::CODEC_SPEEX_NARROWBAND = 0x00

0: speex narrowband (mono, 16bit, 8kHz)

Definition at line 91 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\channelSpacerCreate(), and TeamSpeak3_Helper_Convert\codec().

const TeamSpeak3::CODEC_SPEEX_WIDEBAND = 0x01

1: speex wideband (mono, 16bit, 16kHz)

Definition at line 92 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\codec().

const TeamSpeak3::CODEC_SPEEX_ULTRAWIDEBAND = 0x02

2: speex ultra-wideband (mono, 16bit, 32kHz)

Definition at line 93 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\codec().

const TeamSpeak3::CODEC_CELT_MONO = 0x03

3: celt mono (mono, 16bit, 48kHz)

Definition at line 94 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\codec().

const TeamSpeak3::CODEC_CRYPT_INDIVIDUAL = 0x00

0: configure per channel

Definition at line 99 of file TeamSpeak3.php.

const TeamSpeak3::CODEC_CRYPT_DISABLED = 0x01

1: globally disabled

Definition at line 100 of file TeamSpeak3.php.

const TeamSpeak3::CODEC_CRYPT_ENABLED = 0x02

2: globally enabled

Definition at line 101 of file TeamSpeak3.php.

const TeamSpeak3::KICK_CHANNEL = 0x04

4: kick client from channel

Definition at line 106 of file TeamSpeak3.php.

const TeamSpeak3::KICK_SERVER = 0x05

5: kick client from server

Definition at line 107 of file TeamSpeak3.php.

const TeamSpeak3::TEXTMSG_CLIENT = 0x01

1: target is a client

Definition at line 112 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Client\message(), TeamSpeak3_Node_Channelgroup\message(), and TeamSpeak3_Node_Servergroup\message().

const TeamSpeak3::TEXTMSG_CHANNEL = 0x02

2: target is a channel

Definition at line 113 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Channel\message().

const TeamSpeak3::TEXTMSG_SERVER = 0x03

3: target is a virtual server

Definition at line 114 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\message().

const TeamSpeak3::HOSTMSG_NONE = 0x00

0: display no message

Definition at line 119 of file TeamSpeak3.php.

const TeamSpeak3::HOSTMSG_LOG = 0x01

1: display message in chatlog

Definition at line 120 of file TeamSpeak3.php.

const TeamSpeak3::HOSTMSG_MODAL = 0x02

2: display message in modal dialog

Definition at line 121 of file TeamSpeak3.php.

const TeamSpeak3::HOSTMSG_MODALQUIT = 0x03

3: display message in modal dialog and close connection

Definition at line 122 of file TeamSpeak3.php.

const TeamSpeak3::HOSTBANNER_NO_ADJUST = 0x00

0: do not adjust

Definition at line 127 of file TeamSpeak3.php.

const TeamSpeak3::HOSTBANNER_IGNORE_ASPECT = 0x01

1: adjust but ignore aspect ratio

Definition at line 128 of file TeamSpeak3.php.

const TeamSpeak3::HOSTBANNER_KEEP_ASPECT = 0x02

2: adjust and keep aspect ratio

Definition at line 129 of file TeamSpeak3.php.

const TeamSpeak3::CLIENT_TYPE_REGULAR = 0x00

0: regular client

Definition at line 134 of file TeamSpeak3.php.

const TeamSpeak3::CLIENT_TYPE_SERVERQUERY = 0x01

1: query client

Definition at line 135 of file TeamSpeak3.php.

const TeamSpeak3::GROUP_DBTYPE_TEMPLATE = 0x00

0: template group (used for new virtual servers)

Definition at line 140 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\groupType().

const TeamSpeak3::GROUP_DBTYPE_REGULAR = 0x01

1: regular group (used for regular clients)

Definition at line 141 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\groupType(), and TeamSpeak3_Node_Server\serverGroupGetProfiles().

const TeamSpeak3::GROUP_DBTYPE_SERVERQUERY = 0x02

2: global query group (used for ServerQuery clients)

Definition at line 142 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\groupType().

const TeamSpeak3::GROUP_NAMEMODE_HIDDEN = 0x00

0: display no name

Definition at line 147 of file TeamSpeak3.php.

const TeamSpeak3::GROUP_NAMEMODE_BEFORE = 0x01

1: display name before client nickname

Definition at line 148 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Viewer_Html\getCorpusName().

const TeamSpeak3::GROUP_NAMEMODE_BEHIND = 0x02

2: display name after client nickname

Definition at line 149 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Viewer_Html\getCorpusName().

const TeamSpeak3::GROUP_IDENTIFIY_STRONGEST = 0x01

1: identify most powerful group

Definition at line 154 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\serverGroupIdentify().

const TeamSpeak3::GROUP_IDENTIFIY_WEAKEST = 0x02

2: identify weakest group

Definition at line 155 of file TeamSpeak3.php.

const TeamSpeak3::PERM_TYPE_SERVERGROUP = 0x00

0: server group permission

Definition at line 160 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionType(), and TeamSpeak3_Node_Server\permRemoveAny().

const TeamSpeak3::PERM_TYPE_CLIENT = 0x01

1: client specific permission

Definition at line 161 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionType(), and TeamSpeak3_Node_Server\permRemoveAny().

const TeamSpeak3::PERM_TYPE_CHANNEL = 0x02

2: channel specific permission

Definition at line 162 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionType(), and TeamSpeak3_Node_Server\permRemoveAny().

const TeamSpeak3::PERM_TYPE_CHANNELGROUP = 0x03

3: channel group permission

Definition at line 163 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionType(), and TeamSpeak3_Node_Server\permRemoveAny().

const TeamSpeak3::PERM_TYPE_CHANNELCLIENT = 0x04

4: channel-client specific permission

Definition at line 164 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionType(), and TeamSpeak3_Node_Server\permRemoveAny().

const TeamSpeak3::PERM_CAT_GLOBAL = 0x10

00010000: global permissions

Definition at line 169 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_GLOBAL_INFORMATION = 0x11

00010001: global permissions -> global information

Definition at line 170 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_GLOBAL_SERVER_MGMT = 0x12

00010010: global permissions -> virtual server management

Definition at line 171 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_GLOBAL_ADM_ACTIONS = 0x13

00010011: global permissions -> global administrative actions

Definition at line 172 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_GLOBAL_SETTINGS = 0x14

00010100: global permissions -> global settings

Definition at line 173 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_SERVER = 0x20

00100000: virtual server permissions

Definition at line 174 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_SERVER_INFORMATION = 0x21

00100001: virtual server permissions -> virtual server information

Definition at line 175 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_SERVER_ADM_ACTIONS = 0x22

00100010: virtual server permissions -> virtual server administrative actions

Definition at line 176 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_SERVER_SETTINGS = 0x23

00100011: virtual server permissions -> virtual server settings

Definition at line 177 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_CHANNEL = 0x30

00110000: channel permissions

Definition at line 178 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_CHANNEL_INFORMATION = 0x31

00110001: channel permissions -> channel information

Definition at line 179 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_CHANNEL_CREATE = 0x32

00110010: channel permissions -> create channels

Definition at line 180 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_CHANNEL_MODIFY = 0x33

00110011: channel permissions -> edit channels

Definition at line 181 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_CHANNEL_DELETE = 0x34

00110100: channel permissions -> delete channels

Definition at line 182 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_CHANNEL_ACCESS = 0x35

00110101: channel permissions -> access channels

Definition at line 183 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_GROUP = 0x40

01000000: group permissions

Definition at line 184 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_GROUP_INFORMATION = 0x41

01000001: group permissions -> group information

Definition at line 185 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_GROUP_CREATE = 0x42

01000010: group permissions -> create groups

Definition at line 186 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_GROUP_MODIFY = 0x43

01000011: group permissions -> edit groups

Definition at line 187 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_GROUP_DELETE = 0x44

01000100: group permissions -> delete groups

Definition at line 188 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_CLIENT = 0x50

01010000: client permissions

Definition at line 189 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_CLIENT_INFORMATION = 0x51

01010001: client permissions -> client information

Definition at line 190 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_CLIENT_ADM_ACTIONS = 0x52

01010010: client permissions -> client administrative actions

Definition at line 191 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_CLIENT_BASICS = 0x53

01010011: client permissions -> client basic communication

Definition at line 192 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_CLIENT_MODIFY = 0x54

01010100: client permissions -> edit clients

Definition at line 193 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_FILETRANSFER = 0x60

01100000: file transfer permissions

Definition at line 194 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_NEEDED_MODIFY_POWER = 0xFF

11111111: needed permission modify power (grant) permissions

Definition at line 195 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::FILE_TYPE_DIRECTORY = 0x00

0: file is directory

Definition at line 200 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\channelFileList().

const TeamSpeak3::FILE_TYPE_REGULAR = 0x01

1: file is regular

Definition at line 201 of file TeamSpeak3.php.

const TeamSpeak3::SNAPSHOT_STRING = 0x00

0: default string

Definition at line 206 of file TeamSpeak3.php.

const TeamSpeak3::SNAPSHOT_BASE64 = 0x01

1: base64 string

Definition at line 207 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\snapshotCreate(), and TeamSpeak3_Node_Server\snapshotDeploy().

const TeamSpeak3::SNAPSHOT_HEXDEC = 0x02

2: hexadecimal string

Definition at line 208 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\snapshotCreate(), and TeamSpeak3_Node_Server\snapshotDeploy().

const TeamSpeak3::SPACER_SOLIDLINE = 0x00

0: solid line

Definition at line 213 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\channelSpacerCreate(), TeamSpeak3_Node_Server\channelSpacerGetType(), and TeamSpeak3_Viewer_Html\getCorpusClass().

const TeamSpeak3::SPACER_DASHLINE = 0x01

1: dash line

Definition at line 214 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\channelSpacerCreate(), TeamSpeak3_Node_Server\channelSpacerGetType(), and TeamSpeak3_Viewer_Html\getCorpusClass().

const TeamSpeak3::SPACER_DOTLINE = 0x02

2: dot line

Definition at line 215 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\channelSpacerCreate(), TeamSpeak3_Node_Server\channelSpacerGetType(), and TeamSpeak3_Viewer_Html\getCorpusClass().

const TeamSpeak3::SPACER_DASHDOTLINE = 0x03

3: dash dot line

Definition at line 216 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\channelSpacerCreate(), TeamSpeak3_Node_Server\channelSpacerGetType(), and TeamSpeak3_Viewer_Html\getCorpusClass().

const TeamSpeak3::SPACER_DASHDOTDOTLINE = 0x04

4: dash dot dot line

Definition at line 217 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\channelSpacerCreate(), TeamSpeak3_Node_Server\channelSpacerGetType(), and TeamSpeak3_Viewer_Html\getCorpusClass().

const TeamSpeak3::SPACER_CUSTOM = 0x05

5: custom format

Definition at line 218 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\channelSpacerGetType(), and TeamSpeak3_Viewer_Html\getCorpusName().

const TeamSpeak3::SPACER_ALIGN_LEFT = 0x00

0: alignment left

Definition at line 223 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\channelSpacerCreate(), TeamSpeak3_Node_Server\channelSpacerGetAlign(), and TeamSpeak3_Viewer_Html\getCorpusClass().

const TeamSpeak3::SPACER_ALIGN_RIGHT = 0x01

1: alignment right

Definition at line 224 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\channelSpacerCreate(), TeamSpeak3_Node_Server\channelSpacerGetAlign(), and TeamSpeak3_Viewer_Html\getCorpusClass().

const TeamSpeak3::SPACER_ALIGN_CENTER = 0x02

2: alignment center

Definition at line 225 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\channelSpacerCreate(), TeamSpeak3_Node_Server\channelSpacerGetAlign(), and TeamSpeak3_Viewer_Html\getCorpusClass().

const TeamSpeak3::SPACER_ALIGN_REPEAT = 0x03

3: repeat until the whole line is filled

Definition at line 226 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\channelSpacerCreate(), TeamSpeak3_Node_Server\channelSpacerGetAlign(), and TeamSpeak3_Viewer_Html\getCorpusName().

const TeamSpeak3::REASON_NONE = 0x00

0: no reason

Definition at line 231 of file TeamSpeak3.php.

const TeamSpeak3::REASON_MOVE = 0x01

1: channel switched or moved

Definition at line 232 of file TeamSpeak3.php.

const TeamSpeak3::REASON_SUBSCRIPTION = 0x02

2: subscription added or removed

Definition at line 233 of file TeamSpeak3.php.

const TeamSpeak3::REASON_TIMEOUT = 0x03

3: client connection timed out

Definition at line 234 of file TeamSpeak3.php.

const TeamSpeak3::REASON_CHANNEL_KICK = 0x04

4: client kicked from channel

Definition at line 235 of file TeamSpeak3.php.

const TeamSpeak3::REASON_SERVER_KICK = 0x05

5: client kicked from server

Definition at line 236 of file TeamSpeak3.php.

const TeamSpeak3::REASON_SERVER_BAN = 0x06

6: client banned from server

Definition at line 237 of file TeamSpeak3.php.

const TeamSpeak3::REASON_SERVER_STOP = 0x07

7: server stopped

Definition at line 238 of file TeamSpeak3.php.

const TeamSpeak3::REASON_DISCONNECT = 0x08

8: client disconnected

Definition at line 239 of file TeamSpeak3.php.

const TeamSpeak3::REASON_CHANNEL_UPDATE = 0x09

9: channel information updated

Definition at line 240 of file TeamSpeak3.php.

const TeamSpeak3::REASON_CHANNEL_EDIT = 0x0A

10: channel information edited

Definition at line 241 of file TeamSpeak3.php.

const TeamSpeak3::REASON_DISCONNECT_SHUTDOWN = 0x0B

11: client disconnected on server shutdown

Definition at line 242 of file TeamSpeak3.php.

TeamSpeak3::$escape_patterns

staticprotected

Initial value:

= array(
    "\\" => "\\\\", 
    "/"  => "\\/",  
    " "  => "\\s",  
    "|"  => "\\p",  
    ";"  => "\\;",  
    "\a" => "\\a",  
    "\b" => "\\b",  
    "\f" => "\\f",  
    "\n" => "\\n",  
    "\r" => "\\r",  
    "\t" => "\\t",  
    "\v" => "\\v"   
  )

Definition at line 250 of file TeamSpeak3.php.

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

TeamSpeak3/TeamSpeak3.php

Static Public Member Functions

Public Attributes

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation