TeamSpeak3_Node_Client Class Reference

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

Inheritance diagram for TeamSpeak3_Node_Client:

Public Member Functions
	__construct (TeamSpeak3_Node_Server $server, array $info, $index="clid")
	The TeamSpeak3_Node_Client constructor. More...
	__toString ()
	Returns a string representation of this node. More...
	addServerGroup ($sgid)
	Adds the client to the server group specified with $sgid. More...
	avatarDownload ()
	Downloads and returns the clients avatar file content. More...
	avatarGetName ()
	Returns the possible name of the clients avatar. More...
	ban ($timeseconds=null, $reason=null)
	Bans the client from the server. More...
	customInfo ()
	Returns a list of custom properties for the client. More...
	deleteDb ()
	Deletes the clients properties from the database. More...
	getClones ()
	Returns a list of client connections using the same identity as this client. More...
	getIcon ()
	Returns the name of a possible icon to display the node object. More...
	getRev ()
	Returns the revision/build number from the clients version string. More...
	getSymbol ()
	Returns a symbol representing the node. More...
	getUniqueId ()
	Returns a unique identifier for the node which can be used as a HTML property. More...
	iconDownload ()
	Downloads and returns the clients icon file content. More...
	infoDb ()
	Returns a list of properties from the database for the client. More...
	kick ($reasonid=TeamSpeak3::KICK_CHANNEL, $reasonmsg=null)
	Kicks the client from his currently joined channel or from the server. More...
	memberOf ()
	Returns all server and channel groups the client is currently residing in. More...
	message ($msg)
	Sends a text message to the client. More...
	modify (array $properties)
	Changes the clients properties using given properties. More...
	modifyDb (array $properties)
	Changes the clients properties using given properties. More...
	move ($cid, $cpw=null)
	Moves the client to another channel. More...
	permAssign ($permid, $permvalue, $permskip=FALSE)
	Adds a set of specified permissions to the client. More...
	permAssignByName ($permname, $permvalue, $permskip=FALSE)
	Alias for permAssign(). More...
	permList ($permsid=FALSE)
	Returns a list of permissions defined for the client. More...
	permOverview ($cid)
	Returns an array containing the permission overview of the client. More...
	permRemove ($permid)
	Removes a set of specified permissions from a client. More...
	permRemoveByName ($permname)
	Alias for permRemove(). More...
	poke ($msg)
	Sends a poke message to the client. More...
	remServerGroup ($sgid)
	Removes the client from the server group specified with $sgid. More...
	sendPluginCmd ($plugin, $data)
	Sends a plugin command to the client. More...
	setChannelGroup ($cid, $cgid)
	Sets the channel group of a client to the ID specified. More...
Public Member Functions inherited from TeamSpeak3_Node_Abstract
	__call ($name, array $args)
	Called whenever we're using an unknown method. More...
	__get ($offset)
	__set ($offset, $value)
	__sleep ()
	Commit pending data. More...
	__toString ()
	Returns a string representation of this node. More...
	count ()
	current ()
	execute ($cmd, array $params=array())
	Prepares and executes a ServerQuery command and returns the result. More...
	getChildren ()
	getClass ($prefix="ts3_")
	Returns a possible classname for the node which can be used as a HTML property. More...
	getIcon ()
	Returns the name of a possible icon to display the node object. More...
	getId ()
	Returns the primary ID of the current node. More...
	getInfo ($extend=TRUE, $convert=FALSE)
	Returns all information available on this node. More...
	getParent ()
	Returns the parent object of the current node. More...
	getProperty ($property, $default=null)
	Returns the specified property or a pre-defined default value from the node info array. More...
	getSymbol ()
	Returns a symbol representing the node. More...
	getUniqueId ()
	Returns a unique identifier for the node which can be used as a HTML property. More...
	getViewer (TeamSpeak3_Viewer_Interface $viewer)
	Returns the HTML code to display a TeamSpeak 3 viewer. More...
	hasChildren ()
	hasNext ()
	iconGetName ($key)
	Returns the internal path of the node icon. More...
	iconIsLocal ($key)
	Returns TRUE if the node icon has a local source. More...
	key ()
	next ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	prepare ($cmd, array $params=array())
	Uses given parameters and returns a prepared ServerQuery command. More...
	request ($cmd, $throw=TRUE)
	Sends a prepared command to the server and returns the result. More...
	rewind ()
	toArray ()
	Returns an assoc array filled with current node info properties. More...
	toString ()
	Returns a string representation of this node. More...
	valid ()

Protected Member Functions
	fetchNodeInfo ()
Protected Member Functions inherited from TeamSpeak3_Node_Abstract
	delStorage ($key)
	Deletes data from the internal storage array. More...
	fetchNodeInfo ()
	fetchNodeList ()
	filterList (array $nodes=array(), array $rules=array())
	Filters given node list array using specified filter rules. More...
	getStorage ($key, $default=null)
	Returns data from the internal storage array. More...
	resetNodeInfo ()
	resetNodeList ()
	setStorage ($key, $val)
	Writes data to the internal storage array. More...
	verifyNodeList ()

Additional Inherited Members
Protected Attributes inherited from TeamSpeak3_Node_Abstract
	$nodeId = 0x00
	$nodeInfo = array()
	$nodeList = null
	$parent = null
	$server = null
	$storage = array()

Detailed Description

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

Constructor & Destructor Documentation

__construct()

__construct	(	TeamSpeak3_Node_Server	$server,
		array	$info,
			$index = "clid"
	)

The TeamSpeak3_Node_Client constructor.

Parameters

TeamSpeak3_Node_Server	$server
array	$info
string	$index

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Client

  {
    $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];
  }

Member Function Documentation

__toString()

__toString

(

)

Returns a string representation of this node.

Returns

string

  {
    return (string) $this["client_nickname"];
  }

addServerGroup()

addServerGroup

(

$sgid

)

Adds the client to the server group specified with $sgid.

Parameters

integer

$sgid

Returns

void

  {
    $this->getParent()->serverGroupClientAdd($sgid, $this["client_database_id"]);
  }

avatarDownload()

avatarDownload

(

)

Downloads and returns the clients avatar file content.

Returns

TeamSpeak3_Helper_String

  {
    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"]);
  }

avatarGetName()

avatarGetName

(

)

Returns the possible name of the clients avatar.

Returns

TeamSpeak3_Helper_String

  {
    return new TeamSpeak3_Helper_String("/avatar_" . $this["client_base64HashClientUID"]);
  }

ban()

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.

Parameters

integer	$timeseconds
string	$reason

Returns

array

  {
    return $this->getParent()->clientBan($this->getId(), $timeseconds, $reason);
  }

customInfo()

customInfo

(

)

Returns a list of custom properties for the client.

Returns

array

  {
    return $this->getParent()->customInfo($this["client_database_id"]);
  }

deleteDb()

deleteDb

(

)

Deletes the clients properties from the database.

Returns

void

  {
    $this->getParent()->clientDeleteDb($this["client_database_id"]);
  }

getClones()

getClones

(

)

Returns a list of client connections using the same identity as this client.

Returns

array

  {
    return $this->execute("clientgetids", array("cluid" => $this["client_unique_identifier"]))->toAssocArray("clid");
  }

getIcon()

getIcon

(

)

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

Returns

string

  {
    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";
    }
  }

getRev()

getRev

(

)

Returns the revision/build number from the clients version string.

Returns

integer

  {
    return $this["client_type"] ? null : $this["client_version"]->section("[", 1)->filterDigits();
  }

getSymbol()

getSymbol

(

)

Returns a symbol representing the node.

Returns

string

  {
    return "@";
  }

getUniqueId()

getUniqueId

(

)

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

Returns

string

  {
    return $this->getParent()->getUniqueId() . "_cl" . $this->getId();
  }

iconDownload()

iconDownload

(

)

Downloads and returns the clients icon file content.

Returns

TeamSpeak3_Helper_String

  {
    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"]);
  }

infoDb()

infoDb

(

)

Returns a list of properties from the database for the client.

Returns

array

  {
    return $this->getParent()->clientInfoDb($this["client_database_id"]);
  }

kick()

kick	(		$reasonid = TeamSpeak3::KICK_CHANNEL,
			$reasonmsg = null
	)

Kicks the client from his currently joined channel or from the server.

Parameters

integer	$reasonid
string	$reasonmsg

