Class: HTMLSmartyConverter
Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/Converters/HTML/Smarty/HTMLSmartyConverter.inc
Converter
|
--HTMLSmartyConverter
HTML output converter.
Author(s):
Version:
|
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Variables
Method Detail
HTMLSmartyConverter (Constructor) [line 148]
HTMLSmartyConverter HTMLSmartyConverter(
&$allp,
&$packp,
&$classes,
&$procpages,
$po,
$pp,
$qm,
$targetDir,
$templateDir,
$title,
$charset)
|
|
Parameters:
convertClass [line 1078]
convertConst [line 1106]
Converts class variables for template output
Overrides Converter::convertConst() (Converts class constants for template output.)
Parameters:
convertDefine [line 1147]
ConvertErrorLog [line 928]
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 1126]
convertGlobal [line 1157]
Converts global variables for template output
Overrides Converter::convertGlobal() (Converts global variables for template output)
Parameters:
convertInclude [line 1137]
Converts include elements for template output
Overrides Converter::convertInclude() (Converts includes for template output)
Parameters:
convertMethod [line 1116]
convertPackagepage [line 1004]
Converts package page and sets its package as used in $package_pages
Parameters:
convertPage [line 1167]
ConvertTodoList [line 893]
convertTutorial [line 1034]
convertVar [line 1096]
Converts class variables for template output
Overrides Converter::convertVar() (Converts class variables for template output.)
Parameters:
Convert_RIC [line 872]
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 1604]
void copyMediaRecursively(
$media,
$targetdir, [
$subdir = ''])
|
|
Parameters:
endClass [line 344]
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 523]
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 642]
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 740]
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(). 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 606]
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 321]
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 1571]
void generateElementIndex(
)
|
|
Generate alphabetical index of all elements
generateFormattedClassTree [line 1195]
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 1259]
void generateFormattedClassTrees(
string
$package)
|
|
returns a template-enabled array of class trees
Parameters:
generateFormattedInterfaceTrees [line 1313]
void generateFormattedInterfaceTrees(
string
$package)
|
|
returns a template-enabled array of interface inheritance trees
Parameters:
generatePkgElementIndex [line 1669]
void generatePkgElementIndex(
string
$package)
|
|
Generate alphabetical index of all elements by package and subpackage
Parameters:
generatePkgElementIndexes [line 1719]
void generatePkgElementIndexes(
)
|
|
getCData [line 990]
getClassContents [line 466]
getClassLeft [line 436]
getClassLink [line 1759]
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 1874]
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 287]
getDefineLink [line 1791]
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 190]
void getExampleLink(
$path,
$title)
|
|
Parameters:
getFunctionLink [line 1775]
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 1807]
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 814]
getIndexInformation [line 1453]
Generate indexing information for given element
Parameters:
getMethodLink [line 1840]
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:
getPageContents [line 482]
getPageLeft [line 499]
getPageLink [line 1823]
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 1181]
void getPageName(
&$element)
|
|
Parameters:
getRootTree [line 1370]
string getRootTree(
array
$tree, string
$package, [
$noparent = false], boolean
$nounknownparent)
|
|
return formatted class tree for the Class Trees page
Parameters:
getSourceAnchor [line 211]
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 195]
getTutorialId [line 995]
void getTutorialId(
$package,
$subpackage,
$tutorial,
$id)
|
|
Overrides Converter::getTutorialId() (Return a converter-specific id to distinguish tutorials and their sections)
Parameters:
getTutorialList [line 369]
getTutorialTree [line 396]
void getTutorialTree(
$tutorial, [
$k = false])
|
|
Overrides Converter::getTutorialTree() (Get a tree structure representing the hierarchy of tutorials)
Parameters:
getVarLink [line 1857]
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 554]
Output [line 1931]
This function is not used by HTMLdefaultConverter, but is required by Converter
Overrides Converter::Output() (do all necessary output)
postProcess [line 307]
ProgramExample [line 255]
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 1888]
int rcNatCmp(
mixed
$a, mixed
$b)
|
|
does a nat case sort on the specified second level value of the array
Parameters:
rcNatCmp1 [line 1904]
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 549]
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 784]
setTargetDir [line 1649]
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 328]
void &SmartyInit(
&$templ)
|
|
Parameters:
sourceLine [line 232]
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 273]
unmangle [line 292]
writeExample [line 172]
void writeExample(
$title,
$path,
$source)
|
|
Overrides Converter::writeExample() (Write out the formatted source code for an example php file)
Parameters:
writeNewPPage [line 706]
void writeNewPPage(
$key)
|
|
Parameters:
writeRIC [line 878]
writeSource [line 154]
void writeSource(
$path,
$value)
|
|
Overrides Converter::writeSource() (Write out the formatted source code for a php file)
Parameters:
Documentation generated on Mon, 11 Mar 2019 15:50:27 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|