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[]