Class: XMLDocBookConverter

Source Location: /phpDocumentor/Converters/XML/DocBook/XMLDocBookConverter.inc

Class Overview

Converter
   |
   --XMLDocBookConverter

XML DocBook converter.

Author(s):

Greg Beaver <[email protected]>

Version:

$Id: XMLDocBookConverter.inc 317233 2011-09-24 04:30:11Z ashnazg $

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

[line 43]
XML DocBook converter.

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

Tags:

author:	Greg Beaver <[email protected]>
version:	$Id: XMLDocBookConverter.inc 317233 2011-09-24 04:30:11Z ashnazg $
see:	parserDocBlock, parserInclude, parserPage, parserClass, parserDefine, parserFunction, parserMethod, parserVar
todo:	templates
todo:	indexes for other DocBook converters not based on peardoc
since:	1.0

[ Top ]

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

[ Top ]

$category =

[line 162]

peardoc2 Category

Type:

string

[ 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

[ Top ]

$current =

[line 138]

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

Type:

array

[ Top ]

$currentclass =

[line 144]

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

Type:

array

[ Top ]

$function_data = array()

[line 155]

Type:

mixed

[ 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

[ 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

[ Top ]

$method_data = array()

[line 156]

Type:

mixed

[ Top ]

$name = 'DocBook'

[line 54]

Type:

string

[ 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

Tags:

var:

Format: array(package => 1)

Type:

array

[ Top ]

$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

[ 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

Tags:

see:

Converter::$sort_page_contents_by_type

Type:	boolean
Overrides:	Array

[ Top ]

$sourceloc = ''

[line 157]

Type:

mixed

[ 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

constructor XMLDocBookConverter [line 167]

XMLDocBookConverter XMLDocBookConverter(

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

sets $base_dir to $targetDir

Tags:

see:

Converter::Converter()

Parameters:

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

[ Top ]

method convertClass [line 811]

void convertClass(
parserClass
&$element)

Converts class for template output

Tags:

see:	Converter::getFormattedInheritedMethods(), Converter::getFormattedInheritedVars()
see:	XMLDocBookConverter::prepareDocBlock(), Converter::generateChildClassList(), XMLDocBookConverter::generateFormattedClassTree(), Converter::getFormattedConflicts()

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

Parameters:

parserClass

&$element

[ Top ]

method convertDefine [line 1021]

void convertDefine(
parserDefine
&$element)

Converts defines for template output

Tags:

see:

XMLDocBookConverter::prepareDocBlock(), Converter::getFormattedConflicts()

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

Parameters:

parserDefine

&$element

[ Top ]

method ConvertErrorLog [line 625]

void ConvertErrorLog(
)

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)

[ Top ]

method convertFunction [line 952]

void convertFunction(
parserFunction
&$element)

Converts function for template output

Tags:

see:

XMLDocBookConverter::prepareDocBlock(), parserFunction::getFunctionCall(), Converter::getFormattedConflicts()

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

Parameters:

parserFunction

&$element

[ Top ]

method convertGlobal [line 1040]

void convertGlobal(
parserGlobal
&$element)

Converts global variables for template output

Tags:

see:

XMLDocBookConverter::prepareDocBlock(), Converter::getFormattedConflicts()

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

Parameters:

parserGlobal

&$element

[ Top ]

method convertInclude [line 1003]

void convertInclude(
parserInclude
&$element)

Converts include elements for template output

Tags:

see:

XMLDocBookConverter::prepareDocBlock()

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

Parameters:

parserInclude

&$element

[ Top ]

method convertMethod [line 873]

void convertMethod(
parserMethod
&$element)

Converts method for template output

Tags:

see:

XMLDocBookConverter::prepareDocBlock(), parserMethod::getFunctionCall(), Converter::getFormattedDescMethods(), Converter::getFormattedOverrides()

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

Parameters:

parserMethod

&$element

[ Top ]

method convertPackagePage [line 712]

void convertPackagePage(
parserPackagePage
&$element)

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

Parameters:

parserPackagePage

&$element

[ Top ]

method convertPage [line 1062]

void convertPage(
parserData
&$element)

converts procedural pages for template output

Tags:

see:

XMLDocBookConverter::prepareDocBlock(), Converter::getClassesOnPage()

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

Parameters:

parserData

&$element

[ Top ]

method convertTutorial [line 736]

void convertTutorial(

&$element)

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

Parameters:

&$element

[ Top ]

method convertVar [line 774]

void convertVar(
parserVar
&$element)

Converts class variables for template output.

Tags:

see:

XMLDocBookConverter::prepareDocBlock(), Converter::getFormattedOverrides()

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

Parameters:

parserVar

&$element

[ Top ]

method endClass [line 217]

void endClass(
)

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

Tags:

see:	Converter::endClass()
see:	registerCurrentClass()

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

[ Top ]

method endPage [line 249]

void endPage(
)

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

Tags:

see:	Converter::endPage()
see:	registerCurrent()

Overrides Converter::endPage() (Called by walk() while converting, when the last procedural page element has been parsed.)

[ Top ]

method formatIndex [line 360]

void formatIndex(
)

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.

Tags:

global:

string $phpDocumentor_DefaultPackageName: Used to set the starting package to display

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

[ Top ]

method formatLeftIndex [line 438]

void formatLeftIndex(
)

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

Tags:

see:

Converter::$page_elements, Converter::$class_elements, Converter::$function_elements

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

[ Top ]

method formatPkgIndex [line 327]

void formatPkgIndex(
)

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

Tags:

see:

XMLDocBookConverter::generateElementIndex(), XMLDocBookConverter::generatePkgElementIndex()

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

[ Top ]

method generateElementIndex [line 1260]

void generateElementIndex(
)

Generate alphabetical index of all elements

Tags:

see:

Converter::$elements, Converter::walk()

[ Top ]

method generateFormattedClassTree [line 1122]

array generateFormattedClassTree(
parserClass
$class)

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

[ Top ]

method generateFormattedClassTrees [line 1172]

void generateFormattedClassTrees(
string
$package)

returns a template-enabled array of class trees

Tags:

see:

$roots, HTMLConverter::getRootTree()

Parameters:

string

$package

package to generate a class tree for

[ Top ]

method generatePkgElementIndex [line 1448]

void generatePkgElementIndex(
string
$package)

Generate alphabetical index of all elements by package and subpackage

Tags:

see:

Converter::$pkg_elements, Converter::walk(), XMLDocBookConverter::generatePkgElementIndexes()

Parameters:

string

$package

name of a package

[ Top ]

method generatePkgElementIndexes [line 1588]

void generatePkgElementIndexes(
)

Tags:

see:

XMLDocBookConverter::generatePkgElementIndex()

[ Top ]

method getCData [line 703]

void getCData(

$value)

Parameters:

$value

[ Top ]

method getClassLink [line 1628]

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

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

[ Top ]

method getDefineLink [line 1660]

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

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

[ Top ]

method getFunctionLink [line 1644]

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

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

[ Top ]

method getGlobalLink [line 1676]

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

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

[ Top ]

method getId [line 574]

string getId(
mixed
&$el)

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

[ Top ]

method getLink [line 175]

void &getLink(

$expr, [
$package = false], [
$packages = false])

do that stuff in $template_options

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

Parameters:

	$expr
	$package
	$packages

[ Top ]

method getMethodLink [line 1709]

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

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

[ Top ]

method getPageLink [line 1692]

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

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

[ Top ]

method getPageName [line 1109]

void getPageName(

&$element)

Parameters:

&$element

[ Top ]

method getRootTree [line 1191]

string getRootTree(
array
$tree, 
$package)

return formatted class tree for the Class Trees page

Tags:

see:

Classes::$definitechild, XMLDocBookConverter::generateFormattedClassTrees()

Parameters:

array	$tree	output from getSortedClassTreeFromClass()
	$package

[ Top ]

method getTutorialId [line 696]

void getTutorialId(

$package, 
$subpackage, 
$tutorial, 
$id)

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

Parameters:

	$package
	$subpackage
	$tutorial
	$id

[ Top ]

method getVarLink [line 1726]

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

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

[ Top ]

method makeLeft [line 282]

void makeLeft(
)

[ Top ]

method Output [line 1783]

void Output(
)

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

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

[ Top ]

method postProcess [line 686]

void postProcess(

$text)

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

Parameters:

$text

[ Top ]

method prepareDocBlock [line 691]

void prepareDocBlock(

&$element, [
$nopackage = true])

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

Parameters:

	&$element
	$nopackage

[ Top ]

method rcNatCmp [line 1740]

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

[ Top ]

method rcNatCmp1 [line 1756]

int rcNatCmp1(
mixed
$a, mixed
$b)

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 ]

method returnLink [line 277]

string returnLink(
string
$link, string
$text)

Tags:

return:

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

[ Top ]

method returnSee [line 476]

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

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 ]

method setTargetDir [line 1388]

void setTargetDir(

$dir)

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

Tags:

see:

Converter::setTargetDir()

Overrides Converter::setTargetDir() (Sets the output directory for generated documentation)

Parameters:

$dir

[ Top ]

method setTemplateDir [line 1378]

void setTemplateDir(

$dir)

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

Parameters:

$dir

[ Top ]

method SmartyInit [line 205]

void &SmartyInit(

&$templ)

Parameters:

&$templ

[ Top ]

method type_adjust [line 186]

void type_adjust(

$typename)

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

Parameters:

$typename

[ Top ]

method unmangle [line 180]

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

[ Top ]

method writeNewPPage [line 406]

void writeNewPPage(

$key)

Parameters:

$key

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:15:12 -0600 by phpDocumentor 1.4.4