TeamSpeak3_Node_Abstract Class Reference

Abstract class describing a TeamSpeak 3 node and all it's parameters. More...

Inheritance diagram for TeamSpeak3_Node_Abstract:

Public Member Functions
	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.
	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.
	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.
	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
	filterList (array $nodes=array(), array $rules=array())
	Filters given node list array using specified filter rules.
	setStorage ($key, $val)
	Writes data to the internal storage array.
	getStorage ($key, $default=null)
	Returns data from the internal storage array.
	delStorage ($key)
	Deletes data from the internal storage array.
	fetchNodeList ()
	fetchNodeInfo ()
	resetNodeInfo ()
	verifyNodeList ()
	resetNodeList ()

Protected Attributes
	$parent = null
	$server = null
	$nodeId = 0x00
	$nodeList = null
	$nodeInfo = array()
	$storage = array()

Detailed Description

Abstract class describing a TeamSpeak 3 node and all it's parameters.

Definition at line 32 of file Abstract.php.

Member Function Documentation

TeamSpeak3_Node_Abstract::request

(

$cmd

)

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

Parameters

string

$cmd

Returns

TeamSpeak3_Adapter_ServerQuery_Reply

Definition at line 70 of file Abstract.php.

References getParent().

Referenced by TeamSpeak3_Node_Host\bindingList(), 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()
	)

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 getParent().

Referenced by execute().

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

TeamSpeak3_Node_Abstract::execute	(		$cmd,
		array	$params = array()
	)

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 prepare(), and request().

Referenced by TeamSpeak3_Node_Server\banCreate(), TeamSpeak3_Node_Server\banDelete(), TeamSpeak3_Node_Server\channelClientPermAssign(), TeamSpeak3_Node_Server\channelClientPermList(), TeamSpeak3_Node_Server\channelClientPermRemove(), TeamSpeak3_Node_Server\channelCreate(), TeamSpeak3_Node_Server\channelDelete(), TeamSpeak3_Node_Server\channelDirCreate(), TeamSpeak3_Node_Server\channelFileDelete(), TeamSpeak3_Node_Server\channelFileInfo(), TeamSpeak3_Node_Server\channelFileList(), TeamSpeak3_Node_Server\channelFileRename(), TeamSpeak3_Node_Server\channelGroupClientList(), TeamSpeak3_Node_Server\channelGroupCopy(), TeamSpeak3_Node_Server\channelGroupCreate(), TeamSpeak3_Node_Server\channelGroupDelete(), TeamSpeak3_Node_Server\channelGroupPermAssign(), TeamSpeak3_Node_Server\channelGroupPermList(), TeamSpeak3_Node_Server\channelGroupPermRemove(), TeamSpeak3_Node_Server\channelGroupRename(), TeamSpeak3_Node_Server\channelMove(), TeamSpeak3_Node_Server\channelPermAssign(), TeamSpeak3_Node_Server\channelPermList(), TeamSpeak3_Node_Server\channelPermRemove(), TeamSpeak3_Node_Server\clientBan(), TeamSpeak3_Node_Server\clientCountDb(), TeamSpeak3_Node_Server\clientDeleteDb(), TeamSpeak3_Node_Server\clientFind(), TeamSpeak3_Node_Server\clientFindDb(), TeamSpeak3_Node_Server\clientGetIdsByUid(), TeamSpeak3_Node_Server\clientGetNameByDbid(), TeamSpeak3_Node_Server\clientGetNameByUid(), TeamSpeak3_Node_Server\clientGetServerGroupsByDbid(), TeamSpeak3_Node_Server\clientInfoDb(), TeamSpeak3_Node_Server\clientKick(), TeamSpeak3_Node_Server\clientListDb(), TeamSpeak3_Node_Server\clientModifyDb(), TeamSpeak3_Node_Server\clientMove(), TeamSpeak3_Node_Server\clientPermAssign(), TeamSpeak3_Node_Server\clientPermList(), TeamSpeak3_Node_Server\clientPermRemove(), TeamSpeak3_Node_Server\clientPoke(), TeamSpeak3_Node_Server\clientSetChannelGroup(), TeamSpeak3_Node_Server\complaintCreate(), TeamSpeak3_Node_Server\complaintDelete(), TeamSpeak3_Node_Server\complaintList(), TeamSpeak3_Node_Server\complaintListClear(), TeamSpeak3_Node_Server\customInfo(), TeamSpeak3_Node_Server\customSearch(), TeamSpeak3_Node_Client\fetchNodeInfo(), TeamSpeak3_Node_Channel\fetchNodeInfo(), TeamSpeak3_Node_Client\getClones(), TeamSpeak3_Node_Host\logAdd(), TeamSpeak3_Node_Server\logAdd(), TeamSpeak3_Node_Host\login(), TeamSpeak3_Node_Host\logView(), TeamSpeak3_Node_Server\logView(), TeamSpeak3_Node_Client\message(), TeamSpeak3_Node_Channelgroup\message(), TeamSpeak3_Node_Servergroup\message(), TeamSpeak3_Node_Channel\message(), TeamSpeak3_Node_Host\message(), TeamSpeak3_Node_Server\message(), TeamSpeak3_Node_Server\messageCreate(), TeamSpeak3_Node_Server\messageDelete(), TeamSpeak3_Node_Server\messageRead(), TeamSpeak3_Node_Client\modify(), TeamSpeak3_Node_Channel\modify(), TeamSpeak3_Node_Host\modify(), TeamSpeak3_Node_Server\modify(), TeamSpeak3_Node_Server\notifyRegister(), TeamSpeak3_Node_Host\permissionFind(), TeamSpeak3_Node_Client\permOverview(), TeamSpeak3_Node_Server\privilegeKeyCreate(), TeamSpeak3_Node_Server\privilegeKeyDelete(), TeamSpeak3_Node_Server\privilegeKeyUse(), TeamSpeak3_Node_Host\selfPermCheck(), TeamSpeak3_Node_Server\selfPermOverview(), TeamSpeak3_Node_Server\selfUpdate(), TeamSpeak3_Node_Server\selfUpdateLogin(), TeamSpeak3_Node_Host\serverCreate(), TeamSpeak3_Node_Host\serverDelete(), TeamSpeak3_Node_Server\serverGroupClientAdd(), TeamSpeak3_Node_Server\serverGroupClientDel(), TeamSpeak3_Node_Server\serverGroupClientList(), TeamSpeak3_Node_Server\serverGroupCopy(), TeamSpeak3_Node_Server\serverGroupCreate(), TeamSpeak3_Node_Server\serverGroupDelete(), TeamSpeak3_Node_Server\serverGroupPermAssign(), TeamSpeak3_Node_Host\serverGroupPermAutoAssign(), TeamSpeak3_Node_Host\serverGroupPermAutoRemove(), TeamSpeak3_Node_Server\serverGroupPermList(), TeamSpeak3_Node_Server\serverGroupPermRemove(), TeamSpeak3_Node_Server\serverGroupRename(), TeamSpeak3_Node_Host\serverIdGetByPort(), TeamSpeak3_Node_Host\serverSelect(), TeamSpeak3_Node_Host\serverSelectByPort(), TeamSpeak3_Node_Host\serverStart(), TeamSpeak3_Node_Host\serverStop(), TeamSpeak3_Node_Host\serverStopProcess(), TeamSpeak3_Node_Server\tempPasswordCreate(), TeamSpeak3_Node_Server\tempPasswordDelete(), TeamSpeak3_Node_Server\transferInitDownload(), TeamSpeak3_Node_Server\transferInitUpload(), and TeamSpeak3_Node_Server\transferStop().

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

TeamSpeak3_Node_Abstract::getParent

(

)

Returns the parent object of the current node.

Returns

TeamSpeak3_Adapter_ServerQuery

TeamSpeak3_Node_Abstract

Definition at line 105 of file Abstract.php.

References $parent.

Referenced by __call(), TeamSpeak3_Node_Client\addServerGroup(), TeamSpeak3_Node_Client\avatarDownload(), TeamSpeak3_Node_Client\ban(), TeamSpeak3_Node_Server\channelCreate(), TeamSpeak3_Node_Server\channelDelete(), TeamSpeak3_Node_Servergroup\clientAdd(), TeamSpeak3_Node_Servergroup\clientDel(), TeamSpeak3_Node_Channel\clientList(), TeamSpeak3_Node_Channelgroup\clientList(), TeamSpeak3_Node_Servergroup\clientList(), TeamSpeak3_Node_Server\clientList(), TeamSpeak3_Node_Server\clientMove(), TeamSpeak3_Node_Channel\clientPermAssign(), TeamSpeak3_Node_Channel\clientPermList(), TeamSpeak3_Node_Channel\clientPermRemove(), TeamSpeak3_Node_Servergroup\copy(), TeamSpeak3_Node_Channelgroup\copy(), TeamSpeak3_Node_Client\customInfo(), TeamSpeak3_Node_Servergroup\delete(), TeamSpeak3_Node_Channelgroup\delete(), TeamSpeak3_Node_Channel\delete(), TeamSpeak3_Node_Server\delete(), TeamSpeak3_Node_Client\deleteDb(), TeamSpeak3_Node_Channel\dirCreate(), TeamSpeak3_Node_Channelgroup\fetchNodeList(), TeamSpeak3_Node_Servergroup\fetchNodeList(), TeamSpeak3_Node_Channel\fetchNodeList(), TeamSpeak3_Node_Channel\fileDelete(), TeamSpeak3_Node_Channel\fileInfo(), TeamSpeak3_Node_Channel\fileList(), TeamSpeak3_Node_Channel\fileRename(), TeamSpeak3_Node_Host\getAdapter(), TeamSpeak3_Node_Host\getAdapterHost(), TeamSpeak3_Node_Host\getAdapterPort(), TeamSpeak3_Node_Channel\getLevel(), TeamSpeak3_Node_Channel\getPathway(), TeamSpeak3_Node_Channelgroup\getUniqueId(), TeamSpeak3_Node_Servergroup\getUniqueId(), TeamSpeak3_Node_Client\getUniqueId(), TeamSpeak3_Node_Channel\getUniqueId(), TeamSpeak3_Node_Server\getUniqueId(), TeamSpeak3_Node_Channelgroup\iconDownload(), TeamSpeak3_Node_Servergroup\iconDownload(), TeamSpeak3_Node_Client\iconDownload(), TeamSpeak3_Node_Channel\iconDownload(), TeamSpeak3_Node_Client\infoDb(), TeamSpeak3_Node_Channel\isSpacer(), TeamSpeak3_Node_Client\kick(), TeamSpeak3_Node_Client\memberOf(), TeamSpeak3_Node_Channel\message(), TeamSpeak3_Node_Client\modifyDb(), TeamSpeak3_Node_Client\move(), TeamSpeak3_Node_Channel\move(), TeamSpeak3_Node_Channelgroup\permAssign(), TeamSpeak3_Node_Servergroup\permAssign(), TeamSpeak3_Node_Client\permAssign(), TeamSpeak3_Node_Channel\permAssign(), TeamSpeak3_Node_Channelgroup\permList(), TeamSpeak3_Node_Servergroup\permList(), TeamSpeak3_Node_Client\permList(), TeamSpeak3_Node_Channel\permList(), TeamSpeak3_Node_Channelgroup\permRemove(), TeamSpeak3_Node_Servergroup\permRemove(), TeamSpeak3_Node_Client\permRemove(), TeamSpeak3_Node_Channel\permRemove(), TeamSpeak3_Node_Client\poke(), prepare(), TeamSpeak3_Node_Channelgroup\privilegeKeyCreate(), TeamSpeak3_Node_Servergroup\privilegeKeyCreate(), TeamSpeak3_Node_Client\remServerGroup(), TeamSpeak3_Node_Servergroup\rename(), TeamSpeak3_Node_Channelgroup\rename(), request(), TeamSpeak3_Node_Server\request(), TeamSpeak3_Node_Client\setChannelGroup(), TeamSpeak3_Node_Server\snapshotDeploy(), TeamSpeak3_Node_Channel\spacerGetAlign(), TeamSpeak3_Node_Channel\spacerGetType(), TeamSpeak3_Node_Server\start(), TeamSpeak3_Node_Server\stop(), TeamSpeak3_Node_Channel\subChannelList(), TeamSpeak3_Node_Server\transferInitDownload(), and TeamSpeak3_Node_Server\transferInitUpload().

  {
    return $this->parent;
  }

