When building tools that inspect PHP code, ReflectionClassConstant::getName() helps answer a focused question: returns the unqualified name of the reflected class constant.
Reflection is useful in framework tooling, dependency injection, testing, code inspection and debugging.
What Is ReflectionClassConstant::getName()?
Returns the unqualified name of the reflected class constant.
Its method signature is:
public function getName(): string
This method has no required arguments.
Return value: string
Example 1: Inspect a typed constant
Start with a self-contained PHP declaration and inspect the method result.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_CLASS_CONSTANT)]
class ConstantLabel { public function __construct(public string $value) {} }
class ReportLabels {
/** Human-readable identifier for exported reports. */
#[ConstantLabel('export')]
final public const string KIND = 'csv';
protected const int RETENTION_DAYS = 30;
private const bool INTERNAL = true;
}
enum DeliveryStage: string { case Queued = 'queued'; case Sent = 'sent'; }
$constantReflection = new ReflectionClassConstant(ReportLabels::class, "KIND");
$result = $constantReflection->getName();
var_dump($result);
Output:
string(4) "KIND"
Explanation: Returns the unqualified name of the reflected class constant.
Example 2: Compare a constant with different visibility
Next, change the reflected declaration or parameter to observe a related situation.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_CLASS_CONSTANT)]
class ConstantLabel { public function __construct(public string $value) {} }
class ReportLabels {
/** Human-readable identifier for exported reports. */
#[ConstantLabel('export')]
final public const string KIND = 'csv';
protected const int RETENTION_DAYS = 30;
private const bool INTERNAL = true;
}
enum DeliveryStage: string { case Queued = 'queued'; case Sent = 'sent'; }
$constantReflection = new ReflectionClassConstant(ReportLabels::class, "RETENTION_DAYS");
$result = $constantReflection->getName();
var_dump($result);
// Check the returned value type before using the result.
echo "\nResult type: " . get_debug_type($result);
Output:
string(14) "RETENTION_DAYS"
Result type: string
Explanation: An enum case also appears as a reflected constant; its name remains a string.
Practical Example: Inspect another declared constant
This final case shows how the same API can be used when inspecting application definitions.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_CLASS_CONSTANT)]
class ConstantLabel { public function __construct(public string $value) {} }
class ReportLabels {
/** Human-readable identifier for exported reports. */
#[ConstantLabel('export')]
final public const string KIND = 'csv';
protected const int RETENTION_DAYS = 30;
private const bool INTERNAL = true;
}
enum DeliveryStage: string { case Queued = 'queued'; case Sent = 'sent'; }
$constantReflection = new ReflectionClassConstant(ReportLabels::class, "INTERNAL");
$result = $constantReflection->getName();
var_dump($result);
// Use the reflection result in a simple decision.
if (is_bool($result)) {
echo "\nStatus: " . ($result ? "yes" : "no");
} elseif (is_array($result)) {
echo "\nEntries: " . count($result);
} elseif ($result === null) {
echo "\nNo value returned";
} else {
echo "\nReflection result available";
}
Output:
string(8) "INTERNAL"
Reflection result available
Explanation: getValue returns the constant's actual value instead.
Important Behavior and Edge Cases
- An enum case also appears as a reflected constant; its name remains a string.
- getValue returns the constant's actual value instead.
- Reflection describes declarations and runtime state; requesting metadata does not automatically validate or sanitize application input.
Comparison With Related Approaches
| Approach | When to Use It |
|---|---|
ReflectionClassConstant::getName() | Returns the unqualified name of the reflected class constant. |
Related API | getValue returns the constant's actual value instead. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Ignoring this condition: An enum case also appears as a reflected constant; its name remains a string. | Handle the specific limitation: An enum case also appears as a reflected constant; its name remains a string. |
| Confusing this method with Related API | getValue returns the constant's actual value instead. |
Key Takeaways
- Returns the unqualified name of the reflected class constant.
- An enum case also appears as a reflected constant; its name remains a string.
- getValue returns the constant's actual value instead.
Use ReflectionClassConstant::getName() when you need the precise metadata or behavior demonstrated above. Keep the target declaration and relevant PHP version in mind when adapting the examples.