Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/accessor/PhpdocDocumentAccessor.php
PEAR Repository - PHPDoc

PhpdocDocumentAccessor

PhpdocObject
   |
  +-- PhpdocAccessor
     |
    +-- PhpdocDocumentAccessor

Base of the class and module accessor.

 

private class PhpdocDocumentAccessor extends PhpdocAccessor

Base of the class and module accessor.

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

 
Direct known subclasses: PhpdocClassAccessor, PhpdocModuleAccessor

Methods inherited from PhpdocAccessor

loadxmlfile, init

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

array

getFunctions()

Returns an array with all functions.
array

getFunctionsByAccess(string $access)

Returns an array with all functions with a certain access (public, private) attribute.
array

getVariables()

Returns an array with all variables.
array

getVariablesByAccess(string $access)

Returns an array with all variables with a certain access (public, private) attribute.
array

getConstants()

Returns an array of all constants.
array

getConstantsByAccess(string $access)

Returns an array of all constants with a certain access (public, private) attribute.
array

getUses()

Returns an array of all included files.
array

getUsesByType(string $type)

Returns an array of all included files with a certain type (include, require...) attribute.

Private Method Summary

void

getElements(string $element, string $elementaccess)

Returns elements from the internal $data array.
void

getElementsByAccess(string $access, string $element, string $elementaccess)

Returns elements with a certain access type from the internal data.
void

buildUseslist()

Adds a list of @included files to the internal data array.
void

getElementlist(string $element)

Adds a list of a certain element to the internal data array.

Fields inherited from PhpdocAccessor

$xmlreader, $xml, $freeonget, $data

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Private Field Summary

string

$xmlkey

Kind of top-level container in the xml document.

Public Method Details

getFunctions

public array getFunctions( )

  Returns an array with all functions.

Returns array $functions

See Also getFunctionsByAccess()

getFunctionsByAccess

public array getFunctionsByAccess( string $access )

  Returns an array with all functions with a certain access (public, private) attribute.

Parameter
string $access
Requested access attribute.
Returns array $functions

See Also getFunctions()

getVariables

public array getVariables( )

  Returns an array with all variables.

Returns array $variables

See Also getVariablesByAccess()

getVariablesByAccess

public array getVariablesByAccess( string $access )

  Returns an array with all variables with a certain access (public, private) attribute.

Parameter
string $access
Requested access attribute.
Returns array $variables

See Also getVariables()

getConstants

public array getConstants( )

  Returns an array of all constants.

Returns array $constants

See Also getConstantsByAccess()

getConstantsByAccess

public array getConstantsByAccess( string $access )

  Returns an array of all constants with a certain access (public, private) attribute.

Parameter
string $access
Requested access attribute.
Returns array $constants

See Also getConstants()

getUses

public array getUses( )

  Returns an array of all included files.

Returns array $uses

See Also getUsesByType()

getUsesByType

public array getUsesByType( string $type )

  Returns an array of all included files with a certain type (include, require...) attribute.

Parameter
string $type
Requested type: include, include_once, require, require_once
Returns array $uses


Private Method Details

getElements

private void getElements( string $element, string $elementaccess )

  Returns elements from the internal $data array.

The object uses this function to extract functions, variables, uses and
constants from an internal array. Note that this is not a public function,
future version might access internal data structures different.

Parameter
string $element
Name of the element you need: functions, variables,...
string $elementaccess
Name of internal element access table
Returns void

See Also $data

getElementsByAccess

private void getElementsByAccess( string $access, string $element, string $elementaccess )

  Returns elements with a certain access type from the internal data.

Parameter
string $access
Accesstype
string $element
element name
string $elementaccess
access type
Returns void


buildUseslist

private void buildUseslist( )

  Adds a list of

Returns void


getElementlist

private void getElementlist( string $element )

  Adds a list of a certain element to the internal data array.

Parameter
string $element
name of the element to add: function, variable, constant.
Returns void


Private Field Details

$xmlkey

private string $xmlkey

>>""<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta