Packageindex Classtrees Modulegroups Elementlist Report XML Files

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

PhpdocHTMLIndexRenderer

PhpdocObject
   |
  +-- PhpdocRendererObject
     |
    +-- PhpdocHTMLRenderer
       |
      +-- PhpdocHTMLIndexRenderer

Renders Index lists.

 

private class PhpdocHTMLIndexRenderer extends PhpdocHTMLRenderer

Renders Index lists.

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

 

Methods inherited from PhpdocHTMLRenderer

setpath, settemplateroot, encode

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

void

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

Sets the xml and template root directory.
void

generate()

Builds all index files phpdoc needs assuming that the xml files have default names
void

finishClasstree()

Saves the generated classtree summary to disk.
void

addClasstree(string $xmlfile)

Adds a classtree to the classtree summary template.
void

renderElementlist(string $xmlfile)

Renders the element index list.
void

renderPackagelist(string $xmlfile)

Renders a complete packagelist.
void

renderFrameElementlist(string $xmlfile)

Renders files for the lower left frame with the elements of a certain file.
void

renderFramePackagesummary(string $xmlfile)

Renders a Packagesummary for the frameset.

Private Method Summary

void

addModulegroup(string $xmlfile)

Renders a modulegroup xml file.
void

loadPackagelist(string $xmlfile)

Imports the packagelist from the PhpdocIndexAccessor if not done previously.
void

buildClasstreeHTML(string $class)

Recursivly builds an HTML class tree using <ul><li></ul>.
void

finishModulegroup()

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

$packageFields

Some container in the package list.
array

$packages

Packagelist from the PhpdocIndexAccessor
array

$classtree

Array with classtree informations
unknown

$treeTpl

IntegratedTemplate Object used be renderClasstree()
unknown

$moduleTpl

IntegratedTemplateObject used by renderModulegroup()

Public Method Details

PhpdocHTMLIndexRenderer

public void PhpdocHTMLIndexRenderer( 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 application
string $extension
Returns void

See Also setPath(), setTemplateRoot()

generate

public void generate( )

  Builds all index files phpdoc needs assuming that the xml files have default names

Returns void

See Also renderElementlist(), renderPackagelist(), renderFramelementlist(), renderFramePackageSummary()

finishClasstree

public void finishClasstree( )

  Saves the generated classtree summary to disk.

Returns void

See Also renderClasstree()

addClasstree

public void addClasstree( string $xmlfile )

  Adds a classtree to the classtree summary template.

Parameter
string $xmlfile
XML Classtree file
Returns void

See Also finishClasstree()

renderElementlist

public void renderElementlist( string $xmlfile )

  Renders the element index list.

Parameter
string $xmlfile
XML file
Returns void

See Also generate()

renderPackagelist

public void renderPackagelist( string $xmlfile )

  Renders a complete packagelist.

Parameter
string $xmlfile
XML file
Returns void

See Also renderFrameElementlist(), renderFramePackagesummary()

renderFrameElementlist

public void renderFrameElementlist( string $xmlfile )

  Renders files for the lower left frame with the elements of a certain file.

Parameter
string $xmlfile
This function needs the packagelist.xml to work!
Returns void

See Also renderFramePackagesummary(), renderPackagelist()

renderFramePackagesummary

public void renderFramePackagesummary( string $xmlfile )

  Renders a Packagesummary for the frameset.

Parameter
string $xmlfile
XML file.
Returns void

See Also renderPackagelist(), renderFrameElementlist()

Private Method Details

addModulegroup

private void addModulegroup( string $xmlfile )

  Renders a modulegroup xml file.

Parameter
string $xmlfile
XML File
Returns void


loadPackagelist

private void loadPackagelist( string $xmlfile )

  Imports the packagelist from the PhpdocIndexAccessor if not done previously.

Parameter
string $xmlfile
XMl file.
Returns void

See Also $packages

buildClasstreeHTML

private void buildClasstreeHTML( string $class )

  Recursivly builds an HTML class tree using <ul><li></ul>.

Parameter
string $class
Name of the class the recursive loop starts with
Returns void

See Also renderClasstree()

finishModulegroup

private void finishModulegroup( )

 

Returns void


Private Field Details

$packageFields

private array $packageFields

>>array("class", "module")<<

See Also renderPackagelist()

$packages

private array $packages

>>array()<<


$classtree

private array $classtree

>>array()<<


$treeTpl

private unknown $treeTpl

>>unknown<<

See Also renderClasstree()

$moduleTpl

private unknown $moduleTpl

>>unknown<<

See Also renderModulegroup()


Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta