Docs For Class CHMdefaultConverter

Class: Converter

Converter::Converter(): Initialize Converter data structures
Converter::AttrToString(): Convert the attribute of a Tutorial docbook tag's attribute list
Converter::Bolden(): Used to convert the contents of <b> in a docblock
Converter::Br(): Used to convert <br> in a docblock
Converter::checkState(): Compare parserStringWithInlineTags::Convert() cache state to $state
Converter::cleanup(): Finish up parsing/cleanup directories
Converter::Convert(): Convert all elements to output format
Converter::convertClass(): Default Class Handler
Converter::convertConst(): Converts class constants for template output.
Converter::convertDefine(): Converts defines for template output
Converter::ConvertErrorLog(): Convert the phpDocumentor parsing/conversion error log
Converter::convertFunction(): Converts function for template output
Converter::convertGlobal(): Converts global variables for template output
Converter::convertInclude(): Converts includes for template output
Converter::convertMethod(): Converts method for template output
Converter::convertPage(): Default Page Handler
Converter::ConvertTitle(): Convert the title of a Tutorial docbook tag section
Converter::ConvertTodoList(): Convert the list of all @todo tags
Converter::convertTutorial(): Default Tutorial Handler
Converter::convertVar(): Converts class variables for template output.
Converter::Convert_RIC(): Convert README/INSTALL/CHANGELOG file contents to output format
Converter::copyFile(): Copies a file from the template directory to the target directory
Converter::createParentDir(): Recursively creates all subdirectories that don't exist in the $dir path
Converter::EncloseList(): Used to convert the contents of <ol> or <ul> in a docblock
Converter::EncloseParagraph(): Used to enclose a paragraph in a docblock
Converter::endClass(): Called by walk() while converting, when the last class element has been parsed.
Converter::endPage(): Called by walk() while converting, when the last procedural page element has been parsed.
Converter::exampleProgramExample(): Used to convert the {@example} inline tag in a docblock.
Converter::flushHighlightCache(): Return the close text for the current token
Converter::formatIndex(): Called by walk() while converting.
Converter::formatLeftIndex(): Called by walk() while converting.
Converter::formatPkgIndex(): Called by walk() while converting.
Converter::formatTutorialTOC(): Creates a table of contents for a {@toc} inline tag in a tutorial
Converter::generateChildClassList(): returns a list of child classes
Converter::generateFormattedClassTree(): returns an array containing the class inheritance tree from the root object to the class.
Converter::getClassesOnPage(): gets a list of all classes declared on a procedural page represented by
Converter::getClassLink(): return false or a classLink to $expr
Converter::getConstLink(): return false or a constLink to $expr in $class
Converter::getConverterDir(): Get the absolute path to the converter's base directory
Converter::getCurrentPageLink()
Converter::getCurrentPageURL(): Return the path to the current
Converter::getDefineLink(): return false or a defineLink to $expr
Converter::getFileSourceName(): Translate the path info into a unique file name for the highlighted source code.
Converter::getFileSourcePath(): Return the fixed path to the source-code file folder.
Converter::getFormattedConflicts()
Converter::getFormattedDescMethods(): Get a list of methods in child classes that override this method
Converter::getFormattedDescVars(): Get a list of vars in child classes that override this var
Converter::getFormattedImplements(): returns an array containing the class inheritance tree from the root object to the class.
Converter::getFormattedInheritedConsts(): Return template-enabled list of inherited class constants
Converter::getFormattedInheritedMethods(): Return template-enabled list of inherited methods
Converter::getFormattedInheritedVars(): Return template-enabled list of inherited variables
Converter::getFormattedMethodImplements(): Get the method this method(s) implemented from an interface, if any
Converter::getFormattedOverrides(): Get the method this method overrides, if any
Converter::getFunctionLink(): return false or a functionLink to $expr
Converter::getGlobalLink(): return false or a globalLink to $expr
Converter::getGlobalValue(): Parse a global variable's default value for class initialization.
Converter::getHighlightState()
Converter::getId(): take abstractLink descendant and text $eltext and return a
Converter::getIncludeValue(): Parse an include's file to see if it is a file documented in this project
Converter::getLink(): The meat of the @see tag and inline {@link} tag
Converter::getMethodLink(): return false or a methodLink to $expr in $class
Converter::getPageLink(): return false or a pageLink to $expr
Converter::getSortedClassTreeFromClass(): Return a tree of all classes that extend this class
Converter::getSourceLink()
Converter::getState(): Return parserStringWithInlineTags::Convert() cache state
Converter::getTutorialId(): Return a converter-specific id to distinguish tutorials and their sections
Converter::getTutorialLink(): The meat of the @tutorial tag and inline {@tutorial} tag
Converter::getTutorialTree(): Get a tree structure representing the hierarchy of tutorials
Converter::getVarLink(): return false or a varLink to $expr in $class
Converter::hasSourceCode(): Determine whether an element's file has generated source code, used for linking to line numbers of source.
Converter::hasTutorial()
Converter::highlightDocBlockSource(): Used to allow converters to format the source code of DocBlocks the way they'd like.
Converter::highlightSource(): Used to allow converters to format the source code the way they'd like.
Converter::highlightTutorialSource(): Used to allow converters to format the source code of Tutorial XML the way they'd like.
Converter::Italicize(): Used to convert the contents of <i> in a docblock
Converter::Kbdize(): Used to convert the contents of <kbd> in a docblock
Converter::ListItem(): Used to convert the contents of <li> in a docblock
Converter::newSmarty(): Return a Smarty template object to operate with
Converter::Output(): do all necessary output
Converter::postProcess(): This version does nothing
Converter::prepareDocBlock(): convert the element's DocBlock for output
Converter::PreserveWhiteSpace(): Used to convert the contents of <pre> in a docblock
Converter::ProgramExample(): Used to convert the <code> tag in a docblock
Converter::returnLink(): take URL $link and text $text and return a link in the format needed for the Converter
Converter::returnSee(): take abstractLink descendant and text $eltext and return a link
Converter::Sampize(): Used to convert the contents of <samp> in a docblock
Converter::setSourcePaths(): Mark a file as having had source code highlighted
Converter::setTargetDir(): Sets the output directory for generated documentation
Converter::setTemplateBase(): Set the template directory with a different template base directory
Converter::setTemplateDir(): sets the template directory based on the $outputformat and $name
Converter::sortPageContentsByElementType(): sorts $page_contents by element type as well as alphabetically
Converter::sourceLine(): Return a line of highlighted source code with formatted line number
Converter::startHighlight(): Initialize highlight caching
Converter::TranslateEntity(): Used to translate an XML DocBook entity like ” from a tutorial by reading the options.ini file for the template.
Converter::TranslateTag(): Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.
Converter::TutorialExample()
Converter::type_adjust(): Called by parserReturnTag::Convert() to allow converters to change type names to desired formatting
Converter::unmangle(): Called by parserSourceInlineTag::stringConvert() to allow converters to format the source code the way they'd like.
Converter::vardump_tree(): Debugging function for dumping $tutorial_tree
Converter::Varize(): Used to convert the contents of <var> in a docblock
Converter::walk(): called by phpDocumentor_IntermediateParser::Convert() to traverse the array of pages and their elements, converting them to the output format
Converter::walk_everything(): walk over elements by package rather than page
Converter::writeExample(): Write out the formatted source code for an example php file
Converter::writeFile(): Writes a file to target dir
Converter::writeSource(): Write out the formatted source code for a php file

CHMdefaultConverter (Constructor) [line 135]

CHMdefaultConverter CHMdefaultConverter(

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

sets $base_dir to $targetDir

See: Converter::Converter()

Parameters:

	`&$allp`	—
	`&$packp`	—
	`&$classes`	—
	`&$procpages`	—
	`$po`	—
	`$pp`	—
	`$qm`	—
	`$targetDir`	—
	`$templateDir`	—
	`$title`	—

[ Top ]

addHHP [line 1700]

void addHHP(

$file)

Uses: $hhp_files - creates the array by adding parameter $file

Parameters:

$file —

[ Top ]

addKLink [line 1794]

void addKLink(
string
$name, string
$file, [string
$bookmark = ''], [string
$group = ''])

Add an item to the index.hhk file

Author: Andrew Eddie <eddieajau@users.sourceforge.net>
Uses: CHMdefaultConverter::$KLinks - tracks the index

Parameters:

string	`$name`	—	index entry name
string	`$file`	—	filename containing index
string	`$bookmark`	—	html anchor of location in file, if any
string	`$group`	—	group this entry with a string

[ Top ]

addSourceTOC [line 1761]

void addSourceTOC(

$name, 
$file, 
$package, 
$subpackage, [
$source = false])

Parameters:

	`$name`	—
	`$file`	—
	`$package`	—
	`$subpackage`	—
	`$source`	—

[ Top ]

addTOC [line 1772]

void addTOC(

$name, 
$file, 
$package, 
$subpackage, [
$class = false], [
$tutorial = false])

Parameters:

	`$name`	—
	`$file`	—
	`$package`	—
	`$subpackage`	—
	`$class`	—
	`$tutorial`	—

[ Top ]

convertClass [line 828]

void convertClass(
parserClass
&$element)

Converts class for template output

Overrides Converter::convertClass() (Default Class Handler)

Parameters:

parserClass &$element —

[ Top ]

convertConst [line 860]

void convertConst(
parserDefine
&$element)

Converts class constants for template output

See: Converter::prepareDocBlock(), Converter::getFormattedConflicts()

Overrides Converter::convertConst() (Converts class constants for template output.)

Parameters:

parserDefine &$element —

[ Top ]

convertDefine [line 909]

void convertDefine(
parserDefine
&$element)

Converts defines for template output

See: Converter::prepareDocBlock(), Converter::getFormattedConflicts()

Overrides Converter::convertDefine() (Converts defines for template output)

Parameters:

parserDefine &$element —

[ Top ]

ConvertErrorLog [line 698]

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.

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

Overrides Converter::ConvertErrorLog() (Convert the phpDocumentor parsing/conversion error log)

[ Top ]

convertFunction [line 884]

void convertFunction(
parserFunction
&$element)

Converts function for template output

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

Overrides Converter::convertFunction() (Converts function for template output)

Parameters:

parserFunction &$element —

[ Top ]

convertGlobal [line 920]

void convertGlobal(
parserGlobal
&$element)

Converts global variables for template output

Overrides Converter::convertGlobal() (Converts global variables for template output)

Parameters:

parserGlobal &$element —

[ Top ]

convertInclude [line 897]

void convertInclude(
parserInclude
&$element)

Converts include elements for template output

See: Converter::prepareDocBlock()

Overrides Converter::convertInclude() (Converts includes for template output)

Parameters:

parserInclude &$element —

[ Top ]

convertMethod [line 872]

void convertMethod(
parserDefine
&$element)

Converts class methods for template output

See: Converter::prepareDocBlock(), Converter::getFormattedConflicts()

Overrides Converter::convertMethod() (Converts method for template output)

Parameters:

parserDefine &$element —

[ Top ]

convertPackagepage [line 773]

void convertPackagepage(
parserPackagePage
&$element)

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

Parameters:

parserPackagePage &$element —

[ Top ]

convertPage [line 932]

void convertPage(
parserData
&$element)

converts procedural pages for template output

See: Converter::prepareDocBlock(), Converter::getClassesOnPage()

Overrides Converter::convertPage() (Default Page Handler)

Parameters:

parserData &$element —

[ Top ]

ConvertTodoList [line 644]

void ConvertTodoList(
)

Overrides Converter::ConvertTodoList() (Convert the list of all @todo tags)

[ Top ]

convertTutorial [line 794]

void convertTutorial(
parserTutorial
&$element)

Overrides Converter::convertTutorial() (Default Tutorial Handler)

Parameters:

parserTutorial &$element —

[ Top ]

convertVar [line 848]

void convertVar(
parserDefine
&$element)

Converts class variables for template output

See: Converter::prepareDocBlock(), Converter::getFormattedConflicts()

Overrides Converter::convertVar() (Converts class variables for template output.)

Parameters:

parserDefine &$element —

[ Top ]

Convert_RIC [line 680]

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

void copyMediaRecursively(

$media, 
$targetdir, [
$subdir = ''])

Parameters:

	`$media`	—
	`$targetdir`	—
	`$subdir`	—

[ Top ]

endClass [line 340]

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

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

void formatIndex(
)

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.

Global: string $phpDocumentor_DefaultPackageName: Used to set the starting package to display

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

[ Top ]

formatLeftIndex [line 523]

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

void formatPkgIndex(
)

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

See: CHMdefaultConverter::generateElementIndex(), CHMdefaultConverter::generatePkgElementIndex()

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

[ Top ]

formatTutorialTOC [line 311]

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 ]

generateElementIndex [line 1321]

void generateElementIndex(
)

Generate alphabetical index of all elements

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

[ Top ]

generateFormattedClassTree [line 959]

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

Overrides Converter::generateFormattedClassTree() (returns an array containing the class inheritance tree from the root object to the class.)

Parameters:

parserClass $class — class variable

[ Top ]

generateFormattedClassTrees [line 1023]

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 ]

generateFormattedInterfaceTrees [line 1077]

void generateFormattedInterfaceTrees(
string
$package)

returns a template-enabled array of interface inheritance trees

See: $roots, HTMLConverter::getRootTree()

Parameters:

string $package — package to generate a class tree for

[ Top ]

generateKLinks [line 1815]

string generateKLinks(
)

Get the table of contents for index.hhk

Return: contents of tocentry.tpl generated from $KLinks
Author: Andrew Eddie <eddieajau@users.sourceforge.net>

[ Top ]

generatePkgElementIndex [line 1425]

void generatePkgElementIndex(
string
$package)

Generate alphabetical index of all elements by package and subpackage

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

Parameters:

string $package — name of a package

[ Top ]

generatePkgElementIndexes [line 1476]

void generatePkgElementIndexes(
)

See: CHMdefaultConverter::generatePkgElementIndex()

[ Top ]

