TeamSpeak3_Node_Server Class Reference

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

Inheritance diagram for TeamSpeak3_Node_Server:

Public Member Functions
	__construct (TeamSpeak3_Node_Host $host, array $info, $index="virtualserver_id")
	The TeamSpeak3_Node_Server constructor. More...
	__toString ()
	Returns a string representation of this node. More...
	banCreate (array $rules, $timeseconds=null, $reason=null)
	Adds a new ban rule on the selected virtual server. More...
	banDelete ($banid)
	Deletes the specified ban rule from the server. More...
	banList ()
	Returns a list of active bans on the selected virtual server. More...
	banListClear ()
	Deletes all active ban rules from the server. More...
	channelClientPermAssign ($cid, $cldbid, $permid, $permvalue)
	Adds a set of specified permissions to a client in a specific channel. More...
	channelClientPermList ($cid, $cldbid, $permsid=FALSE)
	Returns a list of permissions defined for a client in a specific channel. More...
	channelClientPermRemove ($cid, $cldbid, $permid)
	Removes a set of specified permissions from a client in a specific channel. More...
	channelCreate (array $properties)
	Creates a new channel using given properties and returns the new ID. More...
	channelDelete ($cid, $force=FALSE)
	Deletes the channel specified by $cid. More...
	channelDirCreate ($cid, $cpw="", $dirname="/")
	Creates new directory in a channels file repository. More...
	channelFileDelete ($cid, $cpw="", $name="/")
	Deletes one or more files stored in a channels file repository. More...
	channelFileInfo ($cid, $cpw="", $name="/")
	Returns detailed information about the specified file stored in a channels file repository. More...
	channelFileList ($cid, $cpw="", $path="/", $recursive=FALSE)
	Returns a list of files and directories stored in the specified channels file repository. More...
	channelFileRename ($cid, $cpw="", $oldname="/", $newname="/", $tcid=null, $tcpw=null)
	Renames a file in a channels file repository. More...
	channelGetById ($cid)
	Returns the TeamSpeak3_Node_Channel object matching the given ID. More...
	channelGetByName ($name)
	Returns the TeamSpeak3_Node_Channel object matching the given name. More...
	channelGetDefault ()
	Returns the TeamSpeak3_Node_Channel object representing the default channel. More...
	channelGetLevel ($cid)
	Returns the level of a channel. More...
	channelGetPathway ($cid)
	Returns the pathway of a channel which can be used as a clients default channel. More...
	channelGroupClientList ($cgid=null, $cid=null, $cldbid=null, $resolve=FALSE)
	Returns all the client and/or channel IDs currently assigned to channel groups. More...
	channelGroupCopy ($scgid, $name=null, $tcgid=0, $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	Creates a copy of an existing channel group specified by $scgid and returns the new groups ID. More...
	channelGroupCreate ($name, $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	Creates a new channel group using the name specified with $name and returns its ID. More...
	channelGroupDelete ($cgid, $force=FALSE)
	Deletes the channel group specified with $cgid. More...
	channelGroupGetById ($cgid)
	Returns the TeamSpeak3_Node_Channelgroup object matching the given ID. More...
	channelGroupGetByName ($name, $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	Returns the TeamSpeak3_Node_Channelgroup object matching the given name. More...
	channelGroupList (array $filter=array())
	Returns a list of channel groups available. More...
	channelGroupListReset ()
	Resets the list of channel groups. More...
	channelGroupPermAssign ($cgid, $permid, $permvalue)
	Adds a set of specified permissions to the channel group specified. More...
	channelGroupPermList ($cgid, $permsid=FALSE)
	Returns a list of permissions assigned to the channel group specified. More...
	channelGroupPermRemove ($cgid, $permid)
	Removes a set of specified permissions from the channel group specified with $cgid. More...
	channelGroupRename ($cgid, $name)
	Renames the channel group specified with $cgid. More...
	channelIsSpacer (TeamSpeak3_Node_Channel $channel)
	Returns TRUE if the given TeamSpeak3_Node_Channel object is a spacer. More...
	channelList (array $filter=array())
	Returns an array filled with TeamSpeak3_Node_Channel objects. More...
	channelListReset ()
	Resets the list of channels online. More...
	channelMove ($cid, $pid, $order=null)
	Moves the channel specified by $cid to the parent channel specified with $pid. More...
	channelPermAssign ($cid, $permid, $permvalue)
	Adds a set of specified permissions to a channel. More...
	channelPermList ($cid, $permsid=FALSE)
	Returns a list of permissions defined for a specific channel. More...
	channelPermRemove ($cid, $permid)
	Removes a set of specified permissions from a channel. More...
	channelSpacerCreate ($ident, $type=TeamSpeak3::SPACER_SOLIDLINE, $align=TeamSpeak3::SPACER_ALIGN_REPEAT, $order=null, $maxclients=0)
	Creates a new channel spacer and returns the new ID. More...
	channelSpacerGetAlign ($cid)
	Returns the possible alignment of a channel spacer. More...
	channelSpacerGetType ($cid)
	Returns the possible type of a channel spacer. More...
	clientBan ($clid, $timeseconds=null, $reason=null)
	Bans the client specified with ID $clid from the server. More...
	clientCount ()
	Returns the number of regular clients online. More...
	clientCountDb ()
	Returns the number of client identities known by the virtual server. More...
	clientDeleteDb ($cldbid)
	Deletes a clients properties from the database. More...
	clientFind ($pattern)
	Returns a list of clients matching a given name pattern. More...
	clientFindDb ($pattern, $uid=FALSE)
	Returns a list of client database IDs matching a given pattern. More...
	clientGetByDbid ($dbid)
	Returns the TeamSpeak3_Node_Client object matching the given database ID. More...
	clientGetById ($clid)
	Returns the TeamSpeak3_Node_Client object matching the given ID. More...
	clientGetByName ($name)
	Returns the TeamSpeak3_Node_Client object matching the given name. More...
	clientGetByUid ($uid)
	Returns the TeamSpeak3_Node_Client object matching the given unique identifier. More...
	clientGetIdsByUid ($cluid)
	Returns an array containing a list of active client connections using the unique identifier specified with $cluid. More...
	clientGetNameByDbid ($cldbid)
	Returns an array containing the last known nickname and the unique identifier of the client matching the database ID specified with $cldbid. More...
	clientGetNameByUid ($cluid)
	Returns an array containing the last known nickname and the database ID of the client matching the unique identifier specified with $cluid. More...
	clientGetServerGroupsByDbid ($cldbid)
	Returns an array containing the names and IDs of all server groups the client specified with $cldbid is is currently residing in. More...
	clientInfoDb ($cldbid)
	Returns a list of properties from the database for the client specified by $cldbid. More...
	clientKick ($clid, $reasonid=TeamSpeak3::KICK_CHANNEL, $reasonmsg=null)
	Kicks one or more clients from their currently joined channel or from the server. More...
	clientList (array $filter=array())
	Returns an array filled with TeamSpeak3_Node_Client objects. More...
	clientListDb ($offset=null, $limit=null)
	Returns a list of client identities known by the virtual server. More...
	clientListReset ()
	Resets the list of clients online. More...
	clientModifyDb ($cldbid, array $properties)
	Changes the clients properties using given properties. More...
	clientMove ($clid, $cid, $cpw=null)
	Moves a client to another channel. More...
	clientPermAssign ($cldbid, $permid, $permvalue, $permskip=FALSE)
	Adds a set of specified permissions to a client. More...
	clientPermList ($cldbid, $permsid=FALSE)
	Returns a list of permissions defined for a client. More...
	clientPermRemove ($cldbid, $permid)
	Removes a set of specified permissions from a client. More...
	clientPoke ($clid, $msg)
	Sends a poke message to a client. More...
	clientSetChannelGroup ($cldbid, $cid, $cgid)
	Sets the channel group of a client to the ID specified. More...
	complaintCreate ($tcldbid, $message)
	Submits a complaint about the client with database ID $tcldbid to the server. More...
	complaintDelete ($tcldbid, $fcldbid)
	Deletes the complaint about the client with ID $tcldbid submitted by the client with ID $fcldbid from the server. More...
	complaintList ($tcldbid=null)
	Returns a list of complaints on the selected virtual server. More...
	complaintListClear ($tcldbid)
	Deletes all active complaints about the client with database ID $tcldbid from the server. More...
	connectionInfo ()
	Returns detailed connection information of the virtual server. More...
	customInfo ($cldbid)
	Returns a list of custom properties for the client specified by $cldbid. More...
	customSearch ($ident, $pattern="%")
	Returns a list of custom client properties specified by $ident. More...
	delete ()
	Deletes the virtual server. More...
	getIcon ()
	Returns the name of a possible icon to display the node object. 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...
	iconDownload ()
	Downloads and returns the servers icon file content. More...
	iconUpload ($data)
	Uploads a given icon file content to the server and returns the ID of the icon. More...
	isOffline ()
	Returns TRUE if the virtual server is offline. More...
	isOnline ()
	Returns TRUE if the virtual server is online. More...
	logAdd ($logmsg, $loglevel=TeamSpeak3::LOGLEVEL_INFO)
	Writes a custom entry into the virtual server log. More...
	logView ($lines=30, $begin_pos=null, $reverse=null, $instance=null)
	Displays a specified number of entries (1-100) from the servers log. More...
	message ($msg)
	Sends a text message to all clients on the virtual server. More...
	messageCreate ($cluid, $subject, $message)
	Sends an offline message to the client specified by $cluid. More...
	messageDelete ($msgid)
	Deletes an existing offline message with ID $msgid from your inbox. More...
	messageList ()
	Returns a list of offline messages you've received. More...
	messageRead ($msgid, $flag_read=TRUE)
	Returns an existing offline message with ID $msgid from your inbox. More...
	modify (array $properties)
	Changes the virtual server configuration using given properties. More...
	notifyRegister ($event, $id=0)
	Registers for a specified category of events on a virtual server to receive notification messages. More...
	notifyUnregister ()
	Unregisters all events previously registered with servernotifyregister so you will no longer receive notification messages. More...
	permRemoveAny ($permid)
	Removes any assignment of the permission specified with $permid on the selected virtual server and returns the number of removed assignments on success. More...
	permReset ()
	Restores the default permission settings on the virtual server and returns a new initial administrator privilege key. More...
	privilegeKeyCreate ($type=TeamSpeak3::TOKEN_SERVERGROUP, $id1, $id2=0, $description=null, $customset=null)
	Creates a new privilege key (token) and returns the key. More...
	privilegeKeyDelete ($token)
	Deletes a token specified by key $token. More...
	privilegeKeyList ($resolve=FALSE)
	Returns a list of privilege keys (tokens) available. More...
	privilegeKeyUse ($token)
	Use a token key gain access to a server or channel group. More...
	request ($cmd, $throw=TRUE)
	Sends a prepared command to the server and returns the result. More...
	selfPermOverview ()
	Returns an array containing the permission overview of your own client. More...
	selfUpdate (array $properties)
	Changes the properties of your own client connection. More...
	selfUpdateLogin ($username)
	Updates your own ServerQuery login credentials using a specified username. More...
	sendPluginCmd ($plugin, $data)
	Sends a plugin command to all clients connected to the server. More...
	serverGroupClientAdd ($sgid, $cldbid)
	Adds a client to the server group specified. More...
	serverGroupClientDel ($sgid, $cldbid)
	Removes a client from the server group specified. More...
	serverGroupClientList ($sgid)
	Returns a list of clients assigned to the server group specified. More...
	serverGroupCopy ($ssgid, $name=null, $tsgid=0, $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	Creates a copy of an existing server group specified by $ssgid and returns the new groups ID. More...
	serverGroupCreate ($name, $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	Creates a new server group using the name specified with $name and returns its ID. More...
	serverGroupDelete ($sgid, $force=FALSE)
	Deletes the server group specified with $sgid. More...
	serverGroupGetById ($sgid)
	Returns the TeamSpeak3_Node_Servergroup object matching the given ID. More...
	serverGroupGetByName ($name, $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	Returns the TeamSpeak3_Node_Servergroup object matching the given name. More...
	serverGroupGetProfiles ($type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	Returns an ordered array of regular server groups available based on a pre-defined set of rules. More...
	serverGroupIdentify ($mode=TeamSpeak3::GROUP_IDENTIFIY_STRONGEST, $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	Tries to identify the post powerful/weakest server group on the virtual server and returns the ID. More...
	serverGroupList (array $filter=array())
	Returns a list of server groups available. More...
	serverGroupListReset ()
	Resets the list of server groups. More...
	serverGroupPermAssign ($sgid, $permid, $permvalue, $permnegated=FALSE, $permskip=FALSE)
	Adds a set of specified permissions to the server group specified. More...
	serverGroupPermList ($sgid, $permsid=FALSE)
	Returns a list of permissions assigned to the server group specified. More...
	serverGroupPermRemove ($sgid, $permid)
	Removes a set of specified permissions from the server group specified with $sgid. More...
	serverGroupRename ($sgid, $name)
	Renames the server group specified with $sgid. More...
	snapshotCreate ($mode=TeamSpeak3::SNAPSHOT_STRING)
	Creates and returns snapshot data for the selected virtual server. More...
	snapshotDeploy ($data, $mode=TeamSpeak3::SNAPSHOT_STRING)
	Deploys snapshot data on the selected virtual server. More...
	start ()
	Starts the virtual server. More...
	stop ()
	Stops the virtual server. More...
	tempPasswordCreate ($pw, $duration, $tcid=0, $tcpw="", $desc="")
	Sets a new temporary server password specified with $pw. More...
	tempPasswordDelete ($pw)
	Deletes the temporary server password specified with $pw. More...
	tempPasswordList ($resolve=FALSE)
	Returns a list of temporary server passwords. More...
	tokenCreate ($type=TeamSpeak3::TOKEN_SERVERGROUP, $id1, $id2=0, $description=null, $customset=null)
	Alias for privilegeKeyCreate(). More...
	tokenDelete ($token)
	Alias for privilegeKeyDelete(). More...
	tokenList ($translate=FALSE)
	Alias for privilegeKeyList(). More...
	tokenUse ($token)
	Alias for privilegeKeyUse(). More...
	transferInitDownload ($clientftfid, $cid, $name, $cpw="", $seekpos=0)
	Initializes a file transfer download. More...
	transferInitUpload ($clientftfid, $cid, $name, $size, $cpw="", $overwrite=FALSE, $resume=FALSE)
	Initializes a file transfer upload. More...
	transferList ()
	Displays a list of running file transfers on the selected virtual server. More...
	transferStop ($serverftfid, $delete=FALSE)
	Stops the running file transfer with server-side ID $serverftfid. 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 ()
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 ()

Static Protected Member Functions
static	sortClientList (TeamSpeak3_Node_Client $a, TeamSpeak3_Node_Client $b)
	Internal callback funtion for sorting of client objects. More...
static	sortFileList (array $a, array $b)
	Internal callback funtion for sorting of file list items. More...
static	sortGroupList (TeamSpeak3_Node_Abstract $a, TeamSpeak3_Node_Abstract $b)
	Internal callback funtion for sorting of group objects. More...

Protected Attributes
	$cgroupList = null
	$channelList = null
	$clientList = null
	$sgroupList = 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 virtual server and all it's parameters.

Constructor & Destructor Documentation

__construct()

__construct	(	TeamSpeak3_Node_Host	$host,
		array	$info,
			$index = "virtualserver_id"
	)

The TeamSpeak3_Node_Server constructor.

Parameters

TeamSpeak3_Node_Host	$host
array	$info
string	$index

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Server

  {
    $this->parent   = $host;
    $this->nodeInfo = $info;

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

    $this->nodeId = $this->nodeInfo[$index];
  }

Member Function Documentation

__toString()

__toString

(

)

Returns a string representation of this node.

Returns

string

  {
    return (string) $this["virtualserver_name"];
  }

banCreate()

banCreate	(	array	$rules,
			$timeseconds = null,
			$reason = null
	)

Adds a new ban rule on the selected virtual server.

All parameters are optional but at least one of the following rules must be set: ip, name, or uid.

Parameters

array	$rules
integer	$timeseconds
string	$reason

Returns

integer

  {
    $rules["time"] = $timeseconds;
    $rules["banreason"] = $reason;

    $banid = $this->execute("banadd", $rules)->toList();

    return $banid["banid"];
  }

banDelete()

banDelete

(

$banid

)

Deletes the specified ban rule from the server.

Parameters

integer

$banid

Returns

void

  {
    $this->execute("bandel", array("banid" => $banid));
  }

banList()

banList

(

)

Returns a list of active bans on the selected virtual server.

Returns

array

  {
    return $this->request("banlist")->toAssocArray("banid");
  }

banListClear()

banListClear

(

)

Deletes all active ban rules from the server.

Returns

void

  {
    $this->request("bandelall");
  }

channelClientPermAssign()

channelClientPermAssign	(		$cid,
			$cldbid,
			$permid,
			$permvalue
	)

Adds a set of specified permissions to a client in a specific channel.

Multiple permissions can be added by providing the two parameters of each permission.

Parameters

integer	$cid
integer	$cldbid
integer	$permid
integer	$permvalue

Returns

void

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

    $this->execute("channelclientaddperm", array("cid" => $cid, "cldbid" => $cldbid, $permident => $permid, "permvalue" => $permvalue));
  }

channelClientPermList()

channelClientPermList	(		$cid,
			$cldbid,
			$permsid = FALSE
	)

Returns a list of permissions defined for a client in a specific channel.

Parameters

integer	$cid
integer	$cldbid
boolean	$permsid

Returns

array

  {
    return $this->execute("channelclientpermlist", array("cid" => $cid, "cldbid" => $cldbid, $permsid ? "-permsid" : null))->toAssocArray($permsid ? "permsid" : "permid");
  }

channelClientPermRemove()

channelClientPermRemove	(		$cid,
			$cldbid,
			$permid
	)

Removes a set of specified permissions from a client in a specific channel.

Multiple permissions can be removed at once.

Parameters

integer	$cid
integer	$cldbid
integer	$permid

Returns

void

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

    $this->execute("channelclientdelperm", array("cid" => $cid, "cldbid" => $cldbid, $permident => $permid));
  }

channelCreate()

channelCreate

(

array

$properties

)

Creates a new channel using given properties and returns the new ID.

Parameters

array

$properties

Returns

integer

  {
    $cid = $this->execute("channelcreate", $properties)->toList();
    $this->channelListReset();

    if(!isset($properties["channel_flag_permanent"]) && !isset($properties["channel_flag_semi_permanent"]))
    {
      $this->getParent()->whoamiSet("client_channel_id", $cid["cid"]);
    }

    return $cid["cid"];
  }

channelDelete()

channelDelete	(		$cid,
			$force = FALSE
	)

Deletes the channel specified by $cid.

Parameters

integer	$cid
boolean	$force

Returns

void

  {
    $this->execute("channeldelete", array("cid" => $cid, "force" => $force));
    $this->channelListReset();

    if(($cid instanceof TeamSpeak3_Node_Abstract ? $cid->getId() : $cid) == $this->whoamiGet("client_channel_id"))
    {
      $this->getParent()->whoamiReset();
    }
  }

channelDirCreate()

channelDirCreate	(		$cid,
			$cpw = "",
			$dirname = "/"
	)

Creates new directory in a channels file repository.

Parameters

integer	$cid
string	$cpw
string	$dirname

Returns

void

  {
    $this->execute("ftcreatedir", array("cid" => $cid, "cpw" => $cpw, "dirname" => $dirname));
  }

channelFileDelete()

channelFileDelete	(		$cid,
			$cpw = "",
			$name = "/"
	)

Deletes one or more files stored in a channels file repository.

Parameters

integer	$cid
string	$cpw
string	$name

Returns

void

  {
    $this->execute("ftdeletefile", array("cid" => $cid, "cpw" => $cpw, "name" => $name));
  }

channelFileInfo()

channelFileInfo	(		$cid,
			$cpw = "",
			$name = "/"
	)

Returns detailed information about the specified file stored in a channels file repository.

Parameters

integer	$cid
string	$cpw
string	$name

Returns

array

  {
    $info = $this->execute("ftgetfileinfo", array("cid" => $cid, "cpw" => $cpw, "name" => $name))->toArray();
    
    return array_pop($info);
  }

channelFileList()

channelFileList	(		$cid,
			$cpw = "",
			$path = "/",
			$recursive = FALSE
	)

Returns a list of files and directories stored in the specified channels file repository.

Parameters

integer	$cid
string	$cpw
string	$path
boolean	$recursive

Returns

array

  {
    $files = $this->execute("ftgetfilelist", array("cid" => $cid, "cpw" => $cpw, "path" => $path))->toArray();
    $count = count($files);

    for($i = 0; $i < $count; $i++)
    {
      $files[$i]["sid"]  = $this->getId();
      $files[$i]["cid"]  = $files[0]["cid"];
      $files[$i]["path"] = $files[0]["path"];
      $files[$i]["src"]  = new TeamSpeak3_Helper_String($cid ? $files[$i]["path"] : "/");

      if(!$files[$i]["src"]->endsWith("/"))
      {
        $files[$i]["src"]->append("/");
      }

      $files[$i]["src"]->append($files[$i]["name"]);

      if($recursive && $files[$i]["type"] == TeamSpeak3::FILE_TYPE_DIRECTORY)
      {
        $files = array_merge($files, $this->channelFileList($cid, $cpw, $path . $files[$i]["name"], $recursive));
      }
    }

    uasort($files, array(__CLASS__, "sortFileList"));

    return $files;
  }

channelFileRename()

channelFileRename	(		$cid,
			$cpw = "",
			$oldname = "/",
			$newname = "/",
			$tcid = null,
			$tcpw = null
	)

Renames a file in a channels file repository.

If the two parameters $tcid and $tcpw are specified, the file will be moved into another channels file repository.

Parameters

integer	$cid
string	$cpw
string	$oldname
string	$newname
integer	$tcid
string	$tcpw

Returns

void

  {
    $this->execute("ftrenamefile", array("cid" => $cid, "cpw" => $cpw, "oldname" => $oldname, "newname" => $newname, "tcid" => $tcid, "tcpw" => $tcpw));
  }

channelGetById()

channelGetById

(

$cid

)

Returns the TeamSpeak3_Node_Channel object matching the given ID.

Parameters

integer

$cid

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Channel

  {
    if(!array_key_exists((string) $cid, $this->channelList()))
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid channelID", 0x300);
    }

    return $this->channelList[intval((string) $cid)];
  }

channelGetByName()

channelGetByName

(

$name

)

Returns the TeamSpeak3_Node_Channel object matching the given name.

Parameters

string

$name

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Channel

  {
    foreach($this->channelList() as $channel)
    {
      if($channel["channel_name"] == $name) return $channel;
    }

    throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid channelID", 0x300);
  }

channelGetDefault()

channelGetDefault

(

)

Returns the TeamSpeak3_Node_Channel object representing the default channel.

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Channel

  {
    foreach($this->channelList() as $channel)
    {
      if($channel["channel_flag_default"]) return $channel;
    }

    throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid channelID", 0x300);
  }

channelGetLevel()

channelGetLevel

(

$cid

)

Returns the level of a channel.

Parameters

integer

$cid

Returns

integer

  {
    $channel = $this->channelGetById($cid);
    $levelno = 0;

    if($channel["pid"])
    {
      $levelno = $this->channelGetLevel($channel["pid"])+1;
    }

    return $levelno;
  }

channelGetPathway()

channelGetPathway

(

$cid

)

Returns the pathway of a channel which can be used as a clients default channel.

Parameters

integer

$cid

Returns

string

  {
    $channel = $this->channelGetById($cid);
    $pathway = $channel["channel_name"];

    if($channel["pid"])
    {
      $pathway = $this->channelGetPathway($channel["pid"]) . "/" . $channel["channel_name"];
    }

    return $pathway;
  }

channelGroupClientList()

channelGroupClientList	(		$cgid = null,
			$cid = null,
			$cldbid = null,
			$resolve = FALSE
	)

Returns all the client and/or channel IDs currently assigned to channel groups.

All three parameters are optional so you're free to choose the most suitable combination for your requirements.

Parameters

integer	$cgid
integer	$cid
integer	$cldbid
boolean	$resolve

Returns

array

  {
    if($this["virtualserver_default_channel_group"] == $cgid)
    {
      return array();
    }

    try
    {
      $result = $this->execute("channelgroupclientlist", array("cgid" => $cgid, "cid" => $cid, "cldbid" => $cldbid))->toArray();
    }
    catch(TeamSpeak3_Adapter_ServerQuery_Exception $e)
    {
      /* ERROR_database_empty_result */
      if($e->getCode() != 0x501) throw $e;

      $result = array();
    }

    if($resolve)
    {
      foreach($result as $k => $v)
      {
        $result[$k] = array_merge($v, $this->clientInfoDb($v["cldbid"]));
      }
    }

    return $result;
  }

channelGroupCopy()

channelGroupCopy	(		$scgid,
			$name = null,
			$tcgid = 0,
			$type = TeamSpeak3::GROUP_DBTYPE_REGULAR
	)

Creates a copy of an existing channel group specified by $scgid and returns the new groups ID.

Parameters

integer	$scgid
string	$name
integer	$tcgid
integer	$type

Returns

integer

  {
    $this->channelGroupListReset();

    $cgid = $this->execute("channelgroupcopy", array("scgid" => $scgid, "tcgid" => $tcgid, "name" => $name, "type" => $type))->toList();

    if($tcgid && $name)
    {
      $this->channelGroupRename($tcgid, $name);
    }

    return count($cgid) ? $cgid["cgid"] : intval($tcgid);
  }

channelGroupCreate()

channelGroupCreate	(		$name,
			$type = TeamSpeak3::GROUP_DBTYPE_REGULAR
	)

Creates a new channel group using the name specified with $name and returns its ID.

Parameters

string	$name
integer	$type

Returns

integer

  {
    $this->channelGroupListReset();

    $cgid = $this->execute("channelgroupadd", array("name" => $name, "type" => $type))->toList();

    return $cgid["cgid"];
  }

channelGroupDelete()

channelGroupDelete	(		$cgid,
			$force = FALSE
	)

Deletes the channel group specified with $cgid.

If $force is set to 1, the channel group will be deleted even if there are clients within.

Parameters

integer	$sgid
boolean	$force

Returns

void

  {
    $this->channelGroupListReset();

    $this->execute("channelgroupdel", array("cgid" => $cgid, "force" => $force));
  }

channelGroupGetById()

channelGroupGetById

(

$cgid

)

Returns the TeamSpeak3_Node_Channelgroup object matching the given ID.

Parameters

integer

$cgid

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Channelgroup

  {
    if(!array_key_exists((string) $cgid, $this->channelGroupList()))
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid groupID", 0xA00);
    }

    return $this->cgroupList[intval((string) $cgid)];
  }

channelGroupGetByName()

channelGroupGetByName	(		$name,
			$type = TeamSpeak3::GROUP_DBTYPE_REGULAR
	)

Returns the TeamSpeak3_Node_Channelgroup object matching the given name.

Parameters

string	$name
integer	$type

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Channelgroup

  {
    foreach($this->channelGroupList() as $group)
    {
      if($group["name"] == $name && $group["type"] == $type) return $group;
    }

    throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid groupID", 0xA00);
  }

channelGroupList()

channelGroupList

(

array

$filter = array()

)

Returns a list of channel groups available.

Parameters

array

$filter

Returns

array|TeamSpeak3_Node_Channelgroup[]

  {
    if($this->cgroupList === null)
    {
      $this->cgroupList = $this->request("channelgrouplist")->toAssocArray("cgid");

      foreach($this->cgroupList as $cgid => $group)
      {
        $this->cgroupList[$cgid] = new TeamSpeak3_Node_Channelgroup($this, $group);
      }

      uasort($this->cgroupList, array(__CLASS__, "sortGroupList"));
    }

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

channelGroupListReset()

channelGroupListReset

(

)

Resets the list of channel groups.

Returns

void

  {
    $this->cgroupList = null;
  }

channelGroupPermAssign()

channelGroupPermAssign	(		$cgid,
			$permid,
			$permvalue
	)

Adds a set of specified permissions to the channel group specified.

Multiple permissions can be added by providing the two parameters of each permission in separate arrays.

Parameters

integer	$cgid
integer	$permid
integer	$permvalue

Returns

void

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

    $this->execute("channelgroupaddperm", array("cgid" => $cgid, $permident => $permid, "permvalue" => $permvalue));
  }

channelGroupPermList()

channelGroupPermList	(		$cgid,
			$permsid = FALSE
	)

Returns a list of permissions assigned to the channel group specified.

Parameters

integer	$cgid
boolean	$permsid

Returns

array

  {
    return $this->execute("channelgrouppermlist", array("cgid" => $cgid, $permsid ? "-permsid" : null))->toAssocArray($permsid ? "permsid" : "permid");
  }

channelGroupPermRemove()

channelGroupPermRemove	(		$cgid,
			$permid
	)

Removes a set of specified permissions from the channel group specified with $cgid.

Multiple permissions can be removed at once.

Parameters

integer	$cgid
integer	$permid

Returns

void

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

    $this->execute("channelgroupdelperm", array("cgid" => $cgid, $permident => $permid));
  }

channelGroupRename()

channelGroupRename	(		$cgid,
			$name
	)

Renames the channel group specified with $cgid.

Parameters

integer	$cgid
string	$name

Returns

void

  {
    $this->channelGroupListReset();

    $this->execute("channelgrouprename", array("cgid" => $cgid, "name" => $name));
  }

channelIsSpacer()

channelIsSpacer

(

TeamSpeak3_Node_Channel

$channel

)

Returns TRUE if the given TeamSpeak3_Node_Channel object is a spacer.

Parameters

TeamSpeak3_Node_Channel

$channel

Returns

boolean

  {
    return (preg_match("/\[[^\]]*spacer[^\]]*\]/", $channel) && $channel["channel_flag_permanent"] && !$channel["pid"]) ? TRUE : FALSE;
  }

channelList()

channelList

(

array

$filter = array()

)

Returns an array filled with TeamSpeak3_Node_Channel objects.

Parameters

array

$filter

Returns

array|TeamSpeak3_Node_Channel[]

  {
    if($this->channelList === null)
    {
      $channels = $this->request("channellist -topic -flags -voice -limits -icon")->toAssocArray("cid");

      $this->channelList = array();

      foreach($channels as $cid => $channel)
      {
        $this->channelList[$cid] = new TeamSpeak3_Node_Channel($this, $channel);
      }

      $this->resetNodeList();
    }

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

channelListReset()

channelListReset

(

)

Resets the list of channels online.

Returns

void

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

channelMove()

channelMove	(		$cid,
			$pid,
			$order = null
	)

Moves the channel specified by $cid to the parent channel specified with $pid.

Parameters

integer	$cid
integer	$pid
integer	$order

Returns

void

  {
    $this->execute("channelmove", array("cid" => $cid, "cpid" => $pid, "order" => $order));
    $this->channelListReset();
  }

channelPermAssign()

channelPermAssign	(		$cid,
			$permid,
			$permvalue
	)

Adds a set of specified permissions to a channel.

Multiple permissions can be added by providing the two parameters of each permission.

Parameters

integer	$cid
integer	$permid
integer	$permvalue

Returns

void

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

    $this->execute("channeladdperm", array("cid" => $cid, $permident => $permid, "permvalue" => $permvalue));
  }

channelPermList()

channelPermList	(		$cid,
			$permsid = FALSE
	)

Returns a list of permissions defined for a specific channel.

Parameters

integer	$cid
boolean	$permsid

Returns

array

  {
    return $this->execute("channelpermlist", array("cid" => $cid, $permsid ? "-permsid" : null))->toAssocArray($permsid ? "permsid" : "permid");
  }

channelPermRemove()

channelPermRemove	(		$cid,
			$permid
	)

Removes a set of specified permissions from a channel.

Multiple permissions can be removed at once.

Parameters

integer	$cid
integer	$permid

Returns

void

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

    $this->execute("channeldelperm", array("cid" => $cid, $permident => $permid));
  }

channelSpacerCreate()

channelSpacerCreate	(		$ident,
			$type = TeamSpeak3::SPACER_SOLIDLINE,
			$align = TeamSpeak3::SPACER_ALIGN_REPEAT,
			$order = null,
			$maxclients = 0
	)

Creates a new channel spacer and returns the new ID.

The first parameter $ident is used to create a unique spacer name on the virtual server.

Parameters

string	$ident
mixed	$type
integer	$align
integer	$order
integer	$maxclients

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

integer

  {
    $properties = array(
      "channel_name_phonetic" => "channel spacer",
      "channel_codec" => TeamSpeak3::CODEC_OPUS_VOICE,
      "channel_codec_quality" => 0x00,
      "channel_flag_permanent" => TRUE,
      "channel_flag_maxclients_unlimited" => FALSE,
      "channel_flag_maxfamilyclients_unlimited" => FALSE,
      "channel_flag_maxfamilyclients_inherited" => FALSE,
      "channel_maxclients" => $maxclients,
      "channel_order" => $order,
    );

    switch($align)
    {
      case TeamSpeak3::SPACER_ALIGN_REPEAT:
        $properties["channel_name"] = "[*spacer" . strval($ident) . "]";
        break;

      case TeamSpeak3::SPACER_ALIGN_LEFT:
        $properties["channel_name"] = "[lspacer" . strval($ident) . "]";
        break;

      case TeamSpeak3::SPACER_ALIGN_RIGHT:
        $properties["channel_name"] = "[rspacer" . strval($ident) . "]";
        break;

      case TeamSpeak3::SPACER_ALIGN_CENTER:
        $properties["channel_name"] = "[cspacer" . strval($ident) . "]";
        break;

      default:
        throw new TeamSpeak3_Adapter_ServerQuery_Exception("missing required parameter", 0x606);
        break;
    }

    switch($type)
    {
      case (string) TeamSpeak3::SPACER_SOLIDLINE:
        $properties["channel_name"] .= "___";
        break;

      case (string) TeamSpeak3::SPACER_DASHLINE:
        $properties["channel_name"] .= "---";
        break;

      case (string) TeamSpeak3::SPACER_DOTLINE:
        $properties["channel_name"] .= "...";
        break;

      case (string) TeamSpeak3::SPACER_DASHDOTLINE:
        $properties["channel_name"] .= "-.-";
        break;

      case (string) TeamSpeak3::SPACER_DASHDOTDOTLINE:
        $properties["channel_name"] .= "-..";
        break;

      default:
        $properties["channel_name"] .= strval($type);
        break;
    }

    return $this->channelCreate($properties);
  }

channelSpacerGetAlign()

channelSpacerGetAlign

(

$cid

)

Returns the possible alignment of a channel spacer.

Parameters

integer

$cid

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

integer

  {
    $channel = $this->channelGetById($cid);

    if(!$this->channelIsSpacer($channel) || !preg_match("/\[(.*)spacer.*\]/", $channel, $matches) || !isset($matches[1]))
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid channel flags", 0x307);
    }

    switch($matches[1])
    {
      case "*":
        return TeamSpeak3::SPACER_ALIGN_REPEAT;

      case "c":
        return TeamSpeak3::SPACER_ALIGN_CENTER;

      case "r":
        return TeamSpeak3::SPACER_ALIGN_RIGHT;

      default:
        return TeamSpeak3::SPACER_ALIGN_LEFT;
    }
  }

channelSpacerGetType()

channelSpacerGetType

(

$cid

)

Returns the possible type of a channel spacer.

Parameters

integer

$cid

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

integer

  {
    $channel = $this->channelGetById($cid);

    if(!$this->channelIsSpacer($channel))
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid channel flags", 0x307);
    }

    switch($channel["channel_name"]->section("]", 1))
    {
      case "___":
        return TeamSpeak3::SPACER_SOLIDLINE;

      case "---":
        return TeamSpeak3::SPACER_DASHLINE;

      case "...":
        return TeamSpeak3::SPACER_DOTLINE;

      case "-.-":
        return TeamSpeak3::SPACER_DASHDOTLINE;

      case "-..":
        return TeamSpeak3::SPACER_DASHDOTDOTLINE;

      default:
        return TeamSpeak3::SPACER_CUSTOM;
    }
  }

