Docs For Class Converter

Converter Converter(
array
&$allp, array
&$packp, Classes
&$classes, ProceduralPages
&$procpages, array
$po, boolean
$pp, boolean
$qm, string
$targetDir, string
$template, string
$title)

Initialize Converter data structures

Parameters:

array	&$allp	$all_packages value
array	&$packp	$package_parents value
Classes	&$classes	$classes value
ProceduralPages	&$procpages	$proceduralpages value
array	$po	$package_output value
boolean	$pp	$parseprivate value
boolean	$qm	$quietmode value
string	$targetDir	$targetDir value
string	$template	$templateDir value
string	$title	(@link $title} value

[ Top ]

string AttrToString(
string
$tag, attribute
$attr, [boolean
$unmodified = false])

Convert the attribute of a Tutorial docbook tag's attribute list

to a string based on the template options.ini

Parameters:

string	$tag	tag name
attribute	$attr	array
boolean	$unmodified	if true, returns attrname="value"...

[ Top ]

string Bolden(
string
$para)

Used to convert the contents of <b> in a docblock

Tags:

usedby:

parserB::Convert()

Parameters:

string

$para

[ Top ]

string Br(
string
$para)

Used to convert <br> in a docblock

Tags:

usedby:

parserBr::Convert()

Overridden in child classes as:

XMLDocBookpeardoc2Converter::Br()

Parameters:

string

$para

[ Top ]

void checkState(
mixed
$state)

Compare parserStringWithInlineTags::Convert() cache state to $state

Tags:

see:	parserStringWithInlineTags::Convert()
abstract:

Parameters:

mixed

$state

[ Top ]

void cleanup(
)

Finish up parsing/cleanup directories

[ Top ]

void Convert(
mixed
&$element)

Convert all elements to output format

This will call ConvertXxx where Xxx is http://www.php.net/ucfirst($element->type). It is expected that a child converter defines a handler for every element type, even if that handler does nothing. phpDocumentor will terminate with an error if a handler doesn't exist.

Tags:

throws:

PDERROR_NO_CONVERT_HANDLER

Parameters:

mixed

&$element

parserElement descendant or parserPackagePage or parserData

[ Top ]

void convertClass(

&$element)

Default Class Handler

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. Sets up the class template. {@, getFormattedConflicts, getFormattedInheritedMethods, and getFormattedInheritedVars are called to complete vital template setup.}}

Overridden in child classes as:

HTMLframesConverter::convertClass(): Converts class for template output

HTMLSmartyConverter::convertClass(): Converts class for template output

XMLDocBookpeardoc2Converter::convertClass(): Converts class for template output

XMLDocBookConverter::convertClass(): Converts class for template output

PDFdefaultConverter::convertClass()

CHMdefaultConverter::convertClass(): Converts class for template output

Parameters:

&$element

[ Top ]

void convertConst(
parserConst
&$element, [
$additions = array()])

Converts class constants for template output.

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template.

This function must be called by a child converter with any extra template variables needed in the parameter $addition

Overridden in child classes as:

HTMLframesConverter::convertConst(): Converts class variables for template output

HTMLSmartyConverter::convertConst(): Converts class variables for template output

PDFdefaultConverter::convertConst()

CHMdefaultConverter::convertConst(): Converts class constants for template output

Parameters:

parserConst	&$element
	$additions

[ Top ]

void convertDefine(
parserDefine
&$element, [array
$addition = array()])

Converts defines for template output

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. This function must be called by a child converter with any extra template variables needed in the parameter $addition {@, this method also uses utility functions getGlobalValue(), getFormattedConflicts()}}

Tags:

uses:

Converter::postProcess() - on define_value template value, makes it displayable

Overridden in child classes as:

HTMLframesConverter::convertDefine(): Converts defines for template output

HTMLSmartyConverter::convertDefine(): Converts defines for template output

XMLDocBookpeardoc2Converter::convertDefine(): Converts defines for template output

XMLDocBookConverter::convertDefine(): Converts defines for template output

PDFdefaultConverter::convertDefine()

CHMdefaultConverter::convertDefine(): Converts defines for template output

Parameters:

parserDefine	&$element
array	$addition	any additional template variables should be in this array

[ Top ]

void ConvertErrorLog(
)

Convert the phpDocumentor parsing/conversion error log

Tags:

abstract:

Overridden in child classes as:

HTMLframesConverter::ConvertErrorLog(): Create errors.html template file output

HTMLSmartyConverter::ConvertErrorLog(): Create errors.html template file output

XMLDocBookpeardoc2Converter::ConvertErrorLog(): Create errors.html template file output

XMLDocBookConverter::ConvertErrorLog(): Create errors.html template file output

CHMdefaultConverter::ConvertErrorLog(): Create errors.html template file output

[ Top ]

void convertFunction(
parserFunction
&$element, [
$addition = array()])

Converts function for template output

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. This function must be called by a child converter with any extra template variables needed in the parameter $addition

Tags:

see:

Converter::prepareDocBlock()

Overridden in child classes as:

HTMLframesConverter::convertFunction(): Converts function for template output

HTMLSmartyConverter::convertFunction(): Converts function for template output

XMLDocBookpeardoc2Converter::convertFunction(): Converts function for template output - does nothing in peardoc2!

XMLDocBookConverter::convertFunction(): Converts function for template output

PDFdefaultConverter::convertFunction()

CHMdefaultConverter::convertFunction(): Converts function for template output

Parameters:

parserFunction	&$element
	$addition

[ Top ]

void convertGlobal(
parserGlobal
&$element, [array
$addition = array()])

Converts global variables for template output

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. This function must be called by a child converter with any extra template variables needed in the parameter $addition {@, this method also uses utility functions getGlobalValue(), getFormattedConflicts()}}

Tags:

uses:

Converter::postProcess() - on global_value template value, makes it displayable

Overridden in child classes as:

HTMLframesConverter::convertGlobal(): Converts global variables for template output

HTMLSmartyConverter::convertGlobal(): Converts global variables for template output

XMLDocBookpeardoc2Converter::convertGlobal(): Converts global variables for template output

XMLDocBookConverter::convertGlobal(): Converts global variables for template output

PDFdefaultConverter::convertGlobal()

CHMdefaultConverter::convertGlobal(): Converts global variables for template output

Parameters:

parserGlobal	&$element
array	$addition	any additional template variables should be in this array

[ Top ]

void convertInclude(
parserInclude
&$element, [
$addition = array()])

Converts includes for template output

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. This function must be called by a child converter with any extra template variables needed in the parameter $addition

Tags:

see:

Converter::prepareDocBlock()

Overridden in child classes as:

HTMLframesConverter::convertInclude(): Converts include elements for template output

HTMLSmartyConverter::convertInclude(): Converts include elements for template output

XMLDocBookpeardoc2Converter::convertInclude(): Converts include elements for template output

XMLDocBookConverter::convertInclude(): Converts include elements for template output

PDFdefaultConverter::convertInclude()

CHMdefaultConverter::convertInclude(): Converts include elements for template output

Parameters:

parserInclude	&$element
	$addition

[ Top ]

void convertMethod(
parserMethod
&$element, [
$additions = array()])

Converts method for template output

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. This function must be called by a child converter with any extra template variables needed in the parameter $addition

Overridden in child classes as:

HTMLframesConverter::convertMethod(): Converts class methods for template output

HTMLSmartyConverter::convertMethod(): Converts class methods for template output

XMLDocBookpeardoc2Converter::convertMethod(): Converts method for template output

XMLDocBookConverter::convertMethod(): Converts method for template output

PDFdefaultConverter::convertMethod()

CHMdefaultConverter::convertMethod(): Converts class methods for template output

Parameters:

parserMethod	&$element
	$additions

[ Top ]

void convertPage(
parserPage
&$element)

Default Page Handler

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. {@, this class uses getSourceLocation() and getClassesOnPage() to set template variables. Also used is getPageName(), to get a Converter-specific name for the page.}}

Overridden in child classes as:

HTMLframesConverter::convertPage(): converts procedural pages for template output

HTMLSmartyConverter::convertPage(): converts procedural pages for template output

XMLDocBookpeardoc2Converter::convertPage(): converts procedural pages for template output

XMLDocBookConverter::convertPage(): converts procedural pages for template output

PDFdefaultConverter::convertPage()

CHMdefaultConverter::convertPage(): converts procedural pages for template output

Parameters:

parserPage

&$element

[ Top ]

string ConvertTitle(
string
$tag, array
$attr, string
$title, string
$cdata)

Convert the title of a Tutorial docbook tag section

to a string based on the template options.ini

Parameters:

string	$tag	tag name
array	$attr
string	$title	title text
string	$cdata

[ Top ]

void ConvertTodoList(
)

Convert the list of all @todo tags

Tags:

abstract:

Overridden in child classes as:

HTMLframesConverter::ConvertTodoList()

HTMLSmartyConverter::ConvertTodoList()

CHMdefaultConverter::ConvertTodoList()

[ Top ]

void &convertTutorial(
parserTutorial
&$element)

Default Tutorial Handler

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. Sets up the tutorial template, and its prev/next/parent links {@ and uses the parserTutorial::prev, parserTutorial::next, parserTutorial::parent links to set up those links.}}

Overridden in child classes as:

HTMLframesConverter::convertTutorial()

HTMLSmartyConverter::convertTutorial()

XMLDocBookpeardoc2Converter::convertTutorial(): Convert tutorials for output

XMLDocBookConverter::convertTutorial()

PDFdefaultConverter::convertTutorial()

CHMdefaultConverter::convertTutorial()

Parameters:

parserTutorial

&$element

[ Top ]

void convertVar(
parserVar
&$element, [
$additions = array()])

Converts class variables for template output.

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template.

This function must be called by a child converter with any extra template variables needed in the parameter $addition

Overridden in child classes as:

HTMLframesConverter::convertVar(): Converts class variables for template output

HTMLSmartyConverter::convertVar(): Converts class variables for template output

XMLDocBookpeardoc2Converter::convertVar(): Does nothing in this converter

XMLDocBookConverter::convertVar(): Converts class variables for template output.

PDFdefaultConverter::convertVar()

CHMdefaultConverter::convertVar(): Converts class variables for template output

Parameters:

parserVar	&$element
	$additions

[ Top ]

void Convert_RIC(
README|INSTALL|CHANGELOG
$name, string
$contents)

Convert README/INSTALL/CHANGELOG file contents to output format

Tags:

abstract:

Overridden in child classes as:

HTMLframesConverter::Convert_RIC(): Convert README/INSTALL/CHANGELOG file contents to output format

HTMLSmartyConverter::Convert_RIC(): Convert README/INSTALL/CHANGELOG file contents to output format

PDFdefaultConverter::Convert_RIC(): Convert README/INSTALL/CHANGELOG file contents to output format

CHMdefaultConverter::Convert_RIC(): Convert README/INSTALL/CHANGELOG file contents to output format

Parameters:

README\|INSTALL\|CHANGELOG	$name
string	$contents	contents of the file

[ Top ]

void copyFile(
string
$file, [
$subdir = ''])

Copies a file from the template directory to the target directory

thanks to Robert Hoffmann for this fix

Parameters:

string	$file
	$subdir

[ Top ]

void createParentDir(
string
$dir)

Recursively creates all subdirectories that don't exist in the $dir path

Parameters:

string

$dir

[ Top ]

string EncloseList(
string
$list, 
$ordered)

Used to convert the contents of <ol> or <ul> in a docblock

Tags:

usedby:

parserList::Convert() - enclose the list

Parameters:

string	$list
	$ordered

[ Top ]

string EncloseParagraph(
string
$para)

Used to enclose a paragraph in a docblock

Parameters:

string

$para

[ Top ]

void endClass(
)

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

A Converter can use this method in any way it pleases. HTMLframesConverter uses it to complete the template for the class and to output its documentation

Tags:

see:	HTMLframesConverter::endClass()
abstract:

Overridden in child classes as:

HTMLframesConverter::endClass(): Writes out the template file of $class_data and unsets the template to save memory

HTMLSmartyConverter::endClass(): Writes out the template file of $class_data and unsets the template to save memory

XMLDocBookpeardoc2Converter::endClass(): Writes out the template file of $class_data and unsets the template to save memory

XMLDocBookConverter::endClass(): Writes out the template file of $class_data and unsets the template to save memory

CHMdefaultConverter::endClass(): Writes out the template file of $class_data and unsets the template to save memory

[ Top ]

void endPage(
)

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

A Converter can use this method in any way it pleases. HTMLframesConverter uses it to complete the template for the procedural page and to output its documentation

Tags:

see:	HTMLframesConverter::endClass()
abstract:

Overridden in child classes as:

HTMLframesConverter::endPage(): Writes out the template file of $page_data and unsets the template to save memory

HTMLSmartyConverter::endPage(): Writes out the template file of $page_data and unsets the template to save memory

XMLDocBookConverter::endPage(): Writes out the template file of $page_data and unsets the template to save memory

CHMdefaultConverter::endPage(): Writes out the template file of $page_data and unsets the template to save memory

[ Top ]

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

Overridden in child classes as:

XMLDocBookpeardoc2Converter::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 ]

string flushHighlightCache(
)

Return the close text for the current token

[ Top ]

void formatIndex(
)

Called by walk() while converting.

This method is intended to be the place that $elements is formatted for output.

Tags:

see:	HTMLframesConverter::formatIndex()
abstract:

Overridden in child classes as:

HTMLframesConverter::formatIndex(): HTMLdefaultConverter uses this function to format template index.html and packages.html

HTMLSmartyConverter::formatIndex(): HTMLdefaultConverter uses this function to format template index.html and packages.html

XMLDocBookpeardoc2Converter::formatIndex(): Does nothing

XMLDocBookConverter::formatIndex(): HTMLdefaultConverter uses this function to format template index.html and packages.html

CHMdefaultConverter::formatIndex(): CHMdefaultConverter uses this function to format template index.html and packages.html

[ Top ]

void formatLeftIndex(
)

Called by walk() while converting.

This method is intended to be the place that any of $class_elements, $function_elements, $page_elements, $define_elements, and $global_elements is formatted for output, depending on the value of $leftindex

Tags:

see:	HTMLframesConverter::formatLeftIndex()
abstract:

Overridden in child classes as:

HTMLframesConverter::formatLeftIndex(): Generate indexes for li_package.html and classtree output files

HTMLSmartyConverter::formatLeftIndex(): Generate indexes for li_package.html and classtree output files

XMLDocBookpeardoc2Converter::formatLeftIndex(): Creates package/lang/categoryname/packagename.xml for each package

XMLDocBookConverter::formatLeftIndex(): Generate indexes for li_package.html and classtree output files

CHMdefaultConverter::formatLeftIndex(): Generate indexes for li_package.html and classtree output files

[ Top ]

void formatPkgIndex(
)

Called by walk() while converting.

This method is intended to be the place that $pkg_elements is formatted for output.

Tags:

see:	HTMLframesConverter::formatPkgIndex()
abstract:

Overridden in child classes as:

HTMLframesConverter::formatPkgIndex(): HTMLdefaultConverter chooses to format both package indexes and the complete index here

HTMLSmartyConverter::formatPkgIndex(): HTMLdefaultConverter chooses to format both package indexes and the complete index here

XMLDocBookpeardoc2Converter::formatPkgIndex(): Does nothing

XMLDocBookConverter::formatPkgIndex(): HTMLdefaultConverter chooses to format both package indexes and the complete index here

CHMdefaultConverter::formatPkgIndex(): CHMdefaultConverter chooses to format both package indexes and the complete index here

[ Top ]

string formatTutorialTOC(
array
$toc)

Creates a table of contents for a {@toc} inline tag in a tutorial

This function should return a formatted table of contents. By default, it does nothing, it is up to the converter to format the TOC

Tags:

return:	table of contents formatted for use in the current output format
abstract:
usedby:	parserTocInlineTag::Convert() - passes an array of format:

Overridden in child classes as:

HTMLframesConverter::formatTutorialTOC(): Use the template tutorial_toc.tpl to generate a table of contents for HTML

HTMLSmartyConverter::formatTutorialTOC(): Use the template tutorial_toc.tpl to generate a table of contents for HTML

CHMdefaultConverter::formatTutorialTOC(): Use the template tutorial_toc.tpl to generate a table of contents for HTML

Parameters:

array

$toc

format: array(array('tagname' => section, 'link' => returnsee link, 'id' => anchor name, 'title' => from title tag),...)

[ Top ]

void generateChildClassList(
parserClass
$class)

returns a list of child classes

Tags:

uses:

parserClass::getChildClassList()

Overridden in child classes as:

XMLDocBookpeardoc2Converter::generateChildClassList(): returns a list of child classes

Parameters:

parserClass

$class

class variable

[ Top ]

string generateFormattedClassTree(
parserClass
$class)

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

This method must be overridden, or phpDocumentor will halt with a fatal error

Tags:

return:	Converter-specific class tree for an individual class
abstract:

Overridden in child classes as:

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

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

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

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

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

Parameters:

parserClass

$class

class variable

[ Top ]

array getClassesOnPage(
parserData
&$element)

gets a list of all classes declared on a procedural page represented by

$element, a parserData class

Tags:

return:

links to each classes documentation

Format:

 array('name' => class name,
       'sdesc' => summary of the class
       'link' => link to the class's documentation)

Parameters:

parserData

&$element

[ Top ]

mixed getClassLink(
string
$expr, string
$package, [
$file = false], [
$text = false])

return false or a classLink to $expr

Tags:

return:	returns a classLink or false if the element is not found in package $package
see:	classLink

Overridden in child classes as:

HTMLframesConverter::getClassLink()

HTMLSmartyConverter::getClassLink()

XMLDocBookpeardoc2Converter::getClassLink()

XMLDocBookConverter::getClassLink()

PDFdefaultConverter::getClassLink()

CHMdefaultConverter::getClassLink()

Parameters:

string	$expr	class name
string	$package	package name
	$file
	$text

[ Top ]

mixed getConstLink(
string
$expr, string
$class, string
$package, [
$file = false], [
$text = false])

return false or a constLink to $expr in $class

Tags:

return:	returns a varLink or false if the element is not found in package $package, class $class
see:	constLink

Overridden in child classes as:

HTMLframesConverter::getConstLink()

HTMLSmartyConverter::getConstLink()

PDFdefaultConverter::getConstLink()

CHMdefaultConverter::getConstLink()

Parameters:

string	$expr	constant name
string	$class	class name
string	$package	package name
	$file
	$text

[ Top ]

string getConverterDir(
)

Get the absolute path to the converter's base directory

[ Top ]

string getCurrentPageLink(
)

Tags:

return:	Link to the current page being parsed. Should return $curname and a converter-specific extension.
abstract:

Overridden in child classes as:

HTMLframesConverter::getCurrentPageLink()

HTMLSmartyConverter::getCurrentPageLink()

CHMdefaultConverter::getCurrentPageLink()

[ Top ]

string getCurrentPageURL(
string
$pathinfo)

Return the path to the current

Parameters:

string

$pathinfo

[ Top ]

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

return false or a defineLink to $expr

Tags:

return:	returns a defineLink or false if the element is not found in package $package
see:	defineLink

Overridden in child classes as:

HTMLframesConverter::getDefineLink()

HTMLSmartyConverter::getDefineLink()

XMLDocBookpeardoc2Converter::getDefineLink()

XMLDocBookConverter::getDefineLink()

PDFdefaultConverter::getDefineLink()

CHMdefaultConverter::getDefineLink()

Parameters:

string	$expr	constant name
string	$package	package name
	$file
	$text

[ Top ]

string getFileSourceName(

$path, string
$pathinfo)

Translate the path info into a unique file name for the highlighted source code.

Overridden in child classes as:

PDFdefaultConverter::getFileSourceName()

Parameters:

string	$pathinfo
	$path

[ Top ]

string getFileSourcePath(
string
$base)

Return the fixed path to the source-code file folder.

Parameters:

string

$base

Path is relative to this folder

[ Top ]

array getFormattedConflicts(
mixed
&$element, string
$type)

Tags:

return:	links to conflicting elements, or empty array
uses:	parserGlobal::getConflicts()
uses:	parserFunction::getConflicts()
uses:	parserDefine::getConflicts()
uses:	parserClass::getConflicts()

Parameters:

mixed	&$element	parserClass, parserFunction, parserDefine or parserGlobal
string	$type	type to display. either 'class','function','define' or 'global variable'

[ Top ]

array getFormattedDescMethods(
parserMethod
&$element)

Get a list of methods in child classes that override this method

Tags:

return:	empty array or array(array('link'=>link to method, 'sdesc'=>short description of the method),...)
uses:	parserMethod::getOverridingMethods()

Parameters:

parserMethod

&$element

[ Top ]

array getFormattedDescVars(
parserVar
&$element)

Get a list of vars in child classes that override this var

Tags:

return:	empty array or array('link'=>link to var, 'sdesc'=>short description of the method
uses:	parserVar::getOverridingVars()

Parameters:

parserVar

&$element

[ Top ]

string getFormattedImplements(
parserClass
$el)

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

This method must be overridden, or phpDocumentor will halt with a fatal error

Tags:

return:	Converter-specific class tree for an individual class
abstract:

Parameters:

parserClass

$el

class variable

[ Top ]

array getFormattedInheritedConsts(
parserConst
$child)

Return template-enabled list of inherited class constants

uses parserConst helper function getInheritedConsts and generates a template-enabled list using getClassLink()

Tags:

return:

Format:

 array(
   array('parent_class' => link to parent class's documentation,
         'ivars' =>
            array(
              array('name' => inherited constant name,
                    'link' => link to inherited constant's documentation,
                    'value' => constant value,
                    'sdesc' => summary of inherited constant),
              ...),
   ...)

see:

Converter::getClassLink(), parserMethod::getInheritedConsts()

Parameters:

parserConst

$child

class constant

[ Top ]

array getFormattedInheritedMethods(
parserMethod
$child)

Return template-enabled list of inherited methods

uses parserMethod helper function getInheritedMethods and generates a template-enabled list using getClassLink()

Tags:

return:

Format:

 array(
   array('parent_class' => link to parent class's documentation,
         'ivars' =>
            array(
              array('name' => inherited variable name,
                    'link' => link to inherited variable's documentation,
                    'function_call' => parserMethod::getIntricateFunctionCall()
                                       returned array,
                    'sdesc' => summary of inherited variable),
              ...),
   ...)

see:

Converter::getClassLink(), parserMethod::getInheritedMethods()

Parameters:

parserMethod

$child

class method

[ Top ]

array getFormattedInheritedVars(
parserVar
$child)

Return template-enabled list of inherited variables

uses parserVar helper function getInheritedVars and generates a template-enabled list using getClassLink()

Tags:

return:

Format:

 array(
   array('parent_class' => link to parent class's documentation,
         'ivars' =>
            array(
              array('name' => inherited variable name,
                    'link' => link to inherited variable's documentation,
                    'default' => default value of inherited variable,
                    'sdesc' => summary of inherited variable),
              ...),
   ...)

see:

Converter::getClassLink(), parserVar::getInheritedVars()

Parameters:

parserVar

$child

class var

[ Top ]

array|false getFormattedMethodImplements(
parserMethod
&$element)

Get the method this method(s) implemented from an interface, if any

Tags:

return:	array('link'=>link to implemented method, 'sdesc'=>short description
uses:	parserMethod::getImplements()

Parameters:

parserMethod

&$element

[ Top ]

array|false getFormattedOverrides(
parserMethod
&$element)

Get the method this method overrides, if any

Tags:

return:	array('link'=>link to overridden method, 'sdesc'=>short description
see:	parserMethod::getOverrides()

Parameters:

parserMethod

&$element

[ Top ]

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

return false or a functionLink to $expr

Tags:

return:	returns a functionLink or false if the element is not found in package $package
see:	functionLink

Overridden in child classes as:

HTMLframesConverter::getFunctionLink()

HTMLSmartyConverter::getFunctionLink()

XMLDocBookpeardoc2Converter::getFunctionLink()

XMLDocBookConverter::getFunctionLink()

PDFdefaultConverter::getFunctionLink()

CHMdefaultConverter::getFunctionLink()

Parameters:

string	$expr	function name
string	$package	package name
	$file
	$text

[ Top ]

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

return false or a globalLink to $expr

Tags:

return:	returns a defineLink or false if the element is not found in package $package
see:	defineLink

Overridden in child classes as:

HTMLframesConverter::getGlobalLink()

HTMLSmartyConverter::getGlobalLink()

XMLDocBookpeardoc2Converter::getGlobalLink()

XMLDocBookConverter::getGlobalLink()

PDFdefaultConverter::getGlobalLink()

CHMdefaultConverter::getGlobalLink()

Parameters:

string	$expr	global variable name (with leading $)
string	$package	package name
	$file
	$text

[ Top ]

string getGlobalValue(
string
$value)

Parse a global variable's default value for class initialization.

If a global variable's default value is "new class" as in:

$globalvar = new Parser

This method will document it not as "new Parser" but instead as "new Parser". For examples, see phpdoc.inc. Many global variables are classes, and phpDocumentor links to their documentation

Tags:

return:

default global variable value with link to class if it's "new Class"

Overridden in child classes as:

PDFdefaultConverter::getGlobalValue()

Parameters:

string

$value

default value of a global variable.

[ Top ]

void getHighlightState(
)

[ Top ]

string getId(
abstractLink
&$link)

take abstractLink descendant and text $eltext and return a

unique ID in the format needed for the Converter

Tags:

return:	unique identifier of $element
abstract:

Overridden in child classes as:

HTMLframesConverter::getId()

HTMLSmartyConverter::getId()

XMLDocBookpeardoc2Converter::getId(): Get the id value needed to allow linking

XMLDocBookConverter::getId(): Get the id value needed to allow linking

CHMdefaultConverter::getId()

Parameters:

abstractLink

&$link

[ Top ]

string getIncludeValue(
string
$value, string
$ipath)

Parse an include's file to see if it is a file documented in this project

Although not very smart yet, this method will try to look for the included file file.ext:

include ("file.ext");

If it finds it, it will return a link to the file's documentation. As of 1.2.0rc1, phpDocumentor is smarty enough to find these cases:

absolute path to file
./file.ext or ../file.ext
relpath/to/file.ext if relpath is a subdirectory of the base parse directory

For examples, see Setup.inc.php includes. Every include auto-links to the documentation for the file that is included

Tags:

return:

included file with link to docs for file, if found

Parameters:

string	$value	file included by include statement.
string	$ipath	path of file that has the include statement

[ Top ]

mixed &getLink(
string
$expr, [string
$package = false], [array
$packages = false])

The meat of the @see tag and inline {@link} tag

$expr is a string with many allowable formats:

proceduralpagename.ext
constant_name
classname::function()
classname::constantname
classname::$variablename
classname
object classname
function functionname()
global $globalvarname
packagename#expr where expr is any of the above

New in version 1.1, you can explicitly specify a package to link to that is different from the current package. Use the # operator to specify a new package, as in tests#bug-540368.php (which should appear as a link like: "bug-540368.php"). This example links to the procedural page bug-540368.php in package tests. Also, the "function" operator is now used to specifically link to a function instead of a method in the current class.

class myclass
{
// from inside the class definition, use "function conflict()" to refer to procedural function "conflict()"
function conflict()
{
}
}
function conflict()
{
}

If classname:: is not present, and the see tag is in a documentation block within a class, then the function uses the classname to search for $expr as a function or variable within classname, or any of its parent classes. given an $expr without '$', '::' or '()' getLink first searches for classes, procedural pages, constants, global variables, and then searches for methods and variables within the default class, and finally for any function

Tags:

return:	getLink returns a descendant of abstractLink if it finds a link, otherwise it returns a string
see:	pageLink, functionLink, defineLink, classLink, methodLink, varLink
see:	Converter::getPageLink(), Converter::getDefineLink(), Converter::getVarLink(), Converter::getFunctionLink(), Converter::getClassLink()

Overridden in child classes as:

XMLDocBookpeardoc2Converter::getLink(): do that stuff in $template_options

XMLDocBookConverter::getLink(): do that stuff in $template_options

Parameters:

string	$expr	expression to search for a link
string	$package	package to start searching in
array	$packages	list of all packages to search in

[ Top ]

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

return false or a methodLink to $expr in $class

Tags:

return:	returns a methodLink or false if the element is not found in package $package, class $class
see:	methodLink

Overridden in child classes as:

HTMLframesConverter::getMethodLink()

HTMLSmartyConverter::getMethodLink()

XMLDocBookpeardoc2Converter::getMethodLink()

XMLDocBookConverter::getMethodLink()

PDFdefaultConverter::getMethodLink()

CHMdefaultConverter::getMethodLink()

Parameters:

string	$expr	method name
string	$class	class name
string	$package	package name
	$file
	$text

[ Top ]

mixed getPageLink(
string
$expr, string
$package, [
$path = false], [
$text = false], [
$packages = false])

return false or a pageLink to $expr

Tags:

return:	returns a pageLink or false if the element is not found in package $package
see:	pageLink

Overridden in child classes as:

HTMLframesConverter::getPageLink()

HTMLSmartyConverter::getPageLink()

XMLDocBookpeardoc2Converter::getPageLink()

XMLDocBookConverter::getPageLink()

PDFdefaultConverter::getPageLink()

CHMdefaultConverter::getPageLink()

Parameters:

string	$expr	procedural page name
string	$package	package name
	$path
	$text
	$packages

[ Top ]

array getSortedClassTreeFromClass(
string
$class, string
$package, string
$subpackage)

Return a tree of all classes that extend this class

The data structure returned is designed for a non-recursive algorithm, and is somewhat complex. In most cases, the array returned is:

 array('#root' =>
         array('link' => classLink to $class,
               'parent' => false,
               'children' => array(array('class' => 'childclass1',
                                         'package' => 'child1package'),
                                    array('class' => 'childclass2',
                                         'package' => 'child2package'),...
                                  )
               ),
       'child1package#childclass1' =>
         array('link' => classLink to childclass1,
               'parent' => '#root',
               'children' => array(array('class' => 'kidclass',
                                         'package' => 'kidpackage'),...
                                  )
              ),
       'kidpackage#kidclass' =>
         array('link' => classLink to kidclass,
               'parent' => 'child1package#childclass1',
               'children' => array() // no children
              ),
      ....
      )

To describe this format using language, every class in the tree has an entry in the first level of the array. The index for all child classes that extend the root class is childpackage#childclassname. Each entry in the array has 3 elements: link, parent, and children.

link - a classLink to the current class
parent - a classLink to the class's parent, or false (except for one special case described below)
children - an array of arrays, each entry has a 'class' and 'package' index to the child class, used to find the entry in the big array

special cases are when the #root class has a parent in another package, or when the #root class extends a class not found by phpDocumentor. In the first case, parent will be a classLink to the parent class. In the second, parent will be the extends clause, as in:

class X extends Y
{
...
}

in this case, the #root entry will be array('link' => classLink to X, 'parent' => 'Y', children => array(...))

The fastest way to design a method to process the array returned is to copy HTMLframesConverter::getRootTree() into your converter and to modify the html to whatever output format you are going to use

Tags:

return:	Format: see docs
see:	HTMLframesConverter::getRootTree()

Parameters:

string	$class	class name
string	$package
string	$subpackage

[ Top ]

string getSourceLink(

$path)

Tags:

return:	an output-format dependent link to phpxref-style highlighted source code
abstract:
usedby:	parserFileSourceTag::getSourceLink()

Overridden in child classes as:

HTMLframesConverter::getSourceLink()

HTMLSmartyConverter::getSourceLink()

PDFdefaultConverter::getSourceLink()

CHMdefaultConverter::getSourceLink()

Parameters:

$path

[ Top ]

void getState(
)

Return parserStringWithInlineTags::Convert() cache state

Tags:

see:	parserStringWithInlineTags::Convert()
abstract:

Overridden in child classes as:

PDFdefaultConverter::getState()

[ Top ]

string getTutorialId(

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

Return a converter-specific id to distinguish tutorials and their sections

Used by {@id}

Tags:

usedby:	parserTocInlineTag::Convert() - retrieve the tutorial ID for
usedby:	parserIdInlineTag::Convert() - retrieve converter-specific ID

Overridden in child classes as:

HTMLframesConverter::getTutorialId()

HTMLSmartyConverter::getTutorialId()

XMLDocBookpeardoc2Converter::getTutorialId()

XMLDocBookConverter::getTutorialId()

PDFdefaultConverter::getTutorialId()

CHMdefaultConverter::getTutorialId()

Parameters:

	$package
	$subpackage
	$tutorial
	$id

[ Top ]

tutorialLink|string getTutorialLink(
string
$expr, [string
$package = false], [string
$subpackage = false], [array
$packages = false])

The meat of the @tutorial tag and inline {@tutorial} tag

Take a string and return an abstract link to the tutorial it represents. Since tutorial naming literally works like the underlying filesystem, the way to reference the tutorial is similar. Tutorials are located in a subdirectory of any directory parsed, which is named 'tutorials/' (we try to make things simple when we can :). They are further organized by package and subpackage as:

tutorials/package/subpackage

and the files are named *.cls, *.pkg, or *.proc, and so a link to a tutorial named file.cls can be referenced (depending on context) as any of:

* @tutorial package/subpackage/file.cls
* @tutorial package/file.cls
* @tutorial file.cls

The first case will only be needed if file.cls exists in both the current package, in anotherpackage/file.cls and in anotherpackage/subpackage/file.cls and you wish to reference the one in anotherpackage/subpackage. The second case is only needed if you wish to reference file.cls in another package and it is unique in that package. the third will link to the first file.cls it finds using this search method:

current package/subpackage
all other subpackages of current package
parent package, if this package has classes that extend classes in another package
all other packages

Tags:

return:	returns either a link, or the original text, if not found
since:	1.2

Parameters:

string	$expr	the original expression
string	$package	package to look in first
string	$subpackage	subpackage to look in first
array	$packages	array of package names to search in if not found in parent packages. This is used to limit the search, phpDocumentor automatically searches all packages

[ Top ]

array getTutorialTree(
parserTutorial|array
$tutorial)

Get a tree structure representing the hierarchy of tutorials

Returns an array in format:

 array('tutorial' => parserTutorial,
       'kids' => array( // child tutorials
                   array('tutorial' => child parserTutorial,
                         'kids' => array(...)
                        )
                      )
      )

Tags:

tutorial:

phpDocumentor Tutorials

Overridden in child classes as:

HTMLframesConverter::getTutorialTree()

HTMLSmartyConverter::getTutorialTree()

Parameters:

parserTutorial|array

$tutorial

[ Top ]

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

return false or a varLink to $expr in $class

Tags:

return:	returns a varLink or false if the element is not found in package $package, class $class
see:	varLink

Overridden in child classes as:

HTMLframesConverter::getVarLink()

HTMLSmartyConverter::getVarLink()

XMLDocBookpeardoc2Converter::getVarLink()

XMLDocBookConverter::getVarLink()

PDFdefaultConverter::getVarLink()

CHMdefaultConverter::getVarLink()

Parameters:

string	$expr	var name
string	$class	class name
string	$package	package name
	$file
	$text

[ Top ]

boolean hasSourceCode(
string
$path)

Determine whether an element's file has generated source code, used for linking to line numbers of source.

Wrapper for $sourcePaths in this version

Parameters:

string

$path

full path to the source code file

[ Top ]

false|parserTutorial hasTutorial(
pkg|cls|proc
$type, tutorial
$name, string
$package, [string
$subpackage = ''])

Tags:

return:

if the tutorial exists, return it

Parameters:

pkg\|cls\|proc	$type	the tutorial type to search for
tutorial	$name	name
string	$package	package name
string	$subpackage	subpackage name, if any

[ Top ]

string highlightDocBlockSource(
string
$token, string
$word, [boolean
$preformatted = false])

Used to allow converters to format the source code of DocBlocks the way they'd like.

default returns it unchanged. Mainly used by the HighlightParser

Parameters:

string	$token	name of docblock token type
string	$word	contents of token
boolean	$preformatted	whether the contents are preformatted or need modification

[ Top ]

string highlightSource(
integer
$token, string
$word, [boolean
$preformatted = false])

Used to allow converters to format the source code the way they'd like.

default returns it unchanged. Mainly used by the HighlightParser

Parameters:

integer	$token	token value from tokenizer constants
string	$word	contents of token
boolean	$preformatted	whether the contents are preformatted or need modification

[ Top ]

string highlightTutorialSource(
string
$token, string
$word, [boolean
$preformatted = false])

Used to allow converters to format the source code of Tutorial XML the way they'd like.

default returns it unchanged. Mainly used by the HighlightParser

Parameters:

string	$token	name of docblock token type
string	$word	contents of token
boolean	$preformatted	whether the contents are preformatted or need modification

[ Top ]

string Italicize(
string
$para)

Used to convert the contents of <i> in a docblock

Tags:

usedby:

parserI::Convert()

Parameters:

string

$para

[ Top ]

string Kbdize(
string
$para)

Used to convert the contents of <kbd> in a docblock

Tags:

usedby:

parserKbd::Convert()

Parameters:

string

$para

[ Top ]

string ListItem(
string
$item)

Used to convert the contents of <li> in a docblock

Tags:

usedby:

parserList::Convert() - enclose each item of the list

Parameters:

string

$item

[ Top ]

Smarty &newSmarty(
)

Return a Smarty template object to operate with

This returns a Smarty template with pre-initialized variables for use. If the method "SmartyInit()" exists, it is called.

[ Top ]

void Output(

$title)

do all necessary output

Tags:

see:	Converter
abstract:
usedby:	phpDocumentor_IntermediateParser::Convert()

Overridden in child classes as:

HTMLframesConverter::Output(): This function is not used by HTMLdefaultConverter, but is required by Converter

HTMLSmartyConverter::Output(): This function is not used by HTMLdefaultConverter, but is required by Converter

XMLDocBookpeardoc2Converter::Output(): Generate the constants.xml, packagename.xml, and globals.xml files

XMLDocBookConverter::Output(): This function is not used by HTMLdefaultConverter, but is required by Converter

PDFdefaultConverter::Output(): calls Cezpdf::ezOutput() and writes documentation.pdf to targetDir

CHMdefaultConverter::Output(): Create the phpdoc.hhp, contents.hhc files needed by MS HTML Help Compiler to create a CHM file

Parameters:

$title

[ Top ]

string postProcess(

$text)

This version does nothing

Perform necessary post-processing of string data. For example, the HTML Converters should escape < and > to become < and >

Tags:

usedby:	Converter::convertDefine() - on define_value template value, makes it displayable
usedby:	Converter::convertGlobal() - on global_value template value, makes it displayable

Overridden in child classes as:

HTMLframesConverter::postProcess(): Uses htmlspecialchars() on the input

HTMLSmartyConverter::postProcess(): Uses htmlspecialchars() on the input

XMLDocBookpeardoc2Converter::postProcess()

XMLDocBookConverter::postProcess()

PDFdefaultConverter::postProcess()

CHMdefaultConverter::postProcess(): Uses htmlspecialchars() on the input

Parameters:

$text

[ Top ]

array prepareDocBlock(
mixed
&$element, [array
$names = array()], [boolean
$nopackage = true])

convert the element's DocBlock for output

This function converts all tags and descriptions for output

Tags:

return:

Format:

 array('sdesc' => DocBlock summary
       'desc' => DocBlock detailed description
       'tags' => array('keyword' => tagname, 'data' => tag description)
                 known tags
       'api_tags' => array('keyword' => tagname, 'data' => tag description)
                 known api documentation tags
       'info_tags' => array('keyword' => tagname, 'data' => tag description)
                 known informational tags
     [ 'utags' => array('keyword' => tagname, 'data' => tag description
                 unknown tags ]
     [ 'vartype' => type from @var/@return tag ]
     [ 'var_descrip' => description from @var/@return tag ]
      )

Overridden in child classes as:

XMLDocBookpeardoc2Converter::prepareDocBlock()

XMLDocBookConverter::prepareDocBlock()

Parameters:

mixed	&$element	any descendant of parserElement, or parserData
array	$names	used to translate tagnames into other tags
boolean	$nopackage	set to false for pages and classes, the only elements allowed to specify @package

[ Top ]

string PreserveWhiteSpace(
string
$string)

Used to convert the contents of <pre> in a docblock

Tags:

usedby:

parserPre::Convert()

Parameters:

string

$string

[ Top ]

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

Used to convert the <code> tag in a docblock

Tags:

usedby:

parserCode::Convert()

Overridden in child classes as:

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

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

XMLDocBookpeardoc2Converter::ProgramExample()

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

Parameters:

string	$example
boolean	$tutorial	true if this is to highlight a tutorial <programlisting>
	$inlinesourceparse
	$class
	$linenum
	$filesourcepath

[ Top ]

string returnLink(
string
$link, string
$text)

take URL $link and text $text and return a link in the format needed for the Converter

Tags:

return:	link to $link
abstract:

Overridden in child classes as:

HTMLframesConverter::returnLink()

HTMLSmartyConverter::returnLink()

XMLDocBookpeardoc2Converter::returnLink()

XMLDocBookConverter::returnLink()

PDFdefaultConverter::returnLink()

CHMdefaultConverter::returnLink()

Parameters:

string	$link	URL
string	$text	text to display

[ Top ]

string returnSee(
abstractLink
&$link, [string
$eltext = false])

take abstractLink descendant and text $eltext and return a link

in the format needed for the Converter

Tags:

return:	link to $element
abstract:

Overridden in child classes as:

HTMLframesConverter::returnSee(): This function takes an abstractLink descendant and returns an html link

HTMLSmartyConverter::returnSee(): This function takes an abstractLink descendant and returns an html link

XMLDocBookpeardoc2Converter::returnSee(): This function takes an abstractLink descendant and returns an html link

XMLDocBookConverter::returnSee(): This function takes an abstractLink descendant and returns an html link

PDFdefaultConverter::returnSee(): Returns a bookmark using Cezpdf 009

CHMdefaultConverter::returnSee(): This function takes an abstractLink descendant and returns an html link

Parameters:

abstractLink	&$link
string	$eltext

[ Top ]

string Sampize(
string
$para)

Used to convert the contents of <samp> in a docblock

Tags:

usedby:

parserSamp::Convert()

Parameters:

string

$para

[ Top ]

void setSourcePaths(
string
$path)

Mark a file as having had source code highlighted

Parameters:

string

$path

full path of source file

[ Top ]

void setTargetDir(
string
$dir)

Sets the output directory for generated documentation

As of 1.3.0RC6, this also sets the compiled templates directory inside the target directory

Overridden in child classes as:

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

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

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

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

Parameters:

string

$dir

the output directory

[ Top ]

void setTemplateBase(
string
$base, string
$dir)

Set the template directory with a different template base directory

Tags:

tutorial:

phpDocumentor Tutorial

Parameters:

string	$base	template base directory
string	$dir	template name

[ Top ]

void setTemplateDir(
string
$dir)

sets the template directory based on the $outputformat and $name

Also sets $templateName to the $dir parameter

Overridden in child classes as:

XMLDocBookpeardoc2Converter::setTemplateDir()

XMLDocBookConverter::setTemplateDir()

PDFdefaultConverter::setTemplateDir()

CHMdefaultConverter::setTemplateDir()

Parameters:

string

$dir

subdirectory

[ Top ]

void sortPageContentsByElementType(

&$pages)

sorts $page_contents by element type as well as alphabetically

Tags:

see:

$sort_page_contents_by_element_type

Parameters:

&$pages

[ Top ]

string sourceLine(
integer
$linenumber, string
$line, [false|string
$path = false])

Return a line of highlighted source code with formatted line number

If the $path is a full path, then an anchor to the line number will be added as well

Tags:

return:

formatted source code line with line number

Overridden in child classes as:

HTMLframesConverter::sourceLine(): Return a line of highlighted source code with formatted line number

HTMLSmartyConverter::sourceLine(): Return a line of highlighted source code with formatted line number

CHMdefaultConverter::sourceLine(): Return a line of highlighted source code with formatted line number

Parameters:

integer	$linenumber	line number
string	$line	highlighted source code line
false\|string	$path	full path to @filesource file this line is a part of, if this is a single line from a complete file.

[ Top ]

void startHighlight(
)

Initialize highlight caching

[ Top ]

void TranslateEntity(
string
$name)

Used to translate an XML DocBook entity like ” from a tutorial by reading the options.ini file for the template.

Tags:

usedby:

parserEntity::Convert() - convert contents to text

Parameters:

string

$name

entity name

[ Top ]

string TranslateTag(
string
$name, string
$attr, string
$cdata, string
$unconvertedcdata)

Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.

Tags:

usedby:

parserXMLDocBookTag::Convert() - Calls this to enclose the contents of the DocBook tag based on the values in template options.ini file

Overridden in child classes as:

PDFdefaultConverter::TranslateTag(): Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.

Parameters:

string	$name	tag name
string	$attr	any attributes Format: array(name => value)
string	$cdata	the tag contents, if any
string	$unconvertedcdata	the tag contents, if any, unpost-processed

[ Top ]

void TutorialExample(
string
$example)

Overridden in child classes as:

HTMLframesConverter::TutorialExample()

HTMLSmartyConverter::TutorialExample()

CHMdefaultConverter::TutorialExample()

Parameters:

string

$example

[ Top ]

string type_adjust(
string
$typename)

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

Used by XMLDocBookConverter::type_adjust() to change true and false to the peardoc2 values

Overridden in child classes as:

XMLDocBookpeardoc2Converter::type_adjust()

XMLDocBookConverter::type_adjust()

Parameters:

string

$typename

[ Top ]

string unmangle(
string
$sourcecode)

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

default returns it unchanged (html with xhtml tags)

Tags:

deprecated:	in favor of tokenizer-based highlighting. This will be removed for 2.0
usedby:	parserSourceInlineTag::stringConvert() - remove the extraneous stuff from http://www.php.net/highlight_string

Overridden in child classes as:

HTMLframesConverter::unmangle()

HTMLSmartyConverter::unmangle()

XMLDocBookpeardoc2Converter::unmangle()

XMLDocBookConverter::unmangle()

PDFdefaultConverter::unmangle()

CHMdefaultConverter::unmangle()

Parameters:

string

$sourcecode

output from highlight_string() - use this function to reformat the returned data for Converter-specific output

[ Top ]

string vardump_tree(

$tree, [
$indent = ''])

Debugging function for dumping $tutorial_tree

Parameters:

	$tree
	$indent

[ Top ]

string Varize(
string
$para)

Used to convert the contents of <var> in a docblock

Tags:

usedby:

parserDescVar::Convert()

Parameters:

string

$para

[ Top ]

void walk(
array
&$pages, array
&$package_pages)

called by phpDocumentor_IntermediateParser::Convert() to traverse the array of pages and their elements, converting them to the output format

The walk() method should be flexible enough such that it never needs modification. walk() sets up all of the indexes, and sorts everything in logical alphabetical order. It then passes each element individually to Convert(), which then passes to the Convert*() methods. A child Converter need not override any of these unless special functionality must be added. see Converter Default Template Variables for details. {@ and the left indexes specified by $leftindexes, and then sorts them by calling sortIndexes().

Next, it converts all README/CHANGELOG/INSTALL-style files, using Convert_RIC.

After this, it passes all package-level docs to Convert(). Then, it calls the index sorting functions formatPkgIndex(), formatIndex() and formatLeftIndex().

Finally, it converts each procedural page in alphabetical order. This stage passes elements from the physical file to Convert() in alphabetical order. First, procedural page elements parserDefine, parserInclude parserGlobal, and parserFunction are passed to Convert().

Then, class elements are passed in this order: parserClass, then all of the parserVars in the class and all of the parserMethods in the class. Classes are in alphabetical order, and both vars and methods are in alphabetical order.

Finally, ConvertErrorLog() is called and the data walk is complete.}}

Tags:

usedby:	phpDocumentor_IntermediateParser::Convert() - passes $pages and $package_pages
uses:	Converter::_createPkgElements() - sets up $elements and $pkg_elements array, as well as $links

Parameters:

array	&$pages	Format: array(fullpath => parserData structure with full parserData::$elements and parserData::$class_elements.
array	&$package_pages	Format: array(parserPackagePage 1, parserPackagePage 2,...)

[ Top ]

void walk_everything(
)

walk over elements by package rather than page

This method is designed for converters like the PDF converter that need everything passed in alphabetical order by package/subpackage and by procedural and then class information

Tags:

see:	Converter::walk()
see:	PDFdefaultConverter

[ Top ]

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

Write out the formatted source code for an example php file

This function provides the primary functionality for the @example tag.

Tags:

abstract:

Overridden in child classes as:

HTMLframesConverter::writeExample()

HTMLSmartyConverter::writeExample()

XMLDocBookpeardoc2Converter::writeExample()

PDFdefaultConverter::writeExample()

CHMdefaultConverter::writeExample()

Parameters:

string	$title	example title
string	$path	example filename (no path)
string	$source	fully highlighted/linked source code of the file

[ Top ]

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

Writes a file to target dir

Overridden in child classes as:

XMLDocBookpeardoc2Converter::writeFile(): Writes a file to target dir, beautify any .xml files first

Parameters:

string	$file
string	$data
boolean	$binary	true if the data is binary and not text

[ Top ]

void writeSource(
string
$filepath, string
$source)

Write out the formatted source code for a php file

This function provides the primary functionality for the @filesource tag.

Tags:

abstract:
usedby:	parserFileSourceTag::writeSource() - export highlighted file source

Overridden in child classes as:

HTMLframesConverter::writeSource()

HTMLSmartyConverter::writeSource()

XMLDocBookpeardoc2Converter::writeSource(): Does nothing

PDFdefaultConverter::writeSource()

CHMdefaultConverter::writeSource()

Parameters:

string	$filepath	full path to the file
string	$source	fully highlighted/linked source code of the file

[ Top ]

void _rmdir(
string
$directory)

Completely remove a directory and its contents

Parameters:

string

$directory

[ Top ]

void _setHighlightCache(

$type, 
$token)

Parameters:

	$type
	$token

[ Top ]

string _tutorial_path(
parserTutorial
$pkg, [parserTutorial
$subpkg = 0], [parserTutorial
$namepkg = 0])

Returns the path to this tutorial as a string

Parameters:

parserTutorial	$pkg
parserTutorial	$subpkg
parserTutorial	$namepkg

[ Top ]

Class: Converter

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$all_packages =

Tags:

$class = false

$classes =

$class_contents = array()

Tags:

$class_data =

$class_elements = array()

Tags:

$curfile =

$curpage =

$define_elements = array()

Tags:

$elements = array()

Tags:

$function_elements = array()

Tags:

$global_elements = array()

Tags:

$highlightingSource = false

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

Tags:

$outputformat = 'Generic'

Tags:

$package = 'default'

$packagecategories =

Tags:

$package_elements = array()

Tags:

$package_output =

Tags:

$package_parents =

Tags:

$page =

$page_contents = array()

Tags:

$page_data =

$page_elements = array()

Tags:

$parseprivate =

$path =

$pkg_elements = array()

Tags:

$processSpecialRoots = false

$quietmode =

$smarty_dir = ''

$sort_absolutely_everything = false

Tags:

$sort_page_contents_by_type = false

Tags:

$sourcePaths = array()

$subpackage = ''

$targetDir = ''

Tags:

$templateDir = ''

$templateName = ''

Tags:

$template_options =

Tags:

$title = 'Generated Documentation'

Tags:

$todoList = array()

Tags:

Class Methods

constructor Converter [line 452]

Parameters:

method AttrToString [line 1307]

Parameters:

method Bolden [line 931]

Tags: