Class PDFParser

(line 68)

Description

Publisher
   |
   --Parser
      |
      --PDFParser

Located in File: /phpDocumentor/Converters/PDF/default/ParserPDF.inc



Class Variables

Summary:

Class Constants

Summary:

Method Detail

Summary:
PDFParser PDFParser ()
void getParserEventName (integer $value)
bool parse (string $parse_data, string $fontdir, phpdocpdf &$pdf, [boolean $debug = false])
void setupStates ()

Constructor PDFParser (line 89)

PDFParser PDFParser( )

Sets up the wordparser for this class

Info

Method getParserEventName (line 549)

void getParserEventName( integer $value)

Overrides : Parser::getParserEventName() Debugging function, takes an event number and attempts to return its name

Return the name of the parser event

Parameters

  • integer $value:

Info

Method parse (line 105)

bool parse( string $parse_data, string $fontdir, phpdocpdf &$pdf, [boolean $debug = false])

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

Parse text for PDFParser XML tags, and add the text to the PDF 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

Info

  • staticvar - integer $endrecur: used for recursion limiting if a handler for an event is not found

Method setupStates (line 485)

void setupStates( )

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

setup the parser tokens, and the pushEvent/popEvent arrays

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class Publisher

Publisher::$subscriber - Array of references objects that have Subscribed to this publisher

Inherited Methods

Inherited Method Summary

Inherited From 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


Inherited From Class Publisher

Publisher::publishEvent() - Publish an event

Publisher::subscribe() - Adds a subscriber to the $subscriber array().



Documentation generated on Mon, 05 Dec 2011 21:28:55 -0600 by phpDocumentor 1.4.4