When building tools that inspect PHP code, ReflectionMethod::getPrototype() helps answer a focused question: returns the overridden or implemented method prototype when available.
Reflection is useful in framework tooling, dependency injection, testing, code inspection and debugging.
What Is ReflectionMethod::getPrototype()?
Returns the overridden or implemented method prototype when available.
Its method signature is:
public function getPrototype(): ReflectionMethod
This method has no required arguments.
Return value: ReflectionMethod
Example 1: Inspect a reflected method
Start with a self-contained PHP declaration and inspect the method result.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_METHOD)]
class ActionLabel { public function __construct(public string $label) {} }
interface Action { public function execute(string $message): string; }
abstract class AbstractAction { abstract public function perform(): void; }
class MailAction implements Action {
public function __construct(public string $name = 'Mail') {}
#[ActionLabel('send')]
public function execute(string $message): string { return $this->name . ': ' . $message; }
protected function verify(): bool { return true; }
private function internal(): string { return 'secret'; }
final public function finalize(): string { return 'complete'; }
public static function version(): int { return 2; }
public function __destruct() {}
}
class SmsAction extends MailAction { public function execute(string $message): string { return parent::execute($message); } }
class VerifiedAction extends MailAction { protected function verify(): bool { return false; } }
$methodReflection = new ReflectionMethod(SmsAction::class, "execute");
$result = $methodReflection->getPrototype();
echo $result->getName();
Output:
execute
Explanation: Returns the overridden or implemented method prototype when available.
Example 2: Compare an inherited method
Next, change the reflected declaration or parameter to observe a related situation.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_METHOD)]
class ActionLabel { public function __construct(public string $label) {} }
interface Action { public function execute(string $message): string; }
abstract class AbstractAction { abstract public function perform(): void; }
class MailAction implements Action {
public function __construct(public string $name = 'Mail') {}
#[ActionLabel('send')]
public function execute(string $message): string { return $this->name . ': ' . $message; }
protected function verify(): bool { return true; }
private function internal(): string { return 'secret'; }
final public function finalize(): string { return 'complete'; }
public static function version(): int { return 2; }
public function __destruct() {}
}
class SmsAction extends MailAction { public function execute(string $message): string { return parent::execute($message); } }
class VerifiedAction extends MailAction { protected function verify(): bool { return false; } }
$methodReflection = new ReflectionMethod(SmsAction::class, "execute");
$result = $methodReflection->getPrototype();
echo $result->getName();
// Check the returned value type before using the result.
echo "\nResult type: " . get_debug_type($result);
Output:
execute
Result type: ReflectionMethod
Explanation: Methods without a parent/interface prototype throw ReflectionException.
Practical Example: Inspect application method metadata
This final case shows how the same API can be used when inspecting application definitions.
<?php
declare(strict_types=1);
#[Attribute(Attribute::TARGET_METHOD)]
class ActionLabel { public function __construct(public string $label) {} }
interface Action { public function execute(string $message): string; }
abstract class AbstractAction { abstract public function perform(): void; }
class MailAction implements Action {
public function __construct(public string $name = 'Mail') {}
#[ActionLabel('send')]
public function execute(string $message): string { return $this->name . ': ' . $message; }
protected function verify(): bool { return true; }
private function internal(): string { return 'secret'; }
final public function finalize(): string { return 'complete'; }
public static function version(): int { return 2; }
public function __destruct() {}
}
class SmsAction extends MailAction { public function execute(string $message): string { return parent::execute($message); } }
class VerifiedAction extends MailAction { protected function verify(): bool { return false; } }
$methodReflection = new ReflectionMethod(VerifiedAction::class, "verify");
$result = $methodReflection->getPrototype();
echo $result->getName();
// 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:
verify
Reflection result available
Explanation: hasPrototype safely checks before retrieving it.
Important Behavior and Edge Cases
- Methods without a parent/interface prototype throw ReflectionException.
- hasPrototype safely checks before retrieving it.
- 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 |
|---|---|
ReflectionMethod::getPrototype() | Returns the overridden or implemented method prototype when available. |
Related API | hasPrototype safely checks before retrieving it. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Ignoring this condition: Methods without a parent/interface prototype throw ReflectionException. | Handle the specific limitation: Methods without a parent/interface prototype throw ReflectionException. |
| Confusing this method with Related API | hasPrototype safely checks before retrieving it. |
Key Takeaways
- Returns the overridden or implemented method prototype when available.
- Methods without a parent/interface prototype throw ReflectionException.
- hasPrototype safely checks before retrieving it.
Use ReflectionMethod::getPrototype() when you need the precise metadata or behavior demonstrated above. Keep the target declaration and relevant PHP version in mind when adapting the examples.