PHP Class packageDoc

Inheritance: extends Doc
Afficher le fichier Open project: peej/phpdoctor

Méthodes publiques

Свойство Type Description
$_classes classDoc[] The classes in this package
$_functions methodDoc[] The functions in this package
$_globals fieldDoc[] The globals in this package

Méthodes publiques

Méthode Description
addClass ( &$class ) Add a class to this package.
addFunction ( &$function ) Add a function to this package.
addGlobal ( &$global ) Add a global to this package.
allClasses ( ) : ClassDoc[] Get all included classes (including exceptions and interfaces).
asPath ( ) : str Return the package path.
depth ( ) : integer Calculate the depth of this package from the root.
exceptions ( ) : ClassDoc[] Get exceptions in this package.
findClass ( $className ) : ClassDoc Lookup for a class within this package.
functions ( ) : MethodDoc[] Get functions in this package.
globals ( ) : FieldDoc[] Get globals in this package.
interfaces ( ) : ClassDoc[] Get interfaces in this package.
ordinaryClasses ( ) : ClassDoc[] Get ordinary classes (excluding exceptions and interfaces) in this package.
packageDoc ( $name, &$root ) Constructor
traits ( ) : ClassDoc[] Get traits in this package.

Method Details

addClass() public méthode

Add a class to this package.
public addClass ( &$class )

addFunction() public méthode

Add a function to this package.
public addFunction ( &$function )

addGlobal() public méthode

Add a global to this package.
public addGlobal ( &$global )

allClasses() public méthode

Get all included classes (including exceptions and interfaces).
public allClasses ( ) : ClassDoc[]
Résultat ClassDoc[] An array of classes

asPath() public méthode

Return the package path.
public asPath ( ) : str
Résultat str

depth() public méthode

Calculate the depth of this package from the root.
public depth ( ) : integer
Résultat integer

exceptions() public méthode

Get exceptions in this package.
public exceptions ( ) : ClassDoc[]
Résultat ClassDoc[] An array of exceptions

findClass() public méthode

Lookup for a class within this package.
public findClass ( $className ) : ClassDoc
Résultat ClassDoc A class

functions() public méthode

Get functions in this package.
public functions ( ) : MethodDoc[]
Résultat MethodDoc[] An array of functions

globals() public méthode

Get globals in this package.
public globals ( ) : FieldDoc[]
Résultat FieldDoc[] An array of globals

interfaces() public méthode

Get interfaces in this package.
public interfaces ( ) : ClassDoc[]
Résultat ClassDoc[] An array of interfaces

ordinaryClasses() public méthode

Get ordinary classes (excluding exceptions and interfaces) in this package.
public ordinaryClasses ( ) : ClassDoc[]
Résultat ClassDoc[] An array of classes

packageDoc() public méthode

Constructor
public packageDoc ( $name, &$root )

traits() public méthode

Get traits in this package.
public traits ( ) : ClassDoc[]
Résultat ClassDoc[] An array of traits

Property Details

$_classes public_oe property

The classes in this package
public classDoc[] $_classes
Résultat classDoc[]

$_functions public_oe property

The functions in this package
public methodDoc[] $_functions
Résultat methodDoc[]

$_globals public_oe property

The globals in this package
public fieldDoc[] $_globals
Résultat fieldDoc[]