Docs For Class Parser

Class: Parser

Class Details

[line 255]

Version: $Id: Parser.inc,v 1.174 2003/01/01 07:23:11 CelloG Exp $
Author: Gregory Beaver <mailto:cellog@users.sourceforge.net>
Author: Joshua Eichorn <mailto:jeichorn@phpdoc.org>

Method Detail

Parser (Constructor) [line 387]

Parser Parser(
)

[ Top ]

checkEventPop [line 2272]

mixed checkEventPop(
mixed
$word, mixed
$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:

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

[ Top ]

checkEventPush [line 2250]

mixed checkEventPush(
mixed
$word, mixed
$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:

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

[ Top ]

configWordParser [line 2615]

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:

phpDocumentorTParser::configWordParser()

Parameters:

$value $e — integer an event number

[ Top ]

getParserEventName [line 2626]

void getParserEventName(
$value
$value)

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

Overridden in child classes as:

parserDescParser::getParserEventName()

XMLPackagePageParser::getParserEventName()

PDFParser::getParserEventName()

Parameters:

$value $value — integer an event number

[ Top ]

parse [line 409]

bool parse(
string
&$parse_data, string
$path, [int
$base = 0], [mixed
$packages = false])

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:

ppageParser::parse(): Parse a new file

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

phpDocumentorTParser::parse(): Parse a new file

XMLPackagePageParser::parse(): Parse a new file

PDFParser::parse(): Parse a new file

Parameters:

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

[ Top ]

setupStates [line 2288]

void setupStates(
)

setup the parser tokens, and the pushEvent/popEvent arrays

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

Overridden in child classes as:

ppageParser::setupStates()

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

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

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

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

[ 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 387]

checkEventPop [line 2272]

checkEventPush [line 2250]

configWordParser [line 2615]

Parameters:

getParserEventName [line 2626]

Parameters:

parse [line 409]

Parameters:

setupStates [line 2288]