clientBan()

clientBan	(		$clid,
			$timeseconds = null,
			$reason = null
	)

Bans the client specified with ID $clid from the server.

Please note that this will create two separate ban rules for the targeted clients IP address and his unique identifier.

Parameters

integer	$clid
integer	$timeseconds
string	$reason

Returns

array

  {
    $this->clientListReset();

    $bans = $this->execute("banclient", array("clid" => $clid, "time" => $timeseconds, "banreason" => $reason))->toAssocArray("banid");

    return array_keys($bans);
  }

clientCount()

clientCount

(

)

Returns the number of regular clients online.

Returns

integer

  {
    if($this->isOffline()) return 0;

    return $this["virtualserver_clientsonline"]-$this["virtualserver_queryclientsonline"];
  }

clientCountDb()

clientCountDb

(

)

Returns the number of client identities known by the virtual server.

Returns

integer

  {
    return current($this->execute("clientdblist -count", array("duration" => 1))->toList("count"));
  }

clientDeleteDb()

clientDeleteDb

(

$cldbid

)

Deletes a clients properties from the database.

Parameters

string

$cldbid

Returns

void

  {
    $this->execute("clientdbdelete", array("cldbid" => $cldbid));
  }

clientFind()

clientFind

(

$pattern

)

Returns a list of clients matching a given name pattern.

