EnumCase
in package
implements
Element, MetaDataContainer, AttributeContainer
uses
MetadataContainer, HasAttributes
FinalYes
Represents a case in an Enum.
Table of Contents
Interfaces
- Element
- Interface for Api Elements
- MetaDataContainer
- AttributeContainer
Properties
- $attributes : array<string|int, Attribute>
- $docBlock : DocBlock|null
- $endLocation : Location
- $fqsen : Fqsen
- $location : Location
- $value : Expression|string|null
Methods
- __construct() : mixed
- addAttribute() : void
- getAttributes() : array<string|int, Attribute>
- getDocBlock() : DocBlock|null
- getEndLocation() : Location
- getFqsen() : Fqsen
- Returns the Fqsen of the element.
- getLocation() : Location
- getName() : string
- Returns the name of the element.
- getValue() : Expression|string|null
- Returns the value for this enum case.
Properties
$attributes
private
array<string|int, Attribute>
$attributes
= []
$docBlock read-only
private
DocBlock|null
$docBlock
$endLocation read-only
private
Location
$endLocation
$fqsen read-only
private
Fqsen
$fqsen
$location read-only
private
Location
$location
$value
private
Expression|string|null
$value
= null
Methods
__construct()
public
__construct(Fqsen $fqsen, DocBlock|null $docBlock[, Location|null $location = null ][, Location|null $endLocation = null ][, Expression|string|null $value = null ]) : mixed
Parameters
- $fqsen : Fqsen
- $docBlock : DocBlock|null
- $location : Location|null = null
- $endLocation : Location|null = null
- $value : Expression|string|null = null
addAttribute()
public
addAttribute(Attribute $attribute) : void
Parameters
- $attribute : Attribute
getAttributes()
public
getAttributes() : array<string|int, Attribute>
Return values
array<string|int, Attribute>getDocBlock()
public
getDocBlock() : DocBlock|null
Return values
DocBlock|nullgetEndLocation()
public
getEndLocation() : Location
Return values
LocationgetFqsen()
Returns the Fqsen of the element.
public
getFqsen() : Fqsen
Attributes
- #[Override]
Return values
FqsengetLocation()
public
getLocation() : Location
Return values
LocationgetName()
Returns the name of the element.
public
getName() : string
Attributes
- #[Override]
Return values
stringgetValue()
Returns the value for this enum case.
public
getValue([bool $asString = true ]) : Expression|string|null
Parameters
- $asString : bool = true