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

Class: PDFParser

Source Location: /phpDocumentor/Converters/PDF/default/ParserPDF.inc

Class Overview

Publisher
   |
   --Parser
      |
      --PDFParser



Author(s):

Version:

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

Copyright:

  • 2000-2007 Kellin, Joshua Eichorn

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 '@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

[line 68]


Tags:

author:  Greg Beaver <cellog@php.net>
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 Methods


constructor PDFParser [line 89]

PDFParser PDFParser( )

Sets up the wordparser for this class



[ Top ]

method getParserEventName [line 549]

void getParserEventName( integer $value)

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 ]

method parse [line 105]

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

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 ]

method setupStates [line 485]

void setupStates( )

setup the parser tokens, and the pushEvent/popEvent arrays



Tags:



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

[ Top ]


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