TeamSpeak 3 PHP Framework  1.1.23
Copyright © Planet TeamSpeak. All rights reserved.
 All Classes Namespaces Files Functions Variables Pages
Static Public Member Functions | Public Attributes | Static Protected Member Functions | Static Protected Attributes | List of all members
TeamSpeak3 Class Reference

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

Static Public Member Functions

static factory ($uri)
 Factory for TeamSpeak3_Adapter_Abstract classes. More...
 
static autoload ($class)
 spl_autoload() suitable implementation for supporting class autoloading. More...
 
static init ()
 Checks for required PHP features, enables autoloading and starts a default profiler. More...
 
static getEscapePatterns ()
 Returns an assoc array containing all escape patterns available on a TeamSpeak 3 Server. More...
 
static dump ($var, $echo=TRUE)
 Debug helper function. More...
 

Public Attributes

const READY = "TS3"
 TeamSpeak 3 protocol welcome message. More...
 
const GREET = "Welcome"
 TeamSpeak 3 protocol greeting message prefix. More...
 
const ERROR = "error"
 TeamSpeak 3 protocol error message prefix. More...
 
const EVENT = "notify"
 TeamSpeak 3 protocol event message prefix. More...
 
const SCHID = "selected"
 TeamSpeak 3 protocol server connection handler ID prefix. More...
 
const LIB_VERSION = "1.1.23"
 TeamSpeak 3 PHP Framework version. More...
 
const SEPARATOR_LINE = "\n"
 protocol line separator More...
 
const SEPARATOR_LIST = "|"
 protocol list separator More...
 
const SEPARATOR_CELL = " "
 protocol cell separator More...
 
const SEPARATOR_PAIR = "="
 protocol pair separator More...
 
const LOGLEVEL_CRITICAL = 0x00
 0: these messages stop the program More...
 
const LOGLEVEL_ERROR = 0x01
 1: everything that is really bad More...
 
const LOGLEVEL_WARNING = 0x02
 2: everything that might be bad More...
 
const LOGLEVEL_DEBUG = 0x03
 3: output that might help find a problem More...
 
const LOGLEVEL_INFO = 0x04
 4: informational output More...
 
const LOGLEVEL_DEVEL = 0x05
 5: development output More...
 
const TOKEN_SERVERGROUP = 0x00
 0: server group token (id1={groupID} id2=0) More...
 
const TOKEN_CHANNELGROUP = 0x01
 1: channel group token (id1={groupID} id2={channelID}) More...
 
const CODEC_SPEEX_NARROWBAND = 0x00
 0: speex narrowband (mono, 16bit, 8kHz) More...
 
const CODEC_SPEEX_WIDEBAND = 0x01
 1: speex wideband (mono, 16bit, 16kHz) More...
 
const CODEC_SPEEX_ULTRAWIDEBAND = 0x02
 2: speex ultra-wideband (mono, 16bit, 32kHz) More...
 
const CODEC_CELT_MONO = 0x03
 3: celt mono (mono, 16bit, 48kHz) More...
 
const CODEC_OPUS_VOICE = 0x04
 3: opus voice (interactive) More...
 
const CODEC_OPUS_MUSIC = 0x05
 3: opus music (interactive) More...
 
const CODEC_CRYPT_INDIVIDUAL = 0x00
 0: configure per channel More...
 
const CODEC_CRYPT_DISABLED = 0x01
 1: globally disabled More...
 
const CODEC_CRYPT_ENABLED = 0x02
 2: globally enabled More...
 
const KICK_CHANNEL = 0x04
 4: kick client from channel More...
 
const KICK_SERVER = 0x05
 5: kick client from server More...
 
const TEXTMSG_CLIENT = 0x01
 1: target is a client More...
 
const TEXTMSG_CHANNEL = 0x02
 2: target is a channel More...
 
const TEXTMSG_SERVER = 0x03
 3: target is a virtual server More...
 
const PLUGINCMD_CHANNEL = 0x01
 1: send plugincmd to all clients in current channel More...
 
