Class: XMLPackagePageParser

Source Location: /phpDocumentor/XMLpackagePageParser.inc

Class Overview

Publisher
   |
   --Parser
      |
      --XMLPackagePageParser

Used to parse XML DocBook-based tutorials

Author(s):

Gregory Beaver <[email protected]>

Version:

Release: @VER@

Copyright:

2002-2007 Gregory Beaver

Variables

Methods

Inherited Variables

Class: Publisher

Publisher::$subscriber

Inherited Methods

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

Class: Publisher

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

Class Details

[line 98]
Used to parse XML DocBook-based tutorials

Tags:

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

[ Top ]

Class Variables

$context =

[line 125]

Tags:

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',
        PHPDOCUMENTOR_PDP_EVENT_ENTITY => 'handleEntity',
    )

[line 103]

Type:

array

[ Top ]

$pars = array()

[line 117]

Type:

array

[ Top ]

$refsect1id = false

[line 119]

Type:

mixed

[ Top ]

$refsect2id = false

[line 120]

Type:

mixed

[ Top ]

$refsect3id = false

[line 121]

Type:

mixed

[ Top ]

Class Methods

static method getParserEventName [line 615]

static mixed getParserEventName(
mixed
$value)

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

Tags:

return:

the looked up value if found, else the original value

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

Parameters:

mixed

$value

a value

[ Top ]

constructor XMLPackagePageParser [line 138]

XMLPackagePageParser XMLPackagePageParser(
)

Set up the wordparser

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

Tags:

uses:

ObjectWordParser

[ Top ]

method parse [line 155]

bool parse(
string
$parse_data, array
$tutorial)

Parse a new file

Tags:

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

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

Parameters:

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

[ Top ]

method setupStates [line 524]

void setupStates(
)

setup the parser tokens, and the pushEvent/popEvent arrays

Tags:

see:

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

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

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:15:31 -0600 by phpDocumentor 1.4.4