Constant
in package
implements
Element, MetaDataContainer
Uses
MetadataContainer
Descriptor representing a constant
Interfaces, Classes and Traits
- Element
- Interface for Api Elements
- MetaDataContainer
Table of Contents
- $docBlock : DocBlock|null
- $endLocation : Location
- $final : bool
- $fqsen : Fqsen
- $location : Location
- $value : string|null
- $visibility : Visibility
- __construct() : mixed
- Initializes the object.
- getDocBlock() : DocBlock|null
- Returns DocBlock of this constant if available.
- getEndLocation() : Location
- getFqsen() : Fqsen
- Returns the Fqsen of the element.
- getLocation() : Location
- getName() : string
- Returns the name of the element.
- getValue() : string|null
- Returns the value of this constant.
- getVisibility() : Visibility
- isFinal() : bool
Properties
$docBlock
private
DocBlock|null
$docBlock
$endLocation
private
Location
$endLocation
$final
private
bool
$final
$fqsen
private
Fqsen
$fqsen
$location
private
Location
$location
$value
private
string|null
$value
$visibility
private
Visibility
$visibility
Methods
__construct()
Initializes the object.
public
__construct(Fqsen $fqsen[, DocBlock|null $docBlock = null ][, string|null $value = null ][, Location|null $location = null ][, Location|null $endLocation = null ][, Visibility|null $visibility = null ][, bool $final = false ]) : mixed
Parameters
- $fqsen : Fqsen
- $docBlock : DocBlock|null = null
- $value : string|null = null
- $location : Location|null = null
- $endLocation : Location|null = null
- $visibility : Visibility|null = null
- $final : bool = false
Return values
mixed —getDocBlock()
Returns DocBlock of this constant if available.
public
getDocBlock() : DocBlock|null
Return values
DocBlock|null —getEndLocation()
public
getEndLocation() : Location
Return values
Location —getFqsen()
Returns the Fqsen of the element.
public
getFqsen() : Fqsen
Return values
Fqsen —getLocation()
public
getLocation() : Location
Return values
Location —getName()
Returns the name of the element.
public
getName() : string
Return values
string —getValue()
Returns the value of this constant.
public
getValue() : string|null
Return values
string|null —getVisibility()
public
getVisibility() : Visibility
Return values
Visibility —isFinal()
public
isFinal() : bool