Added automatic resolving of the class that defined a property or method

betterphp · betterphp · commit 97169c78df03 · 2016-12-09T19:09:07.000Z
diff --git a/tests/example_classes.php b/tests/example_classes.php
@@ -4,8 +4,8 @@
 
 class example_class {
 
-    private $example_string_property;
-    private $example_array_property;
+    protected $example_string_property;
+    protected $example_array_property;
 
     public function __construct() {
         $this->example_string_property = uniqid();
@@ -25,3 +25,15 @@ public function get_value($property_name) {
     }
 
 }
+
+class example_child_class extends example_class {
+
+    protected $example_child_string_property;
+
+    public function __construct() {
+        $this->example_child_string_property = uniqid();
+
+        parent::__construct();
+    }
+
+}
diff --git a/tests/utils/ReflectionTest.php b/tests/utils/ReflectionTest.php
@@ -14,13 +14,16 @@
 class ReflectionTest extends TestCase {
 
     private $example_object;
+    private $example_child_object;
 
     public function setUp() {
         $this->example_object = new example_class();
+        $this->example_child_object = new example_child_class();
     }
 
     public function tearDown() {
         unset($this->example_object);
+        unset($this->example_child_object);
     }
 
     /**
@@ -41,6 +44,26 @@ public function dataGetProperty(): array {
         ];
     }
 
+    /**
+     * @dataProvider dataGetPropertyFromChild
+     */
+    public function testGetPropertyFromChild(string $property_name, string $expected_type) {
+        $reflected_value = reflection::get_property($this->example_child_object, $property_name);
+        $actual_value = $this->example_child_object->get_value($property_name);
+
+        $this->assertInternalType($expected_type, $reflected_value);
+        $this->assertSame($actual_value, $reflected_value);
+    }
+
+    public function dataGetPropertyFromChild(): array {
+        return array_merge(
+            $this->dataGetProperty(),
+            [
+                ['example_child_string_property', 'string'],
+            ]
+        );
+    }
+
     public function testSetProperty() {
         $expected_value = 'wow such value';
         $property_name = 'example_string_property';
diff --git a/utils/reflection.php b/utils/reflection.php
@@ -6,6 +6,30 @@
 
 class reflection {
 
+    /**
+     * Search for the class name that a property is defined in. This is useful
+     * as the reflection API uses that and not the class of the actual object.
+     *
+     * @param string $class_name The name of the starting class
+     * @param string $name The name of the thing to search for
+     * @param boolean $method If the thing being serched for is a method
+     *
+     * @return string The name of the owner class
+     */
+    private static function resolve_class(string $class_name, string $name, bool $method): string {
+        $exists = ($method) ? 'method_exists' : 'property_exists';
+
+        do {
+            if ($exists($class_name, $name)) {
+                return $class_name;
+            }
+
+            $class_name = get_parent_class($class_name);
+        } while ($class_name !== false);
+
+        throw new \Exception("Unable to find class for the property {$property_name}");
+    }
+
     /**
      * Gets the value of an object property
      *
@@ -15,7 +39,8 @@ class reflection {
      * @return mixed The value
      */
     public static function get_property($object, string $property_name) {
-        $property = new \ReflectionProperty(get_class($object), $property_name);
+        $class_name = static::resolve_class(get_class($object), $property_name, false);
+        $property = new \ReflectionProperty($class_name, $property_name);
         $property->setAccessible(true);
 
         return $property->getValue($object);
@@ -31,7 +56,8 @@ public static function get_property($object, string $property_name) {
      * @return void
      */
     public static function set_property($object, string $property_name, $value) {
-        $property = new \ReflectionProperty(get_class($object), $property_name);
+        $class_name = static::resolve_class(get_class($object), $property_name, false);
+        $property = new \ReflectionProperty($class_name, $property_name);
         $property->setAccessible(true);
 
         $property->setValue($object, $value);
