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
Tags:
- author - Greg Beaver <[email protected]>
- version - $Id: Parser.inc 238276 2007-06-22 14:58:30Z ashnazg $
- copyright - 2000-2007 Kellin, Joshua Eichorn
- since - 1.2
- usedby - phpdocpdf::ezText() - extracts all meta-tags and processes text for output
[ Top ]
Class Variables
Class Methods
PDFParser
[ Top ]
getParserEventName
void getParserEventName(
integer
$value)
[line 549]
Return the name of the parser event
Overrides Parser::getParserEventName() (Debugging function, takes an event number and attempts to return its name)
Parameters:
- integer $value -
[ Top ]
parse
bool parse(
string
$parse_data, string
$fontdir, phpdocpdf
&$pdf, [boolean
$debug = false])
[line 105]
Parse text for PDFParser XML tags, and add the text to the PDF file
Tags:
- staticvar - integer $endrecur: used for recursion limiting if a handler for an event is not found
Overrides Parser::parse() (Parse a new file)
Parameters:
- string $parse_data - text to parse for PDFParser XML tags
- string $fontdir - full path to the font directory
- phpdocpdf &$pdf -
- boolean $debug - determines whether output is saved in a variable or added directly to the output
[ Top ]
setupStates
void setupStates(
)
[line 485]
setup the parser tokens, and the pushEvent/popEvent arrays
Tags:
Overrides Parser::setupStates() (setup the parser tokens, and the pushEvent/popEvent arrays)
Parameters:
[ Top ]