Class ppageParser

Description

Global package page parser

Located in /phpDocumentor/Parser.inc (line 3026)

Publisher
   |
   --Parser
      |
      --ppageParser
Variable Summary
 string $package
 string $subpackage
Method Summary
 ppageParser ppageParser ()
 void defaultHandler (string $word, integer $pevent)
 void handleInlineDockeyword (string $word, integer $pevent)
 mixed parse ( &$parse_data,  $xml, [string $package = 'default'], [int $subpackage = ''], [ $tutorial = ''], [ $category = 'default'], [ $path = ''], string $parse_data)
 void setupStates ()
Variables
string $package = false (line 3029)
string $subpackage = '' (line 3031)

Inherited Variables

Inherited from Publisher

Publisher::$subscriber
Methods
Constructor ppageParser (line 3035)

set up invariant Parser variables

ppageParser ppageParser ()
defaultHandler (line 3149)

Handles all non-inline tags

void defaultHandler (string $word, integer $pevent)
  • string $word: token
  • integer $pevent: parser event
handleInlineDockeyword (line 3165)

handler for INLINE_DOCKEYWORD.

this handler recognizes {@inline tags} like link, and parses them, replacing them directly in the text flow with their output.

void handleInlineDockeyword (string $word, integer $pevent)
  • string $word: token
  • integer $pevent: parser event
parse (line 3071)

Parse a new file

  • return: false or parsed data
mixed parse ( &$parse_data,  $xml, [string $package = 'default'], [int $subpackage = ''], [ $tutorial = ''], [ $category = 'default'], [ $path = ''], string $parse_data)
  • string $parse_data
  • string $package
  • int $subpackage
  • &$parse_data
  • $xml
  • $tutorial
  • $category
  • $path

Redefinition of:
Parser::parse()
Parse a new file
setupStates (line 3047)

set up invariant Parser variables

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

Documentation generated on Mon, 05 Dec 2011 21:39:48 -0600 by phpDocumentor 1.4.4