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

Inheritance diagram for TeamSpeak3_Node_Channelgroup:

Public Member Functions
	__construct (TeamSpeak3_Node_Server $server, array $info, $index="cgid")
	The TeamSpeak3_Node_Channelgroup constructor.
	rename ($name)
	Renames the channel group specified.
	delete ($force=FALSE)
	Deletes the channel group.
	copy ($name=null, $tcgid=0, $type=TeamSpeak3::GROUP_DBTYPE_REGULAR)
	Creates a copy of the channel group and returns the new groups ID.
	permList ($permsid=FALSE)
	Returns a list of permissions assigned to the channel group.
	permAssign ($permid, $permvalue)
	Adds a set of specified permissions to the channel group.
	permAssignByName ($permname, $permvalue)
	Alias for permAssign().
	permRemove ($permid)
	Removes a set of specified permissions from the channel group.
	permRemoveByName ($permname)
	Alias for permAssign().
	clientList ()
	Returns a list of clients assigned to the server group specified.
	tokenCreate ($cid, $description=null, $customset=null)
	Alias for privilegeKeyCreate().
	privilegeKeyCreate ($cid, $description=null, $customset=null)
	Creates a new privilege key (token) for the channel group and returns the key.
	message ($msg)
	Sends a text message to all clients residing in the channel group on the virtual server.
	iconDownload ()
	Downloads and returns the channel groups icon file content.
	getUniqueId ()
	Returns a unique identifier for the node which can be used as a HTML property.
	getIcon ()
	Returns the name of a possible icon to display the node object.
	getSymbol ()
	Returns a symbol representing the node.
	__toString ()
	Returns a string representation of this node.
	request ($cmd)
	Sends a prepared command to the server and returns the result.
	prepare ($cmd, array $params=array())
	Uses given parameters and returns a prepared ServerQuery command.
	execute ($cmd, array $params=array())
	Prepares and executes a ServerQuery command and returns the result.
	getParent ()
	Returns the parent object of the current node.
	getId ()
	Returns the primary ID of the current node.
	iconIsLocal ($key)
	Returns TRUE if the node icon has a local source.
	iconGetName ($key)
	Returns the internal path of the node icon.
	getClass ($prefix="ts3_")
	Returns a possible classname for the node which can be used as a HTML property.
	getViewer (TeamSpeak3_Viewer_Interface $viewer)
	Returns the HTML code to display a TeamSpeak 3 viewer.
	getInfo ($extend=TRUE, $convert=FALSE)
	Returns all information available on this node.
	getProperty ($property, $default=null)
	Returns the specified property or a pre-defined default value from the node info array.
	toString ()
	Returns a string representation of this node.
	toArray ()
	Returns an assoc array filled with current node info properties.
	__call ($name, array $args)
	Called whenever we're using an unknown method.
	__sleep ()
	Commit pending data.
	count ()

	current ()

	getChildren ()

	hasChildren ()

	hasNext ()

	key ()

	valid ()

	next ()

	rewind ()

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

	__get ($offset)

	__set ($offset, $value)

Protected Member Functions
	fetchNodeList ()

	filterList (array $nodes=array(), array $rules=array())
	Filters given node list array using specified filter rules.
	setStorage ($key, $val)
	Writes data to the internal storage array.
	getStorage ($key, $default=null)
	Returns data from the internal storage array.
	delStorage ($key)
	Deletes data from the internal storage array.
	fetchNodeInfo ()

	resetNodeInfo ()

	verifyNodeList ()

	resetNodeList ()

Protected Attributes
	$parent = null

	$server = null

	$nodeId = 0x00

	$nodeList = null

	$nodeInfo = array()

	$storage = array()

Detailed Description

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

Definition at line 32 of file Channelgroup.php.

Constructor & Destructor Documentation

TeamSpeak3_Node_Channelgroup::__construct	(	TeamSpeak3_Node_Server $	server,
		array $	info,
		$	index = `"cgid"`
	)

The TeamSpeak3_Node_Channelgroup constructor.

