Class: ppageParser

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/Parser.inc

Class Overview

Publisher
   |
   --Parser
      |
      --ppageParser

Global package page parser

Author(s):

Gregory Beaver <mailto:cellog at users.sourceforge.net>
Joshua Eichorn <mailto:jeichorn at phpdoc.org>

Version:

$Id: Parser.inc,v 1.174 2003/01/01 07:23:11 CelloG Exp $

Variables

Methods

Inherited Variables

Class: Publisher

Publisher::$subscriber

Inherited Methods

Class: Parser

Parser::Parser()
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::getParserEventName(): Debugging function, takes an event number and attempts to return its name
Parser::parse(): Parse a new file
Parser::setupStates(): setup the parser tokens, and the pushEvent/popEvent arrays

Class: Publisher

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

Class Details

[line 2673]
Global package page parser

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>

[ Top ]

Class Variables

$package = false

[line 2675]

Type:

mixed

[ Top ]

$subpackage = ''

[line 2676]

Type:

mixed

[ Top ]

Method Detail

ppageParser (Constructor) [line 2677]

ppageParser ppageParser(
)

[ Top ]

defaultHandler [line 2779]

void defaultHandler(
mixed
$word, mixed
$pevent)

[ Top ]

handleInlineDockeyword [line 2793]

void handleInlineDockeyword(
mixed
$word, mixed
$pevent)

handler for INLINE_DOCKEYWORD.

this handler recognizes {@inline tags} like link, and parses them, replacing them directly in the text flow with their output.

[ Top ]

parse [line 2710]

mixed parse(
string
&$parse_data, mixed
$xml, [string
$package = 'default'], [int
$subpackage = ''], [mixed
$tutorial = ''])

Parse a new file

Return: false or parsed data

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

Parameters:

string	`$parse_data`	—
string	`$package`	—
int	`$subpackage`	—

[ Top ]

setupStates [line 2686]

void setupStates(
)

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

[ Top ]