Docs For Class phpDocumentorTWordParser

Class: phpDocumentorTWordParser

Class Overview

WordParser
   |
   --phpDocumentorTWordParser

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

Author(s):

Gregory Beaver <cellog at php.net>

Version:

Release: 1.5.0a1

Copyright:

2002-2007 Gregory Beaver

Methods

Child classes:

phpDocumentor_HighlightWordParser: Retrieve tokens from an array of tokens organized by line numbers

Inherited Variables

Inherited Methods

Class: WordParser

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

Class Details

[line 59]
Like WordParser, but expects an array of tokens from the tokenizer instead of a string.

Author: Gregory Beaver <cellog@php.net>
Version: Release: 1.5.0a1
Copyright: 2002-2007 Gregory Beaver
Link: http://pear.php.net/PhpDocumentor
Link: http://www.phpdoc.org
Todo: CS cleanup - change package to PhpDocumentor
Todo: CS cleanup - change classname to PhpDocumentor_*
Since: 1.2
License: LGPL

Method Detail

addFileSource [line 278]

void addFileSource(
array
$word)

Wrapper for addSource() used to retrieve the entire source code organized by line number in setup()

Parameters:

array $word — full file source code

[ Top ]

addSource [line 300]

void addSource(
array|string
$word, [bool
$file = false])

Generate source token arrays organized by line number

This code will split up tokens that contain "\n" and add them to the source code as separate tokens on different lines.

Uses: _set_sars()

Parameters:

array\|string	`$word`	—	token to add
bool	`$file`	—	true if this should be added to $_file_source

[ Top ]

backupPos [line 361]

int|void backupPos(
)

backs the parser up to the previous position

Return: can return a word

Overridden in child classes as:

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

Overrides WordParser::backupPos() (Backup to the previous token so that it can be retrieved again in a new context.)

[ Top ]

concatTokens [line 193]

string concatTokens(
array
$a)

Utility function to convert a series of tokens into a string

Return: the resulting string

Parameters:

array $a — array of tokens

[ Top ]

findGlobal [line 347]

void findGlobal(
array
$tokens)

Tell the phpDocumentorTWordParser to return the entire global variable if it is found.

Uses: $_global_search

Parameters:

array $tokens — tokens that represent the global variable definition

[ Top ]

getFileSource [line 148]

array getFileSource(
)

gets the source code tokens

Return: source code tokens split up by line number
Usedby: parserExampleTag::parserExampleTag() - uses to parse an example and retrieve all tokens by line number

[ Top ]

getSource [line 135]

array getSource(
)

loads up next set of source code

Return: source code array

Overrides WordParser::getSource() (Retrieve source code for the last function/method)

[ Top ]

getWord [line 218]

string|array getWord(
)

Retrieve a token for the phpDocumentorTParser

Return: token from tokenizer

Overridden in child classes as:

phpDocumentor_HighlightWordParser::getWord(): Retrieve the next token

Overrides WordParser::getWord() (Retrieve a token from the token list)

[ Top ]

setup [line 117]

void setup(
string
&$input)

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

Overridden in child classes as:

phpDocumentor_HighlightWordParser::setup(): Initialize the parser object

Overrides WordParser::setup() (Initialize the WordParser)

Parameters:

string &$input — source code

[ Top ]

tokenEquals [line 178]

bool tokenEquals(
mixed
$a, mixed
$b)

Utility function to determine whether two tokens from the tokenizer are equal

Return: whether or not the tokens are equal

Parameters:

mixed	`$a`	—	first token
mixed	`$b`	—	second token

[ Top ]