array $all_packages (line 366)

All packages encountered in parsing

• see: phpDocumentor_IntermediateParser::$all_packages

Classes $classes (line 319)

All class information, organized by path, and by package

Smarty $class_data (line 165)

template for the class currently being processed

• XMLDocBookpeardoc2Converter::$class_data : template for the class currently being processed
• XMLDocBookConverter::$class_data : template for the class currently being processed

mixed $curfile (line 313)

full path of the current file being converted

array $define_elements = array() (line 201)

alphabetized index of defines by package

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

array $function_elements = array() (line 222)

alphabetized index of functions by package

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

boolean $highlightingSource = false (line 325)

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

string $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"

• tutorial: phpDocumentor Tutorial

• HTMLframesConverter::$outputformat
• HTMLSmartyConverter::$outputformat
• XMLDocBookpeardoc2Converter::$outputformat
• XMLDocBookConverter::$outputformat
• PDFdefaultConverter::$outputformat
• CHMdefaultConverter::$outputformat

array $packagecategories (line 359)

Packages associated with categories

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

• see: phpDocumentor_IntermediateParser::$packagecategories

mixed $package_output (line 141)

set to value of -po commandline

• tutorial: phpDocumentor Tutorial

string $page (line 147)

name of current page being converted

• XMLDocBookpeardoc2Converter::$page : name of current page being converted
• XMLDocBookConverter::$page : name of current page being converted

Smarty $page_data (line 159)

template for the procedural page currently being processed

• XMLDocBookpeardoc2Converter::$page_data : template for the procedural page currently being processed
• XMLDocBookConverter::$page_data : template for the procedural page currently being processed

bool $parseprivate (line 276)

controls processing of elements marked private with @access private

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

array $pkg_elements = array() (line 229)

alphabetical index of all elements, indexed by package/subpackage

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

bool $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

mixed $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

• XMLDocBookpeardoc2Converter::$sort_absolutely_everything : Pass elements by package, simplifies generation of package.xml/category.xml
• PDFdefaultConverter::$sort_absolutely_everything : default PDF Converter wants elements sorted by type as well as alphabetically

array $sourcePaths = array() (line 372)

A list of files that have had source code generated

mixed $targetDir = '' (line 289)

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

• tutorial: phpDocumentor Tutorial

string $templateName = '' (line 308)

Name of the template, from last part of -o

• tutorial: phpDocumentor Tutorial

string $title = 'Generated Documentation' (line 392)

• see: phpDocumentor_IntermediateParser::$title

Constructor Converter (line 452)

Initialize Converter data structures

• 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

Bolden (line 931)

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

• usedby: parserB::Convert()

• string $para

checkState (line 5393)

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

• see: parserStringWithInlineTags::Convert()
• abstract:

• mixed $state

Convert (line 3982)

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

• mixed &$element: parserElement descendant or parserPackagePage or parserData

convertConst (line 4233)

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

• parserConst &$element
• $additions

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

ConvertErrorLog (line 2426)

Convert the phpDocumentor parsing/conversion error log

• abstract:

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

convertGlobal (line 4324)

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

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

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

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

convertMethod (line 4113)

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

• parserMethod &$element
• $additions

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

ConvertTitle (line 1396)

Convert the title of a Tutorial docbook tag section

to a string based on the template options.ini

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

convertTutorial (line 4010)

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

• parserTutorial &$element

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

Convert_RIC (line 3962)

Convert README/INSTALL/CHANGELOG file contents to output format

• abstract:

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

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

createParentDir (line 5284)

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

• string $dir

EncloseParagraph (line 917)

Used to enclose a paragraph in a docblock

• string $para

endPage (line 521)

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

• see: HTMLframesConverter::endClass()
• abstract:

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

flushHighlightCache (line 609)

Return the close text for the current token

formatLeftIndex (line 559)

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

• see: HTMLframesConverter::formatLeftIndex()
• abstract:

• HTMLframesConverter::formatLeftIndex() : Generate indexes for li_package.html and classtree output files
• HTMLSmartyConverter::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
• CHMdefaultConverter::formatLeftIndex() : Generate indexes for li_package.html and classtree output files

formatTutorialTOC (line 1030)

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:

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

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

generateFormattedClassTree (line 4665)

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:

• parserClass $class: class variable

• HTMLframesConverter::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
• 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
• CHMdefaultConverter::generateFormattedClassTree() : returns an array containing the class inheritance tree from the root object to the class

getClassLink (line 3179)

return false or a classLink to $expr

• return: returns a classLink or false if the element is not found in package $package
• see: classLink

• string $expr: class name
• string $package: package name
• $file
• $text

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

getConverterDir (line 5189)

Get the absolute path to the converter's base directory

getCurrentPageURL (line 1095)

Return the path to the current

• string $pathinfo

getFileSourceName (line 1070)

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

• string $pathinfo
• $path

• PDFdefaultConverter::getFileSourceName()

