void backupPos(
string
$word)
|
|
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 getBlock(
integer
$start, integer
$len)
|
|
Unused
{
return substr($this->data
, $start, $len);
}
Parameters:
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 var
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. }}
Overridden in child classes as:
- phpDocumentorTWordParser::getWord()
- Retrieve a token for the phpDocumentorTParser
- phpDocumentor_HighlightWordParser::getWord()
- Retrieve the next token
- ObjectWordParser::getWord()
