ts3phpframework
Loading...
Searching...
No Matches
PlanetTeamSpeak\TeamSpeak3Framework\Node\Host Class Reference

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

Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Node\Host:
PlanetTeamSpeak\TeamSpeak3Framework\Node\Node

Public Member Functions

 __construct (ServerQuery $squery)
 serverSelectedId ()
 serverSelectedPort ()
 version (string $ident=null)
 serverSelect (int $sid, bool $virtual=null)
 serverSelectById (int $sid, bool $virtual=null)
 serverSelectByPort (int $port, bool $virtual=null)
 serverDeselect ()
 serverIdGetByPort (int $port)
 serverGetPortById (int $sid)
 serverGetSelected ()
 serverGetById (int $sid)
 serverGetByPort (int $port)
 serverGetByName (string $name)
 serverGetByUid (string $uid)
 serverCreate (array $properties=[])
 serverDelete (int $sid)
 serverStart (int $sid)
 serverStop (int $sid, string $msg=null)
 serverStopProcess (string $msg=null)
 serverList (array $filter=[])
 serverListReset ()
 bindingList (string $subsystem="voice")
 apiKeyCount ()
 apiKeyList (int $offset=null, int $limit=null, mixed $cldbid=null)
 apiKeyCreate (string $scope=TeamSpeak3::APIKEY_READ, int $lifetime=14, int $cldbid=null)
 apiKeyDelete (int $id)
 permissionList ()
 permissionCats ()
 permissionEnds ()
 permissionTree ()
 permissionFind (int|array $permissionId)
 permissionGetIdByName (string $name)
 permissionGetNameById (int $permissionId)
 permissionGetCategoryById (int $permid)
 permissionGetGrantById (int $permid)
 serverGroupPermAutoAssign (int $sgtype, int|array $permid, int|array $permvalue, int|array $permnegated=0, array|bool $permskip=false)
 serverGroupPermAutoRemove (int $sgtype, int|array $permid)
 selfPermCheck (int|array $permid)
 modify (array $properties)
 message (string $msg)
 logView (int $lines=30, int $begin_pos=null, bool $reverse=null, bool $instance=true)
 logAdd (string $logmsg, int $loglevel=TeamSpeak3::LOGLEVEL_INFO)
 login (string $username, string $password)
 logout ()
 queryCountLogin (string $pattern=null)
 queryListLogin (int $offset=null, int $limit=null, string $pattern=null)
 queryLoginCreate (string $username, int $cldbid=0)
 queryLoginDelete (int $cldbid)
 whoami ()
 whoamiGet (string $ident, mixed $default=null)
 whoamiSet (string $ident, mixed $value=null)
 whoamiReset ()
 getAdapterHost ()
 getAdapterPort ()
 setPredefinedQueryName (string $name=null)
 getPredefinedQueryName ()
 setExcludeQueryClients (bool $exclude=false)
 getExcludeQueryClients ()
 setUseOfflineAsVirtual (bool $virtual=false)
 getUseOfflineAsVirtual ()
 setLoadClientlistFirst (bool $first=false)
 getLoadClientlistFirst ()
 getAdapter ()
 getUniqueId ()
 getIcon ()
 getSymbol ()
 __wakeup ()
 __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 ()
 fetchNodeInfo ()
 fetchPermissionList ()
 fetchPermissionCats ()
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 ()

Protected Attributes

array null $whoami = null
array null $version = null
array null $serverList = null
array null $permissionEnds = null
array null $permissionList = null
array null $permissionCats = null
string null $predefined_query_name = null
bool $exclude_query_clients = false
bool $start_offline_virtual = false
bool $sort_clients_channels = false
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 server instance and all it's parameters.

Definition at line 22 of file Host.php.

Constructor & Destructor Documentation

◆ __construct()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::__construct ( ServerQuery $squery)

The PlanetTeamSpeak\TeamSpeak3Framework\Node\Host constructor.

Parameters
ServerQuery$squery

Definition at line 79 of file Host.php.

Member Function Documentation

◆ __toString()

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

Returns a string representation of this node.

Returns
string

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 1322 of file Host.php.

◆ __wakeup()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::__wakeup ( )

Re-authenticates with the TeamSpeak 3 Server instance using given ServerQuery login credentials and re-selects a previously selected virtual server.

Exceptions
AdapterException
HelperException
ServerQueryException

Definition at line 1293 of file Host.php.

◆ apiKeyCount()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::apiKeyCount ( )

Returns the number of WebQuery API keys known by the virtual server.

Returns
integer
Exceptions
AdapterException
ServerQueryException

Definition at line 491 of file Host.php.

◆ apiKeyCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::apiKeyCreate ( string $scope = TeamSpeak3::APIKEY_READ,
int $lifetime = 14,
int $cldbid = null )

Creates a new WebQuery API key and returns an assoc array containing its details. Use $lifetime to specify the API key lifetime in days. Setting $lifetime to 0 means the key will be valid forever. $cldbid defaults to the invoker database ID.

Parameters
string$scope
integer$lifetime
integer | null$cldbid
Returns
array
Exceptions
AdapterException
ServerQueryException

Definition at line 525 of file Host.php.

◆ apiKeyDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::apiKeyDelete ( int $id)

Deletes an API key specified by $id.

Parameters
integer$id
Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 542 of file Host.php.

◆ apiKeyList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::apiKeyList ( int $offset = null,
int $limit = null,
mixed $cldbid = null )

Returns a list of WebQuery API keys known by the virtual server. By default, the server spits out 25 entries at once. When no $cldbid is specified, API keys for the invoker are returned. In addition, using '*' as $cldbid will return all known API keys.

Parameters
integer | null$offset
integer | null$limit
mixed | null$cldbid
Returns
array
Exceptions
AdapterException
ServerQueryException

Definition at line 508 of file Host.php.

◆ bindingList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::bindingList ( string $subsystem = "voice")

Returns a list of IP addresses used by the server instance on multi-homed machines.

Parameters
string$subsystem
Returns
array
Exceptions
AdapterException
ServerQueryException

Definition at line 479 of file Host.php.

◆ fetchNodeInfo()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::fetchNodeInfo ( )
protected
Exceptions
AdapterException
ServerQueryException@ignore

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 1098 of file Host.php.

◆ fetchNodeList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::fetchNodeList ( )
protected
Exceptions
AdapterException
ServerQueryException@ignore

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 1084 of file Host.php.

◆ fetchPermissionCats()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::fetchPermissionCats ( )
protected

@ignore

Definition at line 1131 of file Host.php.

◆ fetchPermissionList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::fetchPermissionList ( )
protected
Exceptions
AdapterException
ServerQueryException@ignore

Definition at line 1111 of file Host.php.

◆ getAdapter()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::getAdapter ( )

Returns the underlying PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery object.

Returns
ServerQuery

Definition at line 1250 of file Host.php.

◆ getAdapterHost()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::getAdapterHost ( )

Returns the hostname or IPv4 address the adapter is connected to.

Returns
string

Definition at line 1064 of file Host.php.

◆ getAdapterPort()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::getAdapterPort ( )

Returns the network port the adapter is connected to.

Returns
string

Definition at line 1074 of file Host.php.

◆ getExcludeQueryClients()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::getExcludeQueryClients ( )

Returns the option to decide whether ServerQuery clients should be excluded from node lists or not.

Returns
boolean

Definition at line 1191 of file Host.php.

◆ getIcon()

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

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

Returns
string

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 1270 of file Host.php.

◆ getLoadClientlistFirst()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::getLoadClientlistFirst ( )

Returns the option to decide whether offline servers will be started in virtual mode by default or not.

Returns
boolean

Definition at line 1240 of file Host.php.

◆ getPredefinedQueryName()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::getPredefinedQueryName ( )

Returns the pre-defined nickname for ServerQuery clients which will be used automatically after selecting a virtual server.

Returns
string|null

Definition at line 1166 of file Host.php.

◆ getSymbol()

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

Returns a symbol representing the node.

Returns
string

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 1280 of file Host.php.

◆ getUniqueId()

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

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

Returns
string

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Node\Node.

Definition at line 1260 of file Host.php.

◆ getUseOfflineAsVirtual()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::getUseOfflineAsVirtual ( )

Returns the option to decide whether offline servers will be started in virtual mode by default or not.

Returns
boolean

Definition at line 1216 of file Host.php.

◆ logAdd()

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

Writes a custom entry into the server instance log.

Parameters
string$logmsg
integer$loglevel
Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 891 of file Host.php.

◆ login()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::login ( string $username,
string $password )

Authenticates with the TeamSpeak 3 Server instance using given ServerQuery login credentials.

Parameters
string$username
string$password
Returns
void
Exceptions
AdapterException
HelperException
ServerQueryException

Definition at line 910 of file Host.php.

◆ logout()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::logout ( )

Deselects the active virtual server and logs out from the server instance.

Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 930 of file Host.php.

◆ logView()

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

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

Parameters
integer$lines
integer | null$begin_pos
boolean | null$reverse
boolean$instance
Returns
array
Exceptions
AdapterException
ServerQueryException

Definition at line 877 of file Host.php.

◆ message()

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

Sends a text message to all clients on all virtual servers in the TeamSpeak 3 Server instance.

Parameters
string$msg
Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 861 of file Host.php.

◆ modify()

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

Changes the server instance configuration using given properties.

Parameters
array$properties
Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 847 of file Host.php.

◆ permissionCats()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::permissionCats ( )

Returns a list of permission categories available on the server instance.

Returns
array

Definition at line 587 of file Host.php.

◆ permissionEnds()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::permissionEnds ( )

Returns a list of permission category endings available on the server instance.

Returns
array
Exceptions
AdapterException
ServerQueryException

Definition at line 603 of file Host.php.

◆ permissionFind()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::permissionFind ( int|array $permissionId)

Returns the IDs of all clients, channels or groups using the permission with the specified ID.

Parameters
integer | integer[]$permissionId
Returns
array
Exceptions
ServerQueryException
AdapterException

Definition at line 664 of file Host.php.

◆ permissionGetCategoryById()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::permissionGetCategoryById ( int $permid)

Returns the internal category of the permission matching the given ID.

All pre-3.0.7 permission IDs are 2 bytes wide. The first byte identifies the category while the second byte is the permission count within that group.

Parameters
integer$permid
Returns
integer
Exceptions
AdapterException
ServerQueryException

Definition at line 722 of file Host.php.

◆ permissionGetGrantById()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::permissionGetGrantById ( int $permid)

Returns the internal ID of the i_needed_modify_power_* or grant permission.

Every permission has an associated i_needed_modify_power_* permission, for example b_client_ban_create has an associated permission called i_needed_modify_power_client_ban_create.

Parameters
integer$permid
Returns
integer
Exceptions
AdapterException
ServerQueryException

Definition at line 762 of file Host.php.

◆ permissionGetIdByName()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::permissionGetIdByName ( string $name)

Returns the ID of the permission matching the given name.

Parameters
string$name
Returns
integer
Exceptions
AdapterException
ServerQueryException

Definition at line 683 of file Host.php.

◆ permissionGetNameById()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::permissionGetNameById ( int $permissionId)

Returns the name of the permission matching the given ID.

Parameters
integer$permissionId
Returns
StringHelper
Exceptions
AdapterException
ServerQueryException

Definition at line 700 of file Host.php.

◆ permissionList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::permissionList ( )

Returns a list of permissions available on the server instance.

Returns
array
Exceptions
AdapterException
ServerQueryException

Definition at line 554 of file Host.php.

◆ permissionTree()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::permissionTree ( )

Returns an array filled with all permission categories known to the server including their ID, name and parent.

Returns
array
Exceptions
AdapterException
ServerQueryException

Definition at line 620 of file Host.php.

◆ queryCountLogin()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::queryCountLogin ( string $pattern = null)

Returns the number of ServerQuery logins on the selected virtual server.

Parameters
string | null$pattern
Returns
mixed
Exceptions
ServerQueryException
AdapterException

Definition at line 949 of file Host.php.

◆ queryListLogin()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::queryListLogin ( int $offset = null,
int $limit = null,
string $pattern = null )

Returns a list of ServerQuery logins on the selected virtual server. By default, the server spits out 25 entries at once.

Parameters
integer | null$offset
integer | null$limit
string | null$pattern
Returns
array
Exceptions
AdapterException
ServerQueryException

Definition at line 965 of file Host.php.

◆ queryLoginCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::queryLoginCreate ( string $username,
int $cldbid = 0 )

Creates a new ServerQuery login, or enables ServerQuery logins for an existing client. When no virtual server is selected, the command will create global ServerQuery login, otherwise a ServerQuery login will be added for an existing client (cldbid must be specified).

Parameters
string$username
int$cldbid
Returns
array
Exceptions
AdapterException
ServerQueryException

Definition at line 981 of file Host.php.

◆ queryLoginDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::queryLoginDelete ( int $cldbid)

Deletes an existing ServerQuery login.

Parameters
integer$cldbid
Exceptions
AdapterException
ServerQueryException

Definition at line 997 of file Host.php.

◆ selfPermCheck()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::selfPermCheck ( int|array $permid)

Returns an array containing the value of a specified permission for your own client.

Parameters
integer | integer[]$permid
Returns
array
Exceptions
AdapterException
ServerQueryException

Definition at line 828 of file Host.php.

◆ serverCreate()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverCreate ( array $properties = [])

Creates a new virtual server using given properties and returns an assoc array containing the new ID and initial admin token.

Parameters
array$properties
Returns
array
Exceptions
AdapterException
ServerQueryException

Definition at line 346 of file Host.php.

◆ serverDelete()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverDelete ( int $sid)

Deletes the virtual server specified by ID.

Parameters
integer$sid
Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 367 of file Host.php.

◆ serverDeselect()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverDeselect ( )

Deselects the active virtual server.

Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 218 of file Host.php.

◆ serverGetById()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverGetById ( int $sid)

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

Parameters
integer$sid
Returns
Server
Exceptions
AdapterException
ServerQueryException

Definition at line 277 of file Host.php.

◆ serverGetByName()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverGetByName ( string $name)

Returns the first PlanetTeamSpeak\TeamSpeak3Framework\Node\Server object matching the given name.

Parameters
string$name
Returns
Server
Exceptions
AdapterException
ServerQueryException

Definition at line 307 of file Host.php.

◆ serverGetByPort()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverGetByPort ( int $port)

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Node\Server object matching the given port number.

Parameters
integer$port
Returns
Server
Exceptions
AdapterException
ServerQueryException

Definition at line 292 of file Host.php.

◆ serverGetByUid()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverGetByUid ( string $uid)

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

Parameters
string$uid
Returns
Server
Exceptions
AdapterException
ServerQueryException

Definition at line 326 of file Host.php.

◆ serverGetPortById()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverGetPortById ( int $sid)

Returns the port of a virtual server matching the given ID.

Parameters
integer$sid
Returns
integer
Exceptions
AdapterException
ServerQueryException

Definition at line 248 of file Host.php.

◆ serverGetSelected()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverGetSelected ( )

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Node\Server object matching the currently selected ID.

Returns
Server
Exceptions
AdapterException
ServerQueryException

Definition at line 264 of file Host.php.

◆ serverGroupPermAutoAssign()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverGroupPermAutoAssign ( int $sgtype,
int|array $permid,
int|array $permvalue,
int|array $permnegated = 0,
array|bool $permskip = false )

Adds a set of specified permissions to all regular server groups on all virtual servers. The target groups will be identified by the value of their i_group_auto_update_type permission specified with $sgtype.

Parameters
integer$sgtype
integer | integer[]$permid
integer | integer[]$permvalue
integer | integer[]$permnegated
bool | bool[]$permskip
Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 788 of file Host.php.

◆ serverGroupPermAutoRemove()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverGroupPermAutoRemove ( int $sgtype,
int|array $permid )

Removes a set of specified permissions from all regular server groups on all virtual servers. The target groups will be identified by the value of their i_group_auto_update_type permission specified with $sgtype.

Parameters
integer$sgtype
integer | integer[]$permid
Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 809 of file Host.php.

◆ serverIdGetByPort()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverIdGetByPort ( int $port)

Returns the ID of a virtual server matching the given port.

Parameters
integer$port
Returns
integer
Exceptions
AdapterException
ServerQueryException

Definition at line 233 of file Host.php.

◆ serverList()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverList ( array $filter = [])

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

Parameters
array$filter
Returns
array|Server
Exceptions
AdapterException
ServerQueryException

Definition at line 443 of file Host.php.

◆ serverListReset()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverListReset ( )

Resets the list of virtual servers.

Returns
void

Definition at line 465 of file Host.php.

◆ serverSelect()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverSelect ( int $sid,
bool $virtual = null )

Selects a virtual server by ID to allow further interaction. todo remove additional clientupdate call (breaks compatibility with server versions <= 3.4.0)

Parameters
integer$sid
boolean | null$virtual
Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 135 of file Host.php.

◆ serverSelectById()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverSelectById ( int $sid,
bool $virtual = null )

Alias for serverSelect().

Parameters
integer$sid
boolean | null$virtual
Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 170 of file Host.php.

◆ serverSelectByPort()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverSelectByPort ( int $port,
bool $virtual = null )

Selects a virtual server by UDP port to allow further interaction.

Parameters
integer$port
boolean | null$virtual
Returns
void
Exceptions
AdapterException
ServerQueryException
Todo
remove additional clientupdate call (breaks compatibility with server versions <= 3.4.0)

Definition at line 185 of file Host.php.

◆ serverSelectedId()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverSelectedId ( )

Returns the primary ID of the selected virtual server.

Returns
integer
Exceptions
AdapterException
ServerQueryException

Definition at line 91 of file Host.php.

◆ serverSelectedPort()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverSelectedPort ( )

Returns the primary UDP port of the selected virtual server.

Returns
integer
Exceptions
AdapterException
ServerQueryException

Definition at line 103 of file Host.php.

◆ serverStart()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverStart ( int $sid)

Starts the virtual server specified by ID.

Parameters
integer$sid
Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 387 of file Host.php.

◆ serverStop()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverStop ( int $sid,
string $msg = null )

Stops the virtual server specified by ID.

Parameters
integer$sid
string | null$msg
Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 408 of file Host.php.

◆ serverStopProcess()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::serverStopProcess ( string $msg = null)

Stops the entire TeamSpeak 3 Server instance by shutting down the process.

Parameters
string | null$msg
Returns
void
Exceptions
AdapterException
ServerQueryException

Definition at line 428 of file Host.php.

◆ setExcludeQueryClients()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::setExcludeQueryClients ( bool $exclude = false)

Sets the option to decide whether ServerQuery clients should be excluded from node lists or not.

Parameters
boolean$exclude
Returns
void

Definition at line 1178 of file Host.php.

◆ setLoadClientlistFirst()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::setLoadClientlistFirst ( bool $first = false)

Sets the option to decide whether clients should be sorted before sub-channels to support the new TeamSpeak 3 Client display mode or not.

Parameters
boolean$first

Definition at line 1227 of file Host.php.

◆ setPredefinedQueryName()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::setPredefinedQueryName ( string $name = null)

Sets a pre-defined nickname for ServerQuery clients which will be used automatically after selecting a virtual server.

Parameters
string | null$name

Definition at line 1153 of file Host.php.

◆ setUseOfflineAsVirtual()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::setUseOfflineAsVirtual ( bool $virtual = false)

Sets the option to decide whether offline servers will be started in virtual mode by default or not.

Parameters
boolean$virtual
Returns
void

Definition at line 1203 of file Host.php.

◆ version()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::version ( string $ident = null)

Returns the servers version information including platform and build number.

Parameters
string | null$ident
Returns
mixed
Exceptions
AdapterException
ServerQueryException

Definition at line 116 of file Host.php.

◆ whoami()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::whoami ( )

Returns information about your current ServerQuery connection.

Returns
array
Exceptions
AdapterException
ServerQueryException

Definition at line 1009 of file Host.php.

◆ whoamiGet()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::whoamiGet ( string $ident,
mixed $default = null )

Returns a single value from the current ServerQuery connection info.

Parameters
string$ident
mixed | null$default
Returns
mixed|null
Exceptions
AdapterException
ServerQueryException

Definition at line 1027 of file Host.php.

◆ whoamiReset()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::whoamiReset ( )

Resets the current ServerQuery connection info.

Definition at line 1054 of file Host.php.

◆ whoamiSet()

PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::whoamiSet ( string $ident,
mixed $value = null )

Sets a single value in the current ServerQuery connection info.

Parameters
string$ident
mixed | null$value
Exceptions
AdapterException
ServerQueryException

Definition at line 1044 of file Host.php.

Member Data Documentation

◆ $exclude_query_clients

bool PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::$exclude_query_clients = false
protected

@ignore

Definition at line 62 of file Host.php.

◆ $permissionCats

array null PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::$permissionCats = null
protected

@ignore

Definition at line 52 of file Host.php.

◆ $permissionEnds

array null PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::$permissionEnds = null
protected

@ignore

Definition at line 42 of file Host.php.

◆ $permissionList

array null PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::$permissionList = null
protected

@ignore

Definition at line 47 of file Host.php.

◆ $predefined_query_name

string null PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::$predefined_query_name = null
protected

@ignore

Definition at line 57 of file Host.php.

◆ $serverList

array null PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::$serverList = null
protected

@ignore

Definition at line 37 of file Host.php.

◆ $sort_clients_channels

bool PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::$sort_clients_channels = false
protected

@ignore

Definition at line 72 of file Host.php.

◆ $start_offline_virtual

bool PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::$start_offline_virtual = false
protected

@ignore

Definition at line 67 of file Host.php.

◆ $version

array null PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::$version = null
protected

@ignore

Definition at line 32 of file Host.php.

◆ $whoami

array null PlanetTeamSpeak\TeamSpeak3Framework\Node\Host::$whoami = null
protected

@ignore

Definition at line 27 of file Host.php.

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