Returns

void

  {
    $this->getParent()->clientKick($this->getId(), $reasonid, $reasonmsg);
  }

memberOf()

memberOf

(

)

Returns all server and channel groups the client is currently residing in.

Returns

array

  {
    $groups = array($this->getParent()->channelGroupGetById($this["client_channel_group_id"]));

    foreach(explode(",", $this["client_servergroups"]) as $sgid)
    {
      $groups[] = $this->getParent()->serverGroupGetById($sgid);
    }

    return $groups;
  }

message()

message

(

$msg

)

Sends a text message to the client.

Parameters

string

$msg

Returns

void

  {
    $this->execute("sendtextmessage", array("msg" => $msg, "target" => $this->getId(), "targetmode" => TeamSpeak3::TEXTMSG_CLIENT));
  }

modify()

modify

(

array

$properties

)

Changes the clients properties using given properties.

Parameters

array

$properties

Returns

void

  {
    $properties["clid"] = $this->getId();

    $this->execute("clientedit", $properties);
    $this->resetNodeInfo();
  }

modifyDb()

modifyDb

(

array

$properties

)

Changes the clients properties using given properties.

Parameters

array

$properties

Returns

void

  {
    $this->getParent()->clientModifyDb($this["client_database_id"], $properties);
  }

move()

move	(		$cid,
			$cpw = null
	)

Moves the client to another channel.

Parameters

integer	$cid
string	$cpw

Returns

void

  {
    $this->getParent()->clientMove($this->getId(), $cid, $cpw);
  }

permAssign()

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.

Parameters

integer	$permid
integer	$permvalue
integer	$permskip

Returns

void

  {
    $this->getParent()->clientPermAssign($this["client_database_id"], $permid, $permvalue, $permskip);
  }

permAssignByName()

permAssignByName	(		$permname,
			$permvalue,
			$permskip = FALSE
	)

Alias for permAssign().

Deprecated:

  {
    $this->permAssign($permname, $permvalue, $permskip);
  }

permList()

permList

(

$permsid = FALSE

)

Returns a list of permissions defined for the client.

Parameters

boolean

$permsid

Returns

array

  {
    return $this->getParent()->clientPermList($this["client_database_id"], $permsid);
  }

permOverview()

permOverview

(

$cid

)

Returns an array containing the permission overview of the client.

Parameters

integer

$cid

Returns

array

  {
    return $this->execute("permoverview", array("cldbid" => $this["client_database_id"], "cid" => $cid, "permid" => 0))->toArray();
  }

permRemove()

permRemove

(

$permid

)

Removes a set of specified permissions from a client.

Multiple permissions can be removed at once.

Parameters

integer

$permid

Returns

void

  {
    $this->getParent()->clientPermRemove($this["client_database_id"], $permid);
  }

permRemoveByName()

permRemoveByName

(

$permname

)

Alias for permRemove().

Deprecated:

  {
    $this->permRemove($permname);
  }

poke()

poke

(

$msg

)

Sends a poke message to the client.

Parameters

string

$msg

Returns

void

  {
    $this->getParent()->clientPoke($this->getId(), $msg);
  }

remServerGroup()

remServerGroup

(

$sgid

)

Removes the client from the server group specified with $sgid.

Parameters

integer

$sgid

Returns

void

  {
    $this->getParent()->serverGroupClientDel($sgid, $this["client_database_id"]);
  }

sendPluginCmd()

sendPluginCmd	(		$plugin,
			$data
	)

Sends a plugin command to the client.

Parameters

string	$plugin
string	$data

Returns

void

  {
    $this->execute("plugincmd", array("name" => $plugin, "data" => $data, "targetmode" => TeamSpeak3::PLUGINCMD_CLIENT, "target" => $this->getId()));
  }

setChannelGroup()

setChannelGroup	(		$cid,
			$cgid
	)

Sets the channel group of a client to the ID specified.

Parameters

integer	$cid
integer	$cgid

Returns

void

  {
    $this->getParent()->clientSetChannelGroup($this["client_database_id"], $cid, $cgid);
  }

---

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

• /Volumes/home/Repositories/planetteamspeak/ts3phpframework/libraries/TeamSpeak3/Node/Client.php