generateTOC [line 1709]

void generateTOC(
)

Usedby: CHMdefaultConverter::Output() - assigns to the toc template variable

[ Top ]

getCData [line 759]

void getCData(

$value)

Parameters:

$value —

[ Top ]

getClassLink [line 1516]

mixed getClassLink(
string
$expr, string
$package, [string
$file = false], [boolean
$text = false], [boolean
$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	`$with_a`	—	return just the URL, or enclose it in an html a tag

[ Top ]

getConstLink [line 1631]

mixed getConstLink(
string
$expr, string
$class, string
$package, [string
$file = false], [boolean
$text = false], boolean
5)

Return: false if not found, or an html a link to the var's documentation
See: Converter::getVarLink()

Overrides Converter::getConstLink() (return false or a constLink to $expr in $class)

Parameters:

boolean	`5`	—	return just the URL, or enclose it in an html a tag
string	`$expr`	—	name of class constant
string	`$class`	—	class containing class constant
string	`$package`	—	package name
string	`$file`	—	full path to look in (used in index generation)
boolean	`$text`	—	deprecated

[ Top ]

getCurrentPageLink [line 289]

void getCurrentPageLink(
)

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

[ Top ]

getDefineLink [line 1548]

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

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:

boolean	`4`	—	return just the URL, or enclose it in an html a tag
string	`$expr`	—	name of define
string	`$package`	—	package name
string	`$file`	—	full path to look in (used in index generation)
boolean	`$text`	—	deprecated

[ Top ]

getExampleLink [line 199]

void getExampleLink(

$path, 
$title)

Parameters:

	`$path`	—
	`$title`	—

[ Top ]

getFunctionLink [line 1532]

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

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:

boolean	`4`	—	return just the URL, or enclose it in an html a tag
string	`$expr`	—	name of function
string	`$package`	—	package name
string	`$file`	—	full path to look in (used in index generation)
boolean	`$text`	—	deprecated

[ Top ]

getGlobalLink [line 1564]

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

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:

boolean	`4`	—	return just the URL, or enclose it in an html a tag
string	`$expr`	—	name of global variable
string	`$package`	—	package name
string	`$file`	—	full path to look in (used in index generation)
boolean	`$text`	—	deprecated

[ Top ]

getId [line 591]

void getId(

$element, [
$fullpath = true])

Overrides Converter::getId() (take abstractLink descendant and text $eltext and return a)

Parameters:

	`$element`	—
	`$fullpath`	—

[ Top ]

getIndexInformation [line 1204]

array getIndexInformation(
parserElement
$elt)

Generate indexing information for given element

See: CHMdefaultConverter::generateElementIndex()

Parameters:

parserElement $elt — descendant of parserElement

[ Top ]

getMethodLink [line 1597]

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

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:

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

[ Top ]

getPageLink [line 1580]

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

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:

boolean	`4`	—	return just the URL, or enclose it in an html a tag
string	`$expr`	—	name of procedural page
string	`$package`	—	package name
string	`$path`	—	full path to look in (used in index generation)
boolean	`$text`	—	deprecated

[ Top ]

getPageName [line 945]

void getPageName(

&$element)

Parameters:

&$element —

[ Top ]

getRootTree [line 1134]

string getRootTree(
array
$tree, string
$package, [
$noparent = false], boolean
$nounknownparent)

return formatted class tree for the Class Trees page

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

Parameters:

array	`$tree`	—	output from getSortedClassTreeFromClass()
string	`$package`	—	package
boolean	`$nounknownparent`	—	if true, an object's parent will not be checked
	`$noparent`	—

[ Top ]

getSourceAnchor [line 220]

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.

Return: link to an anchor, or the anchor

Parameters:

string	`$sourcefile`	—	full path to source file
string	`$anchor`	—	name of anchor
string	`$text`	—	link text, if this is a link
boolean	`$link`	—	returns either a link or a destination based on this parameter

[ Top ]

getSourceLink [line 204]

void getSourceLink(

$path)

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

Parameters:

$path —

[ Top ]

getTutorialId [line 764]

void getTutorialId(

$package, 
$subpackage, 
$tutorial, 
$id)

Overrides Converter::getTutorialId() (Return a converter-specific id to distinguish tutorials and their sections)

Parameters:

	`$package`	—
	`$subpackage`	—
	`$tutorial`	—
	`$id`	—

[ Top ]

getVarLink [line 1614]

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

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:

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

[ Top ]

Output [line 1859]

void Output(
)

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}}

Link: http://www.microsoft.com/downloads/release.asp?releaseid=33071
Todo: use to directly call html help compiler hhc.exe
Uses: CHMdefaultConverter::generateTOC() - assigns to the toc template variable

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

[ Top ]

postProcess [line 297]

void postProcess(

$text)

Uses htmlspecialchars() on the input

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

Parameters:

$text —

[ Top ]

ProgramExample [line 266]

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:

string	`$example`	—
boolean	`$tutorial`	—
	`$inlinesourceparse`	—
	`$class`	—
	`$linenum`	—
	`$filesourcepath`	—

[ Top ]

rcNatCmp [line 1645]

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

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

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

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

This function takes an abstractLink descendant and returns an html link

Overrides Converter::returnSee() (take abstractLink descendant and text $eltext and return a link)

Parameters:

boolean	`3`	—	determines whether the returned text is enclosed in an <a> tag
abstractLink	`&$element`	—	a descendant of abstractlink should be passed, and never text
string	`$eltext`	—	text to display in the link
boolean	`$with_a`	—	this parameter is not used, and is deprecated

[ Top ]

setTargetDir [line 1405]

void setTargetDir(

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

Parameters:

$dir —

[ Top ]

setTemplateDir [line 1354]

void setTemplateDir(

$dir)

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

Parameters:

$dir —

[ Top ]

SmartyInit [line 318]

void &SmartyInit(

&$templ)

Parameters:

&$templ —

[ Top ]

sourceLine [line 242]

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

Return: formatted source code line with line number

Overrides Converter::sourceLine() (Return a line of highlighted source code with formatted line number)

Parameters:

integer	`$linenumber`	—	line number
string	`$line`	—	highlighted source code line
false\|string	`$path`	—	full path to @filesource file this line is a part of, if this is a single line from a complete file.

[ Top ]

TutorialExample [line 275]

void TutorialExample(
string
$example)

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

Parameters:

string $example —

[ Top ]

unmangle [line 144]

void unmangle(

$sourcecode)

Deprecated: in favor of PHP 4.3.0+ tokenizer-based source highlighting

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

Parameters:

$sourcecode —

[ Top ]

writeExample [line 179]

void writeExample(

$title, 
$path, 
$source)

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

Parameters:

	`$title`	—
	`$path`	—
	`$source`	—

[ Top ]

writefile [line 1691]

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

function writefile($file,$contents)

    {
        $this->addHHP($this->targetDir . PATH_DELIMITER . $file);
        Converter::writefile($file,$contents);
    }

Parameters:

	`$file`	—
	`$contents`	—

[ Top ]

writeNewPPage [line 491]

void writeNewPPage(

$key)

Parameters:

$key —

[ Top ]

writeSource [line 160]

void writeSource(
string
$path, string
$value)

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

Parameters:

string	`$path`	—	full path to the source file
string	`$value`	—	fully highlighted source code

[ Top ]

Class: CHMdefaultConverter

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Class: Converter

Inherited Methods

Class: Converter

Class Details

Class Variables

$base_dir =

$class_dir =

$current =

$currentclass =

$juststarted = false

$KLinks = array()

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

$name = 'default'

$outputformat = 'CHM'

$package_pages = array()

$page_dir =

$ric_set = array()

$sort_page_contents_by_type = true

$wrote = false

Method Detail

CHMdefaultConverter (Constructor) [line 135]

Parameters:

addHHP [line 1700]

Parameters:

addKLink [line 1794]

Parameters:

addSourceTOC [line 1761]

Parameters:

addTOC [line 1772]

Parameters:

convertClass [line 828]

Parameters:

convertConst [line 860]

Parameters:

convertDefine [line 909]

Parameters:

ConvertErrorLog [line 698]

convertFunction [line 884]

Parameters:

convertGlobal [line 920]

Parameters:

convertInclude [line 897]

Parameters:

convertMethod [line 872]

Parameters:

convertPackagepage [line 773]

Parameters:

convertPage [line 932]

Parameters:

ConvertTodoList [line 644]

convertTutorial [line 794]

Parameters:

convertVar [line 848]

Parameters:

Convert_RIC [line 680]

Parameters:

copyMediaRecursively [line 1360]

Parameters:

endClass [line 340]

endPage [line 363]

formatIndex [line 427]

formatLeftIndex [line 523]

formatPkgIndex [line 395]

formatTutorialTOC [line 311]

Parameters:

generateElementIndex [line 1321]

generateFormattedClassTree [line 959]

Parameters:

generateFormattedClassTrees [line 1023]

Parameters:

generateFormattedInterfaceTrees [line 1077]

Parameters:

generateKLinks [line 1815]