Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/accessor/PhpdocIndexAccessor.php
PEAR Repository - 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>
Version1.0beta

 

Methods inherited from PhpdocAccessor

loadxmlfile

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

void

getModulegroup()

Returns a modulegroup
void

getClasstree()

Returns a classtree.
void

getChapternames()

Returns an ordered list of all chapternames.
void

getChapters()

Returns an ordered list of all chapters.
void

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.

Fields inherited from PhpdocAccessor

$xmlreader, $xml, $freeonget, $data

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

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 void getClasstree( )

  Returns a classtree.

Returns void


getChapternames

public void getChapternames( )

  Returns an ordered list of all chapternames.

Returns void

See Also getChapters()

getChapters

public void getChapters( )

  Returns an ordered list of all chapters.

Returns void

See Also getChapternames()

getPackagelist

public void getPackagelist( )

  Returns a list of all packages

Returns void


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 g::g

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.

Returns void

See Also $flagBuild

Private Field Details

$chapternames

private array $chapternames

>>array()<<


$chapters

private array $chapters

>>array()<<


$packages

private array $packages

>>array()<<


$classtree

private array $classtree

>>array()<<


$modulegroup

private array $modulegroup

>>array()<<


$packageFields

private array $packageFields

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

See Also buildPackagelist()

$flagBuild

private array $flagBuild

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



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta