Class PDFdefaultConverter

(line 55)

Description

Converter
   |
   --PDFdefaultConverter

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

PDF output converter.

This Converter takes output from the Parser and converts it to PDF-ready output for use with Cezpdf. This is now beta code


Class Variables

Summary:
mixed $classpackage_pagenums
mixed $curclasspackage
mixed $curpagepackage
mixed $leftindex
string $name
string $outputformat
mixed $pagepackage_pagenums
Cezpdf $pdf
mixed $ric_set
mixed $smarty_dir
boolean $sort_absolutely_everything
array $_sourcecode

$classpackage_pagenums = array() (line 65)

Data type : mixed

$curclasspackage = false (line 71)

Data type : mixed

$curpagepackage = false (line 70)

Data type : mixed

$leftindex = array('classes' => false, 'pages' => false, 'functions' => false, 'defines' => false, 'globals' => false) (line 63)

Data type : mixed

Overrides: Array

$name = 'default' (line 69)

Data type : string

  • var: - always default

$outputformat = 'PDF' (line 67)

Data type : string

Overrides: Array

  • var: - always PDF

$pagepackage_pagenums = array() (line 64)

Data type : mixed

$pdf = false (line 76)

Data type : Cezpdf

$ric_set = array() (line 77)

Data type : mixed

$smarty_dir (line 72)

Data type : mixed

Overrides: Array

$sort_absolutely_everything = true (line 62)

Data type : boolean

Overrides: Array

default PDF Converter wants elements sorted by type as well as alphabetically

$_sourcecode (line 84)

Data type : array

Source files for appendix C are stored here

Format: array(array(package => packagename, code => array(highlightedsource code 1, ...)))

Class Constants

Summary:

Method Detail

Summary:
PDFdefaultConverter PDFdefaultConverter ( &$allp,  &$packp,  &$classes,  &$procpages,  $po,  $pp,  $qm,  $targetDir,  $templateDir,  $title)
void convertClass ( &$element)
void convertConst ( &$element)
void convertDefine ( &$element)
void convertDocBlock ( &$element)
void convertFunction ( &$element)
void convertGlobal ( &$element)
void convertInclude ( &$element)
void convertMethod ( &$element)
void convertPackagepage ( &$element)
void convertPage ( &$element)
void convertParams ( &$element)
void convertTutorial ( &$element)
void convertVar ( &$element)
void Convert_RIC (README|INSTALL|CHANGELOG $name, string $contents)
void generateFormattedClassTrees (string $package)
void getCData ( $value)
mixed getClassLink (string $expr, string $package, [string $file = false], [ $text = false])
mixed getConstLink (string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)
mixed getDefineLink (string $expr, string $package, [string $file = false], [boolean $text = false])
void getExampleLink ( $path,  $title)
void getFileSourceName ( $path, [ $anchor = ''])
mixed getFunctionLink (string $expr, string $package, [string $file = false], [boolean $text = false])
mixed getGlobalLink (string $expr, string $package, [string $file = false], [boolean $text = false])
void getGlobalValue ( $value)
mixed getMethodLink (string $expr, string $class, string $package, [string $file = false], [boolean $text = false])
mixed getPageLink (string $expr, string $package, [string $path = false], [boolean $text = false])
void getPageName ( &$element)
string getRootTree (array $tree,  $package)
string getSourceAnchor (string $sourcefile, string $anchor, [string $text = ''], [boolean $link = false])
void getSourceLink ( $path)
1 getState ()
void getTutorialId ( $package,  $subpackage,  $tutorial,  $id)
mixed getVarLink (string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)
void mystrnatcasecmp ( $a,  $b)
void Output ([ $title = 'Generated Documentation'])
void postProcess ( $text)
string returnLink (string $link, string $text)
void returnSee (abstractLink &$element, [string $eltext = false])
void setTemplateDir ( $dir)
string TranslateTag (string $name, string $attr, string $cdata, string $unconvertedcdata)
void unmangle ( $notused,  $source)
void writeExample ( $title,  $path,  $source)
void writeSource ( $path,  $value)

