Class phpDocumentor_HighlightWordParser

Description
Method Summary
 void backupPos (array|string $last_token, [bool $is_pos = false])
 array|string getWord ()
 array nextToken ()
 void setup (array &$input, phpDocumentor_HighlightParser &$parser)
Methods
backupPos (line 172)

back the word parser to the previous token as defined by $last_token

void backupPos (array|string $last_token, [bool $is_pos = false])
  • array|string $last_token: token, or output from nextToken()
  • bool $is_pos: if true, backupPos interprets $last_token to be the position in the internal token array of the last token

Redefinition of:
phpDocumentorTWordParser::backupPos()
backs the parser up to the previous position
getWord (line 147)

Retrieve the next token

  • return: either array(PHP token constant, token) or string non-specific separator
array|string getWord ()

Redefinition of:
phpDocumentorTWordParser::getWord()
Retrieve a token for the phpDocumentorTParser
nextToken (line 127)

Retrieve the position of the next token that will be parsed in the internal token array

  • return: format: array(line number, position)
array nextToken ()
setup (line 85)

Initialize the parser object

void setup (array &$input, phpDocumentor_HighlightParser &$parser)

Redefinition of:
phpDocumentorTWordParser::setup()
Uses http://www.php.net/token_get_all to tokenize the source code.

Inherited Methods

Inherited From phpDocumentorTWordParser

 phpDocumentorTWordParser::addFileSource()
 phpDocumentorTWordParser::addSource()
 phpDocumentorTWordParser::backupPos()
 phpDocumentorTWordParser::concatTokens()
 phpDocumentorTWordParser::findGlobal()
 phpDocumentorTWordParser::getFileSource()
 phpDocumentorTWordParser::getSource()
 phpDocumentorTWordParser::getWord()
 phpDocumentorTWordParser::setup()
 phpDocumentorTWordParser::tokenEquals()

Inherited From WordParser

 WordParser::backupPos()
 WordParser::getBlock()
 WordParser::getPos()
 WordParser::getSource()
 WordParser::getWord()
 WordParser::setPos()
 WordParser::setSeperator()
 WordParser::setup()
 WordParser::setWhitespace()

Documentation generated on Mon, 05 Dec 2011 21:04:52 -0600 by phpDocumentor 1.4.4