ts3phpframework
Loading...
Searching...
No Matches
PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3 Class Reference

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

Static Public Member Functions

static factory (string $uri)
static init ()
static getEscapePatterns ()
static dump (mixed $var, bool $echo=true)

Public Attributes

const TS3_PROTO_IDENT = "TS3"
const TS3_MOTD_PREFIX = "Welcome"
const TEA_PROTO_IDENT = "TeaSpeak"
const TEA_MOTD_PREFIX = "Welcome"
const ERROR = "error"
const EVENT = "notify"
const SCHID = "selected"
const LIB_VERSION = "1.3.0"
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 APIKEY_MANAGE = "manage"
 allow access to administrative calls
const APIKEY_WRITE = "write"
 allow access to read and write calls
const APIKEY_READ = "read"
 allow access to read-only calls
const LOGLEVEL_CRITICAL = 0x00
 0: these messages stop the program
const LOGLEVEL_ERROR = 0x01
 1: everything that is awful
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_OPUS_VOICE = 0x04
 3: opus voice (interactive)
const CODEC_OPUS_MUSIC = 0x05
 3: opus music (interactive)
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 PLUGINCMD_CHANNEL = 0x01
 1: send plugincmd to all clients in current channel
const PLUGINCMD_SERVER = 0x02
 2: send plugincmd to all clients on server
const PLUGINCMD_CLIENT = 0x03
 3: send plugincmd to all given client ids
const PLUGINCMD_CHANNEL_SUBSCRIBED = 0x04
 4: send plugincmd to all subscribed clients in current channel
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 getAdapterName (string $name, string $namespace="Adapter_")
static loadClass (string $class)
static getFilePath (string $name)

Static Protected Attributes

static array $escape_patterns

Detailed Description

Factory class all for TeamSpeak 3 PHP Framework objects.

Definition at line 50 of file TeamSpeak3.php.

Member Function Documentation

◆ dump()

PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::dump ( mixed $var,
bool $echo = true )
static

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

Parameters
mixed$var
bool$echo
Returns
string

Definition at line 548 of file TeamSpeak3.php.

◆ factory()

PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::factory ( string $uri)
static

Factory for PlanetTeamSpeak\TeamSpeak3Framework\Node\Server 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
  • tls (TeaSpeak only)
  • ssh (TeamSpeak only)
  • nickname
  • no_query_clients
  • use_offline_as_virtual
  • clients_before_channels
  • server_id|server_uid|server_port|server_name
  • 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:10022/?ssh=1 (TeamSpeak ONLY)
  • serverquery://127.0.0.1:10011/?tls=1 (TeaSpeak ONLY)
  • serverquery://127.0.0.1:10022/?ssh=1&server_port=9987
  • 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/
Parameters
string$uri
Returns
Host|Server|ServerQuery|MockServerQuery|FileTransfer
Exceptions
AdapterException
HelperException
ServerQueryException
Exception

Definition at line 350 of file TeamSpeak3.php.

◆ getAdapterName()

PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::getAdapterName ( string $name,
string $namespace = "Adapter_" )
staticprotected

Returns the name of an adapter class by $name.

Parameters
string$name
string$namespace
Returns
string
Exceptions
AdapterException

Definition at line 445 of file TeamSpeak3.php.

◆ getEscapePatterns()

PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::getEscapePatterns ( )
static

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

Returns
array

Definition at line 535 of file TeamSpeak3.php.

◆ getFilePath()

PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::getFilePath ( string $name)
staticprotected

Generates a possible file path for $name.

Parameters
string$name
Returns
string

Definition at line 500 of file TeamSpeak3.php.

◆ init()

PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::init ( )
static

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

Returns
void
Exceptions
Exception

Definition at line 512 of file TeamSpeak3.php.

◆ loadClass()

PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::loadClass ( string $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
Returns
boolean
Exceptions
Exception

Definition at line 471 of file TeamSpeak3.php.

Member Data Documentation

◆ $escape_patterns

array PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::$escape_patterns
staticprotected
Initial value:
= [
"\\" => "\\\\",
"/" => "\\/",
" " => "\\s",
"|" => "\\p",
";" => "\\;",
"\a" => "\\a",
"\b" => "\\b",
"\f" => "\\f",
"\n" => "\\n",
"\r" => "\\r",
"\t" => "\\t",
"\v" => "\\v"
]

Definition at line 295 of file TeamSpeak3.php.

◆ APIKEY_MANAGE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::APIKEY_MANAGE = "manage"

allow access to administrative calls

Definition at line 103 of file TeamSpeak3.php.

◆ APIKEY_READ

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::APIKEY_READ = "read"

allow access to read-only calls

Definition at line 105 of file TeamSpeak3.php.

◆ APIKEY_WRITE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::APIKEY_WRITE = "write"

allow access to read and write calls

Definition at line 104 of file TeamSpeak3.php.

◆ CLIENT_TYPE_REGULAR

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::CLIENT_TYPE_REGULAR = 0x00

0: regular client

Definition at line 179 of file TeamSpeak3.php.

◆ CLIENT_TYPE_SERVERQUERY

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::CLIENT_TYPE_SERVERQUERY = 0x01

1: query client

Definition at line 180 of file TeamSpeak3.php.

◆ CODEC_CELT_MONO

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::CODEC_CELT_MONO = 0x03

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

Definition at line 129 of file TeamSpeak3.php.

◆ CODEC_CRYPT_DISABLED

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::CODEC_CRYPT_DISABLED = 0x01

1: globally disabled

Definition at line 137 of file TeamSpeak3.php.

◆ CODEC_CRYPT_ENABLED

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::CODEC_CRYPT_ENABLED = 0x02

2: globally enabled

Definition at line 138 of file TeamSpeak3.php.

◆ CODEC_CRYPT_INDIVIDUAL

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::CODEC_CRYPT_INDIVIDUAL = 0x00

0: configure per channel

Definition at line 136 of file TeamSpeak3.php.

◆ CODEC_OPUS_MUSIC

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::CODEC_OPUS_MUSIC = 0x05

3: opus music (interactive)

Definition at line 131 of file TeamSpeak3.php.

◆ CODEC_OPUS_VOICE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::CODEC_OPUS_VOICE = 0x04

3: opus voice (interactive)

Definition at line 130 of file TeamSpeak3.php.

◆ CODEC_SPEEX_NARROWBAND

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::CODEC_SPEEX_NARROWBAND = 0x00

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

Definition at line 126 of file TeamSpeak3.php.

◆ CODEC_SPEEX_ULTRAWIDEBAND

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::CODEC_SPEEX_ULTRAWIDEBAND = 0x02

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

Definition at line 128 of file TeamSpeak3.php.

◆ CODEC_SPEEX_WIDEBAND

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::CODEC_SPEEX_WIDEBAND = 0x01

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

Definition at line 127 of file TeamSpeak3.php.

◆ ERROR

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::ERROR = "error"

TeamSpeak 3 protocol error message prefix.

Definition at line 75 of file TeamSpeak3.php.

◆ EVENT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::EVENT = "notify"

TeamSpeak 3 protocol event message prefix.

Definition at line 80 of file TeamSpeak3.php.

◆ FILE_TYPE_DIRECTORY

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::FILE_TYPE_DIRECTORY = 0x00

0: file is directory

Definition at line 245 of file TeamSpeak3.php.

◆ FILE_TYPE_REGULAR

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::FILE_TYPE_REGULAR = 0x01

1: file is regular

Definition at line 246 of file TeamSpeak3.php.

◆ GROUP_DBTYPE_REGULAR

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::GROUP_DBTYPE_REGULAR = 0x01

1: regular group (used for regular clients)

Definition at line 186 of file TeamSpeak3.php.

◆ GROUP_DBTYPE_SERVERQUERY

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::GROUP_DBTYPE_SERVERQUERY = 0x02

2: global query group (used for ServerQuery clients)

Definition at line 187 of file TeamSpeak3.php.

◆ GROUP_DBTYPE_TEMPLATE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::GROUP_DBTYPE_TEMPLATE = 0x00

0: template group (used for new virtual servers)

Definition at line 185 of file TeamSpeak3.php.

◆ GROUP_IDENTIFIY_STRONGEST

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::GROUP_IDENTIFIY_STRONGEST = 0x01

1: identify most powerful group

Definition at line 199 of file TeamSpeak3.php.

◆ GROUP_IDENTIFIY_WEAKEST

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::GROUP_IDENTIFIY_WEAKEST = 0x02

2: identify weakest group

Definition at line 200 of file TeamSpeak3.php.

◆ GROUP_NAMEMODE_BEFORE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::GROUP_NAMEMODE_BEFORE = 0x01

1: display name before client nickname

Definition at line 193 of file TeamSpeak3.php.

◆ GROUP_NAMEMODE_BEHIND

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::GROUP_NAMEMODE_BEHIND = 0x02

2: display name after client nickname

Definition at line 194 of file TeamSpeak3.php.

◆ GROUP_NAMEMODE_HIDDEN

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::GROUP_NAMEMODE_HIDDEN = 0x00

0: display no name

Definition at line 192 of file TeamSpeak3.php.

◆ HOSTBANNER_IGNORE_ASPECT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::HOSTBANNER_IGNORE_ASPECT = 0x01

1: adjust but ignore aspect ratio

Definition at line 173 of file TeamSpeak3.php.

◆ HOSTBANNER_KEEP_ASPECT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::HOSTBANNER_KEEP_ASPECT = 0x02

2: adjust and keep aspect ratio

Definition at line 174 of file TeamSpeak3.php.

◆ HOSTBANNER_NO_ADJUST

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::HOSTBANNER_NO_ADJUST = 0x00

0: do not adjust

Definition at line 172 of file TeamSpeak3.php.

◆ HOSTMSG_LOG

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::HOSTMSG_LOG = 0x01

1: display message in chatlog

Definition at line 165 of file TeamSpeak3.php.

◆ HOSTMSG_MODAL

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::HOSTMSG_MODAL = 0x02

2: display message in modal dialog

Definition at line 166 of file TeamSpeak3.php.

◆ HOSTMSG_MODALQUIT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::HOSTMSG_MODALQUIT = 0x03

3: display message in modal dialog and close connection

Definition at line 167 of file TeamSpeak3.php.

◆ HOSTMSG_NONE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::HOSTMSG_NONE = 0x00

0: display no message

Definition at line 164 of file TeamSpeak3.php.

◆ KICK_CHANNEL

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::KICK_CHANNEL = 0x04

4: kick client from channel

Definition at line 143 of file TeamSpeak3.php.

◆ KICK_SERVER

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::KICK_SERVER = 0x05

5: kick client from server

Definition at line 144 of file TeamSpeak3.php.

◆ LIB_VERSION

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::LIB_VERSION = "1.3.0"

TeamSpeak 3 PHP Framework version.

Definition at line 90 of file TeamSpeak3.php.

◆ LOGLEVEL_CRITICAL

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::LOGLEVEL_CRITICAL = 0x00

0: these messages stop the program

Definition at line 110 of file TeamSpeak3.php.

◆ LOGLEVEL_DEBUG

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::LOGLEVEL_DEBUG = 0x03

3: output that might help find a problem

Definition at line 113 of file TeamSpeak3.php.

◆ LOGLEVEL_DEVEL

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::LOGLEVEL_DEVEL = 0x05

5: development output

Definition at line 115 of file TeamSpeak3.php.

◆ LOGLEVEL_ERROR

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::LOGLEVEL_ERROR = 0x01

1: everything that is awful

Definition at line 111 of file TeamSpeak3.php.

◆ LOGLEVEL_INFO

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::LOGLEVEL_INFO = 0x04

4: informational output

Definition at line 114 of file TeamSpeak3.php.

◆ LOGLEVEL_WARNING

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::LOGLEVEL_WARNING = 0x02

2: everything that might be bad

Definition at line 112 of file TeamSpeak3.php.

◆ PERM_CAT_CHANNEL

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_CHANNEL = 0x30

00110000: channel permissions

Definition at line 223 of file TeamSpeak3.php.

◆ PERM_CAT_CHANNEL_ACCESS

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_CHANNEL_ACCESS = 0x35

00110101: channel permissions -> access channels

Definition at line 228 of file TeamSpeak3.php.

◆ PERM_CAT_CHANNEL_CREATE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_CHANNEL_CREATE = 0x32

00110010: channel permissions -> create channels

Definition at line 225 of file TeamSpeak3.php.

◆ PERM_CAT_CHANNEL_DELETE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_CHANNEL_DELETE = 0x34

00110100: channel permissions -> delete channels

Definition at line 227 of file TeamSpeak3.php.

◆ PERM_CAT_CHANNEL_INFORMATION

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_CHANNEL_INFORMATION = 0x31

00110001: channel permissions -> channel information

Definition at line 224 of file TeamSpeak3.php.

◆ PERM_CAT_CHANNEL_MODIFY

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_CHANNEL_MODIFY = 0x33

00110011: channel permissions -> edit channels

Definition at line 226 of file TeamSpeak3.php.

◆ PERM_CAT_CLIENT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_CLIENT = 0x50

01010000: client permissions

Definition at line 234 of file TeamSpeak3.php.

◆ PERM_CAT_CLIENT_ADM_ACTIONS

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_CLIENT_ADM_ACTIONS = 0x52

01010010: client permissions -> client administrative actions

Definition at line 236 of file TeamSpeak3.php.

◆ PERM_CAT_CLIENT_BASICS

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_CLIENT_BASICS = 0x53

01010011: client permissions -> client basic communication

Definition at line 237 of file TeamSpeak3.php.

◆ PERM_CAT_CLIENT_INFORMATION

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_CLIENT_INFORMATION = 0x51

01010001: client permissions -> client information

Definition at line 235 of file TeamSpeak3.php.

◆ PERM_CAT_CLIENT_MODIFY

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_CLIENT_MODIFY = 0x54

01010100: client permissions -> edit clients

Definition at line 238 of file TeamSpeak3.php.

◆ PERM_CAT_FILETRANSFER

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_FILETRANSFER = 0x60

01100000: file transfer permissions

Definition at line 239 of file TeamSpeak3.php.

◆ PERM_CAT_GLOBAL

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_GLOBAL = 0x10

00010000: global permissions

Definition at line 214 of file TeamSpeak3.php.

◆ PERM_CAT_GLOBAL_ADM_ACTIONS

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_GLOBAL_ADM_ACTIONS = 0x13

00010011: global permissions -> global administrative actions

Definition at line 217 of file TeamSpeak3.php.

◆ PERM_CAT_GLOBAL_INFORMATION

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_GLOBAL_INFORMATION = 0x11

00010001: global permissions -> global information

Definition at line 215 of file TeamSpeak3.php.

◆ PERM_CAT_GLOBAL_SERVER_MGMT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_GLOBAL_SERVER_MGMT = 0x12

00010010: global permissions -> virtual server management

Definition at line 216 of file TeamSpeak3.php.

◆ PERM_CAT_GLOBAL_SETTINGS

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_GLOBAL_SETTINGS = 0x14

00010100: global permissions -> global settings

Definition at line 218 of file TeamSpeak3.php.

◆ PERM_CAT_GROUP

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_GROUP = 0x40

01000000: group permissions

Definition at line 229 of file TeamSpeak3.php.

◆ PERM_CAT_GROUP_CREATE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_GROUP_CREATE = 0x42

01000010: group permissions -> create groups

Definition at line 231 of file TeamSpeak3.php.

◆ PERM_CAT_GROUP_DELETE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_GROUP_DELETE = 0x44

01000100: group permissions -> delete groups

Definition at line 233 of file TeamSpeak3.php.

◆ PERM_CAT_GROUP_INFORMATION

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_GROUP_INFORMATION = 0x41

01000001: group permissions -> group information

Definition at line 230 of file TeamSpeak3.php.

◆ PERM_CAT_GROUP_MODIFY

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_GROUP_MODIFY = 0x43

01000011: group permissions -> edit groups

Definition at line 232 of file TeamSpeak3.php.

◆ PERM_CAT_NEEDED_MODIFY_POWER

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_NEEDED_MODIFY_POWER = 0xFF

11111111: needed permission modify power (grant) permissions

Definition at line 240 of file TeamSpeak3.php.

◆ PERM_CAT_SERVER

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_SERVER = 0x20

00100000: virtual server permissions

Definition at line 219 of file TeamSpeak3.php.

◆ PERM_CAT_SERVER_ADM_ACTIONS

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_SERVER_ADM_ACTIONS = 0x22

00100010: virtual server permissions -> virtual server administrative actions

Definition at line 221 of file TeamSpeak3.php.

◆ PERM_CAT_SERVER_INFORMATION

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_SERVER_INFORMATION = 0x21

00100001: virtual server permissions -> virtual server information

Definition at line 220 of file TeamSpeak3.php.

◆ PERM_CAT_SERVER_SETTINGS

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_CAT_SERVER_SETTINGS = 0x23

00100011: virtual server permissions -> virtual server settings

Definition at line 222 of file TeamSpeak3.php.

◆ PERM_TYPE_CHANNEL

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_TYPE_CHANNEL = 0x02

2: channel specific permission

Definition at line 207 of file TeamSpeak3.php.

◆ PERM_TYPE_CHANNELCLIENT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_TYPE_CHANNELCLIENT = 0x04

4: channel-client specific permission

Definition at line 209 of file TeamSpeak3.php.

◆ PERM_TYPE_CHANNELGROUP

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_TYPE_CHANNELGROUP = 0x03

3: channel group permission

Definition at line 208 of file TeamSpeak3.php.

◆ PERM_TYPE_CLIENT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_TYPE_CLIENT = 0x01

1: client specific permission

Definition at line 206 of file TeamSpeak3.php.

◆ PERM_TYPE_SERVERGROUP

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PERM_TYPE_SERVERGROUP = 0x00

0: server group permission

Definition at line 205 of file TeamSpeak3.php.

◆ PLUGINCMD_CHANNEL

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PLUGINCMD_CHANNEL = 0x01

1: send plugincmd to all clients in current channel

Definition at line 156 of file TeamSpeak3.php.

◆ PLUGINCMD_CHANNEL_SUBSCRIBED

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PLUGINCMD_CHANNEL_SUBSCRIBED = 0x04

4: send plugincmd to all subscribed clients in current channel

Definition at line 159 of file TeamSpeak3.php.

◆ PLUGINCMD_CLIENT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PLUGINCMD_CLIENT = 0x03

3: send plugincmd to all given client ids

Definition at line 158 of file TeamSpeak3.php.

◆ PLUGINCMD_SERVER

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::PLUGINCMD_SERVER = 0x02

2: send plugincmd to all clients on server

Definition at line 157 of file TeamSpeak3.php.

◆ REASON_CHANNEL_EDIT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::REASON_CHANNEL_EDIT = 0x0A

10: channel information edited

Definition at line 286 of file TeamSpeak3.php.

◆ REASON_CHANNEL_KICK

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::REASON_CHANNEL_KICK = 0x04

4: client kicked from channel

Definition at line 280 of file TeamSpeak3.php.

◆ REASON_CHANNEL_UPDATE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::REASON_CHANNEL_UPDATE = 0x09

9: channel information updated

Definition at line 285 of file TeamSpeak3.php.

◆ REASON_DISCONNECT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::REASON_DISCONNECT = 0x08

8: client disconnected

Definition at line 284 of file TeamSpeak3.php.

◆ REASON_DISCONNECT_SHUTDOWN

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::REASON_DISCONNECT_SHUTDOWN = 0x0B

11: client disconnected on server shutdown

Definition at line 287 of file TeamSpeak3.php.

◆ REASON_MOVE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::REASON_MOVE = 0x01

1: channel switched or moved

Definition at line 277 of file TeamSpeak3.php.

◆ REASON_NONE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::REASON_NONE = 0x00

0: no reason

Definition at line 276 of file TeamSpeak3.php.

◆ REASON_SERVER_BAN

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::REASON_SERVER_BAN = 0x06

6: client banned from server

Definition at line 282 of file TeamSpeak3.php.

◆ REASON_SERVER_KICK

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::REASON_SERVER_KICK = 0x05

5: client kicked from server

Definition at line 281 of file TeamSpeak3.php.

◆ REASON_SERVER_STOP

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::REASON_SERVER_STOP = 0x07

7: server stopped

Definition at line 283 of file TeamSpeak3.php.

◆ REASON_SUBSCRIPTION

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::REASON_SUBSCRIPTION = 0x02

2: subscription added or removed

Definition at line 278 of file TeamSpeak3.php.

◆ REASON_TIMEOUT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::REASON_TIMEOUT = 0x03

3: client connection timed out

Definition at line 279 of file TeamSpeak3.php.

◆ SCHID

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SCHID = "selected"

TeamSpeak 3 protocol server connection handler ID prefix.

Definition at line 85 of file TeamSpeak3.php.

◆ SEPARATOR_CELL

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SEPARATOR_CELL = " "

protocol cell separator

Definition at line 97 of file TeamSpeak3.php.

◆ SEPARATOR_LINE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SEPARATOR_LINE = "\n"

protocol line separator

Definition at line 95 of file TeamSpeak3.php.

◆ SEPARATOR_LIST

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SEPARATOR_LIST = "|"

protocol list separator

Definition at line 96 of file TeamSpeak3.php.

◆ SEPARATOR_PAIR

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SEPARATOR_PAIR = "="

protocol pair separator

Definition at line 98 of file TeamSpeak3.php.

◆ SNAPSHOT_BASE64

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SNAPSHOT_BASE64 = 0x01

1: base64 string

Definition at line 252 of file TeamSpeak3.php.

◆ SNAPSHOT_HEXDEC

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SNAPSHOT_HEXDEC = 0x02

2: hexadecimal string

Definition at line 253 of file TeamSpeak3.php.

◆ SNAPSHOT_STRING

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SNAPSHOT_STRING = 0x00

0: default string

Definition at line 251 of file TeamSpeak3.php.

◆ SPACER_ALIGN_CENTER

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SPACER_ALIGN_CENTER = 0x02

2: alignment center

Definition at line 270 of file TeamSpeak3.php.

◆ SPACER_ALIGN_LEFT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SPACER_ALIGN_LEFT = 0x00

0: alignment left

Definition at line 268 of file TeamSpeak3.php.

◆ SPACER_ALIGN_REPEAT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SPACER_ALIGN_REPEAT = 0x03

3: repeat until the whole line is filled

Definition at line 271 of file TeamSpeak3.php.

◆ SPACER_ALIGN_RIGHT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SPACER_ALIGN_RIGHT = 0x01

1: alignment right

Definition at line 269 of file TeamSpeak3.php.

◆ SPACER_CUSTOM

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SPACER_CUSTOM = 0x05

5: custom format

Definition at line 263 of file TeamSpeak3.php.

◆ SPACER_DASHDOTDOTLINE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SPACER_DASHDOTDOTLINE = 0x04

4: dash dot dot line

Definition at line 262 of file TeamSpeak3.php.

◆ SPACER_DASHDOTLINE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SPACER_DASHDOTLINE = 0x03

3: dash dot line

Definition at line 261 of file TeamSpeak3.php.

◆ SPACER_DASHLINE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SPACER_DASHLINE = 0x01

1: dash line

Definition at line 259 of file TeamSpeak3.php.

◆ SPACER_DOTLINE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SPACER_DOTLINE = 0x02

2: dot line

Definition at line 260 of file TeamSpeak3.php.

◆ SPACER_SOLIDLINE

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::SPACER_SOLIDLINE = 0x00

0: solid line

Definition at line 258 of file TeamSpeak3.php.

◆ TEA_MOTD_PREFIX

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::TEA_MOTD_PREFIX = "Welcome"

TeaSpeak protocol greeting message prefix.

Definition at line 70 of file TeamSpeak3.php.

◆ TEA_PROTO_IDENT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::TEA_PROTO_IDENT = "TeaSpeak"

TeaSpeak protocol welcome message.

Definition at line 65 of file TeamSpeak3.php.

◆ TEXTMSG_CHANNEL

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::TEXTMSG_CHANNEL = 0x02

2: target is a channel

Definition at line 150 of file TeamSpeak3.php.

◆ TEXTMSG_CLIENT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::TEXTMSG_CLIENT = 0x01

1: target is a client

Definition at line 149 of file TeamSpeak3.php.

◆ TEXTMSG_SERVER

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::TEXTMSG_SERVER = 0x03

3: target is a virtual server

Definition at line 151 of file TeamSpeak3.php.

◆ TOKEN_CHANNELGROUP

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::TOKEN_CHANNELGROUP = 0x01

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

Definition at line 121 of file TeamSpeak3.php.

◆ TOKEN_SERVERGROUP

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::TOKEN_SERVERGROUP = 0x00

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

Definition at line 120 of file TeamSpeak3.php.

◆ TS3_MOTD_PREFIX

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::TS3_MOTD_PREFIX = "Welcome"

TeamSpeak 3 protocol greeting message prefix.

Definition at line 60 of file TeamSpeak3.php.

◆ TS3_PROTO_IDENT

const PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3::TS3_PROTO_IDENT = "TS3"

TeamSpeak 3 protocol welcome message.

Definition at line 55 of file TeamSpeak3.php.

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