TeamSpeak3_Node_Abstract::getId

(

)

Returns the primary ID of the current node.

Returns

integer

Definition at line 115 of file Abstract.php.

References $nodeId.

Referenced by TeamSpeak3_Node_Client\ban(), TeamSpeak3_Node_Server\channelDelete(), TeamSpeak3_Node_Server\channelFileList(), TeamSpeak3_Node_Servergroup\clientAdd(), TeamSpeak3_Node_Servergroup\clientDel(), TeamSpeak3_Node_Channel\clientList(), TeamSpeak3_Node_Channelgroup\clientList(), TeamSpeak3_Node_Servergroup\clientList(), TeamSpeak3_Node_Channel\clientPermAssign(), TeamSpeak3_Node_Channel\clientPermList(), TeamSpeak3_Node_Channel\clientPermRemove(), TeamSpeak3_Node_Channelgroup\copy(), TeamSpeak3_Node_Servergroup\copy(), TeamSpeak3_Node_Servergroup\delete(), TeamSpeak3_Node_Channelgroup\delete(), TeamSpeak3_Node_Channel\delete(), TeamSpeak3_Node_Server\delete(), TeamSpeak3_Node_Channel\dirCreate(), TeamSpeak3_Node_Client\fetchNodeInfo(), TeamSpeak3_Node_Channel\fetchNodeInfo(), TeamSpeak3_Node_Channelgroup\fetchNodeList(), TeamSpeak3_Node_Servergroup\fetchNodeList(), TeamSpeak3_Node_Channel\fetchNodeList(), TeamSpeak3_Node_Channel\fileDelete(), TeamSpeak3_Node_Channel\fileInfo(), TeamSpeak3_Node_Channel\fileList(), TeamSpeak3_Node_Channel\fileRename(), TeamSpeak3_Node_Channel\getLevel(), TeamSpeak3_Node_Channel\getPathway(), TeamSpeak3_Node_Channelgroup\getUniqueId(), TeamSpeak3_Node_Servergroup\getUniqueId(), TeamSpeak3_Node_Client\getUniqueId(), TeamSpeak3_Node_Channel\getUniqueId(), TeamSpeak3_Node_Server\getUniqueId(), TeamSpeak3_Node_Client\kick(), TeamSpeak3_Node_Client\message(), TeamSpeak3_Node_Channel\message(), TeamSpeak3_Node_Server\message(), TeamSpeak3_Node_Client\modify(), TeamSpeak3_Node_Channel\modify(), TeamSpeak3_Node_Client\move(), TeamSpeak3_Node_Channel\move(), TeamSpeak3_Node_Channelgroup\permAssign(), TeamSpeak3_Node_Servergroup\permAssign(), TeamSpeak3_Node_Channel\permAssign(), TeamSpeak3_Node_Channelgroup\permList(), TeamSpeak3_Node_Servergroup\permList(), TeamSpeak3_Node_Channel\permList(), TeamSpeak3_Node_Channelgroup\permRemove(), TeamSpeak3_Node_Servergroup\permRemove(), TeamSpeak3_Node_Channel\permRemove(), TeamSpeak3_Node_Client\poke(), TeamSpeak3_Node_Channelgroup\privilegeKeyCreate(), TeamSpeak3_Node_Servergroup\privilegeKeyCreate(), TeamSpeak3_Node_Servergroup\rename(), TeamSpeak3_Node_Channelgroup\rename(), TeamSpeak3_Node_Server\request(), TeamSpeak3_Node_Server\sortGroupList(), TeamSpeak3_Node_Channel\spacerGetAlign(), TeamSpeak3_Node_Channel\spacerGetType(), TeamSpeak3_Node_Server\start(), TeamSpeak3_Node_Server\stop(), and TeamSpeak3_Node_Channel\subChannelList().

  {
    return $this->nodeId;
  }

TeamSpeak3_Node_Abstract::iconIsLocal

(

$key

)

Returns TRUE if the node icon has a local source.

Parameters

string

$key

Returns

