Class: XMLDocBookpeardoc2Converter
Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/Converters/XML/DocBook/peardoc2/XMLDocBookpeardoc2Converter.inc
Converter
|
--XMLDocBookpeardoc2Converter
XML DocBook converter.
Author(s):
Version:
|
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Variables
$base_dir =
[line 134]
target directory passed on the command-line. $targetDir is malleable, always adding package/ and package/subpackage/ subdirectories onto it.
$category =
[line 207]
peardoc2 Category
$class =
[line 103]
name of current class being converted
$class_data =
[line 146]
template for the class currently being processed
$class_dir =
[line 140]
output directory for the current class being processed
$current =
[line 176]
contains all of the template procedural page element loop data needed for the current template
$currentclass =
[line 182]
contains all of the template class element loop data needed for the current template
$function_data = array()
[line 198]
$juststarted = false
[line 170]
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' => false, 'functions' => false, 'defines' => true, 'globals' => true)
[line 80]
indexes of elements by package that need to be generated
$local = true
[line 85]
whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir
$method_data = array()
[line 199]
$name = 'DocBook/peardoc2'
[line 75]
$outputformat = 'XML'
[line 73]
$packagexml =
[line 159]
Contents of the packagename.xml file are stored in this template variable
$package_pages = array()
[line 153]
array of converted package page names. Used to link to the package page in the left index
$page =
[line 91]
name of current page being converted
$page_data =
[line 109]
template for the procedural page currently being processed
$page_dir =
[line 115]
output directory for the current procedural page being processed
$path =
[line 97]
path of current page being converted
$processSpecialRoots = true
[line 65]
This converter knows about the new root tree processing In order to fix PEAR Bug #6389
$sort_absolutely_everything = true
[line 187]
Pass elements by package, simplifies generation of package.xml/category.xml
$sort_page_contents_by_type = true
[line 71]
XMLDocBookConverter wants elements sorted by type as well as alphabetically
$sourceloc = ''
[line 202]
$template_options = array('usepear' => false)
[line 196]
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
XMLDocBookpeardoc2Converter (Constructor) [line 220]
XMLDocBookpeardoc2Converter XMLDocBookpeardoc2Converter(
&$allp,
&$packp,
&$classes,
&$procpages,
$po,
$pp,
$qm,
$targetDir,
$templateDir,
$title,
$charset)
|
|
sets $base_dir to $targetDir
Parameters:
addSummaryToPackageXml [line 345]
void addSummaryToPackageXml(
$template_output)
|
|
Parameters:
Br [line 681]
convertClass [line 793]
convertDefine [line 1009]
ConvertErrorLog [line 565]
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 937]
Converts function for template output - does nothing in peardoc2!
Overrides Converter::convertFunction() (Converts function for template output)
Parameters:
convertGlobal [line 1049]
Converts global variables for template output
Overrides Converter::convertGlobal() (Converts global variables for template output)
Parameters:
convertInclude [line 989]
Converts include elements for template output Completely ignored by this converter
Overrides Converter::convertInclude() (Converts includes for template output)
Parameters:
convertMethod [line 861]
convertPackagePage [line 708]
Does nothing - use tutorials for DocBook
Parameters:
convertPage [line 1099]
convertTutorial [line 716]
convertVar [line 755]
Does nothing in this converter
Overrides Converter::convertVar() (Converts class variables for template output.)
Parameters:
endClass [line 322]
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.)
exampleProgramExample [line 276]
string exampleProgramExample(
string
$example, [boolean
$tutorial = false], [
$inlinesourceparse = null], [
$class = null], [
$linenum = null], [
$filesourcepath = null])
|
|
Used to convert the {@example} inline tag in a docblock. By default, this just wraps ProgramExample
Overrides Converter::exampleProgramExample() (Used to convert the {@example} inline tag in a docblock.)
Parameters:
flushPackageXml [line 353]
formatIndex [line 419]
formatLeftIndex [line 440]
Creates package/lang/categoryname/packagename.xml for each package
Overrides Converter::formatLeftIndex() (Called by walk() while converting.)
formatPkgIndex [line 412]
generateChildClassList [line 1165]
generateElementIndex [line 1378]
void generateElementIndex(
)
|
|
does nothing
generateFormattedClassTree [line 1124]
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 1201]
void generateFormattedClassTrees(
string
$package)
|
|
returns a template-enabled array of class trees
Parameters:
generateFormattedInterfaceTrees [line 1255]
void generateFormattedInterfaceTrees(
string
$package)
|
|
returns a template-enabled array of interface inheritance trees
Parameters:
generatePkgElementIndex [line 1394]
void generatePkgElementIndex(
string
$package)
|
|
Generate alphabetical index of all elements by package and subpackage
Parameters:
generatePkgElementIndexes [line 1402]
void generatePkgElementIndexes(
)
|
|
getCData [line 686]
getClassLink [line 1415]
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 1447]
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:
getExampleLink [line 290]
void getExampleLink(
$unused,
$title)
|
|
Parameters:
getFunctionLink [line 1431]
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 1463]
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 513]
string getId(
mixed
&$el, [boolean
$returnpackage = false])
|
|
Get the id value needed to allow linking
Overrides Converter::getId() (take abstractLink descendant and text $eltext and return a)
Parameters:
getLink [line 237]
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 1496]
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 1479]
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 1111]
void getPageName(
&$element)
|
|
Parameters:
getRootTree [line 1312]
string getRootTree(
array
$tree, string
$package, [
$noparent = false], boolean
$nounknownparent)
|
|
return formatted class tree for the Class Trees page
Parameters:
getSourceAnchor [line 676]
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. NOTE: unused
Parameters:
getTutorialId [line 656]
void getTutorialId(
$package,
$subpackage,
$tutorial,
$id,
$category)
|
|
Overrides Converter::getTutorialId() (Return a converter-specific id to distinguish tutorials and their sections)
Parameters:
getVarLink [line 1513]
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 405]
Output [line 1575]
Generate the constants.xml, packagename.xml, and globals.xml files
Overrides Converter::Output() (do all necessary output)
postProcess [line 626]
prepareDocBlock [line 631]
void prepareDocBlock(
&$element, [
$nopackage = true])
|
|
Overrides Converter::prepareDocBlock() (convert the element's DocBlock for output)
Parameters:
ProgramExample [line 691]
void ProgramExample(
$listing, [
$tutorial = false], [
$inlinesourceparse = null], [
$class = null], [
$linenum = null], [
$filesourcepath = null], [
$origsource = null])
|
|
Overrides Converter::ProgramExample() (Used to convert the <code> tag in a docblock)
Parameters:
rcNatCmp [line 1527]
int rcNatCmp(
mixed
$a, mixed
$b)
|
|
does a nat case sort on the specified second level value of the array
Parameters:
rcNatCmp1 [line 1543]
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 400]
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 453]
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:
setTemplateDir [line 1382]
void setTemplateDir(
$dir)
|
|
Overrides Converter::setTemplateDir() (sets the template directory based on the $outputformat and $name)
Parameters:
type_adjust [line 296]
unmangle [line 242]
wordwrap [line 1567]
writeExample [line 285]
void writeExample(
$title,
$path,
$source)
|
|
Overrides Converter::writeExample() (Write out the formatted source code for an example php file)
Parameters:
writeFile [line 254]
void writeFile(
string
$file, string
$data, [boolean
$binary = false])
|
|
Writes a file to target dir, beautify any .xml files first
Overrides Converter::writeFile() (Writes a file to target dir)
Parameters:
writeNewPPage [line 426]
void writeNewPPage(
$key)
|
|
Does nothing
Parameters:
writeSource [line 433]
Documentation generated on Mon, 11 Mar 2019 15:50:36 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|