Docs For Class WordParser

Class: WordParser

Class Overview

Retrieves tokens from source code for use by the Parser

Author(s):

Joshua Eichorn <jeichorn at phpdoc.org>

Version:

$Id: WordParser.inc,v 1.3 2006/04/30 22:18:14 cellog Exp $

Child classes:

phpDocumentorTWordParser: Like WordParser, but expects an array of tokens from the tokenizer instead of a string.

ObjectWordParser: Like WordParser but designed to handle an array with strings and

Inherited Variables

Inherited Methods

Class Details

[line 46]
Retrieves tokens from source code for use by the Parser

Author: Joshua Eichorn <jeichorn@phpdoc.org>
Version: $Id: WordParser.inc,v 1.3 2006/04/30 22:18:14 cellog Exp $
See: Parser

Method Detail

backupPos [line 322]

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()

phpDocumentor_HighlightWordParser::backupPos(): back the word parser to the previous token as defined by $last_token

Parameters:

string $word — token to back up to

[ Top ]

getBlock [line 291]

void getBlock(
integer
$start, integer
$len)

Unused

function getBlock($start,$len)

    {
        return substr($this->data,$start,$len);
    }

Parameters:

integer	`$start`	—	starting position
integer	`$len`	—	length of block to retrieve

[ Top ]

getPos [line 279]

void getPos(
)

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

[ Top ]

getSource [line 135]

string getSource(
)

Retrieve source code for the last function/method

Overridden in child classes as:

phpDocumentorTWordParser::getSource()

[ Top ]

getWord [line 187]

string|false getWord(
)

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

is a token, and

global

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

Overridden in child classes as:

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

phpDocumentor_HighlightWordParser::getWord(): Retrieve the next token

ObjectWordParser::getWord()

[ Top ]

setPos [line 309]

void setPos(
integer
$pos)

Set the internal cursor within the source code

Parameters:

integer $pos —

[ Top ]

setSeperator [line 300]

void setSeperator(
array
&$seps)

Uses: $wordseperators

Parameters:

array &$seps — array of strings that separate tokens

[ Top ]

setup [line 119]

void setup(
string
&$input)

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()

ObjectWordParser::setup(): Set the word parser to go.

Parameters:

string &$input — source code

[ Top ]

setWhitespace [line 332]

void setWhitespace(
[boolean
$val = false])

set parser to return or strip whitespace

Parameters:

boolean $val —

[ Top ]