Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: c:/www/apache/doc2//accessor/PhpdocIndexAccessor.php
PHPDOC 2000/12/03 - PHPDoc

PhpdocIndexAccessor

PhpdocObject
   |
  +-- PhpdocAccessor
     |
    +-- PhpdocIndexAccessor

Provides a API to access Index xml documents.

 

private class PhpdocIndexAccessor extends PhpdocAccessor

Provides a API to access Index xml documents.

AuthorsUlf Wendel <ulf.wendel@phpdoc.de>
Version$Id: $

 

Methods inherited from PhpdocAccessor

loadxmlfile

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

void

getModulegroup()

Returns a modulegroup
array

getClasstree()

Returns a classtree.
array

getChapternames()

Returns an ordered list of all chapternames.
array

getChapters()

Returns an ordered list of all chapters.
array

getPackagelist()

Returns a list of all packages

Private Method Summary

void

buildPackagelist()

Builds the internal packagelist.
void

buildChapterlist()

Builds the internal chapterlists.
void

buildModulegroup()

Extracts the modulegroup data of the xml file.
void

buildClasstree()

Extracts the classtree data of the xml file.
void

init()

Resets the build flags.Warning: documentation is missing.

Fields inherited from PhpdocAccessor

$xmlreader, $xml, $freeonget, $data

Fields inherited from PhpdocObject

$err, $application, $warn, $flag_output

Private Field Summary

array

$chapternames

Ordered list of all chapternames.
array

$chapters

Ordered list of all chapters.
array

$packages

List of all packages.
array

$classtree

Data of a classtree
array

$modulegroup

Data of a modulegroup
array

$packageFields

Some container withing the packagelist.
array

$flagBuild

Flag indicating that certain internal datafield have been filled.

Public Method Details

getModulegroup

public void getModulegroup( )

  Returns a modulegroup

Returns void


getClasstree

public array getClasstree( )

  Returns a classtree.

Returns array


getChapternames

public array getChapternames( )

  Returns an ordered list of all chapternames.

Returns array

See Also getChapters()

getChapters

public array getChapters( )

  Returns an ordered list of all chapters.

Returns array

See Also getChapternames()

getPackagelist

public array getPackagelist( )

  Returns a list of all packages

Returns array


Private Method Details

buildPackagelist

private void buildPackagelist( )

  Builds the internal packagelist.

Returns void


buildChapterlist

private void buildChapterlist( )

  Builds the internal chapterlists.

Returns void


buildModulegroup

private void buildModulegroup( )

  Extracts the modulegroup data of the xml file.

Returns void

See Also getModulegroup()

buildClasstree

private void buildClasstree( )

  Extracts the classtree data of the xml file.

Returns void

See Also getClasstree()

init

private void init( )

  Resets the build flags.

Warning: documentation is missing.

Returns void

See Also $flagBuild

Private Field Details

$chapternames

private array $chapternames

>>array()<<

Ordered list of all chapternames.


$chapters

private array $chapters

>>array()<<

Ordered list of all chapters.


$packages

private array $packages

>>array()<<

List of all packages.


$classtree

private array $classtree

>>array()<<

Data of a classtree


$modulegroup

private array $modulegroup

>>array()<<

Data of a modulegroup


$packageFields

private array $packageFields

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

Some container withing the packagelist.

See Also buildPackagelist()

$flagBuild

private array $flagBuild

>>array( "chapter" => false, "package" => false )<<

Flag indicating that certain internal datafield have been filled.



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta