target directory passed on the command-line.

$targetDir is malleable, always adding package/ and package/subpackage/ subdirectories onto it.

contains all of the template procedural page element loop data needed for the current template

controls formatting of parser informative output

Converter prints: "Converting /path/to/file.php... Procedural Page Elements... Classes..." Since CHMdefaultConverter outputs files while converting, it needs to send a \n to start a new line. However, if there is more than one class, output is messy, with multiple \n's just between class file output. This variable prevents that and is purely cosmetic

indexes of elements by package that need to be generated

Converter::$leftindex

Controls which of the one-element-only indexes are generated.

Converter::$outputformat

output format of this converter

output directory for the current procedural page being processed

CHMdefaultConverter wants elements sorted by type as well as alphabetically

• see: Converter::$sort_page_contents_by_type

Converter::$sort_page_contents_by_type

This determines whether the $page_contents array should be sorted by element type as well as alphabetically by name

sets $base_dir to $targetDir

• see: Converter::Converter()

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

Add an item to the index.hhk file

• author: Andrew Eddie <[email protected]>
• uses: CHMdefaultConverter::$KLinks - tracks the index

• 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

• $name
• $file
• $package
• $subpackage
• $class
• $tutorial

Converts class constants for template output

• see: Converter::prepareDocBlock(), Converter::getFormattedConflicts()

• parserDefine &$element

Converter::convertConst()

Converts class constants for template output.

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

Converter::ConvertErrorLog()

Convert the phpDocumentor parsing/conversion error log

Converts global variables for template output

• parserGlobal &$element

Converter::convertGlobal()

Converts global variables for template output

Converts class methods for template output

• see: Converter::prepareDocBlock(), Converter::getFormattedConflicts()

• parserDefine &$element

Converter::convertMethod()

Converts method for template output

converts procedural pages for template output

• see: Converter::prepareDocBlock(), Converter::getClassesOnPage()

• parserData &$element

Converter::convertPage()

Default Page Handler

• parserTutorial &$element

Converter::convertTutorial()

Default Tutorial Handler

Convert README/INSTALL/CHANGELOG file contents to output format

• README|INSTALL|CHANGELOG $name
• string $contents: contents of the file

Converter::Convert_RIC()

Convert README/INSTALL/CHANGELOG file contents to output format

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

• see: Converter::endClass()
• see: registerCurrentClass()

Converter::endClass()

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

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

Converter::formatIndex()

Called by walk() while converting.

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

Converter::formatPkgIndex()

Called by walk() while converting.

Generate alphabetical index of all elements

• see: Converter::$elements, Converter::walk()

returns a template-enabled array of class trees

• see: $roots, HTMLConverter::getRootTree()

• string $package: package to generate a class tree for

Get the table of contents for index.hhk

• return: contents of tocentry.tpl generated from $KLinks
• author: Andrew Eddie <[email protected]>

• see: CHMdefaultConverter::generatePkgElementIndex()

• $value

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

• 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

Converter::getConstLink()

return false or a constLink to $expr in $class

• return: false if not found, or an html a link to the define's documentation
• see: Converter::getDefineLink()

• 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

Converter::getDefineLink()

return false or a defineLink to $expr

• return: false if not found, or an html a link to the function's documentation
• see: Converter::getFunctionLink()

• 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

Converter::getFunctionLink()

return false or a functionLink to $expr

• $element
• $fullpath

Converter::getId()

take abstractLink descendant and text $eltext and return a

• return: false if not found, or an html a link to the method's documentation
• see: Converter::getMethodLink()

• 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

Converter::getMethodLink()

return false or a methodLink to $expr in $class

• &$element

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

• 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

• $package
• $subpackage
• $tutorial
• $id

Converter::getTutorialId()

Return a converter-specific id to distinguish tutorials and their sections

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:

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

Converter::Output()

do all necessary output

Used to convert the <code> tag in a docblock

• string $example
• boolean $tutorial
• $inlinesourceparse
• $class
• $linenum
• $filesourcepath

Converter::ProgramExample()

Used to convert the <code> tag in a docblock

does a nat case sort on the specified second level value of the array.

this one puts constructors first

• mixed $a
• mixed $b

This function takes an abstractLink descendant and returns an html link

• 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

Converter::returnSee()

take abstractLink descendant and text $eltext and return a link

• $dir

Converter::setTemplateDir()

sets the template directory based on the $outputformat and $name

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

• 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.

Converter::sourceLine()

Return a line of highlighted source code with formatted line number

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

• $sourcecode

Converter::unmangle()

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

Write a file to disk, and add it to the $hhp_files list of files to include in the generated CHM

• $file
• $contents

• string $path: full path to the source file
• string $value: fully highlighted source code

Converter::writeSource()

Write out the formatted source code for a php file