Docs For Class Parser

Parser (Constructor) [line 483]

Parser Parser(
)

Set up invariant parsing variables

[ Top ]

categoryTagHandler [line 2042]

void categoryTagHandler(
string
$word)

handles @category

Tag Handlers

Tutorial: @category

Parameters:

string $word —

[ Top ]

checkEventPop [line 2569]

mixed checkEventPop(

$word, 
$pevent)

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

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.

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

Parameters:

	`$word`	—
	`$pevent`	—

[ Top ]

checkEventPush [line 2547]

mixed checkEventPush(

$word, 
$pevent)

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

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.

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

Parameters:

	`$word`	—
	`$pevent`	—

[ Top ]

configWordParser [line 2914]

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"

See: WordParser

Overridden in child classes as:

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

phpDocumentorTParser::configWordParser()

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

Parameters:

$value $e — integer an event number

[ Top ]

defaultTagHandler [line 1985]

void defaultTagHandler(
string
$word)

Handles all standard tags that only have a description

Tag Handlers

Parameters:

string $word —

[ Top ]

endTag [line 1967]

void endTag(
)

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

[ Top ]

exampleTagHandler [line 2027]

void exampleTagHandler(
string
$word)

handles @example

Tag Handlers

Tutorial: @example

Parameters:

string $word —

[ Top ]

getParserEventName [line 2925]

void getParserEventName(
$value
$value)

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

Overridden in child classes as:

phpDocumentor_TutorialHighlightParser::getParserEventName()

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

XMLPackagePageParser::getParserEventName(): debugging function

parserDescParser::getParserEventName()

Parameters:

$value $value — integer an event number

[ Top ]

globalTagHandler [line 2058]

void globalTagHandler(
string
$word)

handles @global

Tag Handlers

Tutorial: @global

Parameters:

string $word —

[ Top ]

invalidTagHandler [line 1999]

void invalidTagHandler(
string
$word)

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

Tag Handlers

Parameters:

string $word —

[ Top ]

packageTagHandler [line 2011]

void packageTagHandler(
string
$word)

handles @package

Tag Handlers

Tutorial: @package

Parameters:

string $word —

[ Top ]

paramTagHandler [line 2188]

void paramTagHandler(
string
$word)

handles @param

Tag Handlers

Tutorial: @param

Parameters:

string $word —

[ Top ]

parse [line 505]

bool parse(

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

Parse a new file

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

Overridden in child classes as:

phpDocumentor_TutorialHighlightParser::parse(): Parse a new file

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

ppageParser::parse(): Parse a new file

XMLPackagePageParser::parse(): Parse a new file

phpDocumentorTParser::parse(): Parse a new file

phpDocumentor_HighlightParser::parse(): Parse a new file

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

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 ]

returnTagHandler [line 2224]

void returnTagHandler(
string
$word)

handles @return

Tag Handlers

Tutorial: @return

Parameters:

string $word —

[ Top ]

setupStates [line 2585]

void setupStates(
)

setup the parser tokens, and the pushEvent/popEvent arrays

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

Overridden in child classes as:

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

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

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

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

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

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

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

[ Top ]

staticvarTagHandler [line 2130]

void staticvarTagHandler(
string
$word)

handles @staticvar

Tag Handlers

Tutorial: @staticvar

Parameters:

string $word —

[ Top ]

usesTagHandler [line 2166]

void usesTagHandler(
string
$word)

handles @uses

Tag Handlers

Tutorial: @uses

Parameters:

string $word —

[ Top ]

varTagHandler [line 2248]

void varTagHandler(
string
$word)

handles @var

Tag Handlers

Tutorial: @var

Parameters:

string $word —

[ Top ]

Class: Parser

Class Overview

Author(s):

Version:

Methods

Child classes:

Inherited Variables

Class: Publisher

Inherited Methods

Class: Publisher

Class Details

Method Detail

Parser (Constructor) [line 483]

categoryTagHandler [line 2042]

Parameters:

checkEventPop [line 2569]

Parameters:

checkEventPush [line 2547]

Parameters:

configWordParser [line 2914]

Parameters:

defaultTagHandler [line 1985]

Parameters:

endTag [line 1967]

exampleTagHandler [line 2027]

Parameters:

getParserEventName [line 2925]

Parameters:

globalTagHandler [line 2058]

Parameters:

invalidTagHandler [line 1999]

Parameters:

packageTagHandler [line 2011]

Parameters:

paramTagHandler [line 2188]

Parameters:

parse [line 505]

Parameters:

returnTagHandler [line 2224]

Parameters:

setupStates [line 2585]

staticvarTagHandler [line 2130]

Parameters:

usesTagHandler [line 2166]

Parameters:

varTagHandler [line 2248]

Parameters: