Class: XMLDocBookpeardoc2Converter

[line 134]

target directory passed on the command-line.

$targetDir is malleable, always adding package/ and package/subpackage/ subdirectories onto it.

Type: string

Overrides:

[line 207]

peardoc2 Category

Type: string

Overrides:

[line 103]

name of current class being converted

Type: string

Overrides: Array

[line 146]

template for the class currently being processed

Type: Template

Overrides: Array

[line 140]

output directory for the current class being processed

Type: string

Overrides:

[line 176]

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

Type: array

Overrides:

[line 182]

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

Type: array

Overrides:

[line 198]

Type: mixed

Overrides:

[line 170]

controls formatting of parser informative output

Converter prints: "Converting /path/to/file.php... Procedural Page Elements... Classes..." Since HTMLdefaultConverter outputs files while converting, it needs to send a \n to start a new line. However, if there is more than one class, output is messy, with multiple \n's just between class file output. This variable prevents that and is purely cosmetic

Type: boolean

Overrides:

[line 80]

indexes of elements by package that need to be generated

Type: array

Overrides: Array

[line 85]

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

Type: boolean

Overrides:

[line 199]

Type: mixed

Overrides:

[line 75]

Type: string

Overrides:

[line 73]

Type: string

Overrides: Array

[line 159]

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

Type: Smarty

Overrides:

[line 153]

array of converted package page names.

Used to link to the package page in the left index

Tags:

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

Type: array

Overrides:

[line 91]

name of current page being converted

Type: string

Overrides: Array

[line 109]

template for the procedural page currently being processed

Type: Template

Overrides: Array

[line 115]

output directory for the current procedural page being processed

Type: string

Overrides:

[line 97]

path of current page being converted

Type: string

Overrides: Array

[line 65]

This converter knows about the new root tree processing

In order to fix PEAR Bug #6389

Type: boolean

Overrides: Array

[line 187]

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

Type: mixed

Overrides: Array

[line 71]

XMLDocBookConverter wants elements sorted by type as well as alphabetically

Tags:

• see - Converter::$sort_page_contents_by_type

Type: boolean

Overrides: Array

[line 202]

Type: mixed

Overrides:

[line 196]

template options. Currently only 1 recognized option usepear

usepear tells the getLink() function to return a package link to PEAR and PEAR_ERROR if possible, and to link directly to the fully-delimited link package#class.method or package#file.method in PEAR style, if possible, even if the package is not parsed. This will allow parsing of separate PEAR packages without parsing the entire thing at once!

Type: array

Overrides: Array

[line 121]

Constants, used for constants.tpl

Type: array

Overrides:

[line 127]

Global Variables, used for globals.tpl

Type: array

Overrides:

[line 200]

Type: mixed

Overrides:

[line 201]

Type: mixed

Overrides:

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

[line 220]

sets $base_dir to $targetDir

Tags:

• see - Converter::Converter()

Parameters:

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

void addSummaryToPackageXml( $template_output)

[line 345]

Parameters:

• $template_output -

void Br( $input)

[line 681]

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

Parameters:

• $input -

void convertClass( parserClass &$element)

[line 793]

Converts class for template output

Tags:

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

Overrides Converter::convertClass() (Default Class Handler)

Parameters:

• parserClass &$element -

void convertDefine( parserDefine &$element)

[line 1009]

Converts defines for template output

Tags:

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

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

Parameters:

• parserDefine &$element -

void ConvertErrorLog( )

[line 565]

Create errors.html template file output

This method takes all parsing errors and warnings and spits them out ordered by file and line number.

Tags:

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

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

Parameters:

void convertFunction( parserFunction &$element)

[line 937]

Converts function for template output - does nothing in peardoc2!

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

Parameters:

• parserFunction &$element -

void convertGlobal( parserGlobal &$element)

[line 1049]

Converts global variables for template output

Tags:

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

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

Parameters:

• parserGlobal &$element -

void convertInclude( parserInclude &$element)

[line 989]

Converts include elements for template output

Completely ignored by this converter

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

Parameters:

• parserInclude &$element -

void convertMethod( parserMethod &$element)

[line 861]

Converts method for template output

Tags:

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

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

Parameters:

• parserMethod &$element -

void convertPackagePage( parserPackagePage &$element)

[line 708]

Does nothing - use tutorials for DocBook

Parameters:

• parserPackagePage &$element -

void convertPage( parserData &$element)

[line 1099]

converts procedural pages for template output

Tags:

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

Overrides Converter::convertPage() (Default Page Handler)

Parameters:

• parserData &$element -

void convertTutorial( parserTutorial &$element)

[line 716]

Convert tutorials for output

Overrides Converter::convertTutorial() (Default Tutorial Handler)

Parameters:

• parserTutorial &$element -

void convertVar( parserVar &$element)

[line 755]

Does nothing in this converter

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

Parameters:

• parserVar &$element -

void endClass( )

[line 322]

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

Tags:

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

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

Parameters:

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

[line 276]

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

By default, this just wraps ProgramExample

Tags:

• see - XMLDocBookpeardoc2Converter::exampleProgramExample

Overrides Converter::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 -

void flushPackageXml( parserClass|false $element)

[line 353]

Tags:

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

Parameters:

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

void formatIndex( )

[line 419]

Does nothing

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

Parameters:

void formatLeftIndex( )

[line 440]

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

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

Parameters:

void formatPkgIndex( )

[line 412]

Does nothing

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

Parameters:

void generateChildClassList( parserClass $class)

[line 1165]

returns a list of child classes

Tags:

• uses - parserClass::getChildClassList()

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

Parameters:

• parserClass $class - class variable

void generateElementIndex( )

[line 1378]

does nothing

Parameters:

array generateFormattedClassTree( parserClass $class)

[line 1124]

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

Tags:

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

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

Parameters:

• parserClass $class - class variable

void generateFormattedClassTrees( string $package)

[line 1201]

returns a template-enabled array of class trees

Tags:

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

Parameters:

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

void generateFormattedInterfaceTrees( string $package)

[line 1255]

returns a template-enabled array of interface inheritance trees

Tags:

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

Parameters:

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

void generatePkgElementIndex( string $package)

[line 1394]

Generate alphabetical index of all elements by package and subpackage

Tags:

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

Parameters:

• string $package - name of a package

void generatePkgElementIndexes( )

[line 1402]

Tags:

• see - XMLDocBookpeardoc2Converter::generatePkgElementIndex()

Parameters:

void getCData( $value)

[line 686]

Parameters:

• $value -

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

[line 1415]

Tags:

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

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 -

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

[line 1447]

Tags:

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

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

void getExampleLink( $unused, $title)

[line 290]

Parameters:

• $unused -
• $title -

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

[line 1431]

Tags:

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

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

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

[line 1463]

Tags:

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

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

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

[line 513]

Get the id value needed to allow linking

Tags:

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

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

Parameters:

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

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

[line 237]

do that stuff in $template_options

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

Parameters:

• $expr -
• $package -
• $packages -

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

[line 1496]

Tags:

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

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

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

[line 1479]

Tags:

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

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

void getPageName( &$element)

[line 1111]

Parameters:

• &$element -

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

[line 1312]

return formatted class tree for the Class Trees page

Tags:

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

Parameters:

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

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

[line 676]

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

NOTE: unused

Tags:

• return - link to an anchor, or the anchor

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

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

[line 656]

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

Parameters:

• $package -
• $subpackage -
• $tutorial -
• $id -
• $category -

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

[line 1513]

Tags:

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

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

void makeLeft( )

[line 405]

Parameters:

void Output( )

[line 1575]

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

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

Parameters:

void postProcess( $text)

[line 626]

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

Parameters:

• $text -

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

[line 631]

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

Parameters:

• &$element -
• $nopackage -

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

[line 691]

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

Parameters:

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

int rcNatCmp( mixed $a, mixed $b)

[line 1527]

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

Parameters:

• mixed $a -
• mixed $b -

int rcNatCmp1( mixed $a, mixed $b)

[line 1543]

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

this one puts constructors first

Parameters:

• mixed $a -
• mixed $b -

string returnLink( string $link, string $text)

[line 400]

Tags:

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

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 -

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

[line 453]

This function takes an abstractLink descendant and returns an html link

Overrides Converter::returnSee() (take abstractLink descendant and text $eltext and return a 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

void setTemplateDir( $dir)

[line 1382]

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

Parameters:

• $dir -

void type_adjust( $typename)

[line 296]

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

Parameters:

• $typename -

void unmangle( $s, $sourcecode)

[line 242]

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

Parameters:

• $s -
• $sourcecode -

void wordwrap( $string)

[line 1567]

Parameters:

• $string -

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

[line 285]

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

Parameters:

• $title -
• $path -
• $source -

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

[line 254]

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

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

Parameters:

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

void writeNewPPage( $key)

[line 426]

Does nothing

Parameters:

• $key -

void writeSource( )

[line 433]

Does nothing

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

Parameters: