ReflectionClass inspects the definition of a class, rather than running its constructor or calling its methods.
What Is ReflectionClass::getProperty in PHP?
Returns ReflectionProperty for a named property or throws if it does not exist.
ReflectionClass::getProperty(string $name)Parameters:
$name— Required. The exact class-member name (method, property or constant) to inspect.
Example 1: Understanding the Basic Behavior
<?php
class Report { public const VERSION = 2; public string $title = 'Draft'; protected int $pages = 10; public static string $category = 'docs'; public function publish(): void {} }
$reflectionClass = new ReflectionClass(Report::class);
$result = $reflectionClass->getProperty("title");
var_dump($result);The output includes runtime-dependent object or source details, so it may differ across PHP installations.
Explanation: Returns ReflectionProperty for a named property or throws if it does not exist.
Example 2: Testing Another Case
<?php
interface Exportable { public function export(): string; }
trait HasId { public function getId(): int { return 12; } }
class Invoice implements Exportable { use HasId; public string $name = 'Invoice'; public const STATE = 'open'; public function export(): string { return 'invoice'; } }
$reflectionClass = new ReflectionClass(Invoice::class);
$result = $reflectionClass->getProperty("name");
var_dump($result);The output includes runtime-dependent object or source details, so it may differ across PHP installations.
Explanation: A missing property throws ReflectionException; check hasProperty() before relying on it.
Practical Example: Applying the Operation
<?php
abstract class BaseJob { protected string $name = 'job'; abstract public function run(): void; }
class CompletedJob extends BaseJob { public function run(): void {} }
$reflectionClass = new ReflectionClass(CompletedJob::class);
$result = $reflectionClass->getProperty("name");
var_dump($result);The output includes runtime-dependent object or source details, so it may differ across PHP installations.
Explanation: The returned metadata may be false, null, an array, or a Reflection object depending on the requested property.
Important Behavior and Edge Cases
- A missing property throws ReflectionException; check hasProperty() before relying on it.
- The returned metadata may be false, null, an array, or a Reflection object depending on the requested property.
Comparison With Related Approaches
| Approach | When to Use It |
|---|---|
ReflectionClass::getProperty | Returns ReflectionProperty for a named property or throws if it does not exist. |
ReflectionClass::hasProperty() | getProperty() returns one ReflectionProperty; hasProperty() tests existence. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Treating metadata returned by ReflectionClass::getProperty() as though it executes the reflected class member. | A missing property throws ReflectionException; check hasProperty() before relying on it. |
| Choosing ReflectionClass::hasProperty() without checking whether it provides the same result. | getProperty() returns one ReflectionProperty; hasProperty() tests existence. |
Key Takeaways
- Returns ReflectionProperty for a named property or throws if it does not exist.
- A missing property throws ReflectionException; check hasProperty() before relying on it.
- The returned metadata may be false, null, an array, or a Reflection object depending on the requested property.
The examples demonstrate where ReflectionClass::getProperty fits within reflection and metadata. Verify the relevant preconditions whenever you adapt the code to real data.