Docs For Class Parser

Parser Parser(
)

Set up invariant parsing variables

[ Top ]

void categoryTagHandler(
string
$word)

handles @category

Tag Handlers

Tags:

tutorial:

@category

Parameters:

string

$word

[ Top ]

mixed checkEventPop(

$word, 
$pevent)

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

Overridden in child classes as:

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

Parameters:

	$word
	$pevent

[ Top ]

mixed checkEventPush(

$word, 
$pevent)

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

Overridden in child classes as:

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

Parameters:

	$word
	$pevent

[ Top ]

void configWordParser(
$value
$e)

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

Overridden in child classes as:

phpDocumentor_HighlightParser::configWordParser(): Give the word parser necessary data to begin a new parse

phpDocumentor_TutorialHighlightParser::configWordParser(): Tell the parser's WordParser $wp to set up tokens to parse words by.

Parameters:

$value

$e

integer an event number

[ Top ]

void defaultTagHandler(
string
$word)

Handles all standard tags that only have a description

Tag Handlers

Parameters:

string

$word

[ Top ]

void endTag(
)

Called to clean up at the end of parsing a @tag in a docblock

[ Top ]

void exampleTagHandler(
string
$word)

handles @example

Tag Handlers

Tags:

tutorial:

@example

Parameters:

string

$word

[ Top ]

void getParserEventName(
$value
$value)

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

Overridden in child classes as:

parserDescParser::getParserEventName()

phpDocumentor_TutorialHighlightParser::getParserEventName(): searches for a parser event name based on its number

XMLPackagePageParser::getParserEventName(): debugging function

PDFParser::getParserEventName(): Return the name of the parser event

Parameters:

$value

$value

integer an event number

[ Top ]

void globalTagHandler(
string
$word)

handles @global

Tag Handlers

Tags:

tutorial:

@global

Parameters:

string

$word

[ Top ]

void invalidTagHandler(
string
$word)

Handles tags like '@filesource' that only work in PHP 4.3.0+

Tag Handlers

Parameters:

string

$word

[ Top ]

void packageTagHandler(
string
$word)

handles @package

Tag Handlers

Tags:

tutorial:

@package

Parameters:

string

$word

[ Top ]

void paramTagHandler(
string
$word)

handles @param

Tag Handlers

Tags:

tutorial:

@param

Parameters:

string

$word

[ Top ]

bool parse(

&$parse_data, string
$path, [int
$base = 0], [
$packages = false], string
$parse_data)

Parse a new file

Tags:

staticvar:

integer $endrecur: used for recursion limiting if a handler for an event is not found

Overridden in child classes as:

phpDocumentorTParser::parse(): Parse a new file

phpDocumentor_HighlightParser::parse(): Parse a new file

parserDescParser::parse(): Parse a long or short description for tags

phpDocumentor_TutorialHighlightParser::parse(): Parse a new file

ppageParser::parse(): Parse a new file

XMLPackagePageParser::parse(): Parse a new file

PDFParser::parse(): Parse text for PDFParser XML tags, and add the text to the PDF file

Parameters:

string	$parse_data
string	$path
int	$base	number of directories to drop off the bottom when creating names using path
	&$parse_data
	$packages

[ Top ]

void propertyTagHandler(
string
$word)

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

Tag Handlers

Parameters:

string

$word

[ Top ]

void returnTagHandler(
string
$word)

handles @return

Tag Handlers

Tags:

tutorial:

@return

Parameters:

string

$word

[ Top ]

void setupStates(
)

setup the parser tokens, and the pushEvent/popEvent arrays

Tags:

see:

Publisher::$tokens, Publisher::$pushEvent, Publisher::$popEvent

Overridden in child classes as:

phpDocumentor_HighlightParser::setupStates(): Initialize all parser state variables

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

phpDocumentor_TutorialHighlightParser::setupStates(): Initialize all parser state variables

ppageParser::setupStates(): set up invariant Parser variables

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

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

[ Top ]

void staticvarTagHandler(
string
$word)

handles @staticvar

Tag Handlers

Tags:

tutorial:

@staticvar

Parameters:

string

$word

[ Top ]

void usesTagHandler(
string
$word)

handles @uses

Tag Handlers

Tags:

tutorial:

@uses

Parameters:

string

$word

[ Top ]

void varTagHandler(
string
$word)

handles @var

Tag Handlers

Tags:

tutorial:

@var

Parameters:

string

$word

[ Top ]

Class: Parser

Class Overview

Author(s):

Version:

Copyright:

Methods

Child classes:

Inherited Variables

Class: Publisher

Inherited Methods

Class: Publisher

Class Details

Tags:

Class Methods

constructor Parser [line 487]

method categoryTagHandler [line 2046]

Tags:

Parameters:

method checkEventPop [line 2612]

Tags:

Parameters:

method checkEventPush [line 2590]

Tags:

Parameters:

method configWordParser [line 2957]

Tags:

Parameters:

method defaultTagHandler [line 1989]

Parameters:

method endTag [line 1971]

method exampleTagHandler [line 2031]

Tags:

Parameters:

method getParserEventName [line 2968]

Parameters:

method globalTagHandler [line 2062]

Tags:

Parameters:

method invalidTagHandler [line 2003]

Parameters:

method packageTagHandler [line 2015]

Tags:

Parameters:

method paramTagHandler [line 2192]

Tags:

Parameters:

method parse [line 509]

Tags:

Parameters:

method propertyTagHandler [line 2276]

Parameters:

method returnTagHandler [line 2228]

Tags:

Parameters:

method setupStates [line 2628]

Tags:

method staticvarTagHandler [line 2134]

Tags:

Parameters:

method usesTagHandler [line 2170]

Tags:

Parameters:

method varTagHandler [line 2252]

Tags:

Parameters: