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

Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Node\Server:

Public Member Functions
	__construct (Host $host, array $info, string $index="virtualserver_id")
	request (string $cmd, bool $throw=true)
	channelList (array $filter=[])
	channelListReset ()
	channelGetDefault ()
	channelCreate (array $properties)
	channelDelete (int\|Node $cid, bool $force=false)
	channelMove (int $cid, int $pid, int $order=null)
	channelIsSpacer (Channel $channel)
	channelSpacerCreate (string $ident, int $type=TeamSpeak3::SPACER_SOLIDLINE, int $align=TeamSpeak3::SPACER_ALIGN_REPEAT, int $order=null, int $maxclients=0)
	channelSpacerGetType (int $cid)
	channelSpacerGetAlign (int $cid)
	channelPermList (int $cid, bool $permsid=false)
	channelPermAssign (int $cid, int\|array $permid, int\|array $permvalue)
	channelPermRemove (int $cid, int\|array $permid)
	channelClientPermList (int $cid, int $cldbid, bool $permsid=false)
	channelClientPermAssign (int $cid, int $cldbid, int\|array $permid, int\|array $permvalue)
	channelClientPermRemove (int $cid, int $cldbid, int\|array $permid)
	channelFileList (int $cid, string $cpw="", string $path="/", bool $recursive=false)
	channelFileInfo (int $cid, string $cpw="", string $name="/")
	channelFileRename (int $cid, string $cpw="", string $oldname="/", string $newname="/", int $tcid=null, string $tcpw=null)
	channelFileDelete (int $cid, string $cpw="", string $name="/")
	channelDirCreate (int $cid, string $cpw="", string $dirname="/")
	channelGetLevel (int $cid)
	channelGetPathway (int $cid)
	channelGetById (int $cid)
	channelGetByName (string $name)
	clientList (array $filter=[])
	clientListReset ()
	clientFind (string $pattern)
	clientListDb (int $offset=null, int $limit=null)
	clientCountDb ()
	clientInfoDb (int $cldbid)
	clientFindDb (string $pattern, bool $uid=false)
	clientCount ()
	clientGetById (int $clid)
	clientGetByName (string $name)
	clientGetByUid (string $uid)
	clientGetByDbid (int $dbid)
	clientGetNameByUid (string $cluid)
	clientGetIdsByUid (string $cluid)
	clientGetNameByDbid (string $cldbid)
	clientGetServerGroupsByDbid (string $cldbid)
	clientMove (int\|Node $clid, int\|Node $cid, $cpw=null)
	clientKick (int $clid, int $reasonid=TeamSpeak3::KICK_CHANNEL, $reasonmsg=null)
	clientPoke (int $clid, string $msg)
	clientBan (int $clid, int $timeseconds=null, string $reason=null)
	clientModifyDb (string $cldbid, array $properties)
	clientDeleteDb (string $cldbid)
	clientSetChannelGroup (int $cldbid, int $cid, int $cgid)
	clientPermList (int $cldbid, bool $permsid=false)
	clientPermAssign (int $cldbid, int\|array $permid, int\|array $permvalue, bool\|array $permskip=false)
	clientPermRemove (int $cldbid, int\|array $permid)
	serverGroupList (array $filter=[])
	serverGroupListReset ()
	serverGroupCreate (string $name, int $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	serverGroupCopy (int $ssgid, string $name=null, int $tsgid=0, int $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	serverGroupRename (int $sgid, string $name)
	serverGroupDelete (int $sgid, bool $force=false)
	serverGroupGetById (int $sgid)
	serverGroupGetByName (string $name, int $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	serverGroupPermList (int $sgid, bool $permsid=false)
	serverGroupPermAssign (int $sgid, int\|array $permid, int\|array $permvalue, int\|array $permnegated=0, bool\|array $permskip=false)
	serverGroupPermRemove (int $sgid, int\|array $permid)
	serverGroupClientList (int $sgid)
	serverGroupClientAdd (int $sgid, int $cldbid)
	serverGroupClientDel (int $sgid, int $cldbid)
	serverGroupGetProfiles (int $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	serverGroupIdentify (int $mode=TeamSpeak3::GROUP_IDENTIFIY_STRONGEST, int $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	channelGroupList (array $filter=[])
	channelGroupListReset ()
	channelGroupCreate (string $name, int $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	channelGroupCopy (int $scgid, string $name=null, int $tcgid=0, int $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	channelGroupRename (int $cgid, string $name)
	channelGroupDelete (int $cgid, bool $force=false)
	channelGroupGetById (int $cgid)
	channelGroupGetByName (string $name, int $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	channelGroupPermList (int $cgid, bool $permsid=false)
	channelGroupPermAssign (int $cgid, int\|array $permid, int\|array $permvalue)
	channelGroupPermRemove (int $cgid, int\|array $permid)
	channelGroupClientList (int $cgid=null, int $cid=null, int $cldbid=null, bool $resolve=false)
	permReset ()
	permRemoveAny (int $permid)
	transferInitUpload (int $clientftfid, int $cid, string $name, int $size, string $cpw="", bool $overwrite=false, bool $resume=false)
	transferInitDownload (int $clientftfid, int $cid, string $name, string $cpw="", int $seekpos=0)
	transferList ()
	transferStop (int $serverftfid, bool $delete=false)
	iconDownload (string $iconname=null)
	iconUpload (string $data)
	modify (array $properties)
	message (string $msg)
	messageList ()
	messageCreate (string $cluid, string $subject, string $message)
	messageDelete (int $msgid)
	messageRead (int $msgid, bool $flag_read=true)
	snapshotCreate (int $mode=TeamSpeak3::SNAPSHOT_STRING)
	snapshotDeploy (string $data, int $mode=TeamSpeak3::SNAPSHOT_STRING)
	notifyRegister (string $event, int $id=0)
	notifyUnregister ()
	tokenList (bool $translate=false)
	privilegeKeyList (bool $resolve=false)
	tokenCreate (int $id1, int $id2=0, int $type=TeamSpeak3::TOKEN_SERVERGROUP, string $description=null, array $customset=null)
	privilegeKeyCreate (int $id1, int $id2=0, int $type=TeamSpeak3::TOKEN_SERVERGROUP, string $description=null, string $customset=null)
	tokenDelete ($token)
	privilegeKeyDelete (string $token)
	tokenUse ($token)
	privilegeKeyUse (string $token)
	customSearch (string $ident, string $pattern="%")
	customInfo (int $cldbid)
	customSet (int $cldbid, string $ident, string $value)
	customDelete (int $cldbid, string $ident)
	banList ($offset=null, $limit=null)
	banCount ()
	banListClear ()
	banCreate (array $rules, int $timeseconds=null, string $reason=null)
	banDelete (int $banid)
	complaintList (int $tcldbid=null)
	complaintListClear (int $tcldbid)
	complaintCreate (int $tcldbid, string $message)
	complaintDelete (int $tcldbid, int $fcldbid)
	tempPasswordList (bool $resolve=false)
	tempPasswordCreate (string $pw, int $duration, int $tcid=0, string $tcpw="", string $desc="")
	tempPasswordDelete (string $pw)
	logView (int $lines=30, int $begin_pos=null, bool $reverse=null, bool $instance=null)
	logAdd (string $logmsg, int $loglevel=TeamSpeak3::LOGLEVEL_INFO)
	connectionInfo ()
	delete ()
	start ()
	stop (string $msg=null)
	sendPluginCmd (string $plugin, string $data)
	selfUpdate (array $properties)
	selfUpdateLogin (string $username)
	selfPermOverview ()
	isOnline ()
	isOffline ()
	getUniqueId ()
	getIcon ()
	getSymbol ()
	__toString ()
Public Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node
	prepare (string $cmd, array $params=[])
	execute ($cmd, array $params=[])
	getParent ()
	getId ()
	iconIsLocal (string $key)
	iconGetName (string $key)
	getClass (string $prefix="ts3_")
	getViewer (ViewerInterface $viewer)
	getInfo (bool $extend=true, bool $convert=false)
	getProperty (string $property, mixed $default=null)
	toString ()
	toArray ()
	__call (string $name, array $args)
	__sleep ()
	count ()
	current ()
	getChildren ()
	hasChildren ()
	hasNext ()
	key ()
	valid ()
	next ()
	rewind ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	__get ($offset)
	__set ($offset, $value)

Protected Member Functions
	fetchNodeList ()
	fetchNodeInfo ()
Protected Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node
	filterList (array $nodes=[], array $rules=[])
	setStorage (string $key, mixed $val)
	getStorage (string $key, mixed $default=null)
	delStorage (string $key)
	resetNodeInfo ()
	verifyNodeList ()
	resetNodeList ()

Static Protected Member Functions
static	sortClientList (Client $a, Client $b)
static	sortGroupList (Node $a, Node $b)
static	sortFileList (array $a, array $b)

Protected Attributes
array null	$channelList = null
array null	$clientList = null
array null	$sgroupList = null
array null	$cgroupList = null
Protected Attributes inherited from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node
Node null ServerQuery	$parent = null
array null	$server = null
int	$nodeId = 0x00
array null	$nodeList = null
array	$nodeInfo = []
array	$storage = []

Detailed Description

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

Definition at line 20 of file Server.php.

Constructor & Destructor Documentation

◆ __construct()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::__construct	(	Host	$host,
		array	$info,
		string	$index = "virtualserver_id" )

Server constructor.

Parameters

Host	$host
array	$info
string	$index

Exceptions

ServerQueryException

Definition at line 50 of file Server.php.

Member Function Documentation

◆ __toString()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::__toString ( )

Returns a string representation of this node.

Returns: string

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 2712 of file Server.php.

◆ banCount()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::banCount ( )

Returns the number of bans on the selected virtual server.

Returns: integer

Exceptions

AdapterException
ServerQueryException

Definition at line 2260 of file Server.php.

◆ banCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::banCreate	(	array	$rules,
		int	$timeseconds = null,
		string	$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 \| null	$timeseconds
string \| null	$reason

Returns: integer

Exceptions

AdapterException
ServerQueryException

Definition at line 2288 of file Server.php.

◆ banDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::banDelete ( int $banid )

Deletes the specified ban rule from the server.

Parameters

integer $banid

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 2306 of file Server.php.

◆ banList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::banList	(		$offset = null,
			$limit = null )

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

Parameters

null	$offset
null	$limit

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 2248 of file Server.php.

◆ banListClear()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::banListClear ( )

Deletes all active ban rules from the server.

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 2272 of file Server.php.

◆ channelClientPermAssign()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelClientPermAssign	(	int	$cid,
		int	$cldbid,
		int\|array	$permid,
		int\|array	$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 \| integer[]	$permid
integer \| integer[]	$permvalue

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 387 of file Server.php.

◆ channelClientPermList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelClientPermList	(	int	$cid,
		int	$cldbid,
		bool	$permsid = false )

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

Parameters

integer	$cid
integer	$cldbid
boolean	$permsid

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 369 of file Server.php.

◆ channelClientPermRemove()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelClientPermRemove	(	int	$cid,
		int	$cldbid,
		int\|array	$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 \| integer[]	$permid

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 408 of file Server.php.

◆ channelCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelCreate ( array $properties )

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

Parameters

array $properties

Returns: integer

Exceptions

AdapterException
ServerQueryException

Definition at line 142 of file Server.php.

◆ channelDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelDelete	(	int\|Node	$cid,
		bool	$force = false )

Deletes the channel specified by $cid.

Parameters

integer \| Node	$cid
boolean	$force

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 163 of file Server.php.

◆ channelDirCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelDirCreate	(	int	$cid,
		string	$cpw = "",
		string	$dirname = "/" )

Creates new directory in a channels file repository.

Parameters

integer	$cid
string	$cpw
string	$dirname

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 518 of file Server.php.

◆ channelFileDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelFileDelete	(	int	$cid,
		string	$cpw = "",
		string	$name = "/" )

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

Parameters

integer	$cid
string	$cpw
string	$name

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 503 of file Server.php.

◆ channelFileInfo()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelFileInfo	(	int	$cid,
		string	$cpw = "",
		string	$name = "/" )

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

Parameters

integer	$cid
string	$cpw
string	$name

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 467 of file Server.php.

◆ channelFileList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelFileList	(	int	$cid,
		string	$cpw = "",
		string	$path = "/",
		bool	$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

Exceptions

AdapterException
ServerQueryException

Definition at line 430 of file Server.php.

◆ channelFileRename()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelFileRename	(	int	$cid,
		string	$cpw = "",
		string	$oldname = "/",
		string	$newname = "/",
		int	$tcid = null,
		string	$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 \| null	$tcid
string \| null	$tcpw

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 488 of file Server.php.

◆ channelGetById()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGetById ( int $cid )

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Node\Channel object matching the given ID.

Parameters

integer $cid

Returns: Channel

Exceptions

AdapterException
ServerQueryException

Definition at line 571 of file Server.php.

◆ channelGetByName()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGetByName ( string $name )

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Node\Channel object matching the given name.

Parameters

string $name

Returns: Channel

Exceptions

AdapterException
ServerQueryException

Definition at line 588 of file Server.php.

◆ channelGetDefault()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGetDefault ( )

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Node\Channel object representing the default channel.

Returns: Channel

Exceptions

AdapterException
ServerQueryException

Definition at line 123 of file Server.php.

◆ channelGetLevel()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGetLevel ( int $cid )

Returns the level of a channel.

Parameters

integer $cid

Returns: integer

Exceptions

AdapterException
ServerQueryException

Definition at line 531 of file Server.php.

◆ channelGetPathway()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGetPathway ( int $cid )

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

Parameters

integer $cid

Returns: string

Exceptions

AdapterException
ServerQueryException

Definition at line 551 of file Server.php.

◆ channelGroupClientList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGroupClientList	(	int	$cgid = null,
		int	$cid = null,
		int	$cldbid = null,
		bool	$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 \| null	$cgid
integer \| null	$cid
integer \| null	$cldbid
boolean	$resolve

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 1611 of file Server.php.

◆ channelGroupCopy()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGroupCopy	(	int	$scgid,
		string	$name = null,
		int	$tcgid = 0,
		int	$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 \| null	$name
integer	$tcgid
integer	$type

Returns: integer

Exceptions

AdapterException
ServerQueryException

Definition at line 1456 of file Server.php.

◆ channelGroupCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGroupCreate	(	string	$name,
		int	$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

Exceptions

AdapterException
ServerQueryException

Definition at line 1436 of file Server.php.

◆ channelGroupDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGroupDelete	(	int	$cgid,
		bool	$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	$cgid
boolean	$force

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1496 of file Server.php.

◆ channelGroupGetById()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGroupGetById ( int $cgid )

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Node\Channelgroup object matching the given ID.

Parameters

integer $cgid

Returns: ChannelGroup

Exceptions

AdapterException
ServerQueryException

Definition at line 1511 of file Server.php.

◆ channelGroupGetByName()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGroupGetByName	(	string	$name,
		int	$type = TeamSpeak3::GROUP_DBTYPE_REGULAR )

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Node\Channelgroup object matching the given name.

Parameters

string	$name
integer	$type

Returns: ChannelGroup

Exceptions

AdapterException
ServerQueryException

Definition at line 1529 of file Server.php.

◆ channelGroupList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGroupList ( array $filter = [] )

Returns a list of channel groups available.

Parameters

array $filter

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 1402 of file Server.php.

◆ channelGroupListReset()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGroupListReset ( )

Resets the list of channel groups.

Returns: void

Definition at line 1422 of file Server.php.

◆ channelGroupPermAssign()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGroupPermAssign	(	int	$cgid,
		int\|array	$permid,
		int\|array	$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 \| integer[]	$permid
integer \| integer[]	$permvalue

Returns: void

Exceptions

ServerQueryException
AdapterException

Definition at line 1566 of file Server.php.

◆ channelGroupPermList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGroupPermList	(	int	$cgid,
		bool	$permsid = false )

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

Parameters

integer	$cgid
boolean	$permsid

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 1549 of file Server.php.

◆ channelGroupPermRemove()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGroupPermRemove	(	int	$cgid,
		int\|array	$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 \| integer[]	$permid

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1587 of file Server.php.

◆ channelGroupRename()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelGroupRename	(	int	$cgid,
		string	$name )

Renames the channel group specified with $cgid.

Parameters

integer	$cgid
string	$name

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1479 of file Server.php.

◆ channelIsSpacer()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelIsSpacer ( Channel $channel )

Returns TRUE if the given PlanetTeamSpeak\TeamSpeak3Framework\Node\Channel object is a spacer.

Parameters

Channel $channel

Returns: boolean

Definition at line 195 of file Server.php.

◆ channelList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelList ( array $filter = [] )

Returns an array filled with PlanetTeamSpeak\TeamSpeak3Framework\Node\Channel objects.

Parameters

array $filter

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 88 of file Server.php.

◆ channelListReset()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelListReset ( )

Resets the list of channels online.

Returns: void

Definition at line 110 of file Server.php.

◆ channelMove()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelMove	(	int	$cid,
		int	$pid,
		int	$order = null )

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

Parameters

integer	$cid
integer	$pid
integer \| null	$order

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 183 of file Server.php.

◆ channelPermAssign()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelPermAssign	(	int	$cid,
		int\|array	$permid,
		int\|array	$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 \| integer[]	$permid
integer \| integer[]	$permvalue

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 328 of file Server.php.

◆ channelPermList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelPermList	(	int	$cid,
		bool	$permsid = false )

Returns a list of permissions defined for a specific channel.

Parameters

integer	$cid
boolean	$permsid

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 311 of file Server.php.

◆ channelPermRemove()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelPermRemove	(	int	$cid,
		int\|array	$permid )

Removes a set of specified permissions from a channel. Multiple permissions can be removed at once.

Parameters

integer	$cid
integer \| integer[]	$permid

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 348 of file Server.php.

◆ channelSpacerCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelSpacerCreate	(	string	$ident,
		int	$type = TeamSpeak3::SPACER_SOLIDLINE,
		int	$align = TeamSpeak3::SPACER_ALIGN_REPEAT,
		int	$order = null,
		int	$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 \| int	$type
integer	$align
integer \| null	$order
integer	$maxclients

Returns: integer

Exceptions

AdapterException
ServerQueryException

Definition at line 213 of file Server.php.

◆ channelSpacerGetAlign()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelSpacerGetAlign ( int $cid )

Returns the possible alignment of a channel spacer.

Parameters

integer $cid

Returns: integer

Exceptions

AdapterException
ServerQueryException

Definition at line 286 of file Server.php.

◆ channelSpacerGetType()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::channelSpacerGetType ( int $cid )

Returns the possible type of a channel spacer.

Parameters

integer $cid

Returns: integer

Exceptions

AdapterException
ServerQueryException

Definition at line 260 of file Server.php.

◆ clientBan()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientBan	(	int	$clid,
		int	$timeseconds = null,
		string	$reason = null )

Bans the client specified with ID $clid from the server. Please note that this will create three separate ban rules for the targeted clients IP address, the unique identifier and the myTeamSpeak ID (if available).

Parameters

integer	$clid
integer \| null	$timeseconds
string \| null	$reason

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 927 of file Server.php.

◆ clientCount()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientCount ( )

Returns the number of regular clients online.

Returns: integer

Definition at line 717 of file Server.php.

◆ clientCountDb()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientCountDb ( )

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

Returns: integer

Exceptions

AdapterException
ServerQueryException

Definition at line 678 of file Server.php.

◆ clientDeleteDb()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientDeleteDb ( string $cldbid )

Deletes a clients properties from the database.

Parameters

string $cldbid

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 961 of file Server.php.

◆ clientFind()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientFind ( string $pattern )

Returns a list of clients matching a given name pattern.

Parameters

string $pattern

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 650 of file Server.php.

◆ clientFindDb()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientFindDb	(	string	$pattern,
		bool	$uid = false )

Returns a list of client database information 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

Exceptions

AdapterException
ServerQueryException

Definition at line 706 of file Server.php.

◆ clientGetByDbid()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientGetByDbid ( int $dbid )

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Node\Client object matching the given database ID.

Parameters

integer $dbid

Returns: Client

Exceptions

AdapterException
ServerQueryException

Definition at line 789 of file Server.php.

◆ clientGetById()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientGetById ( int $clid )

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Node\Client object matching the given ID.

Parameters

integer $clid

Returns: Client

Exceptions

AdapterException
ServerQueryException

Definition at line 734 of file Server.php.

◆ clientGetByName()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientGetByName ( string $name )

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Node\Client object matching the given name.

Parameters

string $name

Returns: Client

Exceptions

AdapterException
ServerQueryException

Definition at line 751 of file Server.php.

◆ clientGetByUid()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientGetByUid ( string $uid )

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Node\Client object matching the given unique identifier.

Parameters

string $uid

Returns: Client

Exceptions

AdapterException
ServerQueryException

Definition at line 770 of file Server.php.

◆ clientGetIdsByUid()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientGetIdsByUid ( string $cluid )

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

Parameters

string $cluid

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 823 of file Server.php.

◆ clientGetNameByDbid()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientGetNameByDbid ( string $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

Exceptions

AdapterException
ServerQueryException

Definition at line 837 of file Server.php.

◆ clientGetNameByUid()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientGetNameByUid ( string $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

Exceptions

AdapterException
ServerQueryException

Definition at line 809 of file Server.php.

◆ clientGetServerGroupsByDbid()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientGetServerGroupsByDbid ( string $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

Exceptions

AdapterException
ServerQueryException

Definition at line 851 of file Server.php.

◆ clientInfoDb()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientInfoDb ( int $cldbid )

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

Parameters

integer $cldbid

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 691 of file Server.php.

◆ clientKick()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientKick	(	int	$clid,
		int	$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
null	$reasonmsg

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 895 of file Server.php.

◆ clientList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientList ( array $filter = [] )

Returns an array filled with PlanetTeamSpeak\TeamSpeak3Framework\Node\Client objects.

Parameters

array $filter

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 607 of file Server.php.

◆ clientListDb()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientListDb	(	int	$offset = null,
		int	$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 \| null	$offset
integer \| null	$limit

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 665 of file Server.php.

◆ clientListReset()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientListReset ( )

Resets the list of clients online.

Returns: void

Definition at line 636 of file Server.php.

◆ clientModifyDb()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientModifyDb	(	string	$cldbid,
		array	$properties )

Changes the clients properties using given properties.

Parameters

string	$cldbid
array	$properties

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 946 of file Server.php.

◆ clientMove()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientMove	(	int\|Node	$clid,
		int\|Node	$cid,
			$cpw = null )

Moves a client to another channel.

Parameters

int \| Node	$clid
int \| Node	$cid
null	$cpw

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 866 of file Server.php.

◆ clientPermAssign()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientPermAssign	(	int	$cldbid,
		int\|array	$permid,
		int\|array	$permvalue,
		bool\|array	$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 \| integer[]	$permid
integer \| integer[]	$permvalue
bool \| bool[]	$permskip

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1010 of file Server.php.

◆ clientPermList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientPermList	(	int	$cldbid,
		bool	$permsid = false )

Returns a list of permissions defined for a client.

Parameters

integer	$cldbid
boolean	$permsid

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 990 of file Server.php.

◆ clientPermRemove()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientPermRemove	(	int	$cldbid,
		int\|array	$permid )

Removes a set of specified permissions from a client. Multiple permissions can be removed at once.

Parameters

integer	$cldbid
integer \| integer[]	$permid

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1030 of file Server.php.

◆ clientPoke()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientPoke	(	int	$clid,
		string	$msg )

Sends a poke message to a client.

Parameters

integer	$clid
string	$msg

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 911 of file Server.php.

◆ clientSetChannelGroup()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::clientSetChannelGroup	(	int	$cldbid,
		int	$cid,
		int	$cgid )

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

Parameters

integer	$cldbid
integer	$cid
integer	$cgid

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 976 of file Server.php.

◆ complaintCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::complaintCreate	(	int	$tcldbid,
		string	$message )

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

Parameters

integer	$tcldbid
string	$message

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 2347 of file Server.php.

◆ complaintDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::complaintDelete	(	int	$tcldbid,
		int	$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

Exceptions

AdapterException
ServerQueryException

Definition at line 2361 of file Server.php.

◆ complaintList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::complaintList ( int $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 | null $tcldbid

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 2320 of file Server.php.

◆ complaintListClear()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::complaintListClear ( int $tcldbid )

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

Parameters

integer $tcldbid

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 2333 of file Server.php.

◆ connectionInfo()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::connectionInfo ( )

Returns detailed connection information of the virtual server.

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 2461 of file Server.php.

◆ customDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::customDelete	(	int	$cldbid,
		string	$ident )

Removes a custom property from the client specified by $cldbid.

Parameters

integer	$cldbid
string	$ident

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 2234 of file Server.php.

◆ customInfo()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::customInfo ( int $cldbid )

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

Parameters

integer $cldbid

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 2205 of file Server.php.

◆ customSearch()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::customSearch	(	string	$ident,
		string	$pattern = "%" )

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

Parameters

string	$ident
string	$pattern

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 2192 of file Server.php.

◆ customSet()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::customSet	(	int	$cldbid,
		string	$ident,
		string	$value )

Creates or updates a custom property for the client specified by $cldbid.

Parameters

integer	$cldbid
string	$ident
string	$value

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 2220 of file Server.php.

◆ delete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::delete ( )

Deletes the virtual server.

Returns: void

Definition at line 2471 of file Server.php.

◆ fetchNodeInfo()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::fetchNodeInfo ( )

protected

Exceptions

AdapterException
ServerQueryException	@ignore

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 2578 of file Server.php.

◆ fetchNodeList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::fetchNodeList ( )

protected

Exceptions

AdapterException
ServerQueryException	@ignore

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 2562 of file Server.php.

◆ getIcon()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::getIcon ( )

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

Returns: string

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 2686 of file Server.php.

◆ getSymbol()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::getSymbol ( )

Returns a symbol representing the node.

Returns: string

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 2702 of file Server.php.

◆ getUniqueId()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::getUniqueId ( )

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

Returns: string

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 2676 of file Server.php.

◆ iconDownload()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::iconDownload ( string $iconname = null )

Downloads and returns the servers icon file content.

Parameters

string | null $iconname

Returns: StringHelper|void

Exceptions

AdapterException
HelperException
ServerQueryException

Definition at line 1815 of file Server.php.

◆ iconUpload()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::iconUpload ( string $data )

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

Parameters

string $data

Returns: integer

Exceptions

AdapterException
HelperException
ServerQueryException

Definition at line 1846 of file Server.php.

◆ isOffline()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::isOffline ( )

Returns TRUE if the virtual server is offline.

Returns: boolean

Definition at line 2666 of file Server.php.

◆ isOnline()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::isOnline ( )

Returns TRUE if the virtual server is online.

Returns: boolean

Definition at line 2656 of file Server.php.

◆ logAdd()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::logAdd	(	string	$logmsg,
		int	$loglevel = TeamSpeak3::LOGLEVEL_INFO )

Writes a custom entry into the virtual server log.

Parameters

string	$logmsg
integer	$loglevel

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 2449 of file Server.php.

◆ logView()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::logView	(	int	$lines = 30,
		int	$begin_pos = null,
		bool	$reverse = null,
		bool	$instance = null )

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

Parameters

integer	$lines
integer \| null	$begin_pos
boolean \| null	$reverse
boolean \| null	$instance

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 2434 of file Server.php.

◆ message()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::message ( string $msg )

Sends a text message to all clients on the virtual server.

Parameters

string $msg

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1881 of file Server.php.

◆ messageCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::messageCreate	(	string	$cluid,
		string	$subject,
		string	$message )

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

Parameters

string	$cluid
string	$subject
string	$message

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1909 of file Server.php.

◆ messageDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::messageDelete ( int $msgid )

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

Parameters

integer $msgid

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1922 of file Server.php.

◆ messageList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::messageList ( )

Returns a list of offline messages you've received. The output contains the senders unique identifier, the messages subject, etc.

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 1894 of file Server.php.

◆ messageRead()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::messageRead	(	int	$msgid,
		bool	$flag_read = true )

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

Parameters

integer	$msgid
boolean	$flag_read

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 1936 of file Server.php.

◆ modify()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::modify ( array $properties )

Changes the virtual server configuration using given properties.

Parameters

array $properties

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1867 of file Server.php.

◆ notifyRegister()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::notifyRegister	(	string	$event,
		int	$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

Exceptions

AdapterException
ServerQueryException

Definition at line 2011 of file Server.php.

◆ notifyUnregister()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::notifyUnregister ( )

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

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 2024 of file Server.php.

◆ permRemoveAny()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::permRemoveAny ( int $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

Exceptions

AdapterException
ServerQueryException

Definition at line 1664 of file Server.php.

◆ permReset()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::permReset ( )

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

Returns: StringHelper

Exceptions

AdapterException
ServerQueryException

Definition at line 1646 of file Server.php.

◆ privilegeKeyCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::privilegeKeyCreate	(	int	$id1,
		int	$id2 = 0,
		int	$type = TeamSpeak3::TOKEN_SERVERGROUP,
		string	$description = null,
		string	$customset = null )

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

Parameters

integer	$id1
integer	$id2
integer	$type
string \| null	$description
string \| null	$customset

Returns: StringHelper

Exceptions

AdapterException
ServerQueryException

Definition at line 2115 of file Server.php.

◆ privilegeKeyDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::privilegeKeyDelete ( string $token )

Deletes a token specified by key $token.

Parameters

string $token

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 2151 of file Server.php.

◆ privilegeKeyList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::privilegeKeyList ( bool $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

Exceptions

AdapterException
NodeException
ServerQueryException

Definition at line 2055 of file Server.php.

◆ privilegeKeyUse()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::privilegeKeyUse ( string $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

Exceptions

AdapterException
ServerQueryException

Definition at line 2178 of file Server.php.

◆ request()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::request	(	string	$cmd,
		bool	$throw = true )

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

Parameters

string	$cmd
boolean	$throw

Returns: Reply

Exceptions

AdapterException
ServerQueryException

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 71 of file Server.php.

◆ selfPermOverview()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::selfPermOverview ( )

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

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 2551 of file Server.php.

◆ selfUpdate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::selfUpdate ( array $properties )

Changes the properties of your own client connection.

Parameters

array $properties

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 2519 of file Server.php.

◆ selfUpdateLogin()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::selfUpdateLogin ( string $username )

Updates your own ServerQuery login credentials using a specified username. The password will be auto-generated.

Parameters

string $username

Returns: StringHelper

Exceptions

AdapterException
ServerQueryException

Definition at line 2537 of file Server.php.

◆ sendPluginCmd()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::sendPluginCmd	(	string	$plugin,
		string	$data )

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

Parameters

string	$plugin
string	$data

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 2506 of file Server.php.

◆ serverGroupClientAdd()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupClientAdd	(	int	$sgid,
		int	$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

Exceptions

AdapterException
ServerQueryException

Definition at line 1277 of file Server.php.

◆ serverGroupClientDel()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupClientDel	(	int	$sgid,
		int	$cldbid )

Removes a client from the server group specified.

Parameters

integer	$sgid
integer	$cldbid

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1293 of file Server.php.

◆ serverGroupClientList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupClientList ( int $sgid )

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

Parameters

integer $sgid

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 1258 of file Server.php.

◆ serverGroupCopy()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupCopy	(	int	$ssgid,
		string	$name = null,
		int	$tsgid = 0,
		int	$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 \| null	$name
integer	$tsgid
integer	$type

Returns: integer

Exceptions

AdapterException
ServerQueryException

Definition at line 1104 of file Server.php.

◆ serverGroupCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupCreate	(	string	$name,
		int	$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

Exceptions

AdapterException
ServerQueryException

Definition at line 1084 of file Server.php.

◆ serverGroupDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupDelete	(	int	$sgid,
		bool	$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

Exceptions

AdapterException
ServerQueryException

Definition at line 1144 of file Server.php.

◆ serverGroupGetById()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupGetById ( int $sgid )

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Node\Servergroup object matching the given ID.

Parameters

integer $sgid

Returns: ServerGroup

Exceptions

AdapterException
NodeException
ServerQueryException

Definition at line 1160 of file Server.php.

◆ serverGroupGetByName()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupGetByName	(	string	$name,
		int	$type = TeamSpeak3::GROUP_DBTYPE_REGULAR )

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Node\Servergroup object matching the given name.

Parameters

string	$name
integer	$type

Returns: ServerGroup

Exceptions

AdapterException
NodeException
ServerQueryException

Definition at line 1179 of file Server.php.

◆ serverGroupGetProfiles()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupGetProfiles ( int $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

Exceptions

AdapterException
NodeException
ServerQueryException

Definition at line 1308 of file Server.php.

◆ serverGroupIdentify()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupIdentify	(	int	$mode = TeamSpeak3::GROUP_IDENTIFIY_STRONGEST,
		int	$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: ServerGroup

Exceptions

AdapterException
NodeException
ServerQueryException

Definition at line 1383 of file Server.php.

◆ serverGroupList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupList ( array $filter = [] )

Returns a list of server groups available.

Parameters

array $filter

Returns: array

Exceptions

AdapterException
NodeException
ServerQueryException

Definition at line 1050 of file Server.php.

◆ serverGroupListReset()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupListReset ( )

Resets the list of server groups.

Returns: void

Definition at line 1070 of file Server.php.

◆ serverGroupPermAssign()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupPermAssign	(	int	$sgid,
		int\|array	$permid,
		int\|array	$permvalue,
		int\|array	$permnegated = 0,
		bool\|array	$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 \| integer[]	$permid
integer \| integer[]	$permvalue
integer \| integer[]	$permnegated
bool \| bool[]	$permskip

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1218 of file Server.php.

◆ serverGroupPermList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupPermList	(	int	$sgid,
		bool	$permsid = false )

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

Parameters

integer	$sgid
boolean	$permsid

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 1199 of file Server.php.

◆ serverGroupPermRemove()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupPermRemove	(	int	$sgid,
		int\|array	$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 \| integer[]	$permid

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1239 of file Server.php.

◆ serverGroupRename()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::serverGroupRename	(	int	$sgid,
		string	$name )

Renames the server group specified with $sgid.

Parameters

integer	$sgid
string	$name

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1127 of file Server.php.

◆ snapshotCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::snapshotCreate ( int $mode = TeamSpeak3::SNAPSHOT_STRING )

Creates and returns snapshot data for the selected virtual server.

Parameters

int $mode

Returns: string

Exceptions

AdapterException
ServerQueryException

Definition at line 1955 of file Server.php.

◆ snapshotDeploy()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::snapshotDeploy	(	string	$data,
		int	$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
int	$mode

Returns: array

Exceptions

AdapterException
HelperException
ServerQueryException

Definition at line 1977 of file Server.php.

◆ sortClientList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::sortClientList	(	Client	$a,
		Client	$b )

staticprotected

Internal callback funtion for sorting of client objects.

Parameters

Client	$a
Client	$b

Returns: integer

Definition at line 2590 of file Server.php.

◆ sortFileList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::sortFileList	(	array	$a,
		array	$b )

staticprotected

Internal callback funtion for sorting of file list items.

Parameters

array	$a
array	$b

Returns: integer

Definition at line 2638 of file Server.php.

◆ sortGroupList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::sortGroupList	(	Node	$a,
		Node	$b )

staticprotected

Internal callback funtion for sorting of group objects.

Parameters

Node	$a
Node	$b

Returns: integer

Definition at line 2614 of file Server.php.

◆ start()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::start ( )

Starts the virtual server.

Returns: void

Definition at line 2481 of file Server.php.

◆ stop()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::stop ( string $msg = null )

Stops the virtual server.

Parameters

string | null $msg

Returns: void

Definition at line 2492 of file Server.php.

◆ tempPasswordCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::tempPasswordCreate	(	string	$pw,
		int	$duration,
		int	$tcid = 0,
		string	$tcpw = "",
		string	$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

Exceptions

AdapterException
ServerQueryException

Definition at line 2405 of file Server.php.

◆ tempPasswordDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::tempPasswordDelete ( string $pw )

Deletes the temporary server password specified with $pw.

Parameters

string $pw

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 2418 of file Server.php.

◆ tempPasswordList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::tempPasswordList ( bool $resolve = false )

Returns a list of temporary server passwords.

Parameters

boolean $resolve

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 2374 of file Server.php.

◆ tokenCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::tokenCreate	(	int	$id1,
		int	$id2 = 0,
		int	$type = TeamSpeak3::TOKEN_SERVERGROUP,
		string	$description = null,
		array	$customset = null )

Alias for privilegeKeyCreate().

Parameters

int	$id1
int	$id2
int	$type
string \| null	$description
array \| null	$customset

Returns: StringHelper

Exceptions

AdapterException
ServerQueryException

Deprecated

Definition at line 2094 of file Server.php.

◆ tokenDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::tokenDelete ( $token )

Alias for privilegeKeyDelete().

Parameters

$token

Exceptions

AdapterException
ServerQueryException

Deprecated

Definition at line 2138 of file Server.php.

◆ tokenList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::tokenList ( bool $translate = false )

Alias for privilegeKeyList().

Parameters

bool $translate

Returns: array

Exceptions

AdapterException
NodeException
ServerQueryException

Deprecated

Definition at line 2039 of file Server.php.

◆ tokenUse()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::tokenUse ( $token )

Alias for privilegeKeyUse().

Parameters

$token

Exceptions

AdapterException
ServerQueryException

Deprecated

Definition at line 2164 of file Server.php.

◆ transferInitDownload()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::transferInitDownload	(	int	$clientftfid,
		int	$cid,
		string	$name,
		string	$cpw = "",
		int	$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

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 1755 of file Server.php.

◆ transferInitUpload()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::transferInitUpload	(	int	$clientftfid,
		int	$cid,
		string	$name,
		int	$size,
		string	$cpw = "",
		bool	$overwrite = false,
		bool	$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

Returns: array

Exceptions

AdapterException
ServerQueryException

Definition at line 1712 of file Server.php.

◆ transferList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::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

Exceptions

AdapterException
ServerQueryException

Definition at line 1787 of file Server.php.

◆ transferStop()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::transferStop	(	int	$serverftfid,
		bool	$delete = false )

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

Parameters

integer	$serverftfid
boolean	$delete

Returns: void

Exceptions

AdapterException
ServerQueryException

Definition at line 1801 of file Server.php.

Member Data Documentation

◆ $cgroupList

array null PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::$cgroupList = null

protected

@ignore

Definition at line 40 of file Server.php.

◆ $channelList

array null PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::$channelList = null

protected

@ignore

Definition at line 25 of file Server.php.

◆ $clientList

array null PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::$clientList = null

protected

@ignore

Definition at line 30 of file Server.php.

◆ $sgroupList

array null PlanetTeamSpeak\TeamSpeak3Framework\Node\Server::$sgroupList = null

protected

@ignore

Definition at line 35 of file Server.php.

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

src/Node/Server.php

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ banCount()

◆ banCreate()

◆ banDelete()

◆ banList()

◆ banListClear()

◆ channelClientPermAssign()

◆ channelClientPermList()

◆ channelClientPermRemove()

◆ channelCreate()

◆ channelDelete()

◆ channelDirCreate()

◆ channelFileDelete()

◆ channelFileInfo()

◆ channelFileList()

◆ channelFileRename()

◆ channelGetById()

◆ channelGetByName()

◆ channelGetDefault()

◆ channelGetLevel()

◆ channelGetPathway()

◆ channelGroupClientList()

◆ channelGroupCopy()

◆ channelGroupCreate()

◆ channelGroupDelete()

◆ channelGroupGetById()

◆ channelGroupGetByName()

◆ channelGroupList()

◆ channelGroupListReset()

◆ channelGroupPermAssign()

◆ channelGroupPermList()

◆ channelGroupPermRemove()

◆ channelGroupRename()

◆ channelIsSpacer()

◆ channelList()

◆ channelListReset()

◆ channelMove()

◆ channelPermAssign()

◆ channelPermList()

◆ channelPermRemove()

◆ channelSpacerCreate()

◆ channelSpacerGetAlign()

◆ channelSpacerGetType()

◆ clientBan()

◆ clientCount()

◆ clientCountDb()

◆ clientDeleteDb()

◆ clientFind()

◆ clientFindDb()

◆ clientGetByDbid()

◆ clientGetById()

◆ clientGetByName()

◆ clientGetByUid()

◆ clientGetIdsByUid()

◆ clientGetNameByDbid()

◆ clientGetNameByUid()

◆ clientGetServerGroupsByDbid()

◆ clientInfoDb()

◆ clientKick()

◆ clientList()

◆ clientListDb()

◆ clientListReset()

◆ clientModifyDb()

◆ clientMove()

◆ clientPermAssign()

◆ clientPermList()

◆ clientPermRemove()

◆ clientPoke()

◆ clientSetChannelGroup()

◆ complaintCreate()

◆ complaintDelete()

◆ complaintList()