ConstantInterface
extends
ElementInterface, TypeInterface
in
Descriptor representing a constant on a class, trait, property or file.
Table of Contents
- __toString() : string
- getDescription() : DescriptionDescriptor|null
- Returns a longer description for this element.
- getFullyQualifiedStructuralElementName() : Fqsen|null
- Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
- getLine() : int
- Returns the line number where this element may be found.
- getName() : string
- Returns the local 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.
- getTypes() : array<int, Type>
- Returns the types that may be present in this constant.
- getValue() : string
- Retrieves a textual representation of the value in this constant.
- setDescription() : void
- Sets a longer description for this element.
- setFullyQualifiedStructuralElementName() : void
- Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
- setLocation() : void
- Sets the file and location for this element.
- setName() : void
- Sets the local name for this element.
- setSummary() : void
- Sets a summary describing this element.
- setTypes() : void
- Sets the types that this constant may contain.
- setValue() : void
- Sets the value representation for this constant.
Methods
__toString()
public
__toString() : string
Return values
string —getDescription()
Returns a longer description for this element.
public
getDescription() : DescriptionDescriptor|null
Return values
DescriptionDescriptor|null —getFullyQualifiedStructuralElementName()
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
public
getFullyQualifiedStructuralElementName() : Fqsen|null
Return values
Fqsen|null —getLine()
Returns the line number where this element may be found.
public
getLine() : int
Tags
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 —getTags()
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>> —getTypes()
Returns the types that may be present in this constant.
public
getTypes() : array<int, Type>
Return values
array<int, Type> —getValue()
Retrieves a textual representation of the value in this constant.
public
getValue() : string
Return values
string —setDescription()
Sets a longer description for this element.
public
setDescription(DescriptionDescriptor $description) : void
Parameters
- $description : DescriptionDescriptor
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 —setLocation()
Sets the file and location for this element.
public
setLocation(FileDescriptor $file, int $line) : void
Parameters
- $file : FileDescriptor
- $line : int
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 —setTypes()
Sets the types that this constant may contain.
public
setTypes(Type $types) : void
Parameters
- $types : Type
Return values
void —setValue()
Sets the value representation for this constant.
public
setValue(string $value) : void
Parameters
- $value : string