Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/renderer/html/PhpdocHTMLDocumentRenderer.php
PEAR Repository - 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.

AuthorsUlf Wendel <ulf.wendel@phpdoc.de>
Version1.0beta

 
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, @see.
void

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

Renders an author list, @author.
void

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

Renders a list of external links, @link.
void

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

Renders a list of exceptions, @throws.
void

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

Renders a list of global elements, @global
void

renderCommonDocfields(string $block, &$data)

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

Fields inherited from PhpdocHTMLRenderer

$tpl, $accessor, $templateroot, $path

Fields inherited from PhpdocRendererObject

$file_extension, $warn, $accessor

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Public Field Summary

string

$undocmented

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

Known types for @include.

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" and
withing this block a bock called "constantssummary_loop" in the template.

Returns void

See Also renderConstantDetail()

renderConstantDetail

private void renderConstantDetail( )

  Adds a detailed list of all constants to the template.

The function assumes that there is a block named "constantdetails" and
withing it another block named "constantdetails_loop".

Returns void

See Also renderConstantSummary()

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

Returns void

See Also renderUsesSummary()

renderUsesSummary

private void renderUsesSummary( )

  Adds a summary of all

Returns void

See Also renderUsesDetail()

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" and
within 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" and
within 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" in
the template and within it a block named "functiondetails_parameter_loop".

Parameter
array $parameter
Parameter
Returns void


getParameter

private string getParameter( array $parameter )

  Converts the XML parameter array into formatted string.

Parameter
array $parameter
XML 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
XML references array
string $prefix = >>""<<
optional template blockname prefix
Returns void

See Also .::.

renderAuthors

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

  Renders an author list,

Parameter
array $authors
XML author array
string $prefix = >>""<<
optional template blockname prefix
Returns void

Author(s)

renderLinks

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

  Renders a list of external links,

Parameter
array $links
XML link array
string $prefix = >>""<<
optional template blockname prefix
Returns void

Links

renderThrows

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

  Renders a list of exceptions,

Parameter
array $throws
XML array
string $prefix = >>""<<
optional template blockname prefix
Returns void

Throws .

renderGlobals

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

  Renders a list of global elements,

Parameter
array $globals
XML globals array
string $prefix = >>""<<
optional template blockname prefix
Returns void


renderCommonDocfields

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

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

Parameter
string $block
template blockname prefixs
&$data
Returns void

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

Public Field Details

$undocmented

public string $undocmented

>>"Warning: documentation is missing."<<


Private Field Details

$functions

private array $functions

>>array()<<


$uses

private array $uses

>>array()<<


$constants

private array $constants

>>array()<<


$accessModifiers

private array $accessModifiers

>>array("public", "private")<<


$simpleDocfields

private array $simpleDocfields

>>array( "VERSION" => "version", "SINCE" => "since", "DEPRECATED" => "deprecated", "COPYRIGHT" => "copyright", "MAGIC" => "magic" )<<

See Also renderVariableDetail()

$usesTypes

private array $usesTypes

>>array( "include", "include_once", "require", "require_once" )<<

See Also renderUses()


Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta