Docs For Class XMLDocBookConverter

Inherited Variables

Class: Converter

Converter::$all_packages
Converter::$classes
Converter::$class_contents
Converter::$class_elements
Converter::$curfile
Converter::$curpage
Converter::$define_elements
Converter::$elements
Converter::$function_elements
Converter::$global_elements
Converter::$highlightingSource
Converter::$package
Converter::$packagecategories
Converter::$package_elements
Converter::$package_output
Converter::$package_parents
Converter::$page_contents
Converter::$page_elements
Converter::$parseprivate
Converter::$pkg_elements
Converter::$processSpecialRoots
Converter::$quietmode
Converter::$smarty_dir
Converter::$sort_absolutely_everything
Converter::$sourcePaths
Converter::$subpackage
Converter::$targetDir
Converter::$templateDir
Converter::$templateName
Converter::$title
Converter::$todoList

Inherited Constants

Inherited Methods

Class: Converter

Converter::Converter(): Initialize Converter data structures
Converter::AttrToString(): Convert the attribute of a Tutorial docbook tag's attribute list
Converter::Bolden(): Used to convert the contents of <b> in a docblock
Converter::Br(): Used to convert <br> in a docblock
Converter::checkState(): Compare parserStringWithInlineTags::Convert() cache state to $state
Converter::cleanup(): Finish up parsing/cleanup directories
Converter::Convert(): Convert all elements to output format
Converter::convertClass(): Default Class Handler
Converter::convertConst(): Converts class constants for template output.
Converter::convertDefine(): Converts defines for template output
Converter::ConvertErrorLog(): Convert the phpDocumentor parsing/conversion error log
Converter::convertFunction(): Converts function for template output
Converter::convertGlobal(): Converts global variables for template output
Converter::convertInclude(): Converts includes for template output
Converter::convertMethod(): Converts method for template output
Converter::convertPage(): Default Page Handler
Converter::ConvertTitle(): Convert the title of a Tutorial docbook tag section
Converter::ConvertTodoList(): Convert the list of all @todo tags
Converter::convertTutorial(): Default Tutorial Handler
Converter::convertVar(): Converts class variables for template output.
Converter::Convert_RIC(): Convert README/INSTALL/CHANGELOG file contents to output format
Converter::copyFile(): Copies a file from the template directory to the target directory
Converter::createParentDir(): Recursively creates all subdirectories that don't exist in the $dir path
Converter::EncloseList(): Used to convert the contents of <ol> or <ul> in a docblock
Converter::EncloseParagraph(): Used to enclose a paragraph in a docblock
Converter::endClass(): Called by walk() while converting, when the last class element has been parsed.
Converter::endPage(): Called by walk() while converting, when the last procedural page element has been parsed.
Converter::exampleProgramExample(): Used to convert the {@example} inline tag in a docblock.
Converter::flushHighlightCache(): Return the close text for the current token
Converter::formatIndex(): Called by walk() while converting.
Converter::formatLeftIndex(): Called by walk() while converting.
Converter::formatPkgIndex(): Called by walk() while converting.
Converter::formatTutorialTOC(): Creates a table of contents for a {@toc} inline tag in a tutorial
Converter::generateChildClassList(): returns a list of child classes
Converter::generateFormattedClassTree(): returns an array containing the class inheritance tree from the root object to the class.
Converter::getClassesOnPage(): gets a list of all classes declared on a procedural page represented by
Converter::getClassLink(): return false or a classLink to $expr
Converter::getConstLink(): return false or a constLink to $expr in $class
Converter::getConverterDir(): Get the absolute path to the converter's base directory
Converter::getCurrentPageLink()
Converter::getCurrentPageURL(): Return the path to the current
Converter::getDefineLink(): return false or a defineLink to $expr
Converter::getFileSourceName(): Translate the path info into a unique file name for the highlighted source code.
Converter::getFileSourcePath(): Return the fixed path to the source-code file folder.
Converter::getFormattedConflicts()
Converter::getFormattedDescMethods(): Get a list of methods in child classes that override this method
Converter::getFormattedDescVars(): Get a list of vars in child classes that override this var
Converter::getFormattedImplements(): returns an array containing the class inheritance tree from the root object to the class.
Converter::getFormattedInheritedConsts(): Return template-enabled list of inherited class constants
Converter::getFormattedInheritedMethods(): Return template-enabled list of inherited methods
Converter::getFormattedInheritedVars(): Return template-enabled list of inherited variables
Converter::getFormattedMethodImplements(): Get the method this method(s) implemented from an interface, if any
Converter::getFormattedOverrides(): Get the method this method overrides, if any
Converter::getFunctionLink(): return false or a functionLink to $expr
Converter::getGlobalLink(): return false or a globalLink to $expr
Converter::getGlobalValue(): Parse a global variable's default value for class initialization.
Converter::getHighlightState()
Converter::getId(): take abstractLink descendant and text $eltext and return a
Converter::getIncludeValue(): Parse an include's file to see if it is a file documented in this project
Converter::getLink(): The meat of the @see tag and inline {@link} tag
Converter::getMethodLink(): return false or a methodLink to $expr in $class
Converter::getPageLink(): return false or a pageLink to $expr
Converter::getSortedClassTreeFromClass(): Return a tree of all classes that extend this class
Converter::getSourceLink()
Converter::getState(): Return parserStringWithInlineTags::Convert() cache state
Converter::getTutorialId(): Return a converter-specific id to distinguish tutorials and their sections
Converter::getTutorialLink(): The meat of the @tutorial tag and inline {@tutorial} tag
Converter::getTutorialTree(): Get a tree structure representing the hierarchy of tutorials
Converter::getVarLink(): return false or a varLink to $expr in $class
Converter::hasSourceCode(): Determine whether an element's file has generated source code, used for linking to line numbers of source.
Converter::hasTutorial()
Converter::highlightDocBlockSource(): Used to allow converters to format the source code of DocBlocks the way they'd like.
Converter::highlightSource(): Used to allow converters to format the source code the way they'd like.
Converter::highlightTutorialSource(): Used to allow converters to format the source code of Tutorial XML the way they'd like.
Converter::Italicize(): Used to convert the contents of <i> in a docblock
Converter::Kbdize(): Used to convert the contents of <kbd> in a docblock
Converter::ListItem(): Used to convert the contents of <li> in a docblock
Converter::newSmarty(): Return a Smarty template object to operate with
Converter::Output(): do all necessary output
Converter::postProcess(): This version does nothing
Converter::prepareDocBlock(): convert the element's DocBlock for output
Converter::PreserveWhiteSpace(): Used to convert the contents of <pre> in a docblock
Converter::ProgramExample(): Used to convert the <code> tag in a docblock
Converter::returnLink(): take URL $link and text $text and return a link in the format needed for the Converter
Converter::returnSee(): take abstractLink descendant and text $eltext and return a link
Converter::Sampize(): Used to convert the contents of <samp> in a docblock
Converter::setSourcePaths(): Mark a file as having had source code highlighted
Converter::setTargetDir(): Sets the output directory for generated documentation
Converter::setTemplateBase(): Set the template directory with a different template base directory
Converter::setTemplateDir(): sets the template directory based on the $outputformat and $name
Converter::sortPageContentsByElementType(): sorts $page_contents by element type as well as alphabetically
Converter::sourceLine(): Return a line of highlighted source code with formatted line number
Converter::startHighlight(): Initialize highlight caching
Converter::TranslateEntity(): Used to translate an XML DocBook entity like ” from a tutorial by reading the options.ini file for the template.
Converter::TranslateTag(): Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.
Converter::TutorialExample()
Converter::type_adjust(): Called by parserReturnTag::Convert() to allow converters to change type names to desired formatting
Converter::unmangle(): Called by parserSourceInlineTag::stringConvert() to allow converters to format the source code the way they'd like.
Converter::vardump_tree(): Debugging function for dumping $tutorial_tree
Converter::Varize(): Used to convert the contents of <var> in a docblock
Converter::walk(): called by phpDocumentor_IntermediateParser::Convert() to traverse the array of pages and their elements, converting them to the output format
Converter::walk_everything(): walk over elements by package rather than page
Converter::writeExample(): Write out the formatted source code for an example php file
Converter::writeFile(): Writes a file to target dir
Converter::writeSource(): Write out the formatted source code for a php file
Converter::_rmdir(): Completely remove a directory and its contents
Converter::_setHighlightCache()
Converter::_tutorial_path(): Returns the path to this tutorial as a string

Class Details

XML DocBook converter.

This Converter takes output from the Parser and converts it to DocBook output

Class Variables

$base_dir

[line 101]

target directory passed on the command-line.

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

Type: string

Overrides:

[ Top ]

$category

[line 162]

peardoc2 Category

Type: string

Overrides:

[ Top ]

$class

[line 82]

name of current class being converted

Type: string

Overrides: Array

[ Top ]

$class_data

[line 113]

template for the class currently being processed

Type: Template

Overrides: Array

[ Top ]

$class_dir

[line 107]

output directory for the current class being processed

Type: string

Overrides:

[ Top ]

$current

[line 138]

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

Type: array

Overrides:

[ Top ]

$currentclass

[line 144]

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

Type: array

Overrides:

[ Top ]

$function_data = array()

[line 155]

Type: mixed

Overrides:

[ Top ]

$juststarted = false

[line 132]

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:

[ Top ]

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

[line 59]

indexes of elements by package that need to be generated

Type: array

Overrides: Array

[ Top ]

$local = true

[line 64]

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

Type: boolean

Overrides:

[ Top ]

$method_data = array()

[line 156]

Type: mixed

Overrides:

[ Top ]

$name = 'DocBook'

[line 54]

Type: string

Overrides:

[ Top ]

$outputformat = 'XML'

[line 52]

Type: string

Overrides: Array

[ Top ]

$package_pages = array()

[line 120]

array of converted package page names.

Used to link to the package page in the left index

$page

[line 70]

name of current page being converted

Type: string

Overrides: Array

[ Top ]

$page_data

[line 88]

template for the procedural page currently being processed

Type: Template

Overrides: Array

[ Top ]

$page_dir

[line 94]

output directory for the current procedural page being processed

Type: string

Overrides:

[ Top ]

$path

[line 76]

path of current page being converted

Type: string

Overrides: Array

[ Top ]

$sort_page_contents_by_type = true

[line 50]

XMLDocBookConverter wants elements sorted by type as well as alphabetically

$sourceloc = ''

[line 157]

Type: mixed

Overrides:

[ Top ]

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

[line 153]

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

[ Top ]

Class Methods

XMLDocBookConverter

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

[line 167]

sets $base_dir to $targetDir

Parameters:

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

[ Top ]

convertClass

void convertClass( parserClass &$element)

[line 811]

Converts class for template output

Tags:

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

Parameters:

parserClass &$element -

[ Top ]

convertDefine

void convertDefine( parserDefine &$element)

[line 1021]

Converts defines for template output

Parameters:

parserDefine &$element -

[ Top ]

ConvertErrorLog

void ConvertErrorLog( )

[line 625]

Create errors.html template file output

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

Parameters:

[ Top ]

convertFunction

void convertFunction( parserFunction &$element)

[line 952]

Converts function for template output

Parameters:

parserFunction &$element -

[ Top ]

convertGlobal

void convertGlobal( parserGlobal &$element)

[line 1040]

Converts global variables for template output

Parameters:

parserGlobal &$element -

[ Top ]

convertInclude

void convertInclude( parserInclude &$element)

[line 1003]

Converts include elements for template output

Parameters:

parserInclude &$element -

[ Top ]

convertMethod

void convertMethod( parserMethod &$element)

[line 873]

Converts method for template output

Parameters:

parserMethod &$element -

[ Top ]

convertPackagePage

void convertPackagePage( parserPackagePage &$element)

[line 712]

Converts package page and sets its package as used in $package_pages

Parameters:

parserPackagePage &$element -

[ Top ]

convertPage

void convertPage( parserData &$element)

[line 1062]

converts procedural pages for template output

Parameters:

parserData &$element -

[ Top ]

convertTutorial

void convertTutorial( &$element)

[line 736]

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

Parameters:

&$element -

[ Top ]

convertVar

void convertVar( parserVar &$element)

[line 774]

Converts class variables for template output.

Parameters:

parserVar &$element -

[ Top ]

endClass

void endClass( )

[line 217]

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

Parameters:

[ Top ]

endPage

void endPage( )

[line 249]

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

Parameters:

[ Top ]

formatIndex

void formatIndex( )

[line 360]

HTMLdefaultConverter uses this function to format template index.html and packages.html

This function generates the package list from $all_packages, eliminating any packages that don't have any entries in their package index (no files at all, due to @ignore or other factors). Then it uses the default package name as the first package index to display. It sets the right pane to be either a blank file with instructions on making package-level docs, or the package-level docs for the default package.

Parameters:

[ Top ]

formatLeftIndex

void formatLeftIndex( )

[line 438]

Generate indexes for li_package.html and classtree output files

This function generates the li_package.html files from the template file left.html. It does this by iterating through each of the $page_elements, $class_elements and $function_elements arrays to retrieve the pre-sorted abstractLink descendants needed for index generation. Conversion of these links to text is done by returnSee(). The $local parameter is set to false to ensure that paths are correct.

Then it uses generateFormattedClassTrees() to create class trees from the template file classtrees.html. Output filename is classtrees_packagename.html. This function also unsets $elements and $pkg_elements to free up the considerable memory these two class vars use

Parameters:

[ Top ]

formatPkgIndex

void formatPkgIndex( )

[line 327]

HTMLdefaultConverter chooses to format both package indexes and the complete index here

This function formats output for the elementindex.html and pkgelementindex.html template files. It then writes them to the target directory

Parameters:

[ Top ]

generateElementIndex

void generateElementIndex( )

[line 1260]

Generate alphabetical index of all elements

Parameters:

[ Top ]

generateFormattedClassTree

array generateFormattedClassTree( parserClass $class)

[line 1122]

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

Parameters:

parserClass $class - class variable