const PLUGINCMD_SERVER = 0x02
 2: send plugincmd to all clients on server More...
 
const PLUGINCMD_CLIENT = 0x03
 3: send plugincmd to all given client ids More...
 
const PLUGINCMD_CHANNEL_SUBSCRIBED = 0x04
 4: send plugincmd to all subscribed clients in current channel More...
 
const HOSTMSG_NONE = 0x00
 0: display no message More...
 
const HOSTMSG_LOG = 0x01
 1: display message in chatlog More...
 
const HOSTMSG_MODAL = 0x02
 2: display message in modal dialog More...
 
const HOSTMSG_MODALQUIT = 0x03
 3: display message in modal dialog and close connection More...
 
const HOSTBANNER_NO_ADJUST = 0x00
 0: do not adjust More...
 
const HOSTBANNER_IGNORE_ASPECT = 0x01
 1: adjust but ignore aspect ratio More...
 
const HOSTBANNER_KEEP_ASPECT = 0x02
 2: adjust and keep aspect ratio More...
 
const CLIENT_TYPE_REGULAR = 0x00
 0: regular client More...
 
const CLIENT_TYPE_SERVERQUERY = 0x01
 1: query client More...
 
const GROUP_DBTYPE_TEMPLATE = 0x00
 0: template group (used for new virtual servers) More...
 
const GROUP_DBTYPE_REGULAR = 0x01
 1: regular group (used for regular clients) More...
 
const GROUP_DBTYPE_SERVERQUERY = 0x02
 2: global query group (used for ServerQuery clients) More...
 
const GROUP_NAMEMODE_HIDDEN = 0x00
 0: display no name More...
 
const GROUP_NAMEMODE_BEFORE = 0x01
 1: display name before client nickname More...
 
const GROUP_NAMEMODE_BEHIND = 0x02
 2: display name after client nickname More...
 
const GROUP_IDENTIFIY_STRONGEST = 0x01
 1: identify most powerful group More...
 
const GROUP_IDENTIFIY_WEAKEST = 0x02
 2: identify weakest group More...
 
const PERM_TYPE_SERVERGROUP = 0x00
 0: server group permission More...
 
const PERM_TYPE_CLIENT = 0x01
 1: client specific permission More...
 
const PERM_TYPE_CHANNEL = 0x02
 2: channel specific permission More...
 
const PERM_TYPE_CHANNELGROUP = 0x03
 3: channel group permission More...
 
const PERM_TYPE_CHANNELCLIENT = 0x04
 4: channel-client specific permission More...
 
const PERM_CAT_GLOBAL = 0x10
 00010000: global permissions More...
 
const PERM_CAT_GLOBAL_INFORMATION = 0x11
 00010001: global permissions -> global information More...
 
const PERM_CAT_GLOBAL_SERVER_MGMT = 0x12
 00010010: global permissions -> virtual server management More...
 
const PERM_CAT_GLOBAL_ADM_ACTIONS = 0x13
 00010011: global permissions -> global administrative actions More...
 
const PERM_CAT_GLOBAL_SETTINGS = 0x14
 00010100: global permissions -> global settings More...
 
const PERM_CAT_SERVER = 0x20
 00100000: virtual server permissions More...
 
const PERM_CAT_SERVER_INFORMATION = 0x21
 00100001: virtual server permissions -> virtual server information More...
 
const PERM_CAT_SERVER_ADM_ACTIONS = 0x22
 00100010: virtual server permissions -> virtual server administrative actions More...
 
const PERM_CAT_SERVER_SETTINGS = 0x23
 00100011: virtual server permissions -> virtual server settings More...
 
const PERM_CAT_CHANNEL = 0x30
 00110000: channel permissions More...
 
const PERM_CAT_CHANNEL_INFORMATION = 0x31
 00110001: channel permissions -> channel information More...
 
const PERM_CAT_CHANNEL_CREATE = 0x32
 00110010: channel permissions -> create channels More...
 
const PERM_CAT_CHANNEL_MODIFY = 0x33
 00110011: channel permissions -> edit channels More...
 
const PERM_CAT_CHANNEL_DELETE = 0x34
 00110100: channel permissions -> delete channels More...
 
const PERM_CAT_CHANNEL_ACCESS = 0x35
 00110101: channel permissions -> access channels More...
 
const PERM_CAT_GROUP = 0x40
 01000000: group permissions More...
 
const PERM_CAT_GROUP_INFORMATION = 0x41
 01000001: group permissions -> group information More...
 
const PERM_CAT_GROUP_CREATE = 0x42
 01000010: group permissions -> create groups More...
 
const PERM_CAT_GROUP_MODIFY = 0x43
 01000011: group permissions -> edit groups More...
 
const PERM_CAT_GROUP_DELETE = 0x44
 01000100: group permissions -> delete groups More...
 
const PERM_CAT_CLIENT = 0x50
 01010000: client permissions More...
 
const PERM_CAT_CLIENT_INFORMATION = 0x51
 01010001: client permissions -> client information More...
 
const PERM_CAT_CLIENT_ADM_ACTIONS = 0x52
 01010010: client permissions -> client administrative actions More...
 
const PERM_CAT_CLIENT_BASICS = 0x53
 01010011: client permissions -> client basic communication More...
 
const PERM_CAT_CLIENT_MODIFY = 0x54
 01010100: client permissions -> edit clients More...
 
const PERM_CAT_FILETRANSFER = 0x60
 01100000: file transfer permissions More...
 
const PERM_CAT_NEEDED_MODIFY_POWER = 0xFF
 11111111: needed permission modify power (grant) permissions More...
 
const FILE_TYPE_DIRECTORY = 0x00
 0: file is directory More...
 
const FILE_TYPE_REGULAR = 0x01
 1: file is regular More...
 
const SNAPSHOT_STRING = 0x00
 0: default string More...
 
const SNAPSHOT_BASE64 = 0x01
 1: base64 string More...
 
const SNAPSHOT_HEXDEC = 0x02
 2: hexadecimal string More...
 
const SPACER_SOLIDLINE = 0x00
 0: solid line More...
 
const SPACER_DASHLINE = 0x01
 1: dash line More...
 
const SPACER_DOTLINE = 0x02
 2: dot line More...
 
const SPACER_DASHDOTLINE = 0x03
 3: dash dot line More...
 
const SPACER_DASHDOTDOTLINE = 0x04
 4: dash dot dot line More...
 
const SPACER_CUSTOM = 0x05
 5: custom format More...
 
const SPACER_ALIGN_LEFT = 0x00
 0: alignment left More...
 
const SPACER_ALIGN_RIGHT = 0x01
 1: alignment right More...
 
const SPACER_ALIGN_CENTER = 0x02
 2: alignment center More...
 
const SPACER_ALIGN_REPEAT = 0x03
 3: repeat until the whole line is filled More...
 
const REASON_NONE = 0x00
 0: no reason More...
 
const REASON_MOVE = 0x01
 1: channel switched or moved More...
 
const REASON_SUBSCRIPTION = 0x02
 2: subscription added or removed More...
 
const REASON_TIMEOUT = 0x03
 3: client connection timed out More...
 
const REASON_CHANNEL_KICK = 0x04
 4: client kicked from channel More...
 
const REASON_SERVER_KICK = 0x05
 5: client kicked from server More...
 
const REASON_SERVER_BAN = 0x06
 6: client banned from server More...
 
const REASON_SERVER_STOP = 0x07
 7: server stopped More...
 
const REASON_DISCONNECT = 0x08
 8: client disconnected More...
 
const REASON_CHANNEL_UPDATE = 0x09
 9: channel information updated More...
 
const REASON_CHANNEL_EDIT = 0x0A
 10: channel information edited More...
 
const REASON_DISCONNECT_SHUTDOWN = 0x0B
 11: client disconnected on server shutdown More...
 

Static Protected Member Functions

static loadClass ($class)
 Loads a class from a PHP file. More...
 
static getFilePath ($name)
 Generates a possible file path for $name. More...
 
static getAdapterName ($name, $namespace="TeamSpeak3_Adapter_")
 Returns the name of an adapter class by $name. More...
 

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 309 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().

310  {
311  self::init();
312 
313  $uri = new TeamSpeak3_Helper_Uri($uri);
314 
315  $adapter = self::getAdapterName($uri->getScheme());
316  $options = array("host" => $uri->getHost(), "port" => $uri->getPort(), "timeout" => intval($uri->getQueryVar("timeout", 10)), "blocking" => intval($uri->getQueryVar("blocking", 1)));
317 
318  self::loadClass($adapter);
319 
320  $object = new $adapter($options);
321 
322  if($object instanceof TeamSpeak3_Adapter_ServerQuery)
323  {
324  $node = $object->getHost();
325 
326  if($uri->hasUser() && $uri->hasPass())
327  {
328  $node->login($uri->getUser(), $uri->getPass());
329  }
330 
331  /* option to pre-define nickname */
332  if($uri->hasQueryVar("nickname"))
333  {
334  $node->setPredefinedQueryName($uri->getQueryVar("nickname"));
335  }
336 
337  /* flag to use offline servers in virtual mode */
338  if($uri->getFragment() == "use_offline_as_virtual")
339  {
340  $node->setUseOfflineAsVirtual(TRUE);
341  }
342  elseif($uri->hasQueryVar("use_offline_as_virtual"))
343  {
344  $node->setUseOfflineAsVirtual($uri->getQueryVar("use_offline_as_virtual") ? TRUE : FALSE);
345  }
346 
347  /* flag to fetch clients before sub-channels */
348  if($uri->getFragment() == "clients_before_channels")
349  {
350  $node->setLoadClientlistFirst(TRUE);
351  }
352  elseif($uri->hasQueryVar("clients_before_channels"))
353  {
354  $node->setLoadClientlistFirst($uri->getQueryVar("clients_before_channels") ? TRUE : FALSE);
355  }
356 
357  /* flag to hide ServerQuery clients */
358  if($uri->getFragment() == "no_query_clients")
359  {
360  $node->setExcludeQueryClients(TRUE);
361  }
362  elseif($uri->hasQueryVar("no_query_clients"))
363  {
364  $node->setExcludeQueryClients($uri->getQueryVar("no_query_clients") ? TRUE : FALSE);
365  }
366 
367  /* access server node object */
368  if($uri->hasQueryVar("server_id"))
369  {
370  $node = $node->serverGetById($uri->getQueryVar("server_id"));
371  }
372  elseif($uri->hasQueryVar("server_uid"))
373  {
374  $node = $node->serverGetByUid($uri->getQueryVar("server_uid"));
375  }
376  elseif($uri->hasQueryVar("server_port"))
377  {
378  $node = $node->serverGetByPort($uri->getQueryVar("server_port"));
379  }
380  elseif($uri->hasQueryVar("server_name"))
381  {
382  $node = $node->serverGetByName($uri->getQueryVar("server_name"));
383  }
384  elseif($uri->hasQueryVar("server_tsdns"))
385  {
386  $node = $node->serverGetByTSDNS($uri->getQueryVar("server_tsdns"));
387  }
388 
389  /* direct access to node objects */
390  if($node instanceof TeamSpeak3_Node_Server)
391  {
392  /* access channel node object */
393  if($uri->hasQueryVar("channel_id"))
394  {
395  $node = $node->channelGetById($uri->getQueryVar("channel_id"));
396  }
397  elseif($uri->hasQueryVar("channel_name"))
398  {
399  $node = $node->channelGetByName($uri->getQueryVar("channel_name"));
400  }
401 
402  /* access client node object */
403  if($uri->hasQueryVar("client_id"))
404  {
405  $node = $node->clientGetById($uri->getQueryVar("client_id"));
406  }
407  if($uri->hasQueryVar("client_uid"))
408  {
409  $node = $node->clientGetByUid($uri->getQueryVar("client_uid"));
410  }
411  elseif($uri->hasQueryVar("client_name"))
412  {
413  $node = $node->clientGetByName($uri->getQueryVar("client_name"));
414  }
415  }
416 
417  return $node;
418  }
419 
420  return $object;
421  }
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 433 of file TeamSpeak3.php.

434  {
435  if(class_exists($class, FALSE) || interface_exists($class, FALSE))
436  {
437  return;
438  }
439 
440  if(preg_match("/[^a-z0-9\\/\\\\_.-]/i", $class))
441  {
442  throw new LogicException("illegal characters in classname '" . $class . "'");
443  }
444 
445  $file = self::getFilePath($class) . ".php";
446 
447  if(!file_exists($file) || !is_readable($file))
448  {
449  throw new LogicException("file '" . $file . "' does not exist or is not readable");
450  }
451 
452  if(class_exists($class, FALSE) || interface_exists($class, FALSE))
453  {
454  throw new LogicException("class '" . $class . "' does not exist");
455  }
456 
457  return include_once($file);
458  }
static TeamSpeak3::getFilePath (   $name)
staticprotected

Generates a possible file path for $name.

Parameters
string$name
Returns
string

Definition at line 466 of file TeamSpeak3.php.

467  {
468  $path = str_replace("_", DIRECTORY_SEPARATOR, $name);
469  $path = str_replace(__CLASS__, dirname(__FILE__), $path);
470 
471  return $path;
472  }
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 482 of file TeamSpeak3.php.

References TeamSpeak3_Helper_String\factory().

483  {
484  $path = self::getFilePath($namespace);
485  $scan = scandir($path);
486 
487  foreach($scan as $node)
488  {
489  $file = TeamSpeak3_Helper_String::factory($node)->toLower();
490 
491  if($file->startsWith($name) && $file->endsWith(".php"))
492  {
493  return $namespace . str_replace(".php", "", $node);
494  }
495  }
496 
497  throw new TeamSpeak3_Adapter_Exception("adapter '" . $name . "' does not exist");
498  }
static TeamSpeak3::autoload (   $class)
static

spl_autoload() suitable implementation for supporting class autoloading.

Parameters
string$class
Returns
boolean

Definition at line 506 of file TeamSpeak3.php.

507  {
508  if(substr($class, 0, strlen(__CLASS__)) != __CLASS__) return;
509 
510  try
511  {
512  self::loadClass($class);
513 
514  return TRUE;
515  }
516  catch(Exception $e)
517  {
518  return FALSE;
519  }
520  }
static TeamSpeak3::init ( )
static

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

Exceptions
LogicException
Returns
void

Definition at line 528 of file TeamSpeak3.php.

References TeamSpeak3_Helper_Profiler\start().

529  {
530  if(version_compare(phpversion(), "5.2.1") == -1)
531  {
532  throw new LogicException("this particular software cannot be used with the installed version of PHP");
533  }
534 
535  if(!function_exists("stream_socket_client"))
536  {
537  throw new LogicException("network functions are not available in this PHP installation");
538  }
539 
540  if(!function_exists("spl_autoload_register"))
541  {
542  throw new LogicException("autoload functions are not available in this PHP installation");
543  }
544 
545  if(!class_exists("TeamSpeak3_Helper_Profiler"))
546  {
547  spl_autoload_register(array(__CLASS__, "autoload"));
548  }
549 
550  TeamSpeak3_Helper_Profiler::start();
551  }
static TeamSpeak3::getEscapePatterns ( )
static

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

Returns
array

Definition at line 559 of file TeamSpeak3.php.

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

560  {
561  return self::$escape_patterns;
562  }
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 572 of file TeamSpeak3.php.

573  {
574  ob_start();
575  var_dump($var);
576 
577  $output = ob_get_clean();
578  $output = preg_replace("/\]\=>\n(\s+)/m", "] => ", $output);
579 
580  if(PHP_SAPI == "cli")
581  {
582  $output = PHP_EOL . PHP_EOL . $output . PHP_EOL;
583  }
584  else
585  {
586  $output = "<pre>" . htmlspecialchars($output, ENT_QUOTES) . "</pre>";
587  }
588 
589  if($echo) echo($output);
590 
591  return $output;
592  }

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.23"

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_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(), and TeamSpeak3_Viewer_Html\getSuffixIconChannel().

const TeamSpeak3::CODEC_OPUS_VOICE = 0x04

3: opus voice (interactive)

Definition at line 95 of file TeamSpeak3.php.

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

const TeamSpeak3::CODEC_OPUS_MUSIC = 0x05

3: opus music (interactive)

Definition at line 96 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\codec(), and TeamSpeak3_Viewer_Html\getSuffixIconChannel().

const TeamSpeak3::CODEC_CRYPT_INDIVIDUAL = 0x00

0: configure per channel

Definition at line 101 of file TeamSpeak3.php.

const TeamSpeak3::CODEC_CRYPT_DISABLED = 0x01

1: globally disabled

Definition at line 102 of file TeamSpeak3.php.

const TeamSpeak3::CODEC_CRYPT_ENABLED = 0x02

2: globally enabled

Definition at line 103 of file TeamSpeak3.php.

const TeamSpeak3::KICK_CHANNEL = 0x04

4: kick client from channel

Definition at line 108 of file TeamSpeak3.php.

const TeamSpeak3::KICK_SERVER = 0x05

5: kick client from server

Definition at line 109 of file TeamSpeak3.php.

const TeamSpeak3::TEXTMSG_CLIENT = 0x01

1: target is a client

Definition at line 114 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 115 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Channel\message().

const TeamSpeak3::TEXTMSG_SERVER = 0x03

3: target is a virtual server

Definition at line 116 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\message().

const TeamSpeak3::PLUGINCMD_CHANNEL = 0x01

1: send plugincmd to all clients in current channel

Definition at line 121 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Channel\sendPluginCmd().

const TeamSpeak3::PLUGINCMD_SERVER = 0x02

2: send plugincmd to all clients on server

Definition at line 122 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\sendPluginCmd().

const TeamSpeak3::PLUGINCMD_CLIENT = 0x03

3: send plugincmd to all given client ids

Definition at line 123 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Client\sendPluginCmd().

const TeamSpeak3::PLUGINCMD_CHANNEL_SUBSCRIBED = 0x04

4: send plugincmd to all subscribed clients in current channel

Definition at line 124 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Channel\sendPluginCmd().

const TeamSpeak3::HOSTMSG_NONE = 0x00

0: display no message

Definition at line 129 of file TeamSpeak3.php.

const TeamSpeak3::HOSTMSG_LOG = 0x01

1: display message in chatlog

Definition at line 130 of file TeamSpeak3.php.

const TeamSpeak3::HOSTMSG_MODAL = 0x02

2: display message in modal dialog

Definition at line 131 of file TeamSpeak3.php.

const TeamSpeak3::HOSTMSG_MODALQUIT = 0x03

3: display message in modal dialog and close connection

Definition at line 132 of file TeamSpeak3.php.

const TeamSpeak3::HOSTBANNER_NO_ADJUST = 0x00

0: do not adjust

Definition at line 137 of file TeamSpeak3.php.

const TeamSpeak3::HOSTBANNER_IGNORE_ASPECT = 0x01

1: adjust but ignore aspect ratio

Definition at line 138 of file TeamSpeak3.php.

const TeamSpeak3::HOSTBANNER_KEEP_ASPECT = 0x02

2: adjust and keep aspect ratio

Definition at line 139 of file TeamSpeak3.php.

const TeamSpeak3::CLIENT_TYPE_REGULAR = 0x00

0: regular client

Definition at line 144 of file TeamSpeak3.php.

const TeamSpeak3::CLIENT_TYPE_SERVERQUERY = 0x01

1: query client

Definition at line 145 of file TeamSpeak3.php.

const TeamSpeak3::GROUP_DBTYPE_TEMPLATE = 0x00

0: template group (used for new virtual servers)

Definition at line 150 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 151 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 152 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\groupType().

const TeamSpeak3::GROUP_NAMEMODE_HIDDEN = 0x00

0: display no name

Definition at line 157 of file TeamSpeak3.php.

const TeamSpeak3::GROUP_NAMEMODE_BEFORE = 0x01

1: display name before client nickname

Definition at line 158 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 159 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Viewer_Html\getCorpusName().

const TeamSpeak3::GROUP_IDENTIFIY_STRONGEST = 0x01

1: identify most powerful group

Definition at line 164 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\serverGroupIdentify().

const TeamSpeak3::GROUP_IDENTIFIY_WEAKEST = 0x02

2: identify weakest group

Definition at line 165 of file TeamSpeak3.php.

const TeamSpeak3::PERM_TYPE_SERVERGROUP = 0x00

0: server group permission

Definition at line 170 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 171 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 172 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 173 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 174 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 179 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 180 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 181 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 182 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 183 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_SERVER = 0x20

00100000: virtual server permissions

Definition at line 184 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 185 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 186 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 187 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_CHANNEL = 0x30

00110000: channel permissions

Definition at line 188 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 189 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 190 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 191 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 192 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 193 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_GROUP = 0x40

01000000: group permissions

Definition at line 194 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 195 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 196 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 197 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 198 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_CLIENT = 0x50

01010000: client permissions

Definition at line 199 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 200 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 201 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 202 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 203 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::PERM_CAT_FILETRANSFER = 0x60

01100000: file transfer permissions

Definition at line 204 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 205 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Helper_Convert\permissionCategory().

const TeamSpeak3::FILE_TYPE_DIRECTORY = 0x00

0: file is directory

Definition at line 210 of file TeamSpeak3.php.

Referenced by TeamSpeak3_Node_Server\channelFileList().

const TeamSpeak3::FILE_TYPE_REGULAR = 0x01

1: file is regular

Definition at line 211 of file TeamSpeak3.php.

const TeamSpeak3::SNAPSHOT_STRING = 0x00

0: default string

Definition at line 216 of file TeamSpeak3.php.

const TeamSpeak3::SNAPSHOT_BASE64 = 0x01

1: base64 string

Definition at line 217 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 218 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 223 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 224 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 225 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 226 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 227 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 228 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 233 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 234 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 235 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 236 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 241 of file TeamSpeak3.php.

const TeamSpeak3::REASON_MOVE = 0x01

1: channel switched or moved

Definition at line 242 of file TeamSpeak3.php.

const TeamSpeak3::REASON_SUBSCRIPTION = 0x02

2: subscription added or removed

Definition at line 243 of file TeamSpeak3.php.

const TeamSpeak3::REASON_TIMEOUT = 0x03

3: client connection timed out

Definition at line 244 of file TeamSpeak3.php.

const TeamSpeak3::REASON_CHANNEL_KICK = 0x04

4: client kicked from channel

Definition at line 245 of file TeamSpeak3.php.

const TeamSpeak3::REASON_SERVER_KICK = 0x05

5: client kicked from server

Definition at line 246 of file TeamSpeak3.php.

const TeamSpeak3::REASON_SERVER_BAN = 0x06

6: client banned from server

Definition at line 247 of file TeamSpeak3.php.

const TeamSpeak3::REASON_SERVER_STOP = 0x07

7: server stopped

Definition at line 248 of file TeamSpeak3.php.

const TeamSpeak3::REASON_DISCONNECT = 0x08

8: client disconnected

Definition at line 249 of file TeamSpeak3.php.

const TeamSpeak3::REASON_CHANNEL_UPDATE = 0x09

9: channel information updated

Definition at line 250 of file TeamSpeak3.php.

const TeamSpeak3::REASON_CHANNEL_EDIT = 0x0A

10: channel information edited

Definition at line 251 of file TeamSpeak3.php.

const TeamSpeak3::REASON_DISCONNECT_SHUTDOWN = 0x0B

11: client disconnected on server shutdown

Definition at line 252 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 260 of file TeamSpeak3.php.

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