Skip to content

GH-16317: allow __debugInfo() overrides in mysqli classes #16543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

GH-16317: allow __debugInfo() overrides in mysqli classes #16543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions ext/mysqli/mysqli.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,10 @@ static int mysqli_object_has_property(zend_object *object, zend_string *name, in

HashTable *mysqli_object_get_debug_info(zend_object *object, int *is_temp)
{
/* GH-16317: allow subclasses to use __debugInfo() */
if (object->ce->__debugInfo != NULL) {
return zend_std_get_debug_info(object, is_temp);
}
mysqli_object *obj = php_mysqli_fetch_object(object);
HashTable *retval, *props = obj->prop_handler;
mysqli_prop_handler *entry;
Expand Down
45 changes: 45 additions & 0 deletions ext/mysqli/tests/gh16317.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
--TEST--
GH-16317 (__debugInfo() overrides don't work)
--EXTENSIONS--
mysqli
--FILE--
<?php

class subclass_mysqli extends mysqli {
public function __construct() {}
public function __debugInfo(): array {
return ['a' => 'b'];
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps a test for seeing that you can call parent::__debugInfo() might be useful to add here as well for the different subclasses

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Except the parent classes don't define those methods? There isn't a parent method to call

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm interesting if the internals of mysqli fills out an implementation for __debugInfo, then I would almost argue that is a secondary bug and it should properly expose such /or any other internal class that does similar).

Just tested and confirmed the patch with without my above comment too.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want to file that bug I might be able to work on it

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Internal classes faking methods that are supposed to exists in userland is indeed a long standing issue. E.g. Internal classes don't have a default constructor... i.e. https://3v4l.org/SIMVn#v8.4.2

So I think the best and most consistent solution would be to add the debugInfo() method instead of patching the handler. As far as I see, the get_debug_info object handler of mysqli classes are just performance optimizations (the __debugInfo()method doesn't have to be called). Since performance is not a concern in case of a debug messages, it's not a problem at all if we use the magic method instead of the handler.

In any case, as this idea may be controversial, other maintainers should also express their preference how to best solve the problem before continuing the implementation...

BTW: I suspected that we have similar issues with other object handlers, but I was not able to find any other issues (initially I thought that at least I can find issues with the *_dimension handlers)

}
}
var_dump( new subclass_mysqli() );

class subclass_mysqli_result extends mysqli_result {
public function __construct() {}
public function __debugInfo(): array {
return ['o' => 'p'];
}
}
var_dump( new subclass_mysqli_result() );

class subclass_mysqli_stmt extends mysqli_stmt {
public function __construct() {}
public function __debugInfo(): array {
return ['x' => 'y'];
}
}
var_dump( new subclass_mysqli_stmt() );

?>
--EXPECT--
object(subclass_mysqli)#1 (1) {
["a"]=>
string(1) "b"
}
object(subclass_mysqli_result)#1 (1) {
["o"]=>
string(1) "p"
}
object(subclass_mysqli_stmt)#1 (1) {
["x"]=>
string(1) "y"
}