Docs For Class WordParser

Class WordParser

Class Overview

Retrieves tokens from source code for use by the Parser

Located in /phpDocumentor/WordParser.inc [line 56]

Author(s):

Joshua Eichorn <[email protected]>

API Tags:

See:

Parser

Information Tags:

Version:	Release: @VER@
Copyright:	2000-2007 Joshua Eichorn
Link:	http://pear.php.net/PhpDocumentor
Link:	http://www.phpdoc.org
Todo:	CS cleanup - change package to PhpDocumentor
License:	LGPL

Methods

[ Top ]

Descendants

Child Class	Description
ObjectWordParser	Like WordParser but designed to handle an array with strings and
phpDocumentorTWordParser	Like WordParser, but expects an array of tokens from the tokenizer instead of a string.

[ Top ]

Method Summary

void	backupPos()	Backup to the previous token so that it can be retrieved again in a new context.
string	getBlock()	Unused
int	getPos()	Returns the current pointer position, or 1 character after the end of the word
string	getSource()	Retrieve source code for the last function/method
string\|false	getWord()	Retrieve a token from the token list
void	setPos()	Set the internal cursor within the source code
void	setSeperator()	Sets the list of possible separator tokens
void	setup()	Initialize the WordParser
void	setWhitespace()	set parser to return or strip whitespace

[ Top ]

Methods

backupPos [line 346]

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.

Parameters:

string

$word:

token to back up to

Redefined in descendants 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

[ Top ]

getBlock [line 305]

string 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

API Tags:

Return:

the requested block of characters

[ Top ]

getPos [line 290]

int getPos(
)

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

API Tags:

Return:

the position

[ Top ]

getSource [line 149]

string getSource(
)

Retrieve source code for the last function/method

Redefined in descendants as:

phpDocumentorTWordParser::getSource() : loads up next set of source code

[ Top ]

getWord [line 206]

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

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

API 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

Redefined in descendants as:

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

[ Top ]

setPos [line 330]

void setPos(
integer
$pos 
)

Set the internal cursor within the source code

Parameters:

integer

$pos:

the position

[ Top ]

setSeperator [line 318]

void setSeperator(
array
&$seps 
)

Sets the list of possible separator tokens

Parameters:

array

&$seps:

array of strings that separate tokens

API Tags:

Uses:

$wordseperators

[ Top ]

setup [line 132]

void setup(
string
&$input 
)

Initialize the WordParser

Parameters:

string

&$input:

source code

Redefined in descendants as:

ObjectWordParser::setup() : Set the word parser to go.
phpDocumentorTWordParser::setup() : Uses http://www.php.net/token_get_all to tokenize the source code.
phpDocumentor_HighlightWordParser::setup() : Initialize the parser object

[ Top ]

setWhitespace [line 360]

void setWhitespace(
[boolean
$val = false] 
)

set parser to return or strip whitespace

Parameters:

boolean

$val:

flag to return or strip whitespace

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:21:26 -0600 by phpDocumentor 1.4.4

	phpDocumentor WordParsers

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

Class: WordParser

Class WordParser