Class XMLDocBookConverter

(line 43)

Description

Converter
   |
   --XMLDocBookConverter

Located in File: /phpDocumentor/Converters/XML/DocBook/XMLDocBookConverter.inc

XML DocBook converter.

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


Class Variables

Summary:
string $base_dir
string $category
string $class
Template $class_data
string $class_dir
array $current
array $currentclass
mixed $function_data
boolean $juststarted
array $leftindex
boolean $local
mixed $method_data
string $name
string $outputformat
array $package_pages
string $page
Template $page_data
string $page_dir
string $path
boolean $sort_page_contents_by_type
mixed $sourceloc
array $template_options

$base_dir (line 101)

Data type : string

target directory passed on the command-line.

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

$category (line 162)

Data type : string

peardoc2 Category

$class (line 82)

Data type : string

Overrides: Array

name of current class being converted

$class_data (line 113)

Data type : Template

Overrides: Array

template for the class currently being processed

$class_dir (line 107)

Data type : string

output directory for the current class being processed

$current (line 138)

Data type : array

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

$currentclass (line 144)

Data type : array

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

$function_data = array() (line 155)

Data type : mixed

$juststarted = false (line 132)

Data type : boolean

controls formatting of parser informative output

Converter prints: "Converting /path/to/file.php... Procedural Page Elements... Classes..." Since HTMLdefaultConverter outputs files while converting, it needs to send a \n to start a new line. However, if there is more than one class, output is messy, with multiple \n's just between class file output. This variable prevents that and is purely cosmetic

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

Data type : array

Overrides: Array

indexes of elements by package that need to be generated

$local = true (line 64)

Data type : boolean

whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir

$method_data = array() (line 156)

Data type : mixed

$name = 'DocBook' (line 54)

Data type : string

$outputformat = 'XML' (line 52)

Data type : string

Overrides: Array

$package_pages = array() (line 120)

Data type : array

array of converted package page names.

Used to link to the package page in the left index

  • var: - Format: array(package => 1)

$page (line 70)

Data type : string

Overrides: Array

name of current page being converted

$page_data (line 88)

Data type : Template

Overrides: Array

template for the procedural page currently being processed

$page_dir (line 94)

Data type : string

output directory for the current procedural page being processed

$path (line 76)

Data type : string

Overrides: Array

path of current page being converted

$sort_page_contents_by_type = true (line 50)

Data type : boolean

Overrides: Array

XMLDocBookConverter wants elements sorted by type as well as alphabetically

$sourceloc = '' (line 157)

Data type : mixed

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

Data type : array

Overrides: Array

template options. Currently only 1 recognized option usepear

usepear tells the getLink() function to return a package link to PEAR and PEAR_ERROR if possible, and to link directly to the fully-delimited link package#class.method or package#file.method in PEAR style, if possible, even if the package is not parsed. This will allow parsing of separate PEAR packages without parsing the entire thing at once!

Class Constants

Summary:

Method Detail

Summary:
XMLDocBookConverter XMLDocBookConverter ( &$allp,  &$packp,  &$classes,  &$procpages,  $po,  $pp,  $qm,  $targetDir,  $templateDir,  $title)
void convertClass (parserClass &$element)
void convertDefine (parserDefine &$element)
void ConvertErrorLog ()
void convertFunction (parserFunction &$element)
void convertGlobal (parserGlobal &$element)
void convertInclude (parserInclude &$element)
void convertMethod (parserMethod &$element)
void convertPackagePage (parserPackagePage &$element)
void convertPage (parserData &$element)
void convertTutorial ( &$element)
void convertVar (parserVar &$element)
void endClass ()
void endPage ()
void formatIndex ()
void formatLeftIndex ()
void formatPkgIndex ()
void generateElementIndex ()
array generateFormattedClassTree (parserClass $class)
void generateFormattedClassTrees (string $package)
void generatePkgElementIndex (string $package)
void generatePkgElementIndexes ()
void getCData ( $value)
mixed getClassLink (string $expr, string $package, [string $file = false], [boolean $text = false], [boolean $local = true], [ $with_a = true])
mixed getDefineLink (string $expr, string $package, [string $file = false], [boolean $text = false], [boolean $local = true])
mixed getFunctionLink (string $expr, string $package, [string $file = false], [boolean $text = false], [boolean $local = true])
mixed getGlobalLink (string $expr, string $package, [string $file = false], [boolean $text = false], [boolean $local = true])
string getId (mixed &$el)
void &getLink ( $expr, [ $package = false], [ $packages = false])
mixed getMethodLink (string $expr, string $class, string $package, [string $file = false], [boolean $text = false], [boolean $local = true])
mixed getPageLink (string $expr, string $package, [string $path = false], [boolean $text = false], [boolean $local = true])
void getPageName ( &$element)
string getRootTree (array $tree,  $package)
void getTutorialId ( $package,  $subpackage,  $tutorial,  $id)
mixed getVarLink (string $expr, string $class, string $package, [string $file = false], [boolean $text = false], [boolean $local = true])
void makeLeft ()
void Output ()
void postProcess ( $text)
void prepareDocBlock ( &$element, [ $nopackage = true])
int rcNatCmp (mixed $a, mixed $b)
int rcNatCmp1 (mixed $a, mixed $b)
string returnLink (string $link, string $text)
void returnSee (abstractLink &$element, [string $eltext = false], [boolean $local = true], [boolean $with_a = true])
void setTargetDir ( $dir)
void setTemplateDir ( $dir)
void &SmartyInit ( &$templ)
void type_adjust ( $typename)
void unmangle ( $s,  $sourcecode)
void writeNewPPage ( $key)

