Class: phpDocumentor_HighlightParser

Source Location: /phpDocumentor/HighlightParser.inc

Class Overview [line 226]

Publisher
   |
   --Parser
      |
      --phpDocumentorTParser
         |
         --phpDocumentor_HighlightParser

Variables

Constants

Methods


Inherited Methods

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 [email protected]' 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

Class: Publisher

Publisher::publishEvent()
Publish an event
Publisher::subscribe()
Adds a subscriber to the $subscriber array().


Class Details

Highlights source code using parse()

Tags:

[ Top ]


Class Variables


Class Methods

phpDocumentor_HighlightParser

void phpDocumentor_HighlightParser( )

[line 2322]

Initialize the $tokenpushEvent, $wordpushEvent arrays

Parameters:

[ Top ]

configWordParser

void configWordParser( array &$data)

[line 2231]

Give the word parser necessary data to begin a new parse

Tags:

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

Parameters:

  • array &$data - all tokens separated by line number

[ Top ]

newLineNum

void newLineNum( )

[line 346]

wraps the current line (via the converter) and resets it to empty

Tags:

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

Parameters:

[ Top ]

parse

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

[line 406]

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:

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

Parameters:

  • array &$parse_data - the parse data
  • Converter &$converter - the converter object
  • bool $inlinesourceparse - whether this data is from an inline [email protected]} tag
  • string|false $class - if a string, it is the name of the class whose method we are parsing containing a [email protected]} tag
  • false|integer $linenum - starting line number from [email protected] linenum}
  • false|string $filesourcepath - full path to file with @filesource tag, if this is a @filesource parse

[ Top ]

setLineNum

void setLineNum( int $num)

[line 365]

Start the parsing at a certain line number

Parameters:

  • int $num - line number

[ Top ]

setupStates

void setupStates( bool $inlinesourceparse, false|string $class)

[line 2248]

Initialize all parser state variables

Tags:

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

Parameters:

  • bool $inlinesourceparse - true if we are highlighting an inline [email protected]} tag's output
  • false|string $class - name of class we are going to start from

[ Top ]


Class Constants


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