PHPDOC 2000/12/03 - PHPDoc

PhpdocHTMLDocumentRenderer

PhpdocObject
   |
  +-- PhpdocRendererObject
     |
    +-- PhpdocHTMLRenderer
       |
      +-- PhpdocHTMLDocumentRenderer

Provides functioninality to render modules and classes.

private class PhpdocHTMLDocumentRenderer extends PhpdocHTMLRenderer

Provides functioninality to render modules and classes.

Authors Ulf Wendel <ulf.wendel@phpdoc.de>

Version $Id: $

Direct known subclasses: PhpdocHTMLClassRenderer, PhpdocHTMLModuleRenderer

Methods inherited from PhpdocHTMLRenderer

setpath, settemplateroot, encode

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Private Method Summary
void	renderConstants() Adds a summary and a detailed list of all constants to the template.
void	renderConstantSummary() Adds a summary of all constants to the template.
void	renderConstantDetail() Adds a detailed list of all constants to the template.
void	renderUses() Adds a summary and a detailed list of included files to the template.
void	renderUsesDetail() Adds a detailed list of all included files to the template.
void	renderUsesSummary() Adds a summary of all included files to the template.
void	renderFunctions() Adds a summary and a detailed list of all functions to the template.
void	renderFunctionSummary() Adds a function summary to the template.
void	renderFunctionDetail() Adds a detailed list of functions to the template.
void	renderParameterDetail(array $parameter) Renders a detailed list of function parameters.
string	getParameter(array $parameter) Converts the XML parameter array into formatted string.
void	renderSee(array $references, [ string $prefix ]) Renders a block with references to other source elements.
void	renderAuthors(array $authors, [ string $prefix ]) Renders an author list.
void	renderLinks(array $links, [ string $prefix ]) Renders a list of external links.
void	renderThrows(array $throws, [ string $prefix ]) Renders a list of exceptions.
void	renderGlobals(array $globals, [ string $prefix ]) Renders a list of global elements.
void	renderCommonDocfields(string $block, array &$data) Adds some tags to the template that are allowed nearly everywhere.

Public Field Summary
string	$undocumented Message displayed if an object lacks documentation.

Private Field Summary
array	$functions Array of functions found in the xml document.
array	$uses Array of included files.
array	$constants Array of constants.
array	$accessModifiers Array of access modifiers.
array	$simpleDocfields Array of doc container fields that get mapped directly to templateblocks.
array	$usesTypes Types of include statements.

Private Method Details

renderConstants

private void renderConstants( )

Adds a summary and a detailed list of all constants to the template.

Returns

void

See Also renderConstantSummary(), renderConstantDetail()

renderConstantSummary

private void renderConstantSummary( )

Adds a summary of all constants to the template.
The function assumes that there is a block called "constantssummary" andwithing this block a bock called "constantssummary_loop" in the template.

Returns

void

renderConstantDetail

private void renderConstantDetail( )

Adds a detailed list of all constants to the template.
The function assumes that there is a block named "constantdetails" andwithing it another block named "constantdetails_loop".

Returns

void

renderUses

private void renderUses( )

Adds a summary and a detailed list of included files to the template.

Returns

void

See Also renderUsesSummary(), renderUsesDetail()

renderUsesDetail

private void renderUsesDetail( )

Adds a detailed list of all included files to the template.
The function assumes that there is a block names "usesdetail" and within the blocka block names "usesdetail_loop" in the template.

Returns

void

renderUsesSummary

private void renderUsesSummary( )

Adds a summary of all included files to the template.
The function assumes that there is a block names "usessummary" and withinthe block another block names "usessummary_loop" in the template.

Returns

void

renderFunctions

private void renderFunctions( )

Adds a summary and a detailed list of all functions to the template.

Returns

void

See Also renderFunctionSummary(), renderFunctionDetail(), $functions

renderFunctionSummary

private void renderFunctionSummary( )

Adds a function summary to the template.
The function assumes that there is ablock names "functionsummary" andwithin it a block names "functionsummary_loop" in the template.

Returns

void

See Also renderFunctionDetail(), renderFunctions(), $functions, $accessModifiers

renderFunctionDetail

private void renderFunctionDetail( )

Adds a detailed list of functions to the template.
The function assumes that there is a block named "functiondetails" andwithin it a bloc "functiondetails_loop" in the template.

Returns

void

See Also renderFunctions(), renderFunctionSummary(), $functions, $accessModifiers

