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.

• string $word: token to back up to

---

• 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

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

• return: the position

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

is a token, and is not, but inside a function, the reverse is true. The parser state PARSER_STATE_CLASS has a token list that includes whitespace, code delimiters like ; and {}, and comment/DocBlock indicators

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. }}

• 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

---

• ObjectWordParser::getWord()
• phpDocumentorTWordParser::getWord() : Retrieve a token for the phpDocumentorTParser
• phpDocumentor_HighlightWordParser::getWord() : Retrieve the next token

Sets the list of possible separator tokens

• uses: $wordseperators

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

set parser to return or strip whitespace

• boolean $val: flag to return or strip whitespace