$base_dir (line 134)

Data type : string

target directory passed on the command-line.

$category (line 207)

Data type : string

peardoc2 Category

$class (line 103)

Data type : string

Overrides: Array

name of current class being converted

$class_data (line 146)

Data type : Template

Overrides: Array

template for the class currently being processed

$class_dir (line 140)

Data type : string

output directory for the current class being processed

$current (line 176)

Data type : array

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

$currentclass (line 182)

Data type : array

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

$function_data = array() (line 198)

Data type : mixed

$juststarted = false (line 170)

Data type : boolean

controls formatting of parser informative output

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

Data type : array

Overrides: Array

indexes of elements by package that need to be generated

$local = true (line 85)

Data type : boolean

whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir

$method_data = array() (line 199)

Data type : mixed

$name = 'DocBook/peardoc2' (line 75)

Data type : string

$outputformat = 'XML' (line 73)

Data type : string

Overrides: Array

$packagexml (line 159)

Data type : Smarty

Contents of the packagename.xml file are stored in this template variable

$package_pages = array() (line 153)

Data type : array

array of converted package page names.

• var: - Format: array(package => 1)

$page (line 91)

Data type : string

Overrides: Array

name of current page being converted

$page_data (line 109)

Data type : Template

Overrides: Array

template for the procedural page currently being processed

$page_dir (line 115)

Data type : string

output directory for the current procedural page being processed

$path (line 97)

Data type : string

Overrides: Array

path of current page being converted

$processSpecialRoots = true (line 65)

Data type : boolean

Overrides: Array

This converter knows about the new root tree processing

$sort_absolutely_everything = true (line 187)

Data type : mixed

Overrides: Array

Pass elements by package, simplifies generation of package.xml/category.xml

$sort_page_contents_by_type = true (line 71)

Data type : boolean

Overrides: Array

XMLDocBookConverter wants elements sorted by type as well as alphabetically

• see: - Converter::$sort_page_contents_by_type

$sourceloc = '' (line 202)

Data type : mixed

$template_options = array('usepear' => false) (line 196)

Data type : array

Overrides: Array

template options. Currently only 1 recognized option usepear

$_peardoc2_constants = false (line 121)

Data type : array

Constants, used for constants.tpl

$_peardoc2_globals = false (line 127)

Data type : array

Global Variables, used for globals.tpl

$_write_constants_xml = array() (line 200)

Data type : mixed

$_write_globals_xml = array() (line 201)

Data type : mixed

Constructor XMLDocBookpeardoc2Converter (line 220)

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

sets $base_dir to $targetDir

Parameters

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

Info

• see - Converter::Converter()

Method addSummaryToPackageXml (line 345)

void addSummaryToPackageXml( $template_output)

Parameters

• $template_output:

Info

Method Br (line 681)

void Br( $input)

Overrides : Converter::Br() Used to convert <br> in a docblock

Parameters

• $input:

Info

Method convertClass (line 793)

void convertClass( parserClass &$element)

Overrides : Converter::convertClass() Default Class Handler

Converts class for template output

Parameters

• parserClass &$element:

Info

• uses - XMLDocBookpeardoc2Converter::flushPackageXml() - creates packagename.xml file when all classes in a package have been converted

Method convertDefine (line 1009)

void convertDefine( parserDefine &$element)

Overrides : Converter::convertDefine() Converts defines for template output

Converts defines for template output

Parameters

• parserDefine &$element:

Info

• see - XMLDocBookpeardoc2Converter::prepareDocBlock(), Converter::getFormattedConflicts()

Method ConvertErrorLog (line 565)

void ConvertErrorLog( )

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

Create errors.html template file output

Info

• global - ErrorTracker $phpDocumentor_errors: We'll be using it's output facility

Method convertFunction (line 937)

void convertFunction( parserFunction &$element)

Overrides : Converter::convertFunction() Converts function for template output

Converts function for template output - does nothing in peardoc2!

Parameters

• parserFunction &$element:

Info

Method convertGlobal (line 1049)

void convertGlobal( parserGlobal &$element)

Overrides : Converter::convertGlobal() Converts global variables for template output

Converts global variables for template output

Parameters

• parserGlobal &$element:

Info

• see - XMLDocBookpeardoc2Converter::prepareDocBlock(), Converter::getFormattedConflicts()

Method convertInclude (line 989)

void convertInclude( parserInclude &$element)

Overrides : Converter::convertInclude() Converts includes for template output

Converts include elements for template output

Parameters

• parserInclude &$element:

Info

Method convertMethod (line 861)

void convertMethod( parserMethod &$element)

Overrides : Converter::convertMethod() Converts method for template output

Converts method for template output

Parameters

• parserMethod &$element:

Info

• see - XMLDocBookpeardoc2Converter::prepareDocBlock(), parserMethod::getFunctionCall(), Converter::getFormattedDescMethods(), Converter::getFormattedOverrides()

Method convertPackagePage (line 708)

void convertPackagePage( parserPackagePage &$element)

Does nothing - use tutorials for DocBook

Parameters

• parserPackagePage &$element:

Info

Method convertPage (line 1099)

void convertPage( parserData &$element)

Overrides : Converter::convertPage() Default Page Handler

converts procedural pages for template output

Parameters

• parserData &$element:

Info

• see - XMLDocBookpeardoc2Converter::prepareDocBlock(), Converter::getClassesOnPage()

Method convertTutorial (line 716)

void convertTutorial( parserTutorial &$element)

Overrides : Converter::convertTutorial() Default Tutorial Handler

Convert tutorials for output

Parameters

• parserTutorial &$element:

Info

Method convertVar (line 755)

void convertVar( parserVar &$element)

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

Does nothing in this converter

Parameters

• parserVar &$element:

Info

Method endClass (line 322)

void endClass( )

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

Writes out the template file of $class_data and unsets the template to save memory

Info

• see - registerCurrentClass()
• see - Converter::endClass()
• todo - move class summary into an array to be written out at the end of parsing each package

Method exampleProgramExample (line 276)

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

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

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:

Info

• see - XMLDocBookpeardoc2Converter::exampleProgramExample

Method flushPackageXml (line 353)

void flushPackageXml( parserClass|false $element)

Parameters

• parserClass|false $element: is false if this is the end of all conversion

Info

• usedby - XMLDocBookpeardoc2Converter::convertClass() - creates packagename.xml file when all classes in a package have been converted

Method formatIndex (line 419)

void formatIndex( )

Overrides : Converter::formatIndex() Called by walk() while converting.

Does nothing

Info

Method formatLeftIndex (line 440)

void formatLeftIndex( )

Overrides : Converter::formatLeftIndex() Called by walk() while converting.

Creates package/lang/categoryname/packagename.xml for each package

Info

Method formatPkgIndex (line 412)

void formatPkgIndex( )

Overrides : Converter::formatPkgIndex() Called by walk() while converting.

Does nothing

Info

Method generateChildClassList (line 1165)

void generateChildClassList( parserClass $class)

Overrides : Converter::generateChildClassList() returns a list of child classes

returns a list of child classes

Parameters

• parserClass $class: class variable

Info

• uses - parserClass::getChildClassList()

Method generateElementIndex (line 1378)

void generateElementIndex( )

does nothing

Info

Method generateFormattedClassTree (line 1124)

array generateFormattedClassTree( parserClass $class)

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

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

Parameters

• parserClass $class: class variable

Info

• return - Format: array(root,child,child,child,...,$class)
• uses - parserClass::getParentClassTree()

Method generateFormattedClassTrees (line 1201)

void generateFormattedClassTrees( string $package)

returns a template-enabled array of class trees

Parameters

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

Info

• see - $roots, HTMLConverter::getRootTree()

Method generateFormattedInterfaceTrees (line 1255)

void generateFormattedInterfaceTrees( string $package)

