Class phpDocumentor_TutorialHighlightParser

(line 69)

Description

Publisher
   |
   --Parser
      |
      --phpDocumentor_TutorialHighlightParser

Located in File: /phpDocumentor/TutorialHighlightParser.inc

Highlights source code using parse()

Class Variables

Summary:

Class Constants

Summary:

Method Detail

Summary:
phpDocumentor_TutorialHighlightParser phpDocumentor_TutorialHighlightParser ()
mixed checkEventPop (string|array $word, integer $pevent)
mixed checkEventPush (string|array $word, integer $pevent)
void configWordParser (integer $e)
string|int getParserEventName (int $value)
void newLineNum ()
bool parse (string $parse_data, Converter &$converter, [false|string $filesourcepath = false], [false|integer $linenum = false])
void setLineNum (int $num)
void setupStates (bool|string $parsedata)

Constructor phpDocumentor_TutorialHighlightParser (line 423)

phpDocumentor_TutorialHighlightParser phpDocumentor_TutorialHighlightParser( )

Initialize the $tokenpushEvent, $wordpushEvent arrays

Info

Method checkEventPop (line 380)

mixed checkEventPop( string|array $word, integer $pevent)

Overrides : Parser::checkEventPop() this function checks whether parameter $word is a token for popping the current event off of the Event Stack.

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

Parameters

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

Info

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

Method checkEventPush (line 358)

mixed checkEventPush( string|array $word, integer $pevent)

Overrides : Parser::checkEventPush() this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.

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

Parameters

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

Info

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

Method configWordParser (line 341)

void configWordParser( integer $e)

Overrides : Parser::configWordParser() tell the parser's WordParser $wp to set up tokens to parse words by.

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"

Parameters

  • integer $e: an event number

Info

Method getParserEventName (line 508)

string|int getParserEventName( int $value)

Overrides : Parser::getParserEventName() Debugging function, takes an event number and attempts to return its name

searches for a parser event name based on its number

Parameters

  • int $value: the event number

Info

  • return - the event name, or the original value

Method newLineNum (line 115)

void newLineNum( )

advances output to a new line

Info

  • uses - Converter::SourceLine() - encloses $_line in a converter-specific format

Method parse (line 166)

bool parse( string $parse_data, Converter &$converter, [false|string $filesourcepath = false], [false|integer $linenum = false])

Overrides : Parser::parse() Parse a new file

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.

Parameters

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

Info

Method setLineNum (line 130)

void setLineNum( int $num)

Start the parsing at a certain line number

Parameters

  • int $num: the line number

Info

Method setupStates (line 403)

void setupStates( bool|string $parsedata)

Overrides : Parser::setupStates() setup the parser tokens, and the pushEvent/popEvent arrays

Initialize all parser state variables

Parameters

  • 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

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class Publisher

Publisher::$subscriber - Array of references objects that have Subscribed to this publisher

Inherited Methods

Inherited Method Summary

Inherited From Class Parser

Parser::Parser() - Set up invariant parsing variables

Parser::categoryTagHandler() - handles @category

Parser::checkEventPop() - this function checks whether parameter $word is a token for popping the current event off of the Event Stack.

Parser::checkEventPush() - this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.

Parser::configWordParser() - tell the parser's WordParser $wp to set up tokens to parse words by.

Parser::defaultTagHandler() - Handles all standard tags that only have a description

Parser::endTag() - Called to clean up at the end of parsing a @tag in a docblock

Parser::exampleTagHandler() - handles @example

Parser::getParserEventName() - Debugging function, takes an event number and attempts to return its name

Parser::globalTagHandler() - handles @global

Parser::invalidTagHandler() - Handles tags like '@filesource' that only work in PHP 4.3.0+

Parser::packageTagHandler() - handles @package

Parser::paramTagHandler() - handles @param

Parser::parse() - Parse a new file

Parser::propertyTagHandler() - Handles @property(-read or -write) and @method magic tag

Parser::returnTagHandler() - handles @return

Parser::setupStates() - setup the parser tokens, and the pushEvent/popEvent arrays

Parser::staticvarTagHandler() - handles @staticvar

Parser::usesTagHandler() - handles @uses

Parser::varTagHandler() - handles @var


Inherited From Class Publisher

Publisher::publishEvent() - Publish an event

Publisher::subscribe() - Adds a subscriber to the $subscriber array().


Documentation generated on Mon, 05 Dec 2011 21:29:18 -0600 by phpDocumentor 1.4.4