Class: WordParser

void backupPos( string $word)

[line 346]

Backup to the previous token so that it can be retrieved again in a new context.

Occasionally, a word will be passed to an event handler that should be handled by another event handler. This method allows that to happen.

Overridden in child classes as:

phpDocumentorTWordParser::backupPos()

backs the parser up to the previous position

phpDocumentor_HighlightWordParser::backupPos()

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

Parameters:

• string $word - token to back up to

string getBlock( integer $start, integer $len)

[line 305]

Unused

1. function getBlock($start, $len)
2.     {
3.         return substr($this->data, $start, $len);
4.     }

Tags:

• return - the requested block of characters

Parameters:

• integer $start - starting position
• integer $len - length of block to retrieve

int getPos( )

[line 290]

Returns the current pointer position, or 1 character after the end of the word

Tags:

• return - the position

Parameters:

string getSource( )

[line 149]

Retrieve source code for the last function/method

Overridden in child classes as:

phpDocumentorTWordParser::getSource()

loads up next set of source code

Parameters:

string|false getWord( )

[line 206]

Retrieve a token from the token list

The Parser class relies upon this method to retrieve the next token. The $wordseperators array is a collection of strings that delineate tokens for the current parser state. $wordseperators is set by the parser with a call to Parser::configWordParser() every time a new parser state is reached.

For example, while parsing the source code for a class, the word

1. var

1. global

If the whitespace option has been turned off using setWhitespace(), then no whitespace is returned with tokens

{@ is of course the string containing the PHP code to be parsed, and $pos is the cursor, or current location within the parsed data. }}

Tags:

• return - the next token, an empty string if there are no token separators in the $wordseperators array, or false if the end of input has been reached

Overridden in child classes as:

phpDocumentorTWordParser::getWord()

Retrieve a token for the phpDocumentorTParser

phpDocumentor_HighlightWordParser::getWord()

Retrieve the next token

ObjectWordParser::getWord()

Parameters:

void setPos( integer $pos)

[line 330]

Set the internal cursor within the source code

Parameters:

• integer $pos - the position

void setSeperator( array &$seps)

[line 318]

Sets the list of possible separator tokens

Tags:

• uses - $wordseperators

Parameters:

• array &$seps - array of strings that separate tokens

void setup( string &$input)

[line 132]

Initialize the WordParser

Overridden in child classes as:

phpDocumentorTWordParser::setup()

Uses http://www.php.net/token_get_all to tokenize the source code.

phpDocumentor_HighlightWordParser::setup()

Initialize the parser object

ObjectWordParser::setup()

Set the word parser to go.

Parameters:

• string &$input - source code

void setWhitespace( [boolean $val = false])

[line 360]

set parser to return or strip whitespace

Parameters:

• boolean $val - flag to return or strip whitespace