boolean

Definition at line 126 of file Abstract.php.

Referenced by TeamSpeak3_Node_Channelgroup\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

)

Returns the internal path of the node icon.

Parameters

string

$key

Returns

TeamSpeak3_Helper_String

Definition at line 137 of file Abstract.php.

Referenced by getInfo(), TeamSpeak3_Node_Channelgroup\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_"

)

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

Parameters

string

$prefix

Returns

string

Definition at line 150 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::getUniqueId ( )

abstract

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

Returns

string

TeamSpeak3_Node_Abstract::getIcon ( )

abstract

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

Returns

string

TeamSpeak3_Node_Abstract::getSymbol ( )

abstract

Returns a symbol representing the node.

Returns

string

TeamSpeak3_Node_Abstract::getViewer

(

TeamSpeak3_Viewer_Interface

$viewer

)

Returns the HTML code to display a TeamSpeak 3 viewer.

Parameters

TeamSpeak3_Viewer_Interface

$viewer

Returns

string

Definition at line 191 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

Filters given node list array using specified filter rules.

Parameters

array	$nodes
array	$rules

Returns

array

Definition at line 221 of file Abstract.php.

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

  {
    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
	)

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 263 of file Abstract.php.

References $nodeInfo, TeamSpeak3_Helper_Convert\bytes(), TeamSpeak3_Helper_String\factory(), fetchNodeInfo(), 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
	)

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 321 of file Abstract.php.

References fetchNodeInfo(), and 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

(

)

Returns a string representation of this node.

Returns

string

Definition at line 341 of file Abstract.php.

Referenced by toString().

  {
    return get_class($this);
  }

TeamSpeak3_Node_Abstract::toString

(

)

Returns a string representation of this node.

Returns

string

Definition at line 351 of file Abstract.php.

References __toString().

  {
    return $this->__toString();
  }

TeamSpeak3_Node_Abstract::toArray

(

)

Returns an assoc array filled with current node info properties.

Returns

array

Definition at line 361 of file Abstract.php.

References $nodeList.

Referenced by TeamSpeak3_Node_Server\channelFileInfo().

  {
    return $this->nodeList;
  }

TeamSpeak3_Node_Abstract::__call	(		$name,
		array	$args
	)

Called whenever we're using an unknown method.

Parameters

string	$name
array	$args

Exceptions

TeamSpeak3_Node_Exception

Returns

mixed

Definition at line 374 of file Abstract.php.

References 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

Writes data to the internal storage array.

Parameters

string	$key
mixed	$val

Returns

void

Definition at line 391 of file Abstract.php.

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

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

TeamSpeak3_Node_Abstract::getStorage (   $key,   $default = null  )

protected

Returns data from the internal storage array.

Parameters

string	$key
mixed	$default

Returns

mixed

Definition at line 403 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

Deletes data from the internal storage array.

Parameters

string

$key

Returns

void

Definition at line 414 of file Abstract.php.

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

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

TeamSpeak3_Node_Abstract::__sleep

(

)

Commit pending data.

Returns

array

Definition at line 424 of file Abstract.php.

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

TeamSpeak3_Node_Abstract::fetchNodeList ( )

protected

Definition at line 432 of file Abstract.php.

Referenced by verifyNodeList().

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

TeamSpeak3_Node_Abstract::fetchNodeInfo ( )

protected

Definition at line 440 of file Abstract.php.

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

  {
    return;
  }

TeamSpeak3_Node_Abstract::resetNodeInfo ( )

protected

Definition at line 448 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

Definition at line 456 of file Abstract.php.

References fetchNodeList().

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

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

TeamSpeak3_Node_Abstract::resetNodeList ( )

protected

Definition at line 467 of file Abstract.php.

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

  {
    $this->nodeList = null;
  }

TeamSpeak3_Node_Abstract::count

(

)

Definition at line 475 of file Abstract.php.

References verifyNodeList().

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

  {
    $this->verifyNodeList();

    return count($this->nodeList);
  }

TeamSpeak3_Node_Abstract::current

(

)

Definition at line 485 of file Abstract.php.

References verifyNodeList().