Constructor PDFdefaultConverter (line 88)

PDFdefaultConverter PDFdefaultConverter( &$allp, &$packp, &$classes, &$procpages, $po, $pp, $qm, $targetDir, $templateDir, $title)

Parameters

  • &$allp:
  • &$packp:
  • &$classes:
  • &$procpages:
  • $po:
  • $pp:
  • $qm:
  • $targetDir:
  • $templateDir:
  • $title:

Info

Method convertClass (line 461)

void convertClass( &$element)

Overrides : Converter::convertClass() Default Class Handler

Parameters

  • &$element:

Info

Method convertConst (line 439)

void convertConst( &$element)

Overrides : Converter::convertConst() Converts class constants for template output.

Parameters

  • &$element:

Info

Method convertDefine (line 541)

void convertDefine( &$element)

Overrides : Converter::convertDefine() Converts defines for template output

Parameters

  • &$element:

Info

Method convertDocBlock (line 249)

void convertDocBlock( &$element)

Parameters

  • &$element:

Info

Method convertFunction (line 508)

void convertFunction( &$element)

Overrides : Converter::convertFunction() Converts function for template output

Parameters

  • &$element:

Info

Method convertGlobal (line 349)

void convertGlobal( &$element)

Overrides : Converter::convertGlobal() Converts global variables for template output

Parameters

  • &$element:

Info

Method convertInclude (line 494)

void convertInclude( &$element)

Overrides : Converter::convertInclude() Converts includes for template output

Parameters

  • &$element:

Info

Method convertMethod (line 376)

void convertMethod( &$element)

Overrides : Converter::convertMethod() Converts method for template output

Parameters

  • &$element:

Info

Method convertPackagepage (line 638)

void convertPackagepage( &$element)

Parameters

  • &$element:

Info

Method convertPage (line 562)

void convertPage( &$element)

Overrides : Converter::convertPage() Default Page Handler

Parameters

  • &$element:

Info

Method convertParams (line 331)

void convertParams( &$element)

Parameters

  • &$element:

Info

Method convertTutorial (line 645)

void convertTutorial( &$element)

Overrides : Converter::convertTutorial() Default Tutorial Handler

Parameters

  • &$element:

Info

Method convertVar (line 416)

void convertVar( &$element)

Overrides : Converter::convertVar() Converts class variables for template output.

Parameters

  • &$element:

Info

Method Convert_RIC (line 244)

void Convert_RIC( README|INSTALL|CHANGELOG $name, string $contents)

Overrides : Converter::Convert_RIC() Convert README/INSTALL/CHANGELOG file contents to output format

Convert README/INSTALL/CHANGELOG file contents to output format

Parameters

  • README|INSTALL|CHANGELOG $name:
  • string $contents: contents of the file

Info

Method generateFormattedClassTrees (line 665)

void generateFormattedClassTrees( string $package)

returns a template-enabled array of class trees

Parameters

  • string $package: package to generate a class tree for

Info

Method getCData (line 630)

void getCData( $value)

Parameters

  • $value:

Info

Method getClassLink (line 844)

mixed getClassLink( string $expr, string $package, [string $file = false], [ $text = false])

Overrides : Converter::getClassLink() return false or a classLink to $expr

Parameters

  • string $expr: name of class
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • $text:

Info

Method getConstLink (line 954)

mixed getConstLink( string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)

Overrides : Converter::getConstLink() return false or a constLink to $expr in $class

Parameters

  • boolean 5: return just the URL, or enclose it in an html a tag
  • string $expr: name of class constant
  • string $class: class containing class constant
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated

Info

Method getDefineLink (line 874)

mixed getDefineLink( string $expr, string $package, [string $file = false], [boolean $text = false])

Overrides : Converter::getDefineLink() return false or a defineLink to $expr

Parameters

  • string $expr: name of define
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated

Info

Method getExampleLink (line 140)

void getExampleLink( $path, $title)

Parameters

  • $path:
  • $title:

Info

Method getFileSourceName (line 152)

void getFileSourceName( $path, [ $anchor = ''])

Overrides : Converter::getFileSourceName() Translate the path info into a unique file name for the highlighted source code.

Parameters

  • $path:
  • $anchor:

Info

Method getFunctionLink (line 859)

mixed getFunctionLink( string $expr, string $package, [string $file = false], [boolean $text = false])

Overrides : Converter::getFunctionLink() return false or a functionLink to $expr

Parameters

  • string $expr: name of function
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated

Info

Method getGlobalLink (line 889)

mixed getGlobalLink( string $expr, string $package, [string $file = false], [boolean $text = false])

Overrides : Converter::getGlobalLink() return false or a globalLink to $expr

Parameters

  • string $expr: name of global variable
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated

Info

Method getGlobalValue (line 371)

void getGlobalValue( $value)

Overrides : Converter::getGlobalValue() Parse a global variable's default value for class initialization.

Parameters

  • $value:

Info

Method getMethodLink (line 920)

mixed getMethodLink( string $expr, string $class, string $package, [string $file = false], [boolean $text = false])

Overrides : Converter::getMethodLink() return false or a methodLink to $expr in $class

Parameters

  • string $expr: name of method
  • string $class: class containing method
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated

Info

Method getPageLink (line 904)

mixed getPageLink( string $expr, string $package, [string $path = false], [boolean $text = false])

Overrides : Converter::getPageLink() return false or a pageLink to $expr

Parameters

  • string $expr: name of procedural page
  • string $package: package name
  • string $path: full path to look in (used in index generation)
  • boolean $text: deprecated

Info

Method getPageName (line 619)

void getPageName( &$element)

Parameters

  • &$element:

Info

Method getRootTree (line 684)

string getRootTree( array $tree, $package)

return formatted class tree for the Class Trees page

Parameters

Info

Method getSourceAnchor (line 167)

string getSourceAnchor( string $sourcefile, string $anchor, [string $text = ''], [boolean $link = false])

Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.

Parameters

  • string $sourcefile: full path to source file
  • string $anchor: name of anchor
  • string $text: link text, if this is a link
  • boolean $link: returns either a link or a destination based on this parameter

Info

  • return - link to an anchor, or the anchor

Method getSourceLink (line 146)

void getSourceLink( $path)

Overrides : Converter::getSourceLink() parent method not documented

Parameters

  • $path:

Info

Method getState (line 968)

1 getState( )

Overrides : Converter::getState() Return parserStringWithInlineTags::Convert() cache state

Info

  • return - always the same

Method getTutorialId (line 625)

void getTutorialId( $package, $subpackage, $tutorial, $id)

Overrides : Converter::getTutorialId() Return a converter-specific id to distinguish tutorials and their sections

Parameters

  • $package:
  • $subpackage:
  • $tutorial:
  • $id:

Info

Method getVarLink (line 937)

mixed getVarLink( string $expr, string $class, string $package, [string $file = false], [boolean $text = false], boolean 5)

Overrides : Converter::getVarLink() return false or a varLink to $expr in $class

Parameters

  • boolean 5: return just the URL, or enclose it in an html a tag
  • string $expr: name of var
  • string $class: class containing var
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated

Info

Method mystrnatcasecmp (line 831)

void mystrnatcasecmp( $a, $b)

Parameters

  • $a:
  • $b:

Info

Method Output (line 752)

void Output( [ $title = 'Generated Documentation'])

Overrides : Converter::Output() do all necessary output

calls Cezpdf::ezOutput() and writes documentation.pdf to targetDir

Parameters

  • $title:

Info

Method postProcess (line 121)

void postProcess( $text)

Overrides : Converter::postProcess() This version does nothing

Parameters

  • $text:

Info

Method returnLink (line 234)

string returnLink( string $link, string $text)

