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

Usedby: parserBr::Convert()
Usedby: parserI::Convert()
Usedby: parserB::Convert()

Parameters:

string $para —

[ Top ]

string Br(
string
$para)

Used to convert <br> in a docblock

Parameters:

string $para —

[ Top ]

void checkState(
mixed
$state)

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

Abstract:
See: parserStringWithInlineTags::Convert()

Overridden in child classes as:

CHMdefaultConverter::checkState(): checks $state to see if it is the same as $local

HTMLdefaultConverter::checkState(): checks $state to see if it is the same as $local

HTMLframesConverter::checkState(): checks $state to see if it is the same as $local

HTMLSmartyConverter::checkState(): checks $state to see if it is the same as $local

XMLDocBookConverter::checkState(): checks $state to see if it is the same as $local

Parameters:

mixed $state —

[ Top ]

void Convert(
mixed
&$element)

Convert all elements to output format

Abstract:

Overridden in child classes as:

CHMdefaultConverter::Convert(): Convert abstract $element for template

HTMLdefaultConverter::Convert(): Convert abstract $element for template

HTMLframesConverter::Convert(): Convert abstract $element for template

HTMLSmartyConverter::Convert(): Convert abstract $element for template

PDFdefaultConverter::Convert(): Convert abstract $element for template

XMLDocBookConverter::Convert(): Convert abstract $element for template

Parameters:

mixed &$element — parserElement descendant or parserPackagePage or parserData

[ Top ]

void ConvertErrorLog(
)

See: HTMLdefaultConverter::ConvertErrorLog()
Abstract:

Overridden in child classes as:

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

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

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

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

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

[ 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 Convert_RIC(
README|INSTALL|CHANGELOG
$name, string
$contents)

Convert README/INSTALL/CHANGELOG file contents to output format

Abstract:

Overridden in child classes as:

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

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

Parameters:

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

[ Top ]

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

Copies a file from the template directory to the target directory

thanks to Robert Hoffmann for this fix

Parameters:

string $file —

[ 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, mixed
$ordered)

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

Parameters:

string $list —

[ 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. HTMLdefaultConverter uses it to complete the template for the class and to output its documentation

Abstract:
See: HTMLframesConverter::endClass()

Overridden in child classes as:

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

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

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

[ 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. HTMLdefaultConverter uses it to complete the template for the procedural page and to output its documentation

Abstract:
See: HTMLdefaultConverter::endClass()

Overridden in child classes as:

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

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

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

[ Top ]

void formatIndex(
)

Called by walk() while converting.

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

Abstract:
See: HTMLdefaultConverter::formatIndex()

Overridden in child classes as:

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

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

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

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

Abstract:
See: HTMLdefaultConverter::formatLeftIndex()

Overridden in child classes as:

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

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

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

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

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

Abstract:
See: HTMLdefaultConverter::formatPkgIndex()

Overridden in child classes as:

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

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

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

XMLDocBookConverter::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
Usedby: parserTocInlineTag::Convert()
Abstract:

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

Parameters:

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

[ Top ]

mixed getClassLink(
string
$expr, string
$package, [mixed
$file = false], [mixed
$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:

CHMdefaultConverter::getClassLink()

HTMLdefaultConverter::getClassLink()

HTMLframesConverter::getClassLink()

HTMLSmartyConverter::getClassLink()

PDFdefaultConverter::getClassLink()

XMLDocBookConverter::getClassLink()

Parameters:

string	`$expr`	—	class name
string	`$package`	—	package name

[ Top ]

string getConverterDir(
)

Get the absolute path to the converter's base directory

[ Top ]

mixed getDefineLink(
string
$expr, string
$package, [mixed
$file = false], [mixed
$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:

CHMdefaultConverter::getDefineLink()

HTMLdefaultConverter::getDefineLink()

HTMLframesConverter::getDefineLink()

HTMLSmartyConverter::getDefineLink()

PDFdefaultConverter::getDefineLink()

XMLDocBookConverter::getDefineLink()

Parameters:

string	`$expr`	—	constant name
string	`$package`	—	package name

[ Top ]

mixed getFunctionLink(
string
$expr, string
$package, [mixed
$file = false], [mixed
$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:

CHMdefaultConverter::getFunctionLink()

HTMLdefaultConverter::getFunctionLink()

HTMLframesConverter::getFunctionLink()

HTMLSmartyConverter::getFunctionLink()

PDFdefaultConverter::getFunctionLink()

XMLDocBookConverter::getFunctionLink()

Parameters:

string	`$expr`	—	function name
string	`$package`	—	package name

[ Top ]

mixed getGlobalLink(
string
$expr, string
$package, [mixed
$file = false], [mixed
$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:

CHMdefaultConverter::getGlobalLink()

HTMLdefaultConverter::getGlobalLink()

HTMLframesConverter::getGlobalLink()

HTMLSmartyConverter::getGlobalLink()

PDFdefaultConverter::getGlobalLink()

XMLDocBookConverter::getGlobalLink()

Parameters:

string	`$expr`	—	global variable name (with leading $)
string	`$package`	—	package name

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


1     $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"

Parameters:

string $value — default value of a global variable.

[ Top ]

string getIncludeValue(
string
$value)

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:


1     include ("file.ext");

If it finds it, it will return a link to the file's documentation. For examples, see phpdoc.inc 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.

[ 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::$variablename
classname
function functionname()
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: "tests#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.


1     class myclass
2      {
3       // from inside the class definition, use "function conflict()" to refer to procedural function "conflict()"
4         function conflict()
5         {
6         }
7      }
8     
9      function conflict()
10     {
11     }

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: parserDocBlock, Render::HandleEvent(), Converter::getPageLink(), Converter::getDefineLink(), Converter::getVarLink(), Converter::getFunctionLink(), Converter::getClassLink()

Overridden in child classes as:

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, [mixed
$file = false], [mixed
$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:

CHMdefaultConverter::getMethodLink()

HTMLdefaultConverter::getMethodLink()

HTMLframesConverter::getMethodLink()

HTMLSmartyConverter::getMethodLink()

PDFdefaultConverter::getMethodLink()

XMLDocBookConverter::getMethodLink()

Parameters:

string	`$expr`	—	method name
string	`$class`	—	class name
string	`$package`	—	package name

[ Top ]

mixed getPageLink(
string
$expr, string
$package, [mixed
$path = false], [mixed
$text = false], [mixed
$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:

CHMdefaultConverter::getPageLink()

HTMLdefaultConverter::getPageLink()

HTMLframesConverter::getPageLink()

HTMLSmartyConverter::getPageLink()

PDFdefaultConverter::getPageLink()

XMLDocBookConverter::getPageLink()

Parameters:

string	`$expr`	—	procedural page name
string	`$package`	—	package name

[ Top ]

void getPPageId(
mixed
$package, mixed
$subpackage, mixed
$tutorial, mixed
$id)

Used by {@id}

Overridden in child classes as:

CHMdefaultConverter::getPPageId()

HTMLframesConverter::getPPageId()

HTMLSmartyConverter::getPPageId()

PDFdefaultConverter::getPPageId()

XMLDocBookConverter::getPPageId()

[ 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' =>  to $class,
                        'parent' => false,
                        'children' => array(array('class' => 'childclass1', 'package' => 'child1package'),
                                            array('class' => 'childclass2', 'package' => 'child2package'),...
                                           )
                       ),
       'child1package#childclass1' => array('link' =>  to childclass1,
                                            'parent' => '#root',
                                            'children' => array(array('class' => 'kidclass', 'package' => 'kidpackage'),...
                                                               )
                                           ),
       'kidpackage#kidclass' => array('link' =>  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:


1     class X extends Y
2      {
3      ...
4      }

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 returne 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(
mixed
$path)

Return: an output-format dependent link to phpxref-style highlighted source code
Abstract:

Overridden in child classes as:

HTMLframesConverter::getSourceLink()

HTMLSmartyConverter::getSourceLink()

[ Top ]

void getState(
)

Return parserStringWithInlineTags::Convert() cache state

Abstract:
See: parserStringWithInlineTags::Convert()

Overridden in child classes as:

CHMdefaultConverter::getState(): returns $local

HTMLdefaultConverter::getState(): returns $local

HTMLframesConverter::getState(): returns $local

HTMLSmartyConverter::getState(): returns $local

PDFdefaultConverter::getState()

XMLDocBookConverter::getState(): returns $local

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


1     * @tutorial package/subpackage/file.cls
2      * @tutorial package/file.cls
3      * @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 ]

void getTutorialTree(
parserTutorial|array
$tutorial)

Overridden in child classes as:

HTMLframesConverter::getTutorialTree()

HTMLSmartyConverter::getTutorialTree()

Parameters:

parserTutorial|array $tutorial —

[ Top ]

mixed getVarLink(
string
$expr, string
$class, string
$package, [mixed
$file = false], [mixed
$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:

CHMdefaultConverter::getVarLink()

HTMLdefaultConverter::getVarLink()

HTMLframesConverter::getVarLink()

HTMLSmartyConverter::getVarLink()

PDFdefaultConverter::getVarLink()

XMLDocBookConverter::getVarLink()

Parameters:

string	`$expr`	—	var name
string	`$class`	—	class name
string	`$package`	—	package name

[ 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 highlightSource(
integer
$token, mixed
$word)

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

default returns it unchanged

Overridden in child classes as:

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

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

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

Parameters:

integer $token — token value from http://www.php.net/tokenizer

[ Top ]

string Italicize(
string
$para)

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

Parameters:

string $para —

[ Top ]

string ListItem(
string
$item)

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

Parameters:

string $item —

[ Top ]

void Output(
mixed
$title)

do all necessary output

Abstract:
See: Converter

Overridden in child classes as:

CHMdefaultConverter::Output(): This function will be used by CHMdefaultConverter to call html help compiler

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

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

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

[ Top ]

string postProcess(
mixed
$text)

This version does nothing

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

Overridden in child classes as:

CHMdefaultConverter::postProcess()

HTMLdefaultConverter::postProcess()

HTMLframesConverter::postProcess()

HTMLSmartyConverter::postProcess()

XMLDocBookConverter::postProcess()

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

Used to convert the <code> tag in a docblock

Usedby: parserCode::Convert()

Overridden in child classes as:

CHMdefaultConverter::ProgramExample()

HTMLframesConverter::ProgramExample()

HTMLSmartyConverter::ProgramExample()

Parameters:

string $example —

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

CHMdefaultConverter::returnLink()

HTMLdefaultConverter::returnLink()

HTMLframesConverter::returnLink()

HTMLSmartyConverter::returnLink()

PDFdefaultConverter::returnLink()

XMLDocBookConverter::returnLink()

Parameters:

string	`$link`	—	URL
string	`$text`	—	text to display

[ Top ]

string returnSee(
abstractLink
&$element, [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:

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

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

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

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

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

Parameters:

abstractLink	`&$element`	—
string	`$eltext`	—

[ Top ]

void setTargetDir(
string
$dir)

Sets the output directory for generated documentation

Overridden in child classes as:

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

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

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

Parameters:

string $dir — the output directory

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

CHMdefaultConverter::setTemplateDir()

HTMLframesConverter::setTemplateDir()

HTMLSmartyConverter::setTemplateDir()

PDFdefaultConverter::setTemplateDir()

XMLDocBookConverter::setTemplateDir()

Parameters:

string $dir — subdirectory

[ Top ]

void sortPageContentsByElementType(
mixed
&$pages)

sorts $page_contents by element type as well as alphabetically

See: $sort_page_contents_by_element_type

[ Top ]

string sourceLine(
integer
$linenumber, string
$line)

Return: formatted source code line with line number

Parameters:

integer	`$linenumber`	—	line number
string	`$line`	—	highlighted source code line

[ Top ]

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

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

Usedby: parserXMLDocBookTag::Convert()

Parameters:

string	`$name`	—	tag name
string	`$attr`	—	any attributes Format: array(name => value)
string	`$cdata`	—	the tag contents, if any

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

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)

Overridden in child classes as:

CHMdefaultConverter::unmangle()

HTMLdefaultConverter::unmangle()

HTMLframesConverter::unmangle()

HTMLSmartyConverter::unmangle()

PDFdefaultConverter::unmangle()

XMLDocBookConverter::unmangle()

Parameters:

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

[ Top ]

void vardump_tree(
mixed
$tree, [mixed
$indent = ''])

Debugging function for dumping $tutorial_tree

[ 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(), a method that must be overridden in a child Converter.

walk() first creates all of the indexes $elements, $pkg_elements and the left indexes specified by $leftindexes, and then sorts them by calling sortIndexes(). 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.

Uses: Converter::_createPkgElements()

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

See: Converter::walk()

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

HTMLframesConverter::writeExample()

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

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:

Overridden in child classes as:

HTMLframesConverter::writeSource()

HTMLSmartyConverter::writeSource()

Parameters:

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

[ Top ]

void writeSourceFunction(
string
$function, string
$path, string
$source)

Write out the formatted source code for a function

This function provides the primary functionality for the tags.source.pkg tag.

Abstract:

Parameters:

string	`$function`	—	function name
string	`$path`	—	full path of file that contains function
string	`$source`	—	fully highlighted/linked source code of the function

[ Top ]

Class: Converter

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$all_packages =

$class = false

$classes =

$class_contents = array()

$class_elements = array()

$curfile =

$define_elements = array()

$elements = array()

$function_elements = array()

$global_elements = array()

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

$outputformat = 'Generic'

$package = 'default'

$package_elements = array()

$package_output =

$package_parents =

$page_contents = array()

$page_elements = array()

$parseprivate =

$pkg_elements = array()

$quietmode =

$sort_absolutely_everything = false

$sort_page_contents_by_type = false

$subpackage = ''

$targetDir = ''

$templateDir = ''

$templateName = ''

$template_options =

$title = 'Generated Documentation'

Method Detail

Converter (Constructor) [line 279]

Parameters:

AttrToString [line 712]

Parameters:

Bolden [line 496]

Parameters:

Br [line 524]

Parameters:

checkState [line 3389]

Parameters:

Convert [line 3185]

Parameters:

ConvertErrorLog [line 1849]

ConvertTitle [line 801]

Parameters:

Convert_RIC [line 3176]

Parameters:

copyFile [line 3364]

Parameters:

createParentDir [line 3282]

Parameters:

EncloseList [line 453]

Parameters:

EncloseParagraph [line 482]

Parameters:

endClass [line 332]

endPage [line 344]

formatIndex [line 366]

formatLeftIndex [line 379]

formatPkgIndex [line 355]

formatTutorialTOC [line 553]

Parameters:

getClassLink [line 2494]

Parameters:

getConverterDir [line 3220]

getDefineLink [line 2550]

Parameters:

getFunctionLink [line 2522]

Parameters: