Class: CHMdefaultConverter

[line 85]

target directory passed on the command-line.

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

Type: string

Overrides:

[line 91]

output directory for the current class being processed

Type: string

Overrides:

[line 116]

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

Type: array

Overrides:

[line 122]

contains all of the template class element loop data needed for the current template

Type: array

Overrides:

[line 110]

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

Type: boolean

Overrides:

[line 129]

Table of Contents entry for index.hhk

Tags:

• usedby - CHMdefaultConverter::addKLink() - tracks the index

Type: array

Overrides:

[line 72]

indexes of elements by package that need to be generated

Type: array

Overrides: Array

[line 67]

Type: string

Overrides:

[line 65]

Type: string

Overrides: Array

[line 98]

array of converted package page names.

Used to link to the package page in the left index

Tags:

• var - Format: array(package => 1)

Type: array

Overrides:

[line 78]

output directory for the current procedural page being processed

Type: string

Overrides:

[line 124]

Type: mixed

Overrides:

[line 63]

CHMdefaultConverter wants elements sorted by type as well as alphabetically

Tags:

• see - Converter::$sort_page_contents_by_type

Type: boolean

Overrides: Array

[line 123]

Type: mixed

Overrides:

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

[line 135]

sets $base_dir to $targetDir

Tags:

• see - Converter::Converter()

Parameters:

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

void addHHP( $file)

[line 1701]

Tags:

• uses - $hhp_files - creates the array by adding parameter $file

Parameters:

• $file -

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

[line 1795]

Add an item to the index.hhk file

Tags:

• author - Andrew Eddie <[email protected]>
• 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

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

[line 1762]

Parameters:

• $name -
• $file -
• $package -
• $subpackage -
• $source -

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

[line 1773]

Parameters:

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

void convertClass( parserClass &$element)

[line 828]

Converts class for template output

Tags:

• see - Converter::getFormattedInheritedMethods(), Converter::getFormattedInheritedVars()
• see - Converter::prepareDocBlock(), Converter::generateChildClassList(), CHMdefaultConverter::generateFormattedClassTree(), Converter::getFormattedConflicts()

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

Parameters:

• parserClass &$element -

void convertConst( parserDefine &$element)

[line 860]

Converts class constants for template output

Tags:

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

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

Parameters:

• parserDefine &$element -

void convertDefine( parserDefine &$element)

[line 909]

Converts defines for template output

Tags:

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

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

Parameters:

• parserDefine &$element -

void ConvertErrorLog( )

[line 698]

Create errors.html template file output

This method takes all parsing errors and warnings and spits them out ordered by file and line number.

Tags:

• global - ErrorTracker $phpDocumentor_errors: We'll be using it's output facility

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

Parameters:

void convertFunction( parserFunction &$element)

[line 884]

Converts function for template output

Tags:

• see - Converter::prepareDocBlock(), parserFunction::getFunctionCall(), Converter::getFormattedConflicts()

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

Parameters:

• parserFunction &$element -

void convertGlobal( parserGlobal &$element)

[line 920]

Converts global variables for template output

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

Parameters:

• parserGlobal &$element -

void convertInclude( parserInclude &$element)

[line 897]

Converts include elements for template output

Tags:

• see - Converter::prepareDocBlock()

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

Parameters:

• parserInclude &$element -

void convertMethod( parserDefine &$element)

[line 872]

Converts class methods for template output

Tags:

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

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

Parameters:

• parserDefine &$element -

void convertPackagepage( parserPackagePage &$element)

[line 773]

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

Parameters:

• parserPackagePage &$element -

void convertPage( parserData &$element)

[line 932]

converts procedural pages for template output

Tags:

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

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

Parameters:

• parserData &$element -

void ConvertTodoList( )

[line 644]

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

Parameters:

void convertTutorial( parserTutorial &$element)

[line 794]

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

Parameters:

• parserTutorial &$element -

void convertVar( parserDefine &$element)

[line 848]

Converts class variables for template output

Tags:

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

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

Parameters:

• parserDefine &$element -

void Convert_RIC( README|INSTALL|CHANGELOG $name, string $contents)

[line 680]

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

void copyMediaRecursively( $media, $targetdir, [ $subdir = ''])

[line 1361]

Parameters:

• $media -
• $targetdir -
• $subdir -

void endClass( )

[line 340]

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

Tags:

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

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

Parameters:

void endPage( )

[line 363]

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

Tags:

• see - Converter::endPage()
• see - registerCurrent()

Overrides Converter::endPage() (Called by walk() while converting, when the last procedural page element has been parsed.)

Parameters:

void formatIndex( )

[line 427]

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.

Tags:

• global - string $phpDocumentor_DefaultPackageName: Used to set the starting package to display

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

Parameters:

void formatLeftIndex( )

[line 523]

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

Tags:

• see - Converter::$page_elements, Converter::$class_elements, Converter::$function_elements

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

Parameters:

void formatPkgIndex( )

[line 395]

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

Tags:

• see - CHMdefaultConverter::generateElementIndex(), CHMdefaultConverter::generatePkgElementIndex()

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

Parameters:

string formatTutorialTOC( array $toc)

