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
Global package page parser
Tags:
- tutorial - phpDocumentor Tutorials
- author - Joshua Eichorn <[email protected]>
- author - Gregory Beaver <[email protected]>
- version - $Id: Parser.inc 238276 2007-06-22 14:58:30Z ashnazg $
- copyright - 2000-2007 Kellin, Joshua Eichorn
- deprecated - in favor of tutorials
[ Top ]
Class Variables
$package = false
[line 3029]
Type: string
Overrides:
[ Top ]
$subpackage = ''
[line 3031]
Type: string
Overrides:
[ Top ]
Class Methods
ppageParser
ppageParser ppageParser(
)
[line 3035]
set up invariant Parser variables
Parameters:
[ Top ]
defaultHandler
void defaultHandler(
string
$word, integer
$pevent)
[line 3149]
Handles all non-inline tags
Parameters:
- string $word - token
- integer $pevent - parser event
[ Top ]
handleInlineDockeyword
void handleInlineDockeyword(
string
$word, integer
$pevent)
[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.
Parameters:
- string $word - token
- integer $pevent - parser event
[ Top ]
parse
mixed parse(
&$parse_data,
$xml, [string
$package = 'default'], [int
$subpackage = ''], [
$tutorial = ''], [
$category = 'default'], [
$path = ''], string
$parse_data)
[line 3071]
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 ]
setupStates
void setupStates(
)
[line 3047]
set up invariant Parser variables
Overrides Parser::setupStates() (setup the parser tokens, and the pushEvent/popEvent arrays)
Parameters:
[ Top ]