TeamSpeak3_Node_Host Class Reference

Class describing a TeamSpeak 3 server instance and all it's parameters. More...

Inheritance diagram for TeamSpeak3_Node_Host:

Public Member Functions
	__construct (TeamSpeak3_Adapter_ServerQuery $squery)
	The TeamSpeak3_Node_Host constructor. More...
	__toString ()
	Returns a string representation of this node. More...
	__wakeup ()
	Re-authenticates with the TeamSpeak 3 Server instance using given ServerQuery login credentials and re-selects a previously selected virtual server. More...
	bindingList ($subsystem="voice")
	Returns a list of IP addresses used by the server instance on multi-homed machines. More...
	getAdapter ()
	Returns the underlying TeamSpeak3_Adapter_ServerQuery object. More...
	getAdapterHost ()
	Returns the hostname or IPv4 address the adapter is connected to. More...
	getAdapterPort ()
	Returns the network port the adapter is connected to. More...
	getExcludeQueryClients ()
	Returns the option to decide whether ServerQuery clients should be excluded from node lists or not. More...
	getIcon ()
	Returns the name of a possible icon to display the node object. More...
	getLoadClientlistFirst ()
	Returns the option to decide whether offline servers will be started in virtual mode by default or not. More...
	getPredefinedQueryName ()
	Returns the pre-defined nickname for ServerQuery clients which will be used automatically after selecting a virtual server. More...
	getSymbol ()
	Returns a symbol representing the node. More...
	getUniqueId ()
	Returns a unique identifier for the node which can be used as a HTML property. More...
	getUseOfflineAsVirtual ()
	Returns the option to decide whether offline servers will be started in virtual mode by default or not. More...
	logAdd ($logmsg, $loglevel=TeamSpeak3::LOGLEVEL_INFO)
	Writes a custom entry into the server instance log. More...
	login ($username, $password)
	Authenticates with the TeamSpeak 3 Server instance using given ServerQuery login credentials. More...
	logout ()
	Deselects the active virtual server and logs out from the server instance. More...
	logView ($lines=30, $begin_pos=null, $reverse=null, $instance=TRUE)
	Displays a specified number of entries (1-100) from the servers log. More...
	message ($msg)
	Sends a text message to all clients on all virtual servers in the TeamSpeak 3 Server instance. More...
	modify (array $properties)
	Changes the server instance configuration using given properties. More...
	permissionCats ()
	Returns a list of permission categories available on the server instance. More...
	permissionEnds ()
	Returns a list of permission category endings available on the server instance. More...
	permissionFind ($permid)
	Returns the IDs of all clients, channels or groups using the permission with the specified ID. More...
	permissionGetCategoryById ($permid)
	Returns the internal category of the permission matching the given ID. More...
	permissionGetGrantById ($permid)
	Returns the internal ID of the i_needed_modify_power_* or grant permission. More...
	permissionGetIdByName ($name)
	Returns the ID of the permission matching the given name. More...
	permissionGetNameById ($permid)
	Returns the name of the permission matching the given ID. More...
	permissionList ()
	Returns a list of permissions available on the server instance. More...
	permissionTree ()
	Returns an array filled with all permission categories known to the server including their ID, name and parent. More...
	selfPermCheck ($permid)
	Returns an array containing the value of a specified permission for your own client. More...
	serverCreate (array $properties=array())
	Creates a new virtual server using given properties and returns an assoc array containing the new ID and initial admin token. More...
	serverDelete ($sid)
	Deletes the virtual server specified by ID. More...
	serverDeselect ()
	Deselects the active virtual server. More...
	serverGetById ($sid)
	Returns the TeamSpeak3_Node_Server object matching the given ID. More...
	serverGetByName ($name)
	Returns the first TeamSpeak3_Node_Server object matching the given name. More...
	serverGetByPort ($port)
	Returns the TeamSpeak3_Node_Server object matching the given port number. More...
	serverGetByUid ($uid)
	Returns the first TeamSpeak3_Node_Server object matching the given unique identifier. More...
	serverGetPortById ($sid)
	Returns the port of a virtual server matching the given ID. More...
	serverGetSelected ()
	Returns the TeamSpeak3_Node_Server object matching the currently selected ID. More...
	serverGroupPermAutoAssign ($sgtype, $permid, $permvalue, $permnegated=FALSE, $permskip=FALSE)
	Adds a set of specified permissions to all regular server groups on all virtual servers. More...
	serverGroupPermAutoRemove ($sgtype, $permid)
	Removes a set of specified permissions from all regular server groups on all virtual servers. More...
	serverIdGetByPort ($port)
	Returns the ID of a virtual server matching the given port. More...
	serverList (array $filter=array())
	Returns an array filled with TeamSpeak3_Node_Server objects. More...
	serverListReset ()
	Resets the list of virtual servers. More...
	serverSelect ($sid, $virtual =null)
	Selects a virtual server by ID to allow further interaction. More...
	serverSelectById ($sid, $virtual =null)
	Alias for serverSelect(). More...
	serverSelectByPort ($port, $virtual =null)
	Selects a virtual server by UDP port to allow further interaction. More...
	serverSelectedId ()
	Returns the primary ID of the selected virtual server. More...
	serverSelectedPort ()
	Returns the primary UDP port of the selected virtual server. More...
	serverStart ($sid)
	Starts the virtual server specified by ID. More...
	serverStop ($sid)
	Stops the virtual server specified by ID. More...
	serverStopProcess ()
	Stops the entire TeamSpeak 3 Server instance by shutting down the process. More...
	setExcludeQueryClients ($exclude=FALSE)
	Sets the option to decide whether ServerQuery clients should be excluded from node lists or not. More...
	setLoadClientlistFirst ($first=FALSE)
	Sets the option to decide whether clients should be sorted before sub-channels to support the new TeamSpeak 3 Client display mode or not. More...
	setPredefinedQueryName ($name=null)
	Sets a pre-defined nickname for ServerQuery clients which will be used automatically after selecting a virtual server. More...
	setUseOfflineAsVirtual ($virtual =FALSE)
	Sets the option to decide whether offline servers will be started in virtual mode by default or not. More...
	version ($ident=null)
	Returns the servers version information including platform and build number. More...
	whoami ()
	Returns information about your current ServerQuery connection. More...
	whoamiGet ($ident, $default=null)
	Returns a single value from the current ServerQuery connection info. More...
	whoamiReset ()
	Resets the current ServerQuery connection info. More...
	whoamiSet ($ident, $value=null)
	Sets a single value in the current ServerQuery connection info. More...
