string $base_dir (line 88)

target directory passed on the command-line.

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

array $current (line 119)

contains all of the template procedural page element loop data needed for the current template

boolean $juststarted = false (line 113)

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

array $package_pages = array() (line 101)

array of converted package page names.

Used to link to the package page in the left index

• var: Format: array(package => 1)

boolean $processSpecialRoots = true (line 60)

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 66)

Smarty Converter 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

Constructor HTMLframesConverter (line 133)

sets $base_dir to $targetDir

• see: Converter::Converter()

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

convertConst (line 1058)

Converts class variables for template output

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

• parserDefine &$element

Converter::convertConst()

Converts class constants for template output.

ConvertErrorLog (line 914)

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 1108)

Converts global variables for template output

• parserGlobal &$element

Converter::convertGlobal()

Converts global variables for template output

convertMethod (line 1068)

Converts class methods for template output

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

• parserDefine &$element

Converter::convertMethod()

Converts method for template output

convertPage (line 1118)

converts procedural pages for template output

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

• parserData &$element

Converter::convertPage()

Default Page Handler

convertTutorial (line 1006)

• parserTutorial &$element

Converter::convertTutorial()

Default Tutorial Handler

Convert_RIC (line 869)

Convert README/INSTALL/CHANGELOG file contents to output format

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

Converter::Convert_RIC()

Convert README/INSTALL/CHANGELOG file contents to output format

endClass (line 334)

Writes out the template file of $class_data and unsets the template to save memory

• see: Converter::endClass()
• see: registerCurrentClass()

Converter::endClass()

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

formatIndex (line 626)

HTMLdefaultConverter uses this function to format template index.html and packages.html

This function generates the package list from $all_packages, eliminating any packages that don't have any entries in their package index (no files at all, due to @ignore or other factors). Then it uses the default package name as the first package index to display. It sets the right pane to be either a blank file with instructions on making package-level docs, or the package-level docs for the default package.

• global: string $phpDocumentor_DefaultPackageName: Used to set the starting package to display

Converter::formatIndex()

Called by walk() while converting.

formatPkgIndex (line 597)

HTMLdefaultConverter chooses to format both package indexes and the complete index here

This function formats output for the elementindex.html and pkgelementindex.html template files. It then writes them to the target directory

• see: HTMLframesConverter::generateElementIndex(), HTMLframesConverter::generatePkgElementIndex()

Converter::formatPkgIndex()

Called by walk() while converting.

generateElementIndex (line 1517)

Generate alphabetical index of all elements

• see: Converter::$elements, Converter::walk()

generateFormattedClassTrees (line 1207)

returns a template-enabled array of class trees

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

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

generatePkgElementIndex (line 1615)

Generate alphabetical index of all elements by package and subpackage

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

• string $package: name of a package

getCData (line 980)

• $value

getConstLink (line 1821)

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

• 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

Converter::getConstLink()

return false or a constLink to $expr in $class

getDefineLink (line 1738)

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

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

Converter::getDefineLink()

return false or a defineLink to $expr

getFunctionLink (line 1722)

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

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

Converter::getFunctionLink()

return false or a functionLink to $expr

getId (line 811)

• $element
• $fullpath

Converter::getId()

take abstractLink descendant and text $eltext and return a

getMethodLink (line 1787)

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

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

Converter::getMethodLink()

return false or a methodLink to $expr in $class

getPageName (line 1129)

• &$element

getSourceAnchor (line 215)

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

• 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

getTutorialId (line 975)

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

Converter::getTutorialId()

Return a converter-specific id to distinguish tutorials and their sections

getVarLink (line 1804)

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

• 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

Converter::getVarLink()

return false or a varLink to $expr in $class

Output (line 1878)

This function is not used by HTMLdefaultConverter, but is required by Converter

Converter::Output()

do all necessary output

ProgramExample (line 260)

Used to convert the <code> tag in a docblock

• string $example
• boolean $tutorial
• $inlinesourceparse
• $class
• $linenum
• $filesourcepath

Converter::ProgramExample()

Used to convert the <code> tag in a docblock

rcNatCmp1 (line 1851)

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

this one puts constructors first

• mixed $a
• mixed $b

returnSee (line 781)

This function takes an abstractLink descendant and returns an html link

• boolean 3: determines whether the returned text is enclosed in an <a> tag
• abstractLink &$element: a descendant of abstractlink should be passed, and never text
• string $eltext: text to display in the link
• boolean $with_a: this parameter is not used, and is deprecated

Converter::returnSee()

take abstractLink descendant and text $eltext and return a link

SmartyInit (line 313)

• &$templ

TutorialExample (line 270)

• string $example

Converter::TutorialExample()

writeExample (line 176)

• $title
• $path
• $source

Converter::writeExample()

Write out the formatted source code for an example php file

writeSource (line 158)

• string $path: full path to the source file
• string $value: fully highlighted source code

Converter::writeSource()

Write out the formatted source code for a php file