Parameters

string

$pattern

Returns

array

  {
    return $this->execute("clientfind", array("pattern" => $pattern))->toAssocArray("clid");
  }

clientFindDb()

clientFindDb	(		$pattern,
			$uid = FALSE
	)

Returns a list of client database IDs matching a given pattern.

You can either search for a clients last known nickname or his unique identity by using the $uid option.

Parameters

string	$pattern
boolean	$uid

Returns

array

  {
    return array_keys($this->execute("clientdbfind", array("pattern" => $pattern, ($uid) ? "-uid" : null))->toAssocArray("cldbid"));
  }

clientGetByDbid()

clientGetByDbid

(

$dbid

)

Returns the TeamSpeak3_Node_Client object matching the given database ID.

Parameters

integer

$dbid

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Client

  {
    foreach($this->clientList() as $client)
    {
      if($client["client_database_id"] == $dbid) return $client;
    }

    throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid clientID", 0x200);
  }

clientGetById()

clientGetById

(

$clid

)

Returns the TeamSpeak3_Node_Client object matching the given ID.

Parameters

integer

$clid

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Client

  {
    if(!array_key_exists((string) $clid, $this->clientList()))
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid clientID", 0x200);
    }

    return $this->clientList[intval((string) $clid)];
  }

clientGetByName()

clientGetByName

(

$name

)

Returns the TeamSpeak3_Node_Client object matching the given name.

Parameters

string

$name

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Client

  {
    foreach($this->clientList() as $client)
    {
      if($client["client_nickname"] == $name) return $client;
    }

    throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid clientID", 0x200);
  }

clientGetByUid()

clientGetByUid

(

$uid

)

Returns the TeamSpeak3_Node_Client object matching the given unique identifier.

Parameters

string

$uid

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Client

  {
    foreach($this->clientList() as $client)
    {
      if($client["client_unique_identifier"] == $uid) return $client;
    }

    throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid clientID", 0x200);
  }

clientGetIdsByUid()

clientGetIdsByUid

(

$cluid

)

Returns an array containing a list of active client connections using the unique identifier specified with $cluid.

Parameters

string

$cluid

Returns

array

  {
    return $this->execute("clientgetids", array("cluid" => $cluid))->toAssocArray("clid");
  }

clientGetNameByDbid()

clientGetNameByDbid

(

$cldbid

)

Returns an array containing the last known nickname and the unique identifier of the client matching the database ID specified with $cldbid.

Parameters

string

$cldbid

Returns

array

  {
    return $this->execute("clientgetnamefromdbid", array("cldbid" => $cldbid))->toList();
  }

clientGetNameByUid()

clientGetNameByUid

(

$cluid

)

Returns an array containing the last known nickname and the database ID of the client matching the unique identifier specified with $cluid.

Parameters

string

$cluid

Returns

array

  {
    return $this->execute("clientgetnamefromuid", array("cluid" => $cluid))->toList();
  }

clientGetServerGroupsByDbid()

clientGetServerGroupsByDbid

(

$cldbid

)

Returns an array containing the names and IDs of all server groups the client specified with $cldbid is is currently residing in.

Parameters

string

$cldbid

Returns

array

  {
    return $this->execute("servergroupsbyclientid", array("cldbid" => $cldbid))->toAssocArray("sgid");
  }

clientInfoDb()

clientInfoDb

(

$cldbid

)

Returns a list of properties from the database for the client specified by $cldbid.

Parameters

integer

$cldbid

Returns

array

  {
    return $this->execute("clientdbinfo", array("cldbid" => $cldbid))->toList();
  }

clientKick()

clientKick	(		$clid,
			$reasonid = TeamSpeak3::KICK_CHANNEL,
			$reasonmsg = null
	)

Kicks one or more clients from their currently joined channel or from the server.

Parameters

integer	$clid
integer	$reasonid
string	$reasonmsg

Returns

void

  {
    $this->clientListReset();

    $this->execute("clientkick", array("clid" => $clid, "reasonid" => $reasonid, "reasonmsg" => $reasonmsg));
  }

clientList()

clientList

(

array

$filter = array()

)

Returns an array filled with TeamSpeak3_Node_Client objects.

Parameters

array

$filter

Returns

array|TeamSpeak3_Node_Client[]

  {
    if($this->clientList === null)
    {
      $clients = $this->request("clientlist -uid -away -badges -voice -info -times -groups -icon -country -ip")->toAssocArray("clid");

      $this->clientList = array();

      foreach($clients as $clid => $client)
      {
        if($this->getParent()->getExcludeQueryClients() && $client["client_type"]) continue;

        $this->clientList[$clid] = new TeamSpeak3_Node_Client($this, $client);
      }

      uasort($this->clientList, array(__CLASS__, "sortClientList"));

      $this->resetNodeList();
    }

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

clientListDb()

clientListDb	(		$offset = null,
			$limit = null
	)

Returns a list of client identities known by the virtual server.

By default, the server spits out 25 entries at once.

Parameters

integer	$offset
integer	$limit

Returns

array

  {
    return $this->execute("clientdblist -count", array("start" => $offset, "duration" => $limit))->toAssocArray("cldbid");
  }

clientListReset()

clientListReset

(

)

Resets the list of clients online.

Returns

void

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

clientModifyDb()

clientModifyDb	(		$cldbid,
		array	$properties
	)

Changes the clients properties using given properties.

Parameters

string	$cldbid
array	$properties

Returns

void

  {
    $properties["cldbid"] = $cldbid;

    $this->execute("clientdbedit", $properties);
  }

clientMove()

clientMove	(		$clid,
			$cid,
			$cpw = null
	)

Moves a client to another channel.

Parameters

integer	$clid
integer	$cid
string	$cpw

Returns

void

  {
    $this->clientListReset();

    $this->execute("clientmove", array("clid" => $clid, "cid" => $cid, "cpw" => $cpw));

    if($clid instanceof TeamSpeak3_Node_Abstract)
    {
      $clid = $clid->getId();
    }

    if($cid instanceof TeamSpeak3_Node_Abstract)
    {
      $cid = $cid->getId();
    }

    if(!is_array($clid) && $clid == $this->whoamiGet("client_id"))
    {
      $this->getParent()->whoamiSet("client_channel_id", $cid);
    }
  }

clientPermAssign()

clientPermAssign	(		$cldbid,
			$permid,
			$permvalue,
			$permskip = FALSE
	)

Adds a set of specified permissions to a client.

Multiple permissions can be added by providing the three parameters of each permission.

Parameters

integer	$cldbid
integer	$permid
integer	$permvalue
integer	$permskip

Returns

void

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

    $this->execute("clientaddperm", array("cldbid" => $cldbid, $permident => $permid, "permvalue" => $permvalue, "permskip" => $permskip));
  }

clientPermList()

clientPermList	(		$cldbid,
			$permsid = FALSE
	)

Returns a list of permissions defined for a client.

Parameters

integer	$cldbid
boolean	$permsid

Returns

array

  {
    $this->clientListReset();

    return $this->execute("clientpermlist", array("cldbid" => $cldbid, $permsid ? "-permsid" : null))->toAssocArray($permsid ? "permsid" : "permid");
  }

clientPermRemove()

clientPermRemove	(		$cldbid,
			$permid
	)

Removes a set of specified permissions from a client.

Multiple permissions can be removed at once.

Parameters

integer	$cldbid
integer	$permid

Returns

void

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

    $this->execute("clientdelperm", array("cldbid" => $cldbid, $permident => $permid));
  }

clientPoke()

clientPoke	(		$clid,
			$msg
	)

Sends a poke message to a client.

Parameters

integer	$clid
string	$msg

Returns

void

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

clientSetChannelGroup()

clientSetChannelGroup	(		$cldbid,
			$cid,
			$cgid
	)

Sets the channel group of a client to the ID specified.

Parameters

integer	$cldbid
integer	$cid
integer	$cgid

Returns

void

  {
    $this->execute("setclientchannelgroup", array("cldbid" => $cldbid, "cid" => $cid, "cgid" => $cgid));
  }

complaintCreate()

complaintCreate	(		$tcldbid,
			$message
	)

Submits a complaint about the client with database ID $tcldbid to the server.

Parameters

integer	$tcldbid
string	$message

Returns

void

  {
    $this->execute("complainadd", array("tcldbid" => $tcldbid, "message" => $message));
  }

complaintDelete()

complaintDelete	(		$tcldbid,
			$fcldbid
	)

Deletes the complaint about the client with ID $tcldbid submitted by the client with ID $fcldbid from the server.

Parameters

integer	$tcldbid
integer	$fcldbid

Returns

void

  {
    $this->execute("complaindel", array("tcldbid" => $tcldbid, "fcldbid" => $fcldbid));
  }

complaintList()

complaintList

(

$tcldbid = null

)

Returns a list of complaints on the selected virtual server.

If $tcldbid is specified, only complaints about the targeted client will be shown.

Parameters

integer

$tcldbid

Returns

array

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

complaintListClear()

complaintListClear

(

$tcldbid

)

Deletes all active complaints about the client with database ID $tcldbid from the server.

Parameters

integer

$tcldbid

Returns

void

  {
    $this->execute("complaindelall", array("tcldbid" => $tcldbid));
  }

connectionInfo()

connectionInfo

(

)

Returns detailed connection information of the virtual server.

Returns

array

  {
    return $this->request("serverrequestconnectioninfo")->toList();
  }

customInfo()

customInfo

(

$cldbid

)

Returns a list of custom properties for the client specified by $cldbid.

Parameters

integer

$cldbid

Returns

array

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

customSearch()

customSearch	(		$ident,
			$pattern = "%"
	)

Returns a list of custom client properties specified by $ident.

Parameters

string	$ident
string	$pattern

Returns

array

  {
    return $this->execute("customsearch", array("ident" => $ident, "pattern" => $pattern))->toArray();
  }

delete()

delete

(

)

Deletes the virtual server.

Returns

void

  {
    $this->getParent()->serverDelete($this->getId());
  }

getIcon()

getIcon

(

)

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

Returns

string

  {
    if($this["virtualserver_clientsonline"]-$this["virtualserver_queryclientsonline"] >= $this["virtualserver_maxclients"])
    {
      return "server_full";
    }
    elseif($this["virtualserver_flag_password"])
    {
      return "server_pass";
    }
    else
    {
      return "server_open";
    }
  }

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 $this->getParent()->getUniqueId() . "_s" . $this->getId();
  }

iconDownload()

iconDownload

(

)