getFormattedConflicts (line 4718)

• return: links to conflicting elements, or empty array
• uses: parserGlobal::getConflicts()
• uses: parserFunction::getConflicts()
• uses: parserDefine::getConflicts()
• uses: parserClass::getConflicts()

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

getFormattedDescVars (line 4759)

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

• return: empty array or array('link'=>link to var, 'sdesc'=>short description of the method
• uses: parserVar::getOverridingVars()

• parserVar &$element

getFormattedInheritedConsts (line 5023)

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

• parserConst $child: class constant

getFormattedInheritedVars (line 4864)

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

• parserVar $child: class var

getFormattedOverrides (line 4780)

Get the method this method overrides, if any

• return: array('link'=>link to overridden method, 'sdesc'=>short description
• see: parserMethod::getOverrides()

• parserMethod &$element

getGlobalLink (line 3251)

return false or a globalLink to $expr

• return: returns a defineLink or false if the element is not found in package $package
• see: defineLink

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

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

getIncludeValue (line 5254)

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:

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

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

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

getMethodLink (line 3300)

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

• string $expr: method name
• string $class: class name
• string $package: package name
• $file
• $text

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

getSortedClassTreeFromClass (line 2954)

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:

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

• return: Format: see docs
• see: HTMLframesConverter::getRootTree()

• string $class: class name
• string $package
• string $subpackage

getState (line 5382)

Return parserStringWithInlineTags::Convert() cache state

• see: parserStringWithInlineTags::Convert()
• abstract:

• PDFdefaultConverter::getState()

getTutorialLink (line 3417)

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:

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

• 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

getVarLink (line 3327)

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

• string $expr: var name
• string $class: class name
• string $package: package name
• $file
• $text

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

hasTutorial (line 490)

• return: if the tutorial exists, return it

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

highlightSource (line 637)

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

default returns it unchanged. Mainly used by the HighlightParser

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

Italicize (line 945)

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

• usedby: parserI::Convert()

• string $para

ListItem (line 874)

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

• usedby: parserList::Convert() - enclose each item of the list

• string $item

Output (line 5137)

do all necessary output

• see: Converter
• abstract:
• usedby: phpDocumentor_IntermediateParser::Convert()

• $title

• HTMLframesConverter::Output() : This function is not used by HTMLdefaultConverter, but is required by Converter
• HTMLSmartyConverter::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
• XMLDocBookConverter::Output() : This function is not used by HTMLdefaultConverter, but is required by Converter
• PDFdefaultConverter::Output() : calls Cezpdf::ezOutput() and writes documentation.pdf to targetDir
• CHMdefaultConverter::Output() : Create the phpdoc.hhp, contents.hhc files needed by MS HTML Help Compiler to create a CHM file

prepareDocBlock (line 4480)

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

• 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

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

ProgramExample (line 785)

Used to convert the <code> tag in a docblock

• usedby: parserCode::Convert()

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

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

returnSee (line 3941)

take abstractLink descendant and text $eltext and return a link

in the format needed for the Converter

• return: link to $element
• abstract:

• abstractLink &$link
• string $eltext

• HTMLframesConverter::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
• XMLDocBookpeardoc2Converter::returnSee() : This function takes an abstractLink descendant and returns an html link
• XMLDocBookConverter::returnSee() : This function takes an abstractLink descendant and returns an html link
• PDFdefaultConverter::returnSee() : Returns a bookmark using Cezpdf 009
• CHMdefaultConverter::returnSee() : This function takes an abstractLink descendant and returns an html link

setSourcePaths (line 1174)

Mark a file as having had source code highlighted

• string $path: full path of source file

setTemplateBase (line 5148)

Set the template directory with a different template base directory

• tutorial: phpDocumentor Tutorial

• string $base: template base directory
• string $dir: template name

sortPageContentsByElementType (line 2570)

sorts $page_contents by element type as well as alphabetically

• see: $sort_page_contents_by_element_type

• &$pages

startHighlight (line 582)

Initialize highlight caching

TranslateTag (line 1214)

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

• usedby: parserXMLDocBookTag::Convert() - Calls this to enclose the contents of the DocBook tag based on the values in template options.ini file

• 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

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

type_adjust (line 759)

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

• string $typename

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

vardump_tree (line 2202)

Debugging function for dumping $tutorial_tree

• $tree
• $indent

walk (line 1705)

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

• usedby: phpDocumentor_IntermediateParser::Convert() - passes $pages and $package_pages
• uses: Converter::_createPkgElements() - sets up $elements and $pkg_elements array, as well as $links

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

writeExample (line 1060)

Write out the formatted source code for an example php file

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

• abstract:

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

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

writeSource (line 1044)

Write out the formatted source code for a php file

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

• abstract:
• usedby: parserFileSourceTag::writeSource() - export highlighted file source

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

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

_setHighlightCache (line 593)

• $type
• $token