phpDocumentor phpDocumentor
Parsers
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: phpDocumentor_HighlightWordParser

Source Location: /phpDocumentor/HighlightParser.inc

Class phpDocumentor_HighlightWordParser

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From phpDocumentorTWordParser

phpDocumentorTWordParser::addFileSource()
Wrapper for addSource() used to retrieve the entire source code organized by line number in setup()
phpDocumentorTWordParser::addSource()
Generate source token arrays organized by line number
phpDocumentorTWordParser::backupPos()
backs the parser up to the previous position
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()
gets the source code tokens
phpDocumentorTWordParser::getSource()
loads up next set of source code
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

Inherited From WordParser

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()
Sets the list of possible separator tokens
WordParser::setup()
Initialize the WordParser
WordParser::setWhitespace()
set parser to return or strip whitespace

[ Top ]
Method Summary
void   backupPos()   back the word parser to the previous token as defined by $last_token
array|string   getWord()   Retrieve the next token
array   nextToken()   Retrieve the position of the next token that will be parsed in the internal token array
void   setup()   Initialize the parser object

[ Top ]
Methods
backupPos  [line 172]

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

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

Parameters:
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

[ Top ]
getWord  [line 147]

  array|string getWord( )

Retrieve the next token


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


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

[ Top ]
nextToken  [line 127]

  array nextToken( )

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


API Tags:
Return:  format: array(line number, position)


[ Top ]
setup  [line 85]

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

Initialize the parser object

Parameters:
array   &$input:  the input
phpDocumentor_HighlightParser   &$parser:  the parser


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

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:19:09 -0600 by phpDocumentor 1.4.4