returns a template-enabled array of interface inheritance trees

Parameters

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

Info

• see - $roots, HTMLConverter::getRootTree()

Method generatePkgElementIndex (line 1394)

void generatePkgElementIndex( string $package)

Generate alphabetical index of all elements by package and subpackage

Parameters

• string $package: name of a package

Info

• see - Converter::$pkg_elements, Converter::walk(), XMLDocBookpeardoc2Converter::generatePkgElementIndexes()

Method generatePkgElementIndexes (line 1402)

void generatePkgElementIndexes( )

Info

• see - XMLDocBookpeardoc2Converter::generatePkgElementIndex()

Method getCData (line 686)

void getCData( $value)

Parameters

• $value:

Info

Method getClassLink (line 1415)

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

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

Parameters

• string $expr: name of class
• string $package: package name
• string $file: full path to look in (used in index generation)
• boolean $text: deprecated
• boolean $local: return just the URL, or enclose it in an html a tag
• $with_a:

Info

• return - false if not found, or an html a link to the class's documentation
• see - Converter::getClassLink()

Method getDefineLink (line 1447)

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

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

Parameters

• string $expr: name of define
• string $package: package name
• string $file: full path to look in (used in index generation)
• boolean $text: deprecated
• boolean $local: return just the URL, or enclose it in an html a tag

Info

• return - false if not found, or an html a link to the define's documentation
• see - Converter::getDefineLink()

Method getExampleLink (line 290)

void getExampleLink( $unused, $title)

Parameters

• $unused:
• $title:

Info

Method getFunctionLink (line 1431)

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

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

Parameters

• string $expr: name of function
• string $package: package name
• string $file: full path to look in (used in index generation)
• boolean $text: deprecated
• boolean $local: return just the URL, or enclose it in an html a tag

Info

• return - false if not found, or an html a link to the function's documentation
• see - Converter::getFunctionLink()

Method getGlobalLink (line 1463)

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

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

Parameters

• string $expr: name of global variable
• string $package: package name
• string $file: full path to look in (used in index generation)
• boolean $text: deprecated
• boolean $local: return just the URL, or enclose it in an html a tag

Info

• return - false if not found, or an html a link to the global variable's documentation
• see - Converter::getGlobalLink()

Method getId (line 513)

string getId( mixed &$el, [boolean $returnpackage = false])

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

Get the id value needed to allow linking

Parameters

• mixed &$el: descendant of parserElement or parserData/parserPage
• boolean $returnpackage: true to return the id for the package page

Info

• return - the id value for this element type
• see - parserElement, parserData, parserPage

Method getLink (line 237)

void &getLink( $expr, [ $package = false], [ $packages = false])

Overrides : Converter::getLink() The meat of the @see tag and inline {@link} tag

do that stuff in $template_options

Parameters

• $expr:
• $package:
• $packages:

Info

Method getMethodLink (line 1496)

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

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

Parameters

• string $expr: name of method
• string $class: class containing method
• string $package: package name
• string $file: full path to look in (used in index generation)
• boolean $text: deprecated
• boolean $local: return just the URL, or enclose it in an html a tag

Info

• return - false if not found, or an html a link to the method's documentation
• see - Converter::getMethodLink()

Method getPageLink (line 1479)

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

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

Parameters

• string $expr: name of procedural page
• string $package: package name
• string $path: full path to look in (used in index generation)
• boolean $text: deprecated
• boolean $local: return just the URL, or enclose it in an html a tag

Info

• return - false if not found, or an html a link to the procedural page's documentation
• see - Converter::getPageLink()

Method getPageName (line 1111)

void getPageName( &$element)

Parameters

• &$element:

Info

Method getRootTree (line 1312)

string getRootTree( array $tree, string $package, [ $noparent = false], boolean $nounknownparent)

return formatted class tree for the Class Trees page

Parameters

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

Info

• see - Classes::$definitechild, XMLDocBookpeardoc2Converter::generateFormattedClassTrees()

Method getSourceAnchor (line 676)

string getSourceAnchor( string $sourcefile, string $anchor, [string $text = ''], [boolean $link = false])

Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.

Parameters

• string $sourcefile: full path to source file
• string $anchor: name of anchor
• string $text: link text, if this is a link
• boolean $link: returns either a link or a destination based on this parameter

Info

• return - link to an anchor, or the anchor

Method getTutorialId (line 656)

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

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

Parameters

• $package:
• $subpackage:
• $tutorial:
• $id:
• $category:

Info

Method getVarLink (line 1513)

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

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

Parameters

• string $expr: name of var
• string $class: class containing var
• string $package: package name
• string $file: full path to look in (used in index generation)
• boolean $text: deprecated
• boolean $local: return just the URL, or enclose it in an html a tag

Info

• return - false if not found, or an html a link to the var's documentation
• see - Converter::getVarLink()

Method makeLeft (line 405)

void makeLeft( )

Info

Method Output (line 1575)

void Output( )

Overrides : Converter::Output() do all necessary output

Generate the constants.xml, packagename.xml, and globals.xml files

Info

Method postProcess (line 626)

void postProcess( $text)

Overrides : Converter::postProcess() This version does nothing

Parameters

• $text:

Info

Method prepareDocBlock (line 631)

void prepareDocBlock( &$element, [ $nopackage = true])

Overrides : Converter::prepareDocBlock() convert the element's DocBlock for output

Parameters

• &$element:
• $nopackage:

Info

Method ProgramExample (line 691)

void ProgramExample( $listing, [ $tutorial = false], [ $inlinesourceparse = null], [ $class = null], [ $linenum = null], [ $filesourcepath = null], [ $origsource = null])

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

Parameters

• $listing:
• $tutorial:
• $inlinesourceparse:
• $class:
• $linenum:
• $filesourcepath:
• $origsource:

Info

Method rcNatCmp (line 1527)

int rcNatCmp( mixed $a, mixed $b)

does a nat case sort on the specified second level value of the array

Parameters

• mixed $a:
• mixed $b:

Info

Method rcNatCmp1 (line 1543)

int rcNatCmp1( mixed $a, mixed $b)

does a nat case sort on the specified second level value of the array.

Parameters

• mixed $a:
• mixed $b:

Info

Method returnLink (line 400)

string returnLink( string $link, string $text)

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

Parameters

• string $link:
• string $text:

Info

• return - <ulink url="'.$link.'">'.$text.'</ulink>

Method returnSee (line 453)

void returnSee( abstractLink &$element, [string $eltext = false], [boolean $local = true], [boolean $with_a = true])

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

This function takes an abstractLink descendant and returns an html link

Parameters

• abstractLink &$element: a descendant of abstractlink should be passed, and never text
• string $eltext: text to display in the link
• boolean $local: this parameter is not used, and is deprecated
• boolean $with_a: determines whether the returned text is enclosed in an <link> tag

Info

Method setTemplateDir (line 1382)

void setTemplateDir( $dir)

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

Parameters

• $dir:

Info

Method type_adjust (line 296)

void type_adjust( $typename)

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

Parameters

• $typename:

Info

Method unmangle (line 242)

void unmangle( $s, $sourcecode)

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

Parameters

• $s:
• $sourcecode:

Info

Method wordwrap (line 1567)

void wordwrap( $string)

Parameters

• $string:

Info

Method writeExample (line 285)

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

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

Parameters

• $title:
• $path:
• $source:

Info

Method writeFile (line 254)

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

Overrides : Converter::writeFile() Writes a file to target dir

Writes a file to target dir, beautify any .xml files first

Parameters

• string $file: filename
• string $data: file contents
• boolean $binary: true if the data is binary and not text

Info

Method writeNewPPage (line 426)

void writeNewPPage( $key)

Does nothing

Parameters

• $key:

Info

Method writeSource (line 433)

void writeSource( )

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

Does nothing

Info