Converters

[ ] [ ] [ ]

Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier

Tutorials/Manuals:
В пакете:

Converter Manual

Class-level:

Writing a New Converter
- Converter Default Template Variables
- Writing a Converter, Methods

Using the PDFParser XML templating language

Writing templates for the PDFdefault Converter

Writing templates for the CHMdefault Converter

Writing templates for the XMLDocBook Converter

Writing templates for the HTMLSmarty Converter

Writing templates for the HTMLframes Converter

Files:

Converter.inc

subpackage CHMdefault

CHMdefaultConverter.inc

subpackage HTMLframes

HTMLframesConverter.inc
HTMLSmartyConverter.inc

subpackage PDFdefault

class.phpdocpdf.php
ParserPDF.inc
PDFdefaultConverter.inc

subpackage XMLDocBook

XMLDocBookConverter.inc
XMLDocBookpeardoc2Converter.inc

Classes:

CHMdefault
CHMdefaultConverter

PDFdefault
PDFdefaultConverter
PDFParser
phpdocpdf

Converter

HTMLframes
HTMLframesConverter

HTMLSmarty
HTMLSmartyConverter

XMLDocBook
XMLDocBookConverter
XMLDocBookpeardoc2Converter

Class: Converter

Source Location: /phpDocumentor/Converter.inc

Class Overview

Base class for all output converters.

Author(s):

Greg Beaver <cellog@php.net>

Version:

$Id: Converter.inc 287891 2009-08-30 08:08:00Z ashnazg $

Child classes:

XMLDocBookpeardoc2Converter: XML DocBook converter.

XMLDocBookConverter: XML DocBook converter.

HTMLSmartyConverter: HTML output converter.

HTMLframesConverter: HTML output converter.

PDFdefaultConverter: PDF output converter.

CHMdefaultConverter: Generates files that MS HTML Help Worshop can use to create a MS Windows compiled help file (CHM)

Class Details

[line 74]
Base class for all output converters.

The Converter marks the final stage in phpDocumentor. phpDocumentor works in this order:

Parsing => Intermediate Parsing organization => Conversion to output

A Converter takes output from the phpDocumentor_IntermediateParser and converts it to output. With version 1.2, phpDocumentor includes a variety of output converters:

{@ and using walk() or walk_everything (depending on the value of $sort_absolutely_everything) it "walks" over an array of phpDocumentor elements.}}

Tags:

author:	Greg Beaver <cellog@php.net>
version:	$Id: Converter.inc 287891 2009-08-30 08:08:00Z ashnazg $
abstract:
since:	1.0rc1

[ Top ]

Class Variables

$all_packages =

[line 366]

All packages encountered in parsing

Tags:

see:

phpDocumentor_IntermediateParser::$all_packages

Type:

array

[ Top ]

$class = false

[line 105]

set to a classname if currently parsing a class, false if not

Type:

string|false

[ Top ]

$classes =

[line 319]

All class information, organized by path, and by package

Type:

Classes

[ Top ]

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

var:	Format: array(package => array(subpackage => array(path => array(class => array(abstractLink descendant 1, ... ) ) ) )
see:	Converter::formatLeftIndex()

Type:

array

[ Top ]

$class_data =

[line 165]

template for the class currently being processed

Type:

Smarty

[ Top ]

$class_elements = array()

[line 208]

alphabetized index of classes by package

Tags:

var:	Format: array(package => array(subpackage => array(classLink 1,classLink 2,...)
see:	Converter::$leftindex

Type:

array

[ Top ]

$curfile =

[line 313]

full path of the current file being converted

Type:

mixed

[ Top ]

$curpage =

[line 171]

current procedural page being processed

Type:

parserPage

[ Top ]

$define_elements = array()

[line 201]

alphabetized index of defines by package

Tags:

var:	Format: array(package => array(subpackage => array(defineLink 1,defineLink 2,...)
see:	Converter::$leftindex

Type:

array

[ Top ]

$elements = array()

[line 187]

alphabetical index of all elements

Tags:

var:	Format: array(first letter of element name => array(parserElement or parserPage,...))
see:	Converter::formatIndex(), HTMLframesConverter::formatIndex()

Type:

array

[ Top ]

$function_elements = array()

[line 222]

alphabetized index of functions by package

Tags:

var:	Format: array(package => array(subpackage => array(functionLink 1,functionLink 2,...)
see:	Converter::$leftindex

Type:

array

[ Top ]

$global_elements = array()

[line 215]

alphabetized index of global variables by package

Tags:

var:	Format: array(package => array(subpackage => array(globalLink 1,globalLink 2,...)
see:	Converter::$leftindex

Type:

array

[ Top ]

$highlightingSource = false

[line 325]

Flag used to help converters determine whether to do special source highlighting

Type:

boolean

[ Top ]

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

see:	Converter::formatLeftIndex()
see:	Converter::$class_elements, Converter::$page_elements, Converter::$function_elements, Converter::$define_elements, Converter::$global_elements

Type:

array

[ Top ]

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

tutorial:

phpDocumentor Tutorial

Type:

string

[ Top ]

$package = 'default'

[line 95]

package name currently being converted

Type:

string

[ Top ]

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

see:

phpDocumentor_IntermediateParser::$packagecategories

Type:

array

[ Top ]

$package_elements = array()

[line 180]

alphabetical index of all elements sorted by package, subpackage, page, and class.

Tags:

var:	Format: array(package => array(subpackage => array('page'\|'class' => array(path\|classname => array(element, element,...)))))
uses:	Converter::$sort_absolutely_everything - if true, then $package_elements is used, otherwise, the ParserData::$classelements and ParserData::$pageelements variables are used

Type:

array

[ Top ]

$package_output =

[line 141]

set to value of -po commandline

Tags:

tutorial:

phpDocumentor Tutorial

Type:

mixed

[ Top ]

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

see:

phpDocumentor_IntermediateParser::$package_parents

Type:

array

[ Top ]

$page =

[line 147]

name of current page being converted

Type:

string

[ Top ]

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

var:	Format: array(package => array(subpackage => array(path => array(abstractLink descendant 1, ...)))
see:	Converter::formatLeftIndex()

Type:

array

[ Top ]

$page_data =

[line 159]

template for the procedural page currently being processed

Type:

Smarty

[ Top ]

$page_elements = array()

[line 194]

alphabetized index of procedural pages by package

Tags:

var:	Format: array(package => array(subpackage => array(pageLink 1,pageLink 2,...)
see:	Converter::$leftindex

Type:

array

[ Top ]

$parseprivate =

[line 276]

controls processing of elements marked private with @access private

defaults to false. Set with command-line --parseprivate or -pp

Type:

bool

[ Top ]

$path =

[line 153]

path of current page being converted

Type:

string

[ Top ]

$pkg_elements = array()

[line 229]

alphabetical index of all elements, indexed by package/subpackage

Tags:

var:	Format: array(first letter of element name => array(parserElement or parserPage,...))
see:	Converter::formatPkgIndex(), HTMLframesConverter::formatPkgIndex()

Type:

array

[ Top ]

$processSpecialRoots = false

[line 81]

This converter knows about the new root tree processing

In order to fix PEAR Bug #6389

Type:

boolean

[ Top ]

$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

Type:

bool

[ Top ]

$smarty_dir = ''

[line 301]

Directory that the smarty templates are in

Type:

string

[ Top ]

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

usedby:

Converter::$package_elements - if true, then $package_elements is used, otherwise, the ParserData::$classelements and ParserData::$pageelements variables are used

Type:

mixed

[ Top ]

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

see:

Converter::sortPageContentsByElementType()

Type:

boolean

[ Top ]

$sourcePaths = array()

[line 372]

A list of files that have had source code generated

Type:

array

[ Top ]

$subpackage = ''

[line 100]

subpackage name currently being converted

Type:

string

[ Top ]

$targetDir = ''

[line 289]

directory that output is sent to. -t command-line sets this.

Tags:

tutorial:

phpDocumentor Tutorial

Type:

mixed

[ Top ]

$templateDir = ''

[line 295]

Directory that the template is in, relative to phpDocumentor root directory

Type:

string

[ Top ]

$templateName = ''

[line 308]

Name of the template, from last part of -o

Tags:

tutorial:

phpDocumentor Tutorial

Type:

string

[ Top ]

$template_options =

[line 399]

Options for each template, parsed from the options.ini file in the template base directory

Tags:

tutorial:

phpDocumentor Tutorials

Type:

array

[ Top ]

$title = 'Generated Documentation'

[line 392]

Tags:

see:

phpDocumentor_IntermediateParser::$title

Type:

string

[ Top ]

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

tutorial:

@todo

Type:

array

[ Top ]

Class Methods

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:

array	&$allp	$all_packages value
array	&$packp	$package_parents value
Classes	&$classes	$classes value
ProceduralPages	&$procpages	$proceduralpages value
array	$po	$package_output value
boolean	$pp	$parseprivate value
boolean	$qm	$quietmode value
string	$targetDir	$targetDir value
string	$template	$templateDir value
string	$title	(@link $title} value

[ Top ]

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:

string	$tag	tag name
attribute	$attr	array
boolean	$unmodified	if true, returns attrname="value"...

[ Top ]

method Bolden [line 931]

string Bolden(
string
$para)

Used to convert the contents of <b> in a docblock

Tags:

usedby:

parserB::Convert()

Parameters:

string

$para

[ Top ]

method Br [line 1001]

string Br(
string
$para)

Used to convert <br> in a docblock

Parameters:

string

$para

[ Top ]

method checkState [line 5366]

void checkState(
mixed
$state)

Compare parserStringWithInlineTags::Convert() cache state to $state

Tags:

see:	parserStringWithInlineTags::Convert()
abstract:

Parameters:

mixed

$state

[ Top ]

method cleanup [line 5077]

void cleanup(
)

Finish up parsing/cleanup directories

[ Top ]

method Convert [line 3982]

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:

throws:

PDERROR_NO_CONVERT_HANDLER

Parameters:

mixed

&$element

parserElement descendant or parserPackagePage or parserData

[ Top ]

method convertClass [line 4046]

void convertClass(

&$element)

Default Class Handler

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. Sets up the class template. {@, getFormattedConflicts, getFormattedInheritedMethods, and getFormattedInheritedVars are called to complete vital template setup.}}

Overridden in child classes as:

XMLDocBookpeardoc2Converter::convertClass(): Converts class for template output

XMLDocBookConverter::convertClass(): Converts class for template output

HTMLSmartyConverter::convertClass(): Converts class for template output

HTMLframesConverter::convertClass(): Converts class for template output

PDFdefaultConverter::convertClass()

CHMdefaultConverter::convertClass(): Converts class for template output

Parameters:

&$element

[ Top ]

method convertConst [line 4217]

void convertConst(
parserConst
&$element, [
$additions = array()])

Converts class constants for template output.

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template.

This function must be called by a child converter with any extra template variables needed in the parameter $addition

Overridden in child classes as:

HTMLSmartyConverter::convertConst(): Converts class variables for template output

HTMLframesConverter::convertConst(): Converts class variables for template output

PDFdefaultConverter::convertConst()

CHMdefaultConverter::convertConst(): Converts class constants for template output

Parameters:

parserConst	&$element
	$additions

[ Top ]

method convertDefine [line 4334]

void convertDefine(
parserDefine
&$element, [array
$addition = array()])

Converts defines for template output

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. This function must be called by a child converter with any extra template variables needed in the parameter $addition {@, this method also uses utility functions getGlobalValue(), getFormattedConflicts()}}

Parameters:

parserDefine	&$element
array	$addition	any additional template variables should be in this array

[ Top ]

method ConvertErrorLog [line 2426]

void ConvertErrorLog(
)

Convert the phpDocumentor parsing/conversion error log

method convertFunction [line 4391]

void convertFunction(
parserFunction
&$element, [
$addition = array()])

Converts function for template output

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. This function must be called by a child converter with any extra template variables needed in the parameter $addition

Parameters:

parserFunction	&$element
	$addition

[ Top ]

method convertGlobal [line 4300]

void convertGlobal(
parserGlobal
&$element, [array
$addition = array()])

Converts global variables for template output

Conversion Handlers

Parameters:

parserGlobal	&$element
array	$addition	any additional template variables should be in this array

[ Top ]

method convertInclude [line 4363]

void convertInclude(
parserInclude
&$element, [
$addition = array()])

Converts includes for template output

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. This function must be called by a child converter with any extra template variables needed in the parameter $addition

Parameters:

parserInclude	&$element
	$addition

[ Top ]

method convertMethod [line 4113]

void convertMethod(
parserMethod
&$element, [
$additions = array()])

Converts method for template output

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. This function must be called by a child converter with any extra template variables needed in the parameter $addition

Overridden in child classes as:

XMLDocBookpeardoc2Converter::convertMethod(): Converts method for template output

XMLDocBookConverter::convertMethod(): Converts method for template output

HTMLSmartyConverter::convertMethod(): Converts class methods for template output

HTMLframesConverter::convertMethod(): Converts class methods for template output

PDFdefaultConverter::convertMethod()

CHMdefaultConverter::convertMethod(): Converts class methods for template output

Parameters:

parserMethod	&$element
	$additions

[ Top ]

method convertPage [line 4254]

void convertPage(
parserPage
&$element)

Default Page Handler

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. {@, this class uses getSourceLocation() and getClassesOnPage() to set template variables. Also used is getPageName(), to get a Converter-specific name for the page.}}

Overridden in child classes as:

XMLDocBookpeardoc2Converter::convertPage(): converts procedural pages for template output

XMLDocBookConverter::convertPage(): converts procedural pages for template output

HTMLSmartyConverter::convertPage(): converts procedural pages for template output

HTMLframesConverter::convertPage(): converts procedural pages for template output

PDFdefaultConverter::convertPage()

CHMdefaultConverter::convertPage(): converts procedural pages for template output

Parameters:

parserPage

&$element

[ Top ]

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:

string	$tag	tag name
array	$attr
string	$title	title text
string	$cdata

[ Top ]

method ConvertTodoList [line 2434]

void ConvertTodoList(
)

Convert the list of all @todo tags

method convertTutorial [line 4010]

void &convertTutorial(
parserTutorial
&$element)

Default Tutorial Handler

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template. Sets up the tutorial template, and its prev/next/parent links {@ and uses the parserTutorial::prev, parserTutorial::next, parserTutorial::parent links to set up those links.}}

Overridden in child classes as:

XMLDocBookpeardoc2Converter::convertTutorial(): Convert tutorials for output

XMLDocBookConverter::convertTutorial()

HTMLSmartyConverter::convertTutorial()

HTMLframesConverter::convertTutorial()

PDFdefaultConverter::convertTutorial()

CHMdefaultConverter::convertTutorial()

Parameters:

parserTutorial

&$element

[ Top ]

method convertVar [line 4173]

void convertVar(
parserVar
&$element, [
$additions = array()])

Converts class variables for template output.

Conversion Handlers

All of the convert* handlers set up template variables for the Smarty template.

This function must be called by a child converter with any extra template variables needed in the parameter $addition

Overridden in child classes as:

XMLDocBookpeardoc2Converter::convertVar(): Does nothing in this converter

XMLDocBookConverter::convertVar(): Converts class variables for template output.

HTMLSmartyConverter::convertVar(): Converts class variables for template output

HTMLframesConverter::convertVar(): Converts class variables for template output

PDFdefaultConverter::convertVar()

CHMdefaultConverter::convertVar(): Converts class variables for template output

Parameters:

parserVar	&$element
	$additions

[ Top ]

method Convert_RIC [line 3962]

void Convert_RIC(
README|INSTALL|CHANGELOG
$name, string
$contents)

Convert README/INSTALL/CHANGELOG file contents to output format

Parameters:

README\|INSTALL\|CHANGELOG	$name
string	$contents	contents of the file

[ Top ]

method copyFile [line 5341]

void copyFile(
string
$file, [
$subdir = ''])

Copies a file from the template directory to the target directory

thanks to Robert Hoffmann for this fix

Parameters:

string	$file
	$subdir

[ Top ]

method createParentDir [line 5257]

void createParentDir(
string
$dir)

Recursively creates all subdirectories that don't exist in the $dir path

Parameters:

string

$dir

[ Top ]

method EncloseList [line 888]

string EncloseList(
string
$list, 
$ordered)

Used to convert the contents of <ol> or <ul> in a docblock

Tags:

usedby:

parserList::Convert() - enclose the list

Parameters:

string	$list
	$ordered

[ Top ]

method EncloseParagraph [line 917]

string EncloseParagraph(
string
$para)

Used to enclose a paragraph in a docblock

Parameters:

string

$para

[ Top ]

method endClass [line 507]

void endClass(
)

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:

see:	HTMLframesConverter::endClass()
abstract:

Overridden in child classes as:

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

CHMdefaultConverter::endClass(): Writes out the template file of $class_data and unsets the template to save memory

[ Top ]

method endPage [line 521]

void endPage(
)

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:

see:	HTMLframesConverter::endClass()
abstract:

Overridden in child classes as:

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

CHMdefaultConverter::endPage(): Writes out the template file of $page_data and unsets the template to save memory

[ Top ]

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

Parameters:

string	$example
boolean	$tutorial	true if this is to highlight a tutorial <programlisting>
	$inlinesourceparse
	$class
	$linenum
	$filesourcepath

[ Top ]

method flushHighlightCache [line 609]

string flushHighlightCache(
)

Return the close text for the current token

[ Top ]

method formatIndex [line 545]

void formatIndex(
)

Called by walk() while converting.

This method is intended to be the place that $elements is formatted for output.

Tags:

see:	HTMLframesConverter::formatIndex()
abstract:

Overridden in child classes as:

XMLDocBookpeardoc2Converter::formatIndex(): Does nothing

XMLDocBookConverter::formatIndex(): HTMLdefaultConverter uses this function to format template index.html and packages.html

HTMLSmartyConverter::formatIndex(): HTMLdefaultConverter uses this function to format template index.html and packages.html

HTMLframesConverter::formatIndex(): HTMLdefaultConverter uses this function to format template index.html and packages.html

CHMdefaultConverter::formatIndex(): CHMdefaultConverter uses this function to format template index.html and packages.html

[ Top ]

method formatLeftIndex [line 559]

void formatLeftIndex(
)

Called by walk() while converting.

This method is intended to be the place that any of $class_elements, $function_elements, $page_elements, $define_elements, and $global_elements is formatted for output, depending on the value of $leftindex

Tags:

see:	HTMLframesConverter::formatLeftIndex()
abstract:

Overridden in child classes as:

XMLDocBookpeardoc2Converter::formatLeftIndex(): Creates package/lang/categoryname/packagename.xml for each package

XMLDocBookConverter::formatLeftIndex(): Generate indexes for li_package.html and classtree output files

HTMLSmartyConverter::formatLeftIndex(): Generate indexes for li_package.html and classtree output files

HTMLframesConverter::formatLeftIndex(): Generate indexes for li_package.html and classtree output files

CHMdefaultConverter::formatLeftIndex(): Generate indexes for li_package.html and classtree output files

[ Top ]

method formatPkgIndex [line 533]

void formatPkgIndex(
)

Called by walk() while converting.

This method is intended to be the place that $pkg_elements is formatted for output.

Tags:

see:	HTMLframesConverter::formatPkgIndex()
abstract:

Overridden in child classes as:

XMLDocBookpeardoc2Converter::formatPkgIndex(): Does nothing

XMLDocBookConverter::formatPkgIndex(): HTMLdefaultConverter chooses to format both package indexes and the complete index here

HTMLSmartyConverter::formatPkgIndex(): HTMLdefaultConverter chooses to format both package indexes and the complete index here

HTMLframesConverter::formatPkgIndex(): HTMLdefaultConverter chooses to format both package indexes and the complete index here

CHMdefaultConverter::formatPkgIndex(): CHMdefaultConverter chooses to format both package indexes and the complete index here

[ Top ]

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:

return:	table of contents formatted for use in the current output format
abstract:
usedby:	parserTocInlineTag::Convert() - passes an array of format:

Overridden in child classes as:

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

CHMdefaultConverter::formatTutorialTOC(): Use the template tutorial_toc.tpl to generate a table of contents for HTML

Parameters:

array

$toc

format: array(array('tagname' => section, 'link' => returnsee link, 'id' => anchor name, 'title' => from title tag),...)

[ Top ]

method generateChildClassList [line 4794]

void generateChildClassList(
parserClass
$class)

returns a list of child classes

Parameters:

parserClass

$class

class variable

[ Top ]

method generateFormattedClassTree [line 4641]

string generateFormattedClassTree(
parserClass
$class)

returns an array containing the class inheritance tree from the root object to the class.

This method must be overridden, or phpDocumentor will halt with a fatal error

Tags:

return:	Converter-specific class tree for an individual class
abstract:

Overridden in child classes as:

XMLDocBookpeardoc2Converter::generateFormattedClassTree(): returns an array containing the class inheritance tree from the root object to the class

XMLDocBookConverter::generateFormattedClassTree(): returns an array containing the class inheritance tree from the root object to the class

HTMLSmartyConverter::generateFormattedClassTree(): returns an array containing the class inheritance tree from the root object to the class

HTMLframesConverter::generateFormattedClassTree(): returns an array containing the class inheritance tree from the root object to the class

CHMdefaultConverter::generateFormattedClassTree(): returns an array containing the class inheritance tree from the root object to the class

Parameters:

parserClass

$class

class variable

[ Top ]

method getClassesOnPage [line 4593]

array getClassesOnPage(
parserData
&$element)

gets a list of all classes declared on a procedural page represented by

$element, a parserData class

Tags:

return:

links to each classes documentation

Format:

 array('name' => class name,
       'sdesc' => summary of the class
       'link' => link to the class's documentation)

Parameters:

parserData

&$element

[ Top ]

method getClassLink [line 3179]

mixed getClassLink(
string
$expr, string
$package, [
$file = false], [
$text = false])

return false or a classLink to $expr

Tags:

return:	returns a classLink or false if the element is not found in package $package
see:	classLink

Overridden in child classes as:

XMLDocBookpeardoc2Converter::getClassLink()

XMLDocBookConverter::getClassLink()

HTMLSmartyConverter::getClassLink()

HTMLframesConverter::getClassLink()

PDFdefaultConverter::getClassLink()

CHMdefaultConverter::getClassLink()

Parameters:

string	$expr	class name
string	$package	package name
	$file
	$text

[ Top ]

method getConstLink [line 3354]

mixed getConstLink(
string
$expr, string
$class, string
$package, [
$file = false], [
$text = false])

return false or a constLink to $expr in $class

Tags:

return:	returns a varLink or false if the element is not found in package $package, class $class
see:	constLink

Overridden in child classes as:

HTMLSmartyConverter::getConstLink()

HTMLframesConverter::getConstLink()

PDFdefaultConverter::getConstLink()

CHMdefaultConverter::getConstLink()

Parameters:

string	$expr	constant name
string	$class	class name
string	$package	package name
	$file
	$text

[ Top ]

method getConverterDir [line 5162]

string getConverterDir(
)

Get the absolute path to the converter's base directory

[ Top ]

method getCurrentPageLink [line 1115]

string getCurrentPageLink(
)

Tags:

return:	Link to the current page being parsed. Should return $curname and a converter-specific extension.
abstract:

Overridden in child classes as:

HTMLSmartyConverter::getCurrentPageLink()

HTMLframesConverter::getCurrentPageLink()

CHMdefaultConverter::getCurrentPageLink()

[ Top ]

method getCurrentPageURL [line 1095]

string getCurrentPageURL(
string
$pathinfo)

Return the path to the current

Parameters:

string

$pathinfo

[ Top ]

method getDefineLink [line 3227]

mixed getDefineLink(
string
$expr, string
$package, [
$file = false], [
$text = false])

return false or a defineLink to $expr

Tags:

return:	returns a defineLink or false if the element is not found in package $package
see:	defineLink

Overridden in child classes as:

XMLDocBookpeardoc2Converter::getDefineLink()

XMLDocBookConverter::getDefineLink()

HTMLSmartyConverter::getDefineLink()

HTMLframesConverter::getDefineLink()

PDFdefaultConverter::getDefineLink()

CHMdefaultConverter::getDefineLink()

Parameters:

string	$expr	constant name
string	$package	package name
	$file
	$text

[ Top ]

method getFileSourceName [line 1070]

string getFileSourceName(

$path, string
$pathinfo)

Translate the path info into a unique file name for the highlighted source code.

Overridden in child classes as:

PDFdefaultConverter::getFileSourceName()

Parameters:

string	$pathinfo
	$path

[ Top ]

method getFileSourcePath [line 1083]

string getFileSourcePath(
string
$base)

Return the fixed path to the source-code file folder.

Parameters:

string

$base

Path is relative to this folder

[ Top ]

method getFormattedConflicts [line 4694]

array getFormattedConflicts(
mixed
&$element, string
$type)

Tags:

return:	links to conflicting elements, or empty array
uses:	parserGlobal::getConflicts()
uses:	parserFunction::getConflicts()
uses:	parserDefine::getConflicts()
uses:	parserClass::getConflicts()

Parameters:

mixed	&$element	parserClass, parserFunction, parserDefine or parserGlobal
string	$type	type to display. either 'class','function','define' or 'global variable'

[ Top ]

method getFormattedDescMethods [line 4714]

array getFormattedDescMethods(
parserMethod
&$element)

Get a list of methods in child classes that override this method

Tags:

return:	empty array or array(array('link'=>link to method, 'sdesc'=>short description of the method),...)
uses:	parserMethod::getOverridingMethods()

Parameters:

parserMethod

&$element

[ Top ]

method getFormattedDescVars [line 4735]

array getFormattedDescVars(
parserVar
&$element)

Get a list of vars in child classes that override this var

Tags:

return:	empty array or array('link'=>link to var, 'sdesc'=>short description of the method
uses:	parserVar::getOverridingVars()

Parameters:

parserVar

&$element

[ Top ]

method getFormattedImplements [line 4657]

string getFormattedImplements(
parserClass
$el)

returns an array containing the class inheritance tree from the root object to the class.

This method must be overridden, or phpDocumentor will halt with a fatal error

Tags:

return:	Converter-specific class tree for an individual class
abstract:

Parameters:

parserClass

$el

class variable

[ Top ]

method getFormattedInheritedConsts [line 4999]

array getFormattedInheritedConsts(
parserConst
$child)

Return template-enabled list of inherited class constants

uses parserConst helper function getInheritedConsts and generates a template-enabled list using getClassLink()

Tags:

return:

Format:

 array(
   array('parent_class' => link to parent class's documentation,
         'ivars' =>
            array(
              array('name' => inherited constant name,
                    'link' => link to inherited constant's documentation,
                    'value' => constant value,
                    'sdesc' => summary of inherited constant),
              ...),
   ...)

see:

Converter::getClassLink(), parserMethod::getInheritedConsts()

Parameters:

parserConst

$child

class constant

[ Top ]

method getFormattedInheritedMethods [line 4911]

array getFormattedInheritedMethods(
parserMethod
$child)

Return template-enabled list of inherited methods

uses parserMethod helper function getInheritedMethods and generates a template-enabled list using getClassLink()

Tags:

return:

Format:

 array(
   array('parent_class' => link to parent class's documentation,
         'ivars' =>
            array(
              array('name' => inherited variable name,
                    'link' => link to inherited variable's documentation,
                    'function_call' => parserMethod::getIntricateFunctionCall()
                                       returned array,
                    'sdesc' => summary of inherited variable),
              ...),
   ...)

see:

Converter::getClassLink(), parserMethod::getInheritedMethods()

Parameters:

parserMethod

$child

class method

[ Top ]

method getFormattedInheritedVars [line 4840]

array getFormattedInheritedVars(
parserVar
$child)

Return template-enabled list of inherited variables

uses parserVar helper function getInheritedVars and generates a template-enabled list using getClassLink()

Tags:

return:

Format:

 array(
   array('parent_class' => link to parent class's documentation,
         'ivars' =>
            array(
              array('name' => inherited variable name,
                    'link' => link to inherited variable's documentation,
                    'default' => default value of inherited variable,
                    'sdesc' => summary of inherited variable),
              ...),
   ...)

see:

Converter::getClassLink(), parserVar::getInheritedVars()

Parameters:

parserVar

$child

class var

[ Top ]

method getFormattedMethodImplements [line 4773]

array|false getFormattedMethodImplements(
parserMethod
&$element)

Get the method this method(s) implemented from an interface, if any

Tags:

return:	array('link'=>link to implemented method, 'sdesc'=>short description
uses:	parserMethod::getImplements()

Parameters:

parserMethod

&$element

[ Top ]

method getFormattedOverrides [line 4756]

array|false getFormattedOverrides(
parserMethod
&$element)

Get the method this method overrides, if any

Tags:

return:	array('link'=>link to overridden method, 'sdesc'=>short description
see:	parserMethod::getOverrides()

Parameters:

parserMethod

&$element

[ Top ]

method getFunctionLink [line 3203]

mixed getFunctionLink(
string
$expr, string
$package, [
$file = false], [
$text = false])

return false or a functionLink to $expr

Tags:

return:	returns a functionLink or false if the element is not found in package $package
see:	functionLink

Overridden in child classes as:

XMLDocBookpeardoc2Converter::getFunctionLink()

XMLDocBookConverter::getFunctionLink()

HTMLSmartyConverter::getFunctionLink()

HTMLframesConverter::getFunctionLink()

PDFdefaultConverter::getFunctionLink()

CHMdefaultConverter::getFunctionLink()

Parameters:

string	$expr	function name
string	$package	package name
	$file
	$text

[ Top ]

method getGlobalLink [line 3251]

mixed getGlobalLink(
string
$expr, string
$package, [
$file = false], [
$text = false])

return false or a globalLink to $expr

Tags:

return:	returns a defineLink or false if the element is not found in package $package
see:	defineLink

Overridden in child classes as:

XMLDocBookpeardoc2Converter::getGlobalLink()

XMLDocBookConverter::getGlobalLink()

HTMLSmartyConverter::getGlobalLink()

HTMLframesConverter::getGlobalLink()

PDFdefaultConverter::getGlobalLink()

CHMdefaultConverter::getGlobalLink()

Parameters:

string	$expr	global variable name (with leading $)
string	$package	package name
	$file
	$text

[ Top ]

method getGlobalValue [line 5186]

string getGlobalValue(
string
$value)

Parse a global variable's default value for class initialization.

If a global variable's default value is "new class" as in:

$globalvar = new Parser

This method will document it not as "new Parser" but instead as "new Parser". For examples, see phpdoc.inc. Many global variables are classes, and phpDocumentor links to their documentation

Parameters:

string

$value

default value of a global variable.

[ Top ]

method getHighlightState [line 588]

void getHighlightState(
)

[ Top ]

method getId [line 3952]

string getId(
abstractLink
&$link)

take abstractLink descendant and text $eltext and return a

unique ID in the format needed for the Converter

Tags:

return:	unique identifier of $element
abstract:

Overridden in child classes as:

XMLDocBookpeardoc2Converter::getId(): Get the id value needed to allow linking

XMLDocBookConverter::getId(): Get the id value needed to allow linking

HTMLSmartyConverter::getId()

HTMLframesConverter::getId()

CHMdefaultConverter::getId()

Parameters:

abstractLink

&$link

[ Top ]

method getIncludeValue [line 5227]

string getIncludeValue(
string
$value, string
$ipath)

Parse an include's file to see if it is a file documented in this project

Although not very smart yet, this method will try to look for the included file file.ext:

include ("file.ext");

If it finds it, it will return a link to the file's documentation. As of 1.2.0rc1, phpDocumentor is smarty enough to find these cases:

absolute path to file
./file.ext or ../file.ext
relpath/to/file.ext if relpath is a subdirectory of the base parse directory

For examples, see Setup.inc.php includes. Every include auto-links to the documentation for the file that is included

Tags:

return:

included file with link to docs for file, if found

Parameters:

string	$value	file included by include statement.
string	$ipath	path of file that has the include statement

[ Top ]

method getLink [line 3565]

mixed &getLink(
string
$expr, [string
$package = false], [array
$packages = false])

The meat of the @see tag and inline {@link} tag

$expr is a string with many allowable formats:

proceduralpagename.ext
constant_name
classname::function()
classname::constantname
classname::$variablename
classname
object classname
function functionname()
global $globalvarname
packagename#expr where expr is any of the above

New in version 1.1, you can explicitly specify a package to link to that is different from the current package. Use the # operator to specify a new package, as in tests#bug-540368.php (which should appear as a link like: "bug-540368.php"). This example links to the procedural page bug-540368.php in package tests. Also, the "function" operator is now used to specifically link to a function instead of a method in the current class.

class myclass
{
// from inside the class definition, use "function conflict()" to refer to procedural function "conflict()"
function conflict()
{
}
}
function conflict()
{
}

If classname:: is not present, and the see tag is in a documentation block within a class, then the function uses the classname to search for $expr as a function or variable within classname, or any of its parent classes. given an $expr without '$', '::' or '()' getLink first searches for classes, procedural pages, constants, global variables, and then searches for methods and variables within the default class, and finally for any function

Tags:

return:	getLink returns a descendant of abstractLink if it finds a link, otherwise it returns a string
see:	pageLink, functionLink, defineLink, classLink, methodLink, varLink
see:	Converter::getPageLink(), Converter::getDefineLink(), Converter::getVarLink(), Converter::getFunctionLink(), Converter::getClassLink()

Overridden in child classes as:

XMLDocBookpeardoc2Converter::getLink(): do that stuff in $template_options

XMLDocBookConverter::getLink(): do that stuff in $template_options

Parameters:

string	$expr	expression to search for a link
string	$package	package to start searching in
array	$packages	list of all packages to search in

[ Top ]

method getMethodLink [line 3300]

mixed getMethodLink(
string
$expr, string
$class, string
$package, [
$file = false], [
$text = false])

return false or a methodLink to $expr in $class

Tags:

return:	returns a methodLink or false if the element is not found in package $package, class $class
see:	methodLink

Overridden in child classes as:

XMLDocBookpeardoc2Converter::getMethodLink()

XMLDocBookConverter::getMethodLink()

HTMLSmartyConverter::getMethodLink()

HTMLframesConverter::getMethodLink()

PDFdefaultConverter::getMethodLink()

CHMdefaultConverter::getMethodLink()

Parameters:

string	$expr	method name
string	$class	class name
string	$package	package name
	$file
	$text

[ Top ]

method getPageLink [line 3275]

mixed getPageLink(
string
$expr, string
$package, [
$path = false], [
$text = false], [
$packages = false])

return false or a pageLink to $expr

Tags:

return:	returns a pageLink or false if the element is not found in package $package
see:	pageLink

Overridden in child classes as:

XMLDocBookpeardoc2Converter::getPageLink()

XMLDocBookConverter::getPageLink()

HTMLSmartyConverter::getPageLink()

HTMLframesConverter::getPageLink()

PDFdefaultConverter::getPageLink()

CHMdefaultConverter::getPageLink()

Parameters:

string	$expr	procedural page name
string	$package	package name
	$path
	$text
	$packages

[ Top ]

method getSortedClassTreeFromClass [line 2954]

array getSortedClassTreeFromClass(
string
$class, string
$package, string
$subpackage)

Return a tree of all classes that extend this class

The data structure returned is designed for a non-recursive algorithm, and is somewhat complex. In most cases, the array returned is:

 array('#root' =>
         array('link' => classLink to $class,
               'parent' => false,
               'children' => array(array('class' => 'childclass1',
                                         'package' => 'child1package'),
                                    array('class' => 'childclass2',
                                         'package' => 'child2package'),...
                                  )
               ),
       'child1package#childclass1' =>
         array('link' => classLink to childclass1,
               'parent' => '#root',
               'children' => array(array('class' => 'kidclass',
                                         'package' => 'kidpackage'),...
                                  )
              ),
       'kidpackage#kidclass' =>
         array('link' => classLink to kidclass,
               'parent' => 'child1package#childclass1',
               'children' => array() // no children
              ),
      ....
      )

To describe this format using language, every class in the tree has an entry in the first level of the array. The index for all child classes that extend the root class is childpackage#childclassname. Each entry in the array has 3 elements: link, parent, and children.

link - a classLink to the current class
parent - a classLink to the class's parent, or false (except for one special case described below)
children - an array of arrays, each entry has a 'class' and 'package' index to the child class, used to find the entry in the big array

special cases are when the #root class has a parent in another package, or when the #root class extends a class not found by phpDocumentor. In the first case, parent will be a classLink to the parent class. In the second, parent will be the extends clause, as in:

class X extends Y
{
...
}

in this case, the #root entry will be array('link' => classLink to X, 'parent' => 'Y', children => array(...))

The fastest way to design a method to process the array returned is to copy HTMLframesConverter::getRootTree() into your converter and to modify the html to whatever output format you are going to use

Tags:

return:	Format: see docs
see:	HTMLframesConverter::getRootTree()

Parameters:

string	$class	class name
string	$package
string	$subpackage

[ Top ]

method getSourceLink [line 1105]

string getSourceLink(

$path)

Tags:

return:	an output-format dependent link to phpxref-style highlighted source code
abstract:
usedby:	parserFileSourceTag::getSourceLink()

Overridden in child classes as:

HTMLSmartyConverter::getSourceLink()

HTMLframesConverter::getSourceLink()

PDFdefaultConverter::getSourceLink()

CHMdefaultConverter::getSourceLink()

Parameters:

$path

[ Top ]

method getState [line 5355]

void getState(
)

Return parserStringWithInlineTags::Convert() cache state

Tags:

see:	parserStringWithInlineTags::Convert()
abstract:

Overridden in child classes as:

PDFdefaultConverter::getState()

[ Top ]

method getTutorialId [line 1418]

string getTutorialId(

$package, 
$subpackage, 
$tutorial, 
$id)

Return a converter-specific id to distinguish tutorials and their sections

Used by {@id}

Tags:

usedby:	parserTocInlineTag::Convert() - retrieve the tutorial ID for
usedby:	parserIdInlineTag::Convert() - retrieve converter-specific ID

Overridden in child classes as:

XMLDocBookpeardoc2Converter::getTutorialId()

XMLDocBookConverter::getTutorialId()

HTMLSmartyConverter::getTutorialId()

HTMLframesConverter::getTutorialId()

PDFdefaultConverter::getTutorialId()

CHMdefaultConverter::getTutorialId()

Parameters:

	$package
	$subpackage
	$tutorial
	$id

[ Top ]

method getTutorialLink [line 3417]

tutorialLink|string getTutorialLink(
string
$expr, [string
$package = false], [string
$subpackage = false], [array
$packages = false])

The meat of the @tutorial tag and inline {@tutorial} tag

Take a string and return an abstract link to the tutorial it represents. Since tutorial naming literally works like the underlying filesystem, the way to reference the tutorial is similar. Tutorials are located in a subdirectory of any directory parsed, which is named 'tutorials/' (we try to make things simple when we can :). They are further organized by package and subpackage as:

tutorials/package/subpackage

and the files are named *.cls, *.pkg, or *.proc, and so a link to a tutorial named file.cls can be referenced (depending on context) as any of:

* @tutorial package/subpackage/file.cls
* @tutorial package/file.cls
* @tutorial file.cls

The first case will only be needed if file.cls exists in both the current package, in anotherpackage/file.cls and in anotherpackage/subpackage/file.cls and you wish to reference the one in anotherpackage/subpackage. The second case is only needed if you wish to reference file.cls in another package and it is unique in that package. the third will link to the first file.cls it finds using this search method:

current package/subpackage
all other subpackages of current package
parent package, if this package has classes that extend classes in another package
all other packages

Tags:

return:	returns either a link, or the original text, if not found
since:	1.2

Parameters:

string	$expr	the original expression
string	$package	package to look in first
string	$subpackage	subpackage to look in first
array	$packages	array of package names to search in if not found in parent packages. This is used to limit the search, phpDocumentor automatically searches all packages

[ Top ]

method getTutorialTree [line 1974]

array getTutorialTree(
parserTutorial|array
$tutorial)

Get a tree structure representing the hierarchy of tutorials

Returns an array in format:

 array('tutorial' => parserTutorial,
       'kids' => array( // child tutorials
                   array('tutorial' => child parserTutorial,
                         'kids' => array(...)
                        )
                      )
      )

Parameters:

parserTutorial|array

$tutorial

[ Top ]

method getVarLink [line 3327]

mixed getVarLink(
string
$expr, string
$class, string
$package, [
$file = false], [
$text = false])

return false or a varLink to $expr in $class

Tags:

return:	returns a varLink or false if the element is not found in package $package, class $class
see:	varLink

Overridden in child classes as:

XMLDocBookpeardoc2Converter::getVarLink()

XMLDocBookConverter::getVarLink()

HTMLSmartyConverter::getVarLink()

HTMLframesConverter::getVarLink()

PDFdefaultConverter::getVarLink()

CHMdefaultConverter::getVarLink()

Parameters:

string	$expr	var name
string	$class	class name
string	$package	package name
	$file
	$text

[ Top ]

method hasSourceCode [line 1159]

boolean hasSourceCode(
string
$path)

Determine whether an element's file has generated source code, used for linking to line numbers of source.

Wrapper for $sourcePaths in this version

Parameters:

string

$path

full path to the source code file

[ Top ]

method hasTutorial [line 490]

false|parserTutorial hasTutorial(
pkg|cls|proc
$type, tutorial
$name, string
$package, [string
$subpackage = ''])

Tags:

return:

if the tutorial exists, return it

Parameters:

pkg\|cls\|proc	$type	the tutorial type to search for
tutorial	$name	name
string	$package	package name
string	$subpackage	subpackage name, if any

[ Top ]

method highlightDocBlockSource [line 690]

string highlightDocBlockSource(
string
$token, string
$word, [boolean
$preformatted = false])

Used to allow converters to format the source code of DocBlocks the way they'd like.

default returns it unchanged. Mainly used by the HighlightParser

Parameters:

string	$token	name of docblock token type
string	$word	contents of token
boolean	$preformatted	whether the contents are preformatted or need modification

[ Top ]

method highlightSource [line 637]

string highlightSource(
integer
$token, string
$word, [boolean
$preformatted = false])

Used to allow converters to format the source code the way they'd like.

default returns it unchanged. Mainly used by the HighlightParser

Parameters:

integer	$token	token value from tokenizer constants
string	$word	contents of token
boolean	$preformatted	whether the contents are preformatted or need modification

[ Top ]

method highlightTutorialSource [line 728]

string highlightTutorialSource(
string
$token, string
$word, [boolean
$preformatted = false])

Used to allow converters to format the source code of Tutorial XML the way they'd like.

default returns it unchanged. Mainly used by the HighlightParser

Parameters:

string	$token	name of docblock token type
string	$word	contents of token
boolean	$preformatted	whether the contents are preformatted or need modification

[ Top ]

method Italicize [line 945]

string Italicize(
string
$para)

Used to convert the contents of <i> in a docblock

Tags:

usedby:

parserI::Convert()

Parameters:

string

$para

[ Top ]

method Kbdize [line 973]

string Kbdize(
string
$para)

Used to convert the contents of <kbd> in a docblock

Tags:

usedby:

parserKbd::Convert()

Parameters:

string

$para

[ Top ]

method ListItem [line 874]

string ListItem(
string
$item)

Used to convert the contents of <li> in a docblock

Tags:

usedby:

parserList::Convert() - enclose each item of the list

Parameters:

string

$item

[ Top ]

method newSmarty [line 5051]

Smarty &newSmarty(
)

Return a Smarty template object to operate with

This returns a Smarty template with pre-initialized variables for use. If the method "SmartyInit()" exists, it is called.

[ Top ]

method Output [line 5112]

void Output(

$title)

do all necessary output

Tags:

see:	Converter
abstract:
usedby:	phpDocumentor_IntermediateParser::Convert()

Overridden in child classes as:

XMLDocBookpeardoc2Converter::Output(): Generate the constants.xml, packagename.xml, and globals.xml files

XMLDocBookConverter::Output(): This function is not used by HTMLdefaultConverter, but is required by Converter

HTMLSmartyConverter::Output(): This function is not used by HTMLdefaultConverter, but is required by Converter

HTMLframesConverter::Output(): This function is not used by HTMLdefaultConverter, but is required by Converter

PDFdefaultConverter::Output(): calls Cezpdf::ezOutput() and writes documentation.pdf to targetDir

CHMdefaultConverter::Output(): Create the phpdoc.hhp, contents.hhc files needed by MS HTML Help Compiler to create a CHM file

Parameters:

$title

[ Top ]

method postProcess [line 1016]

string postProcess(

$text)

This version does nothing

Perform necessary post-processing of string data. For example, the HTML Converters should escape < and > to become < and >

Tags:

usedby:	Converter::convertDefine() - on define_value template value, makes it displayable
usedby:	Converter::convertGlobal() - on global_value template value, makes it displayable

Overridden in child classes as:

XMLDocBookpeardoc2Converter::postProcess()

XMLDocBookConverter::postProcess()

HTMLSmartyConverter::postProcess(): Uses htmlspecialchars() on the input

HTMLframesConverter::postProcess(): Uses htmlspecialchars() on the input

PDFdefaultConverter::postProcess()

CHMdefaultConverter::postProcess(): Uses htmlspecialchars() on the input

Parameters:

$text

[ Top ]

method prepareDocBlock [line 4456]

array prepareDocBlock(
mixed
&$element, [array
$names = array()], [boolean
$nopackage = true])

convert the element's DocBlock for output

This function converts all tags and descriptions for output

Tags:

return:

Format:

 array('sdesc' => DocBlock summary
       'desc' => DocBlock detailed description
       'tags' => array('keyword' => tagname, 'data' => tag description)
                 known tags
       'api_tags' => array('keyword' => tagname, 'data' => tag description)
                 known api documentation tags
       'info_tags' => array('keyword' => tagname, 'data' => tag description)
                 known informational tags
     [ 'utags' => array('keyword' => tagname, 'data' => tag description
                 unknown tags ]
     [ 'vartype' => type from @var/@return tag ]
     [ 'var_descrip' => description from @var/@return tag ]
      )

Overridden in child classes as:

XMLDocBookpeardoc2Converter::prepareDocBlock()

XMLDocBookConverter::prepareDocBlock()

Parameters:

mixed	&$element	any descendant of parserElement, or parserData
array	$names	used to translate tagnames into other tags
boolean	$nopackage	set to false for pages and classes, the only elements allowed to specify @package

[ Top ]

method PreserveWhiteSpace [line 903]

string PreserveWhiteSpace(
string
$string)

Used to convert the contents of <pre> in a docblock

Tags:

usedby:

parserPre::Convert()

Parameters:

string

$string

[ Top ]

method ProgramExample [line 785]

string ProgramExample(
string
$example, [boolean
$tutorial = false], [
$inlinesourceparse = null], [
$class = null], [
$linenum = null], [
$filesourcepath = null])

Used to convert the <code> tag in a docblock

Parameters:

string	$example
boolean	$tutorial	true if this is to highlight a tutorial <programlisting>
	$inlinesourceparse
	$class
	$linenum
	$filesourcepath

[ Top ]

method returnLink [line 3929]

string returnLink(
string
$link, string
$text)

take URL $link and text $text and return a link in the format needed for the Converter

Tags:

return:	link to $link
abstract:

Overridden in child classes as:

XMLDocBookpeardoc2Converter::returnLink()

XMLDocBookConverter::returnLink()

HTMLSmartyConverter::returnLink()

HTMLframesConverter::returnLink()

PDFdefaultConverter::returnLink()

CHMdefaultConverter::returnLink()

Parameters:

string	$link	URL
string	$text	text to display

[ Top ]

method returnSee [line 3941]

string returnSee(
abstractLink
&$link, [string
$eltext = false])

take abstractLink descendant and text $eltext and return a link

in the format needed for the Converter

Tags:

return:	link to $element
abstract:

Overridden in child classes as:

XMLDocBookpeardoc2Converter::returnSee(): This function takes an abstractLink descendant and returns an html link

XMLDocBookConverter::returnSee(): This function takes an abstractLink descendant and returns an html link

HTMLSmartyConverter::returnSee(): This function takes an abstractLink descendant and returns an html link

HTMLframesConverter::returnSee(): This function takes an abstractLink descendant and returns an html link

PDFdefaultConverter::returnSee(): Returns a bookmark using Cezpdf 009

CHMdefaultConverter::returnSee(): This function takes an abstractLink descendant and returns an html link

Parameters:

abstractLink	&$link
string	$eltext

[ Top ]

method Sampize [line 987]

string Sampize(
string
$para)

Used to convert the contents of <samp> in a docblock

Tags:

usedby:

parserSamp::Convert()

Parameters:

string

$para

[ Top ]

method setSourcePaths [line 1174]

void setSourcePaths(
string
$path)

Mark a file as having had source code highlighted

Parameters:

string

$path

full path of source file

[ Top ]

method setTargetDir [line 5285]

void setTargetDir(
string
$dir)

Sets the output directory for generated documentation

As of 1.3.0RC6, this also sets the compiled templates directory inside the target directory

Overridden in child classes as:

XMLDocBookConverter::setTargetDir(): calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied

HTMLSmartyConverter::setTargetDir(): calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied

HTMLframesConverter::setTargetDir(): calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied

CHMdefaultConverter::setTargetDir(): calls the converter setTargetDir, and then copies any template images and the stylesheet if they haven't been copied

Parameters:

string

$dir

the output directory

[ Top ]

method setTemplateBase [line 5123]

void setTemplateBase(
string
$base, string
$dir)

Set the template directory with a different template base directory

Tags:

tutorial:

phpDocumentor Tutorial

Parameters:

string	$base	template base directory
string	$dir	template name

[ Top ]

method setTemplateDir [line 5148]

void setTemplateDir(
string
$dir)

sets the template directory based on the $outputformat and $name

Also sets $templateName to the $dir parameter

Overridden in child classes as:

XMLDocBookpeardoc2Converter::setTemplateDir()

XMLDocBookConverter::setTemplateDir()

PDFdefaultConverter::setTemplateDir()

CHMdefaultConverter::setTemplateDir()

Parameters:

string

$dir

subdirectory

[ Top ]

method sortPageContentsByElementType [line 2570]

void sortPageContentsByElementType(

&$pages)

sorts $page_contents by element type as well as alphabetically

Tags:

see:

$sort_page_contents_by_element_type

Parameters:

&$pages

[ Top ]

method sourceLine [line 1130]

string sourceLine(
integer
$linenumber, string
$line, [false|string
$path = false])

Return a line of highlighted source code with formatted line number

If the $path is a full path, then an anchor to the line number will be added as well

Parameters:

integer	$linenumber	line number
string	$line	highlighted source code line
false\|string	$path	full path to @filesource file this line is a part of, if this is a single line from a complete file.

[ Top ]

method startHighlight [line 582]

void startHighlight(
)

Initialize highlight caching

[ Top ]

method TranslateEntity [line 1184]

void TranslateEntity(
string
$name)

Used to translate an XML DocBook entity like ” from a tutorial by reading the options.ini file for the template.

Tags:

usedby:

parserEntity::Convert() - convert contents to text

Parameters:

string

$name

entity name

[ Top ]

method TranslateTag [line 1214]

string TranslateTag(
string
$name, string
$attr, string
$cdata, string
$unconvertedcdata)

Used to translate an XML DocBook tag from a tutorial by reading the options.ini file for the template.

Parameters:

string	$name	tag name
string	$attr	any attributes Format: array(name => value)
string	$cdata	the tag contents, if any
string	$unconvertedcdata	the tag contents, if any, unpost-processed

[ Top ]

method TutorialExample [line 860]

void TutorialExample(
string
$example)

Overridden in child classes as:

HTMLSmartyConverter::TutorialExample()

HTMLframesConverter::TutorialExample()

CHMdefaultConverter::TutorialExample()

Parameters:

string

$example

[ Top ]

method type_adjust [line 759]

string type_adjust(
string
$typename)

Called by parserReturnTag::Convert() to allow converters to change type names to desired formatting

Used by XMLDocBookConverter::type_adjust() to change true and false to the peardoc2 values

Overridden in child classes as:

XMLDocBookpeardoc2Converter::type_adjust()

XMLDocBookConverter::type_adjust()

Parameters:

string

$typename

[ Top ]

method unmangle [line 574]

string unmangle(
string
$sourcecode)

Called by parserSourceInlineTag::stringConvert() to allow converters to format the source code the way they'd like.

default returns it unchanged (html with xhtml tags)

Tags:

deprecated:	in favor of tokenizer-based highlighting. This will be removed for 2.0
usedby:	parserSourceInlineTag::stringConvert() - remove the extraneous stuff from http://www.php.net/highlight_string

Overridden in child classes as:

XMLDocBookpeardoc2Converter::unmangle()

XMLDocBookConverter::unmangle()

HTMLSmartyConverter::unmangle()

HTMLframesConverter::unmangle()

PDFdefaultConverter::unmangle()

CHMdefaultConverter::unmangle()

Parameters:

string

$sourcecode

output from highlight_string() - use this function to reformat the returned data for Converter-specific output

[ Top ]

method vardump_tree [line 2202]

string vardump_tree(

$tree, [
$indent = ''])

Debugging function for dumping $tutorial_tree

Parameters:

	$tree
	$indent

[ Top ]

method Varize [line 959]

string Varize(
string
$para)

Used to convert the contents of <var> in a docblock

Tags:

usedby:

parserDescVar::Convert()

Parameters:

string

$para

[ Top ]

method walk [line 1705]

void walk(
array
&$pages, array
&$package_pages)

called by phpDocumentor_IntermediateParser::Convert() to traverse the array of pages and their elements, converting them to the output format

The walk() method should be flexible enough such that it never needs modification. walk() sets up all of the indexes, and sorts everything in logical alphabetical order. It then passes each element individually to Convert(), which then passes to the Convert*() methods. A child Converter need not override any of these unless special functionality must be added. see Converter Default Template Variables for details. {@ and the left indexes specified by $leftindexes, and then sorts them by calling sortIndexes().

Next, it converts all README/CHANGELOG/INSTALL-style files, using Convert_RIC.

After this, it passes all package-level docs to Convert(). Then, it calls the index sorting functions formatPkgIndex(), formatIndex() and formatLeftIndex().

Finally, it converts each procedural page in alphabetical order. This stage passes elements from the physical file to Convert() in alphabetical order. First, procedural page elements parserDefine, parserInclude parserGlobal, and parserFunction are passed to Convert().

Then, class elements are passed in this order: parserClass, then all of the parserVars in the class and all of the parserMethods in the class. Classes are in alphabetical order, and both vars and methods are in alphabetical order.

Finally, ConvertErrorLog() is called and the data walk is complete.}}

Tags:

usedby:	phpDocumentor_IntermediateParser::Convert() - passes $pages and $package_pages
uses:	Converter::_createPkgElements() - sets up $elements and $pkg_elements array, as well as $links

Parameters:

array	&$pages	Format: array(fullpath => parserData structure with full parserData::$elements and parserData::$class_elements.
array	&$package_pages	Format: array(parserPackagePage 1, parserPackagePage 2,...)

[ Top ]

method walk_everything [line 2267]

void walk_everything(
)

walk over elements by package rather than page

This method is designed for converters like the PDF converter that need everything passed in alphabetical order by package/subpackage and by procedural and then class information

Tags:

see:	Converter::walk()
see:	PDFdefaultConverter

[ Top ]

method writeExample [line 1060]

void writeExample(
string
$title, string
$path, string
$source)

Write out the formatted source code for an example php file

This function provides the primary functionality for the @example tag.

Parameters:

string	$title	example title
string	$path	example filename (no path)
string	$source	fully highlighted/linked source code of the file

[ Top ]

method writeFile [line 5318]

void writeFile(
string
$file, string
$data, [boolean
$binary = false])

Writes a file to target dir

Overridden in child classes as:

XMLDocBookpeardoc2Converter::writeFile(): Writes a file to target dir, beautify any .xml files first

Parameters:

string	$file
string	$data
boolean	$binary	true if the data is binary and not text

[ Top ]

method writeSource [line 1044]

void writeSource(
string
$filepath, string
$source)

Write out the formatted source code for a php file

This function provides the primary functionality for the @filesource tag.

Tags:

abstract:
usedby:	parserFileSourceTag::writeSource() - export highlighted file source

Overridden in child classes as:

XMLDocBookpeardoc2Converter::writeSource(): Does nothing

HTMLSmartyConverter::writeSource()

HTMLframesConverter::writeSource()

PDFdefaultConverter::writeSource()

CHMdefaultConverter::writeSource()

Parameters:

string	$filepath	full path to the file
string	$source	fully highlighted/linked source code of the file

[ Top ]

method _rmdir [line 5089]

void _rmdir(
string
$directory)

Completely remove a directory and its contents

Parameters:

string

$directory

[ Top ]

method _setHighlightCache [line 593]

void _setHighlightCache(

$type, 
$token)

Parameters:

	$type
	$token

[ Top ]

method _tutorial_path [line 2081]

string _tutorial_path(
parserTutorial
$pkg, [parserTutorial
$subpkg = 0], [parserTutorial
$namepkg = 0])

Returns the path to this tutorial as a string

Parameters:

parserTutorial	$pkg
parserTutorial	$subpkg
parserTutorial	$namepkg

[ Top ]

PHP5

Для web разработчика

Dec 22Docs For Class Converter

Class: Converter

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$all_packages =

Tags:

$class = false

$classes =

$class_contents = array()

Tags:

$class_data =

$class_elements = array()

Tags:

$curfile =

$curpage =

$define_elements = array()

Tags:

$elements = array()

Tags:

$function_elements = array()

Tags:

$global_elements = array()

Tags:

$highlightingSource = false

$leftindex = array('classes' => true, 'pages' => true, 'functions' => true, 'defines' => true, 'globals' => true)

Tags:

$outputformat = 'Generic'

Tags:

$package = 'default'

$packagecategories =

Tags:

$package_elements = array()

Tags:

$package_output =

Tags:

$package_parents =

Tags:

$page =

$page_contents = array()

Tags:

$page_data =

$page_elements = array()

Tags:

$parseprivate =

$path =

$pkg_elements = array()

Tags:

$processSpecialRoots = false

$quietmode =

$smarty_dir = ''

$sort_absolutely_everything = false

Tags:

$sort_page_contents_by_type = false

Tags:

$sourcePaths = array()

$subpackage = ''

$targetDir = ''

Tags:

$templateDir = ''

$templateName = ''

Tags:

$template_options =

Tags:

$title = 'Generated Documentation'

Tags:

$todoList = array()

Tags:

Class Methods

constructor Converter [line 452]

Parameters:

method AttrToString [line 1307]

Dec 22
Docs For Class Converter