Class: CHMdefaultConverter
Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/Converters/CHM/default/CHMdefaultConverter.inc
Converter
|
--CHMdefaultConverter
Generates files that MS HTML Help Worshop can use to create a MS Windows compiled help file (CHM)
Author(s):
Version:
|
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Variables
Method Detail
CHMdefaultConverter (Constructor) [line 140]
CHMdefaultConverter CHMdefaultConverter(
&$allp,
&$packp,
&$classes,
&$procpages,
$po,
$pp,
$qm,
$targetDir,
$templateDir,
$title,
$charset)
|
|
sets $base_dir to $targetDir
Parameters:
addHHP [line 1710]
addKLink [line 1804]
void addKLink(
string
$name, string
$file, [string
$bookmark = ''], [string
$group = ''])
|
|
Add an item to the index.hhk file
Parameters:
addSourceTOC [line 1771]
void addSourceTOC(
$name,
$file,
$package,
$subpackage, [
$source = false])
|
|
Parameters:
addTOC [line 1782]
void addTOC(
$name,
$file,
$package,
$subpackage, [
$class = false], [
$tutorial = false])
|
|
Parameters:
convertClass [line 837]
convertConst [line 869]
Converts class constants for template output
Overrides Converter::convertConst() (Converts class constants for template output.)
Parameters:
convertDefine [line 918]
ConvertErrorLog [line 707]
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 893]
convertGlobal [line 929]
Converts global variables for template output
Overrides Converter::convertGlobal() (Converts global variables for template output)
Parameters:
convertInclude [line 906]
Converts include elements for template output
Overrides Converter::convertInclude() (Converts includes for template output)
Parameters:
convertMethod [line 881]
convertPackagepage [line 782]
Converts package page and sets its package as used in $package_pages
Parameters:
convertPage [line 941]
ConvertTodoList [line 653]
convertTutorial [line 803]
convertVar [line 857]
Converts class variables for template output
Overrides Converter::convertVar() (Converts class variables for template output.)
Parameters:
Convert_RIC [line 689]
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 1370]
void copyMediaRecursively(
$media,
$targetdir, [
$subdir = ''])
|
|
Parameters:
endClass [line 349]
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 372]
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 436]
CHMdefaultConverter 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 532]
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 404]
CHMdefaultConverter 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 320]
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 1331]
void generateElementIndex(
)
|
|
Generate alphabetical index of all elements
generateFormattedClassTree [line 968]
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 1032]
void generateFormattedClassTrees(
string
$package)
|
|
returns a template-enabled array of class trees
Parameters:
generateFormattedInterfaceTrees [line 1086]
void generateFormattedInterfaceTrees(
string
$package)
|
|
returns a template-enabled array of interface inheritance trees
Parameters:
generateKLinks [line 1825]
Get the table of contents for index.hhk
generatePkgElementIndex [line 1435]
void generatePkgElementIndex(
string
$package)
|
|
Generate alphabetical index of all elements by package and subpackage
Parameters:
generatePkgElementIndexes [line 1486]
void generatePkgElementIndexes(
)
|
|
generateTOC [line 1719]
getCData [line 768]
getClassLink [line 1526]
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 1641]
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 298]
getDefineLink [line 1558]
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 208]
void getExampleLink(
$path,
$title)
|
|
Parameters:
getFunctionLink [line 1542]
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 1574]
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 600]
getIndexInformation [line 1214]
Generate indexing information for given element
Parameters:
getMethodLink [line 1607]
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 1590]
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 954]
void getPageName(
&$element)
|
|
Parameters:
getRootTree [line 1143]
string getRootTree(
array
$tree, string
$package, [
$noparent = false], boolean
$nounknownparent)
|
|
return formatted class tree for the Class Trees page
Parameters:
getSourceAnchor [line 229]
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 213]
getTutorialId [line 773]
void getTutorialId(
$package,
$subpackage,
$tutorial,
$id)
|
|
Overrides Converter::getTutorialId() (Return a converter-specific id to distinguish tutorials and their sections)
Parameters:
getVarLink [line 1624]
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:
Output [line 1869]
Create the phpdoc.hhp, contents.hhc files needed by MS HTML Help Compiler to create a CHM file The output function generates the table of contents (contents.hhc) and file list (phpdoc.hhp) files used to create a .CHM by the free MS HTML Help compiler. {@, a list of all separate .html files is created in CHM format, and written to phpdoc.hhp. This list was generated by writefile. Next, a call to the table of contents: phpDocumentor_out("NOTE: to create the documentation.chm file, you must now run Microsoft Help Workshop on phpdoc.hhp\n");
phpDocumentor_out("To get the free Microsoft Help Workshop, browse to: http://go.microsoft.com/fwlink/?LinkId=14188\n");
finishes things off}}
Overrides Converter::Output() (do all necessary output)
postProcess [line 306]
ProgramExample [line 275]
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 1655]
int rcNatCmp(
mixed
$a, mixed
$b)
|
|
does a nat case sort on the specified second level value of the array
Parameters:
rcNatCmp1 [line 1671]
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 392]
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 570]
setTargetDir [line 1415]
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:
setTemplateDir [line 1364]
void setTemplateDir(
$dir)
|
|
Overrides Converter::setTemplateDir() (sets the template directory based on the $outputformat and $name)
Parameters:
SmartyInit [line 327]
void &SmartyInit(
&$templ)
|
|
Parameters:
sourceLine [line 251]
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 284]
unmangle [line 149]
writeExample [line 188]
void writeExample(
$title,
$path,
$source)
|
|
Overrides Converter::writeExample() (Write out the formatted source code for an example php file)
Parameters:
writefile [line 1701]
void writefile(
$file,
$contents)
|
|
Write a file to disk, and add it to the $hhp_files list of files to include in the generated CHM
{
}
Parameters:
writeNewPPage [line 500]
void writeNewPPage(
$key)
|
|
Parameters:
writeSource [line 165]
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:09 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|