[line 311]

Use the template tutorial_toc.tpl to generate a table of contents for HTML

Tags:

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

void generateElementIndex( )

[line 1322]

Generate alphabetical index of all elements

Tags:

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

Parameters:

array generateFormattedClassTree( parserClass $class)

[line 959]

returns an array containing the class inheritance tree from the root object to the class

Tags:

• 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

void generateFormattedClassTrees( string $package)

[line 1023]

returns a template-enabled array of class trees

Tags:

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

Parameters:

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

void generateFormattedInterfaceTrees( string $package)

[line 1077]

returns a template-enabled array of interface inheritance trees

Tags:

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

Parameters:

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

string generateKLinks( )

[line 1816]

Get the table of contents for index.hhk

Tags:

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

Parameters:

void generatePkgElementIndex( string $package)

[line 1426]

Generate alphabetical index of all elements by package and subpackage

Tags:

• see - Converter::$pkg_elements, Converter::walk(), CHMdefaultConverter::generatePkgElementIndexes()

Parameters:

• string $package - name of a package

void generatePkgElementIndexes( )

[line 1477]

Tags:

• see - CHMdefaultConverter::generatePkgElementIndex()

Parameters:

void generateTOC( )

[line 1710]

Tags:

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

Parameters:

void getCData( $value)

[line 759]

Parameters:

• $value -

mixed getClassLink( string $expr, string $package, [string $file = false], [boolean $text = false], [boolean $with_a = true])

[line 1517]

Tags:

• 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

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

[line 1632]

Tags:

• 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

void getCurrentPageLink( )

[line 289]

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

Parameters:

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

[line 1549]

Tags:

• 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

void getExampleLink( $path, $title)

[line 199]

Parameters:

• $path -
• $title -

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

[line 1533]

Tags:

• 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

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

[line 1565]

Tags:

• 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

void getId( $element, [ $fullpath = true])

[line 591]

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

Parameters:

• $element -
• $fullpath -

array getIndexInformation( parserElement $elt)

[line 1205]

Generate indexing information for given element

Tags:

• see - CHMdefaultConverter::generateElementIndex()

Parameters:

• parserElement $elt - descendant of parserElement

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

[line 1598]

Tags:

• 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

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

[line 1581]

Tags:

• 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

void getPageName( &$element)

[line 945]

Parameters:

• &$element -

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

[line 1134]

return formatted class tree for the Class Trees page

Tags:

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

string getSourceAnchor( string $sourcefile, string $anchor, [string $text = ''], [boolean $link = false])

[line 220]

Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.

Tags:

• 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

void getSourceLink( $path)

[line 204]

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

Parameters:

• $path -

void getTutorialId( $package, $subpackage, $tutorial, $id)

[line 764]

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

Parameters:

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

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

[line 1615]

Tags:

• 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

void Output( )

[line 1860]

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:

1.         phpDocumentor_out("NOTE: to create the documentation.chm file, you must now run Microsoft Help Workshop on phpdoc.hhp\n");
2.         phpDocumentor_out("To get the free Microsoft Help Workshop, browse to: http://go.microsoft.com/fwlink/?LinkId=14188\n");

finishes things off}}

Tags:

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

Parameters:

void postProcess( $text)

[line 297]

Uses htmlspecialchars() on the input

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

Parameters:

• $text -

string ProgramExample( string $example, [boolean $tutorial = false], [ $inlinesourceparse = null], [ $class = null], [ $linenum = null], [ $filesourcepath = null])

[line 266]

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 -

int rcNatCmp( mixed $a, mixed $b)

[line 1646]

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

Parameters:

• mixed $a -
• mixed $b -

int rcNatCmp1( mixed $a, mixed $b)

[line 1662]

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

this one puts constructors first

Parameters:

• mixed $a -
• mixed $b -

string returnLink( string $link, string $text)

[line 383]

Tags:

• return - &lt;a href="'.$link.'">'.$text.'</a&gt;

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 -

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

[line 561]

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

void setTargetDir( $dir)

[line 1406]

calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied

Tags:

• see - Converter::setTargetDir()

Overrides Converter::setTargetDir() (Sets the output directory for generated documentation)

Parameters:

• $dir -

void setTemplateDir( $dir)

[line 1355]

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

Parameters:

• $dir -

void &SmartyInit( &$templ)

[line 318]

Parameters:

• &$templ -

string sourceLine( integer $linenumber, string $line, [false|string $path = false])

[line 242]

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

Tags:

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

void TutorialExample( string $example)

[line 275]

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

Parameters:

• string $example -

void unmangle( $sourcecode)

[line 144]

Tags:

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

void writeExample( $title, $path, $source)

[line 179]

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

Parameters:

• $title -
• $path -
• $source -

void writefile( $file, $contents)

[line 1692]

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

1. function writefile($file,$contents)
2.     {
3.         $this->addHHP($this->targetDir . PATH_DELIMITER . $file);
4.         Converter::writefile($file,$contents);
5.     }

Parameters:

• $file -
• $contents -

void writeNewPPage( $key)

[line 491]

Parameters:

• $key -

void writeSource( string $path, string $value)

[line 160]

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