PHP Class classDoc

Inheritance: extends ProgramElementDoc
Mostrar archivo Open project: peej/phpdoctor

Public Properties

Property Type Description
$_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.

Public Methods

Method Description
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

Method Details

addConstant() public method

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

addField() public method

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

addMethod() public method

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

classDoc() public method

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

constants() public method

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

constructor() public method

Return constructor for this class.
public constructor ( ) : MethodDoc
return MethodDoc

destructor() public method

Return destructor for this class.
public destructor ( ) : MethodDoc
return MethodDoc

fieldNamed() public method

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

fields() public method

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

interfaceNamed() public method

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

interfaces() public method

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

isAbstract() public method

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

isClass() public method

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

isException() public method

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

isInterface() public method

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

isOrdinaryClass() public method

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

isTrait() public method

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

mergeSuperClassData() public method

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

methodNamed() public method

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

methods() public method

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

subclassOf() public method

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

subclasses() public method

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

superclass() public method

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

traitNamed() public method

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

traits() public method

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

Property Details

$_abstract public_oe property

Is this class abstract.
public bool $_abstract
return boolean

$_constants public_oe property

The class constants.
public fieldDoc[] $_constants
return fieldDoc[]

$_fields public_oe property

The class fields.
public fieldDoc[] $_fields
return fieldDoc[]

$_interface public_oe property

Is this an interface?
public bool $_interface
return boolean

$_interfaces public_oe property

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

$_methods public_oe property

The class methods.
public methodDoc[] $_methods
return methodDoc[]

$_superclass public_oe property

The super class.
public str $_superclass
return str

$_trait public_oe property

Is this a trait?
public bool $_trait
return boolean

$_traits public_oe property

Traits this class uses.
public classDoc[] $_traits
return classDoc[]