Docs For Class HTMLSmartyConverter

Description

Converter
   |
   --HTMLSmartyConverter

Located in File: /phpDocumentor/Converters/HTML/Smarty/HTMLSmartyConverter.inc

HTML output converter.

This Converter takes output from the Parser and converts it to HTML-ready output for use with Smarty.

author: - Greg Beaver <[email protected]>
version: - $Revision: 318096 $
see: - parserDocBlock, parserInclude, parserPage, parserClass, parserDefine, parserFunction, parserMethod, parserVar
since: - 1.0rc1

Class Variables

Summary:

string $base_dir

string $class_dir

array $current

array $currentclass

boolean $juststarted

array $leftindex

string $name

string $outputformat

array $package_pages

string $page_dir

boolean $processSpecialRoots

mixed $ric_set

boolean $sort_page_contents_by_type

mixed $wrote

$base_dir (line 89)

Data type : string

target directory passed on the command-line.

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

$class_dir (line 95)

Data type : string

output directory for the current class being processed

$current (line 120)

Data type : array

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

$currentclass (line 126)

Data type : array

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

$juststarted = false (line 114)

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' => true, 'defines' => false, 'globals' => false) (line 76)

Data type : array

Overrides: Array

indexes of elements by package that need to be generated

$name = 'Smarty' (line 71)

Data type : string

$outputformat = 'HTML' (line 69)

Data type : string

Overrides: Array

$package_pages = array() (line 102)

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_dir (line 82)

Data type : string

output directory for the current procedural page being processed

$processSpecialRoots = true (line 61)

Data type : boolean

Overrides: Array

This converter knows about the new root tree processing

In order to fix PEAR Bug #6389

$ric_set = array() (line 128)

Data type : mixed

$sort_page_contents_by_type = true (line 67)

Data type : boolean

Overrides: Array

Smarty Converter wants elements sorted by type as well as alphabetically

see: - Converter::$sort_page_contents_by_type

$wrote = false (line 127)

Data type : mixed

Class Constants

Summary:

Method Detail

Summary:

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

void convertClass (parserClass &$element)

void convertConst (parserDefine &$element)

void convertDefine (parserDefine &$element)

void ConvertErrorLog ()

void convertFunction (parserFunction &$element)

void convertGlobal (parserGlobal &$element)

void convertInclude (parserInclude &$element)

void convertMethod (parserDefine &$element)

void convertPackagepage (parserPackagePage &$element)

void convertPage (parserData &$element)

void ConvertTodoList ()

void convertTutorial (parserTutorial &$element)

void convertVar (parserDefine &$element)

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

void copyMediaRecursively ( $media, $targetdir, [ $subdir = ''])

void endClass ()

void endPage ()

void formatIndex ()

void formatLeftIndex ()

void formatPkgIndex ()

string formatTutorialTOC (array $toc)

void generateElementIndex ()

array generateFormattedClassTree (parserClass $class)

void generateFormattedClassTrees (string $package)

void generateFormattedInterfaceTrees (string $package)

void generatePkgElementIndex (string $package)

void generatePkgElementIndexes ()

void getCData ( $value)

void getClassContents ()

void getClassLeft ()

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

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

void getCurrentPageLink ()

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

void getExampleLink ( $path, $title)

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

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

void getId ( $element, [ $fullpath = true])

array getIndexInformation (parserElement $elt)

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

void getPageContents ()

void getPageLeft ()

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

void getPageName ( &$element)

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

string getSourceAnchor (string $sourcefile, string $anchor, [string $text = ''], [boolean $link = false])

void getSourceLink ( $path)

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

void getTutorialList ()

void getTutorialTree ( $tutorial, [ $k = false])

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

void makeLeft ()

void Output ()

void postProcess ( $text)

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

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 $with_a = true], boolean 3)

void setTargetDir ( $dir)

void &SmartyInit ( &$templ)

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

void TutorialExample (string $example)

void unmangle ( $sourcecode)

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

void writeNewPPage ( $key)

void writeRIC ()

void writeSource ( $path, $value)

Constructor HTMLSmartyConverter (line 148)

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

Parameters

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

Info

Method convertClass (line 1078)

void convertClass( parserClass &$element)

Overrides : Converter::convertClass() Default Class Handler

Converts class for template output

Parameters

parserClass &$element:

Info

Method convertConst (line 1106)

void convertConst( parserDefine &$element)

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

Converts class variables for template output

Parameters

parserDefine &$element:

Info

see - Converter::prepareDocBlock(), Converter::getFormattedConflicts()

Method convertDefine (line 1147)

void convertDefine( parserDefine &$element)

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

Converts defines for template output

Parameters

parserDefine &$element:

Info

see - Converter::prepareDocBlock(), Converter::getFormattedConflicts()

Method ConvertErrorLog (line 928)

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

void convertFunction( parserFunction &$element)

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

Converts function for template output

Parameters

parserFunction &$element:

Info

see - Converter::prepareDocBlock(), parserFunction::getFunctionCall(), Converter::getFormattedConflicts()

Method convertGlobal (line 1157)

void convertGlobal( parserGlobal &$element)

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

Converts global variables for template output

Parameters

parserGlobal &$element:

Info

see - Converter::prepareDocBlock(), Converter::getFormattedConflicts()

Method convertInclude (line 1137)

void convertInclude( parserInclude &$element)

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

Converts include elements for template output

Parameters

parserInclude &$element:

Info

see - Converter::prepareDocBlock()

Method convertMethod (line 1116)

void convertMethod( parserDefine &$element)

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

Converts class methods for template output

Parameters

parserDefine &$element:

Info

see - Converter::prepareDocBlock(), Converter::getFormattedConflicts()

Method convertPackagepage (line 1004)

void convertPackagepage( parserPackagePage &$element)

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

Parameters

parserPackagePage &$element:

Info

Method convertPage (line 1167)

void convertPage( parserData &$element)

Overrides : Converter::convertPage() Default Page Handler

converts procedural pages for template output

Parameters

parserData &$element:

Info

see - Converter::prepareDocBlock(), Converter::getClassesOnPage()

Method ConvertTodoList (line 893)

void ConvertTodoList( )

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

Info

Method convertTutorial (line 1034)

void convertTutorial( parserTutorial &$element)

Overrides : Converter::convertTutorial() Default Tutorial Handler

Parameters

parserTutorial &$element:

Info

Method convertVar (line 1096)

void convertVar( parserDefine &$element)

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

Converts class variables for template output

Parameters

parserDefine &$element:

Info

see - Converter::prepareDocBlock(), Converter::getFormattedConflicts()

Method Convert_RIC (line 872)

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

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

Convert README/INSTALL/CHANGELOG file contents to output format

Parameters

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

Info

Method copyMediaRecursively (line 1604)

void copyMediaRecursively( $media, $targetdir, [ $subdir = ''])

Parameters

$media:
$targetdir:
$subdir:

Info

Method endClass (line 344)

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

see - Converter::endClass()
see - registerCurrentClass()

Method endPage (line 523)

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

see - Converter::endPage()
see - registerCurrent()

Method formatIndex (line 642)

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

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

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

see - Converter::$page_elements, Converter::$class_elements, Converter::$function_elements

Method formatPkgIndex (line 606)

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

see - HTMLSmartyConverter::generateElementIndex(), HTMLSmartyConverter::generatePkgElementIndex()

Method formatTutorialTOC (line 321)

string formatTutorialTOC( array $toc)

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

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

Info

return - table of contents formatted for use in the current output format

Method generateElementIndex (line 1571)

void generateElementIndex( )

Generate alphabetical index of all elements

Info

see - Converter::$elements, Converter::walk()

Method generateFormattedClassTree (line 1195)

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

parserClass $class: class variable

Info

return - Format: array(root,child,child,child,...,$class)
uses - parserClass::getParentClassTree()

Method generateFormattedClassTrees (line 1259)

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 generateFormattedInterfaceTrees (line 1313)

void generateFormattedInterfaceTrees( string $package)

returns a template-enabled array of interface inheritance trees

Parameters

string $package: package to generate a class tree for

Info

see - $roots, HTMLConverter::getRootTree()

Method generatePkgElementIndex (line 1669)

void generatePkgElementIndex( string $package)

Generate alphabetical index of all elements by package and subpackage

Parameters

string $package: name of a package

Info

see - Converter::$pkg_elements, Converter::walk(), HTMLSmartyConverter::generatePkgElementIndexes()

Method generatePkgElementIndexes (line 1719)

void generatePkgElementIndexes( )

Info

see - HTMLSmartyConverter::generatePkgElementIndex()

Method getCData (line 990)

void getCData( $value)

Parameters

$value:

Info

Method getClassContents (line 466)

void getClassContents( )

Info

Method getClassLeft (line 436)

void getClassLeft( )

Info

Method getClassLink (line 1759)

mixed getClassLink( string $expr, string $package, [string $file = false], [boolean $text = false], [boolean $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 $with_a: return just the URL, or enclose it in an html a tag

Info

return - false if not found, or an html a link to the class's documentation
see - Converter::getClassLink()

Method getConstLink (line 1874)

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

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

Parameters

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

Info

return - false if not found, or an html a link to the var's documentation
see - Converter::getVarLink()

Method getCurrentPageLink (line 287)

void getCurrentPageLink( )

Overrides : Converter::getCurrentPageLink() parent method not documented

Info

Method getDefineLink (line 1791)

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

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

Parameters

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

Info

return - false if not found, or an html a link to the define's documentation
see - Converter::getDefineLink()

Method getExampleLink (line 190)

void getExampleLink( $path, $title)

Parameters

$path:
$title:

Info

Method getFunctionLink (line 1775)

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

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

Parameters

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

Info

return - false if not found, or an html a link to the function's documentation
see - Converter::getFunctionLink()

Method getGlobalLink (line 1807)

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

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

Parameters

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

Info

return - false if not found, or an html a link to the global variable's documentation
see - Converter::getGlobalLink()

Method getId (line 814)

void getId( $element, [ $fullpath = true])

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

Parameters

$element:
$fullpath:

Info

Method getIndexInformation (line 1453)

array getIndexInformation( parserElement $elt)

Generate indexing information for given element

Parameters

parserElement $elt: descendant of parserElement

Info

see - HTMLSmartyConverter::generateElementIndex()

Method getMethodLink (line 1840)

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

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

Parameters

boolean 5: return just the URL, or enclose it in an html a tag
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

Info

return - false if not found, or an html a link to the method's documentation
see - Converter::getMethodLink()

Method getPageContents (line 482)

void getPageContents( )

Info

Method getPageLeft (line 499)

void getPageLeft( )

Info

Method getPageLink (line 1823)

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

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

Parameters

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

Info

return - false if not found, or an html a link to the procedural page's documentation
see - Converter::getPageLink()

Method getPageName (line 1181)

void getPageName( &$element)

Parameters

&$element:

Info

Method getRootTree (line 1370)

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

return formatted class tree for the Class Trees page

Parameters

array $tree: output from getSortedClassTreeFromClass()
string $package: package
boolean $nounknownparent: if true, an object's parent will not be checked
$noparent:

Info

see - Classes::$definitechild, HTMLSmartyConverter::generateFormattedClassTrees()

Method getSourceAnchor (line 211)

string getSourceAnchor( string $sourcefile, string $anchor, [string $text = ''], [boolean $link = false])

Retrieve a Converter-specific anchor to a segment of a source code file parsed via a @filesource tag.

Parameters

string $sourcefile: full path to source file
string $anchor: name of anchor
string $text: link text, if this is a link
boolean $link: returns either a link or a destination based on this parameter

Info

return - link to an anchor, or the anchor

Method getSourceLink (line 195)

void getSourceLink( $path)

Overrides : Converter::getSourceLink() parent method not documented

Parameters

$path:

Info

Method getTutorialId (line 995)

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 getTutorialList (line 369)

void getTutorialList( )

Info

Method getTutorialTree (line 396)

void getTutorialTree( $tutorial, [ $k = false])

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

Parameters

$tutorial:
$k:

Info

Method getVarLink (line 1857)

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

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

Parameters

boolean 5: return just the URL, or enclose it in an html a tag
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

Info

return - false if not found, or an html a link to the var's documentation
see - Converter::getVarLink()

Method makeLeft (line 554)

void makeLeft( )

Info

Method Output (line 1931)

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

void postProcess( $text)

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

Uses htmlspecialchars() on the input

Parameters

$text:

Info

Method ProgramExample (line 255)

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

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

Used to convert the <code> tag in a docblock

Parameters

string $example:
boolean $tutorial:
$inlinesourceparse:
$class:
$linenum:
$filesourcepath:

Info

Method rcNatCmp (line 1888)

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

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

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 - <a href="'.$link.'">'.$text.'</a>

Method returnSee (line 784)

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

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

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

Info

Method setTargetDir (line 1649)

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

see - Converter::setTargetDir()

Method SmartyInit (line 328)

void &SmartyInit( &$templ)

Parameters

&$templ:

Info

Method sourceLine (line 232)

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

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

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

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.

Info

return - formatted source code line with line number

Method TutorialExample (line 273)

void TutorialExample( string $example)

Overrides : Converter::TutorialExample() parent method not documented

Parameters

string $example:

Info

Method unmangle (line 292)

void unmangle( $sourcecode)

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

Parameters

$sourcecode:

Info

Method writeExample (line 172)

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

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

Parameters

$title:
$path:
$source:

Info

Method writeNewPPage (line 706)

void writeNewPPage( $key)

Parameters

$key:

Info

Method writeRIC (line 878)

void writeRIC( )

Info

Method writeSource (line 154)

void writeSource( $path, $value)

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

Parameters

$path:
$value:

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class Converter

Converter::$all_packages - All packages encountered in parsing

Converter::$class - set to a classname if currently parsing a class, false if not

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_data - template for the class currently being processed

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 - name of current page being converted

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

Converter::$page_data - template for the procedural page currently being processed

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

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

Converter::$path - path of current page being converted

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

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::$template_options - Options for each template, parsed from the options.ini file in the template base directory

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 ” 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