Docs For Class XMLPackagePageParser

Description

Used to parse XML DocBook-based tutorials

author: Gregory Beaver <[email protected]>
version: Release: @VER@
copyright: 2002-2007 Gregory Beaver
link: http://pear.php.net/PhpDocumentor
link: http://www.phpdoc.org
todo: CS cleanup - change package to PhpDocumentor
since: 1.2
license: LGPL

Located in /phpDocumentor/XMLpackagePageParser.inc (line 98)

Publisher
   |
   --Parser
      |
      --XMLPackagePageParser

Variable Summary

array $context

array $eventHandlers

array $pars

mixed $refsect1id

mixed $refsect2id

mixed $refsect3id

Method Summary

static mixed getParserEventName (mixed $value)

XMLPackagePageParser XMLPackagePageParser ()

bool parse (string $parse_data, array $tutorial)

void setupStates ()

Variables

array $context (line 125)

var: the tag stack

array $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',
PHPDOCUMENTOR_PDP_EVENT_ENTITY => 'handleEntity',
) (line 103)

array $pars = array() (line 117)

mixed $refsect1id = false (line 119)

mixed $refsect2id = false (line 120)

mixed $refsect3id = false (line 121)

Inherited Variables

Inherited from Publisher

Publisher::$subscriber

Methods

static method getParserEventName (line 615)

debugging function

function getParserEventName ($value)
{
$lookup = array(
PARSER_EVENT_NOEVENTS
=> "PARSER_EVENT_NOEVENTS",
PHPDOCUMENTOR_PDP_EVENT_TAG
=> "PHPDOCUMENTOR_PDP_EVENT_TAG",
PHPDOCUMENTOR_PDP_EVENT_ATTRIBUTES
=> "PHPDOCUMENTOR_PDP_EVENT_ATTRIBUTES",
PHPDOCUMENTOR_PDP_EVENT_CDATA
=> "PHPDOCUMENTOR_PDP_EVENT_CDATA",
PHPDOCUMENTOR_PDP_EVENT_LIST
=> "PHPDOCUMENTOR_PDP_EVENT_LIST",
PARSER_EVENT_QUOTE
=> "PARSER_EVENT_QUOTE",
PHPDOCUMENTOR_PDP_EVENT_ENTITY
=> "PHPDOCUMENTOR_PDP_EVENT_ENTITY",
PHPDOCUMENTOR_PDP_EVENT_COMMENT
=> "PHPDOCUMENTOR_PDP_EVENT_COMMENT",
PHPDOCUMENTOR_PDP_EVENT_PI
=> "PHPDOCUMENTOR_PDP_EVENT_PI",
);
if (isset($lookup[$value])) {
return $lookup[$value];
} else {
return $value;
}
}

return: the looked up value if found, else the original value

static mixed getParserEventName (mixed $value)

mixed $value: a value

Redefinition of:

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

Constructor XMLPackagePageParser (line 138)

Set up the wordparser

function XMLPackagePageParser()
{
$this->wp = new ObjectWordParser(true);
}

uses: ObjectWordParser

XMLPackagePageParser XMLPackagePageParser ()

parse (line 155)

Parse a new file

staticvar: integer $endrecur: used for recursion limiting if a handler for an event is not found
uses: parserTutorial - using Publisher::PublishEvent(), a new tutorial is created from the file parsed, and passed to the Intermediate Parser

bool parse (string $parse_data, array $tutorial)

string $parse_data: the parse data
array $tutorial: for format, see Io::getTutorials()

Redefinition of:

Parser::parse(): Parse a new file

setupStates (line 524)

setup the parser tokens, and the pushEvent/popEvent arrays

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

void setupStates ()

Redefinition of:

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

Inherited Methods

Inherited From Parser

Parser::Parser()
Parser::categoryTagHandler()
Parser::checkEventPop()
Parser::checkEventPush()
Parser::configWordParser()
Parser::defaultTagHandler()
Parser::endTag()
Parser::exampleTagHandler()
Parser::getParserEventName()
Parser::globalTagHandler()
Parser::invalidTagHandler()
Parser::packageTagHandler()
Parser::paramTagHandler()
Parser::parse()
Parser::propertyTagHandler()
Parser::returnTagHandler()
Parser::setupStates()
Parser::staticvarTagHandler()
Parser::usesTagHandler()
Parser::varTagHandler()

Inherited From Publisher

Publisher::publishEvent()
Publisher::subscribe()