Parameters:

TeamSpeak3_Node_Server	$server
array	$info
string	$index

Exceptions:

TeamSpeak3_Adapter_ServerQuery_Exception

Returns:: TeamSpeak3_Node_Channelgroup

Definition at line 43 of file Channelgroup.php.

References TeamSpeak3_Node_Abstract\$server.

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

Member Function Documentation

TeamSpeak3_Node_Channelgroup::rename ( $ name )

Renames the channel group specified.

Parameters:

string $name

Returns:: void

Definition at line 62 of file Channelgroup.php.

References TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().

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

TeamSpeak3_Node_Channelgroup::delete ( $ force = FALSE )

Deletes the channel group.

If $force is set to TRUE, the channel group will be deleted even if there are clients within.

Parameters:

boolean $force

Returns:: void

Definition at line 74 of file Channelgroup.php.

References TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().

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

    unset($this);
  }

TeamSpeak3_Node_Channelgroup::copy	(	$	name = `null`,
		$	tcgid = `0`,
		$	type = `TeamSpeak3::GROUP_DBTYPE_REGULAR`
	)

Creates a copy of the channel group and returns the new groups ID.

Parameters:

string	$name
integer	$tcgid
integer	$type

Returns:: integer

Definition at line 89 of file Channelgroup.php.

References TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().

  {
    return $this->getParent()->channelGroupCopy($this->getId(), $name, $tcgid, $type);
  }

TeamSpeak3_Node_Channelgroup::permList ( $ permsid = FALSE )

Returns a list of permissions assigned to the channel group.

Parameters:

boolean $permsid

Returns:: array

Definition at line 100 of file Channelgroup.php.

References TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().

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

TeamSpeak3_Node_Channelgroup::permAssign	(	$	permid,
		$	permvalue
	)

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.

Parameters:

integer	$permid
integer	$permvalue

Returns:: void

Definition at line 113 of file Channelgroup.php.

References TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().

Referenced by permAssignByName().

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

TeamSpeak3_Node_Channelgroup::permAssignByName	(	$	permname,
		$	permvalue
	)

Alias for permAssign().

Deprecated:

Definition at line 123 of file Channelgroup.php.

References permAssign().

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

TeamSpeak3_Node_Channelgroup::permRemove ( $ permid )

Removes a set of specified permissions from the channel group.

Multiple permissions can be removed at once.

Parameters:

integer $permid

Returns:: void

Definition at line 135 of file Channelgroup.php.

References TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().

Referenced by permRemoveByName().

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

TeamSpeak3_Node_Channelgroup::permRemoveByName ( $ permname )

Alias for permAssign().

Deprecated:

Definition at line 145 of file Channelgroup.php.

References permRemove().

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

TeamSpeak3_Node_Channelgroup::clientList ( )

Returns a list of clients assigned to the server group specified.

Returns:: array

Definition at line 155 of file Channelgroup.php.

References TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().

Referenced by fetchNodeList().

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

TeamSpeak3_Node_Channelgroup::tokenCreate	(	$	cid,
		$	description = `null`,
		$	customset = `null`
	)

Alias for privilegeKeyCreate().

Deprecated:

Definition at line 165 of file Channelgroup.php.

References privilegeKeyCreate().

  {
    return $this->privilegeKeyCreate($cid, $description, $customset);
  }

TeamSpeak3_Node_Channelgroup::privilegeKeyCreate	(	$	cid,
		$	description = `null`,
		$	customset = `null`
	)

Creates a new privilege key (token) for the channel group and returns the key.

Parameters:

integer	$cid
string	$description
string	$customset

Returns:: TeamSpeak3_Helper_String

Definition at line 178 of file Channelgroup.php.

References TeamSpeak3_Node_Abstract\getId(), TeamSpeak3_Node_Abstract\getParent(), and TeamSpeak3\TOKEN_CHANNELGROUP.

Referenced by tokenCreate().

  {
    return $this->getParent()->privilegeKeyCreate(TeamSpeak3::TOKEN_CHANNELGROUP, $this->getId(), $cid, $description, $customset);
  }

TeamSpeak3_Node_Channelgroup::message ( $ msg )

Sends a text message to all clients residing in the channel group on the virtual server.

Parameters:

string $msg

Returns:: void

Definition at line 189 of file Channelgroup.php.

References TeamSpeak3_Node_Abstract\execute(), and TeamSpeak3\TEXTMSG_CLIENT.

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

TeamSpeak3_Node_Channelgroup::iconDownload ( )

Downloads and returns the channel groups icon file content.

Returns:: TeamSpeak3_Helper_String

Definition at line 210 of file Channelgroup.php.

References TeamSpeak3\factory(), TeamSpeak3_Node_Abstract\getParent(), TeamSpeak3_Node_Abstract\iconGetName(), and TeamSpeak3_Node_Abstract\iconIsLocal().

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

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

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

TeamSpeak3_Node_Channelgroup::fetchNodeList ( ) [protected]

Reimplemented from TeamSpeak3_Node_Abstract.

Definition at line 223 of file Channelgroup.php.

References clientList(), TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().

  {
    $this->nodeList = array();

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

TeamSpeak3_Node_Channelgroup::getUniqueId ( )

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

Returns:: string

Reimplemented from TeamSpeak3_Node_Abstract.

Definition at line 241 of file Channelgroup.php.

References TeamSpeak3_Node_Abstract\getId(), and TeamSpeak3_Node_Abstract\getParent().

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

TeamSpeak3_Node_Channelgroup::getIcon ( )

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

Returns:: string

Reimplemented from TeamSpeak3_Node_Abstract.

Definition at line 251 of file Channelgroup.php.

  {
    return "group_channel";
  }

TeamSpeak3_Node_Channelgroup::getSymbol ( )

Returns a symbol representing the node.

Returns:: string

Reimplemented from TeamSpeak3_Node_Abstract.

Definition at line 261 of file Channelgroup.php.

  {
    return "%";
  }

TeamSpeak3_Node_Channelgroup::__toString ( )

Returns a string representation of this node.

Returns:: string

Reimplemented from TeamSpeak3_Node_Abstract.

Definition at line 271 of file Channelgroup.php.

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

TeamSpeak3_Node_Abstract::request ( $ cmd ) [inherited]

Sends a prepared command to the server and returns the result.

Parameters:

string $cmd

Returns:: TeamSpeak3_Adapter_ServerQuery_Reply

Reimplemented in TeamSpeak3_Node_Server.

Definition at line 70 of file Abstract.php.

References TeamSpeak3_Node_Abstract\getParent().

Referenced by TeamSpeak3_Node_Host\bindingList(), TeamSpeak3_Node_Abstract\execute(), TeamSpeak3_Node_Host\fetchNodeInfo(), TeamSpeak3_Node_Host\logout(), TeamSpeak3_Node_Host\permissionList(), TeamSpeak3_Node_Host\serverList(), TeamSpeak3_Node_Host\version(), and TeamSpeak3_Node_Host\whoami().

  {
    return $this->getParent()->request($cmd);
  }

TeamSpeak3_Node_Abstract::prepare	(	$	cmd,
		array $	params = `array()`
	)		`[inherited]`

Uses given parameters and returns a prepared ServerQuery command.

Parameters:

string	$cmd
array	$params

Returns:: TeamSpeak3_Helper_String

Definition at line 82 of file Abstract.php.

References TeamSpeak3_Node_Abstract\getParent().

Referenced by TeamSpeak3_Node_Abstract\execute().

  {
    return $this->getParent()->prepare($cmd, $params);
  }

TeamSpeak3_Node_Abstract::execute	(	$	cmd,
		array $	params = `array()`
	)		`[inherited]`

Prepares and executes a ServerQuery command and returns the result.

Parameters:

string	$cmd
array	$params

Returns:: TeamSpeak3_Adapter_ServerQuery_Reply

Definition at line 94 of file Abstract.php.

References TeamSpeak3_Node_Abstract\prepare(), and TeamSpeak3_Node_Abstract\request().

  {
    return $this->request($this->prepare($cmd, $params));
  }

TeamSpeak3_Node_Abstract::getParent ( ) [inherited]

Returns the parent object of the current node.

Returns:: TeamSpeak3_Adapter_ServerQuery; TeamSpeak3_Node_Abstract

Definition at line 105 of file Abstract.php.

  {
    return $this->parent;
  }

TeamSpeak3_Node_Abstract::getId ( ) [inherited]

Returns the primary ID of the current node.

Returns:: integer

Definition at line 115 of file Abstract.php.

  {
    return $this->nodeId;
  }

TeamSpeak3_Node_Abstract::iconIsLocal ( $ key ) [inherited]

Returns TRUE if the node icon has a local source.

Returns:: boolean

Definition at line 125 of file Abstract.php.

Referenced by iconDownload(), TeamSpeak3_Node_Servergroup\iconDownload(), TeamSpeak3_Node_Client\iconDownload(), TeamSpeak3_Node_Channel\iconDownload(), and TeamSpeak3_Node_Server\iconDownload().

  {
    return ($this[$key] > 0 && $this[$key] < 1000) ? TRUE : FALSE;
  }

TeamSpeak3_Node_Abstract::iconGetName ( $ key ) [inherited]

Returns the internal path of the node icon.

Returns:: TeamSpeak3_Helper_String

Definition at line 135 of file Abstract.php.

Referenced by TeamSpeak3_Node_Abstract\getInfo(), iconDownload(), TeamSpeak3_Node_Servergroup\iconDownload(), TeamSpeak3_Node_Client\iconDownload(), TeamSpeak3_Node_Channel\iconDownload(), and TeamSpeak3_Node_Server\iconDownload().

  {
    $iconid = ($this[$key] < 0) ? (pow(2, 32))-($this[$key]*-1) : $this[$key];

    return new TeamSpeak3_Helper_String("/icon_" . $iconid);
  }

TeamSpeak3_Node_Abstract::getClass ( $ prefix = "ts3_" ) [inherited]

Returns a possible classname for the node which can be used as a HTML property.

Returns:: string

Definition at line 147 of file Abstract.php.

References TeamSpeak3_Helper_String\factory().

  {
    if($this instanceof TeamSpeak3_Node_Channel && $this->isSpacer())
    {
      return $prefix . "spacer";
    }
    elseif($this instanceof TeamSpeak3_Node_Client && $this["client_type"])
    {
      return $prefix . "query";
    }

    return $prefix . TeamSpeak3_Helper_String::factory(get_class($this))->section("_", 2)->toLower();
  }

TeamSpeak3_Node_Abstract::getViewer ( TeamSpeak3_Viewer_Interface $ viewer ) [inherited]

Returns the HTML code to display a TeamSpeak 3 viewer.

Parameters:

TeamSpeak3_Viewer_Interface $viewer

Returns:: string

Definition at line 188 of file Abstract.php.

References TeamSpeak3_Viewer_Interface\fetchObject().

  {
    $html = $viewer->fetchObject($this);

    $iterator = new RecursiveIteratorIterator($this, RecursiveIteratorIterator::SELF_FIRST);

    foreach($iterator as $node)
    {
      $siblings = array();

      for($level = 0; $level < $iterator->getDepth(); $level++)
      {
        $siblings[] = ($iterator->getSubIterator($level)->hasNext()) ? 1 : 0;
      }

      $siblings[] = (!$iterator->getSubIterator($level)->hasNext()) ? 1 : 0;

      $html .= $viewer->fetchObject($node, $siblings);
    }

    return $html;
  }

TeamSpeak3_Node_Abstract::filterList	(	array $	nodes = `array()`,
		array $	rules = `array()`
	)		`[protected, inherited]`

Filters given node list array using specified filter rules.

Parameters:

array	$nodes
array	$rules

Returns:: array

Definition at line 218 of file Abstract.php.

Referenced by TeamSpeak3_Node_Server\channelGroupList(), TeamSpeak3_Node_Server\channelList(), TeamSpeak3_Node_Channel\clientList(), TeamSpeak3_Node_Server\clientList(), TeamSpeak3_Node_Server\serverGroupList(), TeamSpeak3_Node_Host\serverList(), and TeamSpeak3_Node_Channel\subChannelList().

  {
    if(!empty($rules))
    {
      foreach($nodes as $node)
      {
        if(!$node instanceof TeamSpeak3_Node_Abstract) continue;

        $props = $node->getInfo(FALSE);
        $props = array_intersect_key($props, $rules);
        $match = TRUE;

        foreach($props as $key => $val)
        {
          if($val instanceof TeamSpeak3_Helper_String)
          {
            $match = $val->contains($rules[$key], TRUE);
          }
          else
          {
            $match = $val == $rules[$key];
          }

          if($match === FALSE)
          {
            unset($nodes[$node->getId()]);
          }
        }
      }
    }

    return $nodes;
  }

TeamSpeak3_Node_Abstract::getInfo	(	$	extend = `TRUE`,
		$	convert = `FALSE`
	)		`[inherited]`

Returns all information available on this node.

If $convert is enabled, some property values will be converted to human-readable values.

Parameters:

boolean	$extend
boolean	$convert

Returns:: array

Definition at line 260 of file Abstract.php.

References TeamSpeak3_Helper_Convert\bytes(), TeamSpeak3_Helper_String\factory(), TeamSpeak3_Node_Abstract\fetchNodeInfo(), TeamSpeak3_Node_Abstract\iconGetName(), TeamSpeak3_Helper_Convert\seconds(), and TeamSpeak3_Helper_Convert\version().

  {
    if($extend)
    {
      $this->fetchNodeInfo();
    }

    if($convert)
    {
      $info = $this->nodeInfo;

      foreach($info as $key => $val)
      {
        $key = TeamSpeak3_Helper_String::factory($key);

        if($key->contains("_bytes_"))
        {
          $info[$key->toString()] = TeamSpeak3_Helper_Convert::bytes($val);
        }
        elseif($key->contains("_bandwidth_"))
        {
          $info[$key->toString()] = TeamSpeak3_Helper_Convert::bytes($val) . "/s";
        }
        elseif($key->contains("_packets_"))
        {
          $info[$key->toString()] = number_format($val, null, null, ".");
        }
        elseif($key->contains("_packetloss_"))
        {
          $info[$key->toString()] = sprintf("%01.2f", floatval($val->toString())*100) . "%";
        }
        elseif($key->endsWith("_uptime"))
        {
          $info[$key->toString()] = TeamSpeak3_Helper_Convert::seconds($val);
        }
        elseif($key->endsWith("_version"))
        {
          $info[$key->toString()] = TeamSpeak3_Helper_Convert::version($val);
        }
        elseif($key->endsWith("_icon_id"))
        {
          $info[$key->toString()] = $this->iconGetName($key)->filterDigits();
        }
      }

      return $info;
    }

    return $this->nodeInfo;
  }

TeamSpeak3_Node_Abstract::getProperty	(	$	property,
		$	default = `null`
	)		`[inherited]`

Returns the specified property or a pre-defined default value from the node info array.

Parameters:

string	$property
mixed	$default

Returns:: mixed

Definition at line 318 of file Abstract.php.

References TeamSpeak3_Node_Abstract\fetchNodeInfo(), and TeamSpeak3_Node_Abstract\offsetExists().

Referenced by TeamSpeak3_Node_Server\sortClientList(), and TeamSpeak3_Node_Server\sortGroupList().

  {
    if(!$this->offsetExists($property))
    {
      $this->fetchNodeInfo();
    }

    if(!$this->offsetExists($property))
    {
      return $default;
    }

    return $this->nodeInfo[(string) $property];
  }

TeamSpeak3_Node_Abstract::toString ( ) [inherited]

Returns a string representation of this node.

Returns:: string

Definition at line 348 of file Abstract.php.

References TeamSpeak3_Node_Abstract\__toString().

  {
    return $this->__toString();
  }

TeamSpeak3_Node_Abstract::toArray ( ) [inherited]

Returns an assoc array filled with current node info properties.

Returns:: array

Definition at line 358 of file Abstract.php.

Referenced by TeamSpeak3_Node_Server\channelFileInfo().

  {
    return $this->nodeList;
  }

TeamSpeak3_Node_Abstract::__call	(	$	name,
		array $	args
	)		`[inherited]`

Called whenever we're using an unknown method.

Parameters:

string	$name
array	$args

Exceptions:

TeamSpeak3_Node_Exception

Returns:: mixed

Definition at line 371 of file Abstract.php.

References TeamSpeak3_Node_Abstract\getParent().

  {
    if($this->getParent() instanceof TeamSpeak3_Node_Abstract)
    {
      return call_user_func_array(array($this->getParent(), $name), $args);
    }

    throw new TeamSpeak3_Node_Exception("node method '" . $name . "()' does not exist");
  }

TeamSpeak3_Node_Abstract::setStorage	(	$	key,
		$	val
	)		`[protected, inherited]`

Writes data to the internal storage array.

Parameters:

string	$key
mixed	$val

Returns:: void

Definition at line 388 of file Abstract.php.

Referenced by TeamSpeak3_Node_Host\login(), TeamSpeak3_Node_Host\serverSelect(), TeamSpeak3_Node_Host\serverSelectByPort(), TeamSpeak3_Node_Host\setExcludeQueryClients(), TeamSpeak3_Node_Host\setLoadClientlistFirst(), TeamSpeak3_Node_Host\setPredefinedQueryName(), and TeamSpeak3_Node_Host\setUseOfflineAsVirtual().

  {
    $this->storage[$key] = $val;
  }

TeamSpeak3_Node_Abstract::getStorage	(	$	key,
		$	default = `null`
	)		`[protected, inherited]`

Returns data from the internal storage array.

Parameters:

string	$key
mixed	$default

Returns:: mixed

Definition at line 400 of file Abstract.php.

Referenced by TeamSpeak3_Node_Host\__wakeup().

  {
    return (array_key_exists($key, $this->storage) && !empty($this->storage[$key])) ? $this->storage[$key] : $default;
  }

TeamSpeak3_Node_Abstract::delStorage ( $ key ) [protected, inherited]

Deletes data from the internal storage array.

Parameters:

string $key

Returns:: void

Definition at line 411 of file Abstract.php.

Referenced by TeamSpeak3_Node_Host\logout(), and TeamSpeak3_Node_Host\serverDeselect().

  {
    unset($this->storage[$key]);
  }

TeamSpeak3_Node_Abstract::__sleep ( ) [inherited]

Commit pending data.

Returns:: array

Definition at line 421 of file Abstract.php.

  {
    return array("parent", "storage", "nodeId");
  }

TeamSpeak3_Node_Abstract::fetchNodeInfo ( ) [protected, inherited]

Reimplemented in TeamSpeak3_Node_Server, TeamSpeak3_Node_Host, TeamSpeak3_Node_Channel, and TeamSpeak3_Node_Client.

Definition at line 437 of file Abstract.php.

Referenced by TeamSpeak3_Node_Abstract\getInfo(), TeamSpeak3_Node_Abstract\getProperty(), and TeamSpeak3_Node_Abstract\offsetGet().

  {
    return;
  }

TeamSpeak3_Node_Abstract::resetNodeInfo ( ) [protected, inherited]

Definition at line 445 of file Abstract.php.

Referenced by TeamSpeak3_Node_Client\modify(), TeamSpeak3_Node_Channel\modify(), TeamSpeak3_Node_Host\modify(), and TeamSpeak3_Node_Server\modify().

  {
    $this->nodeInfo = array();
  }

TeamSpeak3_Node_Abstract::verifyNodeList ( ) [protected, inherited]

Definition at line 453 of file Abstract.php.

References TeamSpeak3_Node_Abstract\fetchNodeList().

Referenced by TeamSpeak3_Node_Abstract\count(), TeamSpeak3_Node_Abstract\current(), TeamSpeak3_Node_Abstract\getChildren(), TeamSpeak3_Node_Abstract\hasChildren(), TeamSpeak3_Node_Abstract\hasNext(), TeamSpeak3_Node_Abstract\key(), TeamSpeak3_Node_Abstract\next(), TeamSpeak3_Node_Abstract\rewind(), and TeamSpeak3_Node_Abstract\valid().

  {
    if($this->nodeList === null)
    {
      $this->fetchNodeList();
    }
  }

TeamSpeak3_Node_Abstract::resetNodeList ( ) [protected, inherited]

Definition at line 464 of file Abstract.php.

Referenced by TeamSpeak3_Node_Server\channelList(), TeamSpeak3_Node_Server\channelListReset(), TeamSpeak3_Node_Server\clientList(), TeamSpeak3_Node_Server\clientListReset(), TeamSpeak3_Node_Host\serverList(), and TeamSpeak3_Node_Host\serverListReset().

  {
    $this->nodeList = null;
  }

TeamSpeak3_Node_Abstract::count ( ) [inherited]

Definition at line 472 of file Abstract.php.

References TeamSpeak3_Node_Abstract\verifyNodeList().

Referenced by TeamSpeak3_Node_Server\channelFileList(), TeamSpeak3_Node_Server\channelGroupCopy(), TeamSpeak3_Node_Abstract\hasNext(), TeamSpeak3_Node_Server\permRemoveAny(), and TeamSpeak3_Node_Server\serverGroupCopy().

  {
    $this->verifyNodeList();

    return count($this->nodeList);
  }

TeamSpeak3_Node_Abstract::current ( ) [inherited]

Definition at line 482 of file Abstract.php.

References TeamSpeak3_Node_Abstract\verifyNodeList().

  {
    $this->verifyNodeList();

    return current($this->nodeList);
  }

TeamSpeak3_Node_Abstract::getChildren ( ) [inherited]

Definition at line 492 of file Abstract.php.

References TeamSpeak3_Node_Abstract\current(), and TeamSpeak3_Node_Abstract\verifyNodeList().

  {
    $this->verifyNodeList();

    return $this->current();
  }

TeamSpeak3_Node_Abstract::hasChildren ( ) [inherited]

Definition at line 502 of file Abstract.php.

References TeamSpeak3_Node_Abstract\current(), and TeamSpeak3_Node_Abstract\verifyNodeList().

  {
    $this->verifyNodeList();

    return $this->current()->count() > 0;
  }

TeamSpeak3_Node_Abstract::hasNext ( ) [inherited]

Definition at line 512 of file Abstract.php.

References TeamSpeak3_Node_Abstract\count(), TeamSpeak3_Node_Abstract\key(), and TeamSpeak3_Node_Abstract\verifyNodeList().

  {
    $this->verifyNodeList();

    return $this->key()+1 < $this->count();
  }

TeamSpeak3_Node_Abstract::key ( ) [inherited]

Definition at line 522 of file Abstract.php.

References TeamSpeak3_Node_Abstract\verifyNodeList().

Referenced by TeamSpeak3_Node_Abstract\hasNext(), and TeamSpeak3_Node_Abstract\valid().

  {
    $this->verifyNodeList();

    return key($this->nodeList);
  }

TeamSpeak3_Node_Abstract::valid ( ) [inherited]

Definition at line 532 of file Abstract.php.

References TeamSpeak3_Node_Abstract\key(), and TeamSpeak3_Node_Abstract\verifyNodeList().

  {
    $this->verifyNodeList();

    return $this->key() !== null;
  }

TeamSpeak3_Node_Abstract::next ( ) [inherited]

Definition at line 542 of file Abstract.php.

References TeamSpeak3_Node_Abstract\verifyNodeList().

  {
    $this->verifyNodeList();

    return next($this->nodeList);
  }

TeamSpeak3_Node_Abstract::rewind ( ) [inherited]

Definition at line 552 of file Abstract.php.

References TeamSpeak3_Node_Abstract\verifyNodeList().

  {
    $this->verifyNodeList();

    return reset($this->nodeList);
  }

TeamSpeak3_Node_Abstract::offsetExists ( $ offset ) [inherited]

Definition at line 562 of file Abstract.php.

Referenced by TeamSpeak3_Node_Abstract\getProperty(), and TeamSpeak3_Node_Abstract\offsetGet().

  {
    return array_key_exists((string) $offset, $this->nodeInfo) ? TRUE : FALSE;
  }

TeamSpeak3_Node_Abstract::offsetGet ( $ offset ) [inherited]

Definition at line 570 of file Abstract.php.

References TeamSpeak3_Node_Abstract\fetchNodeInfo(), and TeamSpeak3_Node_Abstract\offsetExists().

Referenced by TeamSpeak3_Node_Abstract\__get().

  {
    if(!$this->offsetExists($offset))
    {
      $this->fetchNodeInfo();
    }

    if(!$this->offsetExists($offset))
    {
      echo $offset;

      throw new TeamSpeak3_Adapter_ServerQuery_Exception("invalid parameter", 0x602);
    }

    return $this->nodeInfo[(string) $offset];
  }

TeamSpeak3_Node_Abstract::offsetSet	(	$	offset,
		$	value
	)		`[inherited]`

Definition at line 590 of file Abstract.php.

Referenced by TeamSpeak3_Node_Abstract\__set().

  {
    if(method_exists($this, "modify"))
    {
      return $this->modify(array((string) $offset => $value));
    }

    throw new TeamSpeak3_Node_Exception("node '" . get_class($this) . "' is read only");
  }

TeamSpeak3_Node_Abstract::offsetUnset ( $ offset ) [inherited]

Definition at line 603 of file Abstract.php.

  {
    unset($this->nodeInfo[(string) $offset]);
  }

TeamSpeak3_Node_Abstract::__get ( $ offset ) [inherited]

Definition at line 611 of file Abstract.php.

References TeamSpeak3_Node_Abstract\offsetGet().

  {
    return $this->offsetGet($offset);
  }

TeamSpeak3_Node_Abstract::__set	(	$	offset,
		$	value
	)		`[inherited]`

Definition at line 619 of file Abstract.php.

References TeamSpeak3_Node_Abstract\offsetSet().

  {
    $this->offsetSet($offset, $value);
  }

Member Data Documentation

TeamSpeak3_Node_Abstract::$parent = null [protected, inherited]

Definition at line 37 of file Abstract.php.

TeamSpeak3_Node_Abstract::$server = null [protected, inherited]

Definition at line 42 of file Abstract.php.

Referenced by TeamSpeak3_Node_Channel\__construct(), __construct(), TeamSpeak3_Node_Servergroup\__construct(), TeamSpeak3_Node_Client\__construct(), TeamSpeak3_Node_Host\__wakeup(), TeamSpeak3_Node_Host\fetchNodeList(), TeamSpeak3_Node_Host\serverCreate(), TeamSpeak3_Node_Host\serverGetByName(), TeamSpeak3_Node_Host\serverGetByUid(), and TeamSpeak3_Node_Host\serverList().

TeamSpeak3_Node_Abstract::$nodeId = 0x00 [protected, inherited]

Definition at line 47 of file Abstract.php.

TeamSpeak3_Node_Abstract::$nodeList = null [protected, inherited]

Definition at line 52 of file Abstract.php.

TeamSpeak3_Node_Abstract::$nodeInfo = array() [protected, inherited]

Definition at line 57 of file Abstract.php.

TeamSpeak3_Node_Abstract::$storage = array() [protected, inherited]

Definition at line 62 of file Abstract.php.

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

libraries/TeamSpeak3/Node/Channelgroup.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation