Add ReflectionProperty::getMangledName()

NEWS

@@ -187,6 +187,7 @@ PHP                                                                        NEWS
     zval for uninitialized typed properties). (nielsdos)
   . Fixed bug GH-15766 (ReflectionClass::toString() should have better output
     for enums). (DanielEScherzer)
+  . Added ReflectionProperty::getMangledName() method. (alexandre-daubois)
 
 - Session:
   . session_start() throws a ValueError on option argument if not a hashmap

UPGRADING

@@ -420,6 +420,7 @@ PHP 8.5 UPGRADE NOTES
     ReflectionConstant::getExtensionName() were introduced.
   . ReflectionConstant::getAttributes() was introduced.
     RFC: https://wiki.php.net/rfc/attributes-on-constants
+  . ReflectionProperty::getMangledName() was introduced.
 
 - Sqlite:
   . Sqlite3Stmt::busy to check if a statement had been fetched

ext/reflection/php_reflection.c

@@ -5753,6 +5753,21 @@ ZEND_METHOD(ReflectionProperty, getName)
 }
 /* }}} */
 
+ZEND_METHOD(ReflectionProperty, getMangledName)
+{
+	reflection_object *intern;
+	property_reference *ref;
+
+	ZEND_PARSE_PARAMETERS_NONE();
+
+	GET_REFLECTION_OBJECT_PTR(ref);
+	if (ref->prop == NULL) {
+	    RETURN_STR_COPY(ref->unmangled_name);
+	}
+
+	RETURN_STR_COPY(ref->prop->name);
+}
+
 static void _property_check_flag(INTERNAL_FUNCTION_PARAMETERS, int mask) /* {{{ */
 {
 	reflection_object *intern;

ext/reflection/php_reflection.stub.php

@@ -482,6 +482,8 @@ public function __toString(): string {}
     /** @tentative-return-type */
     public function getName(): string {}
 
+    public function getMangledName(): string {}
+
     /** @tentative-return-type */
     public function getValue(?object $object = null): mixed {}
 

ext/reflection/tests/ReflectionProperty_getMangledName_basic.phpt

@@ -0,0 +1,43 @@
+--TEST--
+Test ReflectionProperty::getMangledName() method
+--FILE--
+<?php
+
+class TestClass {
+    public $publicProp = 'public';
+    protected $protectedProp = 'protected';
+    private $privateProp = 'private';
+}
+
+function testMangledName($class, $property) {
+    $reflection = new ReflectionProperty($class, $property);
+    echo "Property: $property\n";
+    echo "getName(): " . $reflection->getName() . "\n";
+    echo "getMangledName(): " . $reflection->getMangledName() . "\n";
+
+    $obj = new $class();
+    $array = (array) $obj;
+    echo "In array cast: " . (array_key_exists($reflection->getMangledName(), $array) ? "found" : "not found") . "\n";
+    echo "\n";
+}
+
+testMangledName('TestClass', 'publicProp');
+testMangledName('TestClass', 'protectedProp');  
+testMangledName('TestClass', 'privateProp');
+
+?>
+--EXPECTF--
+Property: publicProp
+getName(): publicProp
+getMangledName(): publicProp
+In array cast: found
+
+Property: protectedProp
+getName(): protectedProp
+getMangledName(): %0*%0protectedProp
+In array cast: found
+
+Property: privateProp
+getName(): privateProp
+getMangledName(): %0TestClass%0privateProp
+In array cast: found

ext/reflection/tests/ReflectionProperty_getMangledName_dynamic.phpt

@@ -0,0 +1,99 @@
+--TEST--
+Test ReflectionProperty::getMangledName() with dynamic properties
+--FILE--
+<?php
+
+echo "=== Testing stdClass with dynamic properties ===\n";
+$stdObj = new stdClass();
+$stdObj->prop1 = 'value1';
+$stdObj->{'special-name'} = 'special value';
+$stdObj->{'123numeric'} = 'numeric start';
+
+function testDynamicProperty($obj, $property, $description) {
+    try {
+        $reflection = new ReflectionProperty($obj, $property);
+        echo "$description:\n";
+        echo "  getName(): " . $reflection->getName() . "\n";
+        echo "  getMangledName(): " . $reflection->getMangledName() . "\n";
+
+        $array = (array) $obj;
+        echo "  Found in array cast: " . (array_key_exists($reflection->getMangledName(), $array) ? "yes" : "no") . "\n";
+        echo "\n";
+    } catch (ReflectionException $e) {
+        echo "$description: EXCEPTION - " . $e->getMessage() . "\n\n";
+    }
+}
+
+testDynamicProperty($stdObj, 'prop1', 'stdClass property prop1');
+testDynamicProperty($stdObj, 'special-name', 'stdClass property with special name');
+testDynamicProperty($stdObj, '123numeric', 'stdClass property starting with number');
+
+echo "=== Testing regular class with dynamic properties ===\n";
+#[AllowDynamicProperties]
+class TestClass {
+    public $existing = 'existing';
+}
+
+$obj = new TestClass();
+$obj->dynamic = 'dynamic value';
+$obj->anotherDynamic = 'another dynamic';
+
+testDynamicProperty($obj, 'dynamic', 'Regular class dynamic property');
+testDynamicProperty($obj, 'anotherDynamic', 'Regular class another dynamic property');
+
+$reflection = new ReflectionProperty($obj, 'existing');
+echo "Regular property:\n";
+echo "  getName(): " . $reflection->getName() . "\n";
+echo "  getMangledName(): " . $reflection->getMangledName() . "\n";
+
+echo "\n=== Testing ReflectionProperty from class vs instance ===\n";
+try {
+    $reflection = new ReflectionProperty('TestClass', 'dynamic');
+    echo "This should not be reached\n";
+} catch (ReflectionException $e) {
+    echo "Expected exception for class-based reflection: " . $e->getMessage() . "\n";
+}
+
+try {
+    $reflection = new ReflectionProperty($obj, 'dynamic');
+    echo "Instance-based reflection works: " . $reflection->getMangledName() . "\n";
+} catch (ReflectionException $e) {
+    echo "Unexpected exception: " . $e->getMessage() . "\n";
+}
+
+?>
+--EXPECT--
+=== Testing stdClass with dynamic properties ===
+stdClass property prop1:
+  getName(): prop1
+  getMangledName(): prop1
+  Found in array cast: yes
+
+stdClass property with special name:
+  getName(): special-name
+  getMangledName(): special-name
+  Found in array cast: yes
+
+stdClass property starting with number:
+  getName(): 123numeric
+  getMangledName(): 123numeric
+  Found in array cast: yes
+
+=== Testing regular class with dynamic properties ===
+Regular class dynamic property:
+  getName(): dynamic
+  getMangledName(): dynamic
+  Found in array cast: yes
+
+Regular class another dynamic property:
+  getName(): anotherDynamic
+  getMangledName(): anotherDynamic
+  Found in array cast: yes
+
+Regular property:
+  getName(): existing
+  getMangledName(): existing
+
+=== Testing ReflectionProperty from class vs instance ===
+Expected exception for class-based reflection: Property TestClass::$dynamic does not exist
+Instance-based reflection works: dynamic

ext/reflection/tests/ReflectionProperty_getMangledName_inheritance.phpt

@@ -0,0 +1,87 @@
+--TEST--
+Test ReflectionProperty::getMangledName() with inheritance
+--FILE--
+<?php
+
+class ParentClass {
+    public $public = 'parent_public';
+    protected $protected = 'parent_protected';
+    private $private = 'parent_private';
+    private $parentOnly = 'parent_only_private';
+}
+
+class ChildClass extends ParentClass {
+    private $private = 'child_private';
+    protected $childProp = 'child_protected';
+}
+
+function testProperty($class, $property) {
+    $reflection = new ReflectionProperty($class, $property);
+    $obj = new $class();
+    $array = (array) $obj;
+
+    echo "Class: $class, Property: \$$property\n";
+    echo "Mangled name: '" . $reflection->getMangledName() . "'\n";
+    echo "Key exists in array cast: " . (array_key_exists($reflection->getMangledName(), $array) ? "yes" : "no") . "\n";
+    echo "\n";
+}
+
+testProperty('ParentClass', 'public');
+testProperty('ParentClass', 'protected');
+testProperty('ParentClass', 'private');
+
+testProperty('ChildClass', 'public');
+testProperty('ChildClass', 'protected');
+testProperty('ChildClass', 'childProp');
+testProperty('ChildClass', 'private');
+
+echo "Access to parent's private property not in child:\n";
+
+try {
+    $reflection = new ReflectionProperty('ChildClass', 'parentOnly');
+    echo "ERROR: Should have failed\n";
+} catch (ReflectionException $e) {
+    echo "Instance-based creation failed as expected: " . $e->getMessage() . "\n";
+}
+
+try {
+    $obj = new ChildClass();
+    $reflection = new ReflectionProperty($obj, 'parentOnly');
+    echo "ERROR: Should have failed\n";
+} catch (ReflectionException $e) {
+    echo "Object-based creation failed as expected: " . $e->getMessage() . "\n";
+}
+
+?>
+--EXPECTF--
+Class: ParentClass, Property: $public
+Mangled name: 'public'
+Key exists in array cast: yes
+
+Class: ParentClass, Property: $protected
+Mangled name: '%0*%0protected'
+Key exists in array cast: yes
+
+Class: ParentClass, Property: $private
+Mangled name: '%0ParentClass%0private'
+Key exists in array cast: yes
+
+Class: ChildClass, Property: $public
+Mangled name: 'public'
+Key exists in array cast: yes
+
+Class: ChildClass, Property: $protected
+Mangled name: '%0*%0protected'
+Key exists in array cast: yes
+
+Class: ChildClass, Property: $childProp
+Mangled name: '%0*%0childProp'
+Key exists in array cast: yes
+
+Class: ChildClass, Property: $private
+Mangled name: '%0ChildClass%0private'
+Key exists in array cast: yes
+
+Access to parent's private property not in child:
+Instance-based creation failed as expected: Property ChildClass::$parentOnly does not exist
+Object-based creation failed as expected: Property ChildClass::$parentOnly does not exist