TeamSpeak3_Node_Servergroup Class Reference

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

Inheritance diagram for TeamSpeak3_Node_Servergroup:

Public Member Functions
	__construct (TeamSpeak3_Node_Server $server, array $info, $index="sgid")
	The TeamSpeak3_Node_Servergroup constructor. More...
	__toString ()
	Returns a string representation of this node. More...
	clientAdd ($cldbid)
	Adds a client to the server group specified. More...
	clientDel ($cldbid)
	Removes a client from the server group. More...
	clientList ()
	Returns a list of clients assigned to the server group specified. More...
	copy ($name=null, $tsgid=0, $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	Creates a copy of the server group and returns the new groups ID. More...
	delete ($force=FALSE)
	Deletes the server group. 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 server groups icon file content. More...
	message ($msg)
	Sends a text message to all clients residing in the server group on the virtual server. More...
	permAssign ($permid, $permvalue, $permnegated=FALSE, $permskip=FALSE)
	Adds a set of specified permissions to the server group. More...
	permAssignByName ($permname, $permvalue, $permnegated=FALSE, $permskip=FALSE)
	Alias for permAssign(). More...
	permList ($permsid=FALSE)
	Returns a list of permissions assigned to the server group. More...
	permRemove ($permid)
	Removes a set of specified permissions from the server group. More...
	permRemoveByName ($permname)
	Alias for permRemove(). More...
	privilegeKeyCreate ($description=null, $customset=null)
	Creates a new privilege key (token) for the server group and returns the key. More...
	rename ($name)
	Renames the server group specified. More...
	tokenCreate ($description=null, $customset=null)
	Alias for privilegeKeyCreate(). 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
	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 ()

Additional Inherited Members
Protected Attributes inherited from TeamSpeak3_Node_Abstract
	$nodeId = 0x00
	$nodeInfo = array()
	$nodeList = null
	$parent = null
	$server = null
	$storage = array()

Detailed Description

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

Constructor & Destructor Documentation

__construct()

__construct	(	TeamSpeak3_Node_Server	$server,
		array	$info,
			$index = "sgid"
	)

The TeamSpeak3_Node_Servergroup constructor.

Parameters

TeamSpeak3_Node_Server	$server
array	$info
string	$index

Exceptions

TeamSpeak3_Node_Exception

Returns

TeamSpeak3_Node_Servergroup

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

 if(!array_key_exists($index, $this->nodeInfo))
 {
 throw new TeamSpeak3_Node_Exception("invalid groupID", 0xA00);
 }

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

Member Function Documentation

__toString()

__toString

(

)

Returns a string representation of this node.

Returns

string

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

clientAdd()

clientAdd

(

$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

$cldbid

Returns

void

 {
 $this->getParent()->serverGroupClientAdd($this->getId(), $cldbid);
 }

clientDel()

clientDel

(

$cldbid

)

Removes a client from the server group.

Parameters

integer

$cldbid

Returns

void

 {
 $this->getParent()->serverGroupClientDel($this->getId(), $cldbid);
 }

clientList()

clientList

(

)

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

Returns

array

 {
 return $this->getParent()->serverGroupClientList($this->getId());
 }

copy()

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

Creates a copy of the server group and returns the new groups ID.

Parameters

string	$name
integer	$tsgid
integer	$type

Returns

integer

 {
 return $this->getParent()->serverGroupCopy($this->getId(), $name, $tsgid, $type);
 }

delete()

delete

(

$force = FALSE

)

Deletes the server group.

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

Parameters

boolean

$force

Returns

void

 {
 $this->getParent()->serverGroupDelete($this->getId(), $force);
 }

getIcon()

getIcon

(

)

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

Returns

string

 {
 return "group_server";
 }

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

iconDownload()

iconDownload

(

)

Downloads and returns the server groups icon file content.

Returns

TeamSpeak3_Helper_String

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

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

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

message()

message

(

$msg

)

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

Parameters

string

$msg

Returns

void

 {
 foreach($this as $client)
 {
 try
 {
 $this->execute("sendtextmessage", array("msg" => $msg, "target" => $client, "targetmode" => TeamSpeak3::TEXTMSG_CLIENT));
 }
 catch(TeamSpeak3_Adapter_ServerQuery_Exception $e)
 {
 /* ERROR_client_invalid_id */
 if($e->getCode() != 0x0200) throw $e;
 }
 }
 }

permAssign()

permAssign	(		$permid,
			$permvalue,
			$permnegated = FALSE,
			$permskip = FALSE
	)

Adds a set of specified permissions to the server group.

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

Parameters

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

Returns

void

 {
 $this->getParent()->serverGroupPermAssign($this->getId(), $permid, $permvalue, $permnegated, $permskip);
 }

permAssignByName()

permAssignByName	(		$permname,
			$permvalue,
			$permnegated = FALSE,
			$permskip = FALSE
	)

Alias for permAssign().

Deprecated:

 {
 $this->permAssign($permname, $permvalue, $permnegated, $permskip);
 }

permList()

permList

(

$permsid = FALSE

)

Returns a list of permissions assigned to the server group.

Parameters

boolean

$permsid

Returns

array

 {
 return $this->getParent()->serverGroupPermList($this->getId(), $permsid);
 }

permRemove()

permRemove

(

$permid

)

Removes a set of specified permissions from the server group.

Multiple permissions can be removed at once.

Parameters

integer

$permid

Returns

void

 {
 $this->getParent()->serverGroupPermRemove($this->getId(), $permid);
 }

permRemoveByName()

permRemoveByName

(

$permname

)

Alias for permRemove().

Deprecated:

 {
 $this->permRemove($permname);
 }

privilegeKeyCreate()

privilegeKeyCreate	(		$description = null,
			$customset = null
	)

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

Parameters

string	$description
string	$customset

Returns

TeamSpeak3_Helper_String

 {
 return $this->getParent()->privilegeKeyCreate(TeamSpeak3::TOKEN_SERVERGROUP, $this->getId(), 0, $description, $customset);
 }

rename()

rename

(

$name

)

Renames the server group specified.

Parameters

string

$name

Returns

void

 {
 $this->getParent()->serverGroupRename($this->getId(), $name);
 }

tokenCreate()

tokenCreate	(		$description = null,
			$customset = null
	)

Alias for privilegeKeyCreate().

Deprecated:

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

---

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

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