TeamSpeak3_Node_Channel Class Reference

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

Inheritance diagram for TeamSpeak3_Node_Channel:

Public Member Functions
	__construct (TeamSpeak3_Node_Server $server, array $info, $index="cid")
	The TeamSpeak3_Node_Channel constructor. More...
	__toString ()
	Returns a string representation of this node. More...
	clientGetById ($clid)
	Returns the TeamSpeak3_Node_Client object matching the given ID. More...
	clientGetByName ($name)
	Returns the TeamSpeak3_Node_Client object matching the given name. More...
	clientList (array $filter=array())
	Returns an array filled with TeamSpeak3_Node_Client objects. More...
	clientPermAssign ($cldbid, $permid, $permvalue)
	Adds a set of specified permissions to a client in a specific channel. More...
	clientPermAssignByName ($cldbid, $permname, $permvalue)
	Alias for clientPermAssign(). More...
	clientPermList ($cldbid, $permsid=FALSE)
	Returns a list of permissions defined for a client in the channel. More...
	clientPermRemove ($cldbid, $permid)
	Removes a set of specified permissions from a client in the channel. More...
	clientPermRemoveByName ($cldbid, $permname)
	Alias for clientPermRemove(). More...
	delete ($force=FALSE)
	Deletes the channel. More...
	dirCreate ($cpw="", $dirname="/")
	Creates new directory in a channels file repository. More...
	fileDelete ($cpw="", $name="/")
	Deletes one or more files stored in the channels file repository. More...
	fileInfo ($cpw="", $name="/")
	Returns detailed information about the specified file stored in the channels file repository. More...
	fileList ($cpw="", $path="/", $recursive=FALSE)
	Returns a list of files and directories stored in the channels file repository. More...
	fileRename ($cpw="", $oldname="/", $newname="/", $tcid=null, $tcpw=null)
	Renames a file in the channels file repository. More...
	getIcon ()
	Returns the name of a possible icon to display the node object. More...
	getLevel ()
	Returns the level of the channel. More...
	getPathway ()
	Returns the pathway of the channel which can be used as a clients default channel. 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 channels icon file content. More...
	isSpacer ()
	Returns TRUE if the channel is a spacer. More...
	message ($msg, $cpw=null)
	Sends a text message to all clients in the channel. More...
	modify (array $properties)
	Changes the channel configuration using given properties. More...
	move ($pid, $order=null)
	Moves the channel to the parent channel specified with $pid. More...
	permAssign ($permid, $permvalue)
	Adds a set of specified permissions to the channel. More...
	permAssignByName ($permname, $permvalue)
	Alias for permAssign(). More...
	permList ($permsid=FALSE)
	Returns a list of permissions defined for the channel. More...
	permRemove ($permid)
	Removes a set of specified permissions from the channel. More...
	permRemoveByName ($permname)
	Alias for permRemove(). More...
	sendPluginCmd ($plugin, $data, $cpw=null, $subscribed=FALSE)
	Sends a plugin command to all clients in the channel. More...
	spacerGetAlign ()
	Returns the possible spacer alignment of the channel. More...
	spacerGetType ()
	Returns the possible spacer type of the channel. More...
	subChannelGetById ($cid)
	Returns the TeamSpeak3_Node_Channel object matching the given ID. More...
	subChannelGetByName ($name)
	Returns the TeamSpeak3_Node_Channel object matching the given name. More...
	subChannelList (array $filter=array())
	Returns an array filled with TeamSpeak3_Node_Channel objects. 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 ()
	fetchNodeList ()
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 channel and all it's parameters.

Constructor & Destructor Documentation

__construct()

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

The TeamSpeak3_Node_Channel constructor.

Parameters

TeamSpeak3_Node_Server	$server
array	$info
string	$index

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Channel

  {
    $this->parent = $server;
    $this->nodeInfo = $info;

    if(!array_key_exists($index, $this->nodeInfo))
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid channelID", 0x300);
    }

    $this->nodeId = $this->nodeInfo[$index];
  }

Member Function Documentation

__toString()

__toString

(

)

Returns a string representation of this node.

Returns

string

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

clientGetById()

clientGetById

(

$clid

)

Returns the TeamSpeak3_Node_Client object matching the given ID.

Parameters

integer

$clid

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Client

  {
    if(!array_key_exists($clid, $this->clientList()))
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid clientID", 0x200);
    }

    return $this->clientList[intval($clid)];
  }

clientGetByName()

clientGetByName

(

$name

)

Returns the TeamSpeak3_Node_Client object matching the given name.

Parameters

integer

$name

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Client

  {
    foreach($this->clientList() as $client)
    {
      if($client["client_nickname"] == $name) return $client;
    }

    throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid clientID", 0x200);
  }

clientList()

clientList

(

array

$filter = array()

)

Returns an array filled with TeamSpeak3_Node_Client objects.

Parameters

array

$filter

Returns

array|TeamSpeak3_Node_Client[]

  {
    $clients = array();

    foreach($this->getParent()->clientList() as $client)
    {
      if($client["cid"] == $this->getId())
      {
        $clients[$client->getId()] = $client;
      }
    }

    return $this->filterList($clients, $filter);
  }

clientPermAssign()

clientPermAssign	(		$cldbid,
			$permid,
			$permvalue
	)

Adds a set of specified permissions to a client in a specific channel.

Multiple permissions can be added by providing the two parameters of each permission.

Parameters

integer	$cldbid
integer	$permid
integer	$permvalue

Returns

void

  {
    $this->getParent()->channelClientPermAssign($this->getId(), $cldbid, $permid, $permvalue);
  }

clientPermAssignByName()

clientPermAssignByName	(		$cldbid,
			$permname,
			$permvalue
	)

Alias for clientPermAssign().

Deprecated:

  {
    $this->clientPermAssign($cldbid, $permname, $permvalue);
  }

clientPermList()

clientPermList	(		$cldbid,
			$permsid = FALSE
	)

Returns a list of permissions defined for a client in the channel.

Parameters

integer	$cldbid
boolean	$permsid

Returns

array

  {
    return $this->getParent()->channelClientPermList($this->getId(), $cldbid, $permsid);
  }

clientPermRemove()

clientPermRemove	(		$cldbid,
			$permid
	)

Removes a set of specified permissions from a client in the channel.

Multiple permissions can be removed at once.

Parameters

integer	$cldbid
integer	$permid

Returns

void

  {
    $this->getParent()->channelClientPermRemove($this->getId(), $cldbid, $permid);
  }

clientPermRemoveByName()

clientPermRemoveByName	(		$cldbid,
			$permname
	)

Alias for clientPermRemove().

Deprecated:

  {
    $this->clientPermRemove($cldbid, $permname);
  }

delete()

delete

(

$force = FALSE

)

Deletes the channel.

Parameters

boolean

$force

Returns

void

  {
    $this->getParent()->channelDelete($this->getId(), $force);
  }

dirCreate()

dirCreate	(		$cpw = "",
			$dirname = "/"
	)

Creates new directory in a channels file repository.

Parameters

string	$cpw
string	$dirname

Returns

void

  {
    $this->getParent()->channelDirCreate($this->getId(), $cpw, $dirname);
  }

fileDelete()

fileDelete	(		$cpw = "",
			$name = "/"
	)

Deletes one or more files stored in the channels file repository.

Parameters

string	$cpw
string	$path

Returns

void

  {
    $this->getParent()->channelFileDelete($this->getId(), $cpw, $name);
  }

fileInfo()

fileInfo	(		$cpw = "",
			$name = "/"
	)

Returns detailed information about the specified file stored in the channels file repository.

Parameters

string	$cpw
string	$name

Returns

array

  {
    return $this->getParent()->channelFileInfo($this->getId(), $cpw, $name);
  }

fileList()

fileList	(		$cpw = "",
			$path = "/",
			$recursive = FALSE
	)

Returns a list of files and directories stored in the channels file repository.

Parameters

string	$cpw
string	$path
boolean	$recursive

Returns

array

  {
    return $this->getParent()->channelFileList($this->getId(), $cpw, $path, $recursive);
  }

fileRename()

fileRename	(		$cpw = "",
			$oldname = "/",
			$newname = "/",
			$tcid = null,
			$tcpw = null
	)

Renames a file in the channels file repository.

If the two parameters $tcid and $tcpw are specified, the file will be moved into another channels file repository.

Parameters

string	$cpw
string	$oldname
string	$newname
integer	$tcid
string	$tcpw

Returns

void

  {
    $this->getParent()->channelFileRename($this->getId(), $cpw, $oldname, $newname, $tcid, $tcpw);
  }

getIcon()

getIcon

(

)

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

Returns

string

  {
    if($this["channel_maxclients"] != -1 && $this["channel_maxclients"] <= $this["total_clients"])
    {
      return "channel_full";
    }
    elseif($this["channel_flag_password"])
    {
      return "channel_pass";
    }
    else
    {
      return "channel_open";
    }
  }

getLevel()

getLevel

(

)

Returns the level of the channel.

Returns

integer

  {
    return $this->getParent()->channelGetLevel($this->getId());
  }

getPathway()

getPathway

(

)

Returns the pathway of the channel which can be used as a clients default channel.

Returns

string

  {
    return $this->getParent()->channelGetPathway($this->getId());
  }

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() . "_ch" . $this->getId();
  }

iconDownload()

iconDownload

(

)

Downloads and returns the channels icon file content.

Returns

TeamSpeak3_Helper_String

  {
    if($this->iconIsLocal("channel_icon_id") || $this["channel_icon_id"] == 0) return;

    $download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->iconGetName("channel_icon_id"));
    $transfer = TeamSpeak3::factory("filetransfer://" . (strstr($download["host"], ":") !== FALSE ? "[" . $download["host"] . "]" : $download["host"]) . ":" . $download["port"]);

    return $transfer->download($download["ftkey"], $download["size"]);
  }

isSpacer()

isSpacer

(

)

Returns TRUE if the channel is a spacer.

Returns

boolean

  {
    return $this->getParent()->channelIsSpacer($this);
  }

message()

message	(		$msg,
			$cpw = null
	)

Sends a text message to all clients in the channel.

Parameters

string	$msg
string	$cpw

Returns

void

  {
    if($this->getId() != $this->getParent()->whoamiGet("client_channel_id"))
    {
      $this->getParent()->clientMove($this->getParent()->whoamiGet("client_id"), $this->getId(), $cpw);
    }

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

modify()

modify

(

array

$properties

)

Changes the channel configuration using given properties.

Parameters

array

$properties

Returns

void

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

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

move()

move	(		$pid,
			$order = null
	)

Moves the channel to the parent channel specified with $pid.

Parameters

integer	$pid
integer	$order

Returns

void

  {
    $this->getParent()->channelMove($this->getId(), $pid, $order);
  }

permAssign()

permAssign	(		$permid,
			$permvalue
	)

Adds a set of specified permissions to the channel.

Multiple permissions can be added by providing the two parameters of each permission.

Parameters

integer	$permid
integer	$permvalue

Returns

void

  {
    $this->getParent()->channelPermAssign($this->getId(), $permid, $permvalue);
  }

permAssignByName()

permAssignByName	(		$permname,
			$permvalue
	)

Alias for permAssign().

Deprecated:

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

permList()

permList

(

$permsid = FALSE

)

Returns a list of permissions defined for the channel.

Parameters

boolean

$permsid

Returns

array

  {
    return $this->getParent()->channelPermList($this->getId(), $permsid);
  }

permRemove()

permRemove

(

$permid

)

Removes a set of specified permissions from the channel.

Multiple permissions can be removed at once.

Parameters

integer

$permid

Returns

void

  {
    $this->getParent()->channelPermRemove($this->getId(), $permid);
  }

permRemoveByName()

permRemoveByName

(

$permname

)

Alias for permRemove().

Deprecated:

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

sendPluginCmd()

sendPluginCmd	(		$plugin,
			$data,
			$cpw = null,
			$subscribed = FALSE
	)

Sends a plugin command to all clients in the channel.

Parameters

string	$plugin
string	$data
string	$cpw
boolean	$subscribed

Returns

void

  {
    if($this->getId() != $this->getParent()->whoamiGet("client_channel_id"))
    {
      $this->getParent()->clientMove($this->getParent()->whoamiGet("client_id"), $this->getId(), $cpw);
    }
    
    $this->execute("plugincmd", array("name" => $plugin, "data" => $data, "targetmode" => $subscribed ? TeamSpeak3::PLUGINCMD_CHANNEL_SUBSCRIBED : TeamSpeak3::PLUGINCMD_CHANNEL));
  }

spacerGetAlign()

spacerGetAlign

(

)

Returns the possible spacer alignment of the channel.

Returns

integer

  {
    return $this->getParent()->channelSpacerGetAlign($this->getId());
  }

spacerGetType()

spacerGetType

(

)

Returns the possible spacer type of the channel.

Returns

integer

  {
    return $this->getParent()->channelSpacerGetType($this->getId());
  }

subChannelGetById()

subChannelGetById

(

$cid

)

Returns the TeamSpeak3_Node_Channel object matching the given ID.

Parameters

integer

$cid

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Channel

  {
    if(!array_key_exists((int) $cid, $this->subChannelList()))
    {
      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid channelID", 0x300);
    }

    return $this->channelList[(int) $cid];
  }

subChannelGetByName()

subChannelGetByName

(

$name

)

Returns the TeamSpeak3_Node_Channel object matching the given name.

Parameters

integer

$name

Exceptions

TeamSpeak3_Adapter_ServerQuery_Exception

Returns

TeamSpeak3_Node_Channel

  {
    foreach($this->subChannelList() as $channel)
    {
      if($channel["channel_name"] == $name) return $channel;
    }

    throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid channelID", 0x300);
  }

subChannelList()

subChannelList

(

array

$filter = array()

)

Returns an array filled with TeamSpeak3_Node_Channel objects.

Parameters

array

$filter

Returns

array|TeamSpeak3_Node_Channel[]

  {
    $channels = array();

    foreach($this->getParent()->channelList() as $channel)
    {
      if($channel["pid"] == $this->getId())
      {
        $channels[$channel->getId()] = $channel;
      }
    }

    return $this->filterList($channels, $filter);
  }

---

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

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