Constructor XMLDocBookConverter (line 167)

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

sets $base_dir to $targetDir

Parameters

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

Info

Method convertClass (line 811)

void convertClass( parserClass &$element)

Overrides : Converter::convertClass() Default Class Handler

Converts class for template output

Parameters

Info

Method convertDefine (line 1021)

void convertDefine( parserDefine &$element)

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

Converts defines for template output

Parameters

Info

Method ConvertErrorLog (line 625)

void ConvertErrorLog( )

Overrides : Converter::ConvertErrorLog() Convert the phpDocumentor parsing/conversion error log

Create errors.html template file output

This method takes all parsing errors and warnings and spits them out ordered by file and line number.

Info

  • global - ErrorTracker $phpDocumentor_errors: We'll be using it's output facility

Method convertFunction (line 952)

void convertFunction( parserFunction &$element)

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

Converts function for template output

Parameters

Info

Method convertGlobal (line 1040)

void convertGlobal( parserGlobal &$element)

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

Converts global variables for template output

Parameters

Info

Method convertInclude (line 1003)

void convertInclude( parserInclude &$element)

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

Converts include elements for template output

Parameters

Info

Method convertMethod (line 873)

void convertMethod( parserMethod &$element)

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

Converts method for template output

Parameters

Info

Method convertPackagePage (line 712)

void convertPackagePage( parserPackagePage &$element)

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

Parameters

Info

Method convertPage (line 1062)

void convertPage( parserData &$element)

Overrides : Converter::convertPage() Default Page Handler

converts procedural pages for template output

Parameters

Info

Method convertTutorial (line 736)

void convertTutorial( &$element)

Overrides : Converter::convertTutorial() Default Tutorial Handler

Parameters

  • &$element:

Info

Method convertVar (line 774)

void convertVar( parserVar &$element)

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

Converts class variables for template output.

Parameters

Info

Method endClass (line 217)

void endClass( )

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

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

Info

Method endPage (line 249)

void endPage( )

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

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

Info

Method formatIndex (line 360)

void formatIndex( )

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

HTMLdefaultConverter uses this function to format template index.html and packages.html

This function generates the package list from $all_packages, eliminating any packages that don't have any entries in their package index (no files at all, due to @ignore or other factors). Then it uses the default package name as the first package index to display. It sets the right pane to be either a blank file with instructions on making package-level docs, or the package-level docs for the default package.

Info

  • global - string $phpDocumentor_DefaultPackageName: Used to set the starting package to display

Method formatLeftIndex (line 438)

void formatLeftIndex( )

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

Generate indexes for li_package.html and classtree output files

This function generates the li_package.html files from the template file left.html. It does this by iterating through each of the $page_elements, $class_elements and $function_elements arrays to retrieve the pre-sorted abstractLink descendants needed for index generation. Conversion of these links to text is done by returnSee(). The $local parameter is set to false to ensure that paths are correct.

Then it uses generateFormattedClassTrees() to create class trees from the template file classtrees.html. Output filename is classtrees_packagename.html. This function also unsets $elements and $pkg_elements to free up the considerable memory these two class vars use

Info

Method formatPkgIndex (line 327)

void formatPkgIndex( )

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

HTMLdefaultConverter chooses to format both package indexes and the complete index here

This function formats output for the elementindex.html and pkgelementindex.html template files. It then writes them to the target directory

Info

Method generateElementIndex (line 1260)

void generateElementIndex( )

Generate alphabetical index of all elements

Info

Method generateFormattedClassTree (line 1122)

array generateFormattedClassTree( parserClass $class)

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

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

Parameters

Info

Method generateFormattedClassTrees (line 1172)

void generateFormattedClassTrees( string $package)

returns a template-enabled array of class trees

Parameters

  • string $package: package to generate a class tree for

Info

  • see - $roots, HTMLConverter::getRootTree()

Method generatePkgElementIndex (line 1448)

void generatePkgElementIndex( string $package)

Generate alphabetical index of all elements by package and subpackage

Parameters

  • string $package: name of a package

Info

Method generatePkgElementIndexes (line 1588)

void generatePkgElementIndexes( )

Info

Method getCData (line 703)

void getCData( $value)

Parameters

  • $value:

Info

Method getClassLink (line 1628)

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

Overrides : Converter::getClassLink() return false or a classLink to $expr

Parameters

  • string $expr: name of class
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated
  • boolean $local: return just the URL, or enclose it in an html a tag
  • $with_a:

Info

Method getDefineLink (line 1660)

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

Overrides : Converter::getDefineLink() return false or a defineLink to $expr

Parameters

  • string $expr: name of define
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated
  • boolean $local: return just the URL, or enclose it in an html a tag

Info

Method getFunctionLink (line 1644)

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

Overrides : Converter::getFunctionLink() return false or a functionLink to $expr

Parameters

  • string $expr: name of function
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated
  • boolean $local: return just the URL, or enclose it in an html a tag

Info

Method getGlobalLink (line 1676)

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

Overrides : Converter::getGlobalLink() return false or a globalLink to $expr

Parameters

  • string $expr: name of global variable
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated
  • boolean $local: return just the URL, or enclose it in an html a tag

Info

Method getId (line 574)

string getId( mixed &$el)

Overrides : Converter::getId() take abstractLink descendant and text $eltext and return a

Get the id value needed to allow linking

Parameters

  • mixed &$el: descendant of parserElement or parserData/parserPage

Info

Method getLink (line 175)

void &getLink( $expr, [ $package = false], [ $packages = false])

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

do that stuff in $template_options

Parameters

  • $expr:
  • $package:
  • $packages:

Info

Method getMethodLink (line 1709)

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

Overrides : Converter::getMethodLink() return false or a methodLink to $expr in $class

Parameters

  • string $expr: name of method
  • string $class: class containing method
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated
  • boolean $local: return just the URL, or enclose it in an html a tag

Info

Method getPageLink (line 1692)

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

Overrides : Converter::getPageLink() return false or a pageLink to $expr

Parameters

  • string $expr: name of procedural page
  • string $package: package name
  • string $path: full path to look in (used in index generation)
  • boolean $text: deprecated
  • boolean $local: return just the URL, or enclose it in an html a tag

Info

Method getPageName (line 1109)

void getPageName( &$element)

Parameters

  • &$element:

Info

Method getRootTree (line 1191)

string getRootTree( array $tree, $package)

return formatted class tree for the Class Trees page

Parameters

Info

Method getTutorialId (line 696)

void getTutorialId( $package, $subpackage, $tutorial, $id)

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

Parameters

  • $package:
  • $subpackage:
  • $tutorial:
  • $id:

Info

Method getVarLink (line 1726)

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

Overrides : Converter::getVarLink() return false or a varLink to $expr in $class

Parameters

  • string $expr: name of var
  • string $class: class containing var
  • string $package: package name
  • string $file: full path to look in (used in index generation)
  • boolean $text: deprecated
  • boolean $local: return just the URL, or enclose it in an html a tag

Info

Method makeLeft (line 282)

void makeLeft( )

Info

Method Output (line 1783)

void Output( )

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

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

Info

Method postProcess (line 686)

void postProcess( $text)

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

Parameters

  • $text:

Info

Method prepareDocBlock (line 691)

void prepareDocBlock( &$element, [ $nopackage = true])

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

Parameters

  • &$element:
  • $nopackage:

Info

Method rcNatCmp (line 1740)

int rcNatCmp( mixed $a, mixed $b)

does a nat case sort on the specified second level value of the array

Parameters

  • mixed $a:
  • mixed $b:

Info

Method rcNatCmp1 (line 1756)

int rcNatCmp1( mixed $a, mixed $b)

does a nat case sort on the specified second level value of the array.

this one puts constructors first

Parameters

  • mixed $a:
  • mixed $b:

Info

Method returnLink (line 277)

string returnLink( string $link, string $text)

Overrides : Converter::returnLink() take URL $link and text $text and return a link in the format needed for the Converter

Parameters

  • string $link:
  • string $text:

Info

  • return - &lt;ulink url="'.$link.'">'.$text.'</ulink&gt;

Method returnSee (line 476)

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

Overrides : Converter::returnSee() take abstractLink descendant and text $eltext and return a link

This function takes an abstractLink descendant and returns an html link

Parameters

  • abstractLink &$element: a descendant of abstractlink should be passed, and never text
  • string $eltext: text to display in the link
  • boolean $local: this parameter is not used, and is deprecated
  • boolean $with_a: determines whether the returned text is enclosed in an &lt;a> tag

Info

Method setTargetDir (line 1388)

void setTargetDir( $dir)

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

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

Parameters

  • $dir:

Info

Method setTemplateDir (line 1378)

void setTemplateDir( $dir)

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

Parameters

  • $dir:

Info

Method SmartyInit (line 205)

void &SmartyInit( &$templ)

Parameters

  • &$templ:

Info

Method type_adjust (line 186)

void type_adjust( $typename)

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

Parameters

  • $typename:

Info

Method unmangle (line 180)

void unmangle( $s, $sourcecode)

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

Parameters

  • $s:
  • $sourcecode:

Info

Method writeNewPPage (line 406)

void writeNewPPage( $key)

Parameters

  • $key:

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class Converter

Converter::$all_packages - All packages encountered in parsing

Converter::$classes - All class information, organized by path, and by package

Converter::$class_contents - alphabetical index of all methods and vars in a class by package/subpackage

Converter::$class_elements - alphabetized index of classes by package

Converter::$curfile - full path of the current file being converted

Converter::$curpage - current procedural page being processed

Converter::$define_elements - alphabetized index of defines by package

Converter::$elements - alphabetical index of all elements

Converter::$function_elements - alphabetized index of functions by package

Converter::$global_elements - alphabetized index of global variables by package

Converter::$highlightingSource - Flag used to help converters determine whether to do special source highlighting

Converter::$package - package name currently being converted

Converter::$packagecategories - Packages associated with categories

Converter::$package_elements - alphabetical index of all elements sorted by package, subpackage, page, and class.

Converter::$package_output - set to value of -po commandline

Converter::$package_parents - Hierarchy of packages

Converter::$page_contents - alphabetical index of all elements on a page by package/subpackage

Converter::$page_elements - alphabetized index of procedural pages by package

Converter::$parseprivate - controls processing of elements marked private with @access private

Converter::$pkg_elements - alphabetical index of all elements, indexed by package/subpackage

Converter::$processSpecialRoots - This converter knows about the new root tree processing

Converter::$quietmode - controls display of progress information while parsing.

Converter::$smarty_dir - Directory that the smarty templates are in

Converter::$sort_absolutely_everything - This is used if the content must be passed in the order it should be read, i.e. by package, procedural then classes

Converter::$sourcePaths - A list of files that have had source code generated

Converter::$subpackage - subpackage name currently being converted

Converter::$targetDir - directory that output is sent to. -t command-line sets this.

Converter::$templateDir - Directory that the template is in, relative to phpDocumentor root directory

Converter::$templateName - Name of the template, from last part of -o

Converter::$title -

Converter::$todoList - List of all @todo tags and a link to the element with the @todo

Inherited Methods

Inherited Method Summary

Inherited From Class Converter

Converter::Converter() - Initialize Converter data structures

Converter::AttrToString() - Convert the attribute of a Tutorial docbook tag's attribute list

Converter::Bolden() - Used to convert the contents of <b> in a docblock

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

Converter::checkState() - Compare parserStringWithInlineTags::Convert() cache state to $state

Converter::cleanup() - Finish up parsing/cleanup directories

Converter::Convert() - Convert all elements to output format

Converter::convertClass() - Default Class Handler

Converter::convertConst() - Converts class constants for template output.

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

Converter::ConvertErrorLog() - Convert the phpDocumentor parsing/conversion error log

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

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

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

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

Converter::convertPage() - Default Page Handler

Converter::ConvertTitle() - Convert the title of a Tutorial docbook tag section

Converter::ConvertTodoList() - Convert the list of all @todo tags

Converter::convertTutorial() - Default Tutorial Handler

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

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

Converter::copyFile() - Copies a file from the template directory to the target directory

Converter::createParentDir() - Recursively creates all subdirectories that don't exist in the $dir path

Converter::EncloseList() - Used to convert the contents of <ol> or <ul> in a docblock

Converter::EncloseParagraph() - Used to enclose a paragraph in a docblock

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

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

Converter::exampleProgramExample() - Used to convert the {@example} inline tag in a docblock.

Converter::flushHighlightCache() - Return the close text for the current token

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

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

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

Converter::formatTutorialTOC() - Creates a table of contents for a {@toc} inline tag in a tutorial

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

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

Converter::getClassesOnPage() - gets a list of all classes declared on a procedural page represented by

Converter::getClassLink() - return false or a classLink to $expr

Converter::getConstLink() - return false or a constLink to $expr in $class

Converter::getConverterDir() - Get the absolute path to the converter's base directory

Converter::getCurrentPageLink() -

Converter::getCurrentPageURL() - Return the path to the current

Converter::getDefineLink() - return false or a defineLink to $expr

Converter::getFileSourceName() - Translate the path info into a unique file name for the highlighted source code.

Converter::getFileSourcePath() - Return the fixed path to the source-code file folder.

Converter::getFormattedConflicts() -

Converter::getFormattedDescMethods() - Get a list of methods in child classes that override this method

Converter::getFormattedDescVars() - Get a list of vars in child classes that override this var

Converter::getFormattedImplements() - returns an array containing the class inheritance tree from the root object to the class.

Converter::getFormattedInheritedConsts() - Return template-enabled list of inherited class constants

Converter::getFormattedInheritedMethods() - Return template-enabled list of inherited methods

Converter::getFormattedInheritedVars() - Return template-enabled list of inherited variables

Converter::getFormattedMethodImplements() - Get the method this method(s) implemented from an interface, if any

Converter::getFormattedOverrides() - Get the method this method overrides, if any

Converter::getFunctionLink() - return false or a functionLink to $expr

Converter::getGlobalLink() - return false or a globalLink to $expr

Converter::getGlobalValue() - Parse a global variable's default value for class initialization.

Converter::getHighlightState() -

Converter::getId() - take abstractLink descendant and text $eltext and return a

Converter::getIncludeValue() - Parse an include's file to see if it is a file documented in this project

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

Converter::getMethodLink() - return false or a methodLink to $expr in $class

Converter::getPageLink() - return false or a pageLink to $expr

Converter::getSortedClassTreeFromClass() - Return a tree of all classes that extend this class

Converter::getSourceLink() -

Converter::getState() - Return parserStringWithInlineTags::Convert() cache state

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

Converter::getTutorialLink() - The meat of the @tutorial tag and inline {@tutorial} tag

Converter::getTutorialTree() - Get a tree structure representing the hierarchy of tutorials

Converter::getVarLink() - return false or a varLink to $expr in $class

Converter::hasSourceCode() - Determine whether an element's file has generated source code, used for linking to line numbers of source.

Converter::hasTutorial() -

Converter::highlightDocBlockSource() - Used to allow converters to format the source code of DocBlocks the way they'd like.

Converter::highlightSource() - Used to allow converters to format the source code the way they'd like.

Converter::highlightTutorialSource() - Used to allow converters to format the source code of Tutorial XML the way they'd like.

Converter::Italicize() - Used to convert the contents of <i> in a docblock

Converter::Kbdize() - Used to convert the contents of <kbd> in a docblock

Converter::ListItem() - Used to convert the contents of <li> in a docblock

Converter::newSmarty() - Return a Smarty template object to operate with

Converter::Output() - do all necessary output

Converter::postProcess() - This version does nothing

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

Converter::PreserveWhiteSpace() - Used to convert the contents of <pre> in a docblock

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

Converter::returnLink() - take URL $link and text $text and return a link in the format needed for the Converter

Converter::returnSee() - take abstractLink descendant and text $eltext and return a link

Converter::Sampize() - Used to convert the contents of <samp> in a docblock

Converter::setSourcePaths() - Mark a file as having had source code highlighted

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

Converter::setTemplateBase() - Set the template directory with a different template base directory

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

Converter::sortPageContentsByElementType() - sorts $page_contents by element type as well as alphabetically

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

Converter::startHighlight() - Initialize highlight caching

Converter::TranslateEntity() - Used to translate an XML DocBook entity like &rdquo; from a tutorial by reading the options.ini file for the template.

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

Converter::TutorialExample() -

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

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

Converter::vardump_tree() - Debugging function for dumping $tutorial_tree

Converter::Varize() - Used to convert the contents of <var> in a docblock

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

Converter::walk_everything() - walk over elements by package rather than page

Converter::writeExample() - Write out the formatted source code for an example php file

Converter::writeFile() - Writes a file to target dir

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

Converter::_rmdir() - Completely remove a directory and its contents

Converter::_setHighlightCache() -

Converter::_tutorial_path() - Returns the path to this tutorial as a string


Documentation generated on Mon, 05 Dec 2011 21:29:19 -0600 by phpDocumentor 1.4.4