phpDocumentor

ClassInterface extends ElementInterface, ChildInterface, TypeInterface
in

Common interface representing the description of a class.

Tags
see
NamespaceInterface

Classes may be contained in namespaces.

see
FileInterface

Classes may be defined in a file.

Table of Contents

__toString()  : string
getConstants()  : Collection<string|int, ConstantDescriptor>
getDescription()  : DescriptionDescriptor|null
Returns a longer description for this element.
getFullyQualifiedStructuralElementName()  : Fqsen|null
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
getInheritedMethods()  : Collection<string|int, MethodDescriptor>
getInheritedProperties()  : Collection<string|int, PropertyDescriptor>
getInterfaces()  : Collection<string|int, \phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen>
getLine()  : int
Returns the line number where this element may be found.
getMethods()  : Collection<string|int, MethodDescriptor>
getName()  : string
Returns the local name for this element.
getParent()  : DescriptorAbstract|Fqsen|string|null
Returns the parent for this descriptor.
getPath()  : string
Returns the file location for this element relative to the project root.
getProperties()  : Collection<string|int, PropertyDescriptor>
getSummary()  : string
Returns the summary describing this element.
getTags()  : Collection<string|int, Collection<string|int, TagDescriptor>>
Returns all tags associated with this element.
isAbstract()  : bool
isFinal()  : bool
setAbstract()  : void
setConstants()  : void
setDescription()  : void
Sets a longer description for this element.
setFinal()  : void
setFullyQualifiedStructuralElementName()  : void
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
setInterfaces()  : void
setLocation()  : void
Sets the file and location for this element.
setMethods()  : void
setName()  : void
Sets the local name for this element.
setParent()  : void
Sets the parent for this Descriptor.
setProperties()  : void
setSummary()  : void
Sets a summary describing this element.

Methods

__toString()

public __toString() : string
Return values
string

getFullyQualifiedStructuralElementName()

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

public getFullyQualifiedStructuralElementName() : Fqsen|null
Return values
Fqsen|null

getInterfaces()

public getInterfaces() : Collection<string|int, \phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen>
Return values
Collection<string|int, \phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen>

getLine()

Returns the line number where this element may be found.

public getLine() : int
Tags
see
getPath()

to find out in which file this element is found.

Return values
int

getName()

Returns the local name for this element.

public getName() : string
Return values
string

getPath()

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

public getPath() : string
Return values
string

getSummary()

Returns the summary describing this element.

public getSummary() : string
Return values
string

setAbstract()

public setAbstract(bool $abstract) : void
Parameters
$abstract : bool
Return values
void

setFinal()

public setFinal(bool $final) : void
Parameters
$final : bool
Return values
void

setFullyQualifiedStructuralElementName()

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

public setFullyQualifiedStructuralElementName(Fqsen $name) : void
Parameters
$name : Fqsen
Return values
void

setInterfaces()

public setInterfaces(Collection<string|int, \phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen> $implements) : void
Parameters
$implements : Collection<string|int, \phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen>
Return values
void

setName()

Sets the local name for this element.

public setName(string $name) : void
Parameters
$name : string
Return values
void

setSummary()

Sets a summary describing this element.

public setSummary(string $summary) : void
Parameters
$summary : string
Return values
void

Search results