string $base_dir (line 134)

target directory passed on the command-line.

$targetDir is malleable, always adding package/ and package/subpackage/ subdirectories onto it.

string $class (line 103)

name of current class being converted

Converter::$class

set to a classname if currently parsing a class, false if not

string $class_dir (line 140)

output directory for the current class being processed

array $currentclass (line 182)

contains all of the template class element loop data needed for the current template

boolean $juststarted = false (line 170)

controls formatting of parser informative output

Converter prints: "Converting /path/to/file.php... Procedural Page Elements... Classes..." Since HTMLdefaultConverter outputs files while converting, it needs to send a \n to start a new line. However, if there is more than one class, output is messy, with multiple \n's just between class file output. This variable prevents that and is purely cosmetic

boolean $local = true (line 85)

whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir

Smarty $packagexml (line 159)

Contents of the packagename.xml file are stored in this template variable

string $page (line 91)

name of current page being converted

Converter::$page

name of current page being converted

string $page_dir (line 115)

output directory for the current procedural page being processed

boolean $processSpecialRoots = true (line 65)

This converter knows about the new root tree processing

In order to fix PEAR Bug #6389

Converter::$processSpecialRoots

This converter knows about the new root tree processing

boolean $sort_page_contents_by_type = true (line 71)

XMLDocBookConverter wants elements sorted by type as well as alphabetically

• see: Converter::$sort_page_contents_by_type

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

array $template_options = array('usepear' => false) (line 196)

template options. Currently only 1 recognized option usepear

usepear tells the getLink() function to return a package link to PEAR and PEAR_ERROR if possible, and to link directly to the fully-delimited link package#class.method or package#file.method in PEAR style, if possible, even if the package is not parsed. This will allow parsing of separate PEAR packages without parsing the entire thing at once!

Converter::$template_options

Options for each template, parsed from the options.ini file in the template base directory

array $_peardoc2_globals = false (line 127)

Global Variables, used for globals.tpl

addSummaryToPackageXml (line 345)

• $template_output

convertClass (line 793)

Converts class for template output

• uses: XMLDocBookpeardoc2Converter::flushPackageXml() - creates packagename.xml file when all classes in a package have been converted

• parserClass &$element

Converter::convertClass()

Default Class Handler

ConvertErrorLog (line 565)

Create errors.html template file output

This method takes all parsing errors and warnings and spits them out ordered by file and line number.

• global: ErrorTracker $phpDocumentor_errors: We'll be using it's output facility

Converter::ConvertErrorLog()

Convert the phpDocumentor parsing/conversion error log

convertGlobal (line 1049)

Converts global variables for template output

• see: XMLDocBookpeardoc2Converter::prepareDocBlock(), Converter::getFormattedConflicts()

• parserGlobal &$element

Converter::convertGlobal()

Converts global variables for template output

convertMethod (line 861)

Converts method for template output

• see: XMLDocBookpeardoc2Converter::prepareDocBlock(), parserMethod::getFunctionCall(), Converter::getFormattedDescMethods(), Converter::getFormattedOverrides()

• parserMethod &$element

Converter::convertMethod()

Converts method for template output

convertPage (line 1099)

converts procedural pages for template output

• see: XMLDocBookpeardoc2Converter::prepareDocBlock(), Converter::getClassesOnPage()

• parserData &$element

Converter::convertPage()

Default Page Handler

convertVar (line 755)

Does nothing in this converter

• parserVar &$element

Converter::convertVar()

Converts class variables for template output.

exampleProgramExample (line 276)

Used to convert the {@example} inline tag in a docblock.

By default, this just wraps ProgramExample

• see: XMLDocBookpeardoc2Converter::exampleProgramExample

• string $example
• boolean $tutorial: true if this is to highlight a tutorial <programlisting>
• $inlinesourceparse
• $class
• $linenum
• $filesourcepath

Converter::exampleProgramExample()

Used to convert the {@example} inline tag in a docblock.

formatIndex (line 419)

Does nothing

Converter::formatIndex()

Called by walk() while converting.

formatPkgIndex (line 412)

Does nothing

Converter::formatPkgIndex()

Called by walk() while converting.

generateElementIndex (line 1378)

does nothing

generateFormattedClassTrees (line 1201)

returns a template-enabled array of class trees

• see: $roots, HTMLConverter::getRootTree()

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

generatePkgElementIndex (line 1394)

Generate alphabetical index of all elements by package and subpackage

• see: Converter::$pkg_elements, Converter::walk(), XMLDocBookpeardoc2Converter::generatePkgElementIndexes()

• string $package: name of a package

getCData (line 686)

• $value

getDefineLink (line 1447)

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

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

Converter::getDefineLink()

return false or a defineLink to $expr

getFunctionLink (line 1431)

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

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

Converter::getFunctionLink()

return false or a functionLink to $expr

getId (line 513)

Get the id value needed to allow linking

• return: the id value for this element type
• see: parserElement, parserData, parserPage

• mixed &$el: descendant of parserElement or parserData/parserPage
• boolean $returnpackage: true to return the id for the package page

Converter::getId()

take abstractLink descendant and text $eltext and return a

getMethodLink (line 1496)

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

• 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
• boolean $local: return just the URL, or enclose it in an html a tag

Converter::getMethodLink()

return false or a methodLink to $expr in $class

getPageName (line 1111)

• &$element

getSourceAnchor (line 676)

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

NOTE: unused

• return: link to an anchor, or the anchor

• 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

getVarLink (line 1513)

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

• 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
• boolean $local: return just the URL, or enclose it in an html a tag

Converter::getVarLink()

return false or a varLink to $expr in $class

Output (line 1575)

Generate the constants.xml, packagename.xml, and globals.xml files

Converter::Output()

do all necessary output

prepareDocBlock (line 631)

• &$element
• $nopackage

Converter::prepareDocBlock()

convert the element's DocBlock for output

rcNatCmp (line 1527)

does a nat case sort on the specified second level value of the array

• mixed $a
• mixed $b

returnLink (line 400)

• return: <ulink url="'.$link.'">'.$text.'</ulink>

• string $link
• string $text

Converter::returnLink()

take URL $link and text $text and return a link in the format needed for the Converter

setTemplateDir (line 1382)

• $dir

Converter::setTemplateDir()

sets the template directory based on the $outputformat and $name

unmangle (line 242)

• $s
• $sourcecode

Converter::unmangle()

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

writeExample (line 285)

• $title
• $path
• $source

Converter::writeExample()

Write out the formatted source code for an example php file

writeNewPPage (line 426)

Does nothing

• $key