string $base_dir (line 101)

target directory passed on the command-line.

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

string $class (line 82)

name of current class being converted

Converter::$class

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

string $class_dir (line 107)

output directory for the current class being processed

array $currentclass (line 144)

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

boolean $juststarted = false (line 132)

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

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

array $package_pages = array() (line 120)

array of converted package page names.

Used to link to the package page in the left index

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

Template $page_data (line 88)

template for the procedural page currently being processed

Converter::$page_data

template for the procedural page currently being processed

string $path (line 76)

path of current page being converted

Converter::$path

path of current page being converted

Constructor XMLDocBookConverter (line 167)

sets $base_dir to $targetDir

• see: Converter::Converter()

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

convertDefine (line 1021)

Converts defines for template output

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

• parserDefine &$element

Converter::convertDefine()

Converts defines for template output

convertFunction (line 952)

Converts function for template output

• see: XMLDocBookConverter::prepareDocBlock(), parserFunction::getFunctionCall(), Converter::getFormattedConflicts()

• parserFunction &$element

Converter::convertFunction()

Converts function for template output

convertInclude (line 1003)

Converts include elements for template output

• see: XMLDocBookConverter::prepareDocBlock()

• parserInclude &$element

Converter::convertInclude()

Converts includes for template output

convertPackagePage (line 712)

Converts package page and sets its package as used in $package_pages

• parserPackagePage &$element

convertTutorial (line 736)

• &$element

Converter::convertTutorial()

Default Tutorial Handler

endClass (line 217)

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

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

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: XMLDocBookConverter::generateElementIndex(), XMLDocBookConverter::generatePkgElementIndex()

Converter::formatPkgIndex()

Called by walk() while converting.

generateFormattedClassTree (line 1122)

returns an array containing the class inheritance tree from the root object to the class

• return: Format: array(root,child,child,child,...,$class)
• uses: parserClass::getParentClassTree()

• parserClass $class: class variable

Converter::generateFormattedClassTree()

returns an array containing the class inheritance tree from the root object to the class.

generatePkgElementIndex (line 1448)

Generate alphabetical index of all elements by package and subpackage

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

• string $package: name of a package

getCData (line 703)

• $value

getDefineLink (line 1660)

• 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

getGlobalLink (line 1676)

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

• string $expr: name of global variable
• 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::getGlobalLink()

return false or a globalLink to $expr

getLink (line 175)

do that stuff in $template_options

• $expr
• $package
• $packages

Converter::getLink()

The meat of the @see tag and inline {@link} tag

getPageLink (line 1692)

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

• string $expr: name of procedural page
• string $package: package name
• string $path: 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::getPageLink()

return false or a pageLink to $expr

getRootTree (line 1191)

return formatted class tree for the Class Trees page

• see: Classes::$definitechild, XMLDocBookConverter::generateFormattedClassTrees()

• array $tree: output from getSortedClassTreeFromClass()
• $package

getVarLink (line 1726)

• 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 1783)

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

Converter::Output()

do all necessary output

prepareDocBlock (line 691)

• &$element
• $nopackage

Converter::prepareDocBlock()

convert the element's DocBlock for output

rcNatCmp1 (line 1756)

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

This function takes an abstractLink descendant and returns an html link

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

Converter::returnSee()

take abstractLink descendant and text $eltext and return a link

setTemplateDir (line 1378)

• $dir

Converter::setTemplateDir()

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

type_adjust (line 186)

• $typename

Converter::type_adjust()

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

writeNewPPage (line 406)

• $key