EnumInterface
extends
ElementInterface, TypeInterface
in
Common interface representing the description of a class.
Tags
Table of Contents
Methods
- __toString() : string
- getBackedType() : Type|null
- getCases() : Collection<string|int, EnumCaseInterface>
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getEndLocation() : Location|null
- Returns the end location where the definition for this element can be found.
- getErrors() : Collection<string|int, Error>
- getFullyQualifiedStructuralElementName() : Fqsen|null
- Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
- getInheritedMethods() : Collection<string|int, MethodInterface>
- getInterfaces() : Collection<string|int, \phpDocumentor\Descriptor\Interfaces\InterfaceInterface|\phpDocumentor\Reflection\Fqsen>
- getLine() : int
- Returns the line number where this element may be found.
- getMethods() : Collection<string|int, MethodInterface>
- getName() : string
- Returns the local name for this element.
- getNamespace() : NamespaceInterface|string
- Returns the namespace for this element (defaults to global "\")
- getPackage() : PackageInterface|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.
- getUsedTraits() : Collection<string|int, \phpDocumentor\Descriptor\Interfaces\TraitInterface|\phpDocumentor\Reflection\Fqsen>
- Returns the traits used by this class.
- 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.
- setUsedTraits() : void
- Sets a collection of all traits used by this class.
Methods
__toString()
public
__toString() : string
Return values
stringgetBackedType()
public
getBackedType() : Type|null
Return values
Type|nullgetCases()
public
getCases() : Collection<string|int, EnumCaseInterface>
Return values
Collection<string|int, EnumCaseInterface>getDescription()
Returns the description for this element.
public
getDescription() : DescriptionDescriptor
This method will automatically attempt to inherit the parent's description if this one has none.
Return values
DescriptionDescriptorgetEndLocation()
Returns the end location where the definition for this element can be found.
public
getEndLocation() : Location|null
Return values
Location|nullgetErrors()
public
getErrors() : Collection<string|int, Error>
Return values
Collection<string|int, Error>getFullyQualifiedStructuralElementName()
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
public
getFullyQualifiedStructuralElementName() : Fqsen|null
Return values
Fqsen|nullgetInheritedMethods()
public
getInheritedMethods() : Collection<string|int, MethodInterface>
Return values
Collection<string|int, MethodInterface>getInterfaces()
public
getInterfaces() : Collection<string|int, \phpDocumentor\Descriptor\Interfaces\InterfaceInterface|\phpDocumentor\Reflection\Fqsen>
Return values
Collection<string|int, \phpDocumentor\Descriptor\Interfaces\InterfaceInterface|\phpDocumentor\Reflection\Fqsen>getLine()
Returns the line number where this element may be found.
public
getLine() : int
Tags
Return values
intgetMethods()
public
getMethods() : Collection<string|int, MethodInterface>
Return values
Collection<string|int, MethodInterface>getName()
Returns the local name for this element.
public
getName() : string
Return values
stringgetNamespace()
Returns the namespace for this element (defaults to global "\")
public
getNamespace() : NamespaceInterface|string
Return values
NamespaceInterface|stringgetPackage()
Returns the package name for this element.
public
getPackage() : PackageInterface|null
Return values
PackageInterface|nullgetPath()
Returns the file location for this element relative to the project root.
public
getPath() : string
Return values
stringgetSummary()
Returns the summary describing this element.
public
getSummary() : string
Return values
stringgetTags()
Returns all tags associated with this element.
public
getTags() : Collection<string|int, Collection<string|int, TagDescriptor>>
Return values
Collection<string|int, Collection<string|int, TagDescriptor>>getUsedTraits()
Returns the traits used by this class.
public
getUsedTraits() : Collection<string|int, \phpDocumentor\Descriptor\Interfaces\TraitInterface|\phpDocumentor\Reflection\Fqsen>
Returned values may either be a string (when the Trait is not in this project) or a TraitDescriptor.
Return values
Collection<string|int, \phpDocumentor\Descriptor\Interfaces\TraitInterface|\phpDocumentor\Reflection\Fqsen>setBackedType()
public
setBackedType(Type|null $type) : void
Parameters
- $type : Type|null
setCases()
public
setCases(Collection<string|int, EnumCaseInterface> $cases) : void
Parameters
- $cases : Collection<string|int, EnumCaseInterface>
setDescription()
Sets a longer description for this element.
public
setDescription(DescriptionDescriptor $description) : void
Parameters
- $description : DescriptionDescriptor
setFullyQualifiedStructuralElementName()
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
public
setFullyQualifiedStructuralElementName(Fqsen $name) : void
Parameters
- $name : Fqsen
setInterfaces()
public
setInterfaces(Collection<string|int, \phpDocumentor\Descriptor\Interfaces\InterfaceInterface|\phpDocumentor\Reflection\Fqsen> $implements) : void
Parameters
- $implements : Collection<string|int, \phpDocumentor\Descriptor\Interfaces\InterfaceInterface|\phpDocumentor\Reflection\Fqsen>
setLocation()
Sets the file and location for this element.
public
setLocation(FileInterface $file, Location $startLocation) : void
Parameters
- $file : FileInterface
- $startLocation : Location
setMethods()
public
setMethods(Collection<string|int, MethodInterface> $methods) : void
Parameters
- $methods : Collection<string|int, MethodInterface>
setName()
Sets the local name for this element.
public
setName(string $name) : void
Parameters
- $name : string
setSummary()
Sets a summary describing this element.
public
setSummary(string $summary) : void
Parameters
- $summary : string
setUsedTraits()
Sets a collection of all traits used by this class.
public
setUsedTraits(Collection<string|int, \phpDocumentor\Descriptor\Interfaces\TraitInterface|\phpDocumentor\Reflection\Fqsen> $usedTraits) : void
Parameters
- $usedTraits : Collection<string|int, \phpDocumentor\Descriptor\Interfaces\TraitInterface|\phpDocumentor\Reflection\Fqsen>