ts3phpframework
Loading...
Searching...
No Matches
PlanetTeamSpeak\TeamSpeak3Framework\Node\Group Class Reference
Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Node\Group:
PlanetTeamSpeak\TeamSpeak3Framework\Node\Node PlanetTeamSpeak\TeamSpeak3Framework\Node\ChannelGroup PlanetTeamSpeak\TeamSpeak3Framework\Node\ServerGroup

Public Member Functions

 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_")
 getUniqueId ()
 getIcon ()
 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)

Additional Inherited Members

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)
 fetchNodeList ()
 fetchNodeInfo ()
 resetNodeInfo ()
 verifyNodeList ()
 resetNodeList ()
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 11 of file Group.php.

Member Function Documentation

◆ __toString()

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

Returns a string representation of this node.

Returns
string

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 75 of file Group.php.

◆ getSymbol()

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

Returns a symbol representing the node.

Returns
string

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 65 of file Group.php.

◆ iconDownload()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Group::iconDownload ( )

Downloads and returns the channel groups icon file content.

Returns
StringHelper|void
Exceptions
AdapterException
HelperException
ServerQueryException

Definition at line 43 of file Group.php.

◆ message()

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

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

Parameters
string$msg
Returns
void
Exceptions
ServerQueryException
AdapterException

Definition at line 21 of file Group.php.


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