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

Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Node\ChannelGroup:

Public Member Functions
	__construct (Server $server, array $info, string $index="cgid")
	rename (string $name)
	delete (bool $force=false)
	copy (string $name=null, int $tcgid=0, int $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	permList (bool $permsid=false)
	permAssign (int $permid, int $permvalue)
	permAssignByName ($permname, $permvalue)
	permRemove (int $permid)
	permRemoveByName ($permname)
	clientList (int $cid=null, int $cldbid=null, bool $resolve=false)
	tokenCreate ($cid, $description=null, $customset=null)
	privilegeKeyCreate (int $cid, 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

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

Definition at line 15 of file ChannelGroup.php.

Constructor & Destructor Documentation

◆ __construct()

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

ChannelGroup constructor.

Parameters

Server	$server
array	$info
string	$index

Exceptions

ServerQueryException

Definition at line 25 of file ChannelGroup.php.

Member Function Documentation

◆ clientList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ChannelGroup::clientList	(	int	$cid = null,
		int	$cldbid = null,
		bool	$resolve = false )

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

Parameters

integer \| null	$cid
integer \| null	$cldbid
boolean	$resolve

Returns: array

Definition at line 137 of file ChannelGroup.php.

◆ copy()

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

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

Parameters

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

Returns: integer

Definition at line 68 of file ChannelGroup.php.

◆ delete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ChannelGroup::delete ( bool $force = false )

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

Parameters

boolean $force

Returns: void

Definition at line 55 of file ChannelGroup.php.

◆ fetchNodeList()

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

protected

@ignore

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 168 of file ChannelGroup.php.

◆ getIcon()

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

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

Returns: string

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 194 of file ChannelGroup.php.

◆ getUniqueId()

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

◆ permAssign()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ChannelGroup::permAssign	(	int	$permid,
		int	$permvalue )

Adds a set of specified permissions to the channel group. Multiple permissions can be added by providing the two parameters of each permission in separate arrays.

Parameters

integer	$permid
integer	$permvalue

Returns: void

Definition at line 92 of file ChannelGroup.php.

◆ permAssignByName()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ChannelGroup::permAssignByName	(		$permname,
			$permvalue )

Alias for permAssign().

Deprecated

Definition at line 102 of file ChannelGroup.php.

◆ permList()

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

Returns a list of permissions assigned to the channel group.

Parameters

boolean $permsid

Returns: array

Definition at line 79 of file ChannelGroup.php.

◆ permRemove()

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

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

Parameters

integer $permid

Returns: void

Definition at line 114 of file ChannelGroup.php.

◆ permRemoveByName()

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

Alias for permAssign().

Deprecated

Definition at line 124 of file ChannelGroup.php.

◆ privilegeKeyCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\ChannelGroup::privilegeKeyCreate	(	int	$cid,
		string	$description = null,
		string	$customset = null )

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

Parameters

integer	$cid
string \| null	$description
string \| null	$customset

Returns: StringHelper

Definition at line 160 of file ChannelGroup.php.

◆ rename()

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

Renames the channel group specified.

Parameters

string $name

Returns: void

Definition at line 43 of file ChannelGroup.php.

◆ tokenCreate()

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

Alias for privilegeKeyCreate().

Deprecated

Definition at line 147 of file ChannelGroup.php.

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

src/Node/ChannelGroup.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clientList()

◆ copy()

◆ delete()

◆ fetchNodeList()

◆ getIcon()

◆ getUniqueId()

◆ permAssign()

◆ permAssignByName()

◆ permList()

◆ permRemove()

◆ permRemoveByName()

◆ privilegeKeyCreate()

◆ rename()

◆ tokenCreate()