Class: XMLDocBookpeardoc2Converter

Source Location: /phpDocumentor/Converters/XML/DocBook/peardoc2/XMLDocBookpeardoc2Converter.inc

Class Overview

Converter
   |
   --XMLDocBookpeardoc2Converter

XML DocBook converter.

Author(s):

Greg Beaver <[email protected]>

Version:

$Id: XMLDocBookpeardoc2Converter.inc 234423 2007-04-24 21:32:15Z 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::$quietmode
Converter::$smarty_dir
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 58]
XML DocBook converter.

This Converter takes output from the Parser and converts it to DocBook output for PEAR documentation.

This Converter differs from the parent DocBook Converter in that it does not recognize the possibility of procedural pages or of functions! All functions must be defined as static methods for namespace purposes. In addition, all constants and global variables for a package are grouped together as per peardoc2 requirements. Include statements are not documented. If you want to document a normal project, don't use the peardoc2 converter, use the DocBook converter.

Tags:

author:	Greg Beaver <[email protected]>
version:	$Id: XMLDocBookpeardoc2Converter.inc 234423 2007-04-24 21:32:15Z ashnazg $
since:	1.2

[ Top ]

Class Variables

$base_dir =

[line 134]

target directory passed on the command-line.

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

Type:

string

[ Top ]

$category =

[line 207]

peardoc2 Category

Type:

string

[ Top ]

$class =

[line 103]

name of current class being converted

Type:	string
Overrides:	Array

[ Top ]

$class_data =

[line 146]

template for the class currently being processed

Type:	Template
Overrides:	Array

[ Top ]

$class_dir =

[line 140]

output directory for the current class being processed

Type:

string

[ Top ]

$current =

[line 176]

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

Type:

array

[ Top ]

$currentclass =

[line 182]

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

Type:

array

[ Top ]

$function_data = array()

[line 198]

Type:

mixed

[ Top ]

$juststarted = false

[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

[ Top ]

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

[line 80]

indexes of elements by package that need to be generated

Type:	array
Overrides:	Array

[ Top ]

$local = true

[line 85]

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

Type:

mixed

[ Top ]

$name = 'DocBook/peardoc2'

[line 75]

Type:

string

[ Top ]

$outputformat = 'XML'

[line 73]

Type:	string
Overrides:	Array

[ Top ]

$packagexml =

[line 159]

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

Type:

Smarty

[ Top ]

$package_pages = array()

[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

[ Top ]

$page =

[line 91]

name of current page being converted

Type:	string
Overrides:	Array

[ Top ]

$page_data =

[line 109]

template for the procedural page currently being processed

Type:	Template
Overrides:	Array

[ Top ]

$page_dir =

[line 115]

output directory for the current procedural page being processed

Type:

string

[ Top ]

$path =

[line 97]

path of current page being converted

Type:	string
Overrides:	Array

[ Top ]

$processSpecialRoots = true

[line 65]

This converter knows about the new root tree processing

In order to fix PEAR Bug #6389

Type:	boolean
Overrides:	Array

[ Top ]

$sort_absolutely_everything = true

[line 187]

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

Type:	mixed
Overrides:	Array

[ Top ]

$sort_page_contents_by_type = true

[line 71]

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

Type:

mixed

[ Top ]

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

[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

[ Top ]

$_peardoc2_constants = false

[line 121]

Constants, used for constants.tpl

Type:

array

[ Top ]

$_peardoc2_globals = false

[line 127]

Global Variables, used for globals.tpl

Type:

array

[ Top ]

$_write_constants_xml = array()

[line 200]

Type:

mixed

[ Top ]

$_write_globals_xml = array()

[line 201]

Type:

mixed

[ Top ]

Class Methods

constructor XMLDocBookpeardoc2Converter [line 220]

XMLDocBookpeardoc2Converter XMLDocBookpeardoc2Converter(

&$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 addSummaryToPackageXml [line 345]

void addSummaryToPackageXml(

$template_output)

Parameters:

$template_output

[ Top ]

method Br [line 681]

void Br(

$input)

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

Parameters:

$input

[ Top ]

method convertClass [line 793]

void convertClass(
parserClass
&$element)

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

[ Top ]

method convertDefine [line 1009]

void convertDefine(
parserDefine
&$element)

Converts defines for template output

Tags:

see:

XMLDocBookpeardoc2Converter::prepareDocBlock(), Converter::getFormattedConflicts()

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

Parameters:

parserDefine

&$element

[ Top ]

method ConvertErrorLog [line 565]

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

void convertFunction(
parserFunction
&$element)

Converts function for template output - does nothing in peardoc2!

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

Parameters:

parserFunction

&$element

[ Top ]

method convertGlobal [line 1049]

void convertGlobal(
parserGlobal
&$element)

Converts global variables for template output

Tags:

see:

XMLDocBookpeardoc2Converter::prepareDocBlock(), Converter::getFormattedConflicts()

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

Parameters:

parserGlobal

&$element

[ Top ]

method convertInclude [line 989]

void convertInclude(
parserInclude
&$element)

Converts include elements for template output

Completely ignored by this converter

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

Parameters:

parserInclude

&$element

[ Top ]

method convertMethod [line 861]

void convertMethod(
parserMethod
&$element)

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

[ Top ]

method convertPackagePage [line 708]

void convertPackagePage(
parserPackagePage
&$element)

Does nothing - use tutorials for DocBook

Parameters:

parserPackagePage

&$element

[ Top ]

method convertPage [line 1099]

void convertPage(
parserData
&$element)

converts procedural pages for template output

Tags:

see:

XMLDocBookpeardoc2Converter::prepareDocBlock(), Converter::getClassesOnPage()

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

Parameters:

parserData

&$element

[ Top ]

method convertTutorial [line 716]

void convertTutorial(
parserTutorial
&$element)

Convert tutorials for output

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

Parameters:

parserTutorial

&$element

[ Top ]

method convertVar [line 755]

void convertVar(
parserVar
&$element)

Does nothing in this converter

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

Parameters:

parserVar

&$element

[ Top ]

method endClass [line 322]

void endClass(
)

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

[ Top ]

method exampleProgramExample [line 276]

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

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

[ Top ]

method flushPackageXml [line 353]

void flushPackageXml(
parserClass|false
$element)

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

[ Top ]

method formatIndex [line 419]

void formatIndex(
)

Does nothing

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

[ Top ]

method formatLeftIndex [line 440]

void formatLeftIndex(
)

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

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

[ Top ]

method formatPkgIndex [line 412]

void formatPkgIndex(
)

Does nothing

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

[ Top ]

method generateChildClassList [line 1165]

void generateChildClassList(
parserClass
$class)

returns a list of child classes

Tags:

uses:

parserClass::getChildClassList()

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

Parameters:

parserClass

$class

class variable

[ Top ]

method generateElementIndex [line 1378]

void generateElementIndex(
)

does nothing

[ Top ]

method generateFormattedClassTree [line 1124]

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

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 generateFormattedInterfaceTrees [line 1255]

void generateFormattedInterfaceTrees(
string
$package)

returns a template-enabled array of interface inheritance trees

Tags:

see:

$roots, HTMLConverter::getRootTree()

Parameters:

string

$package

package to generate a class tree for

[ Top ]

method generatePkgElementIndex [line 1394]

void generatePkgElementIndex(
string
$package)

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

[ Top ]

method generatePkgElementIndexes [line 1402]

void generatePkgElementIndexes(
)

Tags:

see:

XMLDocBookpeardoc2Converter::generatePkgElementIndex()

[ Top ]

method getCData [line 686]

void getCData(

$value)

Parameters:

$value

[ Top ]

method getClassLink [line 1415]

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

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 getExampleLink [line 290]

void getExampleLink(

$unused, 
$title)

Parameters:

	$unused
	$title

[ Top ]

method getFunctionLink [line 1431]

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

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

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

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

[ Top ]

method getLink [line 237]

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

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

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

void getPageName(

&$element)

Parameters:

&$element

[ Top ]

method getRootTree [line 1312]

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

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

[ Top ]

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.

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

[ Top ]

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

[ Top ]

method getVarLink [line 1513]

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

void makeLeft(
)

[ Top ]

method Output [line 1575]

void Output(
)

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

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

[ Top ]

method postProcess [line 626]

void postProcess(

$text)

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

Parameters:

$text

[ Top ]

method prepareDocBlock [line 631]

void prepareDocBlock(

&$element, [
$nopackage = true])

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

Parameters:

	&$element
	$nopackage

[ Top ]

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

[ Top ]

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

[ Top ]

method rcNatCmp1 [line 1543]

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

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

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

[ Top ]

method setTemplateDir [line 1382]

void setTemplateDir(

$dir)

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

Parameters:

$dir

[ Top ]

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

[ Top ]

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

[ Top ]

method wordwrap [line 1567]

void wordwrap(

$string)

Parameters:

$string

[ Top ]

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

[ Top ]

method writeFile [line 254]

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

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

[ Top ]

method writeNewPPage [line 426]

void writeNewPPage(

$key)

Does nothing

Parameters:

$key

[ Top ]

method writeSource [line 433]

void writeSource(
)

Does nothing

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

[ Top ]

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