Class: HTMLframesConverter
Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/Converters/HTML/frames/HTMLframesConverter.inc
Converter
|
--HTMLframesConverter
HTML output converter.
Author(s):
Version:
|
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Variables
Method Detail
HTMLframesConverter (Constructor) [line 135]
HTMLframesConverter HTMLframesConverter(
&$allp,
&$packp,
&$classes,
&$procpages,
$po,
$pp,
$qm,
$targetDir,
$templateDir,
$title,
$charset)
|
|
sets $base_dir to $targetDir
Parameters:
convertClass [line 1032]
convertConst [line 1060]
Converts class variables for template output
Overrides Converter::convertConst() (Converts class constants for template output.)
Parameters:
convertDefine [line 1101]
ConvertErrorLog [line 916]
Create errors.html template file output This method takes all parsing errors and warnings and spits them out ordered by file and line number.
Overrides Converter::ConvertErrorLog() (Convert the phpDocumentor parsing/conversion error log)
convertFunction [line 1080]
convertGlobal [line 1110]
Converts global variables for template output
Overrides Converter::convertGlobal() (Converts global variables for template output)
Parameters:
convertInclude [line 1091]
Converts include elements for template output
Overrides Converter::convertInclude() (Converts includes for template output)
Parameters:
convertMethod [line 1070]
convertPackagepage [line 991]
Converts package page and sets its package as used in $package_pages
Parameters:
convertPage [line 1120]
ConvertTodoList [line 881]
convertTutorial [line 1008]
convertVar [line 1050]
Converts class variables for template output
Overrides Converter::convertVar() (Converts class variables for template output.)
Parameters:
Convert_RIC [line 871]
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:
copyMediaRecursively [line 1552]
void copyMediaRecursively(
$media,
$targetdir, [
$subdir = ''])
|
|
Parameters:
endClass [line 336]
Writes out the template file of $class_data and unsets the template to save memory
Overrides Converter::endClass() (Called by walk() while converting, when the last class element has been parsed.)
endPage [line 358]
Writes out the template file of $page_data and unsets the template to save memory
Overrides Converter::endPage() (Called by walk() while converting, when the last procedural page element has been parsed.)
formatIndex [line 628]
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.
Overrides Converter::formatIndex() (Called by walk() while converting.)
formatLeftIndex [line 728]
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
Overrides Converter::formatLeftIndex() (Called by walk() while converting.)
formatPkgIndex [line 599]
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
Overrides Converter::formatPkgIndex() (Called by walk() while converting.)
formatTutorialTOC [line 308]
string formatTutorialTOC(
array
$toc)
|
|
Use the template tutorial_toc.tpl to generate a table of contents for HTML
Overrides Converter::formatTutorialTOC() (Creates a table of contents for a {@toc} inline tag in a tutorial)
Parameters:
generateElementIndex [line 1519]
void generateElementIndex(
)
|
|
Generate alphabetical index of all elements
generateFormattedClassTree [line 1145]
returns an array containing the class inheritance tree from the root object to the class
Overrides Converter::generateFormattedClassTree() (returns an array containing the class inheritance tree from the root object to the class.)
Parameters:
generateFormattedClassTrees [line 1209]
void generateFormattedClassTrees(
string
$package)
|
|
returns a template-enabled array of class trees
Parameters:
generateFormattedInterfaceTrees [line 1263]
void generateFormattedInterfaceTrees(
string
$package)
|
|
returns a template-enabled array of interface inheritance trees
Parameters:
generatePkgElementIndex [line 1617]
void generatePkgElementIndex(
string
$package)
|
|
Generate alphabetical index of all elements by package and subpackage
Parameters:
generatePkgElementIndexes [line 1668]
void generatePkgElementIndexes(
)
|
|
getCData [line 982]
getClassLink [line 1708]
mixed getClassLink(
string
$expr, string
$package, [string
$file = false], [boolean
$text = false], [boolean
$with_a = true])
|
|
Overrides Converter::getClassLink() (return false or a classLink to $expr)
Parameters:
getConstLink [line 1823]
mixed getConstLink(
string
$expr, string
$class, string
$package, [string
$file = false], [boolean
$text = false], boolean
5)
|
|
Overrides Converter::getConstLink() (return false or a constLink to $expr in $class)
Parameters:
getCurrentPageLink [line 286]
getDefineLink [line 1740]
mixed getDefineLink(
string
$expr, string
$package, [string
$file = false], [boolean
$text = false], boolean
4)
|
|
Overrides Converter::getDefineLink() (return false or a defineLink to $expr)
Parameters:
getExampleLink [line 196]
void getExampleLink(
$path,
$title)
|
|
Parameters:
getFunctionLink [line 1724]
mixed getFunctionLink(
string
$expr, string
$package, [string
$file = false], [boolean
$text = false], boolean
4)
|
|
Overrides Converter::getFunctionLink() (return false or a functionLink to $expr)
Parameters:
getGlobalLink [line 1756]
mixed getGlobalLink(
string
$expr, string
$package, [string
$file = false], [boolean
$text = false], boolean
4)
|
|
Overrides Converter::getGlobalLink() (return false or a globalLink to $expr)
Parameters:
getId [line 813]
getIndexInformation [line 1402]
Generate indexing information for given element
Parameters:
getMethodLink [line 1789]
mixed getMethodLink(
string
$expr, string
$class, string
$package, [string
$file = false], [boolean
$text = false], boolean
5)
|
|
Overrides Converter::getMethodLink() (return false or a methodLink to $expr in $class)
Parameters:
getPageLink [line 1772]
mixed getPageLink(
string
$expr, string
$package, [string
$path = false], [boolean
$text = false], boolean
4)
|
|
Overrides Converter::getPageLink() (return false or a pageLink to $expr)
Parameters:
getPageName [line 1131]
void getPageName(
&$element)
|
|
Parameters:
getRootTree [line 1320]
string getRootTree(
array
$tree, string
$package, [
$noparent = false], boolean
$nounknownparent)
|
|
return formatted class tree for the Class Trees page
Parameters:
getSourceAnchor [line 217]
string getSourceAnchor(
string
$sourcefile, string
$anchor, [string
$text = ''], [boolean
$link = false])
|
|
Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.
Parameters:
getSourceLink [line 201]
getTutorialId [line 977]
void getTutorialId(
$package,
$subpackage,
$tutorial,
$id)
|
|
Overrides Converter::getTutorialId() (Return a converter-specific id to distinguish tutorials and their sections)
Parameters:
getTutorialTree [line 550]
void getTutorialTree(
$tutorial, [
$k = false])
|
|
Overrides Converter::getTutorialTree() (Get a tree structure representing the hierarchy of tutorials)
Parameters:
getVarLink [line 1806]
mixed getVarLink(
string
$expr, string
$class, string
$package, [string
$file = false], [boolean
$text = false], boolean
5)
|
|
Overrides Converter::getVarLink() (return false or a varLink to $expr in $class)
Parameters:
makeLeft [line 382]
Output [line 1880]
This function is not used by HTMLdefaultConverter, but is required by Converter
Overrides Converter::Output() (do all necessary output)
postProcess [line 294]
ProgramExample [line 262]
string ProgramExample(
string
$example, [boolean
$tutorial = false], [
$inlinesourceparse = null], [
$class = null], [
$linenum = null], [
$filesourcepath = null])
|
|
Used to convert the <code> tag in a docblock
Overrides Converter::ProgramExample() (Used to convert the <code> tag in a docblock)
Parameters:
rcNatCmp [line 1837]
int rcNatCmp(
mixed
$a, mixed
$b)
|
|
does a nat case sort on the specified second level value of the array
Parameters:
rcNatCmp1 [line 1853]
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:
returnLink [line 377]
string returnLink(
string
$link, string
$text)
|
|
Overrides Converter::returnLink() (take URL $link and text $text and return a link in the format needed for the Converter)
Parameters:
returnSee [line 783]
setTargetDir [line 1597]
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
Overrides Converter::setTargetDir() (Sets the output directory for generated documentation)
Parameters:
SmartyInit [line 315]
void &SmartyInit(
&$templ)
|
|
Parameters:
sourceLine [line 238]
string sourceLine(
integer
$linenumber, string
$line, [false|string
$path = false])
|
|
Return a line of highlighted source code with formatted line number If the $path is a full path, then an anchor to the line number will be added as well
Overrides Converter::sourceLine() (Return a line of highlighted source code with formatted line number)
Parameters:
TutorialExample [line 272]
unmangle [line 144]
writeExample [line 178]
void writeExample(
$title,
$path,
$source)
|
|
Overrides Converter::writeExample() (Write out the formatted source code for an example php file)
Parameters:
writeNewPPage [line 697]
void writeNewPPage(
$key)
|
|
Parameters:
writeSource [line 160]
void writeSource(
string
$path, string
$value)
|
|
Overrides Converter::writeSource() (Write out the formatted source code for a php file)
Parameters:
Documentation generated on Mon, 11 Mar 2019 15:50:24 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|