Public Member Functions inherited from TeamSpeak3_Node_Abstract
	__call ($name, array $args)
	Called whenever we're using an unknown method. More...
	__get ($offset)
	__set ($offset, $value)
	__sleep ()
	Commit pending data. More...
	__toString ()
	Returns a string representation of this node. More...
	count ()
	current ()
	execute ($cmd, array $params=array())
	Prepares and executes a ServerQuery command and returns the result. More...
	getChildren ()
	getClass ($prefix="ts3_")
	Returns a possible classname for the node which can be used as a HTML property. More...
	getIcon ()
	Returns the name of a possible icon to display the node object. More...
	getId ()
	Returns the primary ID of the current node. More...
	getInfo ($extend=TRUE, $convert=FALSE)
	Returns all information available on this node. More...
	getParent ()
	Returns the parent object of the current node. More...
	getProperty ($property, $default=null)
	Returns the specified property or a pre-defined default value from the node info array. More...
	getSymbol ()
	Returns a symbol representing the node. More...
	getUniqueId ()
	Returns a unique identifier for the node which can be used as a HTML property. More...
	getViewer (TeamSpeak3_Viewer_Interface $viewer)
	Returns the HTML code to display a TeamSpeak 3 viewer. More...
	hasChildren ()
	hasNext ()
	iconGetName ($key)
	Returns the internal path of the node icon. More...
	iconIsLocal ($key)
	Returns TRUE if the node icon has a local source. More...
	key ()
	next ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	prepare ($cmd, array $params=array())
	Uses given parameters and returns a prepared ServerQuery command. More...
	request ($cmd, $throw=TRUE)
	Sends a prepared command to the server and returns the result. More...
	rewind ()
	toArray ()
	Returns an assoc array filled with current node info properties. More...
	toString ()
	Returns a string representation of this node. More...
	valid ()

Protected Member Functions
	fetchNodeInfo ()
	fetchNodeList ()
	fetchPermissionCats ()
	fetchPermissionList ()
