Class: phpDocumentor_HighlightWordParser

Source Location: /PhpDocumentor-1.4.0/phpDocumentor/HighlightParser.inc

WordParser
   |
   --phpDocumentorTWordParser
      |
      --phpDocumentor_HighlightWordParser

Retrieve tokens from an array of tokens organized by line numbers

phpDocumentorTWordParser::addFileSource(): Wrapper for addSource() used to retrieve the entire source code
phpDocumentorTWordParser::addSource(): Generate source token arrays organized by line number
phpDocumentorTWordParser::backupPos()
phpDocumentorTWordParser::concatTokens(): Utility function to convert a series of tokens into a string
phpDocumentorTWordParser::findGlobal(): Tell the phpDocumentorTWordParser to return the entire global variable if it is found.
phpDocumentorTWordParser::getFileSource()
phpDocumentorTWordParser::getSource()
phpDocumentorTWordParser::getWord(): Retrieve a token for the phpDocumentorTParser
phpDocumentorTWordParser::setup(): Uses http://www.php.net/token_get_all to tokenize the source code.
phpDocumentorTWordParser::tokenEquals(): Utility function to determine whether two tokens from the tokenizer are equal

WordParser::backupPos(): Backup to the previous token so that it can be retrieved again in a new context.
WordParser::getBlock(): Unused
WordParser::getPos(): Returns the current pointer position, or 1 character after the end of the word
WordParser::getSource(): Retrieve source code for the last function/method
WordParser::getWord(): Retrieve a token from the token list
WordParser::setPos(): Set the internal cursor within the source code
WordParser::setSeperator()
WordParser::setup(): Initialize the WordParser
WordParser::setWhitespace(): set parser to return or strip whitespace

[line 56]
Retrieve tokens from an array of tokens organized by line numbers

[ Top ]

void backupPos(
array|string
$last_token, [boolean
$is_pos = false])

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

Overrides phpDocumentorTWordParser::backupPos() (parent method not documented)

array\|string	`$last_token`	—	token, or output from nextToken()
boolean	`$is_pos`	—	if true, backupPos interprets $last_token to be the position in the internal token array of the last token

[ Top ]

array|string getWord(
)

Retrieve the next token

Return: either array(PHP token constant, token) or string non-specific separator

Overrides phpDocumentorTWordParser::getWord() (Retrieve a token for the phpDocumentorTParser)

[ Top ]

array nextToken(
)

Retrieve the position of the next token that will be parsed

in the internal token array

[ Top ]

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

array	`&$input`	—
phpDocumentor_HighlightParser	`&$parser`	—

[ Top ]