release 1.2.10
This commit is contained in:
Newcomer1989
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,274 +1,274 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* TeamSpeak 3 PHP Framework
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* @package TeamSpeak3
|
||||
* @author Sven 'ScP' Paulsen
|
||||
* @copyright Copyright (c) Planet TeamSpeak. All rights reserved.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @class TeamSpeak3_Node_Channelgroup
|
||||
* @brief Class describing a TeamSpeak 3 channel group and all it's parameters.
|
||||
*/
|
||||
class TeamSpeak3_Node_Channelgroup extends TeamSpeak3_Node_Abstract
|
||||
{
|
||||
/**
|
||||
* The TeamSpeak3_Node_Channelgroup constructor.
|
||||
*
|
||||
* @param TeamSpeak3_Node_Server $server
|
||||
* @param array $info
|
||||
* @param string $index
|
||||
* @throws TeamSpeak3_Adapter_ServerQuery_Exception
|
||||
* @return TeamSpeak3_Node_Channelgroup
|
||||
*/
|
||||
public function __construct(TeamSpeak3_Node_Server $server, array $info, $index = "cgid")
|
||||
{
|
||||
$this->parent = $server;
|
||||
$this->nodeInfo = $info;
|
||||
|
||||
if(!array_key_exists($index, $this->nodeInfo))
|
||||
{
|
||||
throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid groupID", 0xA00);
|
||||
}
|
||||
|
||||
$this->nodeId = $this->nodeInfo[$index];
|
||||
}
|
||||
|
||||
/**
|
||||
* Renames the channel group specified.
|
||||
*
|
||||
* @param string $name
|
||||
* @return void
|
||||
*/
|
||||
public function rename($name)
|
||||
{
|
||||
$this->getParent()->channelGroupRename($this->getId(), $name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes the channel group. If $force is set to TRUE, the channel group will be
|
||||
* deleted even if there are clients within.
|
||||
*
|
||||
* @param boolean $force
|
||||
* @return void
|
||||
*/
|
||||
public function delete($force = FALSE)
|
||||
{
|
||||
$this->getParent()->channelGroupDelete($this->getId(), $force);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a copy of the channel group and returns the new groups ID.
|
||||
*
|
||||
* @param string $name
|
||||
* @param integer $tcgid
|
||||
* @param integer $type
|
||||
* @return integer
|
||||
*/
|
||||
public function copy($name = null, $tcgid = 0, $type = TeamSpeak3::GROUP_DBTYPE_REGULAR)
|
||||
{
|
||||
return $this->getParent()->channelGroupCopy($this->getId(), $name, $tcgid, $type);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of permissions assigned to the channel group.
|
||||
*
|
||||
* @param boolean $permsid
|
||||
* @return array
|
||||
*/
|
||||
public function permList($permsid = FALSE)
|
||||
{
|
||||
return $this->getParent()->channelGroupPermList($this->getId(), $permsid);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @param integer $permid
|
||||
* @param integer $permvalue
|
||||
* @return void
|
||||
*/
|
||||
public function permAssign($permid, $permvalue)
|
||||
{
|
||||
$this->getParent()->channelGroupPermAssign($this->getId(), $permid, $permvalue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for permAssign().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function permAssignByName($permname, $permvalue)
|
||||
{
|
||||
$this->permAssign($permname, $permvalue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a set of specified permissions from the channel group. Multiple
|
||||
* permissions can be removed at once.
|
||||
*
|
||||
* @param integer $permid
|
||||
* @return void
|
||||
*/
|
||||
public function permRemove($permid)
|
||||
{
|
||||
$this->getParent()->channelGroupPermRemove($this->getId(), $permid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for permAssign().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function permRemoveByName($permname)
|
||||
{
|
||||
$this->permRemove($permname);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of clients assigned to the channel group specified.
|
||||
*
|
||||
* @param integer $cid
|
||||
* @param integer $cldbid
|
||||
* @param boolean $resolve
|
||||
* @return array
|
||||
*/
|
||||
public function clientList($cid = null, $cldbid = null, $resolve = FALSE)
|
||||
{
|
||||
return $this->getParent()->channelGroupClientList($this->getId(), $cid, $cldbid, $resolve);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for privilegeKeyCreate().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function tokenCreate($cid, $description = null, $customset = null)
|
||||
{
|
||||
return $this->privilegeKeyCreate($cid, $description, $customset);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new privilege key (token) for the channel group and returns the key.
|
||||
*
|
||||
* @param integer $cid
|
||||
* @param string $description
|
||||
* @param string $customset
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function privilegeKeyCreate($cid, $description = null, $customset = null)
|
||||
{
|
||||
return $this->getParent()->privilegeKeyCreate(TeamSpeak3::TOKEN_CHANNELGROUP, $this->getId(), $cid, $description, $customset);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a text message to all clients residing in the channel group on the virtual server.
|
||||
*
|
||||
* @param string $msg
|
||||
* @return void
|
||||
*/
|
||||
public function message($msg)
|
||||
{
|
||||
foreach($this as $client)
|
||||
{
|
||||
try
|
||||
{
|
||||
$this->execute("sendtextmessage", array("msg" => $msg, "target" => $client, "targetmode" => TeamSpeak3::TEXTMSG_CLIENT));
|
||||
}
|
||||
catch(TeamSpeak3_Adapter_ServerQuery_Exception $e)
|
||||
{
|
||||
/* ERROR_client_invalid_id */
|
||||
if($e->getCode() != 0x0200) throw $e;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Downloads and returns the channel groups icon file content.
|
||||
*
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function iconDownload()
|
||||
{
|
||||
if($this->iconIsLocal("iconid") || $this["iconid"] == 0) return;
|
||||
|
||||
$download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->iconGetName("iconid"));
|
||||
$transfer = TeamSpeak3::factory("filetransfer://" . (strstr($download["host"], ":") !== FALSE ? "[" . $download["host"] . "]" : $download["host"]) . ":" . $download["port"]);
|
||||
|
||||
return $transfer->download($download["ftkey"], $download["size"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
protected function fetchNodeList()
|
||||
{
|
||||
$this->nodeList = array();
|
||||
|
||||
foreach($this->getParent()->clientList() as $client)
|
||||
{
|
||||
if($client["client_channel_group_id"] == $this->getId())
|
||||
{
|
||||
$this->nodeList[] = $client;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a unique identifier for the node which can be used as a HTML property.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getUniqueId()
|
||||
{
|
||||
return $this->getParent()->getUniqueId() . "_cg" . $this->getId();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the name of a possible icon to display the node object.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getIcon()
|
||||
{
|
||||
return "group_channel";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a symbol representing the node.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getSymbol()
|
||||
{
|
||||
return "%";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string representation of this node.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function __toString()
|
||||
{
|
||||
return (string) $this["name"];
|
||||
}
|
||||
}
|
||||
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* TeamSpeak 3 PHP Framework
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* @package TeamSpeak3
|
||||
* @author Sven 'ScP' Paulsen
|
||||
* @copyright Copyright (c) Planet TeamSpeak. All rights reserved.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @class TeamSpeak3_Node_Channelgroup
|
||||
* @brief Class describing a TeamSpeak 3 channel group and all it's parameters.
|
||||
*/
|
||||
class TeamSpeak3_Node_Channelgroup extends TeamSpeak3_Node_Abstract
|
||||
{
|
||||
/**
|
||||
* The TeamSpeak3_Node_Channelgroup constructor.
|
||||
*
|
||||
* @param TeamSpeak3_Node_Server $server
|
||||
* @param array $info
|
||||
* @param string $index
|
||||
* @throws TeamSpeak3_Adapter_ServerQuery_Exception
|
||||
* @return TeamSpeak3_Node_Channelgroup
|
||||
*/
|
||||
public function __construct(TeamSpeak3_Node_Server $server, array $info, $index = "cgid")
|
||||
{
|
||||
$this->parent = $server;
|
||||
$this->nodeInfo = $info;
|
||||
|
||||
if(!array_key_exists($index, $this->nodeInfo))
|
||||
{
|
||||
throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid groupID", 0xA00);
|
||||
}
|
||||
|
||||
$this->nodeId = $this->nodeInfo[$index];
|
||||
}
|
||||
|
||||
/**
|
||||
* Renames the channel group specified.
|
||||
*
|
||||
* @param string $name
|
||||
* @return void
|
||||
*/
|
||||
public function rename($name)
|
||||
{
|
||||
$this->getParent()->channelGroupRename($this->getId(), $name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes the channel group. If $force is set to TRUE, the channel group will be
|
||||
* deleted even if there are clients within.
|
||||
*
|
||||
* @param boolean $force
|
||||
* @return void
|
||||
*/
|
||||
public function delete($force = FALSE)
|
||||
{
|
||||
$this->getParent()->channelGroupDelete($this->getId(), $force);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a copy of the channel group and returns the new groups ID.
|
||||
*
|
||||
* @param string $name
|
||||
* @param integer $tcgid
|
||||
* @param integer $type
|
||||
* @return integer
|
||||
*/
|
||||
public function copy($name = null, $tcgid = 0, $type = TeamSpeak3::GROUP_DBTYPE_REGULAR)
|
||||
{
|
||||
return $this->getParent()->channelGroupCopy($this->getId(), $name, $tcgid, $type);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of permissions assigned to the channel group.
|
||||
*
|
||||
* @param boolean $permsid
|
||||
* @return array
|
||||
*/
|
||||
public function permList($permsid = FALSE)
|
||||
{
|
||||
return $this->getParent()->channelGroupPermList($this->getId(), $permsid);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @param integer $permid
|
||||
* @param integer $permvalue
|
||||
* @return void
|
||||
*/
|
||||
public function permAssign($permid, $permvalue)
|
||||
{
|
||||
$this->getParent()->channelGroupPermAssign($this->getId(), $permid, $permvalue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for permAssign().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function permAssignByName($permname, $permvalue)
|
||||
{
|
||||
$this->permAssign($permname, $permvalue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a set of specified permissions from the channel group. Multiple
|
||||
* permissions can be removed at once.
|
||||
*
|
||||
* @param integer $permid
|
||||
* @return void
|
||||
*/
|
||||
public function permRemove($permid)
|
||||
{
|
||||
$this->getParent()->channelGroupPermRemove($this->getId(), $permid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for permAssign().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function permRemoveByName($permname)
|
||||
{
|
||||
$this->permRemove($permname);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of clients assigned to the channel group specified.
|
||||
*
|
||||
* @param integer $cid
|
||||
* @param integer $cldbid
|
||||
* @param boolean $resolve
|
||||
* @return array
|
||||
*/
|
||||
public function clientList($cid = null, $cldbid = null, $resolve = FALSE)
|
||||
{
|
||||
return $this->getParent()->channelGroupClientList($this->getId(), $cid, $cldbid, $resolve);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for privilegeKeyCreate().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function tokenCreate($cid, $description = null, $customset = null)
|
||||
{
|
||||
return $this->privilegeKeyCreate($cid, $description, $customset);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new privilege key (token) for the channel group and returns the key.
|
||||
*
|
||||
* @param integer $cid
|
||||
* @param string $description
|
||||
* @param string $customset
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function privilegeKeyCreate($cid, $description = null, $customset = null)
|
||||
{
|
||||
return $this->getParent()->privilegeKeyCreate(TeamSpeak3::TOKEN_CHANNELGROUP, $this->getId(), $cid, $description, $customset);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a text message to all clients residing in the channel group on the virtual server.
|
||||
*
|
||||
* @param string $msg
|
||||
* @return void
|
||||
*/
|
||||
public function message($msg)
|
||||
{
|
||||
foreach($this as $client)
|
||||
{
|
||||
try
|
||||
{
|
||||
$this->execute("sendtextmessage", array("msg" => $msg, "target" => $client, "targetmode" => TeamSpeak3::TEXTMSG_CLIENT));
|
||||
}
|
||||
catch(TeamSpeak3_Adapter_ServerQuery_Exception $e)
|
||||
{
|
||||
/* ERROR_client_invalid_id */
|
||||
if($e->getCode() != 0x0200) throw $e;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Downloads and returns the channel groups icon file content.
|
||||
*
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function iconDownload()
|
||||
{
|
||||
if($this->iconIsLocal("iconid") || $this["iconid"] == 0) return;
|
||||
|
||||
$download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->iconGetName("iconid"));
|
||||
$transfer = TeamSpeak3::factory("filetransfer://" . (strstr($download["host"], ":") !== FALSE ? "[" . $download["host"] . "]" : $download["host"]) . ":" . $download["port"]);
|
||||
|
||||
return $transfer->download($download["ftkey"], $download["size"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
protected function fetchNodeList()
|
||||
{
|
||||
$this->nodeList = array();
|
||||
|
||||
foreach($this->getParent()->clientList() as $client)
|
||||
{
|
||||
if($client["client_channel_group_id"] == $this->getId())
|
||||
{
|
||||
$this->nodeList[] = $client;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a unique identifier for the node which can be used as a HTML property.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getUniqueId()
|
||||
{
|
||||
return $this->getParent()->getUniqueId() . "_cg" . $this->getId();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the name of a possible icon to display the node object.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getIcon()
|
||||
{
|
||||
return "group_channel";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a symbol representing the node.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getSymbol()
|
||||
{
|
||||
return "%";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string representation of this node.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function __toString()
|
||||
{
|
||||
return (string) $this["name"];
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1,471 +1,493 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* TeamSpeak 3 PHP Framework
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* @package TeamSpeak3
|
||||
* @author Sven 'ScP' Paulsen
|
||||
* @copyright Copyright (c) Planet TeamSpeak. All rights reserved.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @class TeamSpeak3_Node_Client
|
||||
* @brief Class describing a TeamSpeak 3 client and all it's parameters.
|
||||
*/
|
||||
class TeamSpeak3_Node_Client extends TeamSpeak3_Node_Abstract
|
||||
{
|
||||
/**
|
||||
* The TeamSpeak3_Node_Client constructor.
|
||||
*
|
||||
* @param TeamSpeak3_Node_Server $server
|
||||
* @param array $info
|
||||
* @param string $index
|
||||
* @throws TeamSpeak3_Adapter_ServerQuery_Exception
|
||||
* @return TeamSpeak3_Node_Client
|
||||
*/
|
||||
public function __construct(TeamSpeak3_Node_Server $server, array $info, $index = "clid")
|
||||
{
|
||||
$this->parent = $server;
|
||||
$this->nodeInfo = $info;
|
||||
|
||||
if(!array_key_exists($index, $this->nodeInfo))
|
||||
{
|
||||
throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid clientID", 0x200);
|
||||
}
|
||||
|
||||
$this->nodeId = $this->nodeInfo[$index];
|
||||
}
|
||||
|
||||
/**
|
||||
* Changes the clients properties using given properties.
|
||||
*
|
||||
* @param array $properties
|
||||
* @return void
|
||||
*/
|
||||
public function modify(array $properties)
|
||||
{
|
||||
$properties["clid"] = $this->getId();
|
||||
|
||||
$this->execute("clientedit", $properties);
|
||||
$this->resetNodeInfo();
|
||||
}
|
||||
|
||||
/**
|
||||
* Changes the clients properties using given properties.
|
||||
*
|
||||
* @param array $properties
|
||||
* @return void
|
||||
*/
|
||||
public function modifyDb(array $properties)
|
||||
{
|
||||
$this->getParent()->clientModifyDb($this["client_database_id"], $properties);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes the clients properties from the database.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function deleteDb()
|
||||
{
|
||||
$this->getParent()->clientDeleteDb($this["client_database_id"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of properties from the database for the client.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function infoDb()
|
||||
{
|
||||
return $this->getParent()->clientInfoDb($this["client_database_id"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a text message to the client.
|
||||
*
|
||||
* @param string $msg
|
||||
* @return void
|
||||
*/
|
||||
public function message($msg)
|
||||
{
|
||||
$this->execute("sendtextmessage", array("msg" => $msg, "target" => $this->getId(), "targetmode" => TeamSpeak3::TEXTMSG_CLIENT));
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves the client to another channel.
|
||||
*
|
||||
* @param integer $cid
|
||||
* @param string $cpw
|
||||
* @return void
|
||||
*/
|
||||
public function move($cid, $cpw = null)
|
||||
{
|
||||
$this->getParent()->clientMove($this->getId(), $cid, $cpw);
|
||||
}
|
||||
|
||||
/**
|
||||
* Kicks the client from his currently joined channel or from the server.
|
||||
*
|
||||
* @param integer $reasonid
|
||||
* @param string $reasonmsg
|
||||
* @return void
|
||||
*/
|
||||
public function kick($reasonid = TeamSpeak3::KICK_CHANNEL, $reasonmsg = null)
|
||||
{
|
||||
$this->getParent()->clientKick($this->getId(), $reasonid, $reasonmsg);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a poke message to the client.
|
||||
*
|
||||
* @param string $msg
|
||||
* @return void
|
||||
*/
|
||||
public function poke($msg)
|
||||
{
|
||||
$this->getParent()->clientPoke($this->getId(), $msg);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @param integer $timeseconds
|
||||
* @param string $reason
|
||||
* @return array
|
||||
*/
|
||||
public function ban($timeseconds = null, $reason = null)
|
||||
{
|
||||
return $this->getParent()->clientBan($this->getId(), $timeseconds, $reason);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of custom properties for the client.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function customInfo()
|
||||
{
|
||||
return $this->getParent()->customInfo($this["client_database_id"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array containing the permission overview of the client.
|
||||
*
|
||||
* @param integer $cid
|
||||
* @return array
|
||||
*/
|
||||
public function permOverview($cid)
|
||||
{
|
||||
return $this->execute("permoverview", array("cldbid" => $this["client_database_id"], "cid" => $cid, "permid" => 0))->toArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of permissions defined for the client.
|
||||
*
|
||||
* @param boolean $permsid
|
||||
* @return array
|
||||
*/
|
||||
public function permList($permsid = FALSE)
|
||||
{
|
||||
return $this->getParent()->clientPermList($this["client_database_id"], $permsid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a set of specified permissions to the client. Multiple permissions can be added by providing
|
||||
* the three parameters of each permission.
|
||||
*
|
||||
* @param integer $permid
|
||||
* @param integer $permvalue
|
||||
* @param integer $permskip
|
||||
* @return void
|
||||
*/
|
||||
public function permAssign($permid, $permvalue, $permskip = FALSE)
|
||||
{
|
||||
$this->getParent()->clientPermAssign($this["client_database_id"], $permid, $permvalue, $permskip);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for permAssign().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function permAssignByName($permname, $permvalue, $permskip = FALSE)
|
||||
{
|
||||
$this->permAssign($permname, $permvalue, $permskip);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a set of specified permissions from a client. Multiple permissions can be removed at once.
|
||||
*
|
||||
* @param integer $permid
|
||||
* @return void
|
||||
*/
|
||||
public function permRemove($permid)
|
||||
{
|
||||
$this->getParent()->clientPermRemove($this["client_database_id"], $permid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for permRemove().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function permRemoveByName($permname)
|
||||
{
|
||||
$this->permRemove($permname);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the channel group of a client to the ID specified.
|
||||
*
|
||||
* @param integer $cid
|
||||
* @param integer $cgid
|
||||
* @return void
|
||||
*/
|
||||
public function setChannelGroup($cid, $cgid)
|
||||
{
|
||||
$this->getParent()->clientSetChannelGroup($this["client_database_id"], $cid, $cgid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds the client to the server group specified with $sgid.
|
||||
*
|
||||
* @param integer $sgid
|
||||
* @return void
|
||||
*/
|
||||
public function addServerGroup($sgid)
|
||||
{
|
||||
$this->getParent()->serverGroupClientAdd($sgid, $this["client_database_id"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes the client from the server group specified with $sgid.
|
||||
*
|
||||
* @param integer $sgid
|
||||
* @return void
|
||||
*/
|
||||
public function remServerGroup($sgid)
|
||||
{
|
||||
$this->getParent()->serverGroupClientDel($sgid, $this["client_database_id"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the possible name of the clients avatar.
|
||||
*
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function avatarGetName()
|
||||
{
|
||||
return new TeamSpeak3_Helper_String("/avatar_" . $this["client_base64HashClientUID"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Downloads and returns the clients avatar file content.
|
||||
*
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function avatarDownload()
|
||||
{
|
||||
if($this["client_flag_avatar"]->toString() == NULL) return;
|
||||
|
||||
$download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->avatarGetName());
|
||||
$transfer = TeamSpeak3::factory("filetransfer://" . (strstr($download["host"], ":") !== FALSE ? "[" . $download["host"] . "]" : $download["host"]) . ":" . $download["port"]);
|
||||
|
||||
return $transfer->download($download["ftkey"], $download["size"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of client connections using the same identity as this client.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getClones()
|
||||
{
|
||||
return $this->execute("clientgetids", array("cluid" => $this["client_unique_identifier"]))->toAssocArray("clid");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns TRUE if the client is using Overwolf.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
public function hasOverwolf()
|
||||
{
|
||||
return strstr($this["client_badges"], "overwolf=1") !== FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of equipped badges for this client.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getBadges()
|
||||
{
|
||||
$badges = array();
|
||||
|
||||
foreach(explode(":", $this["client_badges"]) as $set)
|
||||
{
|
||||
if(substr($set, 0, 7) == "badges=")
|
||||
{
|
||||
$badges[] = array_map("trim", explode(",", substr($set, 7)));
|
||||
}
|
||||
}
|
||||
|
||||
return $badges;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the revision/build number from the clients version string.
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
public function getRev()
|
||||
{
|
||||
return $this["client_type"] ? null : $this["client_version"]->section("[", 1)->filterDigits();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns all server and channel groups the client is currently residing in.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function memberOf()
|
||||
{
|
||||
$cgroups = array($this->getParent()->channelGroupGetById($this["client_channel_group_id"]));
|
||||
$sgroups = array();
|
||||
|
||||
foreach(explode(",", $this["client_servergroups"]) as $sgid)
|
||||
{
|
||||
$sgroups[] = $this->getParent()->serverGroupGetById($sgid);
|
||||
}
|
||||
|
||||
uasort($sgroups, array(__CLASS__, "sortGroupList"));
|
||||
|
||||
return array_merge($cgroups, $sgroups);
|
||||
}
|
||||
|
||||
/**
|
||||
* Downloads and returns the clients icon file content.
|
||||
*
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function iconDownload()
|
||||
{
|
||||
if($this->iconIsLocal("client_icon_id") || $this["client_icon_id"] == 0) return;
|
||||
|
||||
$download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->iconGetName("client_icon_id"));
|
||||
$transfer = TeamSpeak3::factory("filetransfer://" . (strstr($download["host"], ":") !== FALSE ? "[" . $download["host"] . "]" : $download["host"]) . ":" . $download["port"]);
|
||||
|
||||
return $transfer->download($download["ftkey"], $download["size"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a plugin command to the client.
|
||||
*
|
||||
* @param string $plugin
|
||||
* @param string $data
|
||||
* @return void
|
||||
*/
|
||||
public function sendPluginCmd($plugin, $data)
|
||||
{
|
||||
$this->execute("plugincmd", array("name" => $plugin, "data" => $data, "targetmode" => TeamSpeak3::PLUGINCMD_CLIENT, "target" => $this->getId()));
|
||||
}
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
protected function fetchNodeInfo()
|
||||
{
|
||||
if($this->offsetExists("client_type") && $this["client_type"] == 1) return;
|
||||
|
||||
$this->nodeInfo = array_merge($this->nodeInfo, $this->execute("clientinfo", array("clid" => $this->getId()))->toList());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a unique identifier for the node which can be used as a HTML property.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getUniqueId()
|
||||
{
|
||||
return $this->getParent()->getUniqueId() . "_cl" . $this->getId();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the name of a possible icon to display the node object.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getIcon()
|
||||
{
|
||||
if($this["client_type"])
|
||||
{
|
||||
return "client_query";
|
||||
}
|
||||
elseif($this["client_away"])
|
||||
{
|
||||
return "client_away";
|
||||
}
|
||||
elseif(!$this["client_output_hardware"])
|
||||
{
|
||||
return "client_snd_disabled";
|
||||
}
|
||||
elseif($this["client_output_muted"])
|
||||
{
|
||||
return "client_snd_muted";
|
||||
}
|
||||
elseif(!$this["client_input_hardware"])
|
||||
{
|
||||
return "client_mic_disabled";
|
||||
}
|
||||
elseif($this["client_input_muted"])
|
||||
{
|
||||
return "client_mic_muted";
|
||||
}
|
||||
elseif($this["client_is_channel_commander"])
|
||||
{
|
||||
return $this["client_flag_talking"] ? "client_cc_talk" : "client_cc_idle";
|
||||
}
|
||||
else
|
||||
{
|
||||
return $this["client_flag_talking"] ? "client_talk" : "client_idle";
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a symbol representing the node.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getSymbol()
|
||||
{
|
||||
return "@";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string representation of this node.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function __toString()
|
||||
{
|
||||
return (string) $this["client_nickname"];
|
||||
}
|
||||
}
|
||||
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* TeamSpeak 3 PHP Framework
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* @package TeamSpeak3
|
||||
* @author Sven 'ScP' Paulsen
|
||||
* @copyright Copyright (c) Planet TeamSpeak. All rights reserved.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @class TeamSpeak3_Node_Client
|
||||
* @brief Class describing a TeamSpeak 3 client and all it's parameters.
|
||||
*/
|
||||
class TeamSpeak3_Node_Client extends TeamSpeak3_Node_Abstract
|
||||
{
|
||||
/**
|
||||
* The TeamSpeak3_Node_Client constructor.
|
||||
*
|
||||
* @param TeamSpeak3_Node_Server $server
|
||||
* @param array $info
|
||||
* @param string $index
|
||||
* @throws TeamSpeak3_Adapter_ServerQuery_Exception
|
||||
* @return TeamSpeak3_Node_Client
|
||||
*/
|
||||
public function __construct(TeamSpeak3_Node_Server $server, array $info, $index = "clid")
|
||||
{
|
||||
$this->parent = $server;
|
||||
$this->nodeInfo = $info;
|
||||
|
||||
if(!array_key_exists($index, $this->nodeInfo))
|
||||
{
|
||||
throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid clientID", 0x200);
|
||||
}
|
||||
|
||||
$this->nodeId = $this->nodeInfo[$index];
|
||||
}
|
||||
|
||||
/**
|
||||
* Changes the clients properties using given properties.
|
||||
*
|
||||
* @param array $properties
|
||||
* @return void
|
||||
*/
|
||||
public function modify(array $properties)
|
||||
{
|
||||
$properties["clid"] = $this->getId();
|
||||
|
||||
$this->execute("clientedit", $properties);
|
||||
$this->resetNodeInfo();
|
||||
}
|
||||
|
||||
/**
|
||||
* Changes the clients properties using given properties.
|
||||
*
|
||||
* @param array $properties
|
||||
* @return void
|
||||
*/
|
||||
public function modifyDb(array $properties)
|
||||
{
|
||||
$this->getParent()->clientModifyDb($this["client_database_id"], $properties);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes the clients properties from the database.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function deleteDb()
|
||||
{
|
||||
$this->getParent()->clientDeleteDb($this["client_database_id"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of properties from the database for the client.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function infoDb()
|
||||
{
|
||||
return $this->getParent()->clientInfoDb($this["client_database_id"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a text message to the client.
|
||||
*
|
||||
* @param string $msg
|
||||
* @return void
|
||||
*/
|
||||
public function message($msg)
|
||||
{
|
||||
$this->execute("sendtextmessage", array("msg" => $msg, "target" => $this->getId(), "targetmode" => TeamSpeak3::TEXTMSG_CLIENT));
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves the client to another channel.
|
||||
*
|
||||
* @param integer $cid
|
||||
* @param string $cpw
|
||||
* @return void
|
||||
*/
|
||||
public function move($cid, $cpw = null)
|
||||
{
|
||||
$this->getParent()->clientMove($this->getId(), $cid, $cpw);
|
||||
}
|
||||
|
||||
/**
|
||||
* Kicks the client from his currently joined channel or from the server.
|
||||
*
|
||||
* @param integer $reasonid
|
||||
* @param string $reasonmsg
|
||||
* @return void
|
||||
*/
|
||||
public function kick($reasonid = TeamSpeak3::KICK_CHANNEL, $reasonmsg = null)
|
||||
{
|
||||
$this->getParent()->clientKick($this->getId(), $reasonid, $reasonmsg);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a poke message to the client.
|
||||
*
|
||||
* @param string $msg
|
||||
* @return void
|
||||
*/
|
||||
public function poke($msg)
|
||||
{
|
||||
$this->getParent()->clientPoke($this->getId(), $msg);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @param integer $timeseconds
|
||||
* @param string $reason
|
||||
* @return array
|
||||
*/
|
||||
public function ban($timeseconds = null, $reason = null)
|
||||
{
|
||||
return $this->getParent()->clientBan($this->getId(), $timeseconds, $reason);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of custom properties for the client.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function customInfo()
|
||||
{
|
||||
return $this->getParent()->customInfo($this["client_database_id"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or updates a custom property for the client.
|
||||
*
|
||||
* @param string $ident
|
||||
* @param string $value
|
||||
* @return void
|
||||
*/
|
||||
public function customSet($ident, $value)
|
||||
{
|
||||
$this->getParent()->customSet($this["client_database_id"], $ident, $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a custom property from the client.
|
||||
*
|
||||
* @param string $ident
|
||||
* @return void
|
||||
*/
|
||||
public function customDelete($ident)
|
||||
{
|
||||
$this->getParent()->customDelete($this["client_database_id"], $ident);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array containing the permission overview of the client.
|
||||
*
|
||||
* @param integer $cid
|
||||
* @return array
|
||||
*/
|
||||
public function permOverview($cid)
|
||||
{
|
||||
return $this->execute("permoverview", array("cldbid" => $this["client_database_id"], "cid" => $cid, "permid" => 0))->toArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of permissions defined for the client.
|
||||
*
|
||||
* @param boolean $permsid
|
||||
* @return array
|
||||
*/
|
||||
public function permList($permsid = FALSE)
|
||||
{
|
||||
return $this->getParent()->clientPermList($this["client_database_id"], $permsid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a set of specified permissions to the client. Multiple permissions can be added by providing
|
||||
* the three parameters of each permission.
|
||||
*
|
||||
* @param integer $permid
|
||||
* @param integer $permvalue
|
||||
* @param integer $permskip
|
||||
* @return void
|
||||
*/
|
||||
public function permAssign($permid, $permvalue, $permskip = FALSE)
|
||||
{
|
||||
$this->getParent()->clientPermAssign($this["client_database_id"], $permid, $permvalue, $permskip);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for permAssign().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function permAssignByName($permname, $permvalue, $permskip = FALSE)
|
||||
{
|
||||
$this->permAssign($permname, $permvalue, $permskip);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a set of specified permissions from a client. Multiple permissions can be removed at once.
|
||||
*
|
||||
* @param integer $permid
|
||||
* @return void
|
||||
*/
|
||||
public function permRemove($permid)
|
||||
{
|
||||
$this->getParent()->clientPermRemove($this["client_database_id"], $permid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for permRemove().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function permRemoveByName($permname)
|
||||
{
|
||||
$this->permRemove($permname);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the channel group of a client to the ID specified.
|
||||
*
|
||||
* @param integer $cid
|
||||
* @param integer $cgid
|
||||
* @return void
|
||||
*/
|
||||
public function setChannelGroup($cid, $cgid)
|
||||
{
|
||||
$this->getParent()->clientSetChannelGroup($this["client_database_id"], $cid, $cgid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds the client to the server group specified with $sgid.
|
||||
*
|
||||
* @param integer $sgid
|
||||
* @return void
|
||||
*/
|
||||
public function addServerGroup($sgid)
|
||||
{
|
||||
$this->getParent()->serverGroupClientAdd($sgid, $this["client_database_id"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes the client from the server group specified with $sgid.
|
||||
*
|
||||
* @param integer $sgid
|
||||
* @return void
|
||||
*/
|
||||
public function remServerGroup($sgid)
|
||||
{
|
||||
$this->getParent()->serverGroupClientDel($sgid, $this["client_database_id"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the possible name of the clients avatar.
|
||||
*
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function avatarGetName()
|
||||
{
|
||||
return new TeamSpeak3_Helper_String("/avatar_" . $this["client_base64HashClientUID"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Downloads and returns the clients avatar file content.
|
||||
*
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function avatarDownload()
|
||||
{
|
||||
if($this["client_flag_avatar"] == NULL) return;
|
||||
|
||||
$download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->avatarGetName());
|
||||
$transfer = TeamSpeak3::factory("filetransfer://" . (strstr($download["host"], ":") !== FALSE ? "[" . $download["host"] . "]" : $download["host"]) . ":" . $download["port"]);
|
||||
|
||||
return $transfer->download($download["ftkey"], $download["size"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of client connections using the same identity as this client.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getClones()
|
||||
{
|
||||
return $this->execute("clientgetids", array("cluid" => $this["client_unique_identifier"]))->toAssocArray("clid");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns TRUE if the client is using Overwolf.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
public function hasOverwolf()
|
||||
{
|
||||
return strstr($this["client_badges"], "overwolf=1") !== FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of equipped badges for this client.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getBadges()
|
||||
{
|
||||
$badges = array();
|
||||
|
||||
foreach(explode(":", $this["client_badges"]) as $set)
|
||||
{
|
||||
if(substr($set, 0, 7) == "badges=")
|
||||
{
|
||||
$badges[] = array_map("trim", explode(",", substr($set, 7)));
|
||||
}
|
||||
}
|
||||
|
||||
return $badges;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the revision/build number from the clients version string.
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
public function getRev()
|
||||
{
|
||||
return $this["client_type"] ? null : $this["client_version"]->section("[", 1)->filterDigits();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns all server and channel groups the client is currently residing in.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function memberOf()
|
||||
{
|
||||
$cgroups = array($this->getParent()->channelGroupGetById($this["client_channel_group_id"]));
|
||||
$sgroups = array();
|
||||
|
||||
foreach(explode(",", $this["client_servergroups"]) as $sgid)
|
||||
{
|
||||
$sgroups[] = $this->getParent()->serverGroupGetById($sgid);
|
||||
}
|
||||
|
||||
uasort($sgroups, array(__CLASS__, "sortGroupList"));
|
||||
|
||||
return array_merge($cgroups, $sgroups);
|
||||
}
|
||||
|
||||
/**
|
||||
* Downloads and returns the clients icon file content.
|
||||
*
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function iconDownload()
|
||||
{
|
||||
if($this->iconIsLocal("client_icon_id") || $this["client_icon_id"] == 0) return;
|
||||
|
||||
$download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->iconGetName("client_icon_id"));
|
||||
$transfer = TeamSpeak3::factory("filetransfer://" . (strstr($download["host"], ":") !== FALSE ? "[" . $download["host"] . "]" : $download["host"]) . ":" . $download["port"]);
|
||||
|
||||
return $transfer->download($download["ftkey"], $download["size"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a plugin command to the client.
|
||||
*
|
||||
* @param string $plugin
|
||||
* @param string $data
|
||||
* @return void
|
||||
*/
|
||||
public function sendPluginCmd($plugin, $data)
|
||||
{
|
||||
$this->execute("plugincmd", array("name" => $plugin, "data" => $data, "targetmode" => TeamSpeak3::PLUGINCMD_CLIENT, "target" => $this->getId()));
|
||||
}
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
protected function fetchNodeInfo()
|
||||
{
|
||||
if($this->offsetExists("client_type") && $this["client_type"] == 1) return;
|
||||
|
||||
$this->nodeInfo = array_merge($this->nodeInfo, $this->execute("clientinfo", array("clid" => $this->getId()))->toList());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a unique identifier for the node which can be used as a HTML property.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getUniqueId()
|
||||
{
|
||||
return $this->getParent()->getUniqueId() . "_cl" . $this->getId();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the name of a possible icon to display the node object.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getIcon()
|
||||
{
|
||||
if($this["client_type"])
|
||||
{
|
||||
return "client_query";
|
||||
}
|
||||
elseif($this["client_away"])
|
||||
{
|
||||
return "client_away";
|
||||
}
|
||||
elseif(!$this["client_output_hardware"])
|
||||
{
|
||||
return "client_snd_disabled";
|
||||
}
|
||||
elseif($this["client_output_muted"])
|
||||
{
|
||||
return "client_snd_muted";
|
||||
}
|
||||
elseif(!$this["client_input_hardware"])
|
||||
{
|
||||
return "client_mic_disabled";
|
||||
}
|
||||
elseif($this["client_input_muted"])
|
||||
{
|
||||
return "client_mic_muted";
|
||||
}
|
||||
elseif($this["client_is_channel_commander"])
|
||||
{
|
||||
return $this["client_flag_talking"] ? "client_cc_talk" : "client_cc_idle";
|
||||
}
|
||||
else
|
||||
{
|
||||
return $this["client_flag_talking"] ? "client_talk" : "client_idle";
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a symbol representing the node.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getSymbol()
|
||||
{
|
||||
return "@";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string representation of this node.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function __toString()
|
||||
{
|
||||
return (string) $this["client_nickname"];
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,29 +1,29 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* TeamSpeak 3 PHP Framework
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* @package TeamSpeak3
|
||||
* @author Sven 'ScP' Paulsen
|
||||
* @copyright Copyright (c) Planet TeamSpeak. All rights reserved.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @class TeamSpeak3_Node_Exception
|
||||
* @brief Enhanced exception class for TeamSpeak3_Node_Abstract objects.
|
||||
*/
|
||||
class TeamSpeak3_Node_Exception extends TeamSpeak3_Exception {}
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* TeamSpeak 3 PHP Framework
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* @package TeamSpeak3
|
||||
* @author Sven 'ScP' Paulsen
|
||||
* @copyright Copyright (c) Planet TeamSpeak. All rights reserved.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @class TeamSpeak3_Node_Exception
|
||||
* @brief Enhanced exception class for TeamSpeak3_Node_Abstract objects.
|
||||
*/
|
||||
class TeamSpeak3_Node_Exception extends TeamSpeak3_Exception {}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,295 +1,295 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* TeamSpeak 3 PHP Framework
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* @package TeamSpeak3
|
||||
* @author Sven 'ScP' Paulsen
|
||||
* @copyright Copyright (c) Planet TeamSpeak. All rights reserved.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @class TeamSpeak3_Node_Servergroup
|
||||
* @brief Class describing a TeamSpeak 3 server group and all it's parameters.
|
||||
*/
|
||||
class TeamSpeak3_Node_Servergroup extends TeamSpeak3_Node_Abstract
|
||||
{
|
||||
/**
|
||||
* The TeamSpeak3_Node_Servergroup constructor.
|
||||
*
|
||||
* @param TeamSpeak3_Node_Server $server
|
||||
* @param array $info
|
||||
* @param string $index
|
||||
* @throws TeamSpeak3_Node_Exception
|
||||
* @return TeamSpeak3_Node_Servergroup
|
||||
*/
|
||||
public function __construct(TeamSpeak3_Node_Server $server, array $info, $index = "sgid")
|
||||
{
|
||||
$this->parent = $server;
|
||||
$this->nodeInfo = $info;
|
||||
|
||||
if(!array_key_exists($index, $this->nodeInfo))
|
||||
{
|
||||
throw new TeamSpeak3_Node_Exception("invalid groupID", 0xA00);
|
||||
}
|
||||
|
||||
$this->nodeId = $this->nodeInfo[$index];
|
||||
}
|
||||
|
||||
/**
|
||||
* Renames the server group specified.
|
||||
*
|
||||
* @param string $name
|
||||
* @return void
|
||||
*/
|
||||
public function rename($name)
|
||||
{
|
||||
$this->getParent()->serverGroupRename($this->getId(), $name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes the server group. If $force is set to 1, the server group will be
|
||||
* deleted even if there are clients within.
|
||||
*
|
||||
* @param boolean $force
|
||||
* @return void
|
||||
*/
|
||||
public function delete($force = FALSE)
|
||||
{
|
||||
$this->getParent()->serverGroupDelete($this->getId(), $force);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a copy of the server group and returns the new groups ID.
|
||||
*
|
||||
* @param string $name
|
||||
* @param integer $tsgid
|
||||
* @param integer $type
|
||||
* @return integer
|
||||
*/
|
||||
public function copy($name = null, $tsgid = 0, $type = TeamSpeak3::GROUP_DBTYPE_REGULAR)
|
||||
{
|
||||
return $this->getParent()->serverGroupCopy($this->getId(), $name, $tsgid, $type);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of permissions assigned to the server group.
|
||||
*
|
||||
* @param boolean $permsid
|
||||
* @return array
|
||||
*/
|
||||
public function permList($permsid = FALSE)
|
||||
{
|
||||
return $this->getParent()->serverGroupPermList($this->getId(), $permsid);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @param integer $permid
|
||||
* @param integer $permvalue
|
||||
* @param integer $permnegated
|
||||
* @param integer $permskip
|
||||
* @return void
|
||||
*/
|
||||
public function permAssign($permid, $permvalue, $permnegated = FALSE, $permskip = FALSE)
|
||||
{
|
||||
$this->getParent()->serverGroupPermAssign($this->getId(), $permid, $permvalue, $permnegated, $permskip);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for permAssign().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function permAssignByName($permname, $permvalue, $permnegated = FALSE, $permskip = FALSE)
|
||||
{
|
||||
$this->permAssign($permname, $permvalue, $permnegated, $permskip);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a set of specified permissions from the server group. Multiple
|
||||
* permissions can be removed at once.
|
||||
*
|
||||
* @param integer $permid
|
||||
* @return void
|
||||
*/
|
||||
public function permRemove($permid)
|
||||
{
|
||||
$this->getParent()->serverGroupPermRemove($this->getId(), $permid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for permRemove().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function permRemoveByName($permname)
|
||||
{
|
||||
$this->permRemove($permname);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of clients assigned to the server group specified.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function clientList()
|
||||
{
|
||||
return $this->getParent()->serverGroupClientList($this->getId());
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a client to the server group specified. Please note that a client cannot be
|
||||
* added to default groups or template groups.
|
||||
*
|
||||
* @param integer $cldbid
|
||||
* @return void
|
||||
*/
|
||||
public function clientAdd($cldbid)
|
||||
{
|
||||
$this->getParent()->serverGroupClientAdd($this->getId(), $cldbid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a client from the server group.
|
||||
*
|
||||
* @param integer $cldbid
|
||||
* @return void
|
||||
*/
|
||||
public function clientDel($cldbid)
|
||||
{
|
||||
$this->getParent()->serverGroupClientDel($this->getId(), $cldbid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for privilegeKeyCreate().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function tokenCreate($description = null, $customset = null)
|
||||
{
|
||||
return $this->privilegeKeyCreate($description, $customset);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new privilege key (token) for the server group and returns the key.
|
||||
*
|
||||
* @param string $description
|
||||
* @param string $customset
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function privilegeKeyCreate($description = null, $customset = null)
|
||||
{
|
||||
return $this->getParent()->privilegeKeyCreate(TeamSpeak3::TOKEN_SERVERGROUP, $this->getId(), 0, $description, $customset);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a text message to all clients residing in the server group on the virtual server.
|
||||
*
|
||||
* @param string $msg
|
||||
* @return void
|
||||
*/
|
||||
public function message($msg)
|
||||
{
|
||||
foreach($this as $client)
|
||||
{
|
||||
try
|
||||
{
|
||||
$this->execute("sendtextmessage", array("msg" => $msg, "target" => $client, "targetmode" => TeamSpeak3::TEXTMSG_CLIENT));
|
||||
}
|
||||
catch(TeamSpeak3_Adapter_ServerQuery_Exception $e)
|
||||
{
|
||||
/* ERROR_client_invalid_id */
|
||||
if($e->getCode() != 0x0200) throw $e;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Downloads and returns the server groups icon file content.
|
||||
*
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function iconDownload()
|
||||
{
|
||||
if($this->iconIsLocal("iconid") || $this["iconid"] == 0) return;
|
||||
|
||||
$download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->iconGetName("iconid"));
|
||||
$transfer = TeamSpeak3::factory("filetransfer://" . (strstr($download["host"], ":") !== FALSE ? "[" . $download["host"] . "]" : $download["host"]) . ":" . $download["port"]);
|
||||
|
||||
return $transfer->download($download["ftkey"], $download["size"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
protected function fetchNodeList()
|
||||
{
|
||||
$this->nodeList = array();
|
||||
|
||||
foreach($this->getParent()->clientList() as $client)
|
||||
{
|
||||
if(in_array($this->getId(), explode(",", $client["client_servergroups"])))
|
||||
{
|
||||
$this->nodeList[] = $client;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a unique identifier for the node which can be used as a HTML property.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getUniqueId()
|
||||
{
|
||||
return $this->getParent()->getUniqueId() . "_sg" . $this->getId();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the name of a possible icon to display the node object.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getIcon()
|
||||
{
|
||||
return "group_server";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a symbol representing the node.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getSymbol()
|
||||
{
|
||||
return "%";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string representation of this node.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function __toString()
|
||||
{
|
||||
return (string) $this["name"];
|
||||
}
|
||||
}
|
||||
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* TeamSpeak 3 PHP Framework
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* @package TeamSpeak3
|
||||
* @author Sven 'ScP' Paulsen
|
||||
* @copyright Copyright (c) Planet TeamSpeak. All rights reserved.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @class TeamSpeak3_Node_Servergroup
|
||||
* @brief Class describing a TeamSpeak 3 server group and all it's parameters.
|
||||
*/
|
||||
class TeamSpeak3_Node_Servergroup extends TeamSpeak3_Node_Abstract
|
||||
{
|
||||
/**
|
||||
* The TeamSpeak3_Node_Servergroup constructor.
|
||||
*
|
||||
* @param TeamSpeak3_Node_Server $server
|
||||
* @param array $info
|
||||
* @param string $index
|
||||
* @throws TeamSpeak3_Node_Exception
|
||||
* @return TeamSpeak3_Node_Servergroup
|
||||
*/
|
||||
public function __construct(TeamSpeak3_Node_Server $server, array $info, $index = "sgid")
|
||||
{
|
||||
$this->parent = $server;
|
||||
$this->nodeInfo = $info;
|
||||
|
||||
if(!array_key_exists($index, $this->nodeInfo))
|
||||
{
|
||||
throw new TeamSpeak3_Node_Exception("invalid groupID", 0xA00);
|
||||
}
|
||||
|
||||
$this->nodeId = $this->nodeInfo[$index];
|
||||
}
|
||||
|
||||
/**
|
||||
* Renames the server group specified.
|
||||
*
|
||||
* @param string $name
|
||||
* @return void
|
||||
*/
|
||||
public function rename($name)
|
||||
{
|
||||
$this->getParent()->serverGroupRename($this->getId(), $name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes the server group. If $force is set to 1, the server group will be
|
||||
* deleted even if there are clients within.
|
||||
*
|
||||
* @param boolean $force
|
||||
* @return void
|
||||
*/
|
||||
public function delete($force = FALSE)
|
||||
{
|
||||
$this->getParent()->serverGroupDelete($this->getId(), $force);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a copy of the server group and returns the new groups ID.
|
||||
*
|
||||
* @param string $name
|
||||
* @param integer $tsgid
|
||||
* @param integer $type
|
||||
* @return integer
|
||||
*/
|
||||
public function copy($name = null, $tsgid = 0, $type = TeamSpeak3::GROUP_DBTYPE_REGULAR)
|
||||
{
|
||||
return $this->getParent()->serverGroupCopy($this->getId(), $name, $tsgid, $type);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of permissions assigned to the server group.
|
||||
*
|
||||
* @param boolean $permsid
|
||||
* @return array
|
||||
*/
|
||||
public function permList($permsid = FALSE)
|
||||
{
|
||||
return $this->getParent()->serverGroupPermList($this->getId(), $permsid);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @param integer $permid
|
||||
* @param integer $permvalue
|
||||
* @param integer $permnegated
|
||||
* @param integer $permskip
|
||||
* @return void
|
||||
*/
|
||||
public function permAssign($permid, $permvalue, $permnegated = FALSE, $permskip = FALSE)
|
||||
{
|
||||
$this->getParent()->serverGroupPermAssign($this->getId(), $permid, $permvalue, $permnegated, $permskip);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for permAssign().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function permAssignByName($permname, $permvalue, $permnegated = FALSE, $permskip = FALSE)
|
||||
{
|
||||
$this->permAssign($permname, $permvalue, $permnegated, $permskip);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a set of specified permissions from the server group. Multiple
|
||||
* permissions can be removed at once.
|
||||
*
|
||||
* @param integer $permid
|
||||
* @return void
|
||||
*/
|
||||
public function permRemove($permid)
|
||||
{
|
||||
$this->getParent()->serverGroupPermRemove($this->getId(), $permid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for permRemove().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function permRemoveByName($permname)
|
||||
{
|
||||
$this->permRemove($permname);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of clients assigned to the server group specified.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function clientList()
|
||||
{
|
||||
return $this->getParent()->serverGroupClientList($this->getId());
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a client to the server group specified. Please note that a client cannot be
|
||||
* added to default groups or template groups.
|
||||
*
|
||||
* @param integer $cldbid
|
||||
* @return void
|
||||
*/
|
||||
public function clientAdd($cldbid)
|
||||
{
|
||||
$this->getParent()->serverGroupClientAdd($this->getId(), $cldbid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a client from the server group.
|
||||
*
|
||||
* @param integer $cldbid
|
||||
* @return void
|
||||
*/
|
||||
public function clientDel($cldbid)
|
||||
{
|
||||
$this->getParent()->serverGroupClientDel($this->getId(), $cldbid);
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias for privilegeKeyCreate().
|
||||
*
|
||||
* @deprecated
|
||||
*/
|
||||
public function tokenCreate($description = null, $customset = null)
|
||||
{
|
||||
return $this->privilegeKeyCreate($description, $customset);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new privilege key (token) for the server group and returns the key.
|
||||
*
|
||||
* @param string $description
|
||||
* @param string $customset
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function privilegeKeyCreate($description = null, $customset = null)
|
||||
{
|
||||
return $this->getParent()->privilegeKeyCreate(TeamSpeak3::TOKEN_SERVERGROUP, $this->getId(), 0, $description, $customset);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends a text message to all clients residing in the server group on the virtual server.
|
||||
*
|
||||
* @param string $msg
|
||||
* @return void
|
||||
*/
|
||||
public function message($msg)
|
||||
{
|
||||
foreach($this as $client)
|
||||
{
|
||||
try
|
||||
{
|
||||
$this->execute("sendtextmessage", array("msg" => $msg, "target" => $client, "targetmode" => TeamSpeak3::TEXTMSG_CLIENT));
|
||||
}
|
||||
catch(TeamSpeak3_Adapter_ServerQuery_Exception $e)
|
||||
{
|
||||
/* ERROR_client_invalid_id */
|
||||
if($e->getCode() != 0x0200) throw $e;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Downloads and returns the server groups icon file content.
|
||||
*
|
||||
* @return TeamSpeak3_Helper_String
|
||||
*/
|
||||
public function iconDownload()
|
||||
{
|
||||
if($this->iconIsLocal("iconid") || $this["iconid"] == 0) return;
|
||||
|
||||
$download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->iconGetName("iconid"));
|
||||
$transfer = TeamSpeak3::factory("filetransfer://" . (strstr($download["host"], ":") !== FALSE ? "[" . $download["host"] . "]" : $download["host"]) . ":" . $download["port"]);
|
||||
|
||||
return $transfer->download($download["ftkey"], $download["size"]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
protected function fetchNodeList()
|
||||
{
|
||||
$this->nodeList = array();
|
||||
|
||||
foreach($this->getParent()->clientList() as $client)
|
||||
{
|
||||
if(in_array($this->getId(), explode(",", $client["client_servergroups"])))
|
||||
{
|
||||
$this->nodeList[] = $client;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a unique identifier for the node which can be used as a HTML property.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getUniqueId()
|
||||
{
|
||||
return $this->getParent()->getUniqueId() . "_sg" . $this->getId();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the name of a possible icon to display the node object.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getIcon()
|
||||
{
|
||||
return "group_server";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a symbol representing the node.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getSymbol()
|
||||
{
|
||||
return "%";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string representation of this node.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function __toString()
|
||||
{
|
||||
return (string) $this["name"];
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user