ReflectionClass::getProperty

(PHP 5, PHP 7, PHP 8)

ReflectionClass::getPropertyGets a ReflectionProperty for a class's property

Description

public ReflectionClass::getProperty(string $name): ReflectionProperty

Gets a ReflectionProperty for a class's property.

Parameters

name

The property name.

Return Values

A ReflectionProperty.

Examples

Example #1 Basic usage of ReflectionClass::getProperty()

<?php
$class
= new ReflectionClass('ReflectionClass');
$property = $class->getProperty('name');
var_dump($property);
?>

The above example will output:

object(ReflectionProperty)#2 (2) {
  ["name"]=>
  string(4) "name"
  ["class"]=>
  string(15) "ReflectionClass"
}

See Also

add a note

User Contributed Notes 2 notes

up
35
eric at naeseth dot com
13 years ago
If the class doesn't have a property with the given name, a ReflectionException will be raised.
up
10
dohpaz42
9 years ago
Accessing private properties is possible, but care must be taken if that private property was defined lower into the inheritance chain. For example, if class A extends class B, and class B defines a private property called 'foo', getProperty will throw a ReflectionException.

Instead, you can loop over getParentClass until it returns false to look for the private property, at which point you can access and/or modify its value as needed.
To Top