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
	__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
	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 ()

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

Detailed Description

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

Member Function Documentation

__call()

__call	(		$name,
		array	$args
	)

Called whenever we're using an unknown method.

Parameters

string	$name
array	$args

Exceptions

TeamSpeak3_Node_Exception

Returns

mixed

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

__sleep()

__sleep

(

)

Commit pending data.

Returns

array

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

__toString()

__toString

(

)

Returns a string representation of this node.

Returns

string

  {
    return get_class($this);
  }

delStorage()

delStorage (   $key )

protected

Deletes data from the internal storage array.

Parameters

string

$key

Returns

void

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

execute()

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

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

filterList()

filterList ( array  $nodes = array(), array  $rules = array()  )

protected

Filters given node list array using specified filter rules.

Parameters

array	$nodes
array	$rules

Returns

array

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

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

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

getClass()

getClass

(

$prefix = "ts3_"

)

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

Parameters

string

$prefix

Returns

string

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

getIcon()

getIcon ( )

abstract

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

Returns

string

getId()

getId

(

)

Returns the primary ID of the current node.

Returns

integer

  {
    return $this->nodeId;
  }

getInfo()

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

  {
    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 instanceof TeamSpeak3_Helper_String ? $val->toString() : strval($val))*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;
  }

getParent()

getParent

(

)

Returns the parent object of the current node.

Returns

TeamSpeak3_Adapter_ServerQuery

TeamSpeak3_Node_Abstract

  {
    return $this->parent;
  }

getProperty()

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

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

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

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

getStorage()

getStorage (   $key,   $default = null  )

protected

Returns data from the internal storage array.

Parameters

string	$key
mixed	$default

Returns

mixed

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

getSymbol()

getSymbol ( )

abstract

Returns a symbol representing the node.

Returns

string

getUniqueId()

getUniqueId ( )

abstract

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

Returns

string

getViewer()

getViewer

(

TeamSpeak3_Viewer_Interface

$viewer

)

Returns the HTML code to display a TeamSpeak 3 viewer.

Parameters

TeamSpeak3_Viewer_Interface

$viewer

Returns

string

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

iconGetName()

iconGetName

(

$key

)

Returns the internal path of the node icon.

Parameters

string

$key

Returns

TeamSpeak3_Helper_String

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

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

iconIsLocal()

iconIsLocal

(

$key

)

Returns TRUE if the node icon has a local source.

Parameters

string

$key

Returns

boolean

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

prepare()

prepare	(		$cmd,
		array	$params = array()
	)

Uses given parameters and returns a prepared ServerQuery command.

Parameters

string	$cmd
array	$params

Returns

TeamSpeak3_Helper_String

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

request()

request	(		$cmd,
			$throw = TRUE
	)

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

Parameters

string	$cmd
boolean	$throw

Returns

TeamSpeak3_Adapter_ServerQuery_Reply

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

setStorage()

setStorage (   $key,   $val  )

protected

Writes data to the internal storage array.

Parameters

string	$key
mixed	$val

Returns

void

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

toArray()

toArray

(

)

Returns an assoc array filled with current node info properties.

Returns

array

  {
    return $this->nodeList;
  }

toString()

toString

(

)

Returns a string representation of this node.

Returns

string

  {
    return $this->__toString();
  }

---

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

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