Converter
   |
   --XMLDocBookpeardoc2Converter

[line 58]
XML DocBook converter.

This Converter takes output from the Parser and converts it to DocBook output for PEAR documentation.

This Converter differs from the parent DocBook Converter in that it does not recognize the possibility of procedural pages or of functions! All functions must be defined as static methods for namespace purposes. In addition, all constants and global variables for a package are grouped together as per peardoc2 requirements. Include statements are not documented. If you want to document a normal project, don't use the peardoc2 converter, use the DocBook converter.

Tags:

$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

Tags:

$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

Tags:

$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!

$_peardoc2_constants =  false

[line 121]

Constants, used for constants.tpl

$_peardoc2_globals =  false

[line 127]

Global Variables, used for globals.tpl

$_write_constants_xml = array()

[line 200]

$_write_globals_xml = array()

[line 201]

---

constructor XMLDocBookpeardoc2Converter [line 220]

---

method addSummaryToPackageXml [line 345]

---

method Br [line 681]

---

method convertClass [line 793]

---

method convertDefine [line 1009]

---

method ConvertErrorLog [line 565]

---

method convertFunction [line 937]

---

method convertGlobal [line 1049]

---

method convertInclude [line 989]

---

method convertMethod [line 861]

---

method convertPackagePage [line 708]

---

method convertPage [line 1099]

---

method convertTutorial [line 716]

---

method convertVar [line 755]

---

method endClass [line 322]

---

method exampleProgramExample [line 276]

---

method flushPackageXml [line 353]

---

method formatIndex [line 419]

---

method formatLeftIndex [line 440]

---

method formatPkgIndex [line 412]

---

method generateChildClassList [line 1165]

---

method generateElementIndex [line 1378]

---

method generateFormattedClassTree [line 1124]

---

method generateFormattedClassTrees [line 1201]

---

method generateFormattedInterfaceTrees [line 1255]

---

method generatePkgElementIndex [line 1394]

---

method generatePkgElementIndexes [line 1402]

---

method getCData [line 686]

---

method getClassLink [line 1415]

---

method getDefineLink [line 1447]

---

method getExampleLink [line 290]

---

method getFunctionLink [line 1431]

---

method getGlobalLink [line 1463]

---

method getId [line 513]

---

method getLink [line 237]

---

method getMethodLink [line 1496]

---

method getPageLink [line 1479]

---

method getPageName [line 1111]

---

method getRootTree [line 1312]

---

method getSourceAnchor [line 676]

---

method getTutorialId [line 656]

---

method getVarLink [line 1513]

---

method makeLeft [line 405]

---

method Output [line 1575]

---

method postProcess [line 626]

---

method prepareDocBlock [line 631]

---

method ProgramExample [line 691]

---

method rcNatCmp [line 1527]

---

method rcNatCmp1 [line 1543]

---

method returnLink [line 400]

---

method returnSee [line 453]

---

method setTemplateDir [line 1382]

---

method type_adjust [line 296]

---

method unmangle [line 242]

---

method wordwrap [line 1567]

---

method writeExample [line 285]

---

method writeFile [line 254]

---

method writeNewPPage [line 426]

---

method writeSource [line 433]