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, string
$charset)

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
string	`$charset`	—	(@link $charset} 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

Usedby: parserB::Convert()

Parameters:

string $para —

[ Top ]

string Br(
string
$para)

Used to convert <br> in a docblock

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

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.

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:

PDFdefaultConverter::convertClass()

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

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

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

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

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

PDFdefaultConverter::convertConst()

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

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

HTMLframesConverter::convertConst(): Converts class variables 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()}}

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

Overridden in child classes as:

PDFdefaultConverter::convertDefine()

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

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

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

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

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

Abstract:

Overridden in child classes as:

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

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

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

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

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

See: Converter::prepareDocBlock()

Overridden in child classes as:

PDFdefaultConverter::convertFunction()

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

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

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

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

HTMLframesConverter::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()}}

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

Overridden in child classes as:

PDFdefaultConverter::convertGlobal()

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

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

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

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

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

See: Converter::prepareDocBlock()

Overridden in child classes as:

PDFdefaultConverter::convertInclude()

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

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

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

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

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

PDFdefaultConverter::convertMethod()

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

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

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

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

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

PDFdefaultConverter::convertPage()

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

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

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

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

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

Abstract:

Overridden in child classes as:

CHMdefaultConverter::ConvertTodoList()

HTMLSmartyConverter::ConvertTodoList()

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

PDFdefaultConverter::convertTutorial()

XMLDocBookConverter::convertTutorial()

XMLDocBookpeardoc2Converter::convertTutorial(): Convert tutorials for output

CHMdefaultConverter::convertTutorial()

HTMLSmartyConverter::convertTutorial()

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

PDFdefaultConverter::convertVar()

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

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

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

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

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

Abstract:

Overridden in child classes as:

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

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

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

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

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

See: HTMLframesConverter::endClass()
Abstract:

Overridden in child classes as:

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

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

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

See: HTMLframesConverter::endClass()
Abstract:

Overridden in child classes as:

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

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

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

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.

See: HTMLframesConverter::formatIndex()
Abstract:

Overridden in child classes as:

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

XMLDocBookpeardoc2Converter::formatIndex(): Does nothing

CHMdefaultConverter::formatIndex(): CHMdefaultConverter 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

HTMLframesConverter::formatIndex(): HTMLdefaultConverter 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

See: HTMLframesConverter::formatLeftIndex()
Abstract:

Overridden in child classes as:

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

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

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

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

HTMLframesConverter::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.

See: HTMLframesConverter::formatPkgIndex()
Abstract:

Overridden in child classes as:

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

XMLDocBookpeardoc2Converter::formatPkgIndex(): Does nothing

CHMdefaultConverter::formatPkgIndex(): CHMdefaultConverter 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

HTMLframesConverter::formatPkgIndex(): HTMLdefaultConverter 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

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:

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

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

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

Return: Converter-specific class tree for an individual class
Abstract:

Overridden in child classes as:

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

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

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

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

Return: returns a classLink or false if the element is not found in package $package
See: classLink

Overridden in child classes as:

PDFdefaultConverter::getClassLink()

XMLDocBookConverter::getClassLink()

XMLDocBookpeardoc2Converter::getClassLink()

CHMdefaultConverter::getClassLink()

HTMLSmartyConverter::getClassLink()

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

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

Overridden in child classes as:

PDFdefaultConverter::getConstLink()

CHMdefaultConverter::getConstLink()

HTMLSmartyConverter::getConstLink()

HTMLframesConverter::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(
)

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

Overridden in child classes as:

CHMdefaultConverter::getCurrentPageLink()

HTMLSmartyConverter::getCurrentPageLink()

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

Return: returns a defineLink or false if the element is not found in package $package
See: defineLink

Overridden in child classes as:

PDFdefaultConverter::getDefineLink()

XMLDocBookConverter::getDefineLink()

XMLDocBookpeardoc2Converter::getDefineLink()

CHMdefaultConverter::getDefineLink()

HTMLSmartyConverter::getDefineLink()

HTMLframesConverter::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)

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

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

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

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

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

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

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

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

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

Return: returns a functionLink or false if the element is not found in package $package
See: functionLink

Overridden in child classes as:

PDFdefaultConverter::getFunctionLink()

XMLDocBookConverter::getFunctionLink()

XMLDocBookpeardoc2Converter::getFunctionLink()

CHMdefaultConverter::getFunctionLink()

HTMLSmartyConverter::getFunctionLink()

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

Return: returns a defineLink or false if the element is not found in package $package
See: defineLink

Overridden in child classes as:

PDFdefaultConverter::getGlobalLink()

XMLDocBookConverter::getGlobalLink()

XMLDocBookpeardoc2Converter::getGlobalLink()

CHMdefaultConverter::getGlobalLink()

HTMLSmartyConverter::getGlobalLink()

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

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

Return: unique identifier of $element
Abstract:

Overridden in child classes as:

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

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

CHMdefaultConverter::getId()

HTMLSmartyConverter::getId()

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

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

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:

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

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

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

Overridden in child classes as:

PDFdefaultConverter::getMethodLink()

XMLDocBookConverter::getMethodLink()

XMLDocBookpeardoc2Converter::getMethodLink()

CHMdefaultConverter::getMethodLink()

HTMLSmartyConverter::getMethodLink()

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

Return: returns a pageLink or false if the element is not found in package $package
See: pageLink

Overridden in child classes as:

PDFdefaultConverter::getPageLink()

XMLDocBookConverter::getPageLink()

XMLDocBookpeardoc2Converter::getPageLink()

CHMdefaultConverter::getPageLink()

HTMLSmartyConverter::getPageLink()

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

Return: Format: see docs
See: HTMLframesConverter::getRootTree()

Parameters:

string	`$class`	—	class name
string	`$package`	—
string	`$subpackage`	—

[ Top ]

string getSourceLink(

$path)

Return: an output-format dependent link to phpxref-style highlighted source code
Abstract:
Usedby: parserFileSourceTag::getSourceLink()

Overridden in child classes as:

PDFdefaultConverter::getSourceLink()

CHMdefaultConverter::getSourceLink()

HTMLSmartyConverter::getSourceLink()

HTMLframesConverter::getSourceLink()

Parameters:

$path —

[ Top ]

void getState(
)

Return parserStringWithInlineTags::Convert() cache state

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}

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

Overridden in child classes as:

PDFdefaultConverter::getTutorialId()

XMLDocBookConverter::getTutorialId()

XMLDocBookpeardoc2Converter::getTutorialId()

CHMdefaultConverter::getTutorialId()

HTMLSmartyConverter::getTutorialId()

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

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

Tutorial: phpDocumentor Tutorials

Overridden in child classes as:

HTMLSmartyConverter::getTutorialTree()

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

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

Overridden in child classes as:

PDFdefaultConverter::getVarLink()

XMLDocBookConverter::getVarLink()

XMLDocBookpeardoc2Converter::getVarLink()

CHMdefaultConverter::getVarLink()

HTMLSmartyConverter::getVarLink()

HTMLframesConverter::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 = ''])

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

Usedby: parserI::Convert()

Parameters:

string $para —

[ Top ]

string Kbdize(
string
$para)

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

Usedby: parserKbd::Convert()

Parameters:

string $para —

[ Top ]

string ListItem(
string
$item)

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

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

See: Converter
Abstract:
Usedby: phpDocumentor_IntermediateParser::Convert()

Overridden in child classes as:

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

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

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

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

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

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 >

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:

PDFdefaultConverter::postProcess()

XMLDocBookConverter::postProcess()

XMLDocBookpeardoc2Converter::postProcess()

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

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

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

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:

XMLDocBookConverter::prepareDocBlock()

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

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

Usedby: parserCode::Convert()

Overridden in child classes as:

XMLDocBookpeardoc2Converter::ProgramExample()

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

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

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

Return: link to $link
Abstract:

Overridden in child classes as:

PDFdefaultConverter::returnLink()

XMLDocBookConverter::returnLink()

XMLDocBookpeardoc2Converter::returnLink()

CHMdefaultConverter::returnLink()

HTMLSmartyConverter::returnLink()

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

Return: link to $element
Abstract:

Overridden in child classes as:

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

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

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

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

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:

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

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

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

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:

PDFdefaultConverter::setTemplateDir()

XMLDocBookConverter::setTemplateDir()

XMLDocBookpeardoc2Converter::setTemplateDir()

CHMdefaultConverter::setTemplateDir()

Parameters:

string $dir — subdirectory

[ Top ]

void sortPageContentsByElementType(

&$pages)

sorts $page_contents by element type as well as alphabetically

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

Return: formatted source code line with line number

Overridden in child classes as:

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

HTMLframesConverter::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.

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.

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:

CHMdefaultConverter::TutorialExample()

HTMLSmartyConverter::TutorialExample()

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

XMLDocBookConverter::type_adjust()

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

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:

PDFdefaultConverter::unmangle()

XMLDocBookConverter::unmangle()

XMLDocBookpeardoc2Converter::unmangle()

CHMdefaultConverter::unmangle()

HTMLSmartyConverter::unmangle()

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

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

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

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.

Abstract:

Overridden in child classes as:

PDFdefaultConverter::writeExample()

XMLDocBookpeardoc2Converter::writeExample()

CHMdefaultConverter::writeExample()

HTMLSmartyConverter::writeExample()

HTMLframesConverter::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.

Abstract:
Usedby: parserFileSourceTag::writeSource() - export highlighted file source

Overridden in child classes as:

PDFdefaultConverter::writeSource()

XMLDocBookpeardoc2Converter::writeSource(): Does nothing

CHMdefaultConverter::writeSource()

HTMLSmartyConverter::writeSource()

HTMLframesConverter::writeSource()

Parameters:

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

[ Top ]

Class: Converter

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$all_packages =

$charset = 'iso-8859-1'

$class = false

$classes =

$class_contents = array()

$class_data =

$class_elements = array()

$curfile =

$curpage =

$define_elements = array()

$elements = array()

$function_elements = array()

$global_elements = array()

$highlightingSource = false

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

$outputformat = 'Generic'

$package = 'default'

$packagecategories =

$package_elements = array()

$package_output =

$package_parents =

$page =

$page_contents = array()

$page_data =

$page_elements = array()

$parseprivate =

$path =

$pkg_elements = array()

$processSpecialRoots = false

$quietmode =

$smarty_dir = ''

$sort_absolutely_everything = false

$sort_page_contents_by_type = false

$sourcePaths = array()

$subpackage = ''

$targetDir = ''

$templateDir = ''

$templateName = ''

$template_options =

$title = 'Generated Documentation'

$todoList = array()

Method Detail

Converter (Constructor) [line 459]

Parameters:

AttrToString [line 1319]

Parameters:

Bolden [line 939]

Parameters:

Br [line 1009]

Parameters:

checkState [line 5406]

Parameters:

cleanup [line 5115]

Convert [line 3994]

Parameters:

convertClass [line 4058]

Parameters:

convertConst [line 4245]

Parameters:

convertDefine [line 4370]

Parameters:

ConvertErrorLog [line 2438]

convertFunction [line 4427]

Parameters:

convertGlobal [line 4336]

Parameters:

convertInclude [line 4399]

Parameters:

convertMethod [line 4125]