Class: PDFdefaultConverter

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::Convert(): Convert all elements to output format
Converter::ConvertErrorLog()
Converter::ConvertTitle(): Convert the title of a Tutorial docbook tag section
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::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::getClassLink(): return false or a classLink to $expr
Converter::getConverterDir(): Get the absolute path to the converter's base directory
Converter::getDefineLink(): return false or a defineLink to $expr
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::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::getPPageId(): Used by {@id}
Converter::getSortedClassTreeFromClass(): Return a tree of all classes that extend this class
Converter::getSourceLink()
Converter::getState(): Return parserStringWithInlineTags::Convert() cache state
Converter::getTutorialLink(): The meat of the @tutorial tag and inline { @tutorial} tag
Converter::getTutorialTree()
Converter::getVarLink(): return false or a varLink to $expr in $class
Converter::hasTutorial()
Converter::highlightSource(): Called by parserSourceInlineTag::arrayConvert() to allow converters to format the source code the way they'd like.
Converter::Italicize(): Used to convert the contents of <i> in a docblock
Converter::ListItem(): Used to convert the contents of <li> in a docblock
Converter::Output(): do all necessary output
Converter::postProcess(): This version does nothing
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 in the format needed for the Converter
Converter::setTargetDir(): Sets the output directory for generated documentation
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()
Converter::TranslateTag(): Used to translate an xml DocBook tag from a tutorial by reading the options.ini file for the template.
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::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::writeSourceFunction(): Write out the formatted source code for a function

Class Details

[line 18]
PDF output converter.

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

Version: $Id: PDFdefaultConverter.inc,v 1.28 2003/01/17 19:52:15 CelloG Exp $
Since: 1.1
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>

[ Top ]

Class Variables

$classpackage_pagenums = array()

[line 28]

Type:

mixed

[ Top ]

$curclasspackage = false

[line 34]

Type:

mixed

[ Top ]

$curpagepackage = false

[line 33]

Type:

mixed

[ Top ]

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

[line 26]

Type:	mixed
Overrides:	Array

[ Top ]

$name = 'default'

[line 32]

Var: always default

Type:

string

[ Top ]

$outputformat = 'PDF'

[line 30]

Var: always PDF

Type:	string
Overrides:	Array

[ Top ]

$pagepackage_pagenums = array()

[line 27]

Type:

mixed

[ Top ]

$pdf = false

[line 39]

Type:

Cezpdf

[ Top ]

$ric_set = array()

[line 40]

Type:

mixed

[ Top ]

$smarty_dir =

[line 35]

Type:

mixed

[ Top ]

$sort_absolutely_everything = true

[line 25]

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

See: Converter::$sort_page_contents_by_type

Type:	boolean
Overrides:	Array

[ Top ]

Method Detail

PDFdefaultConverter (Constructor) [line 44]

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

See: Converter::Converter()

[ Top ]

Convert [line 141]

void Convert(
mixed
&$element)

Convert abstract $element for template

calls helper function based on element type

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

Parameters:

mixed &$element — any descendant of parserElement, or parserPage or parserPackagePage

[ Top ]

convertClass [line 341]

void convertClass(
mixed
&$element)

[ Top ]

convertDefine [line 406]

void convertDefine(
mixed
&$element)

[ Top ]

convertDocBlock [line 187]

void convertDocBlock(
mixed
&$element)

[ Top ]

convertFunction [line 381]

void convertFunction(
mixed
&$element)

[ Top ]

convertGlobal [line 281]

void convertGlobal(
mixed
&$element)

[ Top ]

convertInclude [line 371]

void convertInclude(
mixed
&$element)

[ Top ]

convertMethod [line 298]

void convertMethod(
mixed
&$element)

[ Top ]

convertPackagePage [line 467]

void convertPackagePage(
mixed
&$element)

Deprecated: html package pages just don't work with PDF, use phpDocumentor Tutorials

[ Top ]

convertPage [line 422]

void convertPage(
mixed
&$element)

[ Top ]

convertParams [line 263]

void convertParams(
mixed
&$element)

[ Top ]

convertTutorial [line 474]

void convertTutorial(
mixed
&$element)

[ Top ]

convertVar [line 324]

void convertVar(
mixed
&$element)

[ Top ]

Convert_RIC [line 182]

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

Convert README/INSTALL/CHANGELOG file contents to output format

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

Parameters:

README\|INSTALL\|CHANGELOG	`$name`	—
string	`$contents`	—	contents of the file

[ Top ]

generateFormattedClassTrees [line 492]

void generateFormattedClassTrees(
string
$package)

returns a template-enabled array of class trees

See: $roots, PDFdefaultConverter::getRootTree()

Parameters:

string $package — package to generate a class tree for

[ Top ]

getCData [line 459]

void getCData(
mixed
$value)

[ Top ]

getClassLink [line 641]

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

Return: false if not found, or an html a link to the class's documentation
See: Converter::getClassLink()

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)

[ Top ]

getDefineLink [line 671]

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

Return: false if not found, or an html a link to the define's documentation
See: Converter::getDefineLink()

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

[ Top ]

getFunctionLink [line 656]

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

Return: false if not found, or an html a link to the function's documentation
See: Converter::getFunctionLink()

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

[ Top ]

getGlobalLink [line 686]

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

Return: false if not found, or an html a link to the global variable's documentation
See: Converter::getGlobalLink()

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

[ Top ]

getMethodLink [line 717]

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

Return: false if not found, or an html a link to the method's documentation
See: Converter::getMethodLink()

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

[ Top ]

getPageLink [line 701]

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

Return: false if not found, or an html a link to the procedural page's documentation
See: Converter::getPageLink()

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

[ Top ]

getPageName [line 448]

void getPageName(
mixed
&$element)

[ Top ]

getPPageId [line 454]

void getPPageId(
mixed
$package, mixed
$subpackage, mixed
$tutorial, mixed
$id)

Overrides Converter::getPPageId() (Used by {@id})

[ Top ]

getRootTree [line 513]

string getRootTree(
array
$tree, mixed
$package)

return formatted class tree for the Class Trees page

See: Classes::$definitechild, PDFdefaultConverter::generateFormattedClassTrees()

Parameters:

array $tree — output from getSortedClassTreeFromClass()

[ Top ]

getState [line 748]

1 getState(
)

Return: always the same

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

[ Top ]

getVarLink [line 734]

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

Return: false if not found, or an html a link to the var's documentation
See: Converter::getVarLink()

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

[ Top ]

highlightSource [line 760]

string highlightSource(
integer
$token, mixed
$word)

Called by parserSourceInlineTag::arrayConvert() to allow converters to format the source code the way they'd like.

default returns it unchanged

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

Parameters:

integer $token — token value from http://www.php.net/tokenizer

[ Top ]

mystrnatcasecmp [line 628]

void mystrnatcasecmp(
mixed
$a, mixed
$b)

[ Top ]

newSmarty [line 62]

void &newSmarty(
)

[ Top ]

Output [line 580]

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

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

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

[ Top ]

returnLink [line 128]

string returnLink(
string
$link, string
$text)

Return: <c:alink:$link>$text</c:alink>

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`	—

[ Top ]

returnSee [line 80]

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

Returns a bookmark using Cezpdf 009

Overrides Converter::returnSee() (take abstractLink descendant and text $eltext and return a link in the format needed for the Converter)

Parameters:

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

[ Top ]

setTemplateDir [line 741]

void setTemplateDir(
mixed
$dir)

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

[ Top ]

unmangle [line 785]

void unmangle(
mixed
$notused, mixed
$source)

See: Converter::unmangle()

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

[ Top ]