Protected Member Functions inherited from TeamSpeak3_Node_Abstract
	delStorage ($key)
	Deletes data from the internal storage array. More...
	fetchNodeInfo ()
	fetchNodeList ()
	filterList (array $nodes=array(), array $rules=array())
	Filters given node list array using specified filter rules. More...
	getStorage ($key, $default=null)
	Returns data from the internal storage array. More...
	resetNodeInfo ()
	resetNodeList ()
	setStorage ($key, $val)
	Writes data to the internal storage array. More...
	verifyNodeList ()

Protected Attributes
	$exclude_query_clients = FALSE
	$permissionCats = null
	$permissionEnds = null
	$permissionList = null
	$predefined_query_name = null
	$serverList = null
	$sort_clients_channels = FALSE
	$start_offline_virtual = FALSE
	$version = null
	$whoami = null
Protected Attributes inherited from TeamSpeak3_Node_Abstract
	$nodeId = 0x00
	$nodeInfo = array()
	$nodeList = null
	$parent = null
	$server = null
	$storage = array()

Detailed Description

Class describing a TeamSpeak 3 server instance and all it's parameters.

Constructor & Destructor Documentation

__construct()

__construct

(

TeamSpeak3_Adapter_ServerQuery

$squery

)

The TeamSpeak3_Node_Host constructor.

Parameters

TeamSpeak3_Adapter_ServerQuery

$squery

Returns

TeamSpeak3_Node_Host

  {
    $this->parent = $squery;
  }

Member Function Documentation

__toString()

__toString

(

)

Returns a string representation of this node.

Returns

string

  {
    return (string) $this->getAdapterHost();
  }

__wakeup()

__wakeup

(

)

Re-authenticates with the TeamSpeak 3 Server instance using given ServerQuery login credentials and re-selects a previously selected virtual server.

Returns

void

  {
    $username = $this->getStorage("_login_user");
    $password = $this->getStorage("_login_pass");

    if($username && $password)
    {
      $crypt = new TeamSpeak3_Helper_Crypt($username);

      $this->login($username, $crypt->decrypt($password));
    }

    $this->predefined_query_name = $this->getStorage("_query_nick");
    $this->exclude_query_clients = $this->getStorage("_query_hide", FALSE);
    $this->start_offline_virtual = $this->getStorage("_do_virtual", FALSE);
    $this->sort_clients_channels = $this->getStorage("_client_top", FALSE);

    if($server = $this->getStorage("_server_use"))
    {
      $func = array_shift($server);
      $args = array_shift($server);
      
      try
      {
        call_user_func_array(array($this, $func), $args);
      }
      catch(Exception $e)
      {
        $class = get_class($e);
        
        throw new $class($e->getMessage(), $e->getCode());
      }
    }
  }

bindingList()

bindingList

(

$subsystem = "voice"

)

Returns a list of IP addresses used by the server instance on multi-homed machines.

Returns

array

  {
    return $this->execute("bindinglist", array("subsystem" => $subsystem))->toArray();
  }

getAdapter()

getAdapter

(

)

Returns the underlying TeamSpeak3_Adapter_ServerQuery object.

Returns

TeamSpeak3_Adapter_ServerQuery

  {
    return $this->getParent();
  }

getAdapterHost()

getAdapterHost

(

)

Returns the hostname or IPv4 address the adapter is connected to.

Returns

string

  {
    return $this->getParent()->getTransportHost();
  }

getAdapterPort()

getAdapterPort

(

)

Returns the network port the adapter is connected to.

Returns

string

  {
    return $this->getParent()->getTransportPort();
  }

getExcludeQueryClients()

getExcludeQueryClients

(

)

Returns the option to decide whether ServerQuery clients should be excluded from node lists or not.

Returns

boolean

  {
    return $this->exclude_query_clients;
  }

getIcon()

getIcon

(

)

Returns the name of a possible icon to display the node object.

Returns

string

  {
    return "host";
  }

getLoadClientlistFirst()

getLoadClientlistFirst

(

)

Returns the option to decide whether offline servers will be started in virtual mode by default or not.

Returns

boolean

  {
    return $this->sort_clients_channels;
  }

getPredefinedQueryName()

getPredefinedQueryName

(

)

Returns the pre-defined nickname for ServerQuery clients which will be used automatically after selecting a virtual server.

Returns

string

  {
    return $this->predefined_query_name;
  }

getSymbol()

getSymbol

(

)

Returns a symbol representing the node.

Returns

string

  {
    return "+";
  }

getUniqueId()

getUniqueId

(

)

Returns a unique identifier for the node which can be used as a HTML property.

Returns

string

  {
    return "ts3_h";
  }

getUseOfflineAsVirtual()

getUseOfflineAsVirtual

(

)

Returns the option to decide whether offline servers will be started in virtual mode by default or not.

Returns

boolean

  {
    return $this->start_offline_virtual;
  }

logAdd()

logAdd	(		$logmsg,
			$loglevel = TeamSpeak3::LOGLEVEL_INFO
	)

Writes a custom entry into the server instance log.

Parameters

string	$logmsg
integer	$loglevel

Returns

void

  {
    $sid = $this->serverSelectedId();

    $this->serverDeselect();
    $this->execute("logadd", array("logmsg" => $logmsg, "loglevel" => $loglevel));
    $this->serverSelect($sid);
  }

login()

login	(		$username,
			$password
	)

Authenticates with the TeamSpeak 3 Server instance using given ServerQuery login credentials.

Parameters

string	$username
string	$password

Returns

void

  {
    $this->execute("login", array("client_login_name" => $username, "client_login_password" => $password));
    $this->whoamiReset();

    $crypt = new TeamSpeak3_Helper_Crypt($username);

    $this->setStorage("_login_user", $username);
    $this->setStorage("_login_pass", $crypt->encrypt($password));

    TeamSpeak3_Helper_Signal::getInstance()->emit("notifyLogin", $this);
  }

logout()

logout

(

)

Deselects the active virtual server and logs out from the server instance.

Returns

void

  {
    $this->request("logout");
    $this->whoamiReset();

    $this->delStorage("_login_user");
    $this->delStorage("_login_pass");

    TeamSpeak3_Helper_Signal::getInstance()->emit("notifyLogout", $this);
  }

logView()

logView	(		$lines = 30,
			$begin_pos = null,
			$reverse = null,
			$instance = TRUE
	)

Displays a specified number of entries (1-100) from the servers log.

Parameters

integer	$lines
integer	$begin_pos
boolean	$reverse
boolean	$instance

Returns

array

  {
    return $this->execute("logview", array("lines" => $lines, "begin_pos" => $begin_pos, "instance" => $instance, "reverse" => $reverse))->toArray();
  }

message()

message

(

$msg

)

Sends a text message to all clients on all virtual servers in the TeamSpeak 3 Server instance.

Parameters

string

$msg

Returns

void

  {
    $this->execute("gm", array("msg" => $msg));
  }

modify()

modify

(

array

$properties

)

Changes the server instance configuration using given properties.

Parameters

array

$properties

Returns

void

  {
    $this->execute("instanceedit", $properties);
    $this->resetNodeInfo();
  }

permissionCats()

permissionCats

(

)

Returns a list of permission categories available on the server instance.

Returns

array

  {
    if($this->permissionCats === null)
    {
      $this->fetchPermissionCats();
    }

    return $this->permissionCats;
  }

permissionEnds()

permissionEnds

(

)

Returns a list of permission category endings available on the server instance.

Returns

array

  {
    if($this->permissionEnds === null)
    {
      $this->fetchPermissionList();
    }

    return $this->permissionCats;
  }

permissionFind()

permissionFind

(

$permid

)

Returns the IDs of all clients, channels or groups using the permission with the specified ID.

Parameters

integer

$permid

Returns

array

  {
    if(!is_array($permid))
    {
      $permident = (is_numeric($permid)) ? "permid" : "permsid";
    }
    else
    {
      $permident = (is_numeric(current($permid))) ? "permid" : "permsid";
    }

    return $this->execute("permfind", array($permident => $permid))->toArray();
  }

permissionGetCategoryById()

permissionGetCategoryById

(

$permid

)

Returns the internal category of the permission matching the given ID.

All pre-3.0.7 permission IDs are are 2 bytes wide. The first byte identifies the category while the second byte is the permission count within that group.

Parameters

integer

