phpDocumentor phpDocumentor
Parsers
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: XMLPackagePageParser

Source Location: /phpDocumentor/XMLpackagePageParser.inc

Class XMLPackagePageParser

Class Overview

Used to parse XML DocBook-based tutorials

Located in /phpDocumentor/XMLpackagePageParser.inc [line 98]

Publisher
   |
   --Parser
      |
      --XMLPackagePageParser
Author(s): Information Tags:
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

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Publisher

Publisher::$subscriber

Inherited From 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 Publisher

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

[ Top ]
Property Summary
array   $context  
array   $eventHandlers  
array   $pars  
mixed   $refsect1id  
mixed   $refsect2id  
mixed   $refsect3id  

[ Top ]
Method Summary
static mixed   getParserEventName()   debugging function
XMLPackagePageParser   XMLPackagePageParser()   Set up the wordparser
bool   parse()   Parse a new file
void   setupStates()   setup the parser tokens, and the pushEvent/popEvent arrays

[ Top ]
Properties
array   $context [line 125]

[ Top ]
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]

[ Top ]
array   $pars = array() [line 117]

[ Top ]
mixed   $refsect1id = false [line 119]

[ Top ]
mixed   $refsect2id = false [line 120]

[ Top ]
mixed   $refsect3id = false [line 121]

[ Top ]
Methods
static method getParserEventName  [line 615]

  static mixed getParserEventName( mixed $value  )

debugging function

  1. function getParserEventName ($value)
  2.     {    
  3.         $lookup array(
  4.             PARSER_EVENT_NOEVENTS
  5.                 => "PARSER_EVENT_NOEVENTS",
  6.             PHPDOCUMENTOR_PDP_EVENT_TAG
  7.                 => "PHPDOCUMENTOR_PDP_EVENT_TAG",
  8.             PHPDOCUMENTOR_PDP_EVENT_ATTRIBUTES
  9.                 => "PHPDOCUMENTOR_PDP_EVENT_ATTRIBUTES",
  10.             PHPDOCUMENTOR_PDP_EVENT_CDATA
  11.                 => "PHPDOCUMENTOR_PDP_EVENT_CDATA",
  12.             PHPDOCUMENTOR_PDP_EVENT_LIST
  13.                 => "PHPDOCUMENTOR_PDP_EVENT_LIST",
  14.             PARSER_EVENT_QUOTE
  15.                 => "PARSER_EVENT_QUOTE",
  16.             PHPDOCUMENTOR_PDP_EVENT_ENTITY
  17.                 => "PHPDOCUMENTOR_PDP_EVENT_ENTITY",
  18.             PHPDOCUMENTOR_PDP_EVENT_COMMENT
  19.                 => "PHPDOCUMENTOR_PDP_EVENT_COMMENT",
  20.             PHPDOCUMENTOR_PDP_EVENT_PI
  21.                 => "PHPDOCUMENTOR_PDP_EVENT_PI",
  22.         );
  23.         if (isset($lookup[$value])) {
  24.             return $lookup[$value];
  25.         else {
  26.             return $value;
  27.         }
  28.     }

Parameters:
mixed   $value:  a value

API Tags:
Return:  the looked up value if found, else the original value


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

[ Top ]
Constructor XMLPackagePageParser  [line 138]

  XMLPackagePageParser XMLPackagePageParser( )

Set up the wordparser

  1.     {
  2.         $this->wp new ObjectWordParser(true);
  3.     }


API Tags:
Uses:  ObjectWordParser


[ Top ]
parse  [line 155]

  bool parse( string $parse_data, array $tutorial  )

Parse a new file

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

API 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


Redefinition of:
Parser::parse()
Parse a new file

[ Top ]
setupStates  [line 524]

  void setupStates( )

setup the parser tokens, and the pushEvent/popEvent arrays


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


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

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:21:46 -0600 by phpDocumentor 1.4.4