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

Class: Converter

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/Converter.inc

Class Overview


Base class for all output converters.


Author(s):

Version:

  • $Id$

Variables

Methods


Child classes:

PDFdefaultConverter
PDF output converter.
XMLDocBookConverter
XML DocBook converter.
XMLDocBookpeardoc2Converter
XML DocBook converter.
CHMdefaultConverter
Generates files that MS HTML Help Worshop can use to create a MS Windows compiled help file (CHM)
HTMLSmartyConverter
HTML output converter.
HTMLframesConverter
HTML output converter.

Inherited Variables

Inherited Methods


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

  • Author: Greg Beaver <cellog@php.net>
  • Version: $Id$
  • Abstract:
  • Since: 1.0rc1


[ Top ]


Class Variables

$all_packages =

[line 366]

All packages encountered in parsing

Type:   array


[ Top ]

$charset =  'iso-8859-1'

[line 398]


Type:   string


[ 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


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

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

Type:   array


[ Top ]

$elements = array()

[line 187]

alphabetical index of all elements

Type:   array


[ Top ]

$function_elements = array()

[line 222]

alphabetized index of functions by package

Type:   array


[ Top ]

$global_elements = array()

[line 215]

alphabetized index of global variables by package

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.


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"


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


Type:   array


[ Top ]

$package_elements = array()

[line 180]

alphabetical index of all elements sorted by package, subpackage, page, and class.
  • 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

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:

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


    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


    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

    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

    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

    • 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

    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.

    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

    Type:   string


    [ Top ]

    $template_options =

    [line 405]

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

    Type:   array


    [ Top ]

    $title =  'Generated Documentation'

    [line 392]


    Type:   string


    [ Top ]

    $todoList = array()

    [line 435]

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

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


    Type:   array


    [ Top ]



    Method Detail

    Converter (Constructor)   [line 459]

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

    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
    string   $charset   —  (@link $charset} value

    [ Top ]

    AttrToString   [line 1319]

    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 ]

    Bolden   [line 939]

    string Bolden( string $para)

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

    Parameters:

    string   $para   — 

    [ Top ]

    Br   [line 1009]

    string Br( string $para)

    Used to convert <br> in a docblock

    Overridden in child classes as:

    XMLDocBookpeardoc2Converter::Br()

    Parameters:

    string   $para   — 

    [ Top ]

    checkState   [line 5406]

    void checkState( mixed $state)

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

    Parameters:

    mixed   $state   — 

    [ Top ]

    cleanup   [line 5115]

    void cleanup( )

    Finish up parsing/cleanup directories

    [ Top ]

    Convert   [line 3994]

    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.

    • Throws: PDERROR_NO_CONVERT_HANDLER

    Parameters:

    mixed   &$element   —  parserElement descendant or parserPackagePage or parserData

    [ Top ]

    convertClass   [line 4058]

    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:

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

    Parameters:

       &$element   — 

    [ Top ]

    convertConst   [line 4245]

    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:

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

    Parameters:

    parserConst   &$element   — 
       $additions   — 

    [ Top ]

    convertDefine   [line 4370]

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


    Overridden in child classes as:

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

    Parameters:

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

    [ Top ]

    ConvertErrorLog   [line 2438]

    void ConvertErrorLog( )

    Convert the phpDocumentor parsing/conversion error log
    • Abstract:

    Overridden in child classes as:

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

    [ Top ]

    convertFunction   [line 4427]

    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


    Overridden in child classes as:

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

    Parameters:

    parserFunction   &$element   — 
       $addition   — 

    [ Top ]

    convertGlobal   [line 4336]

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


    Overridden in child classes as:

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

    Parameters:

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

    [ Top ]

    convertInclude   [line 4399]

    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


    Overridden in child classes as:

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

    Parameters:

    parserInclude   &$element   — 
       $addition   — 

    [ Top ]

    convertMethod   [line 4125]

    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:

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

    Parameters:

    parserMethod   &$element   — 
       $additions   — 

    [ Top ]

    convertPage   [line 4290]

    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:

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

    Parameters:

    parserPage   &$element   — 

    [ Top ]

    ConvertTitle   [line 1408]

    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 ]

    ConvertTodoList   [line 2446]

    void ConvertTodoList( )

    Convert the list of all @todo tags
    • Abstract:

    Overridden in child classes as:

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

    [ Top ]

    convertTutorial   [line 4022]

    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:

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

    Parameters:

    parserTutorial   &$element   — 

    [ Top ]

    convertVar   [line 4193]

    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:

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

    Parameters:

    parserVar   &$element   — 
       $additions   — 

    [ Top ]

    Convert_RIC   [line 3974]

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

    Convert README/INSTALL/CHANGELOG file contents to output format
    • Abstract:

    Overridden in child classes as:

    PDFdefaultConverter::Convert_RIC()
    Convert README/INSTALL/CHANGELOG file contents to output format
    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

    Parameters:

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

    [ Top ]

    copyFile   [line 5381]

    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 ]

    createParentDir   [line 5297]

    void createParentDir( string $dir)

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

    Parameters:

    string   $dir   — 

    [ Top ]

    EncloseList   [line 896]

    string EncloseList( string $list, $ordered)

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

    Parameters:

    string   $list   — 
       $ordered   — 

    [ Top ]

    EncloseParagraph   [line 925]

    string EncloseParagraph( string $para)

    Used to enclose a paragraph in a docblock

    Parameters:

    string   $para   — 

    [ Top ]

    endClass   [line 515]

    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


    Overridden in child classes as:

    XMLDocBookConverter::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
    CHMdefaultConverter::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 ]

    endPage   [line 529]

    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


    Overridden in child classes as:

    XMLDocBookConverter::endPage()
    Writes out the template file of $page_data and unsets the template to save memory
    CHMdefaultConverter::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 ]

    exampleProgramExample   [line 781]

    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

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

    flushHighlightCache   [line 617]

    string flushHighlightCache( )

    Return the close text for the current token

    [ Top ]

    formatIndex   [line 553]

    void formatIndex( )

    Called by walk() while converting.

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


    Overridden in child classes as:

    XMLDocBookConverter::formatIndex()
    HTMLdefaultConverter uses this function to format template index.html and packages.html
    XMLDocBookpeardoc2Converter::formatIndex()
    Does nothing
    CHMdefaultConverter::formatIndex()
    CHMdefaultConverter 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 ]

    formatLeftIndex   [line 567]

    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


    Overridden in child classes as:

    XMLDocBookConverter::formatLeftIndex()
    Generate indexes for li_package.html and classtree output files
    XMLDocBookpeardoc2Converter::formatLeftIndex()
    Creates package/lang/categoryname/packagename.xml for each package
    CHMdefaultConverter::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 ]

    formatPkgIndex   [line 541]

    void formatPkgIndex( )

    Called by walk() while converting.

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


    Overridden in child classes as:

    XMLDocBookConverter::formatPkgIndex()
    HTMLdefaultConverter chooses to format both package indexes and the complete index here
    XMLDocBookpeardoc2Converter::formatPkgIndex()
    Does nothing
    CHMdefaultConverter::formatPkgIndex()
    CHMdefaultConverter 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 ]

    formatTutorialTOC   [line 1038]

    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

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

    generateChildClassList   [line 4830]

    void generateChildClassList( parserClass $class)

    returns a list of child classes

    Overridden in child classes as:

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

    Parameters:

    parserClass   $class   —  class variable

    [ Top ]

    generateFormattedClassTree   [line 4677]

    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

    • Return: Converter-specific class tree for an individual class
    • Abstract:

    Overridden in child classes as:

    XMLDocBookConverter::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
    CHMdefaultConverter::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:

    parserClass   $class   —  class variable

    [ Top ]

    getClassesOnPage   [line 4629]

    array getClassesOnPage( parserData &$element)

    gets a list of all classes declared on a procedural page represented by

    $element, a parserData class

    • Return:

      links to each classes documentation

      Format:

       array('name' => class name,
             'sdesc' => summary of the class
             'link' => link to the class's documentation)


    Parameters:

    parserData   &$element   — 

    [ Top ]

    getClassLink   [line 3191]

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

    return false or a classLink to $expr
    • Return: returns a classLink or false if the element is not found in package $package
    • See: classLink

    Overridden in child classes as:

    PDFdefaultConverter::getClassLink()
    XMLDocBookConverter::getClassLink()
    XMLDocBookpeardoc2Converter::getClassLink()
    CHMdefaultConverter::getClassLink()
    HTMLSmartyConverter::getClassLink()
    HTMLframesConverter::getClassLink()

    Parameters:

    string   $expr   —  class name
    string   $package   —  package name
       $file   — 
       $text   — 

    [ Top ]

    getConstLink   [line 3366]

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

    return false or a constLink to $expr in $class
    • Return: returns a varLink or false if the element is not found in package $package, class $class
    • See: constLink

    Overridden in child classes as:

    PDFdefaultConverter::getConstLink()
    CHMdefaultConverter::getConstLink()
    HTMLSmartyConverter::getConstLink()
    HTMLframesConverter::getConstLink()

    Parameters:

    string   $expr   —  constant name
    string   $class   —  class name
    string   $package   —  package name
       $file   — 
       $text   — 

    [ Top ]

    getConverterDir   [line 5202]

    string getConverterDir( )

    Get the absolute path to the converter's base directory

    [ Top ]

    getCurrentPageLink   [line 1123]

    string getCurrentPageLink( )

    • Return: Link to the current page being parsed. Should return $curname and a converter-specific extension.
    • Abstract:

    Overridden in child classes as:

    CHMdefaultConverter::getCurrentPageLink()
    HTMLSmartyConverter::getCurrentPageLink()
    HTMLframesConverter::getCurrentPageLink()

    [ Top ]

    getCurrentPageURL   [line 1103]

    string getCurrentPageURL( string $pathinfo)

    Return the path to the current

    Parameters:

    string   $pathinfo   — 

    [ Top ]

    getDefineLink   [line 3239]

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

    return false or a defineLink to $expr
    • Return: returns a defineLink or false if the element is not found in package $package
    • See: defineLink

    Overridden in child classes as:

    PDFdefaultConverter::getDefineLink()
    XMLDocBookConverter::getDefineLink()
    XMLDocBookpeardoc2Converter::getDefineLink()
    CHMdefaultConverter::getDefineLink()
    HTMLSmartyConverter::getDefineLink()
    HTMLframesConverter::getDefineLink()

    Parameters:

    string   $expr   —  constant name
    string   $package   —  package name
       $file   — 
       $text   — 

    [ Top ]

    getFileSourceName   [line 1078]

    string getFileSourceName( $path, string $pathinfo)

    Translate the path info into a unique file name for the highlighted source code.

    Overridden in child classes as:

    PDFdefaultConverter::getFileSourceName()

    Parameters:

    string   $pathinfo   — 
       $path   — 

    [ Top ]

    getFileSourcePath   [line 1091]

    string getFileSourcePath( string $base)

    Return the fixed path to the source-code file folder.

    Parameters:

    string   $base   —  Path is relative to this folder

    [ Top ]

    getFormattedConflicts   [line 4730]

    array getFormattedConflicts( mixed &$element, string $type)


    Parameters:

    mixed   &$element   —  parserClass, parserFunction, parserDefine or parserGlobal
    string   $type   —  type to display. either 'class','function','define' or 'global variable'

    [ Top ]

    getFormattedDescMethods   [line 4750]

    array getFormattedDescMethods( parserMethod &$element)

    Get a list of methods in child classes that override this method

    Parameters:

    parserMethod   &$element   — 

    [ Top ]

    getFormattedDescVars   [line 4771]

    array getFormattedDescVars( parserVar &$element)

    Get a list of vars in child classes that override this var

    Parameters:

    parserVar   &$element   — 

    [ Top ]

    getFormattedImplements   [line 4693]

    string getFormattedImplements( parserClass $el)

    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

    • Return: Converter-specific class tree for an individual class
    • Abstract:

    Parameters:

    parserClass   $el   —  class variable

    [ Top ]

    getFormattedInheritedConsts   [line 5035]

    array getFormattedInheritedConsts( parserConst $child)

    Return template-enabled list of inherited class constants

    uses parserConst helper function getInheritedConsts and generates a template-enabled list using getClassLink()

    • Return: Format:
       array(
         array('parent_class' => link to parent class's documentation,
               'ivars' =>
                  array(
                    array('name' => inherited constant name,
                          'link' => link to inherited constant's documentation,
                          'value' => constant value,
                          'sdesc' => summary of inherited constant),
                    ...),
         ...)
    • See: Converter::getClassLink(), parserMethod::getInheritedConsts()

    Parameters:

    parserConst   $child   —  class constant

    [ Top ]

    getFormattedInheritedMethods   [line 4947]

    array getFormattedInheritedMethods( parserMethod $child)

    Return template-enabled list of inherited methods

    uses parserMethod helper function getInheritedMethods and generates a template-enabled list using getClassLink()

    • Return: Format:
       array(
         array('parent_class' => link to parent class's documentation,
               'ivars' =>
                  array(
                    array('name' => inherited variable name,
                          'link' => link to inherited variable's documentation,
                          'function_call' => parserMethod::getIntricateFunctionCall()
                                             returned array,
                          'sdesc' => summary of inherited variable),
                    ...),
         ...)
    • See: Converter::getClassLink(), parserMethod::getInheritedMethods()

    Parameters:

    parserMethod   $child   —  class method

    [ Top ]

    getFormattedInheritedVars   [line 4876]

    array getFormattedInheritedVars( parserVar $child)

    Return template-enabled list of inherited variables

    uses parserVar helper function getInheritedVars and generates a template-enabled list using getClassLink()

    • Return: Format:
       array(
         array('parent_class' => link to parent class's documentation,
               'ivars' =>
                  array(
                    array('name' => inherited variable name,
                          'link' => link to inherited variable's documentation,
                          'default' => default value of inherited variable,
                          'sdesc' => summary of inherited variable),
                    ...),
         ...)
    • See: Converter::getClassLink(), parserVar::getInheritedVars()

    Parameters:

    parserVar   $child   —  class var

    [ Top ]

    getFormattedMethodImplements   [line 4809]

    array|false getFormattedMethodImplements( parserMethod &$element)

    Get the method this method(s) implemented from an interface, if any

    Parameters:

    parserMethod   &$element   — 

    [ Top ]

    getFormattedOverrides   [line 4792]

    array|false getFormattedOverrides( parserMethod &$element)

    Get the method this method overrides, if any

    Parameters:

    parserMethod   &$element   — 

    [ Top ]

    getFunctionLink   [line 3215]

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

    return false or a functionLink to $expr

    Overridden in child classes as:

    PDFdefaultConverter::getFunctionLink()
    XMLDocBookConverter::getFunctionLink()
    XMLDocBookpeardoc2Converter::getFunctionLink()
    CHMdefaultConverter::getFunctionLink()
    HTMLSmartyConverter::getFunctionLink()
    HTMLframesConverter::getFunctionLink()

    Parameters:

    string   $expr   —  function name
    string   $package   —  package name
       $file   — 
       $text   — 

    [ Top ]

    getGlobalLink   [line 3263]

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

    return false or a globalLink to $expr
    • Return: returns a defineLink or false if the element is not found in package $package
    • See: defineLink

    Overridden in child classes as:

    PDFdefaultConverter::getGlobalLink()
    XMLDocBookConverter::getGlobalLink()
    XMLDocBookpeardoc2Converter::getGlobalLink()
    CHMdefaultConverter::getGlobalLink()
    HTMLSmartyConverter::getGlobalLink()
    HTMLframesConverter::getGlobalLink()

    Parameters:

    string   $expr   —  global variable name (with leading $)
    string   $package   —  package name
       $file   — 
       $text   — 

    [ Top ]

    getGlobalValue   [line 5226]

    string getGlobalValue( string $value)

    Parse a global variable's default value for class initialization.

    If a global variable's default value is "new class" as in:

    1.  $globalvar = new Parser
    This method will document it not as "new Parser" but instead as "new Parser". For examples, see phpdoc.inc. Many global variables are classes, and phpDocumentor links to their documentation

    • Return: default global variable value with link to class if it's "new Class"

    Overridden in child classes as:

    PDFdefaultConverter::getGlobalValue()

    Parameters:

    string   $value   —  default value of a global variable.

    [ Top ]

    getHighlightState   [line 596]

    void getHighlightState( )


    [ Top ]

    getId   [line 3964]

    string getId( abstractLink &$link)

    take abstractLink descendant and text $eltext and return a

    unique ID in the format needed for the Converter

    • Return: unique identifier of $element
    • Abstract:

    Overridden in child classes as:

    XMLDocBookConverter::getId()
    Get the id value needed to allow linking
    XMLDocBookpeardoc2Converter::getId()
    Get the id value needed to allow linking
    CHMdefaultConverter::getId()
    HTMLSmartyConverter::getId()
    HTMLframesConverter::getId()

    Parameters:

    abstractLink   &$link   — 

    [ Top ]

    getIncludeValue   [line 5267]

    string getIncludeValue( string $value, string $ipath)

    Parse an include's file to see if it is a file documented in this project

    Although not very smart yet, this method will try to look for the included file file.ext:

    1.  include ("file.ext");

    If it finds it, it will return a link to the file's documentation. As of 1.2.0rc1, phpDocumentor is smarty enough to find these cases:

    • absolute path to file
    • ./file.ext or ../file.ext
    • relpath/to/file.ext if relpath is a subdirectory of the base parse directory
    For examples, see Setup.inc.php includes. Every include auto-links to the documentation for the file that is included

    • Return: included file with link to docs for file, if found

    Parameters:

    string   $value   —  file included by include statement.
    string   $ipath   —  path of file that has the include statement

    [ Top ]

    getLink   [line 3577]

    mixed &getLink( string $expr, [string $package = false], [array $packages = false])

    The meat of the @see tag and inline {@link} tag

    $expr is a string with many allowable formats:

    1. proceduralpagename.ext
    2. constant_name
    3. classname::function()
    4. classname::constantname
    5. classname::$variablename
    6. classname
    7. object classname
    8. function functionname()
    9. global $globalvarname
    10. packagename#expr where expr is any of the above

    New in version 1.1, you can explicitly specify a package to link to that is different from the current package. Use the # operator to specify a new package, as in tests#bug-540368.php (which should appear as a link like: "bug-540368.php"). This example links to the procedural page bug-540368.php in package tests. Also, the "function" operator is now used to specifically link to a function instead of a method in the current class.

    1.  class myclass
    2.  {
    3.   // from inside the class definition, use "function conflict()" to refer to procedural function "conflict()"
    4.     function conflict()
    5.     {
    6.     }
    7.  }
    8.  
    9.  function conflict()
    10.  {
    11.  }

    If classname:: is not present, and the see tag is in a documentation block within a class, then the function uses the classname to search for $expr as a function or variable within classname, or any of its parent classes. given an $expr without '$', '::' or '()' getLink first searches for classes, procedural pages, constants, global variables, and then searches for methods and variables within the default class, and finally for any function


    Overridden in child classes as:

    XMLDocBookConverter::getLink()
    do that stuff in $template_options
    XMLDocBookpeardoc2Converter::getLink()
    do that stuff in $template_options

    Parameters:

    string   $expr   —  expression to search for a link
    string   $package   —  package to start searching in
    array   $packages   —  list of all packages to search in

    [ Top ]

    getMethodLink   [line 3312]

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

    return false or a methodLink to $expr in $class
    • Return: returns a methodLink or false if the element is not found in package $package, class $class
    • See: methodLink

    Overridden in child classes as:

    PDFdefaultConverter::getMethodLink()
    XMLDocBookConverter::getMethodLink()
    XMLDocBookpeardoc2Converter::getMethodLink()
    CHMdefaultConverter::getMethodLink()
    HTMLSmartyConverter::getMethodLink()
    HTMLframesConverter::getMethodLink()

    Parameters:

    string   $expr   —  method name
    string   $class   —  class name
    string   $package   —  package name
       $file   — 
       $text   — 

    [ Top ]

    getPageLink   [line 3287]

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

    return false or a pageLink to $expr
    • Return: returns a pageLink or false if the element is not found in package $package
    • See: pageLink

    Overridden in child classes as:

    PDFdefaultConverter::getPageLink()
    XMLDocBookConverter::getPageLink()
    XMLDocBookpeardoc2Converter::getPageLink()
    CHMdefaultConverter::getPageLink()
    HTMLSmartyConverter::getPageLink()
    HTMLframesConverter::getPageLink()

    Parameters:

    string   $expr   —  procedural page name
    string   $package   —  package name
       $path   — 
       $text   — 
       $packages   — 

    [ Top ]

    getSortedClassTreeFromClass   [line 2966]

    array getSortedClassTreeFromClass( string $class, string $package, string $subpackage)

    Return a tree of all classes that extend this class

    The data structure returned is designed for a non-recursive algorithm, and is somewhat complex. In most cases, the array returned is:

     array('#root' =>
             array('link' => classLink to $class,
                   'parent' => false,
                   'children' => array(array('class' => 'childclass1',
                                             'package' => 'child1package'),
                                        array('class' => 'childclass2',
                                             'package' => 'child2package'),...
                                      )
                   ),
           'child1package#childclass1' =>
             array('link' => classLink to childclass1,
                   'parent' => '#root',
                   'children' => array(array('class' => 'kidclass',
                                             'package' => 'kidpackage'),...
                                      )
                  ),
           'kidpackage#kidclass' =>
             array('link' => classLink to kidclass,
                   'parent' => 'child1package#childclass1',
                   'children' => array() // no children
                  ),
          ....
          )

    To describe this format using language, every class in the tree has an entry in the first level of the array. The index for all child classes that extend the root class is childpackage#childclassname. Each entry in the array has 3 elements: link, parent, and children.

    • link - a classLink to the current class
    • parent - a classLink to the class's parent, or false (except for one special case described below)
    • children - an array of arrays, each entry has a 'class' and 'package' index to the child class, used to find the entry in the big array

    special cases are when the #root class has a parent in another package, or when the #root class extends a class not found by phpDocumentor. In the first case, parent will be a classLink to the parent class. In the second, parent will be the extends clause, as in:

    1.  class extends Y
    2.  {
    3.  ...
    4.  }
    in this case, the #root entry will be array('link' => classLink to X, 'parent' => 'Y', children => array(...))

    The fastest way to design a method to process the array returned is to copy HTMLframesConverter::getRootTree() into your converter and to modify the html to whatever output format you are going to use


    Parameters:

    string   $class   —  class name
    string   $package   — 
    string   $subpackage   — 

    [ Top ]

    getSourceLink   [line 1113]

    string getSourceLink( $path)


    Overridden in child classes as:

    PDFdefaultConverter::getSourceLink()
    CHMdefaultConverter::getSourceLink()
    HTMLSmartyConverter::getSourceLink()
    HTMLframesConverter::getSourceLink()

    Parameters:

       $path   — 

    [ Top ]

    getState   [line 5395]

    void getState( )

    Return parserStringWithInlineTags::Convert() cache state

    Overridden in child classes as:

    PDFdefaultConverter::getState()

    [ Top ]

    getTutorialId   [line 1430]

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

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

    Used by {@id}


    Overridden in child classes as:

    PDFdefaultConverter::getTutorialId()
    XMLDocBookConverter::getTutorialId()
    XMLDocBookpeardoc2Converter::getTutorialId()
    CHMdefaultConverter::getTutorialId()
    HTMLSmartyConverter::getTutorialId()
    HTMLframesConverter::getTutorialId()

    Parameters:

       $package   — 
       $subpackage   — 
       $tutorial   — 
       $id   — 

    [ Top ]

    getTutorialLink   [line 3429]

    tutorialLink|string getTutorialLink( string $expr, [string $package = false], [string $subpackage = false], [array $packages = false])

    The meat of the @tutorial tag and inline {@tutorial} tag

    Take a string and return an abstract link to the tutorial it represents. Since tutorial naming literally works like the underlying filesystem, the way to reference the tutorial is similar. Tutorials are located in a subdirectory of any directory parsed, which is named 'tutorials/' (we try to make things simple when we can :). They are further organized by package and subpackage as:

    tutorials/package/subpackage

    and the files are named *.cls, *.pkg, or *.proc, and so a link to a tutorial named file.cls can be referenced (depending on context) as any of:

    1.  * @tutorial package/subpackage/file.cls
    2.  * @tutorial package/file.cls
    3.  * @tutorial file.cls

    The first case will only be needed if file.cls exists in both the current package, in anotherpackage/file.cls and in anotherpackage/subpackage/file.cls and you wish to reference the one in anotherpackage/subpackage. The second case is only needed if you wish to reference file.cls in another package and it is unique in that package. the third will link to the first file.cls it finds using this search method:

    1. current package/subpackage
    2. all other subpackages of current package
    3. parent package, if this package has classes that extend classes in another package
    4. all other packages

    • Return: returns either a link, or the original text, if not found
    • Since: 1.2

    Parameters:

    string   $expr   —  the original expression
    string   $package   —  package to look in first
    string   $subpackage   —  subpackage to look in first
    array   $packages   —  array of package names to search in if not found in parent packages. This is used to limit the search, phpDocumentor automatically searches all packages

    [ Top ]

    getTutorialTree   [line 1986]

    array getTutorialTree( parserTutorial|array $tutorial)

    Get a tree structure representing the hierarchy of tutorials

    Returns an array in format:

     array('tutorial' => parserTutorial,
           'kids' => array( // child tutorials
                       array('tutorial' => child parserTutorial,
                             'kids' => array(...)
                            )
                          )
          )


    Overridden in child classes as:

    HTMLSmartyConverter::getTutorialTree()
    HTMLframesConverter::getTutorialTree()

    Parameters:

    parserTutorial|array   $tutorial   — 

    [ Top ]

    getVarLink   [line 3339]

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

    return false or a varLink to $expr in $class
    • Return: returns a varLink or false if the element is not found in package $package, class $class
    • See: varLink

    Overridden in child classes as:

    PDFdefaultConverter::getVarLink()
    XMLDocBookConverter::getVarLink()
    XMLDocBookpeardoc2Converter::getVarLink()
    CHMdefaultConverter::getVarLink()
    HTMLSmartyConverter::getVarLink()
    HTMLframesConverter::getVarLink()

    Parameters:

    string   $expr   —  var name
    string   $class   —  class name
    string   $package   —  package name
       $file   — 
       $text   — 

    [ Top ]

    hasSourceCode   [line 1167]

    boolean hasSourceCode( string $path)

    Determine whether an element's file has generated source code, used for linking to line numbers of source.

    Wrapper for $sourcePaths in this version


    Parameters:

    string   $path   —  full path to the source code file

    [ Top ]

    hasTutorial   [line 498]

    false|parserTutorial hasTutorial( pkg|cls|proc $type, tutorial $name, string $package, [string $subpackage = ''])

    • Return: if the tutorial exists, return it

    Parameters:

    pkg|cls|proc   $type   —  the tutorial type to search for
    tutorial   $name   —  name
    string   $package   —  package name
    string   $subpackage   —  subpackage name, if any

    [ Top ]

    highlightDocBlockSource   [line 698]

    string highlightDocBlockSource( string $token, string $word, [boolean $preformatted = false])

    Used to allow converters to format the source code of DocBlocks the way they'd like.

    default returns it unchanged. Mainly used by the HighlightParser


    Parameters:

    string   $token   —  name of docblock token type
    string   $word   —  contents of token
    boolean   $preformatted   —  whether the contents are preformatted or need modification

    [ Top ]

    highlightSource   [line 645]

    string highlightSource( integer $token, string $word, [boolean $preformatted = false])

    Used to allow converters to format the source code the way they'd like.

    default returns it unchanged. Mainly used by the HighlightParser


    Parameters:

    integer   $token   —  token value from tokenizer constants
    string   $word   —  contents of token
    boolean   $preformatted   —  whether the contents are preformatted or need modification

    [ Top ]

    highlightTutorialSource   [line 736]

    string highlightTutorialSource( string $token, string $word, [boolean $preformatted = false])

    Used to allow converters to format the source code of Tutorial XML the way they'd like.

    default returns it unchanged. Mainly used by the HighlightParser


    Parameters:

    string   $token   —  name of docblock token type
    string   $word   —  contents of token
    boolean   $preformatted   —  whether the contents are preformatted or need modification

    [ Top ]

    Italicize   [line 953]

    string Italicize( string $para)

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

    Parameters:

    string   $para   — 

    [ Top ]

    Kbdize   [line 981]

    string Kbdize( string $para)

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

    Parameters:

    string   $para   — 

    [ Top ]

    ListItem   [line 882]

    string ListItem( string $item)

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

    Parameters:

    string   $item   — 

    [ Top ]

    newSmarty   [line 5087]

    Smarty &newSmarty( )

    Return a Smarty template object to operate with

    This returns a Smarty template with pre-initialized variables for use. If the method "SmartyInit()" exists, it is called.


    [ Top ]

    Output   [line 5150]

    void Output( $title)

    do all necessary output

    Overridden in child classes as:

    PDFdefaultConverter::Output()
    calls Cezpdf::ezOutput() and writes documentation.pdf to targetDir
    XMLDocBookConverter::Output()
    This function is not used by HTMLdefaultConverter, but is required by Converter
    XMLDocBookpeardoc2Converter::Output()
    Generate the constants.xml, packagename.xml, and globals.xml files
    CHMdefaultConverter::Output()
    Create the phpdoc.hhp, contents.hhc files needed by MS HTML Help Compiler to create a CHM file
    HTMLSmartyConverter::Output()
    This function is not used by HTMLdefaultConverter, but is required by Converter
    HTMLframesConverter::Output()
    This function is not used by HTMLdefaultConverter, but is required by Converter

    Parameters:

       $title   — 

    [ Top ]

    postProcess   [line 1024]

    string postProcess( $text)

    This version does nothing

    Perform necessary post-processing of string data. For example, the HTML Converters should escape < and > to become &lt; and &gt;


    Overridden in child classes as:

    PDFdefaultConverter::postProcess()
    XMLDocBookConverter::postProcess()
    XMLDocBookpeardoc2Converter::postProcess()
    CHMdefaultConverter::postProcess()
    Uses htmlspecialchars() on the input
    HTMLSmartyConverter::postProcess()
    Uses htmlspecialchars() on the input
    HTMLframesConverter::postProcess()
    Uses htmlspecialchars() on the input

    Parameters:

       $text   — 

    [ Top ]

    prepareDocBlock   [line 4492]

    array prepareDocBlock( mixed &$element, [array $names = array()], [boolean $nopackage = true])

    convert the element's DocBlock for output

    This function converts all tags and descriptions for output

    • Return: Format:
       array('sdesc' => DocBlock summary
             'desc' => DocBlock detailed description
             'tags' => array('keyword' => tagname, 'data' => tag description)
                       known tags
             'api_tags' => array('keyword' => tagname, 'data' => tag description)
                       known api documentation tags
             'info_tags' => array('keyword' => tagname, 'data' => tag description)
                       known informational tags
           [ 'utags' => array('keyword' => tagname, 'data' => tag description
                       unknown tags ]
           [ 'vartype' => type from @var/@return tag ]
           [ 'var_descrip' => description from @var/@return tag ]
            )

    Overridden in child classes as:

    XMLDocBookConverter::prepareDocBlock()
    XMLDocBookpeardoc2Converter::prepareDocBlock()

    Parameters:

    mixed   &$element   —  any descendant of parserElement, or parserData
    array   $names   —  used to translate tagnames into other tags
    boolean   $nopackage   —  set to false for pages and classes, the only elements allowed to specify @package

    [ Top ]

    PreserveWhiteSpace   [line 911]

    string PreserveWhiteSpace( string $string)

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

    Parameters:

    string   $string   — 

    [ Top ]

    ProgramExample   [line 793]

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

    Used to convert the <code> tag in a docblock

    Overridden in child classes as:

    XMLDocBookpeardoc2Converter::ProgramExample()
    CHMdefaultConverter::ProgramExample()
    Used to convert the <code> tag in a docblock
    HTMLSmartyConverter::ProgramExample()
    Used to convert the <code> tag in a docblock
    HTMLframesConverter::ProgramExample()
    Used to convert the <code> tag in a docblock

    Parameters:

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

    [ Top ]

    returnLink   [line 3941]

    string returnLink( string $link, string $text)

    take URL $link and text $text and return a link in the format needed for the Converter
    • Return: link to $link
    • Abstract:

    Overridden in child classes as:

    PDFdefaultConverter::returnLink()
    XMLDocBookConverter::returnLink()
    XMLDocBookpeardoc2Converter::returnLink()
    CHMdefaultConverter::returnLink()
    HTMLSmartyConverter::returnLink()
    HTMLframesConverter::returnLink()

    Parameters:

    string   $link   —  URL
    string   $text   —  text to display

    [ Top ]

    returnSee   [line 3953]

    string returnSee( abstractLink &$link, [string $eltext = false])

    take abstractLink descendant and text $eltext and return a link

    in the format needed for the Converter

    • Return: link to $element
    • Abstract:

    Overridden in child classes as:

    PDFdefaultConverter::returnSee()
    Returns a bookmark using Cezpdf 009
    XMLDocBookConverter::returnSee()
    This function takes an abstractLink descendant and returns an html link
    XMLDocBookpeardoc2Converter::returnSee()
    This function takes an abstractLink descendant and returns an html link
    CHMdefaultConverter::returnSee()
    This function takes an abstractLink descendant and returns an html link
    HTMLSmartyConverter::returnSee()
    This function takes an abstractLink descendant and returns an html link
    HTMLframesConverter::returnSee()
    This function takes an abstractLink descendant and returns an html link

    Parameters:

    abstractLink   &$link   — 
    string   $eltext   — 

    [ Top ]

    Sampize   [line 995]

    string Sampize( string $para)

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

    Parameters:

    string   $para   — 

    [ Top ]

    setSourcePaths   [line 1182]

    void setSourcePaths( string $path)

    Mark a file as having had source code highlighted

    Parameters:

    string   $path   —  full path of source file

    [ Top ]

    setTargetDir   [line 5325]

    void setTargetDir( string $dir)

    Sets the output directory for generated documentation

    As of 1.3.0RC6, this also sets the compiled templates directory inside the target directory


    Overridden in child classes as:

    XMLDocBookConverter::setTargetDir()
    calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
    CHMdefaultConverter::setTargetDir()
    calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
    HTMLSmartyConverter::setTargetDir()
    calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
    HTMLframesConverter::setTargetDir()
    calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied

    Parameters:

    string   $dir   —  the output directory

    [ Top ]

    setTemplateBase   [line 5161]

    void setTemplateBase( string $base, string $dir)

    Set the template directory with a different template base directory

    Parameters:

    string   $base   —  template base directory
    string   $dir   —  template name

    [ Top ]

    setTemplateDir   [line 5186]

    void setTemplateDir( string $dir)

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

    Also sets $templateName to the $dir parameter


    Overridden in child classes as:

    PDFdefaultConverter::setTemplateDir()
    XMLDocBookConverter::setTemplateDir()
    XMLDocBookpeardoc2Converter::setTemplateDir()
    CHMdefaultConverter::setTemplateDir()

    Parameters:

    string   $dir   —  subdirectory

    [ Top ]

    sortPageContentsByElementType   [line 2582]

    void sortPageContentsByElementType( &$pages)

    sorts $page_contents by element type as well as alphabetically
    • See: $sort_page_contents_by_element_type

    Parameters:

       &$pages   — 

    [ Top ]

    sourceLine   [line 1138]

    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

    • Return: formatted source code line with line number

    Overridden in child classes as:

    CHMdefaultConverter::sourceLine()
    Return a line of highlighted source code with formatted line number
    HTMLSmartyConverter::sourceLine()
    Return a line of highlighted source code with formatted line number
    HTMLframesConverter::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.

    [ Top ]

    startHighlight   [line 590]

    void startHighlight( )

    Initialize highlight caching

    [ Top ]

    TranslateEntity   [line 1192]

    void TranslateEntity( string $name)

    Used to translate an XML DocBook entity like &rdquo; from a tutorial by reading the options.ini file for the template.

    Parameters:

    string   $name   —  entity name

    [ Top ]

    TranslateTag   [line 1222]

    string TranslateTag( string $name, string $attr, string $cdata, string $unconvertedcdata)

    Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.

    Overridden in child classes as:

    PDFdefaultConverter::TranslateTag()
    Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.

    Parameters:

    string   $name   —  tag name
    string   $attr   —  any attributes Format: array(name => value)
    string   $cdata   —  the tag contents, if any
    string   $unconvertedcdata   —  the tag contents, if any, unpost-processed

    [ Top ]

    TutorialExample   [line 868]

    void TutorialExample( string $example)


    Overridden in child classes as:

    CHMdefaultConverter::TutorialExample()
    HTMLSmartyConverter::TutorialExample()
    HTMLframesConverter::TutorialExample()

    Parameters:

    string   $example   — 

    [ Top ]

    type_adjust   [line 767]

    string type_adjust( string $typename)

    Called by parserReturnTag::Convert() to allow converters to change type names to desired formatting

    Used by XMLDocBookConverter::type_adjust() to change true and false to the peardoc2 values


    Overridden in child classes as:

    XMLDocBookConverter::type_adjust()
    XMLDocBookpeardoc2Converter::type_adjust()

    Parameters:

    string   $typename   — 

    [ Top ]

    unmangle   [line 582]

    string unmangle( string $sourcecode)

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

    default returns it unchanged (html with xhtml tags)


    Overridden in child classes as:

    PDFdefaultConverter::unmangle()
    XMLDocBookConverter::unmangle()
    XMLDocBookpeardoc2Converter::unmangle()
    CHMdefaultConverter::unmangle()
    HTMLSmartyConverter::unmangle()
    HTMLframesConverter::unmangle()

    Parameters:

    string   $sourcecode   —  output from highlight_string() - use this function to reformat the returned data for Converter-specific output

    [ Top ]

    vardump_tree   [line 2214]

    string vardump_tree( $tree, [ $indent = ''])

    Debugging function for dumping $tutorial_tree

    Parameters:

       $tree   — 
       $indent   — 

    [ Top ]

    Varize   [line 967]

    string Varize( string $para)

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

    Parameters:

    string   $para   — 

    [ Top ]

    walk   [line 1717]

    void walk( array &$pages, array &$package_pages)

    called by phpDocumentor_IntermediateParser::Convert() to traverse the array of pages and their elements, converting them to the output format

    The walk() method should be flexible enough such that it never needs modification. walk() sets up all of the indexes, and sorts everything in logical alphabetical order. It then passes each element individually to Convert(), which then passes to the Convert*() methods. A child Converter need not override any of these unless special functionality must be added. see Converter Default Template Variables for details. {@ and the left indexes specified by $leftindexes, and then sorts them by calling sortIndexes().

    Next, it converts all README/CHANGELOG/INSTALL-style files, using Convert_RIC.

    After this, it passes all package-level docs to Convert(). Then, it calls the index sorting functions formatPkgIndex(), formatIndex() and formatLeftIndex().

    Finally, it converts each procedural page in alphabetical order. This stage passes elements from the physical file to Convert() in alphabetical order. First, procedural page elements parserDefine, parserInclude parserGlobal, and parserFunction are passed to Convert().

    Then, class elements are passed in this order: parserClass, then all of the parserVars in the class and all of the parserMethods in the class. Classes are in alphabetical order, and both vars and methods are in alphabetical order.

    Finally, ConvertErrorLog() is called and the data walk is complete.}}


    Parameters:

    array   &$pages   —  Format: array(fullpath => parserData structure with full parserData::$elements and parserData::$class_elements.
    array   &$package_pages   —  Format: array(parserPackagePage 1, parserPackagePage 2,...)

    [ Top ]

    walk_everything   [line 2279]

    void walk_everything( )

    walk over elements by package rather than page

    This method is designed for converters like the PDF converter that need everything passed in alphabetical order by package/subpackage and by procedural and then class information


    [ Top ]

    writeExample   [line 1068]

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

    Write out the formatted source code for an example php file

    This function provides the primary functionality for the @example tag.

    • Abstract:

    Overridden in child classes as:

    PDFdefaultConverter::writeExample()
    XMLDocBookpeardoc2Converter::writeExample()
    CHMdefaultConverter::writeExample()
    HTMLSmartyConverter::writeExample()
    HTMLframesConverter::writeExample()

    Parameters:

    string   $title   —  example title
    string   $path   —  example filename (no path)
    string   $source   —  fully highlighted/linked source code of the file

    [ Top ]

    writeFile   [line 5358]

    void writeFile( string $file, string $data, [boolean $binary = false])

    Writes a file to target dir

    Overridden in child classes as:

    XMLDocBookpeardoc2Converter::writeFile()
    Writes a file to target dir, beautify any .xml files first

    Parameters:

    string   $file   — 
    string   $data   — 
    boolean   $binary   —  true if the data is binary and not text

    [ Top ]

    writeSource   [line 1052]

    void writeSource( string $filepath, string $source)

    Write out the formatted source code for a php file

    This function provides the primary functionality for the @filesource tag.


    Overridden in child classes as:

    PDFdefaultConverter::writeSource()
    XMLDocBookpeardoc2Converter::writeSource()
    Does nothing
    CHMdefaultConverter::writeSource()
    HTMLSmartyConverter::writeSource()
    HTMLframesConverter::writeSource()

    Parameters:

    string   $filepath   —  full path to the file
    string   $source   —  fully highlighted/linked source code of the file

    [ Top ]


    Documentation generated on Mon, 11 Mar 2019 15:50:16 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.