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

Class: Converter

Source Location: /PEAR/PhpDocumentor/phpDocumentor/Converter.inc

Class Overview


Base class for all output converters.


Author(s):

Version:

  • $Id: Converter.inc,v 1.39 2007/12/19 02:16:49 ashnazg Exp $

Variables

Methods


Child classes:

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.

Class Details

[line 74]
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:

{@ and using walk() or walk_everything (depending on the value of $sort_absolutely_everything) it "walks" over an array of phpDocumentor elements.}}




Tags:

author:  Greg Beaver <cellog@php.net>
version:  $Id: Converter.inc,v 1.39 2007/12/19 02:16:49 ashnazg Exp $
abstract:  
since:  1.0rc1


[ Top ]


Class Variables

$all_packages =

[line 366]

All packages encountered in parsing



Tags:


Type:   array


[ Top ]

$class =  false

[line 105]

set to a classname if currently parsing a class, false if not


Type:   string|false


[ Top ]

$classes =

[line 319]

All class information, organized by path, and by package


Type:   Classes


[ Top ]

$class_contents = array()

[line 269]

alphabetical index of all methods and vars in a class by package/subpackage

The class itself has a link under ###main




Tags:

var:  Format:
 array(package =>
       array(subpackage =>
             array(path =>
                   array(class =>
                         array(abstractLink descendant 1, ...
                        )
                  )
            )
      )
see:  Converter::formatLeftIndex()

Type:   array


[ Top ]

$class_data =

[line 165]

template for the class currently being processed


Type:   Smarty


[ Top ]

$class_elements = array()

[line 208]

alphabetized index of classes by package



Tags:

var:  Format: array(package => array(subpackage => array(classLink 1,classLink 2,...)
see:  Converter::$leftindex

Type:   array


[ Top ]

$curfile =

[line 313]

full path of the current file being converted


Type:   mixed


[ Top ]

$curpage =

[line 171]

current procedural page being processed


Type:   parserPage


[ Top ]

$define_elements = array()

[line 201]

alphabetized index of defines by package



Tags:

var:  Format: array(package => array(subpackage => array(defineLink 1,defineLink 2,...)
see:  Converter::$leftindex

Type:   array


[ Top ]

$elements = array()

[line 187]

alphabetical index of all elements



Tags:

var:  Format: array(first letter of element name => array(parserElement or parserPage,...))
see:  Converter::formatIndex(), HTMLframesConverter::formatIndex()

Type:   array


[ Top ]

$function_elements = array()

[line 222]

alphabetized index of functions by package



Tags:

var:  Format: array(package => array(subpackage => array(functionLink 1,functionLink 2,...)
see:  Converter::$leftindex

Type:   array


[ Top ]

$global_elements = array()

[line 215]

alphabetized index of global variables by package



Tags:

var:  Format: array(package => array(subpackage => array(globalLink 1,globalLink 2,...)
see:  Converter::$leftindex

Type:   array


[ Top ]

$highlightingSource =  false

[line 325]

Flag used to help converters determine whether to do special source highlighting


Type:   boolean


[ Top ]

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

[line 384]

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.




Tags:


Type:   array


[ Top ]

$outputformat =  'Generic'

[line 90]

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"




Tags:

tutorial:  phpDocumentor Tutorial

Type:   string


[ Top ]

$package =  'default'

[line 95]

package name currently being converted


Type:   string


[ Top ]

$packagecategories =

[line 359]

Packages associated with categories

Used by the XML:DocBook/peardoc2 converter, and available to others, to group many packages into categories




Tags:


Type:   array


[ Top ]

$package_elements = array()

[line 180]

alphabetical index of all elements sorted by package, subpackage, page, and class.



Tags:

var:  Format: array(package => array(subpackage => array('page'|'class' => array(path|classname => array(element, element,...)))))
uses:  Converter::$sort_absolutely_everything - if true, then $package_elements is used, otherwise, the ParserData::$classelements and ParserData::$pageelements variables are used

Type:   array


[ Top ]

$package_output =

[line 141]

set to value of -po commandline



Tags:

tutorial:  phpDocumentor Tutorial

Type:   mixed


[ Top ]

$package_parents =

[line 349]

Hierarchy of packages

Every package that contains classes may have parent or child classes in other packages. In other words, this code is legal:

  1.  

In this case, package one is a parent of package two




Tags:


Type:   array


[ Top ]

$page =

[line 147]

name of current page being converted


Type:   string


[ Top ]

$page_contents = array()

[line 238]

alphabetical index of all elements on a page by package/subpackage

The page itself has a link under ###main




Tags:

var:  Format: array(package => array(subpackage => array(path => array(abstractLink descendant 1, ...)))
see:  Converter::formatLeftIndex()

Type:   array


[ Top ]

$page_data =

[line 159]

template for the procedural page currently being processed


Type:   Smarty


[ Top ]

$page_elements = array()

[line 194]

alphabetized index of procedural pages by package



Tags:

var:  Format: array(package => array(subpackage => array(pageLink 1,pageLink 2,...)
see:  Converter::$leftindex

Type:   array


[ Top ]

$parseprivate =

[line 276]

controls processing of elements marked private with @access private

defaults to false. Set with command-line --parseprivate or -pp



Type:   bool


[ Top ]

$path =

[line 153]

path of current page being converted


Type:   string


[ Top ]

$pkg_elements = array()

[line 229]

alphabetical index of all elements, indexed by package/subpackage



Tags:

var:  Format: array(first letter of element name => array(parserElement or parserPage,...))
see:  Converter::formatPkgIndex(), HTMLframesConverter::formatPkgIndex()

Type:   array


[ Top ]

$processSpecialRoots =  false

[line 81]

This converter knows about the new root tree processing

In order to fix PEAR Bug #6389



Type:   boolean


[ Top ]

$quietmode =

[line 283]

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



Type:   bool


[ Top ]

$smarty_dir =  ''

[line 301]

Directory that the smarty templates are in


Type:   string


[ Top ]

$sort_absolutely_everything =  false

[line 251]

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




Tags:

usedby:  Converter::$package_elements - if true, then $package_elements is used, otherwise, the ParserData::$classelements and ParserData::$pageelements variables are used

Type:   mixed


[ Top ]

$sort_page_contents_by_type =  false

[line 245]

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



Tags:


Type:   boolean


[ Top ]

$sourcePaths = array()

[line 372]

A list of files that have had source code generated


Type:   array


[ Top ]

$subpackage =  ''

[line 100]

subpackage name currently being converted


Type:   string


[ Top ]

$targetDir =  ''

[line 289]

directory that output is sent to. -t command-line sets this.



Tags:

tutorial:  phpDocumentor Tutorial

Type:   mixed


[ Top ]

$templateDir =  ''

[line 295]

Directory that the template is in, relative to phpDocumentor root directory


Type:   string


[ Top ]

$templateName =  ''

[line 308]

Name of the template, from last part of -o



Tags:

tutorial:  phpDocumentor Tutorial

Type:   string


[ Top ]

$template_options =

[line 399]

Options for each template, parsed from the options.ini file in the template base directory



Tags:


Type:   array


[ Top ]

$title =  'Generated Documentation'

[line 392]



Tags:


Type:   string


[ Top ]

$todoList = array()

[line 429]

List of all @todo tags and a link to the element with the @todo

Format: array(package => array(link to element, array(todo parserTag,...)),...)




Tags:

tutorial:  @todo

Type:   array


[ Top ]



Class Methods


constructor Converter [line 452]

Converter Converter( array &$allp, array &$packp, Classes &$classes, ProceduralPages &$procpages, array $po, boolean $pp, boolean $qm, string $targetDir, string $template, string $title)

Initialize Converter data structures



Parameters:

array   &$allp   $all_packages value
array   &$packp   $package_parents value
Classes   &$classes   $classes value
ProceduralPages   &$procpages   $proceduralpages value
array   $po   $package_output value
boolean   $pp   $parseprivate value
boolean   $qm   $quietmode value
string   $targetDir   $targetDir value
string   $template   $templateDir value
string   $title   (@link $title} value

[ Top ]

method AttrToString [line 1307]

string AttrToString( string $tag, attribute $attr, [boolean $unmodified = false])

Convert the attribute of a Tutorial docbook tag's attribute list

to a string based on the template options.ini




Parameters:

string   $tag   tag name
attribute   $attr   array
boolean   $unmodified   if true, returns attrname="value"...

[ Top ]

method Bolden [line 931]

string Bolden( string $para)

Used to convert the contents of <b> in a docblock



Tags:

usedby:  parserB::Convert()


Parameters:

string   $para  

[ Top ]

method Br [line 1001]

string Br( string $para)

Used to convert <br> in a docblock



Tags:

usedby:  parserBr::Convert()


Overridden in child classes as:

XMLDocBookpeardoc2Converter::Br()

Parameters:

string   $para  

[ Top ]

method checkState [line 5362]

void checkState( mixed $state)

Compare parserStringWithInlineTags::Convert() cache state to $state



Tags:



Parameters:

mixed   $state  

[ Top ]

method cleanup [line 5073]

void cleanup( )

Finish up parsing/cleanup directories



[ Top ]

method Convert [line 3978]

void Convert( mixed &$element)

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.




Tags:

throws:  PDERROR_NO_CONVERT_HANDLER


Parameters:

mixed   &$element   parserElement descendant or parserPackagePage or parserData

[ Top ]

method convertClass [line 4042]

void convertClass( &$element)

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




Overridden in child classes as:

CHMdefaultConverter::convertClass()
Converts class for template output
XMLDocBookpeardoc2Converter::convertClass()
Converts class for template output
XMLDocBookConverter::convertClass()
Converts class for template output
HTMLSmartyConverter::convertClass()
Converts class for template output
HTMLframesConverter::convertClass()
Converts class for template output
PDFdefaultConverter::convertClass()

Parameters:

   &$element  

[ Top ]

method convertConst [line 4213]

void convertConst( parserConst &$element, [ $additions = array()])

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




Overridden in child classes as:

CHMdefaultConverter::convertConst()
Converts class constants for template output
HTMLSmartyConverter::convertConst()
Converts class variables for template output
HTMLframesConverter::convertConst()
Converts class variables for template output
PDFdefaultConverter::convertConst()

Parameters:

parserConst   &$element  
   $additions  

[ Top ]

method convertDefine [line 4330]

void convertDefine( parserDefine &$element, [array $addition = array()])

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




Tags:

uses:  Converter::postProcess() - on define_value template value, makes it displayable


Overridden in child classes as:

CHMdefaultConverter::convertDefine()
Converts defines for template output
XMLDocBookpeardoc2Converter::convertDefine()
Converts defines for template output
XMLDocBookConverter::convertDefine()
Converts defines for template output
HTMLSmartyConverter::convertDefine()
Converts defines for template output
HTMLframesConverter::convertDefine()
Converts defines for template output
PDFdefaultConverter::convertDefine()

Parameters:

parserDefine   &$element  
array   $addition   any additional template variables should be in this array

[ Top ]

method ConvertErrorLog [line 2422]

void ConvertErrorLog( )

Convert the phpDocumentor parsing/conversion error log



Tags:

abstract:  


Overridden in child classes as:

CHMdefaultConverter::ConvertErrorLog()
Create errors.html template file output
XMLDocBookpeardoc2Converter::ConvertErrorLog()
Create errors.html template file output
XMLDocBookConverter::ConvertErrorLog()
Create errors.html template file output
HTMLSmartyConverter::ConvertErrorLog()
Create errors.html template file output
HTMLframesConverter::ConvertErrorLog()
Create errors.html template file output

[ Top ]

method convertFunction [line 4387]

void convertFunction( parserFunction &$element, [ $addition = array()])

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




Tags:



Overridden in child classes as:

CHMdefaultConverter::convertFunction()
Converts function for template output
XMLDocBookpeardoc2Converter::convertFunction()
Converts function for template output - does nothing in peardoc2!
XMLDocBookConverter::convertFunction()
Converts function for template output
HTMLSmartyConverter::convertFunction()
Converts function for template output
HTMLframesConverter::convertFunction()
Converts function for template output
PDFdefaultConverter::convertFunction()

Parameters:

parserFunction   &$element  
   $addition  

[ Top ]

method convertGlobal [line 4296]

void convertGlobal( parserGlobal &$element, [array $addition = array()])

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




Tags:

uses:  Converter::postProcess() - on global_value template value, makes it displayable


Overridden in child classes as:

CHMdefaultConverter::convertGlobal()
Converts global variables for template output
XMLDocBookpeardoc2Converter::convertGlobal()
Converts global variables for template output
XMLDocBookConverter::convertGlobal()
Converts global variables for template output
HTMLSmartyConverter::convertGlobal()
Converts global variables for template output
HTMLframesConverter::convertGlobal()
Converts global variables for template output
PDFdefaultConverter::convertGlobal()

Parameters:

parserGlobal   &$element  
array   $addition   any additional template variables should be in this array

[ Top ]

method convertInclude [line 4359]

void convertInclude( parserInclude &$element, [ $addition = array()])

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




Tags:



Overridden in child classes as:

CHMdefaultConverter::convertInclude()
Converts include elements for template output
XMLDocBookpeardoc2Converter::convertInclude()
Converts include elements for template output
XMLDocBookConverter::convertInclude()
Converts include elements for template output
HTMLSmartyConverter::convertInclude()
Converts include elements for template output
HTMLframesConverter::convertInclude()
Converts include elements for template output
PDFdefaultConverter::convertInclude()

Parameters:

parserInclude   &$element  
   $addition  

[ Top ]

method convertMethod [line 4109]

void convertMethod( parserMethod &$element, [ $additions = array()])

Converts method 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




Overridden in child classes as:

CHMdefaultConverter::convertMethod()
Converts class methods for template output
XMLDocBookpeardoc2Converter::convertMethod()
Converts method for template output
XMLDocBookConverter::convertMethod()
Converts method for template output
HTMLSmartyConverter::convertMethod()
Converts class methods for template output
HTMLframesConverter::convertMethod()
Converts class methods for template output
PDFdefaultConverter::convertMethod()

Parameters:

parserMethod   &$element  
   $additions  

[ Top ]

method convertPage [line 4250]

void convertPage( parserPage &$element)

Default Page Handler

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. {@, this class uses getSourceLocation() and getClassesOnPage() to set template variables. Also used is getPageName(), to get a Converter-specific name for the page.}}




Overridden in child classes as:

CHMdefaultConverter::convertPage()
converts procedural pages for template output
XMLDocBookpeardoc2Converter::convertPage()
converts procedural pages for template output
XMLDocBookConverter::convertPage()
converts procedural pages for template output
HTMLSmartyConverter::convertPage()
converts procedural pages for template output
HTMLframesConverter::convertPage()
converts procedural pages for template output
PDFdefaultConverter::convertPage()

Parameters:

parserPage   &$element  

[ Top ]

method ConvertTitle [line 1396]

string ConvertTitle( string $tag, array $attr, string $title, string $cdata)

Convert the title of a Tutorial docbook tag section

to a string based on the template options.ini




Parameters:

string   $tag   tag name
array   $attr  
string   $title   title text
string   $cdata  

[ Top ]

method ConvertTodoList [line 2430]

void ConvertTodoList( )

Convert the list of all @todo tags



Tags:

abstract:  


Overridden in child classes as:

CHMdefaultConverter::ConvertTodoList()
HTMLSmartyConverter::ConvertTodoList()
HTMLframesConverter::ConvertTodoList()

[ Top ]

method convertTutorial [line 4006]

void &convertTutorial( parserTutorial &$element)

Default Tutorial Handler

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. Sets up the tutorial template, and its prev/next/parent links {@ and uses the parserTutorial::prev, parserTutorial::next, parserTutorial::parent links to set up those links.}}




Overridden in child classes as:

CHMdefaultConverter::convertTutorial()
XMLDocBookpeardoc2Converter::convertTutorial()
Convert tutorials for output
XMLDocBookConverter::convertTutorial()
HTMLSmartyConverter::convertTutorial()
HTMLframesConverter::convertTutorial()
PDFdefaultConverter::convertTutorial()

Parameters:

parserTutorial   &$element  

[ Top ]

method convertVar [line 4169]

void convertVar( parserVar &$element, [ $additions = array()])

Converts class 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




Overridden in child classes as:

CHMdefaultConverter::convertVar()
Converts class variables for template output
XMLDocBookpeardoc2Converter::convertVar()
Does nothing in this converter
XMLDocBookConverter::convertVar()
Converts class variables for template output.
HTMLSmartyConverter::convertVar()
Converts class variables for template output
HTMLframesConverter::convertVar()
Converts class variables for template output
PDFdefaultConverter::convertVar()

Parameters:

parserVar   &$element  
   $additions  

[ Top ]

method Convert_RIC [line 3958]

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

Convert README/INSTALL/CHANGELOG file contents to output format



Tags:

abstract:  


Overridden in child classes as:

CHMdefaultConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
HTMLSmartyConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
HTMLframesConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format
PDFdefaultConverter::Convert_RIC()
Convert README/INSTALL/CHANGELOG file contents to output format

Parameters:

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

[ Top ]

method copyFile [line 5337]

void copyFile( string $file, [ $subdir = ''])

Copies a file from the template directory to the target directory

thanks to Robert Hoffmann for this fix




Parameters:

string   $file  
   $subdir  

[ Top ]

method createParentDir [line 5253]

void createParentDir( string $dir)

Recursively creates all subdirectories that don't exist in the $dir path



Parameters:

string   $dir  

[ Top ]

method EncloseList [line 888]

string EncloseList( string $list, $ordered)

Used to convert the contents of <ol> or <ul> in a docblock



Tags:

usedby:  parserList::Convert() - enclose the list


Parameters:

string   $list  
   $ordered  

[ Top ]

method EncloseParagraph [line 917]

string EncloseParagraph( string $para)

Used to enclose a paragraph in a docblock



Parameters:

string   $para  

[ Top ]

method endClass [line 507]

void endClass( )

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

A Converter can use this method in any way it pleases. HTMLframesConverter uses it to complete the template for the class and to output its documentation




Tags:

see:  HTMLframesConverter::endClass()
abstract:  


Overridden in child classes as:

CHMdefaultConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
XMLDocBookpeardoc2Converter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
XMLDocBookConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
HTMLSmartyConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory
HTMLframesConverter::endClass()
Writes out the template file of $class_data and unsets the template to save memory

[ Top ]

method endPage [line 521]

void endPage( )

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

A Converter can use this method in any way it pleases. HTMLframesConverter uses it to complete the template for the procedural page and to output its documentation




Tags:

see:  HTMLframesConverter::endClass()
abstract:  


Overridden in child classes as:

CHMdefaultConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
XMLDocBookConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
HTMLSmartyConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory
HTMLframesConverter::endPage()
Writes out the template file of $page_data and unsets the template to save memory

[ Top ]

method exampleProgramExample [line 773]

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

Used to convert the {@example} inline tag in a docblock.

By default, this just wraps ProgramExample




Tags:

see:  XMLDocBookpeardoc2Converter::exampleProgramExample


Overridden in child classes as:

XMLDocBookpeardoc2Converter::exampleProgramExample()
Used to convert the {@example} inline tag in a docblock.

Parameters:

string   $example  
boolean   $tutorial   true if this is to highlight a tutorial <programlisting>
   $inlinesourceparse  
   $class  
   $linenum  
   $filesourcepath  

[ Top ]

method flushHighlightCache [line 609]

string flushHighlightCache( )

Return the close text for the current token



[ Top ]

method formatIndex [line 545]

void formatIndex( )

Called by walk() while converting.

This method is intended to be the place that $elements is formatted for output.




Tags:

see:  HTMLframesConverter::formatIndex()
abstract:  


Overridden in child classes as:

CHMdefaultConverter::formatIndex()
CHMdefaultConverter uses this function to format template index.html and packages.html
XMLDocBookpeardoc2Converter::formatIndex()
Does nothing
XMLDocBookConverter::formatIndex()
HTMLdefaultConverter uses this function to format template index.html and packages.html
HTMLSmartyConverter::formatIndex()
HTMLdefaultConverter uses this function to format template index.html and packages.html
HTMLframesConverter::formatIndex()
HTMLdefaultConverter uses this function to format template index.html and packages.html

[ Top ]

method formatLeftIndex [line 559]

void formatLeftIndex( )

Called by walk() while converting.

This method is intended to be the place that any of $class_elements, $function_elements, $page_elements, $define_elements, and $global_elements is formatted for output, depending on the value of $leftindex




Tags:



Overridden in child classes as:

CHMdefaultConverter::formatLeftIndex()
Generate indexes for li_package.html and classtree output files
XMLDocBookpeardoc2Converter::formatLeftIndex()
Creates package/lang/categoryname/packagename.xml for each package
XMLDocBookConverter::formatLeftIndex()
Generate indexes for li_package.html and classtree output files
HTMLSmartyConverter::formatLeftIndex()
Generate indexes for li_package.html and classtree output files
HTMLframesConverter::formatLeftIndex()
Generate indexes for li_package.html and classtree output files

[ Top ]

method formatPkgIndex [line 533]

void formatPkgIndex( )

Called by walk() while converting.

This method is intended to be the place that $pkg_elements is formatted for output.




Tags:



Overridden in child classes as:

CHMdefaultConverter::formatPkgIndex()
CHMdefaultConverter chooses to format both package indexes and the complete index here
XMLDocBookpeardoc2Converter::formatPkgIndex()
Does nothing
XMLDocBookConverter::formatPkgIndex()
HTMLdefaultConverter chooses to format both package indexes and the complete index here
HTMLSmartyConverter::formatPkgIndex()
HTMLdefaultConverter chooses to format both package indexes and the complete index here
HTMLframesConverter::formatPkgIndex()
HTMLdefaultConverter chooses to format both package indexes and the complete index here

[ Top ]

method formatTutorialTOC [line 1030]

string formatTutorialTOC( array $toc)

Creates a table of contents for a {@toc} inline tag in a tutorial

This function should return a formatted table of contents. By default, it does nothing, it is up to the converter to format the TOC




Tags:

return:  table of contents formatted for use in the current output format
abstract:  
usedby:  parserTocInlineTag::Convert() - passes an array of format:


Overridden in child classes as:

CHMdefaultConverter::formatTutorialTOC()
Use the template tutorial_toc.tpl to generate a table of contents for HTML
HTMLSmartyConverter::formatTutorialTOC()
Use the template tutorial_toc.tpl to generate a table of contents for HTML
HTMLframesConverter::formatTutorialTOC()
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),...)

[ Top ]

method generateChildClassList [line 4790]

void generateChildClassList( parserClass $class)

returns a list of child classes



Tags:



Overridden in child classes as:

XMLDocBookpeardoc2Converter::generateChildClassList()
returns a list of child classes

Parameters:

parserClass   $class   class variable

[ Top ]

method generateFormattedClassTree [line 4637]

string generateFormattedClassTree( parserClass $class)

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

This method must be overridden, or phpDocumentor will halt with a fatal error




Tags:

return:  Converter-specific class tree for an individual class
abstract:  


Overridden in child classes as:

CHMdefaultConverter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
XMLDocBookpeardoc2Converter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
XMLDocBookConverter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
HTMLSmartyConverter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class
HTMLframesConverter::generateFormattedClassTree()
returns an array containing the class inheritance tree from the root object to the class

Parameters: