TeamSpeak3_Viewer_Text Class Reference

Renders nodes used in ASCII-based TeamSpeak 3 viewers. More...

Inheritance diagram for TeamSpeak3_Viewer_Text:

Public Member Functions
	fetchObject (TeamSpeak3_Node_Abstract $node, array $siblings=array())
	Returns the code needed to display a node in a TeamSpeak 3 viewer. More...
Public Member Functions inherited from TeamSpeak3_Viewer_Interface
	fetchObject (TeamSpeak3_Node_Abstract $node, array $siblings=array())
	Returns the code needed to display a node in a TeamSpeak 3 viewer. More...

Protected Member Functions
	getCorpusIcon ()
	Returns an ASCII string which can be used to display the status icon for a TeamSpeak_Node_Abstract object. More...
	getCorpusName ()
	Returns a string for the current corpus element which contains the display name for the current TeamSpeak_Node_Abstract object. More...
	getPrefix ()
	Returns the ASCII string to display the prefix of the current node. More...

Detailed Description

Renders nodes used in ASCII-based TeamSpeak 3 viewers.

Member Function Documentation

fetchObject()

fetchObject	(	TeamSpeak3_Node_Abstract	$node,
		array	$siblings = array()
	)

Returns the code needed to display a node in a TeamSpeak 3 viewer.

Parameters

TeamSpeak3_Node_Abstract	$node
array	$siblings

Returns

string

  {
    $this->currObj = $node;
    $this->currSib = $siblings;

    $args = array(
      $this->getPrefix(),
      $this->getCorpusIcon(),
      $this->getCorpusName(),
    );

    return TeamSpeak3_Helper_String::factory($this->pattern)->arg($args);
  }

getCorpusIcon()

getCorpusIcon ( )

protected

Returns an ASCII string which can be used to display the status icon for a TeamSpeak_Node_Abstract object.

Returns

string

  {
    return $this->currObj->getSymbol();
  }

getCorpusName()

getCorpusName ( )

protected

Returns a string for the current corpus element which contains the display name for the current TeamSpeak_Node_Abstract object.

Returns

string

  {
    return $this->currObj;
  }

getPrefix()

getPrefix ( )

protected

Returns the ASCII string to display the prefix of the current node.

Returns

string

  {
    $prefix = "";

    if(count($this->currSib))
    {
      $last = array_pop($this->currSib);

      foreach($this->currSib as $sibling)
      {
        $prefix .=  ($sibling) ? "| " : "  ";
      }

      $prefix .= ($last) ? "\\-" : "|-";
    }

    return $prefix;
  }

---

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

• /Volumes/home/Repositories/planetteamspeak/ts3phpframework/libraries/TeamSpeak3/Viewer/Text.php