Referenced by TeamSpeak3_Node_Server\channelClientPermAssign(), TeamSpeak3_Node_Server\channelClientPermRemove(), TeamSpeak3_Node_Server\channelGroupPermAssign(), TeamSpeak3_Node_Server\channelGroupPermRemove(), TeamSpeak3_Node_Server\channelPermAssign(), TeamSpeak3_Node_Server\channelPermRemove(), TeamSpeak3_Node_Server\clientCountDb(), TeamSpeak3_Node_Server\clientPermAssign(), TeamSpeak3_Node_Server\clientPermRemove(), getChildren(), hasChildren(), TeamSpeak3_Node_Host\permissionFind(), TeamSpeak3_Node_Host\selfPermCheck(), TeamSpeak3_Node_Server\serverGroupPermAssign(), TeamSpeak3_Node_Host\serverGroupPermAutoAssign(), TeamSpeak3_Node_Host\serverGroupPermAutoRemove(), and TeamSpeak3_Node_Server\serverGroupPermRemove().

  {
    $this->verifyNodeList();

    return current($this->nodeList);
  }

TeamSpeak3_Node_Abstract::getChildren

(

)

Definition at line 495 of file Abstract.php.

References current(), and verifyNodeList().

  {
    $this->verifyNodeList();

    return $this->current();
  }

TeamSpeak3_Node_Abstract::hasChildren

(

)

Definition at line 505 of file Abstract.php.

References current(), and verifyNodeList().

  {
    $this->verifyNodeList();

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

TeamSpeak3_Node_Abstract::hasNext

(

)

Definition at line 515 of file Abstract.php.

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

  {
    $this->verifyNodeList();

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

TeamSpeak3_Node_Abstract::key

(

)

Definition at line 525 of file Abstract.php.

References verifyNodeList().

Referenced by hasNext(), and valid().

  {
    $this->verifyNodeList();

    return key($this->nodeList);
  }

TeamSpeak3_Node_Abstract::valid

(

)

Definition at line 535 of file Abstract.php.

References key(), and verifyNodeList().

  {
    $this->verifyNodeList();

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

TeamSpeak3_Node_Abstract::next

(

)

Definition at line 545 of file Abstract.php.

References verifyNodeList().

  {
    $this->verifyNodeList();

    return next($this->nodeList);
  }

TeamSpeak3_Node_Abstract::rewind

(

)

Definition at line 555 of file Abstract.php.

References verifyNodeList().

  {
    $this->verifyNodeList();

    return reset($this->nodeList);
  }

TeamSpeak3_Node_Abstract::offsetExists

(

$offset

)

Definition at line 565 of file Abstract.php.

Referenced by getProperty(), and offsetGet().

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

TeamSpeak3_Node_Abstract::offsetGet

(

$offset

)

Definition at line 573 of file Abstract.php.

References fetchNodeInfo(), and offsetExists().

Referenced by __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
	)

Definition at line 593 of file Abstract.php.

Referenced by __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

)

Definition at line 606 of file Abstract.php.

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

TeamSpeak3_Node_Abstract::__get

(

$offset

)

Definition at line 614 of file Abstract.php.

References offsetGet().

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

TeamSpeak3_Node_Abstract::__set	(		$offset,
			$value
	)

Definition at line 622 of file Abstract.php.

References offsetSet().

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

Member Data Documentation

TeamSpeak3_Node_Abstract::$parent = null

protected

Definition at line 37 of file Abstract.php.

Referenced by getParent().

TeamSpeak3_Node_Abstract::$server = null

protected

Definition at line 42 of file Abstract.php.

Referenced by TeamSpeak3_Node_Channel\__construct(), TeamSpeak3_Node_Channelgroup\__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

Definition at line 47 of file Abstract.php.

Referenced by getId().

TeamSpeak3_Node_Abstract::$nodeList = null

protected

Definition at line 52 of file Abstract.php.

Referenced by toArray().

TeamSpeak3_Node_Abstract::$nodeInfo = array()

protected

Definition at line 57 of file Abstract.php.

Referenced by getInfo().

TeamSpeak3_Node_Abstract::$storage = array()

protected

Definition at line 62 of file Abstract.php.

---

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

• TeamSpeak3/Node/Abstract.php