renderParameterDetail

private void renderParameterDetail( array $parameter )

Renders a detailed list of function parameters.
The function assumes that there is a block named "functiondetails_parameter" inthe template and within it a block named "functiondetails_parameter_loop".

Parameter

array	$parameter

Returns

void

getParameter

private string getParameter( array $parameter )

Converts the XML parameter array into formatted string.

Parameter

array	$parameter
	parameter array

Returns

string

Formatted parameter string

renderSee

private void renderSee( array $references, [ string $prefix ] )

Renders a block with references to other source elements.

Parameter

array	$references
	references array

string	$prefix	`= >>""<<`
	template blockname prefix

Returns

void

renderAuthors

private void renderAuthors( array $authors, [ string $prefix ] )

Renders an author list.

Parameter

array	$authors
	author array

string	$prefix	`= >>""<<`
	template blockname prefix

Returns

void

renderLinks

private void renderLinks( array $links, [ string $prefix ] )

Renders a list of external links.

Parameter

array	$links
	link array

string	$prefix	`= >>""<<`
	template blockname prefix

Returns

void

renderThrows

private void renderThrows( array $throws, [ string $prefix ] )

Renders a list of exceptions.

Parameter

array	$throws
	array

string	$prefix	`= >>""<<`
	template blockname prefix

Returns

void

renderGlobals

private void renderGlobals( array $globals, [ string $prefix ] )

Renders a list of global elements.

Parameter

array	$globals
	globals array

string	$prefix	`= >>""<<`
	template blockname prefix

Returns

void

renderCommonDocfields

private void renderCommonDocfields( string $block, array &$data )

Adds some tags to the template that are allowed nearly everywhere.

Parameter

string	$block
	blockname prefixs

array	&$data

Returns

void

See Also $simpleDocfields, renderLinks(), renderAuthors(), renderSee()

Public Field Details
$undocumented
public string $undocumented >>`"Warning: documentation is missing."`<< Message displayed if an object lacks documentation.

Private Field Details
$functions
private array $functions >>`array()`<< Array of functions found in the xml document.

$uses
private array $uses >>`array()`<< Array of included files.

$constants
private array $constants >>`array()`<< Array of constants.

$accessModifiers
private array $accessModifiers >>`array("public", "private")`<< Array of access modifiers.

$simpleDocfields
private array $simpleDocfields >>`array( "VERSION" => "version", "SINCE" => "since", "DEPRECATED" => "deprecated", "COPYRIGHT" => "copyright", "MAGIC" => "magic" )`<< Array of doc container fields that get mapped directly to templateblocks.

$usesTypes
private array $usesTypes >>`array( "include", "include_once", "require", "require_once" )`<< Types of include statements.
See Also	renderUses()

PHPDoc 1.0beta

PHPDOC 2000/12/03 - PHPDoc

PhpdocHTMLDocumentRenderer

private class PhpdocHTMLDocumentRenderer extends PhpdocHTMLRenderer

Methods inherited from PhpdocHTMLRenderer

Methods inherited from PhpdocObject

Private Method Summary

renderConstants()

renderConstantSummary()

renderConstantDetail()

renderUses()

renderUsesDetail()

renderUsesSummary()

renderFunctions()

renderFunctionSummary()

renderFunctionDetail()

renderParameterDetail(array $parameter)

getParameter(array $parameter)

renderSee(array $references, [ string $prefix ])

renderAuthors(array $authors, [ string $prefix ])

renderLinks(array $links, [ string $prefix ])

renderThrows(array $throws, [ string $prefix ])

renderGlobals(array $globals, [ string $prefix ])

renderCommonDocfields(string $block, array &$data)

Fields inherited from PhpdocHTMLRenderer

Fields inherited from PhpdocRendererObject

Fields inherited from PhpdocObject

Public Field Summary

$undocumented

Private Field Summary

$functions

$uses

$constants

$accessModifiers

$simpleDocfields

$usesTypes

Private Method Details

renderConstants

renderConstantSummary

renderConstantDetail

renderUses

renderUsesDetail

renderUsesSummary

renderFunctions

renderFunctionSummary

renderFunctionDetail

renderParameterDetail

getParameter

renderSee

renderAuthors

renderLinks

renderThrows

renderGlobals

renderCommonDocfields

Public Field Details

$undocumented

Private Field Details

$functions

$uses

$constants

$accessModifiers

$simpleDocfields

$usesTypes