Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/indexer/PhpdocIndexer.php
PEAR Repository - PHPDoc

PhpdocIndexer

PhpdocObject
   |
  +-- PhpdocIndexer

Builds Indexlists with the result from the

 

private class PhpdocIndexer extends PhpdocObject

Builds Indexlists with the result from the

AuthorsUlf Wendel <ulf.wendel@redsys.de>
Version0.3alpha

 

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

void

addClass( &$class)

Adds a class to the index lists (elements, packages, classtree).
void

addModule( &$module)

Adds a module to the index lists (elements, packages, classtree).
array

getClasstree()

Returns the current classtree and resets the internal classtree field.
array

getModulegroup()

Returns the current modulegroup and resets the internal modulegroup field.
array

getPackages()

Returns the package list and resets the internal package field.
array

getElementlist()

Returns the element index list and resets the internal elements field.

Private Method Summary

void

addElements(string &$elements, $type)

Adds an element to the elementlist.

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Private Field Summary

array

$packages

Array of all packages.
array

$classtree

Current classtree.
array

$modulegroup

Current modulegroup.
array

$elements

Array of all elements (functions, variables, constant, included files, classes, packages).
array

$elementFields

Array of fields that get added to the elementlist

Public Method Details

addClass

public void addClass( &$class )

  Adds a class to the index lists (elements, packages, classtree).

Parameter
&$class
Returns void

See Also addModule()

addModule

public void addModule( &$module )

  Adds a module to the index lists (elements, packages, classtree).

Parameter
&$module
Returns void

See Also addClass()

getClasstree

public array getClasstree( )

  Returns the current classtree and resets the internal classtree field.

Returns array $classtree


getModulegroup

public array getModulegroup( )

  Returns the current modulegroup and resets the internal modulegroup field.

Returns array $modulegroup


getPackages

public array getPackages( )

  Returns the package list and resets the internal package field.

Returns array $packages


getElementlist

public array getElementlist( )

  Returns the element index list and resets the internal elements field.

Returns array $elements


Private Method Details

addElements

private void addElements( string &$elements, $type )

  Adds an element to the elementlist.

Parameter
string &$elements
Element type: class, module.
$type
Returns void


Private Field Details

$packages

private array $packages

>>array()<<


$classtree

private array $classtree

>>array()<<


$modulegroup

private array $modulegroup

>>array()<<


$elements

private array $elements

>>array()<<


$elementFields

private array $elementFields

>>array("functions", "variables", "consts", "uses")<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta