Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup:

Public Member Functions
	__construct (Server $server, array $info, string $index="sgid")
	rename (string $name)
	delete (bool $force=false)
	copy (string $name=null, int $tsgid=0, int $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	permList (bool $permsid=false)
	permAssign (int $permid, int $permvalue, int $permnegated=0, int $permskip=0)
	permAssignByName ($permname, $permvalue, $permnegated=false, $permskip=false)
	permRemove (int $permid)
	permRemoveByName ($permname)
	clientList ()
	clientAdd (int $cldbid)
	clientDel (int $cldbid)
	tokenCreate ($description=null, $customset=null)
	privilegeKeyCreate (string $description=null, string $customset=null)
	getUniqueId ()
	getIcon ()
Public Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Node\Group
	message (string $msg)
	iconDownload ()
	getSymbol ()
	__toString ()
Public Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node
	request (string $cmd, bool $throw=true)
	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 ()
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)
	fetchNodeInfo ()
	resetNodeInfo ()
	verifyNodeList ()
	resetNodeList ()

Additional Inherited Members
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

Definition at line 13 of file ServerGroup.php.

Constructor & Destructor Documentation

◆ __construct()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::__construct	(	Server	$server,
		array	$info,
		string	$index = "sgid" )

The ServerGroup constructor.

Parameters

Server	$server
array	$info
string	$index

Exceptions

NodeException

Definition at line 23 of file ServerGroup.php.

Member Function Documentation

◆ clientAdd()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::clientAdd ( 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 $cldbid

Returns: void

Definition at line 146 of file ServerGroup.php.

◆ clientDel()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::clientDel ( int $cldbid )

Removes a client from the server group.

Parameters

integer $cldbid

Returns: void

Definition at line 157 of file ServerGroup.php.

◆ clientList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::clientList ( )

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

Returns: array

Definition at line 134 of file ServerGroup.php.

◆ copy()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::copy	(	string	$name = null,
		int	$tsgid = 0,
		int	$type = TeamSpeak3::GROUP_DBTYPE_REGULAR )

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

Parameters

string \| null	$name
integer	$tsgid
integer	$type

Returns: integer

Definition at line 66 of file ServerGroup.php.

◆ delete()

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

Definition at line 53 of file ServerGroup.php.

◆ fetchNodeList()

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

protected

@ignore

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 188 of file ServerGroup.php.

◆ getIcon()

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

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

Returns: string

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 214 of file ServerGroup.php.

◆ getUniqueId()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::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 204 of file ServerGroup.php.

◆ permAssign()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::permAssign	(	int	$permid,
		int	$permvalue,
		int	$permnegated = 0,
		int	$permskip = 0 )

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

Definition at line 92 of file ServerGroup.php.

◆ permAssignByName()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::permAssignByName	(	$permname,
		$permvalue,
		$permnegated = false,
		$permskip = false )

Alias for permAssign().

Deprecated

Definition at line 102 of file ServerGroup.php.

◆ permList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::permList ( bool $permsid = false )

Returns a list of permissions assigned to the server group.

Parameters

boolean $permsid

Returns: array

Definition at line 77 of file ServerGroup.php.

◆ permRemove()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::permRemove ( int $permid )

Removes a set of specified permissions from the server group. Multiple permissions can be removed at once.

Parameters

integer $permid

Returns: void

Definition at line 114 of file ServerGroup.php.

◆ permRemoveByName()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::permRemoveByName ( $permname )

Alias for permRemove().

Deprecated

Definition at line 124 of file ServerGroup.php.

◆ privilegeKeyCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::privilegeKeyCreate	(	string	$description = null,
		string	$customset = null )

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

Parameters

string \| null	$description
string \| null	$customset

Returns: string

Definition at line 179 of file ServerGroup.php.

◆ rename()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::rename ( string $name )

Renames the server group specified.

Parameters

string $name

Returns: void

Definition at line 41 of file ServerGroup.php.

◆ tokenCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup::tokenCreate	(		$description = null,
			$customset = null )

Alias for privilegeKeyCreate().

Deprecated

Definition at line 167 of file ServerGroup.php.

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

src/Node/ServerGroup.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clientAdd()

◆ clientDel()

◆ clientList()

◆ copy()

◆ delete()

◆ fetchNodeList()

◆ getIcon()

◆ getUniqueId()

◆ permAssign()

◆ permAssignByName()

◆ permList()

◆ permRemove()

◆ permRemoveByName()

◆ privilegeKeyCreate()

◆ rename()

◆ tokenCreate()