When building tools that inspect PHP code, ReflectionParameter::isPromoted() helps answer a focused question: identifies constructor parameters that also declare object properties.
Reflection is useful in framework tooling, dependency injection, testing, code inspection and debugging.
What Is ReflectionParameter::isPromoted()?
Identifies constructor parameters that also declare object properties.
Its method signature is:
public function isPromoted(): bool
This method has no required arguments.
Return value: bool
Example 1: Inspect a formal parameter
Start with a self-contained PHP declaration and inspect the method result.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_PARAMETER)]
class Validated { public function __construct(public string $rule) {} }
function submitOrder(#[Validated('positive')] int $quantity, string $currency = 'USD', ?string $note = null): void {}
function updateCounter(int &$total): void { $total++; }
function collectNames(string ...$names): void {}
class OrderRequest { public function __construct(public readonly int $identifier, public string $label = 'New') {} }
$functionReflection = new ReflectionMethod(OrderRequest::class, "__construct");
$parameterReflection = $functionReflection->getParameters()[0];
$result = $parameterReflection->isPromoted();
var_dump($result);
Output:
bool(true)
Explanation: Identifies constructor parameters that also declare object properties.
Example 2: Compare another parameter position
Next, change the reflected declaration or parameter to observe a related situation.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_PARAMETER)]
class Validated { public function __construct(public string $rule) {} }
function submitOrder(#[Validated('positive')] int $quantity, string $currency = 'USD', ?string $note = null): void {}
function updateCounter(int &$total): void { $total++; }
function collectNames(string ...$names): void {}
class OrderRequest { public function __construct(public readonly int $identifier, public string $label = 'New') {} }
$functionReflection = new ReflectionFunction("submitOrder");
$parameterReflection = $functionReflection->getParameters()[1];
$result = $parameterReflection->isPromoted();
var_dump($result);
// Check the returned value type before using the result.
echo "\nResult type: " . get_debug_type($result);
Output:
bool(false)
Result type: bool
Explanation: Only constructor property promotion produces this metadata.
Practical Example: Check a signature before building a call
This final case shows how the same API can be used when inspecting application definitions.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_PARAMETER)]
class Validated { public function __construct(public string $rule) {} }
function submitOrder(#[Validated('positive')] int $quantity, string $currency = 'USD', ?string $note = null): void {}
function updateCounter(int &$total): void { $total++; }
function collectNames(string ...$names): void {}
class OrderRequest { public function __construct(public readonly int $identifier, public string $label = 'New') {} }
$functionReflection = new ReflectionMethod(OrderRequest::class, "__construct");
$parameterReflection = $functionReflection->getParameters()[1];
$result = $parameterReflection->isPromoted();
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:
bool(true)
Status: yes
Explanation: ReflectionProperty::isPromoted inspects the corresponding property.
Important Behavior and Edge Cases
- Only constructor property promotion produces this metadata.
- ReflectionProperty::isPromoted inspects the corresponding property.
- 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 |
|---|---|
ReflectionParameter::isPromoted() | Identifies constructor parameters that also declare object properties. |
Related API | ReflectionProperty::isPromoted inspects the corresponding property. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Ignoring this condition: Only constructor property promotion produces this metadata. | Handle the specific limitation: Only constructor property promotion produces this metadata. |
| Confusing this method with Related API | ReflectionProperty::isPromoted inspects the corresponding property. |
Key Takeaways
- Identifies constructor parameters that also declare object properties.
- Only constructor property promotion produces this metadata.
- ReflectionProperty::isPromoted inspects the corresponding property.
Use ReflectionParameter::isPromoted() when you need the precise metadata or behavior demonstrated above. Keep the target declaration and relevant PHP version in mind when adapting the examples.