$permid

Returns

integer

  {
    if(!is_numeric($permid))
    {
      $permid = $this->permissionGetIdByName($permid);
    }

    if($permid < 0x1000)
    {
      if($this->permissionEnds === null)
      {
        $this->fetchPermissionList();
      }

      if($this->permissionCats === null)
      {
        $this->fetchPermissionCats();
      }

      $catids = array_values($this->permissionCats());

      foreach($this->permissionEnds as $key => $val)
      {
        if($val >= $permid && isset($catids[$key]))
        {
          return $catids[$key];
        }
      }

      return 0;
    }
    else
    {
      return (int) $permid >> 8;
    }
  }

permissionGetGrantById()

permissionGetGrantById

(

$permid

)

Returns the internal ID of the i_needed_modify_power_* or grant permission.

Every permission has an associated i_needed_modify_power_* permission, for example b_client_ban_create has an associated permission called i_needed_modify_power_client_ban_create.

Parameters

integer

$permid

Returns

integer

  {
    if(!is_numeric($permid))
    {
      $permid = $this->permissionGetIdByName($permid);
    }

    if($permid < 0x1000)
    {
      return (int) $permid+0x8000;
    }
    else
    {
      return (int) bindec(substr(decbin($permid), -8))+0xFF00;
    }
  }

permissionGetIdByName()

permissionGetIdByName

(

$name

)

Returns the ID of the permission matching the given name.

Parameters

string

$name

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

integer

  {
    if(!array_key_exists((string) $name, $this->permissionList()))
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid permission ID", 0xA02);
    }

    return $this->permissionList[(string) $name]["permid"];
  }

permissionGetNameById()

permissionGetNameById

(

$permid

)

Returns the name of the permission matching the given ID.

Parameters

integer

$permid

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Helper_String

  {
    foreach($this->permissionList() as $name => $perm)
    {
      if($perm["permid"] == $permid) return new TeamSpeak3_Helper_String($name);
    }

    throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid permission ID", 0xA02);
  }

permissionList()

permissionList

(

)

Returns a list of permissions available on the server instance.

Returns

array

  {
    if($this->permissionList === null)
    {
      $this->fetchPermissionList();
    }

    foreach($this->permissionList as $permname => $permdata)
    {
      if(isset($permdata["permcatid"]) && $permdata["permgrant"])
      {
        continue;
      }

      $this->permissionList[$permname]["permcatid"] = $this->permissionGetCategoryById($permdata["permid"]);
      $this->permissionList[$permname]["permgrant"] = $this->permissionGetGrantById($permdata["permid"]);

      $grantsid = "i_needed_modify_power_" . substr($permname, 2);

      if(!$permdata["permname"]->startsWith("i_needed_modify_power_") && !isset($this->permissionList[$grantsid]))
      {
        $this->permissionList[$grantsid]["permid"]    = $this->permissionList[$permname]["permgrant"];
        $this->permissionList[$grantsid]["permname"]  = TeamSpeak3_Helper_String::factory($grantsid);
        $this->permissionList[$grantsid]["permdesc"]  = null;
        $this->permissionList[$grantsid]["permcatid"] = 0xFF;
        $this->permissionList[$grantsid]["permgrant"] = $this->permissionList[$permname]["permgrant"];
      }
    }

    return $this->permissionList;
  }

permissionTree()

permissionTree

(

)

Returns an array filled with all permission categories known to the server including their ID, name and parent.

Returns

array

  {
    $permtree = array();

    foreach($this->permissionCats() as $key => $val)
    {
      $permtree[$val]["permcatid"]      = $val;
      $permtree[$val]["permcathex"]     = "0x" . dechex($val);
      $permtree[$val]["permcatname"]    = TeamSpeak3_Helper_String::factory(TeamSpeak3_Helper_Convert::permissionCategory($val));
      $permtree[$val]["permcatparent"]  = $permtree[$val]["permcathex"]{3} == 0 ? 0 : hexdec($permtree[$val]["permcathex"]{2} . 0);
      $permtree[$val]["permcatchilren"] = 0;
      $permtree[$val]["permcatcount"]   = 0;

      if(isset($permtree[$permtree[$val]["permcatparent"]]))
      {
        $permtree[$permtree[$val]["permcatparent"]]["permcatchilren"]++;
      }

      if($permtree[$val]["permcatname"]->contains("/"))
      {
        $permtree[$val]["permcatname"] = $permtree[$val]["permcatname"]->section("/", 1)->trim();
      }

      foreach($this->permissionList() as $permission)
      {
        if($permission["permid"]["permcatid"] == $val)
        {
          $permtree[$val]["permcatcount"]++;
        }
      }
    }

    return $permtree;
  }

selfPermCheck()

selfPermCheck

(

$permid

)

Returns an array containing the value of a specified permission for your own client.

Parameters

integer

$permid

Returns

array

  {
    if(!is_array($permid))
    {
      $permident = (is_numeric($permid)) ? "permid" : "permsid";
    }
    else
    {
      $permident = (is_numeric(current($permid))) ? "permid" : "permsid";
    }

    return $this->execute("permget", array($permident => $permid))->toAssocArray("permsid");
  }

serverCreate()

serverCreate

(

array

$properties = array()

)

Creates a new virtual server using given properties and returns an assoc array containing the new ID and initial admin token.

Parameters

array

$properties

Returns

array

  {
    $this->serverListReset();

    $detail = $this->execute("servercreate", $properties)->toList();
    $server = new TeamSpeak3_Node_Server($this, array("virtualserver_id" => intval($detail["sid"])));

    TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServercreated", $this, $detail["sid"]);
    TeamSpeak3_Helper_Signal::getInstance()->emit("notifyTokencreated", $server, $detail["token"]);

    return $detail;
  }

serverDelete()

serverDelete

(

$sid

)

Deletes the virtual server specified by ID.

Parameters

integer

$sid

Returns

void

  {
    $this->serverListReset();

    $this->execute("serverdelete", array("sid" => $sid));

    TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServerdeleted", $this, $sid);
  }

serverDeselect()

serverDeselect

(

)

Deselects the active virtual server.

Returns

void

  {
    $this->serverSelect(0);

    $this->delStorage("_server_use");
  }

serverGetById()

serverGetById

(

$sid

)

Returns the TeamSpeak3_Node_Server object matching the given ID.

Parameters

integer

$sid

Returns

TeamSpeak3_Node_Server

  {
    $this->serverSelectById($sid);

    return new TeamSpeak3_Node_Server($this, array("virtualserver_id" => intval($sid)));
  }

serverGetByName()

serverGetByName

(

$name

)

Returns the first TeamSpeak3_Node_Server object matching the given name.

Parameters

string

$name

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Server

  {
    foreach($this->serverList() as $server)
    {
      if($server["virtualserver_name"] == $name) return $server;
    }

    throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid serverID", 0x400);
  }

serverGetByPort()

serverGetByPort

(

$port

)

Returns the TeamSpeak3_Node_Server object matching the given port number.

Parameters

integer

$port

Returns

TeamSpeak3_Node_Server

  {
    $this->serverSelectByPort($port);

    return new TeamSpeak3_Node_Server($this, array("virtualserver_id" => $this->serverSelectedId()));
  }

serverGetByUid()

serverGetByUid

(

$uid

)

Returns the first TeamSpeak3_Node_Server object matching the given unique identifier.

Parameters

string

$uid

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Server

  {
    foreach($this->serverList() as $server)
    {
      if($server["virtualserver_unique_identifier"] == $uid) return $server;
    }

    throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid serverID", 0x400);
  }

serverGetPortById()

serverGetPortById

(

$sid

)

Returns the port of a virtual server matching the given ID.

Parameters

integer

$sid

Returns

integer

  {
    if(!array_key_exists((string) $sid, $this->serverList()))
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid serverID", 0x400);
    }

    return $this->serverList[intval((string) $sid)]["virtualserver_port"];
  }

serverGetSelected()

serverGetSelected

(

)

Returns the TeamSpeak3_Node_Server object matching the currently selected ID.

Returns

TeamSpeak3_Node_Server

  {
    return $this->serverGetById($this->serverSelectedId());
  }

serverGroupPermAutoAssign()

serverGroupPermAutoAssign	(		$sgtype,
			$permid,
			$permvalue,
			$permnegated = FALSE,
			$permskip = FALSE
	)

Adds a set of specified permissions to all regular server groups on all virtual servers.

The target groups will be identified by the value of their i_group_auto_update_type permission specified with $sgtype.

Parameters

integer	$sgtype
integer	$permid
integer	$permvalue
integer	$permnegated
integer	$permskip

Returns

void

  {
    if(!is_array($permid))
    {
      $permident = (is_numeric($permid)) ? "permid" : "permsid";
    }
    else
    {
      $permident = (is_numeric(current($permid))) ? "permid" : "permsid";
    }

    $this->execute("servergroupautoaddperm", array("sgtype" => $sgtype, $permident => $permid, "permvalue" => $permvalue, "permnegated" => $permnegated, "permskip" => $permskip));
  }

serverGroupPermAutoRemove()

serverGroupPermAutoRemove	(		$sgtype,
			$permid
	)

Removes a set of specified permissions from all regular server groups on all virtual servers.

The target groups will be identified by the value of their i_group_auto_update_type permission specified with $sgtype.

Parameters

integer	$sgtype
integer	$permid

Returns

void

  {
    if(!is_array($permid))
    {
      $permident = (is_numeric($permid)) ? "permid" : "permsid";
    }
    else
    {
      $permident = (is_numeric(current($permid))) ? "permid" : "permsid";
    }

    $this->execute("servergroupautodelperm", array("sgtype" => $sgtype, $permident => $permid));
  }

serverIdGetByPort()

serverIdGetByPort

(

$port

)

Returns the ID of a virtual server matching the given port.

Parameters

integer

$port

Returns

integer

  {
    $sid = $this->execute("serveridgetbyport", array("virtualserver_port" => $port))->toList();

    return $sid["server_id"];
  }

serverList()

serverList

(

array

$filter = array()

)

Returns an array filled with TeamSpeak3_Node_Server objects.

Parameters

array

$filter

Returns

array

  {
    if($this->serverList === null)
    {
      $servers = $this->request("serverlist -uid")->toAssocArray("virtualserver_id");

      $this->serverList = array();

      foreach($servers as $sid => $server)
      {
        $this->serverList[$sid] = new TeamSpeak3_Node_Server($this, $server);
      }

      $this->resetNodeList();
    }

    return $this->filterList($this->serverList, $filter);
  }

serverListReset()

serverListReset

(

)

Resets the list of virtual servers.

Returns

void

  {
    $this->resetNodeList();
    $this->serverList = null;
  }

serverSelect()

serverSelect	(		$sid,
			$virtual = null
	)

Selects a virtual server by ID to allow further interaction.

Parameters

integer	$sid
boolean	$virtual

Returns

void

  {
    if($this->whoami !== null && $this->serverSelectedId() == $sid) return;

    $virtual = ($virtual !== null) ? $virtual : $this->start_offline_virtual;
    $getargs = func_get_args();

    $this->execute("use", array("sid" => $sid, $virtual ? "-virtual" : null));

    if($sid != 0 && $this->predefined_query_name !== null)
    {
      $this->execute("clientupdate", array("client_nickname" => (string) $this->predefined_query_name));
    }

    $this->whoamiReset();

    $this->setStorage("_server_use", array(__FUNCTION__, $getargs));

    TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServerselected", $this);
  }

serverSelectById()

serverSelectById	(		$sid,
			$virtual = null
	)

Alias for serverSelect().

Parameters

integer	$sid
boolean	$virtual

Returns

void

  {
    $this->serverSelect($sid, $virtual);
  }

serverSelectByPort()

serverSelectByPort	(		$port,
			$virtual = null
	)

Selects a virtual server by UDP port to allow further interaction.

Parameters

integer	$port
boolean	$virtual

Returns

void

  {
    if($this->whoami !== null && $this->serverSelectedPort() == $port) return;

    $virtual = ($virtual !== null) ? $virtual : $this->start_offline_virtual;
    $getargs = func_get_args();

    $this->execute("use", array("port" => $port, $virtual ? "-virtual" : null));

    if($port != 0 && $this->predefined_query_name !== null)
    {
      $this->execute("clientupdate", array("client_nickname" => (string) $this->predefined_query_name));
    }

    $this->whoamiReset();

    $this->setStorage("_server_use", array(__FUNCTION__, $getargs));

    TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServerselected", $this);
  }

serverSelectedId()

serverSelectedId

(

)

Returns the primary ID of the selected virtual server.

Returns

integer

  {
    return $this->whoamiGet("virtualserver_id", 0);
  }

serverSelectedPort()

serverSelectedPort

(

)

Returns the primary UDP port of the selected virtual server.

Returns

integer

  {
    return $this->whoamiGet("virtualserver_port", 0);
  }

serverStart()

serverStart

(

$sid

)

Starts the virtual server specified by ID.

Parameters

integer

$sid

Returns

void

  {
    if($sid == $this->serverSelectedId())
    {
      $this->serverDeselect();
    }

    $this->execute("serverstart", array("sid" => $sid));
    $this->serverListReset();

    TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServerstarted", $this, $sid);
  }

serverStop()

serverStop

(

$sid

)

Stops the virtual server specified by ID.

Parameters

integer

$sid

Returns

void

  {
    if($sid == $this->serverSelectedId())
    {
      $this->serverDeselect();
    }

    $this->execute("serverstop", array("sid" => $sid));
    $this->serverListReset();

    TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServerstopped", $this, $sid);
  }

serverStopProcess()

serverStopProcess

(

)

Stops the entire TeamSpeak 3 Server instance by shutting down the process.

Returns

void

  {
    TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServershutdown", $this);

    $this->execute("serverprocessstop");
  }

setExcludeQueryClients()

setExcludeQueryClients

(

$exclude = FALSE

)

Sets the option to decide whether ServerQuery clients should be excluded from node lists or not.

Parameters

boolean

$exclude

Returns

void

  {
    $this->setStorage("_query_hide", $exclude);

    $this->exclude_query_clients = $exclude;
  }

setLoadClientlistFirst()

setLoadClientlistFirst

(

$first = FALSE

)

Sets the option to decide whether clients should be sorted before sub-channels to support the new TeamSpeak 3 Client display mode or not.

Parameters

boolean

$first

Returns

void

  {
    $this->setStorage("_client_top", $first);

    $this->sort_clients_channels = $first;
  }

setPredefinedQueryName()

setPredefinedQueryName

(

$name = null

)

Sets a pre-defined nickname for ServerQuery clients which will be used automatically after selecting a virtual server.

Parameters

string

$name

Returns

void

  {
    $this->setStorage("_query_nick", $name);

    $this->predefined_query_name = $name;
  }

setUseOfflineAsVirtual()

setUseOfflineAsVirtual

(

$virtual = FALSE

)

Sets the option to decide whether offline servers will be started in virtual mode by default or not.

Parameters

boolean

$virtual

Returns

void

  {
    $this->setStorage("_do_virtual", $virtual);

    $this->start_offline_virtual = $virtual;
  }

version()

version

(

$ident = null

)

Returns the servers version information including platform and build number.

Parameters

string

$ident

Returns

mixed

  {
    if($this->version === null)
    {
      $this->version = $this->request("version")->toList();
    }

    return ($ident && isset($this->version[$ident])) ? $this->version[$ident] : $this->version;
  }

whoami()

whoami

(

)

Returns information about your current ServerQuery connection.

Returns

array

  {
    if($this->whoami === null)
    {
      $this->whoami = $this->request("whoami")->toList();
    }

    return $this->whoami;
  }

whoamiGet()

whoamiGet	(		$ident,
			$default = null
	)

Returns a single value from the current ServerQuery connection info.

Parameters

string	$ident
mixed	$default

Returns

mixed

  {
    if(array_key_exists($ident, $this->whoami()))
    {
      return $this->whoami[$ident];
    }

    return $default;
  }

whoamiReset()

whoamiReset

(

)

Resets the current ServerQuery connection info.

Returns

void

  {
    $this->whoami = null;
  }

whoamiSet()

whoamiSet	(		$ident,
			$value = null
	)

Sets a single value in the current ServerQuery connection info.

Parameters

string	$ident
mixed	$value

Returns

mixed

  {
    $this->whoami();

    $this->whoami[$ident] = (is_numeric($value)) ? (int) $value : TeamSpeak3_Helper_String::factory($value);
  }

---

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

• /Volumes/home/Repositories/planetteamspeak/ts3phpframework/libraries/TeamSpeak3/Node/Host.php