phpDocumentor Converters
CHMdefault
[ class tree: Converters ] [ index: Converters ] [ all elements ]

Class: CHMdefaultConverter

Source Location: /phpDocumentor/Converters/CHM/default/CHMdefaultConverter.inc

Class CHMdefaultConverter

Class Overview

Generates files that MS HTML Help Worshop can use to create a MS Windows compiled help file (CHM)

The free MS HTML Help compiler takes the project file (phpdoc.hhp) and reads the table of contents file specified in the project (which is always contents.hhc in phpDocumentor). When the converter reaches stable state, it will also output an index file index.hhk. The free download for MS HTML Help Workshop is available below

Located in /phpDocumentor/Converters/CHM/default/CHMdefaultConverter.inc [line 56]

Converter
   |
   --CHMdefaultConverter
Author(s): Information Tags:
Version:  $Revision: 317233 $
Link:  MS HTML Help Workshop download
Since:  1.0rc1

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Converter

Converter::$all_packages
Converter::$class
Converter::$classes
Converter::$class_contents
Converter::$class_data
Converter::$class_elements
Converter::$curfile
Converter::$curpage
Converter::$define_elements
Converter::$elements
Converter::$function_elements
Converter::$global_elements
Converter::$highlightingSource
Converter::$package
Converter::$packagecategories
Converter::$package_elements
Converter::$package_output
Converter::$package_parents
Converter::$page
Converter::$page_contents
Converter::$page_data
Converter::$page_elements
Converter::$parseprivate
Converter::$path
Converter::$pkg_elements
Converter::$processSpecialRoots
Converter::$quietmode
Converter::$smarty_dir
Converter::$sort_absolutely_everything
Converter::$sourcePaths
Converter::$subpackage
Converter::$targetDir
Converter::$templateDir
Converter::$templateName
Converter::$template_options
Converter::$title
Converter::$todoList

Inherited From 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 &rdquo; 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
Converter::_rmdir()
Completely remove a directory and its contents
Converter::_setHighlightCache()
Converter::_tutorial_path()
Returns the path to this tutorial as a string

[ Top ]
Property Summary
string   $base_dir   target directory passed on the command-line.
string   $class_dir   output directory for the current class being processed
array   $current   contains all of the template procedural page element loop data needed for the current template
array   $currentclass   contains all of the template class element loop data needed for the current template
boolean   $juststarted   controls formatting of parser informative output
array   $KLinks   Table of Contents entry for index.hhk
array   $leftindex   indexes of elements by package that need to be generated
string   $name  
string   $outputformat  
array   $package_pages   array of converted package page names.
string   $page_dir   output directory for the current procedural page being processed
mixed   $ric_set  
boolean   $sort_page_contents_by_type   CHMdefaultConverter wants elements sorted by type as well as alphabetically
mixed   $wrote  

[ Top ]
Method Summary
CHMdefaultConverter   CHMdefaultConverter()   sets $base_dir to $targetDir
void   addHHP()  
void   addKLink()   Add an item to the index.hhk file
void   addSourceTOC()  
void   addTOC()  
void   convertClass()   Converts class for template output
void   convertConst()   Converts class constants for template output
void   convertDefine()   Converts defines for template output
void   ConvertErrorLog()   Create errors.html template file output
void   convertFunction()   Converts function for template output
void   convertGlobal()   Converts global variables for template output
void   convertInclude()   Converts include elements for template output
void   convertMethod()   Converts class methods for template output
void   convertPackagepage()   Converts package page and sets its package as used in $package_pages
void   convertPage()   converts procedural pages for template output
void   ConvertTodoList()  
void   convertTutorial()  
void   convertVar()   Converts class variables for template output
void   Convert_RIC()   Convert README/INSTALL/CHANGELOG file contents to output format
void   copyMediaRecursively()  
void   endClass()   Writes out the template file of $class_data and unsets the template to save memory
void   endPage()   Writes out the template file of $page_data and unsets the template to save memory
void   formatIndex()   CHMdefaultConverter uses this function to format template index.html and packages.html
void   formatLeftIndex()   Generate indexes for li_package.html and classtree output files
void   formatPkgIndex()   CHMdefaultConverter chooses to format both package indexes and the complete index here
string   formatTutorialTOC()   Use the template tutorial_toc.tpl to generate a table of contents for HTML
void   generateElementIndex()   Generate alphabetical index of all elements
array   generateFormattedClassTree()   returns an array containing the class inheritance tree from the root object to the class
void   generateFormattedClassTrees()   returns a template-enabled array of class trees
void   generateFormattedInterfaceTrees()   returns a template-enabled array of interface inheritance trees
string   generateKLinks()   Get the table of contents for index.hhk
void   generatePkgElementIndex()   Generate alphabetical index of all elements by package and subpackage
void   generatePkgElementIndexes()  
void   generateTOC()  
void   getCData()  
mixed   getClassLink()  
mixed   getConstLink()  
void   getCurrentPageLink()  
mixed   getDefineLink()  
void   getExampleLink()  
mixed   getFunctionLink()  
mixed   getGlobalLink()  
void   getId()  
array   getIndexInformation()   Generate indexing information for given element
mixed   getMethodLink()  
mixed   getPageLink()  
void   getPageName()  
string   getRootTree()   return formatted class tree for the Class Trees page
string   getSourceAnchor()   Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.
void   getSourceLink()  
void   getTutorialId()  
mixed   getVarLink()  
void   Output()   Create the phpdoc.hhp, contents.hhc files needed by MS HTML Help Compiler to create a CHM file
void   postProcess()   Uses htmlspecialchars() on the input
string   ProgramExample()   Used to convert the <code> tag in a docblock
int   rcNatCmp()   does a nat case sort on the specified second level value of the array
int   rcNatCmp1()   does a nat case sort on the specified second level value of the array.
string   returnLink()  
void   returnSee()   This function takes an abstractLink descendant and returns an html link
void   setTargetDir()   calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
void   setTemplateDir()  
void   &SmartyInit()  
string   sourceLine()   Return a line of highlighted source code with formatted line number
void   TutorialExample()  
void   unmangle()  
void   writeExample()  
void   writefile()   Write a file to disk, and add it to the $hhp_files list of files to include in the generated CHM
void   writeNewPPage()  
void   writeSource()  

[ Top ]
Properties
string   $base_dir [line 85]

target directory passed on the command-line.

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


[ Top ]
string   $class_dir [line 91]

output directory for the current class being processed


[ Top ]
array   $current [line 116]

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


[ Top ]
array   $currentclass [line 122]

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


[ Top ]
boolean   $juststarted = false [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


[ Top ]
array   $KLinks = array() [line 129]

Table of Contents entry for index.hhk

API Tags:
Usedby:  CHMdefaultConverter::addKLink() - tracks the index


[ Top ]
array   $leftindex = array('classes' => true, 'pages' => true, 'functions' => true, 'defines' => false, 'globals' => false) [line 72]

indexes of elements by package that need to be generated


Redefinition of:
Converter::$leftindex
Controls which of the one-element-only indexes are generated.

[ Top ]
string   $name = 'default' [line 67]

[ Top ]
string   $outputformat = 'CHM' [line 65]

Redefinition of:
Converter::$outputformat
output format of this converter

[ Top ]
array   $package_pages = array() [line 98]

array of converted package page names.

Used to link to the package page in the left index


[ Top ]
string   $page_dir [line 78]

output directory for the current procedural page being processed


[ Top ]
mixed   $ric_set = array() [line 124]

[ Top ]
boolean   $sort_page_contents_by_type = true [line 63]

CHMdefaultConverter wants elements sorted by type as well as alphabetically

API Tags:
See:  Converter::$sort_page_contents_by_type


Redefinition of:
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

[ Top ]
mixed   $wrote = false [line 123]

[ Top ]
Methods
Constructor CHMdefaultConverter  [line 135]

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

sets $base_dir to $targetDir

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

API Tags:
See:  Converter::Converter()


[ Top ]
addHHP  [line 1701]

  void addHHP( $file  )

Parameters:
   $file: 

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


[ Top ]
addKLink  [line 1795]

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

Add an item to the index.hhk file

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

API Tags:
Uses:  CHMdefaultConverter::$KLinks - tracks the index

Information Tags:
Author:  Andrew Eddie <eddieajau@users.sourceforge.net>

[ Top ]
addSourceTOC  [line 1762]

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

Parameters:
   $name: 
   $file: 
   $package: 
   $subpackage: 
   $source: 


[ Top ]
addTOC  [line 1773]

  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

Parameters:
parserClass   &$element: 

API Tags:
See:  Converter::getFormattedInheritedMethods(), Converter::getFormattedInheritedVars()
See:  Converter::prepareDocBlock(), Converter::generateChildClassList(), CHMdefaultConverter::generateFormattedClassTree(), Converter::getFormattedConflicts()


Redefinition of:
Converter::convertClass()
Default Class Handler

[ Top ]
convertConst  [line 860]

  void convertConst( parserDefine &$element  )

Converts class constants for template output

Parameters:
parserDefine   &$element: 

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


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

[ Top ]
convertDefine  [line 909]

  void convertDefine( parserDefine &$element  )

Converts defines for template output

Parameters:
parserDefine   &$element: 

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


Redefinition of:
Converter::convertDefine()
Converts defines for template output

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


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


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

[ Top ]
convertFunction  [line 884]

  void convertFunction( parserFunction &$element  )

Converts function for template output

Parameters:
parserFunction   &$element: 

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


Redefinition of:
Converter::convertFunction()
Converts function for template output

[ Top ]
convertGlobal  [line 920]

  void convertGlobal( parserGlobal &$element  )

Converts global variables for template output

Parameters:
parserGlobal   &$element: 


Redefinition of:
Converter::convertGlobal()
Converts global variables for template output

[ Top ]
convertInclude  [line 897]

  void convertInclude( parserInclude &$element  )

Converts include elements for template output

Parameters:
parserInclude   &$element: 

API Tags:
See:  Converter::prepareDocBlock()


Redefinition of:
Converter::convertInclude()
Converts includes for template output

[ Top ]
convertMethod  [line 872]

  void convertMethod( parserDefine &$element  )

Converts class methods for template output

Parameters:
parserDefine   &$element: 

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


Redefinition of:
Converter::convertMethod()
Converts method for template output

[ 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

Parameters:
parserData   &$element: 

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


Redefinition of:
Converter::convertPage()
Default Page Handler

[ Top ]
ConvertTodoList  [line 644]

  void ConvertTodoList( )



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

[ Top ]
convertTutorial  [line 794]

  void convertTutorial( parserTutorial &$element  )

Parameters:
parserTutorial   &$element: 


Redefinition of:
Converter::convertTutorial()
Default Tutorial Handler

[ Top ]
convertVar  [line 848]

  void convertVar( parserDefine &$element  )

Converts class variables for template output

Parameters:
parserDefine   &$element: 

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


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

[ Top ]
Convert_RIC  [line 680]

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

Convert README/INSTALL/CHANGELOG file contents to output format

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


Redefinition of:
Converter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format

[ Top ]
copyMediaRecursively  [line 1361]

  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


API Tags:
See:  Converter::endClass()
See:  registerCurrentClass()


Redefinition of:
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


API Tags:
See:  Converter::endPage()
See:  registerCurrent()


Redefinition of:
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.


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


Redefinition of:
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


API Tags:
See:  Converter::$page_elements, Converter::$class_elements, Converter::$function_elements


Redefinition of:
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


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


Redefinition of:
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

Parameters:
array   $toc:  format: array(array('tagname' => section, 'link' => returnsee link, 'id' => anchor name, 'title' => from title tag),...)

API Tags:
Return:  table of contents formatted for use in the current output format


Redefinition of:
Converter::formatTutorialTOC()
Creates a table of contents for a {@toc} inline tag in a tutorial

[ Top ]
generateElementIndex  [line 1322]

  void generateElementIndex( )

Generate alphabetical index of all elements


API Tags:
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

Parameters:
parserClass   $class:  class variable

API Tags:
Return:  Format: array(root,child,child,child,...,$class)
Uses:  parserClass::getParentClassTree()


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

[ Top ]
generateFormattedClassTrees  [line 1023]

  void generateFormattedClassTrees( string $package  )

returns a template-enabled array of class trees

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

API Tags:
See:  $roots, HTMLConverter::getRootTree()


[ Top ]
generateFormattedInterfaceTrees  [line 1077]

  void generateFormattedInterfaceTrees( string $package  )

returns a template-enabled array of interface inheritance trees

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

API Tags:
See:  $roots, HTMLConverter::getRootTree()


[ Top ]
generateKLinks  [line 1816]

  string generateKLinks( )

Get the table of contents for index.hhk


API Tags:
Return:  contents of tocentry.tpl generated from $KLinks

Information Tags:
Author:  Andrew Eddie <eddieajau@users.sourceforge.net>

[ Top ]
generatePkgElementIndex  [line 1426]

  void generatePkgElementIndex( string $package  )

Generate alphabetical index of all elements by package and subpackage

Parameters:
string   $package:  name of a package

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


[ Top ]
generatePkgElementIndexes  [line 1477]

  void generatePkgElementIndexes( )


API Tags:
See:  CHMdefaultConverter::generatePkgElementIndex()


[ Top ]
generateTOC  [line 1710]

  void generateTOC( )


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


[ Top ]
getCData  [line 759]

  void getCData( $value  )

Parameters:
   $value: 


[ Top ]
getClassLink  [line 1517]

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

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

API Tags:
Return:  false if not found, or an html a link to the class's documentation
See:  Converter::getClassLink()


Redefinition of:
Converter::getClassLink()
return false or a classLink to $expr

[ Top ]
getConstLink  [line 1632]

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

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

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


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

[ Top ]
getCurrentPageLink  [line 289]

  void getCurrentPageLink( )



Redefinition of:
Converter::getCurrentPageLink()

[ Top ]
getDefineLink  [line 1549]

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

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

API Tags:
Return:  false if not found, or an html a link to the define's documentation
See:  Converter::getDefineLink()


Redefinition of:
Converter::getDefineLink()
return false or a defineLink to $expr

[ Top ]
getExampleLink  [line 199]

  void getExampleLink( $path, $title  )

Parameters:
   $path: 
   $title: 


[ Top ]
getFunctionLink  [line 1533]

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

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

API Tags:
Return:  false if not found, or an html a link to the function's documentation
See:  Converter::getFunctionLink()


Redefinition of:
Converter::getFunctionLink()
return false or a functionLink to $expr

[ Top ]
getGlobalLink  [line 1565]

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

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

API Tags:
Return:  false if not found, or an html a link to the global variable's documentation
See:  Converter::getGlobalLink()


Redefinition of:
Converter::getGlobalLink()
return false or a globalLink to $expr

[ Top ]
getId  [line 591]

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

Parameters:
   $element: 
   $fullpath: 


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

[ Top ]
getIndexInformation  [line 1205]

  array getIndexInformation( parserElement $elt  )

Generate indexing information for given element

Parameters:
parserElement   $elt:  descendant of parserElement

API Tags:
See:  CHMdefaultConverter::generateElementIndex()


[ Top ]
getMethodLink  [line 1598]

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

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

API Tags:
Return:  false if not found, or an html a link to the method's documentation
See:  Converter::getMethodLink()


Redefinition of:
Converter::getMethodLink()
return false or a methodLink to $expr in $class

[ Top ]
getPageLink  [line 1581]

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

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

API Tags:
Return:  false if not found, or an html a link to the procedural page's documentation
See:  Converter::getPageLink()


Redefinition of:
Converter::getPageLink()
return false or a pageLink to $expr

[ 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

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

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


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

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

API Tags:
Return:  link to an anchor, or the anchor


[ Top ]
getSourceLink  [line 204]

  void getSourceLink( $path  )

Parameters:
   $path: 


Redefinition of:
Converter::getSourceLink()

[ Top ]
getTutorialId  [line 764]

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

Parameters:
   $package: 
   $subpackage: 
   $tutorial: 
   $id: 


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

[ Top ]
getVarLink  [line 1615]

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

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

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


Redefinition of:
Converter::getVarLink()
return false or a varLink to $expr in $class

[ Top ]
Output  [line 1860]

  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:

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


API Tags:
Uses:  CHMdefaultConverter::generateTOC() - assigns to the toc template variable

Information Tags:
Link:  http://www.microsoft.com/downloads/release.asp?releaseid=33071
Todo:  use to directly call html help compiler hhc.exe

Redefinition of:
Converter::Output()
do all necessary output

[ Top ]
postProcess  [line 297]

  void postProcess( $text  )

Uses htmlspecialchars() on the input

Parameters:
   $text: 


Redefinition of:
Converter::postProcess()
This version does nothing

[ 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

Parameters:
string   $example: 
boolean   $tutorial: 
   $inlinesourceparse: 
   $class: 
   $linenum: 
   $filesourcepath: 


Redefinition of:
Converter::ProgramExample()
Used to convert the <code> tag in a docblock

[ Top ]
rcNatCmp  [line 1646]

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

  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  )

Parameters:
string   $link: 
string   $text: 

API Tags:
Return:  &lt;a href="'.$link.'">'.$text.'</a&gt;


Redefinition of:
Converter::returnLink()
take URL $link and text $text and return a link in the format needed for the Converter

[ 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

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


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

[ Top ]
setTargetDir  [line 1406]

  void setTargetDir( $dir  )

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

Parameters:
   $dir: 

API Tags:
See:  Converter::setTargetDir()


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

[ Top ]
setTemplateDir  [line 1355]

  void setTemplateDir( $dir  )

Parameters:
   $dir: 


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

[ 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

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.

API Tags:
Return:  formatted source code line with line number


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

[ Top ]
TutorialExample  [line 275]

  void TutorialExample( string $example  )

Parameters:
string   $example: 


Redefinition of:
Converter::TutorialExample()

[ Top ]
unmangle  [line 144]

  void unmangle( $sourcecode  )

Parameters:
   $sourcecode: 

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


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

[ Top ]
writeExample  [line 179]

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

Parameters:
   $title: 
   $path: 
   $source: 


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

[ Top ]
writefile  [line 1692]

  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

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

Parameters:
   $file: 
   $contents: 


[ Top ]
writeNewPPage  [line 491]

  void writeNewPPage( $key  )

Parameters:
   $key: 


[ Top ]
writeSource  [line 160]

  void writeSource( string $path, string $value  )

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


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

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:16:32 -0600 by phpDocumentor 1.4.4