Class: phpDocumentor_XML_Beautifier_Tokenizer

[line 64]

Type: array

Overrides:

phpDocumentor_XML_Beautifier_Tokenizer phpDocumentor_XML_Beautifier_Tokenizer( )

[line 570]

Initialize the $tokenpushEvent, $wordpushEvent arrays

Parameters:

mixed checkEventPop( $word, $pevent)

[line 535]

this function checks whether parameter $word is a token for popping the current event off of the Event Stack.

Tags:

• return - returns false, or the event number popped off of the stack

Parameters:

• $word -
• $pevent -

mixed checkEventPush( $word, $pevent)

[line 513]

this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.

Tags:

• return - returns false, or the event number

Parameters:

• $word -
• $pevent -

void configWordParser( $value $e)

[line 504]

tell the parser's WordParser $wp to set up tokens to parse words by.

tokens are word separators. In English, a space or punctuation are examples of tokens. In PHP, a token can be a ;, a parenthesis, or even the word "function"

Tags:

• see - WordParser
• usedby - phpDocumentor_XML_Beautifier_Tokenizer::parseString() - pass $parse_data to prepare retrieval of tokens

Parameters:

• $value $e - integer an event number

void getParserEventName( $value)

[line 661]

Parameters:

• $value -

void incdataHandler( object XML $parser, string $cdata)

[line 408]

Handler for real character data

Tags:

• access - protected

Parameters:

• object XML $parser - parser object
• string $cdata - CDATA

bool parseString( string $parse_data, Converter 1, false|string 2, false|integer 3)

[line 108]

Parse a new file

The parse() method is a do...while() loop that retrieves tokens one by one from the $_event_stack, and uses the token event array set up by the class constructor to call event handlers.

The event handlers each process the tokens passed to them, and use the _addoutput() method to append the processed tokens to the $_line variable. The word parser calls newLineNum() every time a line is reached.

In addition, the event handlers use special linking functions _link() and its cousins (_classlink(), etc.) to create in-code hyperlinks to the documentation for source code elements that are in the source code.

Tags:

• staticvar - integer $endrecur: used for recursion limiting if a handler for an event is not found
• uses - phpDocumentor_XML_Beautifier_Tokenizer::setupStates() - initialize parser state variables
• uses - phpDocumentor_XML_Beautifier_Tokenizer::configWordParser() - pass $parse_data to prepare retrieval of tokens

Parameters:

• Converter 1 -
• false|string 2 - full path to file with @filesource tag, if this is a @filesource parse
• false|integer 3 - starting line number from {@source linenum}
• string $parse_data -

void setupStates( boolean $parsedata, false|string 1)

[line 553]

Initialize all parser state variables

Tags:

• usedby - phpDocumentor_XML_Beautifier_Tokenizer::parseString() - initialize parser state variables
• uses - $_wp - sets to a new phpDocumentor_HighlightWordParser

Parameters:

• false|string 1 - name of class we are going to start from
• boolean $parsedata - true if we are highlighting an inline {@source} tag's output