Docs For Class XMLPackagePageParser

Description

Publisher
   |
   --Parser
      |
      --XMLPackagePageParser

Located in File: /phpDocumentor/XMLpackagePageParser.inc

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

Class Variables

Summary:

array $context

array $eventHandlers

array $pars

mixed $refsect1id

mixed $refsect2id

mixed $refsect3id

$context (line 125)

Data type : array

var: - the tag stack

$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)

Data type : array

$pars = array() (line 117)

Data type : array

$refsect1id = false (line 119)

Data type : mixed

$refsect2id = false (line 120)

Data type : mixed

$refsect3id = false (line 121)

Data type : mixed

Class Constants

Summary:

Method Detail

Summary:

static mixed getParserEventName (mixed $value)

XMLPackagePageParser XMLPackagePageParser ()

bool parse (string $parse_data, array $tutorial)

void setupStates ()

Static Method getParserEventName (line 615)

mixed getParserEventName( mixed $value)

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

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;
}
}

Parameters

mixed $value: a value

Info

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

Constructor XMLPackagePageParser (line 138)

XMLPackagePageParser XMLPackagePageParser( )

Set up the wordparser

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

Info

uses - ObjectWordParser

Method parse (line 155)

bool parse( string $parse_data, array $tutorial)

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

Parse a new file

Parameters

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

Info

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

Method setupStates (line 524)

void setupStates( )

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

setup the parser tokens, and the pushEvent/popEvent arrays

Info

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

Class XMLPackagePageParser

Description

Used to parse XML DocBook-based tutorials

Class Variables

$context (line 125)

Data type : array

Data type : array

$pars = array() (line 117)

Data type : array

$refsect1id = false (line 119)

Data type : mixed

$refsect2id = false (line 120)

Data type : mixed

$refsect3id = false (line 121)

Data type : mixed

Class Constants

Method Detail

Static Method getParserEventName (line 615)

mixed getParserEventName( mixed $value)

debugging function

Parameters

Info

Constructor XMLPackagePageParser (line 138)

XMLPackagePageParser XMLPackagePageParser( )

Set up the wordparser

Info

Method parse (line 155)

bool parse( string $parse_data, array $tutorial)

Parse a new file

Parameters

Info

Method setupStates (line 524)

void setupStates( )

setup the parser tokens, and the pushEvent/popEvent arrays

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class Publisher

Publisher::$subscriber - Array of references objects that have Subscribed to this publisher

Inherited Methods

Inherited Method Summary

Inherited From Class Parser

Parser::Parser() - Set up invariant parsing variables

Parser::categoryTagHandler() - handles @category

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::defaultTagHandler() - Handles all standard tags that only have a description

Parser::endTag() - Called to clean up at the end of parsing a @tag in a docblock

Parser::exampleTagHandler() - handles @example

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

Parser::globalTagHandler() - handles @global

Parser::invalidTagHandler() - Handles tags like '@filesource' that only work in PHP 4.3.0+

Parser::packageTagHandler() - handles @package

Parser::paramTagHandler() - handles @param

Parser::parse() - Parse a new file

Parser::propertyTagHandler() - Handles @property(-read or -write) and @method magic tag

Parser::returnTagHandler() - handles @return

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

Parser::staticvarTagHandler() - handles @staticvar

Parser::usesTagHandler() - handles @uses

Parser::varTagHandler() - handles @var

Inherited From Class Publisher

Publisher::publishEvent() - Publish an event

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