$all_packages =
[line 366]
All packages encountered in parsing
Tags:
$class = false
[line 105]
set to a classname if currently parsing a class, false if not
$classes =
[line 319]
All class information, organized by path, and by package
$class_contents = array()
[line 269]
alphabetical index of all methods and vars in a class by package/subpackage
The class itself has a link under ###main
Tags:
$class_data =
[line 165]
template for the class currently being processed
$class_elements = array()
[line 208]
alphabetized index of classes by package
Tags:
$curfile =
[line 313]
full path of the current file being converted
$curpage =
[line 171]
current procedural page being processed
$define_elements = array()
[line 201]
alphabetized index of defines by package
Tags:
$elements = array()
[line 187]
alphabetical index of all elements
Tags:
$function_elements = array()
[line 222]
alphabetized index of functions by package
Tags:
$global_elements = array()
[line 215]
alphabetized index of global variables by package
Tags:
$highlightingSource = false
[line 325]
Flag used to help converters determine whether to do special source highlighting
$leftindex = array('classes' => true, 'pages' => true, 'functions' => true, 'defines' => true, 'globals' => true)
[line 384]
Controls which of the one-element-only indexes are generated.
Generation of these indexes for large packages is time-consuming. This is an optimization feature. An example of how to use this is in HTMLframesConverter::$leftindex, and in HTMLframesConverter::formatLeftIndex(). These indexes are intended for use as navigational aids through documentation, but can be used for anything by converters.
Tags:
$outputformat = 'Generic'
[line 90]
output format of this converter
in Child converters, this will match the first part of the -o command-line as in -o HTML:frames:default "HTML"
Tags:
$package = 'default'
[line 95]
package name currently being converted
$packagecategories =
[line 359]
Packages associated with categories
Used by the XML:DocBook/peardoc2 converter, and available to others, to group many packages into categories
Tags:
$package_elements = array()
[line 180]
alphabetical index of all elements sorted by package, subpackage, page, and class.
Tags:
$package_output =
[line 141]
set to value of -po commandline
Tags:
$package_parents =
[line 349]
Hierarchy of packages
Every package that contains classes may have parent or child classes in other packages. In other words, this code is legal:
In this case, package one is a parent of package two
Tags:
$page =
[line 147]
name of current page being converted
$page_contents = array()
[line 238]
alphabetical index of all elements on a page by package/subpackage
The page itself has a link under ###main
Tags:
$page_data =
[line 159]
template for the procedural page currently being processed
$page_elements = array()
[line 194]
alphabetized index of procedural pages by package
Tags:
$parseprivate =
[line 276]
controls processing of elements marked private with @access private
defaults to false. Set with command-line --parseprivate or -pp
$path =
[line 153]
path of current page being converted
$pkg_elements = array()
[line 229]
alphabetical index of all elements, indexed by package/subpackage
Tags:
$processSpecialRoots = false
[line 81]
This converter knows about the new root tree processing
In order to fix PEAR Bug #6389
$quietmode =
[line 283]
controls display of progress information while parsing.
defaults to false. Set to true for cron jobs or other situations where no visual output is necessary
$smarty_dir = ''
[line 301]
Directory that the smarty templates are in
$sort_absolutely_everything = false
[line 251]
This is used if the content must be passed in the order it should be read, i.e. by package, procedural then classes
This fixes bug 637921, and is used by PDFdefaultConverter
Tags:
$sort_page_contents_by_type = false
[line 245]
This determines whether the $page_contents array should be sorted by element type as well as alphabetically by name
Tags:
$sourcePaths = array()
[line 372]
A list of files that have had source code generated
$subpackage = ''
[line 100]
subpackage name currently being converted
$targetDir = ''
[line 289]
directory that output is sent to. -t command-line sets this.
Tags:
$templateDir = ''
[line 295]
Directory that the template is in, relative to phpDocumentor root directory
$templateName = ''
[line 308]
Name of the template, from last part of -o
Tags:
$template_options =
[line 399]
Options for each template, parsed from the options.ini file in the template base directory
Tags:
$title = 'Generated Documentation'
[line 392]
Tags:
$todoList = array()
[line 429]
List of all @todo tags and a link to the element with the @todo
Format: array(package => array(link to element, array(todo parserTag,...)),...)
Tags:
constructor Converter [line 452]
Converter Converter(
array
&$allp, array
&$packp, Classes
&$classes, ProceduralPages
&$procpages, array
$po, boolean
$pp, boolean
$qm, string
$targetDir, string
$template, string
$title)
|
|
Initialize Converter data structures
Parameters:
method AttrToString [line 1307]
string AttrToString(
string
$tag, attribute
$attr, [boolean
$unmodified = false])
|
|
Convert the attribute of a Tutorial docbook tag's attribute list
to a string based on the template options.ini
Parameters:
method Bolden [line 931]
string Bolden(
string
$para)
|
|
Used to convert the contents of <b> in a docblock
Tags:
Parameters:
method Br [line 1001]
method checkState [line 5362]
void checkState(
mixed
$state)
|
|
Compare parserStringWithInlineTags::Convert() cache state to $state
Tags:
Parameters:
method cleanup [line 5073]
Finish up parsing/cleanup directories
method Convert [line 3978]
void Convert(
mixed
&$element)
|
|
Convert all elements to output format
This will call ConvertXxx where Xxx is http://www.php.net/ucfirst($element->type). It is expected that a child converter defines a handler for every element type, even if that handler does nothing. phpDocumentor will terminate with an error if a handler doesn't exist.
Tags:
Parameters:
method convertClass [line 4042]
method convertConst [line 4213]
method convertDefine [line 4330]
method ConvertErrorLog [line 2422]
method convertFunction [line 4387]
method convertGlobal [line 4296]
method convertInclude [line 4359]
method convertMethod [line 4109]
method convertPage [line 4250]
method ConvertTitle [line 1396]
string ConvertTitle(
string
$tag, array
$attr, string
$title, string
$cdata)
|
|
Convert the title of a Tutorial docbook tag section
to a string based on the template options.ini
Parameters:
method ConvertTodoList [line 2430]
method convertTutorial [line 4006]
method convertVar [line 4169]
method Convert_RIC [line 3958]
method copyFile [line 5337]
void copyFile(
string
$file, [
$subdir = ''])
|
|
Copies a file from the template directory to the target directory
thanks to Robert Hoffmann for this fix
Parameters:
method createParentDir [line 5253]
void createParentDir(
string
$dir)
|
|
Recursively creates all subdirectories that don't exist in the $dir path
Parameters:
method EncloseList [line 888]
string EncloseList(
string
$list,
$ordered)
|
|
Used to convert the contents of <ol> or <ul> in a docblock
Tags:
Parameters:
method EncloseParagraph [line 917]
string EncloseParagraph(
string
$para)
|
|
Used to enclose a paragraph in a docblock
Parameters:
method endClass [line 507]
Called by walk() while converting, when the last class element has been parsed.
A Converter can use this method in any way it pleases. HTMLframesConverter uses it to complete the template for the class and to output its documentation
Tags:
Overridden in child classes as:
- CHMdefaultConverter::endClass()
- Writes out the template file of $class_data and unsets the template to save memory
- XMLDocBookpeardoc2Converter::endClass()
- Writes out the template file of $class_data and unsets the template to save memory
- XMLDocBookConverter::endClass()
- Writes out the template file of $class_data and unsets the template to save memory
- HTMLSmartyConverter::endClass()
- Writes out the template file of $class_data and unsets the template to save memory
- HTMLframesConverter::endClass()
- Writes out the template file of $class_data and unsets the template to save memory
method endPage [line 521]
Called by walk() while converting, when the last procedural page element has been parsed.
A Converter can use this method in any way it pleases. HTMLframesConverter uses it to complete the template for the procedural page and to output its documentation
Tags:
Overridden in child classes as:
- CHMdefaultConverter::endPage()
- Writes out the template file of $page_data and unsets the template to save memory
- XMLDocBookConverter::endPage()
- Writes out the template file of $page_data and unsets the template to save memory
- HTMLSmartyConverter::endPage()
- Writes out the template file of $page_data and unsets the template to save memory
- HTMLframesConverter::endPage()
- Writes out the template file of $page_data and unsets the template to save memory
method exampleProgramExample [line 773]
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
Tags:
Overridden in child classes as:
- XMLDocBookpeardoc2Converter::exampleProgramExample()
- Used to convert the {@example} inline tag in a docblock.
Parameters:
method flushHighlightCache [line 609]
string flushHighlightCache(
)
|
|
Return the close text for the current token
method formatIndex [line 545]
method formatLeftIndex [line 559]
method formatPkgIndex [line 533]
method formatTutorialTOC [line 1030]
string formatTutorialTOC(
array
$toc)
|
|
Creates a table of contents for a {@toc} inline tag in a tutorial
This function should return a formatted table of contents. By default, it does nothing, it is up to the converter to format the TOC
Tags:
Overridden in child classes as:
- CHMdefaultConverter::formatTutorialTOC()
- Use the template tutorial_toc.tpl to generate a table of contents for HTML
- HTMLSmartyConverter::formatTutorialTOC()
- Use the template tutorial_toc.tpl to generate a table of contents for HTML
- HTMLframesConverter::formatTutorialTOC()
- Use the template tutorial_toc.tpl to generate a table of contents for HTML
Parameters:
method generateChildClassList [line 4790]
method generateFormattedClassTree [line 4637]