XML DocBook converter.
This Converter takes output from the Parser and converts it to DocBook output
Located in /phpDocumentor/Converters/XML/DocBook/XMLDocBookConverter.inc (line 43)
Converter | --XMLDocBookConverter
target directory passed on the command-line.
$targetDir is malleable, always adding package/ and package/subpackage/ subdirectories onto it.
peardoc2 Category
name of current class being converted
template for the class currently being processed
output directory for the current class being processed
contains all of the template procedural page element loop data needed for the current template
contains all of the template class element loop data needed for the current template
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
indexes of elements by package that need to be generated
whether a @see is going to be in the $base_dir, or in a package/subpackage subdirectory of $base_dir
array of converted package page names.
Used to link to the package page in the left index
name of current page being converted
template for the procedural page currently being processed
output directory for the current procedural page being processed
path of current page being converted
XMLDocBookConverter wants elements sorted by type as well as alphabetically
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!
Inherited from Converter
Converter::$all_packages
Converter::$classes
Converter::$class_contents
Converter::$class_elements
Converter::$curfile
Converter::$curpage
Converter::$define_elements
Converter::$elements
Converter::$function_elements
Converter::$global_elements
Converter::$highlightingSource
Converter::$package
Converter::$packagecategories
Converter::$package_elements
Converter::$package_output
Converter::$package_parents
Converter::$page_contents
Converter::$page_elements
Converter::$parseprivate
Converter::$pkg_elements
Converter::$processSpecialRoots
Converter::$quietmode
Converter::$smarty_dir
Converter::$sort_absolutely_everything
Converter::$sourcePaths
Converter::$subpackage
Converter::$targetDir
Converter::$templateDir
Converter::$templateName
Converter::$title
Converter::$todoList
sets $base_dir to $targetDir
Converts class for template output
Converts defines for template output
Create errors.html template file output
This method takes all parsing errors and warnings and spits them out ordered by file and line number.
Converts function for template output
Converts global variables for template output
Converts include elements for template output
Converts method for template output
Converts package page and sets its package as used in $package_pages
converts procedural pages for template output
Converts class variables for template output.
Writes out the template file of $class_data and unsets the template to save memory
Writes out the template file of $page_data and unsets the template to save memory
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.
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
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
Generate alphabetical index of all elements
returns an array containing the class inheritance tree from the root object to the class
returns a template-enabled array of class trees
Generate alphabetical index of all elements by package and subpackage
Get the id value needed to allow linking
do that stuff in $template_options
return formatted class tree for the Class Trees page
This function is not used by HTMLdefaultConverter, but is required by Converter
does a nat case sort on the specified second level value of the array
does a nat case sort on the specified second level value of the array.
this one puts constructors first
This function takes an abstractLink descendant and returns an html link
calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied
Inherited From Converter
Converter::Converter()
Converter::AttrToString()
Converter::Bolden()
Converter::Br()
Converter::checkState()
Converter::cleanup()
Converter::Convert()
Converter::convertClass()
Converter::convertConst()
Converter::convertDefine()
Converter::ConvertErrorLog()
Converter::convertFunction()
Converter::convertGlobal()
Converter::convertInclude()
Converter::convertMethod()
Converter::convertPage()
Converter::ConvertTitle()
Converter::ConvertTodoList()
Converter::convertTutorial()
Converter::convertVar()
Converter::Convert_RIC()
Converter::copyFile()
Converter::createParentDir()
Converter::EncloseList()
Converter::EncloseParagraph()
Converter::endClass()
Converter::endPage()
Converter::exampleProgramExample()
Converter::flushHighlightCache()
Converter::formatIndex()
Converter::formatLeftIndex()
Converter::formatPkgIndex()
Converter::formatTutorialTOC()
Converter::generateChildClassList()
Converter::generateFormattedClassTree()
Converter::getClassesOnPage()
Converter::getClassLink()
Converter::getConstLink()
Converter::getConverterDir()
Converter::getCurrentPageLink()
Converter::getCurrentPageURL()
Converter::getDefineLink()
Converter::getFileSourceName()
Converter::getFileSourcePath()
Converter::getFormattedConflicts()
Converter::getFormattedDescMethods()
Converter::getFormattedDescVars()
Converter::getFormattedImplements()
Converter::getFormattedInheritedConsts()
Converter::getFormattedInheritedMethods()
Converter::getFormattedInheritedVars()
Converter::getFormattedMethodImplements()
Converter::getFormattedOverrides()
Converter::getFunctionLink()
Converter::getGlobalLink()
Converter::getGlobalValue()
Converter::getHighlightState()
Converter::getId()
Converter::getIncludeValue()
Converter::getLink()
Converter::getMethodLink()
Converter::getPageLink()
Converter::getSortedClassTreeFromClass()
Converter::getSourceLink()
Converter::getState()
Converter::getTutorialId()
Converter::getTutorialLink()
Converter::getTutorialTree()
Converter::getVarLink()
Converter::hasSourceCode()
Converter::hasTutorial()
Converter::highlightDocBlockSource()
Converter::highlightSource()
Converter::highlightTutorialSource()
Converter::Italicize()
Converter::Kbdize()
Converter::ListItem()
Converter::newSmarty()
Converter::Output()
Converter::postProcess()
Converter::prepareDocBlock()
Converter::PreserveWhiteSpace()
Converter::ProgramExample()
Converter::returnLink()
Converter::returnSee()
Converter::Sampize()
Converter::setSourcePaths()
Converter::setTargetDir()
Converter::setTemplateBase()
Converter::setTemplateDir()
Converter::sortPageContentsByElementType()
Converter::sourceLine()
Converter::startHighlight()
Converter::TranslateEntity()
Converter::TranslateTag()
Converter::TutorialExample()
Converter::type_adjust()
Converter::unmangle()
Converter::vardump_tree()
Converter::Varize()
Converter::walk()
Converter::walk_everything()
Converter::writeExample()
Converter::writeFile()
Converter::writeSource()
Converter::_rmdir()
Converter::_setHighlightCache()
Converter::_tutorial_path()
Documentation generated on Mon, 05 Dec 2011 21:46:06 -0600 by phpDocumentor 1.4.4