php / php/php-src

Lots of classes do not allow `__debugInfo()` overrides to work

Ouverte
#16,317 9 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Bug Status: Verified
Langage dominant
C
Étoiles
40.4k
Forks
8.1k
Merge moyen
2 j 13 h
PR mergées (30 j)
96

Description

Description

Inspired by #11310, I wrote a quick test script to check if there were other classes where creating a subclass with a __debugInfo() method did not work. I found a number of such classes (the one seg fault I filed separately at #16316 since that is a bigger issue than the override just not working).

I tested against b675db4c56dd0de4ea1f5195d587ed90f0096ed8

I did not test against all extensions, `php -m` output provided
[PHP Modules]
bcmath
calendar
Core
ctype
curl
date
dba
dom
enchant
exif
FFI
fileinfo
filter
ftp
gd
gettext
gmp
hash
iconv
intl
json
ldap
libxml
mbstring
mysqli
mysqlnd
odbc
openssl
pcntl
pcre
PDO
pdo_dblib
PDO_Firebird
pdo_mysql
PDO_ODBC
pdo_pgsql
pdo_sqlite
pgsql
Phar
posix
random
readline
Reflection
session
shmop
SimpleXML
snmp
soap
sockets
sodium
SPL
sqlite3
standard
sysvmsg
sysvsem
sysvshm
tidy
tokenizer
xml
xmlreader
xmlwriter
xsl
zend_test
zip
zlib

Approach: create a custom subclass with an empty constructor, and a __debugInfo() method returning ['x' => 'y']. The var_dump() a new instance of that subclass and check the output.

I found 17 classes across the DOM and SimpleXML extension where doing this caused an exception to be thrown relating to invalid state, e.g.

<?php

class Demo extends DOMNode {
    public function __construct() {}
    public function __debugInfo(): array {
        return ['x' => 'y'];
    }
}

var_dump( new Demo() );
List of the 17 classes
DOMNode::class,
DOMNameSpaceNode::class,
DOMDocumentFragment::class,
DOMDocument::class,
DOMCharacterData::class,
DOMAttr::class,
DOMElement::class,
DOMText::class,
DOMComment::class,
DOMCdataSection::class,
DOMDocumentType::class,
DOMNotation::class,
DOMEntity::class,
DOMEntityReference::class,
DOMProcessingInstruction::class,

SimpleXMLElement::class,
SimpleXMLIterator::class,

I also found a further 20 classes where the override does not seem to work, across multiple extensions.

List of those classes
array (
  0 => 'DatePeriod',
  1 => 'DOMImplementation',
  2 => 'Dom\\Implementation',
  3 => 'DOMNodeList',
  4 => 'Dom\\NodeList',
  5 => 'DOMNamedNodeMap',
  6 => 'Dom\\NamedNodeMap',
  7 => 'Dom\\DtdNamedNodeMap',
  8 => 'Dom\\HTMLCollection',
  9 => 'IntlTimeZone',
  10 => 'IntlCalendar',
  11 => 'IntlGregorianCalendar',
  12 => 'IntlBreakIterator',
  13 => 'IntlRuleBasedBreakIterator',
  14 => 'IntlCodePointBreakIterator',
  15 => 'SplFixedArray',
  16 => 'mysqli',
  17 => 'mysqli_result',
  18 => 'mysqli_stmt',
  19 => 'XMLReader',
)

You can see the script I used at https://gist.github.com/DanielEScherzer/c979c15b47bc603758c4c38ba25dd510

PHP Version

dev-master

Operating System

No response

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par le script de reproduction lié et ses vérifications avec var_dump, puis examinez les classes DOM, SimpleXML et les autres classes concernées indiquées. Reproduisez les exceptions d’état invalide et les remplacements qui ne fonctionnent pas dans les classes signalées ; le travail est terminé lorsque le comportement de __debugInfo() dans les sous-classes fonctionne de manière cohérente sans ces exceptions.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
c, php
Domaine
backend
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.