Docs For Class HTMLdefaultConverter

HTMLdefaultConverter (Constructor) [line 121]

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

sets $base_dir to $targetDir

See: Converter::Converter()

[ Top ]

checkState [line 2127]

void checkState(
boolean
$state)

checks $state to see if it is the same as $local

See: Converter::getState(), HTMLdefaultConverter::$local

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

Parameters:

boolean $state — value to compare to $local

[ Top ]

Convert [line 679]

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 898]

void convertClass(
parserClass
&$element)

Converts class for template output

Parameters:

parserClass &$element —

[ Top ]

convertDefine [line 1072]

void convertDefine(
parserDefine
&$element)

Converts defines for template output

See: HTMLdefaultConverter::prepareDocBlock(), HTMLdefaultConverter::getFormattedConflicts()

Parameters:

parserDefine &$element —

[ Top ]

ConvertErrorLog [line 721]

void ConvertErrorLog(
)

Create errors.html template file output

This method takes all parsing errors and warnings and spits them out ordered by file and line number. It does not display any phpDocumentor internal errors, that is handled by exceptions, which always terminate execution.

Global: ErrorTracker $phpDocumentor_errors: We'll be using it's output facility
See: PHPDOCUMENTOR_EXCEPTIONS

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

[ Top ]

convertFunction [line 996]

void convertFunction(
parserFunction
&$element)

Converts function for template output

See: HTMLdefaultConverter::prepareDocBlock(), parserFunction::getFunctionCall(), HTMLdefaultConverter::getFormattedConflicts()

Parameters:

parserFunction &$element —

[ Top ]

convertGlobal [line 1099]

void convertGlobal(
parserGlobal
&$element)

Converts global variables for template output

See: HTMLdefaultConverter::prepareDocBlock(), HTMLdefaultConverter::getFormattedConflicts()

Parameters:

parserGlobal &$element —

[ Top ]

convertInclude [line 1043]

void convertInclude(
parserInclude
&$element)

Converts include elements for template output

See: HTMLdefaultConverter::prepareDocBlock()

Parameters:

parserInclude &$element —

[ Top ]

convertMethod [line 945]

void convertMethod(
parserMethod
&$element)

Converts method for template output

See: HTMLdefaultConverter::prepareDocBlock(), parserMethod::getFunctionCall(), HTMLdefaultConverter::getFormattedDescMethods(), HTMLdefaultConverter::getFormattedOverrides()

Parameters:

parserMethod &$element —

[ Top ]

convertPackagePage [line 852]

void convertPackagePage(
parserPackagePage
&$element)

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

Parameters:

parserPackagePage &$element —

[ Top ]

convertPage [line 1127]

void convertPage(
parserData
&$element)

converts procedural pages for template output

See: HTMLdefaultConverter::prepareDocBlock(), HTMLdefaultConverter::getClassesOnPage()

Parameters:

parserData &$element —

[ Top ]

convertVar [line 866]

void convertVar(
parserVar
&$element)

Converts class variables for template output.

See: HTMLdefaultConverter::prepareDocBlock(), HTMLdefaultConverter::getFormattedOverrides()

Parameters:

parserVar &$element —

[ Top ]

endClass [line 132]

void endClass(
)

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

See: Converter::endClass()
See: HTMLdefaultConverter::registerCurrentClass()

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

[ Top ]

endPage [line 151]

void endPage(
)

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

See: Converter::endPage()
See: HTMLdefaultConverter::registerCurrent()

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

[ Top ]

formatIndex [line 245]

void formatIndex(
)

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

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

[ Top ]

formatLeftIndex [line 314]

void formatLeftIndex(
)

Generate indexes for li_package.html and classtree output files

This function generates the li_package.html files from the template file left.html. It does this by iterating through each of the $page_elements, $class_elements and $function_elements arrays to retrieve the pre-sorted abstractLink descendants needed for index generation. Conversion of these links to text is done by returnSee(). The $local parameter is set to false to ensure that paths are correct.

Then it uses generateFormattedClassTrees() to create class trees from the template file classtrees.html. Output filename is classtrees_packagename.html. This function also unsets $elements and $pkg_elements to free up the considerable memory these two class vars use

See: Converter::$page_elements, Converter::$class_elements, Converter::$function_elements

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

[ Top ]

formatPkgIndex [line 176]

void formatPkgIndex(
)

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

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

[ Top ]

formatUsesList [line 416]

void formatUsesList(
mixed
&$pages)

[ Top ]

generateChildClassList [line 1369]

void generateChildClassList(
parserClass
$class)

returns a string containing a comma-delimited list of child classes

See: parserClass::getChildClassList()

Parameters:

parserClass $class — class variable

[ Top ]

generateElementIndex [line 1659]

void generateElementIndex(
)

Generate alphabetical index of all elements

See: Converter::$elements, Converter::walk()

[ Top ]

generateFormattedClassTree [line 1391]

void generateFormattedClassTree(
parserClass
$class)

returns a string containing the class inheritance tree from the root object to the class

See: parserClass::getParentClassTree()

Parameters:

parserClass $class — class variable

[ Top ]

generateFormattedClassTrees [line 1570]

void generateFormattedClassTrees(
string
$package)

returns a template-enabled array of class trees

See: $roots, HTMLConverter::getRootTree()

Parameters:

string $package — package to generate a class tree for

[ Top ]

generatePkgElementIndex [line 1827]

void generatePkgElementIndex(
string
$package)

Generate alphabetical index of all elements by package and subpackage

See: Converter::$pkg_elements, Converter::walk(), HTMLdefaultConverter::generatePkgElementIndexes()

Parameters:

string $package — name of a package

[ Top ]

generatePkgElementIndexes [line 1968]

void generatePkgElementIndexes(
)

See: HTMLdefaultConverter::generatePkgElementIndex()

[ Top ]

getCData [line 843]

void getCData(
mixed
$value)

[ Top ]

getClassesOnPage [line 1266]

string getClassesOnPage(
parserData
&$element)

gets a list of all classes declared on a procedural page represented by $element, a parserData class

Return: comma-delimited list of links to each classes documentation

Parameters:

parserData &$element —

[ Top ]

getClassLink [line 2008]

mixed getClassLink(
string
$expr, string
$package, [string
$file = false], [boolean
$text = false], [boolean
$local = true], [mixed
$with_a = true])

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)
boolean	`$text`	—	deprecated
boolean	`$local`	—	return just the URL, or enclose it in an html a tag

[ Top ]

getDefineLink [line 2040]

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

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

[ Top ]

getFormattedConflicts [line 1306]

string getFormattedConflicts(
mixed
&$element, string
$type)

Return: full div of comma-separated links to conflicting elements, or empty string
See: parserClass::getConflicts(), parserFunction::getConflicts(), parserDefine::getConflicts(), parserGlobal::getConflicts()

Parameters:

mixed	`&$element`	—	parserClass, parserFunction, parserDefine or parserGlobal
string	`$type`	—	type to display. either 'class','function','define' or 'global variable'

[ Top ]

getFormattedDescMethods [line 1335]

string getFormattedDescMethods(
parserMethod
&$element)

Return: empty string or 'Overridden in child class(es) as: link to class1, link to class2...'
See: parserMethod::getOverridingMethods()

Parameters:

parserMethod &$element —

[ Top ]

getFormattedInheritedMethods [line 1503]

array getFormattedInheritedMethods(
parserMethod
$child)

Return template-enabled list of inherited methods

uses parserMethod helper function getInheritedMethods and generates a template-enabled list using getClassLink()

Return: Template-ready array
See: HTMLdefaultConverter::getClassLink(), parserMethod::getInheritedMethods()

Parameters:

parserMethod $child — class method

[ Top ]

getFormattedInheritedVars [line 1453]

array getFormattedInheritedVars(
parserVar
$child)

Return template-enabled list of inherited variables

uses parserVar helper function getInheritedVars and generates a template-enabled list using getClassLink()

Return: Template-ready array
See: HTMLdefaultConverter::getClassLink(), parserVar::getInheritedVars()

Parameters:

parserVar $child — class method

[ Top ]

getFormattedOverrides [line 1353]

string getFormattedOverrides(
parserMethod
&$element)

Return: empty string or 'Overrides {link to overridden method}'
See: parserMethod::getOverrides()

Parameters:

parserMethod &$element —

[ Top ]

getFunctionLink [line 2024]

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

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

[ Top ]

getGlobalLink [line 2056]

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

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

[ Top ]

getMethodLink [line 2089]

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

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

[ Top ]

getPageLink [line 2072]

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

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

[ Top ]

getPageName [line 1161]

void getPageName(
mixed
&$element)

[ Top ]

getRootTree [line 1591]

string getRootTree(
array
$tree, mixed
$package)

return formatted class tree for the Class Trees page

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

Parameters:

array $tree — output from getSortedClassTreeFromClass()

[ Top ]

getState [line 2117]

void getState(
)

returns $local

See: Converter::getState()

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

[ Top ]

getVarLink [line 2106]

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

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:

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

[ Top ]

Output [line 2182]

void Output(
)

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

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

[ Top ]

postProcess [line 230]

void postProcess(
mixed
$text)

Uses: parserStringWithInlineTags::Convert()

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

[ Top ]

prepareDocBlock [line 791]

array prepareDocBlock(
mixed
&$element, [boolean
$nopackage = true])

convert the element's DocBlock for output

This function converts all tags and descriptions for output

Return: Format: array(short description, long description, array(array('keyword' => tagname,'data' => converted tag),...))

Parameters:

mixed	`&$element`	—	any descendant of parserElement, or parserData
boolean	`$nopackage`	—	set to false for pages and classes, the only elements allowed to specify @package

[ Top ]

rcNatCmp [line 2139]

int rcNatCmp(
mixed
$a, mixed
$b)

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

Parameters:

mixed	`$a`	—
mixed	`$b`	—

[ Top ]

rcNatCmp1 [line 2155]

int rcNatCmp1(
mixed
$a, mixed
$b)

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

this one puts constructors first

Parameters:

mixed	`$a`	—
mixed	`$b`	—

[ Top ]

registerCurrent [line 1175]

void registerCurrent(
)

Registers all of the procedural page elements on a page for variable substitution and output

registers loops: constant, constant_detail, global, global_detail, function, include, include_detail, function_detail

See: Template::register(), HTMLdefaultConverter::$current, HTMLdefaultConverter::endPage()

[ Top ]

registerCurrentClass [line 1231]

void registerCurrentClass(
)

Registers all of the class elements in a class for variable substitution and output

registers loops: function, function_detail, var, var_detail

See: Template::register(), HTMLdefaultConverter::$currentclass, HTMLdefaultConverter::endClass()

[ Top ]

returnLink [line 164]

string returnLink(
string
$link, string
$text)

Return: <a href="'.$link.'">'.$text.'</a>

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 582]

void returnSee(
abstractLink
&$element, [string
$eltext = false], [boolean
$local = true], [boolean
$with_a = true])

This function takes an abstractLink descendant and returns an html link

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
boolean	`$local`	—	this parameter is not used, and it set to $this->local. See $local
boolean	`$with_a`	—	determines whether the returned text is enclosed in an <a> tag

[ Top ]

setTargetDir [line 1783]

void setTargetDir(
mixed
$dir)

calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied

See: Converter::setTargetDir()

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

[ Top ]

unmangle [line 215]

void unmangle(
mixed
$sourcecode)

See: Converter::unmangle()

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

[ Top ]

Class: HTMLdefaultConverter

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Class: Converter

Inherited Methods

Class: Converter

Class Details

Class Variables

$base_dir =

$class =

$class_data =

$class_dir =

$current =

$currentclass =

$juststarted = false

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

$local = true

$name = 'default'

$outputformat = 'HTML'

$package_pages = array()

$page =

$page_data =

$page_dir =

Method Detail

HTMLdefaultConverter (Constructor) [line 121]

checkState [line 2127]

Parameters:

Convert [line 679]

Parameters:

convertClass [line 898]

Parameters:

convertDefine [line 1072]

Parameters:

ConvertErrorLog [line 721]

convertFunction [line 996]

Parameters:

convertGlobal [line 1099]

Parameters:

convertInclude [line 1043]

Parameters:

convertMethod [line 945]

Parameters:

convertPackagePage [line 852]

Parameters:

convertPage [line 1127]

Parameters:

convertVar [line 866]

Parameters:

endClass [line 132]

endPage [line 151]

formatIndex [line 245]

formatLeftIndex [line 314]

formatPkgIndex [line 176]

formatUsesList [line 416]

generateChildClassList [line 1369]

Parameters:

generateElementIndex [line 1659]

generateFormattedClassTree [line 1391]

Parameters:

generateFormattedClassTrees [line 1570]

Parameters:

generatePkgElementIndex [line 1827]

Parameters:

generatePkgElementIndexes [line 1968]

getCData [line 843]

getClassesOnPage [line 1266]

Parameters:

getClassLink [line 2008]

Parameters:

getDefineLink [line 2040]

Parameters:

getFormattedConflicts [line 1306]

Parameters:

getFormattedDescMethods [line 1335]

Parameters:

getFormattedInheritedMethods [line 1503]