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

Class: ppageParser

Source Location: /phpDocumentor/Parser.inc

Class Overview

Publisher
   |
   --Parser
      |
      --ppageParser

Global package page parser


Author(s):

Version:

  • $Id: Parser.inc 238276 2007-06-22 14:58:30Z ashnazg $

Copyright:

  • 2000-2007 Kellin, Joshua Eichorn

Variables

Methods


Inherited Variables

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 [email protected]' 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



[ Top ]


Class Variables

$package =  false

[line 3029]


Type:   string


[ Top ]

$subpackage =  ''

[line 3031]


Type:   string


[ Top ]



Class Methods


constructor ppageParser [line 3035]

ppageParser ppageParser( )

set up invariant Parser variables



[ Top ]

method defaultHandler [line 3149]

void defaultHandler( string $word, integer $pevent)

Handles all non-inline tags



Parameters:

string   $word   token
integer   $pevent   parser event

[ Top ]

method handleInlineDockeyword [line 3165]

void handleInlineDockeyword( string $word, integer $pevent)

handler for INLINE_DOCKEYWORD.

this handler recognizes [email protected] tags} like link, and parses them, replacing them directly in the text flow with their output.




Parameters:

string   $word   token
integer   $pevent   parser event

[ Top ]

method parse [line 3071]

mixed parse( &$parse_data, $xml, [string $package = 'default'], [int $subpackage = ''], [ $tutorial = ''], [ $category = 'default'], [ $path = ''], string $parse_data)

Parse a new file



Tags:

return:  false or parsed data


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

Parameters:

string   $parse_data  
string   $package  
int   $subpackage  
   &$parse_data  
   $xml  
   $tutorial  
   $category  
   $path  

[ Top ]

method setupStates [line 3047]

void setupStates( )

set up invariant Parser variables



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

[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:14:24 -0600 by phpDocumentor 1.4.4