Class: XMLDocBookConverter
Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/Converters/XML/DocBook/XMLDocBookConverter.inc
Converter
|
--XMLDocBookConverter
XML DocBook converter.
Author(s):
Version:
|
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Variables
$base_dir =
[line 101]
target directory passed on the command-line. $targetDir is malleable, always adding package/ and package/subpackage/ subdirectories onto it.
$category =
[line 162]
peardoc2 Category
$class =
[line 82]
name of current class being converted
$class_data =
[line 113]
template for the class currently being processed
$class_dir =
[line 107]
output directory for the current class being processed
$current =
[line 138]
contains all of the template procedural page element loop data needed for the current template
$currentclass =
[line 144]
contains all of the template class element loop data needed for the current template
$function_data = array()
[line 155]
$juststarted = false
[line 132]
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]
indexes of elements by package that need to be generated
$local = true
[line 64]
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]
$name = 'DocBook'
[line 54]
$outputformat = 'XML'
[line 52]
$package_pages = array()
[line 120]
array of converted package page names. Used to link to the package page in the left index
$page =
[line 70]
name of current page being converted
$page_data =
[line 88]
template for the procedural page currently being processed
$page_dir =
[line 94]
output directory for the current procedural page being processed
$path =
[line 76]
path of current page being converted
$sort_page_contents_by_type = true
[line 50]
XMLDocBookConverter wants elements sorted by type as well as alphabetically
$sourceloc = ''
[line 157]
$template_options = array('usepear' => false)
[line 153]
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!
Method Detail
XMLDocBookConverter (Constructor) [line 167]
XMLDocBookConverter XMLDocBookConverter(
&$allp,
&$packp,
&$classes,
&$procpages,
$po,
$pp,
$qm,
$targetDir,
$templateDir,
$title,
$charset)
|
|
sets $base_dir to $targetDir
Parameters:
convertClass [line 811]
convertDefine [line 1021]
ConvertErrorLog [line 625]
Create errors.html template file output This method takes all parsing errors and warnings and spits them out ordered by file and line number.
Overrides Converter::ConvertErrorLog() (Convert the phpDocumentor parsing/conversion error log)
convertFunction [line 952]
convertGlobal [line 1040]
Converts global variables for template output
Overrides Converter::convertGlobal() (Converts global variables for template output)
Parameters:
convertInclude [line 1003]
Converts include elements for template output
Overrides Converter::convertInclude() (Converts includes for template output)
Parameters:
convertMethod [line 873]
convertPackagePage [line 712]
Converts package page and sets its package as used in $package_pages
Parameters:
convertPage [line 1062]
convertTutorial [line 736]
convertVar [line 774]
Converts class variables for template output.
Overrides Converter::convertVar() (Converts class variables for template output.)
Parameters:
endClass [line 217]
Writes out the template file of $class_data and unsets the template to save memory
Overrides Converter::endClass() (Called by walk() while converting, when the last class element has been parsed.)
endPage [line 249]
Writes out the template file of $page_data and unsets the template to save memory
Overrides Converter::endPage() (Called by walk() while converting, when the last procedural page element has been parsed.)
formatIndex [line 360]
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.
Overrides Converter::formatIndex() (Called by walk() while converting.)
formatLeftIndex [line 438]
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
Overrides Converter::formatLeftIndex() (Called by walk() while converting.)
formatPkgIndex [line 327]
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
Overrides Converter::formatPkgIndex() (Called by walk() while converting.)
generateElementIndex [line 1260]
void generateElementIndex(
)
|
|
Generate alphabetical index of all elements
generateFormattedClassTree [line 1122]
returns an array containing the class inheritance tree from the root object to the class
Overrides Converter::generateFormattedClassTree() (returns an array containing the class inheritance tree from the root object to the class.)
Parameters:
generateFormattedClassTrees [line 1172]
void generateFormattedClassTrees(
string
$package)
|
|
returns a template-enabled array of class trees
Parameters:
generatePkgElementIndex [line 1448]
void generatePkgElementIndex(
string
$package)
|
|
Generate alphabetical index of all elements by package and subpackage
Parameters:
generatePkgElementIndexes [line 1588]
void generatePkgElementIndexes(
)
|
|
getCData [line 703]
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:
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:
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:
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:
getId [line 574]
string getId(
mixed
&$el)
|
|
Get the id value needed to allow linking
Overrides Converter::getId() (take abstractLink descendant and text $eltext and return a)
Parameters:
getLink [line 175]
void &getLink(
$expr, [
$package = false], [
$packages = false])
|
|
do that stuff in $template_options
Overrides Converter::getLink() (The meat of the @see tag and inline {@link} tag)
Parameters:
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:
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:
getPageName [line 1109]
void getPageName(
&$element)
|
|
Parameters:
getRootTree [line 1191]
string getRootTree(
array
$tree,
$package)
|
|
return formatted class tree for the Class Trees page
Parameters:
getTutorialId [line 696]
void getTutorialId(
$package,
$subpackage,
$tutorial,
$id)
|
|
Overrides Converter::getTutorialId() (Return a converter-specific id to distinguish tutorials and their sections)
Parameters:
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:
makeLeft [line 282]
Output [line 1783]
This function is not used by HTMLdefaultConverter, but is required by Converter
Overrides Converter::Output() (do all necessary output)
postProcess [line 686]
prepareDocBlock [line 691]
void prepareDocBlock(
&$element, [
$nopackage = true])
|
|
Overrides Converter::prepareDocBlock() (convert the element's DocBlock for output)
Parameters:
rcNatCmp [line 1740]
int rcNatCmp(
mixed
$a, mixed
$b)
|
|
does a nat case sort on the specified second level value of the array
Parameters:
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:
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:
returnSee [line 476]
void returnSee(
abstractLink
&$element, [string
$eltext = false], [boolean
$local = true], [boolean
$with_a = true])
|
|
This function takes an abstractLink descendant and returns an html link
Overrides Converter::returnSee() (take abstractLink descendant and text $eltext and return a link)
Parameters:
setTargetDir [line 1388]
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
Overrides Converter::setTargetDir() (Sets the output directory for generated documentation)
Parameters:
setTemplateDir [line 1378]
void setTemplateDir(
$dir)
|
|
Overrides Converter::setTemplateDir() (sets the template directory based on the $outputformat and $name)
Parameters:
SmartyInit [line 205]
void &SmartyInit(
&$templ)
|
|
Parameters:
type_adjust [line 186]
unmangle [line 180]
writeNewPPage [line 406]
void writeNewPPage(
$key)
|
|
Parameters:
Documentation generated on Mon, 11 Mar 2019 15:50:34 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|