When building tools that inspect PHP code, ReflectionProperty::isPromoted() helps answer a focused question: checks whether a property originated from constructor property promotion.
Reflection is useful in framework tooling, dependency injection, testing, code inspection and debugging.
What Is ReflectionProperty::isPromoted()?
Checks whether a property originated from constructor property promotion.
Its method signature is:
public function isPromoted(): bool
This method has no required arguments.
Return value: bool
Example 1: Inspect a property declaration
Start with a self-contained PHP declaration and inspect the method result.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_PROPERTY)]
class FieldLabel { public function __construct(public string $label) {} }
class BaseData { protected string $source = 'local'; }
class CustomerData extends BaseData {
#[FieldLabel('identity')]
public string $name = 'Morgan';
public private(set) string $token = 'abc';
public protected(set) int $level = 1;
public readonly int $identifier;
public static int $counter = 3;
public string $label { get => strtoupper($this->name); }
public string $initials { get => substr($this->name, 0, 1); }
final public string $finalLabel { get => $this->name; }
public int $delayed;
public function __construct(public string $city = 'Rome') { $this->identifier = 10; }
}
$propertyReflection = new ReflectionProperty(CustomerData::class, "city");
$result = $propertyReflection->isPromoted();
var_dump($result);
Output:
bool(true)
Explanation: Checks whether a property originated from constructor property promotion.
Example 2: Explore another property context
Next, change the reflected declaration or parameter to observe a related situation.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_PROPERTY)]
class FieldLabel { public function __construct(public string $label) {} }
class BaseData { protected string $source = 'local'; }
class CustomerData extends BaseData {
#[FieldLabel('identity')]
public string $name = 'Morgan';
public private(set) string $token = 'abc';
public protected(set) int $level = 1;
public readonly int $identifier;
public static int $counter = 3;
public string $label { get => strtoupper($this->name); }
public string $initials { get => substr($this->name, 0, 1); }
final public string $finalLabel { get => $this->name; }
public int $delayed;
public function __construct(public string $city = 'Rome') { $this->identifier = 10; }
}
$propertyReflection = new ReflectionProperty(CustomerData::class, "name");
$result = $propertyReflection->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: Promoted properties are also constructor parameters.
Practical Example: Apply reflection to a data model
This final case shows how the same API can be used when inspecting application definitions.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_PROPERTY)]
class FieldLabel { public function __construct(public string $label) {} }
class BaseData { protected string $source = 'local'; }
class CustomerData extends BaseData {
#[FieldLabel('identity')]
public string $name = 'Morgan';
public private(set) string $token = 'abc';
public protected(set) int $level = 1;
public readonly int $identifier;
public static int $counter = 3;
public string $label { get => strtoupper($this->name); }
public string $initials { get => substr($this->name, 0, 1); }
final public string $finalLabel { get => $this->name; }
public int $delayed;
public function __construct(public string $city = 'Rome') { $this->identifier = 10; }
}
$propertyReflection = new ReflectionProperty(CustomerData::class, "city");
$result = $propertyReflection->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: ReflectionParameter::isPromoted checks the parameter view.
Important Behavior and Edge Cases
- Promoted properties are also constructor parameters.
- ReflectionParameter::isPromoted checks the parameter view.
- 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 |
|---|---|
ReflectionProperty::isPromoted() | Checks whether a property originated from constructor property promotion. |
Related API | ReflectionParameter::isPromoted checks the parameter view. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Ignoring this condition: Promoted properties are also constructor parameters. | Handle the specific limitation: Promoted properties are also constructor parameters. |
| Confusing this method with Related API | ReflectionParameter::isPromoted checks the parameter view. |
Key Takeaways
- Checks whether a property originated from constructor property promotion.
- Promoted properties are also constructor parameters.
- ReflectionParameter::isPromoted checks the parameter view.
Use ReflectionProperty::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.