Overrides : Converter::returnLink() take URL $link and text $text and return a link in the format needed for the Converter

Parameters

  • string $link:
  • string $text:

Info

  • return - <c:alink:$link>$text</c:alink>

Method returnSee (line 184)

void returnSee( abstractLink &$element, [string $eltext = false])

Overrides : Converter::returnSee() take abstractLink descendant and text $eltext and return a link

Returns a bookmark using Cezpdf 009

Parameters

  • abstractLink &$element: a descendant of abstractlink should be passed, and never text
  • string $eltext: text to display in the link

Info

Method setTemplateDir (line 961)

void setTemplateDir( $dir)

Overrides : Converter::setTemplateDir() sets the template directory based on the $outputformat and $name

Parameters

  • $dir:

Info

Method TranslateTag (line 602)

string TranslateTag( string $name, string $attr, string $cdata, string $unconvertedcdata)

Overrides : Converter::TranslateTag() Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.

Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.

Parameters

  • string $name: tag name
  • string $attr: any attributes Format: array(name => value)
  • string $cdata: the tag contents, if any
  • string $unconvertedcdata: the tag contents, if any, unpost-processed

Info

Method unmangle (line 976)

void unmangle( $notused, $source)

Overrides : Converter::unmangle() Called by parserSourceInlineTag::stringConvert() to allow converters to format the source code the way they'd like.

Parameters

  • $notused:
  • $source:

Info

Method writeExample (line 126)

void writeExample( $title, $path, $source)

Overrides : Converter::writeExample() Write out the formatted source code for an example php file

Parameters

  • $title:
  • $path:
  • $source:

Info

Method writeSource (line 106)

void writeSource( $path, $value)

Overrides : Converter::writeSource() Write out the formatted source code for a php file

Parameters

  • $path:
  • $value:

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class Converter

Converter::$all_packages - All packages encountered in parsing

Converter::$class - set to a classname if currently parsing a class, false if not

Converter::$classes - All class information, organized by path, and by package

Converter::$class_contents - alphabetical index of all methods and vars in a class by package/subpackage

Converter::$class_data - template for the class currently being processed

Converter::$class_elements - alphabetized index of classes by package

Converter::$curfile - full path of the current file being converted

Converter::$curpage - current procedural page being processed

Converter::$define_elements - alphabetized index of defines by package

Converter::$elements - alphabetical index of all elements

Converter::$function_elements - alphabetized index of functions by package

Converter::$global_elements - alphabetized index of global variables by package

Converter::$highlightingSource - Flag used to help converters determine whether to do special source highlighting

Converter::$package - package name currently being converted

Converter::$packagecategories - Packages associated with categories

Converter::$package_elements - alphabetical index of all elements sorted by package, subpackage, page, and class.

Converter::$package_output - set to value of -po commandline

Converter::$package_parents - Hierarchy of packages

Converter::$page - name of current page being converted

Converter::$page_contents - alphabetical index of all elements on a page by package/subpackage

Converter::$page_data - template for the procedural page currently being processed

Converter::$page_elements - alphabetized index of procedural pages by package

Converter::$parseprivate - controls processing of elements marked private with @access private

Converter::$path - path of current page being converted

Converter::$pkg_elements - alphabetical index of all elements, indexed by package/subpackage

Converter::$processSpecialRoots - This converter knows about the new root tree processing

Converter::$quietmode - controls display of progress information while parsing.

Converter::$sort_page_contents_by_type - This determines whether the $page_contents array should be sorted by element type as well as alphabetically by name

Converter::$sourcePaths - A list of files that have had source code generated

Converter::$subpackage - subpackage name currently being converted

Converter::$targetDir - directory that output is sent to. -t command-line sets this.

Converter::$templateDir - Directory that the template is in, relative to phpDocumentor root directory

Converter::$templateName - Name of the template, from last part of -o

Converter::$template_options - Options for each template, parsed from the options.ini file in the template base directory

Converter::$title -

Converter::$todoList - List of all @todo tags and a link to the element with the @todo

Inherited Methods

Inherited Method Summary

Inherited From Class Converter

Converter::Converter() - Initialize Converter data structures

Converter::AttrToString() - Convert the attribute of a Tutorial docbook tag's attribute list

Converter::Bolden() - Used to convert the contents of <b> in a docblock

Converter::Br() - Used to convert <br> in a docblock

Converter::checkState() - Compare parserStringWithInlineTags::Convert() cache state to $state

Converter::cleanup() - Finish up parsing/cleanup directories

Converter::Convert() - Convert all elements to output format

Converter::convertClass() - Default Class Handler

Converter::convertConst() - Converts class constants for template output.

Converter::convertDefine() - Converts defines for template output

Converter::ConvertErrorLog() - Convert the phpDocumentor parsing/conversion error log

Converter::convertFunction() - Converts function for template output

Converter::convertGlobal() - Converts global variables for template output

Converter::convertInclude() - Converts includes for template output

Converter::convertMethod() - Converts method for template output

Converter::convertPage() - Default Page Handler

Converter::ConvertTitle() - Convert the title of a Tutorial docbook tag section

Converter::ConvertTodoList() - Convert the list of all @todo tags

Converter::convertTutorial() - Default Tutorial Handler

Converter::convertVar() - Converts class variables for template output.

Converter::Convert_RIC() - Convert README/INSTALL/CHANGELOG file contents to output format

Converter::copyFile() - Copies a file from the template directory to the target directory

Converter::createParentDir() - Recursively creates all subdirectories that don't exist in the $dir path

Converter::EncloseList() - Used to convert the contents of <ol> or <ul> in a docblock

Converter::EncloseParagraph() - Used to enclose a paragraph in a docblock

Converter::endClass() - Called by walk() while converting, when the last class element has been parsed.

Converter::endPage() - Called by walk() while converting, when the last procedural page element has been parsed.

Converter::exampleProgramExample() - Used to convert the {@example} inline tag in a docblock.

Converter::flushHighlightCache() - Return the close text for the current token

Converter::formatIndex() - Called by walk() while converting.

Converter::formatLeftIndex() - Called by walk() while converting.

Converter::formatPkgIndex() - Called by walk() while converting.

Converter::formatTutorialTOC() - Creates a table of contents for a {@toc} inline tag in a tutorial

Converter::generateChildClassList() - returns a list of child classes

Converter::generateFormattedClassTree() - returns an array containing the class inheritance tree from the root object to the class.

Converter::getClassesOnPage() - gets a list of all classes declared on a procedural page represented by

Converter::getClassLink() - return false or a classLink to $expr

Converter::getConstLink() - return false or a constLink to $expr in $class

Converter::getConverterDir() - Get the absolute path to the converter's base directory

Converter::getCurrentPageLink() -

Converter::getCurrentPageURL() - Return the path to the current

Converter::getDefineLink() - return false or a defineLink to $expr

Converter::getFileSourceName() - Translate the path info into a unique file name for the highlighted source code.

Converter::getFileSourcePath() - Return the fixed path to the source-code file folder.

Converter::getFormattedConflicts() -

Converter::getFormattedDescMethods() - Get a list of methods in child classes that override this method

Converter::getFormattedDescVars() - Get a list of vars in child classes that override this var

Converter::getFormattedImplements() - returns an array containing the class inheritance tree from the root object to the class.

Converter::getFormattedInheritedConsts() - Return template-enabled list of inherited class constants

Converter::getFormattedInheritedMethods() - Return template-enabled list of inherited methods

Converter::getFormattedInheritedVars() - Return template-enabled list of inherited variables

Converter::getFormattedMethodImplements() - Get the method this method(s) implemented from an interface, if any

Converter::getFormattedOverrides() - Get the method this method overrides, if any

Converter::getFunctionLink() - return false or a functionLink to $expr

Converter::getGlobalLink() - return false or a globalLink to $expr

Converter::getGlobalValue() - Parse a global variable's default value for class initialization.

Converter::getHighlightState() -

Converter::getId() - take abstractLink descendant and text $eltext and return a

Converter::getIncludeValue() - Parse an include's file to see if it is a file documented in this project

Converter::getLink() - The meat of the @see tag and inline {@link} tag

Converter::getMethodLink() - return false or a methodLink to $expr in $class

Converter::getPageLink() - return false or a pageLink to $expr

Converter::getSortedClassTreeFromClass() - Return a tree of all classes that extend this class

Converter::getSourceLink() -

Converter::getState() - Return parserStringWithInlineTags::Convert() cache state

Converter::getTutorialId() - Return a converter-specific id to distinguish tutorials and their sections

Converter::getTutorialLink() - The meat of the @tutorial tag and inline {@tutorial} tag

Converter::getTutorialTree() - Get a tree structure representing the hierarchy of tutorials

Converter::getVarLink() - return false or a varLink to $expr in $class

Converter::hasSourceCode() - Determine whether an element's file has generated source code, used for linking to line numbers of source.

Converter::hasTutorial() -

Converter::highlightDocBlockSource() - Used to allow converters to format the source code of DocBlocks the way they'd like.

Converter::highlightSource() - Used to allow converters to format the source code the way they'd like.

Converter::highlightTutorialSource() - Used to allow converters to format the source code of Tutorial XML the way they'd like.

Converter::Italicize() - Used to convert the contents of <i> in a docblock

Converter::Kbdize() - Used to convert the contents of <kbd> in a docblock

Converter::ListItem() - Used to convert the contents of <li> in a docblock

Converter::newSmarty() - Return a Smarty template object to operate with

Converter::Output() - do all necessary output

Converter::postProcess() - This version does nothing

Converter::prepareDocBlock() - convert the element's DocBlock for output

Converter::PreserveWhiteSpace() - Used to convert the contents of <pre> in a docblock

Converter::ProgramExample() - Used to convert the <code> tag in a docblock

Converter::returnLink() - take URL $link and text $text and return a link in the format needed for the Converter

Converter::returnSee() - take abstractLink descendant and text $eltext and return a link

Converter::Sampize() - Used to convert the contents of <samp> in a docblock

Converter::setSourcePaths() - Mark a file as having had source code highlighted

Converter::setTargetDir() - Sets the output directory for generated documentation

Converter::setTemplateBase() - Set the template directory with a different template base directory

Converter::setTemplateDir() - sets the template directory based on the $outputformat and $name

Converter::sortPageContentsByElementType() - sorts $page_contents by element type as well as alphabetically

Converter::sourceLine() - Return a line of highlighted source code with formatted line number

Converter::startHighlight() - Initialize highlight caching

Converter::TranslateEntity() - Used to translate an XML DocBook entity like &rdquo; from a tutorial by reading the options.ini file for the template.

Converter::TranslateTag() - Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.

Converter::TutorialExample() -

Converter::type_adjust() - Called by parserReturnTag::Convert() to allow converters to change type names to desired formatting

Converter::unmangle() - Called by parserSourceInlineTag::stringConvert() to allow converters to format the source code the way they'd like.

Converter::vardump_tree() - Debugging function for dumping $tutorial_tree

Converter::Varize() - Used to convert the contents of <var> in a docblock

Converter::walk() - called by phpDocumentor_IntermediateParser::Convert() to traverse the array of pages and their elements, converting them to the output format

Converter::walk_everything() - walk over elements by package rather than page

Converter::writeExample() - Write out the formatted source code for an example php file

Converter::writeFile() - Writes a file to target dir

Converter::writeSource() - Write out the formatted source code for a php file

Converter::_rmdir() - Completely remove a directory and its contents

Converter::_setHighlightCache() -

Converter::_tutorial_path() - Returns the path to this tutorial as a string


Documentation generated on Mon, 05 Dec 2011 21:29:03 -0600 by phpDocumentor 1.4.4