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

Class: ppageParser

Source Location: /phpDocumentor/Parser.inc

Class ppageParser

Class Overview

Global package page parser

Located in /phpDocumentor/Parser.inc [line 3026]

Publisher
   |
   --Parser
      |
      --ppageParser
Author(s): API Tags:
Deprecated:  in favor of tutorials

Information Tags:
Tutorial:  phpDocumentor Tutorials
Version:  $Id: Parser.inc 238276 2007-06-22 14:58:30Z ashnazg $
Copyright:  2000-2007 Kellin, Joshua Eichorn

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
string   $package  
string   $subpackage  

[ Top ]
Method Summary
ppageParser   ppageParser()   set up invariant Parser variables
void   defaultHandler()   Handles all non-inline tags
void   handleInlineDockeyword()   handler for INLINE_DOCKEYWORD.
mixed   parse()   Parse a new file
void   setupStates()   set up invariant Parser variables

[ Top ]
Properties
string   $package = false [line 3029]

[ Top ]
string   $subpackage = '' [line 3031]

[ Top ]
Methods
Constructor ppageParser  [line 3035]

  ppageParser ppageParser( )

set up invariant Parser variables



[ Top ]
defaultHandler  [line 3149]

  void defaultHandler( string $word, integer $pevent  )

Handles all non-inline tags

Parameters:
string   $word:  token
integer   $pevent:  parser event


[ Top ]
handleInlineDockeyword  [line 3165]

  void handleInlineDockeyword( string $word, integer $pevent  )

handler for INLINE_DOCKEYWORD.

this handler recognizes {@inline 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 ]
parse  [line 3071]

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

Parse a new file

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

API Tags:
Return:  false or parsed data


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

[ Top ]
setupStates  [line 3047]

  void setupStates( )

set up invariant Parser variables



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

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:37 -0600 by phpDocumentor 1.4.4