Class: XMLPackagePageParser

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

Class Overview

Publisher
   |
   --Parser
      |
      --XMLPackagePageParser

Author(s):

Greg Beaver <mailto:cellog at users.sourceforge.net>

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 31]

Version: $Id: Parser.inc,v 1.174 2003/01/01 07:23:11 CelloG Exp $
Since: 1.2
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>

[ Top ]

Class Variables

$context =

[line 54]

Var: the tag stack

Type:

array

[ Top ]

$eventHandlers = array(
                               PHPDOCUMENTOR_PDP_EVENT_TAG => 'handleTag',
                               PHPDOCUMENTOR_PDP_EVENT_ATTRIBUTES => 'handleAttributes',
                               PHPDOCUMENTOR_PDP_EVENT_CDATA => 'handleCData',
                               PARSER_EVENT_NOEVENTS => 'defaultHandler',
                               PARSER_EVENT_COMMENTBLOCK => 'ignoreHandler',
                               PARSER_EVENT_OUTPHP => 'ignoreHandler',
                               PARSER_EVENT_QUOTE => 'handleQuote',
                               )

[line 33]

Type:

mixed

[ Top ]

$pars = array()

[line 46]

Type:

array

[ Top ]

$refsect1id = false

[line 48]

Type:

mixed

[ Top ]

$refsect2id = false

[line 49]

Type:

mixed

[ Top ]

$refsect3id = false

[line 50]

Type:

mixed

[ Top ]

Method Detail

XMLPackagePageParser (Constructor) [line 59]

XMLPackagePageParser XMLPackagePageParser(
)

[ Top ]

defaultHandler [line 149]

void defaultHandler(
mixed
$word, mixed
$pevent)

[ Top ]

getParserEventName [line 438]

void getParserEventName(
mixed
$value)

Overrides Parser::getParserEventName() (Debugging function, takes an event number and attempts to return its name)

[ Top ]

handleAttributes [line 303]

void handleAttributes(
mixed
$word, mixed
$pevent)

[ Top ]

handleCData [line 269]

void handleCData(
mixed
$word, mixed
$pevent)

[ Top ]

handleQuote [line 168]

void handleQuote(
mixed
$word, mixed
$pevent)

handler for QUOTE.

this handler recognizes strings defined with double quotation marks (") and handles them correctly in any place that they legally appear in php code

[ Top ]

handleTag [line 202]

void handleTag(
mixed
$word, mixed
$pevent)

[ Top ]

ignoreHandler [line 157]

void ignoreHandler(
mixed
$word, mixed
$pevent)

[ Top ]

parse [line 72]

bool parse(
string
$parse_data, array
$tutorial)

Parse a new file

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

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

Parameters:

string	`$parse_data`	—
array	`$tutorial`	—	for format, see Io::getTutorials()

[ Top ]

setupStates [line 376]

void setupStates(
)

setup the parser tokens, and the pushEvent/popEvent arrays

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

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

[ Top ]