PHP Класс packageDoc

Наследование: extends Doc
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$_classes classDoc[] The classes in this package
$_functions methodDoc[] The functions in this package
$_globals fieldDoc[] The globals in this package

Открытые методы

Метод Описание
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.

Описание методов

addClass() публичный Метод

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

addFunction() публичный Метод

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

addGlobal() публичный Метод

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

allClasses() публичный Метод

Get all included classes (including exceptions and interfaces).
public allClasses ( ) : ClassDoc[]
Результат ClassDoc[] An array of classes

asPath() публичный Метод

Return the package path.
public asPath ( ) : str
Результат str

depth() публичный Метод

Calculate the depth of this package from the root.
public depth ( ) : integer
Результат integer

exceptions() публичный Метод

Get exceptions in this package.
public exceptions ( ) : ClassDoc[]
Результат ClassDoc[] An array of exceptions

findClass() публичный Метод

Lookup for a class within this package.
public findClass ( $className ) : ClassDoc
Результат ClassDoc A class

functions() публичный Метод

Get functions in this package.
public functions ( ) : MethodDoc[]
Результат MethodDoc[] An array of functions

globals() публичный Метод

Get globals in this package.
public globals ( ) : FieldDoc[]
Результат FieldDoc[] An array of globals

interfaces() публичный Метод

Get interfaces in this package.
public interfaces ( ) : ClassDoc[]
Результат ClassDoc[] An array of interfaces

ordinaryClasses() публичный Метод

Get ordinary classes (excluding exceptions and interfaces) in this package.
public ordinaryClasses ( ) : ClassDoc[]
Результат ClassDoc[] An array of classes

packageDoc() публичный Метод

Constructor
public packageDoc ( $name, &$root )

traits() публичный Метод

Get traits in this package.
public traits ( ) : ClassDoc[]
Результат ClassDoc[] An array of traits

Описание свойств

$_classes публичное свойство

The classes in this package
public classDoc[] $_classes
Результат classDoc[]

$_functions публичное свойство

The functions in this package
public methodDoc[] $_functions
Результат methodDoc[]

$_globals публичное свойство

The globals in this package
public fieldDoc[] $_globals
Результат fieldDoc[]