|
|
|
File: c:/www/apache/doc2//accessor/PhpdocDocumentAccessor.php
PHPDOC 2000/12/03 - PHPDoc
PhpdocDocumentAccessor
PhpdocObject
|
+-- PhpdocAccessor
|
+-- PhpdocDocumentAccessor
Base of the class and module accessor.
|
private class PhpdocDocumentAccessor extends PhpdocAccessor
Base of the class and module accessor.
|
| |
|
Direct known subclasses: PhpdocClassAccessor, PhpdocModuleAccessor
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Private Field Summary |
| string |
$xmlkeyKind 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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 andconstants from an internal array. Note that this is not a public function,future version might access internal data structures different.
|
| Parameter |
|
| string |
$element |
|
|
of the element you need: functions, variables,... |
|
|
| string |
$elementaccess |
|
|
of internal element access table |
|
| Returns |
void |
|
getElementsByAccess |
|
private void getElementsByAccess( string $access, string $element, string $elementaccess )
|
| |
Returns elements with a certain access type from the internal data.
The object uses this function to extract functions, variables, uses andconstants from an internal array. Note that this is not a public function,future version might access internal data structures different.
|
| Parameter |
|
|
|
|
|
| string |
$elementaccess |
|
|
type |
|
| Returns |
void |
|
buildUseslist |
|
private void buildUseslist( )
|
| |
Adds a list of included files to the internal data array.
|
| Returns |
void |
|
getElementlist |
|
private void getElementlist( string $element )
|
| |
Adds a list of a certain element to the internal data array.
|
| Parameter |
|
| string |
$element |
|
|
of the element to add: function, variable, constant. |
|
| Returns |
void |
|
|
Private Field Details |
$xmlkey |
|
private string $xmlkey
>>""<<
Kind of top-level container in the xml document.
Must be set by all derived classes.
|
|
|
|
|
|
| PHPDoc 1.0beta |