Downloads and returns the servers icon file content.

Returns

TeamSpeak3_Helper_String

  {
    if($this->iconIsLocal("virtualserver_icon_id") || $this["virtualserver_icon_id"] == 0) return;

    $download = $this->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->iconGetName("virtualserver_icon_id"));
    $transfer = TeamSpeak3::factory("filetransfer://" . (strstr($download["host"], ":") !== FALSE ? "[" . $download["host"] . "]" : $download["host"]) . ":" . $download["port"]);

    return $transfer->download($download["ftkey"], $download["size"]);
  }

iconUpload()

iconUpload

(

$data

)

Uploads a given icon file content to the server and returns the ID of the icon.

Parameters

string

$data

Returns

integer

  {
    $crc   = crc32($data);
    $size = strlen($data);

    $upload   = $this->transferInitUpload(rand(0x0000, 0xFFFF), 0, "/icon_" . $crc, $size);
    $transfer = TeamSpeak3::factory("filetransfer://" . (strstr($upload["host"], ":") !== FALSE ? "[" . $upload["host"] . "]" : $upload["host"]) . ":" . $upload["port"]);

    $transfer->upload($upload["ftkey"], $upload["seekpos"], $data);

    return $crc;
  }

isOffline()

isOffline

(

)

Returns TRUE if the virtual server is offline.

Returns

boolean

  {
    return ($this["virtualserver_status"] == "offline") ? TRUE : FALSE;
  }

isOnline()

isOnline

(

)

Returns TRUE if the virtual server is online.

Returns

boolean

  {
    return ($this["virtualserver_status"] == "online") ? TRUE : FALSE;
  }

logAdd()

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

Writes a custom entry into the virtual server log.

Parameters

string	$logmsg
integer	$loglevel

Returns

void

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

logView()

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

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 the virtual server.

Parameters

string

$msg

Returns

void

  {
    $this->execute("sendtextmessage", array("msg" => $msg, "target" => $this->getId(), "targetmode" => TeamSpeak3::TEXTMSG_SERVER));
  }

messageCreate()

messageCreate	(		$cluid,
			$subject,
			$message
	)

Sends an offline message to the client specified by $cluid.

Parameters

string	$cluid
string	$subject
string	$message

Returns

void

  {
    $this->execute("messageadd", array("cluid" => $cluid, "subject" => $subject, "message" => $message));
  }

messageDelete()

messageDelete

(

$msgid

)

Deletes an existing offline message with ID $msgid from your inbox.

Parameters

integer

$msgid

Returns

void

  {
    $this->execute("messagedel", array("msgid" => $msgid));
  }

messageList()

messageList

(

)

Returns a list of offline messages you've received.

The output contains the senders unique identifier, the messages subject, etc.

Returns

array

  {
    return $this->request("messagelist")->toAssocArray("msgid");
  }

messageRead()

messageRead	(		$msgid,
			$flag_read = TRUE
	)

Returns an existing offline message with ID $msgid from your inbox.

Parameters

integer	$msgid
boolean	$flag_read

Returns

array

  {
    $msg = $this->execute("messageget", array("msgid" => $msgid))->toList();

    if($flag_read)
    {
      $this->execute("messageget", array("msgid" => $msgid, "flag" => $flag_read));
    }

    return $msg;
  }

modify()

modify

(

array

$properties

)

Changes the virtual server configuration using given properties.

Parameters

array

$properties

Returns

void

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

notifyRegister()

notifyRegister	(		$event,
			$id = 0
	)

Registers for a specified category of events on a virtual server to receive notification messages.

Depending on the notifications you've registered for, the server will send you a message on every event.

Parameters

string	$event
integer	$id

Returns

void

  {
    $this->execute("servernotifyregister", array("event" => $event, "id" => $id));
  }

notifyUnregister()

notifyUnregister

(

)

Unregisters all events previously registered with servernotifyregister so you will no longer receive notification messages.

Returns

void

  {
    $this->request("servernotifyunregister");
  }

permRemoveAny()

permRemoveAny

(

$permid

)

Removes any assignment of the permission specified with $permid on the selected virtual server and returns the number of removed assignments on success.

Parameters

integer

$permid

Returns

integer

  {
    $assignments = $this->permissionFind($permid);

    foreach($assignments as $assignment)
    {
      switch($assignment["t"])
      {
        case TeamSpeak3::PERM_TYPE_SERVERGROUP:
          $this->serverGroupPermRemove($assignment["id1"], $assignment["p"]);
          break;

        case TeamSpeak3::PERM_TYPE_CLIENT:
          $this->clientPermRemove($assignment["id2"], $assignment["p"]);
          break;

        case TeamSpeak3::PERM_TYPE_CHANNEL:
          $this->channelPermRemove($assignment["id2"], $assignment["p"]);
          break;

        case TeamSpeak3::PERM_TYPE_CHANNELGROUP:
          $this->channelGroupPermRemove($assignment["id1"], $assignment["p"]);
          break;

        case TeamSpeak3::PERM_TYPE_CHANNELCLIENT:
          $this->channelClientPermRemove($assignment["id2"], $assignment["id1"], $assignment["p"]);
          break;

        default:
          throw new TeamSpeak3_Adapter_ServerQuery_Exception("convert error", 0x604);
      }
    }

    return count($assignments);
  }

permReset()

permReset

(

)

Restores the default permission settings on the virtual server and returns a new initial administrator privilege key.

Returns

TeamSpeak3_Helper_String

  {
    $token = $this->request("permreset")->toList();

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

    return $token["token"];
  }

privilegeKeyCreate()

privilegeKeyCreate	(		$type = TeamSpeak3::TOKEN_SERVERGROUP,
			$id1,
			$id2 = 0,
			$description = null,
			$customset = null
	)

Creates a new privilege key (token) and returns the key.

Parameters

integer	$type
integer	$id1
integer	$id2
string	$description
string	$customset

Returns

TeamSpeak3_Helper_String

  {
    $token = $this->execute("privilegekeyadd", array("tokentype" => $type, "tokenid1" => $id1, "tokenid2" => $id2, "tokendescription" => $description, "tokencustomset" => $customset))->toList();

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

    return $token["token"];
  }

privilegeKeyDelete()

privilegeKeyDelete

(

$token

)

Deletes a token specified by key $token.

Parameters

string

$token

Returns

void

  {
    $this->execute("privilegekeydelete", array("token" => $token));
  }

privilegeKeyList()

privilegeKeyList

(

$resolve = FALSE

)

Returns a list of privilege keys (tokens) available.

If $resolve is set to TRUE the values of token_id1 and token_id2 will be translated into the appropriate group and/or channel names.

Parameters

boolean

$resolve

Returns

array

  {
    $tokens = $this->request("privilegekeylist")->toAssocArray("token");

    if($resolve)
    {
      foreach($tokens as $token => $array)
      {
        $func = $array["token_type"] ? "channelGroupGetById" : "serverGroupGetById";

        try
        {
          $tokens[$token]["token_id1"] = $this->$func($array["token_id1"])->name;
        }
        catch(Exception $e)
        {
          /* ERROR_channel_invalid_id */
          if($e->getCode() != 0xA00) throw $e;
        }

        try
        {
          if($array["token_type"]) $tokens[$token]["token_id2"] = $this->channelGetById($array["token_id2"])->getPathway();
        }
        catch(Exception $e)
        {
          /* ERROR_permission_invalid_group_id */
          if($e->getCode() != 0x300) throw $e;
        }
      }
    }

    return $tokens;
  }

privilegeKeyUse()

privilegeKeyUse

(

$token

)

Use a token key gain access to a server or channel group.

Please note that the server will automatically delete the token after it has been used.

Parameters

string

$token

Returns

void

  {
    $this->execute("privilegekeyuse", array("token" => $token));
  }

request()

request	(		$cmd,
			$throw = TRUE
	)

Sends a prepared command to the server and returns the result.

Parameters

string	$cmd
boolean	$throw

Returns

TeamSpeak3_Adapter_ServerQuery_Reply

  {
    if($this->getId() != $this->getParent()->serverSelectedId())
    {
      $this->getParent()->serverSelect($this->getId());
    }

    return $this->getParent()->request($cmd, $throw);
  }

selfPermOverview()

selfPermOverview

(

)

Returns an array containing the permission overview of your own client.

Returns

array

  {
    return $this->execute("permoverview", array("cldbid" => $this->whoamiGet("client_database_id"), "cid" => $this->whoamiGet("client_channel_id"), "permid" => 0))->toArray();
  }

selfUpdate()

selfUpdate

(

array

$properties

)

Changes the properties of your own client connection.

Parameters

array

$properties

Returns

void

  {
    $this->execute("clientupdate", $properties);

    foreach($properties as $ident => $value)
    {
      $this->whoamiSet($ident, $value);
    }
  }

selfUpdateLogin()

selfUpdateLogin

(

$username

)

Updates your own ServerQuery login credentials using a specified username.

The password will be auto-generated.

Parameters

string

$username

Returns

TeamSpeak3_Helper_String

  {
    $password = $this->execute("clientsetserverquerylogin", array("client_login_name" => $username))->toList();

    return $password["client_login_password"];
  }

sendPluginCmd()

sendPluginCmd	(		$plugin,
			$data
	)

Sends a plugin command to all clients connected to the server.

Parameters

string	$plugin
string	$data

Returns

void

  {
    $this->execute("plugincmd", array("name" => $plugin, "data" => $data, "targetmode" => TeamSpeak3::PLUGINCMD_SERVER));
  }

serverGroupClientAdd()

serverGroupClientAdd	(		$sgid,
			$cldbid
	)

Adds a client to the server group specified.

Please note that a client cannot be added to default groups or template groups.

Parameters

integer	$sgid
integer	$cldbid

Returns

void

  {
    $this->clientListReset();

    $this->execute("servergroupaddclient", array("sgid" => $sgid, "cldbid" => $cldbid));
  }

serverGroupClientDel()

serverGroupClientDel	(		$sgid,
			$cldbid
	)

Removes a client from the server group specified.

Parameters

integer	$sgid
integer	$cldbid

Returns

void

  {
    $this->execute("servergroupdelclient", array("sgid" => $sgid, "cldbid" => $cldbid));
  }

serverGroupClientList()

serverGroupClientList

(

$sgid

)

Returns a list of clients assigned to the server group specified.

Parameters

integer

$sgid

Returns

array

  {
    if($this["virtualserver_default_server_group"] == $sgid)
    {
      return array();
    }

    return $this->execute("servergroupclientlist", array("sgid" => $sgid,  "-names"))->toAssocArray("cldbid");
  }

serverGroupCopy()

serverGroupCopy	(		$ssgid,
			$name = null,
			$tsgid = 0,
			$type = TeamSpeak3::GROUP_DBTYPE_REGULAR
	)

Creates a copy of an existing server group specified by $ssgid and returns the new groups ID.

Parameters

integer	$ssgid
string	$name
integer	$tsgid
integer	$type

Returns

integer

  {
    $this->serverGroupListReset();

    $sgid = $this->execute("servergroupcopy", array("ssgid" => $ssgid, "tsgid" => $tsgid, "name" => $name, "type" => $type))->toList();

    if($tsgid && $name)
    {
      $this->serverGroupRename($tsgid, $name);
    }

    return count($sgid) ? $sgid["sgid"] : intval($tsgid);
  }

serverGroupCreate()

serverGroupCreate	(		$name,
			$type = TeamSpeak3::GROUP_DBTYPE_REGULAR
	)

Creates a new server group using the name specified with $name and returns its ID.

Parameters

string	$name
integer	$type

Returns

integer

  {
    $this->serverGroupListReset();

    $sgid = $this->execute("servergroupadd", array("name" => $name, "type" => $type))->toList();

    return $sgid["sgid"];
  }

serverGroupDelete()

serverGroupDelete	(		$sgid,
			$force = FALSE
	)

Deletes the server group specified with $sgid.

If $force is set to 1, the server group will be deleted even if there are clients within.

Parameters

integer	$sgid
boolean	$force

Returns

void

  {
    $this->serverGroupListReset();

    $this->execute("servergroupdel", array("sgid" => $sgid, "force" => $force));
  }

serverGroupGetById()

serverGroupGetById

(

$sgid

)

Returns the TeamSpeak3_Node_Servergroup object matching the given ID.

Parameters

integer

$sgid

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Servergroup

  {
    if(!array_key_exists((string) $sgid, $this->serverGroupList()))
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid groupID", 0xA00);
    }

    return $this->sgroupList[intval((string) $sgid)];
  }

serverGroupGetByName()

serverGroupGetByName	(		$name,
			$type = TeamSpeak3::GROUP_DBTYPE_REGULAR
	)

Returns the TeamSpeak3_Node_Servergroup object matching the given name.

Parameters

string	$name
integer	$type

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Servergroup

  {
    foreach($this->serverGroupList() as $group)
    {
      if($group["name"] == $name && $group["type"] == $type) return $group;
    }

    throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid groupID", 0xA00);
  }

serverGroupGetProfiles()

serverGroupGetProfiles

(

$type = TeamSpeak3::GROUP_DBTYPE_REGULAR

)

Returns an ordered array of regular server groups available based on a pre-defined set of rules.

Parameters

integer

$type

Returns

array

  {
    $profiles = array();

    foreach($this->serverGroupList() as $sgid => $sgroup)
    {
      if($sgroup["type"] != $type) continue;

      $profiles[$sgid] = array(
        "b_permission_modify_power_ignore" => 0,
        "i_group_member_add_power" => 0,
        "i_group_member_remove_power" => 0,
        "i_needed_modify_power_count" => 0,
        "i_needed_modify_power_total" => 0,
        "i_permission_modify_power" => 0,
        "i_group_modify_power" => 0,
        "i_client_modify_power" => 0,
        "b_virtualserver_servergroup_create" => 0,
        "b_virtualserver_servergroup_delete" => 0,
        "b_client_ignore_bans" => 0,
        "b_client_ignore_antiflood" => 0,
        "b_group_is_permanent" => 0,
        "i_client_needed_ban_power" => 0,
        "i_client_needed_kick_power" => 0,
        "i_client_needed_move_power" => 0,
        "i_client_talk_power" => 0,
        "__sgid" => $sgid,
        "__name" => $sgroup->toString(),
        "__node" => $sgroup,
      );

      try
      {
        $perms = $this->serverGroupPermList($sgid, TRUE);
        $grant = isset($perms["i_permission_modify_power"]) ? $perms["i_permission_modify_power"]["permvalue"] : null;
      }
      catch(TeamSpeak3_Adapter_ServerQuery_Exception $e)
      {
        /* ERROR_database_empty_result */
        if($e->getCode() != 0x501) throw $e;

        $perms = array();
        $grant = null;
      }

      foreach($perms as $permsid => $perm)
      {
        if(in_array($permsid, array_keys($profiles[$sgid])))
        {
          $profiles[$sgid][$permsid] = $perm["permvalue"];
        }
        elseif(TeamSpeak3_Helper_String::factory($permsid)->startsWith("i_needed_modify_power_"))
        {
          if(!$grant || $perm["permvalue"] > $grant) continue;

          $profiles[$sgid]["i_needed_modify_power_total"] = $profiles[$sgid]["i_needed_modify_power_total"]+$perm["permvalue"];
          $profiles[$sgid]["i_needed_modify_power_count"]++;
        }
      }
    }

    array_multisort($profiles, SORT_DESC);

    return $profiles;
  }

serverGroupIdentify()

serverGroupIdentify	(		$mode = TeamSpeak3::GROUP_IDENTIFIY_STRONGEST,
			$type = TeamSpeak3::GROUP_DBTYPE_REGULAR
	)

Tries to identify the post powerful/weakest server group on the virtual server and returns the ID.

Parameters

integer	$mode
integer	$type

Returns

TeamSpeak3_Node_Servergroup

  {
    $profiles = $this->serverGroupGetProfiles($type);

    $best_guess_profile = ($mode == TeamSpeak3::GROUP_IDENTIFIY_STRONGEST) ? array_shift($profiles) : array_pop($profiles);

    return $this->serverGroupGetById($best_guess_profile["__sgid"]);
  }

serverGroupList()

serverGroupList

(

array

$filter = array()

)

Returns a list of server groups available.

Parameters

filter

$filter

Returns

array|TeamSpeak3_Node_Servergroup[]

  {
    if($this->sgroupList === null)
    {
      $this->sgroupList = $this->request("servergrouplist")->toAssocArray("sgid");

      foreach($this->sgroupList as $sgid => $group)
      {
        $this->sgroupList[$sgid] = new TeamSpeak3_Node_Servergroup($this, $group);
      }

      uasort($this->sgroupList, array(__CLASS__, "sortGroupList"));
    }

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

serverGroupListReset()

serverGroupListReset

(

)

Resets the list of server groups.

Returns

void

  {
    $this->sgroupList = null;
  }

serverGroupPermAssign()

serverGroupPermAssign	(		$sgid,
			$permid,
			$permvalue,
			$permnegated = FALSE,
			$permskip = FALSE
	)

Adds a set of specified permissions to the server group specified.

Multiple permissions can be added by providing the four parameters of each permission in separate arrays.

Parameters

integer	$sgid
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("servergroupaddperm", array("sgid" => $sgid, $permident => $permid, "permvalue" => $permvalue, "permnegated" => $permnegated, "permskip" => $permskip));
  }

serverGroupPermList()

serverGroupPermList	(		$sgid,
			$permsid = FALSE
	)

Returns a list of permissions assigned to the server group specified.

Parameters

integer	$sgid
boolean	$permsid

Returns

array

  {
    return $this->execute("servergrouppermlist", array("sgid" => $sgid, $permsid ? "-permsid" : null))->toAssocArray($permsid ? "permsid" : "permid");
  }

serverGroupPermRemove()

serverGroupPermRemove	(		$sgid,
			$permid
	)

Removes a set of specified permissions from the server group specified with $sgid.

Multiple permissions can be removed at once.

Parameters

integer	$sgid
integer	$permid

Returns

void

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

    $this->execute("servergroupdelperm", array("sgid" => $sgid, $permident => $permid));
  }

serverGroupRename()

serverGroupRename	(		$sgid,
			$name
	)

Renames the server group specified with $sgid.

Parameters

integer	$sgid
string	$name

Returns

void

  {
    $this->serverGroupListReset();

    $this->execute("servergrouprename", array("sgid" => $sgid, "name" => $name));
  }

snapshotCreate()

snapshotCreate

(

$mode = TeamSpeak3::SNAPSHOT_STRING

)

Creates and returns snapshot data for the selected virtual server.

Parameters

string

$mode

Returns

string

  {
    $snapshot = $this->request("serversnapshotcreate")->toString(FALSE);

    switch($mode)
    {
      case TeamSpeak3::SNAPSHOT_BASE64:
        return $snapshot->toBase64();
        break;

      case TeamSpeak3::SNAPSHOT_HEXDEC:
        return $snapshot->toHex();
        break;

      default:
        return (string) $snapshot;
        break;
    }
  }

snapshotDeploy()

snapshotDeploy	(		$data,
			$mode = TeamSpeak3::SNAPSHOT_STRING
	)

Deploys snapshot data on the selected virtual server.

If no virtual server is selected (ID 0), the data will be used to create a new virtual server from scratch.

Parameters

string	$data
string	$mode

Returns

array

  {
    switch($mode)
    {
      case TeamSpeak3::SNAPSHOT_BASE64:
        $data = TeamSpeak3_Helper_String::fromBase64($data);
        break;

      case TeamSpeak3::SNAPSHOT_HEXDEC:
        $data = TeamSpeak3_Helper_String::fromHex($data);
        break;

      default:
        $data = TeamSpeak3_Helper_String::factory($data);
        break;
    }

    $detail = $this->request("serversnapshotdeploy " . $data)->toList();

    if(array_key_exists("sid", $detail))
    {
      TeamSpeak3_Helper_Signal::getInstance()->emit("notifyServercreated", $this->getParent(), $detail["sid"]);
    }

    return $detail;
  }

sortClientList()

static sortClientList ( TeamSpeak3_Node_Client  $a, TeamSpeak3_Node_Client  $b  )

staticprotected

Internal callback funtion for sorting of client objects.

Parameters

TeamSpeak3_Node_Client	$a
TeamSpeak3_Node_Client	$b

Returns

integer

  {
    if(get_class($a) != get_class($b))
    {
      return 0;

      /* workaround for PHP bug #50688 */
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid parameter", 0x602);
    }

    if(!$a instanceof TeamSpeak3_Node_Client)
    {
      return 0;

      /* workaround for PHP bug #50688 */
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("convert error", 0x604);
    }

    if($a->getProperty("client_talk_power", 0) != $b->getProperty("client_talk_power", 0))
    {
      return ($a->getProperty("client_talk_power", 0) > $b->getProperty("client_talk_power", 0)) ? -1 : 1;
    }

    if($a->getProperty("client_is_talker", 0) != $b->getProperty("client_is_talker", 0))
    {
      return ($a->getProperty("client_is_talker", 0) > $b->getProperty("client_is_talker", 0)) ? -1 : 1;
    }

    return strcmp(strtolower($a["client_nickname"]), strtolower($b["client_nickname"]));
  }

sortFileList()

static sortFileList ( array  $a, array  $b  )

staticprotected

Internal callback funtion for sorting of file list items.

Parameters

array	$a
array	$b

Returns

integer

  {
    if(!array_key_exists("src", $a) || !array_key_exists("src", $b) || !array_key_exists("type", $a) || !array_key_exists("type", $b))
    {
      return 0;

      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid parameter", 0x602);
    }
    
    if($a["type"] != $b["type"])
    {
      return ($a["type"] < $b["type"]) ? -1 : 1;
    }

    return strcmp(strtolower($a["src"]), strtolower($b["src"]));
  }

sortGroupList()

static sortGroupList ( TeamSpeak3_Node_Abstract  $a, TeamSpeak3_Node_Abstract  $b  )

staticprotected

Internal callback funtion for sorting of group objects.

Parameters

TeamSpeak3_Node_Abstract	$a
TeamSpeak3_Node_Abstract	$b

Returns

integer

  {
    if(get_class($a) != get_class($b))
    {
      return 0;

      /* workaround for PHP bug #50688 */
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid parameter", 0x602);
    }

    if(!$a instanceof TeamSpeak3_Node_Servergroup && !$a instanceof TeamSpeak3_Node_Channelgroup)
    {
      return 0;

      /* workaround for PHP bug #50688 */
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("convert error", 0x604);
    }

    if($a->getProperty("sortid", 0) != $b->getProperty("sortid", 0) && $a->getProperty("sortid", 0) != 0 && $b->getProperty("sortid", 0) != 0)
    {
      return ($a->getProperty("sortid", 0) < $b->getProperty("sortid", 0)) ? -1 : 1;
    }

    return ($a->getId() < $b->getId()) ? -1 : 1;
  }

start()

start

(

)

Starts the virtual server.

Returns

void

  {
    $this->getParent()->serverStart($this->getId());
  }

stop()

stop

(

)

Stops the virtual server.

Returns

void

  {
    $this->getParent()->serverStop($this->getId());
  }

tempPasswordCreate()

tempPasswordCreate	(		$pw,
			$duration,
			$tcid = 0,
			$tcpw = "",
			$desc = ""
	)

Sets a new temporary server password specified with $pw.

The temporary password will be valid for the number of seconds specified with $duration. The client connecting with this password will automatically join the channel specified with $tcid. If tcid is set to 0, the client will join the default channel.

Parameters

string	$pw
integer	$duration
integer	$tcid
string	$tcpw
string	$desc

Returns

void

  {
    $this->execute("servertemppasswordadd", array("pw" => $pw, "duration" => $duration, "tcid" => $tcid, "tcpw" => $tcpw, "desc" => $desc));
  }

tempPasswordDelete()

tempPasswordDelete

(

$pw

)

Deletes the temporary server password specified with $pw.

Parameters

string

$pw

Returns

void

  {
    $this->execute("servertemppassworddel", array("pw" => $pw));
  }

tempPasswordList()

tempPasswordList

(

$resolve = FALSE

)

Returns a list of temporary server passwords.

Parameters

boolean

$resolve

Returns

array

  {
    $passwords = $this->request("servertemppasswordlist")->toAssocArray("pw_clear");
    
    if($resolve)
    {
      foreach($passwords as $password => $array)
      {
        try
        {
          $channel = $this->channelGetById($array["tcid"]);
          
          $passwords[$password]["tcname"] = $channel->toString();
          $passwords[$password]["tcpath"] = $channel->getPathway();
        }
        catch(Exception $e)
        {
          /* ERROR_channel_invalid_id */
          if($e->getCode() != 0xA00) throw $e;
        }
      }
    }
    
    return $passwords;
  }

tokenCreate()

tokenCreate	(		$type = TeamSpeak3::TOKEN_SERVERGROUP,
			$id1,
			$id2 = 0,
			$description = null,
			$customset = null
	)

Alias for privilegeKeyCreate().

Deprecated:

  {
    return $this->privilegeKeyCreate($type, $id1, $id2, $description, $customset);
  }

tokenDelete()

tokenDelete

(

$token

)

Alias for privilegeKeyDelete().

Deprecated:

  {
    $this->privilegeKeyDelete($token);
  }

tokenList()

tokenList

(

$translate = FALSE

)

Alias for privilegeKeyList().

Deprecated:

  {
    return $this->privilegeKeyList();
  }

tokenUse()

tokenUse

(

$token

)

Alias for privilegeKeyUse().

Deprecated:

  {
    $this->privilegeKeyUse($token);
  }

transferInitDownload()

transferInitDownload	(		$clientftfid,
			$cid,
			$name,
			$cpw = "",
			$seekpos = 0
	)

Initializes a file transfer download.

$clientftfid is an arbitrary ID to identify the file transfer on client-side.

Parameters

integer	$clientftfid
integer	$cid
string	$name
string	$cpw
integer	$seekpos

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

array

  {
    $download = $this->execute("ftinitdownload", array("clientftfid" => $clientftfid, "cid" => $cid, "name" => $name, "cpw" => $cpw, "seekpos" => $seekpos))->toList();

    if(array_key_exists("status", $download) && $download["status"] != 0x00)
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception($download["msg"], $download["status"]);
    }

    $download["cid"]  = $cid;
    $download["file"] = $name;

    if(!array_key_exists("ip", $download) || $download["ip"]->startsWith("0.0.0.0"))
    {
      $download["ip"]   = $this->getParent()->getAdapterHost();
      $download["host"] = $download["ip"];
    }
    else
    {
      $download["ip"]   = $download["ip"]->section(",");
      $download["host"] = $download["ip"];
    }

    TeamSpeak3_Helper_Signal::getInstance()->emit("filetransferDownloadInit", $download["ftkey"], $download);

    return $download;
  }

transferInitUpload()

transferInitUpload	(		$clientftfid,
			$cid,
			$name,
			$size,
			$cpw = "",
			$overwrite = FALSE,
			$resume = FALSE
	)

Initializes a file transfer upload.

$clientftfid is an arbitrary ID to identify the file transfer on client-side.

Parameters

integer	$clientftfid
integer	$cid
string	$name
integer	$size
string	$cpw
boolean	$overwrite
boolean	$resume

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

array

  {
    $upload = $this->execute("ftinitupload", array("clientftfid" => $clientftfid, "cid" => $cid, "name" => $name, "cpw" => $cpw, "size" => $size, "overwrite" => $overwrite, "resume" => $resume))->toList();

    if(array_key_exists("status", $upload) && $upload["status"] != 0x00)
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception($upload["msg"], $upload["status"]);
    }

    $upload["cid"]  = $cid;
    $upload["file"] = $name;

    if(!array_key_exists("ip", $upload) || $upload["ip"]->startsWith("0.0.0.0"))
    {
      $upload["ip"]   = $this->getParent()->getAdapterHost();
      $upload["host"] = $upload["ip"];
    }
    else
    {
      $upload["ip"]   = $upload["ip"]->section(",");
      $upload["host"] = $upload["ip"];
    }

    TeamSpeak3_Helper_Signal::getInstance()->emit("filetransferUploadInit", $upload["ftkey"], $upload);

    return $upload;
  }

transferList()

transferList

(

)

Displays a list of running file transfers on the selected virtual server.

The output contains the path to which a file is uploaded to, the current transfer rate in bytes per second, etc.

Returns

array

  {
    return $this->request("ftlist")->toAssocArray("serverftfid");
  }

transferStop()

transferStop	(		$serverftfid,
			$delete = FALSE
	)

Stops the running file transfer with server-side ID $serverftfid.

Parameters

integer	$serverftfid
boolean	$delete

Returns

void

  {
    $this->execute("ftstop", array("serverftfid" => $serverftfid, "delete" => $delete));
  }

---

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

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