Base class for all output converters.
The Converter marks the final stage in phpDocumentor. phpDocumentor works in this order:
Parsing => Intermediate Parsing organization => Conversion to output
A Converter takes output from the phpDocumentor_IntermediateParser and converts it to output. With version 1.2, phpDocumentor includes a variety of output converters:
Located in /PEAR/PhpDocumentor/phpDocumentor/Converter.inc (line 74)
| Class | Description |
|---|---|
| CHMdefaultConverter | Generates files that MS HTML Help Worshop can use to create a MS Windows compiled help file (CHM) |
| XMLDocBookpeardoc2Converter | XML DocBook converter. |
| XMLDocBookConverter | XML DocBook converter. |
| HTMLSmartyConverter | HTML output converter. |
| HTMLframesConverter | HTML output converter. |
| PDFdefaultConverter | PDF output converter. |
All packages encountered in parsing
set to a classname if currently parsing a class, false if not
alphabetical index of all methods and vars in a class by package/subpackage
The class itself has a link under ###main
template for the class currently being processed
alphabetized index of classes by package
full path of the current file being converted
current procedural page being processed
alphabetized index of defines by package
alphabetical index of all elements
alphabetized index of functions by package
alphabetized index of global variables by package
Flag used to help converters determine whether to do special source highlighting
Controls which of the one-element-only indexes are generated.
Generation of these indexes for large packages is time-consuming. This is an optimization feature. An example of how to use this is in HTMLframesConverter::$leftindex, and in HTMLframesConverter::formatLeftIndex(). These indexes are intended for use as navigational aids through documentation, but can be used for anything by converters.
output format of this converter
in Child converters, this will match the first part of the -o command-line as in -o HTML:frames:default "HTML"
package name currently being converted
Packages associated with categories
Used by the XML:DocBook/peardoc2 converter, and available to others, to group many packages into categories
alphabetical index of all elements sorted by package, subpackage, page, and class.
set to value of -po commandline
Hierarchy of packages
Every package that contains classes may have parent or child classes in other packages. In other words, this code is legal:
In this case, package one is a parent of package two
name of current page being converted
alphabetical index of all elements on a page by package/subpackage
The page itself has a link under ###main
template for the procedural page currently being processed
alphabetized index of procedural pages by package
controls processing of elements marked private with @access private
defaults to false. Set with command-line --parseprivate or -pp
path of current page being converted
alphabetical index of all elements, indexed by package/subpackage
This converter knows about the new root tree processing
In order to fix PEAR Bug #6389
controls display of progress information while parsing.
defaults to false. Set to true for cron jobs or other situations where no visual output is necessary
Directory that the smarty templates are in
This is used if the content must be passed in the order it should be read, i.e. by package, procedural then classes
This fixes bug 637921, and is used by PDFdefaultConverter
This determines whether the $page_contents array should be sorted by element type as well as alphabetically by name
A list of files that have had source code generated
subpackage name currently being converted
directory that output is sent to. -t command-line sets this.
Directory that the template is in, relative to phpDocumentor root directory
Name of the template, from last part of -o
Options for each template, parsed from the options.ini file in the template base directory
Initialize Converter data structures
Convert the attribute of a Tutorial docbook tag's attribute list
to a string based on the template options.ini
Used to convert the contents of <b> in a docblock
Used to convert <br> in a docblock
Compare parserStringWithInlineTags::Convert() cache state to $state
Convert all elements to output format
This will call ConvertXxx where Xxx is http://www.php.net/ucfirst($element->type). It is expected that a child converter defines a handler for every element type, even if that handler does nothing. phpDocumentor will terminate with an error if a handler doesn't exist.
Default Class Handler
Conversion Handlers
All of the convert* handlers set up template variables for the Smarty template. Sets up the class template. {@, getFormattedConflicts, getFormattedInheritedMethods, and getFormattedInheritedVars are called to complete vital template setup.}}
Converts class constants for template output.
Conversion Handlers
All of the convert* handlers set up template variables for the Smarty template.
This function must be called by a child converter with any extra template variables needed in the parameter $addition
Converts defines for template output
Conversion Handlers
All of the convert* handlers set up template variables for the Smarty template. This function must be called by a child converter with any extra template variables needed in the parameter $addition {@, this method also uses utility functions getGlobalValue(), getFormattedConflicts()}}
Convert the phpDocumentor parsing/conversion error log
Converts function for template output
Conversion Handlers
All of the convert* handlers set up template variables for the Smarty template. This function must be called by a child converter with any extra template variables needed in the parameter $addition
Converts global variables for template output
Conversion Handlers
All of the convert* handlers set up template variables for the Smarty template. This function must be called by a child converter with any extra template variables needed in the parameter $addition {@, this method also uses utility functions getGlobalValue(), getFormattedConflicts()}}
Converts includes for template output
Conversion Handlers
All of the convert* handlers set up template variables for the Smarty template. This function must be called by a child converter with any extra template variables needed in the parameter $addition