PlanetTeamSpeak\TeamSpeak3Framework\Viewer\Text Class Reference

Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Viewer\Text:

Public Member Functions
	fetchObject (Node $node, array $siblings=[])

Protected Member Functions
	getPrefix ()
	getCorpusIcon ()
	getCorpusName ()

Protected Attributes
string	$pattern = "%0%1 %2\n"

Detailed Description

Definition at line 13 of file Text.php.

Member Function Documentation

fetchObject()

PlanetTeamSpeak\TeamSpeak3Framework\Viewer\Text::fetchObject	(	Node	$node,
		array	$siblings = [] )

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

Parameters

Node	$node
array	$siblings

Returns

string

Implements PlanetTeamSpeak\TeamSpeak3Framework\Viewer\ViewerInterface.

Definition at line 29 of file Text.php.

getCorpusIcon()

PlanetTeamSpeak\TeamSpeak3Framework\Viewer\Text::getCorpusIcon ( )

protected

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

Returns

string

Definition at line 71 of file Text.php.

getCorpusName()

PlanetTeamSpeak\TeamSpeak3Framework\Viewer\Text::getCorpusName ( )

protected

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

Returns

string

Definition at line 82 of file Text.php.

getPrefix()

PlanetTeamSpeak\TeamSpeak3Framework\Viewer\Text::getPrefix ( )

protected

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

Returns

string

Definition at line 48 of file Text.php.

Member Data Documentation

$pattern

string PlanetTeamSpeak\TeamSpeak3Framework\Viewer\Text::$pattern = "%0%1 %2\n"

protected

Definition at line 20 of file Text.php.

---

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

• src/Viewer/Text.php