Constructor phpDocumentor_TutorialHighlightParser (line 423)

Initialize the $tokenpushEvent, $wordpushEvent arrays

checkEventPush (line 358)

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

• return: returns false, or the event number
• todo: CS cleanup - PHPCS needs to recognize docblock template tags

• string|array $word: token value
• integer $pevent: parser event from Parser.inc

Parser::checkEventPush()

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

getParserEventName (line 508)

searches for a parser event name based on its number

• return: the event name, or the original value

• int $value: the event number

Parser::getParserEventName()

Debugging function, takes an event number and attempts to return its name

parse (line 166)

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.

• staticvar: integer $endrecur: used for recursion limiting if a handler for an event is not found
• todo: CS cleanup - unable to get function signature below 85char wide
• uses: phpDocumentor_TutorialHighlightParser::setupStates() - initialize parser state variables
• uses: phpDocumentor_TutorialHighlightParser::configWordParser() - pass $parse_data to prepare retrieval of tokens

• string $parse_data: blah
• Converter &$converter: blah
• false|string $filesourcepath: full path to file with @filesource tag, if this is a @filesource parse
• false|integer $linenum: starting line number from {@source linenum}

Parser::parse()

Parse a new file

setupStates (line 403)

Initialize all parser state variables

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

• bool|string $parsedata: true if we are highlighting an inline {@source} tag's output, or the name of class we are going to start from

Parser::setupStates()

setup the parser tokens, and the pushEvent/popEvent arrays