ClassInterface

Extends \phpDocumentor\Descriptor\Interfaces\ElementInterface, \phpDocumentor\Descriptor\Interfaces\ChildInterface, \phpDocumentor\Descriptor\Interfaces\TypeInterface

Common interface representing the description of a class.

see

Classes may be contained in namespaces.

see

Classes may be defined in a file.

package

Default

Methods

getConstants

getConstants() : \phpDocumentor\Descriptor\Collection

Returns a longer description for this element.

getDescription() : string
inherited

Response

string

Returns the Fully Qualified Structural Element Name (FQSEN) for this element.

getFullyQualifiedStructuralElementName() : string
inherited

Response

string

getInheritedMethods

getInheritedMethods() : \phpDocumentor\Descriptor\Collection

getInheritedProperties

getInheritedProperties() : \phpDocumentor\Descriptor\Collection

getInterfaces

getInterfaces() : \phpDocumentor\Descriptor\Collection

Returns the line number where this element may be found.

getLine() : integer
inherited
see \phpDocumentor\Descriptor\Interfaces\ElementInterface::getPath()

to find out in which file this element is found.

Response

integer

getMethods

getMethods() : \phpDocumentor\Descriptor\Collection

Returns the local name for this element.

getName() : string
inherited

Response

string

Returns the parent for this descriptor.

getParent() : \phpDocumentor\Descriptor\DescriptorAbstract
inherited

Returns the file location for this element relative to the project root.

getPath() : string
inherited

Response

string

getProperties

getProperties() : \phpDocumentor\Descriptor\Collection

Returns the summary describing this element.

getSummary() : string
inherited

Response

string

Returns all tags associated with this element.

getTags() : \phpDocumentor\Descriptor\Collection
inherited

isAbstract

isAbstract() 

isFinal

isFinal() 

setAbstract

setAbstract( $abstract) : void

Arguments

$abstract

setConstants

setConstants(\phpDocumentor\Descriptor\Collection $constants) : void

Sets a longer description for this element.

setDescription(string $description) : void
inherited

Arguments

$description

string

setFinal

setFinal( $final) : void

Arguments

$final

Sets the Fully Qualified Structural Element Name (FQSEN) for this element.

setFullyQualifiedStructuralElementName(string $name) : void
inherited

Arguments

$name

string

setInterfaces

setInterfaces(\phpDocumentor\Descriptor\Collection $interfaces) : void

Arguments

Sets the file and location for this element.

setLocation(\phpDocumentor\Descriptor\FileDescriptor $file, integer $line) : void
inherited

Arguments

$line

integer

setMethods

setMethods(\phpDocumentor\Descriptor\Collection $methods) : void

Sets the local name for this element.

setName(string $name) : void
inherited

Arguments

$name

string

Sets the parent for this Descriptor.

setParent(\phpDocumentor\Descriptor\DescriptorAbstract $parent) : void
inherited

setProperties

setProperties(\phpDocumentor\Descriptor\Collection $properties) : void

Arguments

Sets a summary describing this element.

setSummary(string $summary) : void
inherited

Arguments

$summary

string