![]() |
TeamSpeak 3 PHP Framework
1.1.16
Copyright © Planet TeamSpeak. All rights reserved.
|
Class describing a TeamSpeak 3 client and all it's parameters. More...
Public Member Functions | |
__construct (TeamSpeak3_Node_Server $server, array $info, $index="clid") | |
The TeamSpeak3_Node_Client constructor. | |
modify (array $properties) | |
Changes the clients properties using given properties. | |
modifyDb (array $properties) | |
Changes the clients properties using given properties. | |
deleteDb () | |
Deletes the clients properties from the database. | |
infoDb () | |
Returns a list of properties from the database for the client. | |
message ($msg) | |
Sends a text message to the client. | |
move ($cid, $cpw=null) | |
Moves the client to another channel. | |
kick ($reasonid=TeamSpeak3::KICK_CHANNEL, $reasonmsg=null) | |
Kicks the client from his currently joined channel or from the server. | |
poke ($msg) | |
Sends a poke message to the client. | |
ban ($timeseconds=null, $reason=null) | |
Bans the client from the server. | |
customInfo () | |
Returns a list of custom properties for the client. | |
permOverview ($cid) | |
Returns an array containing the permission overview of the client. | |
permList ($permsid=FALSE) | |
Returns a list of permissions defined for the client. | |
permAssign ($permid, $permvalue, $permskip=FALSE) | |
Adds a set of specified permissions to the client. | |
permAssignByName ($permname, $permvalue, $permskip=FALSE) | |
Alias for permAssign(). | |
permRemove ($permid) | |
Removes a set of specified permissions from a client. | |
permRemoveByName ($permname) | |
Alias for permRemove(). | |
setChannelGroup ($cid, $cgid) | |
Sets the channel group of a client to the ID specified. | |
addServerGroup ($sgid) | |
Adds the client to the server group specified with $sgid. | |
remServerGroup ($sgid) | |
Removes the client from the server group specified with $sgid. | |
avatarGetName () | |
Returns the possible name of the clients avatar. | |
avatarDownload () | |
Downloads and returns the clients avatar file content. | |
getClones () | |
Returns a list of client connections using the same identity as this client. | |
getRev () | |
Returns the revision/build number from the clients version string. | |
memberOf () | |
Returns all server and channel groups the client is currently residing in. | |
iconDownload () | |
Downloads and returns the clients icon file content. | |
getUniqueId () | |
Returns a unique identifier for the node which can be used as a HTML property. | |
getIcon () | |
Returns the name of a possible icon to display the node object. | |
getSymbol () | |
Returns a symbol representing the node. | |
__toString () | |
Returns a string representation of this node. | |
request ($cmd) | |
Sends a prepared command to the server and returns the result. | |
prepare ($cmd, array $params=array()) | |
Uses given parameters and returns a prepared ServerQuery command. | |
execute ($cmd, array $params=array()) | |
Prepares and executes a ServerQuery command and returns the result. | |
getParent () | |
Returns the parent object of the current node. | |
getId () | |
Returns the primary ID of the current node. | |
iconIsLocal ($key) | |
Returns TRUE if the node icon has a local source. | |
iconGetName ($key) | |
Returns the internal path of the node icon. | |
getClass ($prefix="ts3_") | |
Returns a possible classname for the node which can be used as a HTML property. | |
getViewer (TeamSpeak3_Viewer_Interface $viewer) | |
Returns the HTML code to display a TeamSpeak 3 viewer. | |
getInfo ($extend=TRUE, $convert=FALSE) | |
Returns all information available on this node. | |
getProperty ($property, $default=null) | |
Returns the specified property or a pre-defined default value from the node info array. | |
toString () | |
Returns a string representation of this node. | |
toArray () | |
Returns an assoc array filled with current node info properties. | |
__call ($name, array $args) | |
Called whenever we're using an unknown method. | |
__sleep () | |
Commit pending data. | |
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 | |
fetchNodeInfo () | |
| |
filterList (array $nodes=array(), array $rules=array()) | |
Filters given node list array using specified filter rules. | |
setStorage ($key, $val) | |
Writes data to the internal storage array. | |
getStorage ($key, $default=null) | |
Returns data from the internal storage array. | |
delStorage ($key) | |
Deletes data from the internal storage array. | |
fetchNodeList () | |
| |
resetNodeInfo () | |
| |
verifyNodeList () | |
| |
resetNodeList () | |
| |
Protected Attributes | |
$parent = null | |
| |
$server = null | |
| |
$nodeId = 0x00 | |
| |
$nodeList = null | |
| |
$nodeInfo = array() | |
| |
$storage = array() | |
| |
Class describing a TeamSpeak 3 client and all it's parameters.
Definition at line 32 of file Client.php.
TeamSpeak3_Node_Client::__construct | ( | TeamSpeak3_Node_Server | $server, |
array | $info, | ||
$index = "clid" |
|||
) |
The TeamSpeak3_Node_Client constructor.
TeamSpeak3_Node_Server | $server | |
array | $info | |
string | $index |
TeamSpeak3_Adapter_ServerQuery_Exception |
Definition at line 43 of file Client.php.
References TeamSpeak3_Node_Abstract\$server.
TeamSpeak3_Node_Client::modify | ( | array | $properties | ) |
Changes the clients properties using given properties.
array | $properties |
Definition at line 62 of file Client.php.
References TeamSpeak3_Node_Abstract\execute(), TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\resetNodeInfo().
TeamSpeak3_Node_Client::modifyDb | ( | array | $properties | ) |
Changes the clients properties using given properties.
array | $properties |
Definition at line 76 of file Client.php.
References TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::deleteDb | ( | ) |
Deletes the clients properties from the database.
Definition at line 86 of file Client.php.
References TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::infoDb | ( | ) |
Returns a list of properties from the database for the client.
Definition at line 96 of file Client.php.
References TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::message | ( | $msg | ) |
Sends a text message to the client.
string | $msg |
Definition at line 107 of file Client.php.
References TeamSpeak3_Node_Abstract\execute(), TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3\TEXTMSG_CLIENT.
TeamSpeak3_Node_Client::move | ( | $cid, | |
$cpw = null |
|||
) |
Moves the client to another channel.
integer | $cid | |
string | $cpw |
Definition at line 119 of file Client.php.
References TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::kick | ( | $reasonid = TeamSpeak3::KICK_CHANNEL , |
|
$reasonmsg = null |
|||
) |
Kicks the client from his currently joined channel or from the server.
integer | $reasonid | |
string | $reasonmsg |
Definition at line 131 of file Client.php.
References TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::poke | ( | $msg | ) |
Sends a poke message to the client.
string | $msg |
Definition at line 142 of file Client.php.
References TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::ban | ( | $timeseconds = null , |
|
$reason = null |
|||
) |
Bans the client from the server.
Please note that this will create two separate ban rules for the targeted clients IP address and his unique identifier.
integer | $timeseconds | |
string | $reason |
Definition at line 155 of file Client.php.
References TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::customInfo | ( | ) |
Returns a list of custom properties for the client.
Definition at line 165 of file Client.php.
References TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::permOverview | ( | $cid | ) |
Returns an array containing the permission overview of the client.
integer | $cid |
Definition at line 176 of file Client.php.
References TeamSpeak3_Node_Abstract\execute().
TeamSpeak3_Node_Client::permList | ( | $permsid = FALSE | ) |
Returns a list of permissions defined for the client.
boolean | $permsid |
Definition at line 187 of file Client.php.
References TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::permAssign | ( | $permid, | |
$permvalue, | |||
$permskip = FALSE |
|||
) |
Adds a set of specified permissions to the client.
Multiple permissions can be added by providing the three parameters of each permission.
integer | $permid | |
integer | $permvalue | |
integer | $permskip |
Definition at line 201 of file Client.php.
References TeamSpeak3_Node_Abstract\getParent().
Referenced by permAssignByName().
TeamSpeak3_Node_Client::permAssignByName | ( | $permname, | |
$permvalue, | |||
$permskip = FALSE |
|||
) |
TeamSpeak3_Node_Client::permRemove | ( | $permid | ) |
Removes a set of specified permissions from a client.
Multiple permissions can be removed at once.
integer | $permid |
Definition at line 222 of file Client.php.
References TeamSpeak3_Node_Abstract\getParent().
Referenced by permRemoveByName().
TeamSpeak3_Node_Client::permRemoveByName | ( | $permname | ) |
TeamSpeak3_Node_Client::setChannelGroup | ( | $cid, | |
$cgid | |||
) |
Sets the channel group of a client to the ID specified.
integer | $cid | |
integer | $cgid |
Definition at line 244 of file Client.php.
References TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::addServerGroup | ( | $sgid | ) |
Adds the client to the server group specified with $sgid.
integer | $sgid |
Definition at line 255 of file Client.php.
References TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::remServerGroup | ( | $sgid | ) |
Removes the client from the server group specified with $sgid.
integer | $sgid |
Definition at line 266 of file Client.php.
References TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::avatarGetName | ( | ) |
Returns the possible name of the clients avatar.
Definition at line 276 of file Client.php.
Referenced by avatarDownload().
TeamSpeak3_Node_Client::avatarDownload | ( | ) |
Downloads and returns the clients avatar file content.
Definition at line 286 of file Client.php.
References avatarGetName(), TeamSpeak3\factory(), and TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::getClones | ( | ) |
Returns a list of client connections using the same identity as this client.
Definition at line 301 of file Client.php.
References TeamSpeak3_Node_Abstract\execute().
TeamSpeak3_Node_Client::getRev | ( | ) |
Returns the revision/build number from the clients version string.
Definition at line 311 of file Client.php.
TeamSpeak3_Node_Client::memberOf | ( | ) |
Returns all server and channel groups the client is currently residing in.
Definition at line 321 of file Client.php.
References TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::iconDownload | ( | ) |
Downloads and returns the clients icon file content.
Definition at line 338 of file Client.php.
References TeamSpeak3\factory(), TeamSpeak3_Node_Abstract\getParent(), TeamSpeak3_Node_Abstract\iconGetName(), and TeamSpeak3_Node_Abstract\iconIsLocal().
|
protected |
Definition at line 351 of file Client.php.
References TeamSpeak3_Node_Abstract\execute(), and TeamSpeak3_Node_Abstract\getId().
TeamSpeak3_Node_Client::getUniqueId | ( | ) |
Returns a unique identifier for the node which can be used as a HTML property.
Definition at line 363 of file Client.php.
References TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().
TeamSpeak3_Node_Client::getIcon | ( | ) |
Returns the name of a possible icon to display the node object.
Definition at line 373 of file Client.php.
TeamSpeak3_Node_Client::getSymbol | ( | ) |
Returns a symbol representing the node.
Definition at line 414 of file Client.php.
TeamSpeak3_Node_Client::__toString | ( | ) |
Returns a string representation of this node.
Definition at line 424 of file Client.php.
|
inherited |
Sends a prepared command to the server and returns the result.
string | $cmd |
Definition at line 70 of file Abstract.php.
References TeamSpeak3_Node_Abstract\getParent().
Referenced by TeamSpeak3_Node_Host\bindingList(), TeamSpeak3_Node_Abstract\execute(), TeamSpeak3_Node_Host\fetchNodeInfo(), TeamSpeak3_Node_Host\logout(), TeamSpeak3_Node_Host\permissionList(), TeamSpeak3_Node_Host\serverList(), TeamSpeak3_Node_Host\version(), and TeamSpeak3_Node_Host\whoami().
|
inherited |
Uses given parameters and returns a prepared ServerQuery command.
string | $cmd | |
array | $params |
Definition at line 82 of file Abstract.php.
References TeamSpeak3_Node_Abstract\getParent().
Referenced by TeamSpeak3_Node_Abstract\execute().
|
inherited |
Prepares and executes a ServerQuery command and returns the result.
string | $cmd | |
array | $params |
Definition at line 94 of file Abstract.php.
References TeamSpeak3_Node_Abstract\prepare(), and TeamSpeak3_Node_Abstract\request().
Referenced by TeamSpeak3_Node_Server\banCreate(), TeamSpeak3_Node_Server\banDelete(), TeamSpeak3_Node_Server\channelClientPermAssign(), TeamSpeak3_Node_Server\channelClientPermList(), TeamSpeak3_Node_Server\channelClientPermRemove(), TeamSpeak3_Node_Server\channelCreate(), TeamSpeak3_Node_Server\channelDelete(), TeamSpeak3_Node_Server\channelDirCreate(), TeamSpeak3_Node_Server\channelFileDelete(), TeamSpeak3_Node_Server\channelFileInfo(), TeamSpeak3_Node_Server\channelFileList(), TeamSpeak3_Node_Server\channelFileRename(), TeamSpeak3_Node_Server\channelGroupClientList(), TeamSpeak3_Node_Server\channelGroupCopy(), TeamSpeak3_Node_Server\channelGroupCreate(), TeamSpeak3_Node_Server\channelGroupDelete(), TeamSpeak3_Node_Server\channelGroupPermAssign(), TeamSpeak3_Node_Server\channelGroupPermList(), TeamSpeak3_Node_Server\channelGroupPermRemove(), TeamSpeak3_Node_Server\channelGroupRename(), TeamSpeak3_Node_Server\channelMove(), TeamSpeak3_Node_Server\channelPermAssign(), TeamSpeak3_Node_Server\channelPermList(), TeamSpeak3_Node_Server\channelPermRemove(), TeamSpeak3_Node_Server\clientBan(), TeamSpeak3_Node_Server\clientCountDb(), TeamSpeak3_Node_Server\clientDeleteDb(), TeamSpeak3_Node_Server\clientFind(), TeamSpeak3_Node_Server\clientFindDb(), TeamSpeak3_Node_Server\clientGetIdsByUid(), TeamSpeak3_Node_Server\clientGetNameByDbid(), TeamSpeak3_Node_Server\clientGetNameByUid(), TeamSpeak3_Node_Server\clientGetServerGroupsByDbid(), TeamSpeak3_Node_Server\clientInfoDb(), TeamSpeak3_Node_Server\clientKick(), TeamSpeak3_Node_Server\clientListDb(), TeamSpeak3_Node_Server\clientModifyDb(), TeamSpeak3_Node_Server\clientMove(), TeamSpeak3_Node_Server\clientPermAssign(), TeamSpeak3_Node_Server\clientPermList(), TeamSpeak3_Node_Server\clientPermRemove(), TeamSpeak3_Node_Server\clientPoke(), TeamSpeak3_Node_Server\clientSetChannelGroup(), TeamSpeak3_Node_Server\complaintCreate(), TeamSpeak3_Node_Server\complaintDelete(), TeamSpeak3_Node_Server\complaintList(), TeamSpeak3_Node_Server\complaintListClear(), TeamSpeak3_Node_Server\customInfo(), TeamSpeak3_Node_Server\customSearch(), fetchNodeInfo(), TeamSpeak3_Node_Channel\fetchNodeInfo(), getClones(), TeamSpeak3_Node_Host\logAdd(), TeamSpeak3_Node_Server\logAdd(), TeamSpeak3_Node_Host\login(), TeamSpeak3_Node_Host\logView(), TeamSpeak3_Node_Server\logView(), message(), TeamSpeak3_Node_Channelgroup\message(), TeamSpeak3_Node_Servergroup\message(), TeamSpeak3_Node_Channel\message(), TeamSpeak3_Node_Host\message(), TeamSpeak3_Node_Server\message(), TeamSpeak3_Node_Server\messageCreate(), TeamSpeak3_Node_Server\messageDelete(), TeamSpeak3_Node_Server\messageRead(), modify(), TeamSpeak3_Node_Channel\modify(), TeamSpeak3_Node_Host\modify(), TeamSpeak3_Node_Server\modify(), TeamSpeak3_Node_Server\notifyRegister(), TeamSpeak3_Node_Host\permissionFind(), permOverview(), TeamSpeak3_Node_Server\privilegeKeyCreate(), TeamSpeak3_Node_Server\privilegeKeyDelete(), TeamSpeak3_Node_Server\privilegeKeyUse(), TeamSpeak3_Node_Host\selfPermCheck(), TeamSpeak3_Node_Server\selfPermOverview(), TeamSpeak3_Node_Server\selfUpdate(), TeamSpeak3_Node_Server\selfUpdateLogin(), TeamSpeak3_Node_Host\serverCreate(), TeamSpeak3_Node_Host\serverDelete(), TeamSpeak3_Node_Server\serverGroupClientAdd(), TeamSpeak3_Node_Server\serverGroupClientDel(), TeamSpeak3_Node_Server\serverGroupClientList(), TeamSpeak3_Node_Server\serverGroupCopy(), TeamSpeak3_Node_Server\serverGroupCreate(), TeamSpeak3_Node_Server\serverGroupDelete(), TeamSpeak3_Node_Server\serverGroupPermAssign(), TeamSpeak3_Node_Host\serverGroupPermAutoAssign(), TeamSpeak3_Node_Host\serverGroupPermAutoRemove(), TeamSpeak3_Node_Server\serverGroupPermList(), TeamSpeak3_Node_Server\serverGroupPermRemove(), TeamSpeak3_Node_Server\serverGroupRename(), TeamSpeak3_Node_Host\serverIdGetByPort(), TeamSpeak3_Node_Host\serverSelect(), TeamSpeak3_Node_Host\serverSelectByPort(), TeamSpeak3_Node_Host\serverStart(), TeamSpeak3_Node_Host\serverStop(), TeamSpeak3_Node_Host\serverStopProcess(), TeamSpeak3_Node_Server\tempPasswordCreate(), TeamSpeak3_Node_Server\tempPasswordDelete(), TeamSpeak3_Node_Server\transferInitDownload(), TeamSpeak3_Node_Server\transferInitUpload(), and TeamSpeak3_Node_Server\transferStop().
|
inherited |
Returns the parent object of the current node.
Definition at line 105 of file Abstract.php.
References TeamSpeak3_Node_Abstract\$parent.
Referenced by TeamSpeak3_Node_Abstract\__call(), addServerGroup(), avatarDownload(), ban(), TeamSpeak3_Node_Server\channelCreate(), TeamSpeak3_Node_Server\channelDelete(), TeamSpeak3_Node_Servergroup\clientAdd(), TeamSpeak3_Node_Servergroup\clientDel(), TeamSpeak3_Node_Channel\clientList(), TeamSpeak3_Node_Channelgroup\clientList(), TeamSpeak3_Node_Servergroup\clientList(), TeamSpeak3_Node_Server\clientList(), TeamSpeak3_Node_Server\clientMove(), TeamSpeak3_Node_Channel\clientPermAssign(), TeamSpeak3_Node_Channel\clientPermList(), TeamSpeak3_Node_Channel\clientPermRemove(), TeamSpeak3_Node_Servergroup\copy(), TeamSpeak3_Node_Channelgroup\copy(), customInfo(), TeamSpeak3_Node_Servergroup\delete(), TeamSpeak3_Node_Channelgroup\delete(), TeamSpeak3_Node_Channel\delete(), TeamSpeak3_Node_Server\delete(), deleteDb(), TeamSpeak3_Node_Channel\dirCreate(), TeamSpeak3_Node_Channelgroup\fetchNodeList(), TeamSpeak3_Node_Servergroup\fetchNodeList(), TeamSpeak3_Node_Channel\fetchNodeList(), TeamSpeak3_Node_Channel\fileDelete(), TeamSpeak3_Node_Channel\fileInfo(), TeamSpeak3_Node_Channel\fileList(), TeamSpeak3_Node_Channel\fileRename(), TeamSpeak3_Node_Host\getAdapter(), TeamSpeak3_Node_Host\getAdapterHost(), TeamSpeak3_Node_Host\getAdapterPort(), TeamSpeak3_Node_Channel\getLevel(), TeamSpeak3_Node_Channel\getPathway(), TeamSpeak3_Node_Channelgroup\getUniqueId(), TeamSpeak3_Node_Servergroup\getUniqueId(), getUniqueId(), TeamSpeak3_Node_Channel\getUniqueId(), TeamSpeak3_Node_Server\getUniqueId(), TeamSpeak3_Node_Channelgroup\iconDownload(), TeamSpeak3_Node_Servergroup\iconDownload(), iconDownload(), TeamSpeak3_Node_Channel\iconDownload(), infoDb(), TeamSpeak3_Node_Channel\isSpacer(), kick(), memberOf(), TeamSpeak3_Node_Channel\message(), modifyDb(), move(), TeamSpeak3_Node_Channel\move(), TeamSpeak3_Node_Channelgroup\permAssign(), TeamSpeak3_Node_Servergroup\permAssign(), permAssign(), TeamSpeak3_Node_Channel\permAssign(), TeamSpeak3_Node_Servergroup\permList(), TeamSpeak3_Node_Channelgroup\permList(), permList(), TeamSpeak3_Node_Channel\permList(), TeamSpeak3_Node_Channelgroup\permRemove(), TeamSpeak3_Node_Servergroup\permRemove(), permRemove(), TeamSpeak3_Node_Channel\permRemove(), poke(), TeamSpeak3_Node_Abstract\prepare(), TeamSpeak3_Node_Channelgroup\privilegeKeyCreate(), TeamSpeak3_Node_Servergroup\privilegeKeyCreate(), remServerGroup(), TeamSpeak3_Node_Channelgroup\rename(), TeamSpeak3_Node_Servergroup\rename(), TeamSpeak3_Node_Abstract\request(), TeamSpeak3_Node_Server\request(), setChannelGroup(), TeamSpeak3_Node_Server\snapshotDeploy(), TeamSpeak3_Node_Channel\spacerGetAlign(), TeamSpeak3_Node_Channel\spacerGetType(), TeamSpeak3_Node_Server\start(), TeamSpeak3_Node_Server\stop(), TeamSpeak3_Node_Channel\subChannelList(), TeamSpeak3_Node_Server\transferInitDownload(), and TeamSpeak3_Node_Server\transferInitUpload().
|
inherited |
Returns the primary ID of the current node.
Definition at line 115 of file Abstract.php.
References TeamSpeak3_Node_Abstract\$nodeId.
Referenced by ban(), TeamSpeak3_Node_Server\channelDelete(), TeamSpeak3_Node_Server\channelFileList(), TeamSpeak3_Node_Servergroup\clientAdd(), TeamSpeak3_Node_Servergroup\clientDel(), TeamSpeak3_Node_Channel\clientList(), TeamSpeak3_Node_Channelgroup\clientList(), TeamSpeak3_Node_Servergroup\clientList(), TeamSpeak3_Node_Channel\clientPermAssign(), TeamSpeak3_Node_Channel\clientPermList(), TeamSpeak3_Node_Channel\clientPermRemove(), TeamSpeak3_Node_Channelgroup\copy(), TeamSpeak3_Node_Servergroup\copy(), TeamSpeak3_Node_Servergroup\delete(), TeamSpeak3_Node_Channelgroup\delete(), TeamSpeak3_Node_Channel\delete(), TeamSpeak3_Node_Server\delete(), TeamSpeak3_Node_Channel\dirCreate(), fetchNodeInfo(), TeamSpeak3_Node_Channel\fetchNodeInfo(), TeamSpeak3_Node_Channelgroup\fetchNodeList(), TeamSpeak3_Node_Servergroup\fetchNodeList(), TeamSpeak3_Node_Channel\fetchNodeList(), TeamSpeak3_Node_Channel\fileDelete(), TeamSpeak3_Node_Channel\fileInfo(), TeamSpeak3_Node_Channel\fileList(), TeamSpeak3_Node_Channel\fileRename(), TeamSpeak3_Node_Channel\getLevel(), TeamSpeak3_Node_Channel\getPathway(), TeamSpeak3_Node_Channelgroup\getUniqueId(), TeamSpeak3_Node_Servergroup\getUniqueId(), getUniqueId(), TeamSpeak3_Node_Channel\getUniqueId(), TeamSpeak3_Node_Server\getUniqueId(), kick(), message(), TeamSpeak3_Node_Channel\message(), TeamSpeak3_Node_Server\message(), modify(), TeamSpeak3_Node_Channel\modify(), move(), TeamSpeak3_Node_Channel\move(), TeamSpeak3_Node_Channelgroup\permAssign(), TeamSpeak3_Node_Servergroup\permAssign(), TeamSpeak3_Node_Channel\permAssign(), TeamSpeak3_Node_Servergroup\permList(), TeamSpeak3_Node_Channelgroup\permList(), TeamSpeak3_Node_Channel\permList(), TeamSpeak3_Node_Channelgroup\permRemove(), TeamSpeak3_Node_Servergroup\permRemove(), TeamSpeak3_Node_Channel\permRemove(), poke(), TeamSpeak3_Node_Channelgroup\privilegeKeyCreate(), TeamSpeak3_Node_Servergroup\privilegeKeyCreate(), TeamSpeak3_Node_Channelgroup\rename(), TeamSpeak3_Node_Servergroup\rename(), TeamSpeak3_Node_Server\request(), TeamSpeak3_Node_Server\sortGroupList(), TeamSpeak3_Node_Channel\spacerGetAlign(), TeamSpeak3_Node_Channel\spacerGetType(), TeamSpeak3_Node_Server\start(), TeamSpeak3_Node_Server\stop(), and TeamSpeak3_Node_Channel\subChannelList().
|
inherited |
Returns TRUE if the node icon has a local source.
string | $key |
Definition at line 126 of file Abstract.php.
Referenced by TeamSpeak3_Node_Channelgroup\iconDownload(), TeamSpeak3_Node_Servergroup\iconDownload(), iconDownload(), TeamSpeak3_Node_Channel\iconDownload(), and TeamSpeak3_Node_Server\iconDownload().
|
inherited |
Returns the internal path of the node icon.
string | $key |
Definition at line 137 of file Abstract.php.
Referenced by TeamSpeak3_Node_Abstract\getInfo(), TeamSpeak3_Node_Channelgroup\iconDownload(), TeamSpeak3_Node_Servergroup\iconDownload(), iconDownload(), TeamSpeak3_Node_Channel\iconDownload(), and TeamSpeak3_Node_Server\iconDownload().
|
inherited |
Returns a possible classname for the node which can be used as a HTML property.
string | $prefix |
Definition at line 150 of file Abstract.php.
References TeamSpeak3_Helper_String\factory().
|
inherited |
Returns the HTML code to display a TeamSpeak 3 viewer.
TeamSpeak3_Viewer_Interface | $viewer |
Definition at line 191 of file Abstract.php.
References TeamSpeak3_Viewer_Interface\fetchObject().
|
protectedinherited |
Filters given node list array using specified filter rules.
array | $nodes | |
array | $rules |
Definition at line 221 of file Abstract.php.
Referenced by TeamSpeak3_Node_Server\channelGroupList(), TeamSpeak3_Node_Server\channelList(), TeamSpeak3_Node_Channel\clientList(), TeamSpeak3_Node_Server\clientList(), TeamSpeak3_Node_Server\serverGroupList(), TeamSpeak3_Node_Host\serverList(), and TeamSpeak3_Node_Channel\subChannelList().
|
inherited |
Returns all information available on this node.
If $convert is enabled, some property values will be converted to human-readable values.
boolean | $extend | |
boolean | $convert |
Definition at line 263 of file Abstract.php.
References TeamSpeak3_Node_Abstract\$nodeInfo, TeamSpeak3_Helper_Convert\bytes(), TeamSpeak3_Helper_String\factory(), TeamSpeak3_Node_Abstract\fetchNodeInfo(), TeamSpeak3_Node_Abstract\iconGetName(), TeamSpeak3_Helper_Convert\seconds(), and TeamSpeak3_Helper_Convert\version().
|
inherited |
Returns the specified property or a pre-defined default value from the node info array.
string | $property | |
mixed | $default |
Definition at line 321 of file Abstract.php.
References TeamSpeak3_Node_Abstract\fetchNodeInfo(), and TeamSpeak3_Node_Abstract\offsetExists().
Referenced by TeamSpeak3_Node_Server\sortClientList(), and TeamSpeak3_Node_Server\sortGroupList().
|
inherited |
Returns a string representation of this node.
Definition at line 351 of file Abstract.php.
References TeamSpeak3_Node_Abstract\__toString().
|
inherited |
Returns an assoc array filled with current node info properties.
Definition at line 361 of file Abstract.php.
References TeamSpeak3_Node_Abstract\$nodeList.
Referenced by TeamSpeak3_Node_Server\channelFileInfo().
|
inherited |
Called whenever we're using an unknown method.
string | $name | |
array | $args |
TeamSpeak3_Node_Exception |
Definition at line 374 of file Abstract.php.
References TeamSpeak3_Node_Abstract\getParent().
|
protectedinherited |
Writes data to the internal storage array.
string | $key | |
mixed | $val |
Definition at line 391 of file Abstract.php.
Referenced by TeamSpeak3_Node_Host\login(), TeamSpeak3_Node_Host\serverSelect(), TeamSpeak3_Node_Host\serverSelectByPort(), TeamSpeak3_Node_Host\setExcludeQueryClients(), TeamSpeak3_Node_Host\setLoadClientlistFirst(), TeamSpeak3_Node_Host\setPredefinedQueryName(), and TeamSpeak3_Node_Host\setUseOfflineAsVirtual().
|
protectedinherited |
Returns data from the internal storage array.
string | $key | |
mixed | $default |
Definition at line 403 of file Abstract.php.
Referenced by TeamSpeak3_Node_Host\__wakeup().
|
protectedinherited |
Deletes data from the internal storage array.
string | $key |
Definition at line 414 of file Abstract.php.
Referenced by TeamSpeak3_Node_Host\logout(), and TeamSpeak3_Node_Host\serverDeselect().
|
inherited |
Commit pending data.
Definition at line 424 of file Abstract.php.
|
protectedinherited |
Definition at line 432 of file Abstract.php.
Referenced by TeamSpeak3_Node_Abstract\verifyNodeList().
|
protectedinherited |
Definition at line 448 of file Abstract.php.
Referenced by modify(), TeamSpeak3_Node_Channel\modify(), TeamSpeak3_Node_Host\modify(), and TeamSpeak3_Node_Server\modify().
|
protectedinherited |
Definition at line 456 of file Abstract.php.
References TeamSpeak3_Node_Abstract\fetchNodeList().
Referenced by TeamSpeak3_Node_Abstract\count(), TeamSpeak3_Node_Abstract\current(), TeamSpeak3_Node_Abstract\getChildren(), TeamSpeak3_Node_Abstract\hasChildren(), TeamSpeak3_Node_Abstract\hasNext(), TeamSpeak3_Node_Abstract\key(), TeamSpeak3_Node_Abstract\next(), TeamSpeak3_Node_Abstract\rewind(), and TeamSpeak3_Node_Abstract\valid().
|
protectedinherited |
Definition at line 467 of file Abstract.php.
Referenced by TeamSpeak3_Node_Server\channelList(), TeamSpeak3_Node_Server\channelListReset(), TeamSpeak3_Node_Server\clientList(), TeamSpeak3_Node_Server\clientListReset(), TeamSpeak3_Node_Host\serverList(), and TeamSpeak3_Node_Host\serverListReset().
|
inherited |
Definition at line 475 of file Abstract.php.
References TeamSpeak3_Node_Abstract\verifyNodeList().
Referenced by TeamSpeak3_Node_Server\channelFileList(), TeamSpeak3_Node_Server\channelGroupCopy(), TeamSpeak3_Node_Abstract\hasNext(), TeamSpeak3_Node_Server\permRemoveAny(), and TeamSpeak3_Node_Server\serverGroupCopy().
|
inherited |
Definition at line 485 of file Abstract.php.
References TeamSpeak3_Node_Abstract\verifyNodeList().
Referenced by TeamSpeak3_Node_Server\channelClientPermAssign(), TeamSpeak3_Node_Server\channelClientPermRemove(), TeamSpeak3_Node_Server\channelGroupPermAssign(), TeamSpeak3_Node_Server\channelGroupPermRemove(), TeamSpeak3_Node_Server\channelPermAssign(), TeamSpeak3_Node_Server\channelPermRemove(), TeamSpeak3_Node_Server\clientCountDb(), TeamSpeak3_Node_Server\clientPermAssign(), TeamSpeak3_Node_Server\clientPermRemove(), TeamSpeak3_Node_Abstract\getChildren(), TeamSpeak3_Node_Abstract\hasChildren(), TeamSpeak3_Node_Host\permissionFind(), TeamSpeak3_Node_Host\selfPermCheck(), TeamSpeak3_Node_Server\serverGroupPermAssign(), TeamSpeak3_Node_Host\serverGroupPermAutoAssign(), TeamSpeak3_Node_Host\serverGroupPermAutoRemove(), and TeamSpeak3_Node_Server\serverGroupPermRemove().
|
inherited |
Definition at line 495 of file Abstract.php.
References TeamSpeak3_Node_Abstract\current(), and TeamSpeak3_Node_Abstract\verifyNodeList().
|
inherited |
Definition at line 505 of file Abstract.php.
References TeamSpeak3_Node_Abstract\current(), and TeamSpeak3_Node_Abstract\verifyNodeList().
|
inherited |
Definition at line 515 of file Abstract.php.
References TeamSpeak3_Node_Abstract\count(), TeamSpeak3_Node_Abstract\key(), and TeamSpeak3_Node_Abstract\verifyNodeList().
|
inherited |
Definition at line 525 of file Abstract.php.
References TeamSpeak3_Node_Abstract\verifyNodeList().
Referenced by TeamSpeak3_Node_Abstract\hasNext(), and TeamSpeak3_Node_Abstract\valid().
|
inherited |
Definition at line 535 of file Abstract.php.
References TeamSpeak3_Node_Abstract\key(), and TeamSpeak3_Node_Abstract\verifyNodeList().
|
inherited |
Definition at line 545 of file Abstract.php.
References TeamSpeak3_Node_Abstract\verifyNodeList().
|
inherited |
Definition at line 555 of file Abstract.php.
References TeamSpeak3_Node_Abstract\verifyNodeList().
|
inherited |
Definition at line 565 of file Abstract.php.
Referenced by TeamSpeak3_Node_Abstract\getProperty(), and TeamSpeak3_Node_Abstract\offsetGet().
|
inherited |
Definition at line 573 of file Abstract.php.
References TeamSpeak3_Node_Abstract\fetchNodeInfo(), and TeamSpeak3_Node_Abstract\offsetExists().
Referenced by TeamSpeak3_Node_Abstract\__get().
|
inherited |
Definition at line 593 of file Abstract.php.
Referenced by TeamSpeak3_Node_Abstract\__set().
|
inherited |
Definition at line 606 of file Abstract.php.
|
inherited |
Definition at line 614 of file Abstract.php.
References TeamSpeak3_Node_Abstract\offsetGet().
|
inherited |
Definition at line 622 of file Abstract.php.
References TeamSpeak3_Node_Abstract\offsetSet().
|
protectedinherited |
Definition at line 37 of file Abstract.php.
Referenced by TeamSpeak3_Node_Abstract\getParent().
|
protectedinherited |
Definition at line 42 of file Abstract.php.
Referenced by TeamSpeak3_Node_Channel\__construct(), TeamSpeak3_Node_Channelgroup\__construct(), __construct(), TeamSpeak3_Node_Servergroup\__construct(), TeamSpeak3_Node_Host\__wakeup(), TeamSpeak3_Node_Host\fetchNodeList(), TeamSpeak3_Node_Host\serverCreate(), TeamSpeak3_Node_Host\serverGetByName(), TeamSpeak3_Node_Host\serverGetByUid(), and TeamSpeak3_Node_Host\serverList().
|
protectedinherited |
Definition at line 47 of file Abstract.php.
Referenced by TeamSpeak3_Node_Abstract\getId().
|
protectedinherited |
Definition at line 52 of file Abstract.php.
Referenced by TeamSpeak3_Node_Abstract\toArray().
|
protectedinherited |
Definition at line 57 of file Abstract.php.
Referenced by TeamSpeak3_Node_Abstract\getInfo().
|
protectedinherited |
Definition at line 62 of file Abstract.php.