PHP 클래스 classDoc

상속: extends ProgramElementDoc
파일 보기 프로젝트 열기: peej/phpdoctor

공개 프로퍼티들

프로퍼티 타입 설명
$_abstract boolean Is this class abstract.
$_constants fieldDoc[] The class constants.
$_fields fieldDoc[] The class fields.
$_interface boolean Is this an interface?
$_interfaces classDoc[] Interfaces this class implements or this interface extends.
$_methods methodDoc[] The class methods.
$_superclass str The super class.
$_trait boolean Is this a trait?
$_traits classDoc[] Traits this class uses.

공개 메소드들

메소드 설명
addConstant ( &$constant ) Add a constant to this class.
addField ( &$field ) Add a field to this class.
addMethod ( &$method ) Add a method to this class.
classDoc ( $name, &$root, $filename, $lineNumber, $sourcePath ) Constructor
constants ( ) : FieldDoc[] Return constants in this class.
constructor ( ) : MethodDoc Return constructor for this class.
destructor ( ) : MethodDoc Return destructor for this class.
fieldNamed ( $fieldName ) : FieldDoc Return a field in this class.
fields ( ) : FieldDoc[] Return fields in this class.
interfaceNamed ( $interfaceName ) : ClassDoc Return an interface in this class.
interfaces ( ) : ClassDoc[] Return interfaces implemented by this class or interfaces extended by this interface.
isAbstract ( ) : boolean Return true if this class is abstract.
isClass ( ) : boolean Is this construct a class. Note: interfaces are not classes.
isException ( ) : boolean Is this construct an exception.
isInterface ( ) : boolean Return true if this element is an interface.
isOrdinaryClass ( ) : boolean Is this construct an ordinary class (not an interface or an exception).
isTrait ( ) : boolean Return true if this element is a trait.
mergeSuperClassData ( $superClassName = NULL ) Merge the details of the superclass with this class.
methodNamed ( $methodName ) : MethodDoc Return a method in this class.
methods ( $regularOnly = FALSE ) : MethodDoc[] Return the methods in this class.
subclassOf ( $cd ) : boolean Test whether this class is a subclass of the specified class.
subclasses ( ) : classDoc[] Return the known subclasses of this class
superclass ( ) : ClassDoc Return the superclass of this class.
traitNamed ( $traitName ) : ClassDoc Return an interface in this class.
traits ( ) : ClassDoc[] Return traits used by this class

메소드 상세

addConstant() 공개 메소드

Add a constant to this class.
public addConstant ( &$constant )

addField() 공개 메소드

Add a field to this class.
public addField ( &$field )

addMethod() 공개 메소드

Add a method to this class.
public addMethod ( &$method )

classDoc() 공개 메소드

Constructor
public classDoc ( $name, &$root, $filename, $lineNumber, $sourcePath )

constants() 공개 메소드

Return constants in this class.
public constants ( ) : FieldDoc[]
리턴 FieldDoc[]

constructor() 공개 메소드

Return constructor for this class.
public constructor ( ) : MethodDoc
리턴 MethodDoc

destructor() 공개 메소드

Return destructor for this class.
public destructor ( ) : MethodDoc
리턴 MethodDoc

fieldNamed() 공개 메소드

Return a field in this class.
public fieldNamed ( $fieldName ) : FieldDoc
리턴 FieldDoc

fields() 공개 메소드

Return fields in this class.
public fields ( ) : FieldDoc[]
리턴 FieldDoc[]

interfaceNamed() 공개 메소드

Return an interface in this class.
public interfaceNamed ( $interfaceName ) : ClassDoc
리턴 ClassDoc

interfaces() 공개 메소드

Return interfaces implemented by this class or interfaces extended by this interface.
public interfaces ( ) : ClassDoc[]
리턴 ClassDoc[]

isAbstract() 공개 메소드

Return true if this class is abstract.
public isAbstract ( ) : boolean
리턴 boolean

isClass() 공개 메소드

Is this construct a class. Note: interfaces are not classes.
public isClass ( ) : boolean
리턴 boolean

isException() 공개 메소드

Is this construct an exception.
public isException ( ) : boolean
리턴 boolean

isInterface() 공개 메소드

Return true if this element is an interface.
public isInterface ( ) : boolean
리턴 boolean

isOrdinaryClass() 공개 메소드

Is this construct an ordinary class (not an interface or an exception).
public isOrdinaryClass ( ) : boolean
리턴 boolean

isTrait() 공개 메소드

Return true if this element is a trait.
public isTrait ( ) : boolean
리턴 boolean

mergeSuperClassData() 공개 메소드

Merge the details of the superclass with this class.
public mergeSuperClassData ( $superClassName = NULL )

methodNamed() 공개 메소드

Return a method in this class.
public methodNamed ( $methodName ) : MethodDoc
리턴 MethodDoc

methods() 공개 메소드

Return the methods in this class.
public methods ( $regularOnly = FALSE ) : MethodDoc[]
리턴 MethodDoc[]

subclassOf() 공개 메소드

Test whether this class is a subclass of the specified class.
public subclassOf ( $cd ) : boolean
리턴 boolean

subclasses() 공개 메소드

Return the known subclasses of this class
public subclasses ( ) : classDoc[]
리턴 classDoc[]

superclass() 공개 메소드

Return the superclass of this class.
public superclass ( ) : ClassDoc
리턴 ClassDoc

traitNamed() 공개 메소드

Return an interface in this class.
public traitNamed ( $traitName ) : ClassDoc
리턴 ClassDoc

traits() 공개 메소드

Return traits used by this class
public traits ( ) : ClassDoc[]
리턴 ClassDoc[]

프로퍼티 상세

$_abstract 공개적으로 프로퍼티

Is this class abstract.
public bool $_abstract
리턴 boolean

$_constants 공개적으로 프로퍼티

The class constants.
public fieldDoc[] $_constants
리턴 fieldDoc[]

$_fields 공개적으로 프로퍼티

The class fields.
public fieldDoc[] $_fields
리턴 fieldDoc[]

$_interface 공개적으로 프로퍼티

Is this an interface?
public bool $_interface
리턴 boolean

$_interfaces 공개적으로 프로퍼티

Interfaces this class implements or this interface extends.
public classDoc[] $_interfaces
리턴 classDoc[]

$_methods 공개적으로 프로퍼티

The class methods.
public methodDoc[] $_methods
리턴 methodDoc[]

$_superclass 공개적으로 프로퍼티

The super class.
public str $_superclass
리턴 str

$_trait 공개적으로 프로퍼티

Is this a trait?
public bool $_trait
리턴 boolean

$_traits 공개적으로 프로퍼티

Traits this class uses.
public classDoc[] $_traits
리턴 classDoc[]