Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/renderer/html/PhpdocHTMLClassRenderer.php
PEAR Repository - PHPDoc

PhpdocHTMLClassRenderer

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

Renders classes.

 

private class PhpdocHTMLClassRenderer extends PhpdocHTMLDocumentRenderer

Renders classes.

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

 

Methods inherited from PhpdocHTMLDocumentRenderer

renderconstants, renderconstantsummary, renderconstantdetail, renderuses, renderusesdetail, renderusessummary, renderfunctions, renderfunctionsummary, renderfunctiondetail, renderparameterdetail, getparameter, rendersee, renderauthors, renderlinks, renderthrows, renderglobals, rendercommondocfields

Methods inherited from PhpdocHTMLRenderer

setpath, settemplateroot, encode

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

void

PhpdocHTMLClassRenderer(string $path, string $templateRoot, string $application, string $extension)

Sets the xml and template root directory.
void

renderClass(string $xmlfile, [ string $htmlfile ])

Renders a class

Private Method Summary

void

renderInherited()

Renders a list of inherited elements.
void

renderInheritedElements( $inherited, $block, $type)

Renders a list of a certain inherited element.
void

renderSubclasses()

Renders a list of direct known subclasses.
void

renderVariables()

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

renderVariableSummary()

Adds a summary of all variables to the template.
void

renderVariableDetail()

Adds a detailed list of all variables to the template.
string

getClasstree(string $class)

Returns a html string that shows the class tree.
string

getIndent(int $level)

Returns a certain number of "&nbsp;"s.

Fields inherited from PhpdocHTMLDocumentRenderer

$undocmented, $functions, $uses, $constants, $accessmodifiers, $simpledocfields, $usestypes

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

Private Field Summary

array

$indent

Internal array of "&nbsp;" strings to format HTML output.
array

$variables

Array of variables found in the xml document.

Public Method Details

PhpdocHTMLClassRenderer

public void PhpdocHTMLClassRenderer( string $path, string $templateRoot, string $application, string $extension )

  Sets the xml and template root directory.

Parameter
string $path
XML file path
string $templateRoot
Template file path
string $application
Name of the current application
string $extension
Returns void

See Also setPath(), setTemplateRoot()

renderClass

public void renderClass( string $xmlfile, [ string $htmlfile ] )

  Renders a class

Parameter
string $xmlfile
XML source file
string $htmlfile = >>""<<
Name of the HTML target file.
Returns void


Private Method Details

renderInherited

private void renderInherited( )

  Renders a list of inherited elements.

Returns void

See Also renderInheritedElements()

renderInheritedElements

private void renderInheritedElements( $inherited, $block, $type )

  Renders a list of a certain inherited element.

Parameter
$inherited
$block
$type
Returns void

See Also renderInheritedElements()

renderSubclasses

private void renderSubclasses( )

  Renders a list of direct known subclasses.

Returns void


renderVariables

private void renderVariables( )

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

Returns void

See Also renderVariableSummary(), renderVariableDetail()

renderVariableSummary

private void renderVariableSummary( )

  Adds a summary of all variables to the template.

The function assumes that there is a block named "variablesummary" and
within it a block names "variablesummay_loop" in the template.

Returns void

See Also renderVariableDetail()

renderVariableDetail

private void renderVariableDetail( )

  Adds a detailed list of all variables to the template.

The function assumes that there is a block named "variabledetails"
and within it a block names "variablesdetails_loop" in the template.

Returns void

See Also renderVariableSummary()

getClasstree

private string getClasstree( string $class )

  Returns a html string that shows the class tree.

Parameter
string $class
name of the current class
Returns string

HTML that shows the tree


getIndent

private string getIndent( int $level )

  Returns a certain number of "&nbsp;"s.

Parameter
int $level
number of "&nbsp;" required.
Returns string

A string with the requested number of nunbreakable html spaces

See Also $indent

Private Field Details

$indent

private array $indent

>>array()<<


$variables

private array $variables

>>array()<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta