Docs For Class HTMLframesConverter

HTMLframesConverter (Constructor) [line 137]

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

[ Top ]

checkState [line 2194]

void checkState(
boolean
$state)

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

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

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

Parameters:

boolean $state — value to compare to $local

[ Top ]

Convert [line 828]

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

void convertClass(
parserClass
&$element)

Converts class for template output

Parameters:

parserClass &$element —

[ Top ]

convertDefine [line 1279]

void convertDefine(
parserDefine
&$element)

Converts defines for template output

See: HTMLframesConverter::prepareDocBlock(), HTMLframesConverter::getFormattedConflicts()

Parameters:

parserDefine &$element —

[ Top ]

ConvertErrorLog [line 873]

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

void convertFunction(
parserFunction
&$element)

Converts function for template output

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

Parameters:

parserFunction &$element —

[ Top ]

convertGlobal [line 1297]

void convertGlobal(
parserGlobal
&$element)

Converts global variables for template output

See: HTMLframesConverter::prepareDocBlock(), HTMLframesConverter::getFormattedConflicts()

Parameters:

parserGlobal &$element —

[ Top ]

convertInclude [line 1258]

void convertInclude(
parserInclude
&$element)

Converts include elements for template output

See: HTMLframesConverter::prepareDocBlock()

Parameters:

parserInclude &$element —

[ Top ]

convertMethod [line 1181]

void convertMethod(
parserMethod
&$element)

Converts method for template output

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

Parameters:

parserMethod &$element —

[ Top ]

convertPackagePage [line 1036]

void convertPackagePage(
parserPackagePage
&$element)

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

Parameters:

parserPackagePage &$element —

[ Top ]

convertPage [line 1318]

void convertPage(
parserData
&$element)

converts procedural pages for template output

See: HTMLframesConverter::prepareDocBlock(), HTMLframesConverter::getClassesOnPage()

Parameters:

parserData &$element —

[ Top ]

convertTutorial [line 1063]

void convertTutorial(
parserTutorial
&$element)

Parameters:

parserTutorial &$element —

[ Top ]

convertVar [line 1107]

void convertVar(
parserVar
&$element)

Converts class variables for template output.

See: HTMLframesConverter::prepareDocBlock(), HTMLframesConverter::getFormattedOverrides()

Parameters:

parserVar &$element —

[ Top ]

Convert_RIC [line 810]

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 ]

copyMediaRecursively [line 1844]

void copyMediaRecursively(
mixed
$media, mixed
$targetdir, [mixed
$subdir = ''])

[ Top ]

endClass [line 273]

void endClass(
)

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

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

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

[ Top ]

endPage [line 297]

void endPage(
)

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

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

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

[ Top ]

formatIndex [line 543]

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

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

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

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

[ Top ]

formatTutorialTOC [line 236]

string formatTutorialTOC(
array
$toc)

Use the template tutorial_toc.tpl to generate a table of contents for HTML

Return: table of contents formatted for use in the current output format

Overrides Converter::formatTutorialTOC() (Creates a table of contents for a {@toc} inline tag in a tutorial)

Parameters:

array $toc — format: array(array('tagname' => section, 'link' => returnsee link, 'id' => anchor name, 'title' => from title tag),...)

[ Top ]

generateChildClassList [line 1446]

void generateChildClassList(
parserClass
$class)

returns a list of child classes

Uses: parserClass::getChildClassList()

Parameters:

parserClass $class — class variable

[ Top ]

generateElementIndex [line 1718]

void generateElementIndex(
)

Generate alphabetical index of all elements

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

[ Top ]

generateFormattedClassTree [line 1470]

array generateFormattedClassTree(
parserClass
$class)

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

Parameters:

parserClass $class — class variable

[ Top ]

generateFormattedClassTrees [line 1629]

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

void generatePkgElementIndex(
string
$package)

Generate alphabetical index of all elements by package and subpackage

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

Parameters:

string $package — name of a package

[ Top ]

generatePkgElementIndexes [line 2035]

void generatePkgElementIndexes(
)

See: HTMLframesConverter::generatePkgElementIndex()

[ Top ]

getCData [line 1022]

void getCData(
mixed
$value)

[ Top ]

getClassesOnPage [line 1365]

array getClassesOnPage(
parserData
&$element)

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

Return: links to each classes documentation

Parameters:

parserData &$element —

[ Top ]

getClassLink [line 2075]

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

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 ]

getExampleLink [line 212]

void getExampleLink(
mixed
$path, mixed
$title)

[ Top ]

getFormattedConflicts [line 1390]

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

Return: links to conflicting elements, or empty array
Uses: 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 1410]

array getFormattedDescMethods(
parserMethod
&$element)

Get a list of methods in child classes that override this method

Return: empty array or array('link'=>link to method, 'sdesc'=>short description of the method
Uses: parserMethod::getOverridingMethods()

Parameters:

parserMethod &$element —

[ Top ]

getFormattedInheritedMethods [line 1579]

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: HTMLframesConverter::getClassLink(), parserMethod::getInheritedMethods()

Parameters:

parserMethod $child — class method

[ Top ]

getFormattedInheritedVars [line 1534]

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: HTMLframesConverter::getClassLink(), parserVar::getInheritedVars()

Parameters:

parserVar $child — class method

[ Top ]

getFormattedOverrides [line 1431]

array|false getFormattedOverrides(
parserMethod
&$element)

Get the method this method overrides, if any

Return: array('link'=>link to overridden method, 'sdesc'=>short description
See: parserMethod::getOverrides()

Parameters:

parserMethod &$element —

[ Top ]

getFunctionLink [line 2091]

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

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

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

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

void getPageName(
mixed
&$element)

[ Top ]

getPPageId [line 1017]

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

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

[ Top ]

getRootTree [line 1650]

string getRootTree(
array
$tree, mixed
$package)

return formatted class tree for the Class Trees page

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

Parameters:

array $tree — output from getSortedClassTreeFromClass()

[ Top ]

getSourceLink [line 217]

void getSourceLink(
mixed
$path)

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

[ Top ]

getState [line 2184]

void getState(
)

returns $local

See: Converter::getState()

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

[ Top ]

getTutorialTree [line 464]

void getTutorialTree(
mixed
$tutorial, [mixed
$k = false])

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

[ Top ]

getVarLink [line 2173]

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 ]

highlightSource [line 162]

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 ]

makeLeft [line 324]

void makeLeft(
)

[ Top ]

newSmarty [line 243]

void &newSmarty(
)

[ Top ]

Output [line 2249]

void Output(
)

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

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

[ Top ]

postProcess [line 226]

void postProcess(
mixed
$text)

Uses: parserStringWithInlineTags::Convert()

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

[ Top ]

prepareDocBlock [line 942]

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 ]

ProgramExample [line 1027]

void ProgramExample(
mixed
$text)

Overrides Converter::ProgramExample() (Used to convert the <code> tag in a docblock)

[ Top ]

rcNatCmp [line 2206]

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

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 ]

returnLink [line 319]

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

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

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 ]

setTemplateDir [line 1838]

void setTemplateDir(
mixed
$dir)

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

[ Top ]

unmangle [line 143]

void unmangle(
mixed
$sourcecode)

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

[ Top ]

writeExample [line 200]

void writeExample(
mixed
$title, mixed
$path, mixed
$source)

Overrides Converter::writeExample() (Write out the formatted source code for an example php file)

[ Top ]

writeNewPPage [line 614]

void writeNewPPage(
mixed
$key)

[ Top ]

writeSource [line 184]

void writeSource(
mixed
$path, mixed
$value)

Overrides Converter::writeSource() (Write out the formatted source code for a php file)

[ Top ]

Class: HTMLframesConverter

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 = 'frames'

$outputformat = 'HTML'

$package_pages = array()

$page =

$page_data =

$page_dir =

$path =

$ric_set = array()

$sort_page_contents_by_type = true

$wrote = false

Method Detail

HTMLframesConverter (Constructor) [line 137]

checkState [line 2194]

Parameters:

Convert [line 828]

Parameters:

convertClass [line 1132]

Parameters:

convertDefine [line 1279]

Parameters:

ConvertErrorLog [line 873]

convertFunction [line 1219]

Parameters:

convertGlobal [line 1297]

Parameters:

convertInclude [line 1258]

Parameters:

convertMethod [line 1181]

Parameters:

convertPackagePage [line 1036]

Parameters:

convertPage [line 1318]

Parameters:

convertTutorial [line 1063]

Parameters:

convertVar [line 1107]

Parameters:

Convert_RIC [line 810]

Parameters:

copyMediaRecursively [line 1844]

endClass [line 273]

endPage [line 297]

formatIndex [line 543]

formatLeftIndex [line 645]

formatPkgIndex [line 512]

formatTutorialTOC [line 236]

Parameters:

generateChildClassList [line 1446]

Parameters:

generateElementIndex [line 1718]

generateFormattedClassTree [line 1470]

Parameters:

generateFormattedClassTrees [line 1629]

Parameters:

generatePkgElementIndex [line 1894]

Parameters:

generatePkgElementIndexes [line 2035]

getCData [line 1022]

getClassesOnPage [line 1365]