Partially fix GH-16317: SimpleXML does not allow __debugInfo() overrides to work

If only we did not have the pseudo-key "@attributes", we could've just
removed the custom get_debug_info implementation and this would work out
of the box. Anyway, we just have to manually check for an override now.

Closes GH-20131.

Author: ndossche

NEWS

@@ -22,6 +22,10 @@ PHP                                                                        NEWS
 - Random:
   . Fix Randomizer::__serialize() w.r.t. INDIRECTs. (nielsdos)
 
+- SimpleXML:
+  . Partially fixed bug GH-16317 (SimpleXML does not allow __debugInfo() overrides
+    to work). (nielsdos)
+
 - XMLReader:
   . Fix arginfo/zpp violations when LIBXML_SCHEMAS_ENABLED is not available.
     (nielsdos)

ext/simplexml/simplexml.c

@@ -1225,12 +1225,12 @@ static HashTable *sxe_get_properties(zend_object *object) /* {{{ */
 }
 /* }}} */
 
-static HashTable * sxe_get_debug_info(zend_object *object, int *is_temp) /* {{{ */
+/* This custom handler exists because the var_dump adds a pseudo "@attributes" key. */
+PHP_METHOD(SimpleXMLElement, __debugInfo)
 {
-	*is_temp = 1;
-	return sxe_get_prop_hash(object, 1);
+	ZEND_PARSE_PARAMETERS_NONE();
+	RETURN_ARR(sxe_get_prop_hash(Z_OBJ_P(ZEND_THIS), 1));
 }
-/* }}} */
 
 static int sxe_objects_compare(zval *object1, zval *object2) /* {{{ */
 {
@@ -2733,7 +2733,6 @@ PHP_MINIT_FUNCTION(simplexml)
 	sxe_object_handlers.compare = sxe_objects_compare;
 	sxe_object_handlers.cast_object = sxe_object_cast;
 	sxe_object_handlers.count_elements = sxe_count_elements;
-	sxe_object_handlers.get_debug_info = sxe_get_debug_info;
 	sxe_object_handlers.get_closure = NULL;
 	sxe_object_handlers.get_gc = sxe_get_gc;
 

ext/simplexml/simplexml.stub.php

@@ -51,6 +51,8 @@ public function getName(): string {}
 
     public function __toString(): string {}
 
+    public function __debugInfo(): ?array {}
+
     /** @tentative-return-type */
     public function count(): int {}
 

ext/simplexml/simplexml_arginfo.h

@@ -0,0 +1,22 @@
+--TEST--
+GH-16317 (SimpleXML does not allow __debugInfo() overrides to work)
+--FILE--
+<?php
+
+class MySXE extends SimpleXMLElement {
+    public function __debugInfo(): array {
+        echo "invoked\n";
+        return ['x' => 1];
+    }
+}
+
+$sxe = simplexml_load_string('<root><a/></root>', MySXE::class);
+var_dump($sxe);
+
+?>
+--EXPECT--
+invoked
+object(MySXE)#1 (1) {
+  ["x"]=>
+  int(1)
+}