[ Top ]

generateFormattedClassTrees

void generateFormattedClassTrees( string $package)

[line 1172]

returns a template-enabled array of class trees

Parameters:

string $package - package to generate a class tree for

[ Top ]

generatePkgElementIndex

void generatePkgElementIndex( string $package)

[line 1448]

Generate alphabetical index of all elements by package and subpackage

Parameters:

string $package - name of a package

[ Top ]

generatePkgElementIndexes

void generatePkgElementIndexes( )

[line 1588]

Parameters:

[ Top ]

getCData

void getCData( $value)

[line 703]

Parameters:

$value -

[ Top ]

getClassLink

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

[line 1628]

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 -

[ Top ]

getDefineLink

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

[line 1660]

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

[ Top ]

getFunctionLink

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

[line 1644]

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

[ Top ]

getGlobalLink

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

[line 1676]

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

[ Top ]

getId

string getId( mixed &$el)

[line 574]

Get the id value needed to allow linking

Parameters:

mixed &$el - descendant of parserElement or parserData/parserPage

[ Top ]

getLink

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

[line 175]

do that stuff in $template_options

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

Parameters:

$expr -
$package -
$packages -

[ Top ]

getMethodLink

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

[line 1709]

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

[ Top ]

getPageLink

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

[line 1692]

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

[ Top ]

getPageName

void getPageName( &$element)

[line 1109]

Parameters:

&$element -

[ Top ]

getRootTree

string getRootTree( array $tree, $package)

[line 1191]

return formatted class tree for the Class Trees page

Parameters:

array $tree - output from getSortedClassTreeFromClass()
$package -

[ Top ]

getTutorialId

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

[line 696]

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

Parameters:

$package -
$subpackage -
$tutorial -
$id -

[ Top ]

getVarLink

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

[line 1726]

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

[ Top ]

makeLeft

void makeLeft( )

[line 282]

Parameters:

[ Top ]

Output

void Output( )

[line 1783]

This function is not used by HTMLdefaultConverter, but is required by Converter

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

Parameters:

[ Top ]

postProcess

void postProcess( $text)

[line 686]

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

Parameters:

$text -

[ Top ]

prepareDocBlock

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

[line 691]

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

Parameters:

&$element -
$nopackage -

[ Top ]

rcNatCmp

int rcNatCmp( mixed $a, mixed $b)

[line 1740]

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

Parameters:

mixed $a -
mixed $b -

[ Top ]

rcNatCmp1

int rcNatCmp1( mixed $a, mixed $b)

[line 1756]

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

this one puts constructors first

Parameters:

mixed $a -
mixed $b -

[ Top ]

returnLink

string returnLink( string $link, string $text)

[line 277]

Parameters:

string $link -
string $text -

[ Top ]

returnSee

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

[line 476]

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 <a> tag

[ Top ]

setTargetDir

void setTargetDir( $dir)

[line 1388]

calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied

Parameters:

$dir -

[ Top ]

setTemplateDir

void setTemplateDir( $dir)

[line 1378]

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

Parameters:

$dir -

[ Top ]

SmartyInit

void &SmartyInit( &$templ)

[line 205]

Parameters:

&$templ -

[ Top ]

type_adjust

void type_adjust( $typename)

[line 186]

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

Parameters:

$typename -

[ Top ]

unmangle

void unmangle( $s, $sourcecode)

[line 180]

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

Parameters:

$s -
$sourcecode -

[ Top ]

writeNewPPage

void writeNewPPage( $key)

[line 406]

Parameters:

$key -

[ Top ]

Class: XMLDocBookConverter

Class Overview [line 43]

Author(s):

Version:

Copyright:

Variables

Constants

Methods

Inherited Variables

Class: Converter

Inherited Constants

Inherited Methods

Class: Converter

Class Details

Tags:

Class Variables

$base_dir

$category

$class

$class_data

$class_dir

$current

$currentclass

$function_data = array()

$juststarted = false

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

$local = true

$method_data = array()

$name = 'DocBook'

$outputformat = 'XML'

$package_pages = array()

Tags:

$page

$page_data

$page_dir

$path

$sort_page_contents_by_type = true

Tags:

$sourceloc = ''

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

Class Methods

XMLDocBookConverter

Tags:

Parameters:

convertClass

Tags:

Parameters:

convertDefine

Tags:

Parameters:

ConvertErrorLog

Tags:

Parameters:

convertFunction

Tags:

Parameters:

convertGlobal

Tags:

Parameters:

convertInclude

Tags:

Parameters:

convertMethod

Tags:

Parameters:

convertPackagePage

Parameters:

convertPage

Tags:

Parameters:

convertTutorial

Parameters:

convertVar

Tags:

Parameters:

endClass

Tags:

Parameters:

endPage

Tags: