EnumInterface
extends
ElementInterface, TypeInterface
in
Common interface representing the description of a class.
Tags
Table of Contents
- __toString() : string
- getBackedType() : Type|null
- getCases() : Collection<string|int, EnumCaseInterface>
- 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>
- 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.
- getPackage() : PackageDescriptor|null
- Returns the package name for this element.
- getPath() : string
- Returns the file location for this element relative to the project root.
- getSummary() : string
- Returns the summary describing this element.
- getTags() : Collection<string|int, Collection<string|int, TagDescriptor>>
- Returns all tags associated with this element.
- setBackedType() : void
- setCases() : void
- setDescription() : void
- Sets a longer description for this element.
- 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.
- setSummary() : void
- Sets a summary describing this element.
Methods
__toString()
public
__toString() : string
Tags
Return values
string —getBackedType()
public
getBackedType() : Type|null
Tags
Return values
Type|null —getCases()
public
getCases() : Collection<string|int, EnumCaseInterface>
Tags
Return values
Collection<string|int, EnumCaseInterface> —getDescription()
Returns a longer description for this element.
public
getDescription() : DescriptionDescriptor|null
Tags
Return values
DescriptionDescriptor|null —getFullyQualifiedStructuralElementName()
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
public
getFullyQualifiedStructuralElementName() : Fqsen|null
Tags
Return values
Fqsen|null —getInheritedMethods()
public
getInheritedMethods() : Collection<string|int, MethodDescriptor>
Tags
Return values
Collection<string|int, MethodDescriptor> —getInterfaces()
public
getInterfaces() : Collection<string|int, \phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen>
Tags
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
Return values
int —getMethods()
public
getMethods() : Collection<string|int, MethodDescriptor>
Tags
Return values
Collection<string|int, MethodDescriptor> —getName()
Returns the local name for this element.
public
getName() : string
Tags
Return values
string —getPackage()
Returns the package name for this element.
public
getPackage() : PackageDescriptor|null
Tags
Return values
PackageDescriptor|null —getPath()
Returns the file location for this element relative to the project root.
public
getPath() : string
Tags
Return values
string —getSummary()
Returns the summary describing this element.
public
getSummary() : string
Tags
Return values
string —getTags()
Returns all tags associated with this element.
public
getTags() : Collection<string|int, Collection<string|int, TagDescriptor>>
Tags
Return values
Collection<string|int, Collection<string|int, TagDescriptor>> —setBackedType()
public
setBackedType(Type|null $type) : void
Parameters
- $type : Type|null
Tags
Return values
void —setCases()
public
setCases(Collection<string|int, EnumCaseInterface> $cases) : void
Parameters
- $cases : Collection<string|int, EnumCaseInterface>
Tags
Return values
void —setDescription()
Sets a longer description for this element.
public
setDescription(DescriptionDescriptor $description) : void
Parameters
- $description : DescriptionDescriptor
Tags
Return values
void —setFullyQualifiedStructuralElementName()
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
public
setFullyQualifiedStructuralElementName(Fqsen $name) : void
Parameters
- $name : Fqsen
Tags
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>
Tags
Return values
void —setLocation()
Sets the file and location for this element.
public
setLocation(FileDescriptor $file, Location $startLocation) : void
Parameters
- $file : FileDescriptor
- $startLocation : Location
Tags
Return values
void —setMethods()
public
setMethods(Collection<string|int, MethodDescriptor> $methods) : void
Parameters
- $methods : Collection<string|int, MethodDescriptor>
Tags
Return values
void —setName()
Sets the local name for this element.
public
setName(string $name) : void
Parameters
- $name : string
Tags
Return values
void —setSummary()
Sets a summary describing this element.
public
setSummary(string $summary) : void
Parameters
- $summary : string