PHP-8-Fehler, die alten Code stoppen #

Teil 4, Kapitel 4. In diesem Kapitel geht es um die Änderungen in PHP 8.0, die Code, der früher mit einer Warnung oder stillschweigend lief, in einen Error oder TypeError verwandeln, der die Anfrage abbricht. Sie sind das Erste, was Sie beheben, denn solange die Seite leer bleibt, lässt sich nichts anderes testen. Jedes Beispiel stammt aus einer echten Erweiterung und nennt den Commit, der es behoben hat.

Wie sich diese Fehler zeigen #

Auf einer Entwicklungskopie mit eingeschalteter Debug-Ausgabe liefert ein fataler Fehler eine Meldung, eine Datei und eine Zeile. Im Produktivbetrieb liefert er eine leere Seite oder die Fehlerseite des Kernels, und die Meldung steht im PHP-Fehlerlog und in var/log/error.log. Die Meldung beginnt immer mit der Art des Fehlers:

1. Nackte Wörter sind keine Strings mehr #

PHP 7 machte aus einer undefinierten Konstante den String ihres Namens, mit einer Warnung. PHP 8 bricht ab. Alte ezinfo.php-Dateien sind die häufigste Fundstelle. Aus se7enxweb/expsite_installer, Commit 0c771fe:

// before: Name, Version ... are undefined constants
return array( Name => "expsite_installer",
              Version => "1.0.1",
              info_url => "https://github.com/se7enxweb/expsite_installer" );

// after
return array( 'Name' => "expsite_installer",
              'Version' => "1.0.1",
              'Info_url' => "https://github.com/se7enxweb/expsite_installer" );

Beachten Sie die zweite Korrektur in denselben Zeilen: Der Schlüssel, den die Seite „Über“ liest, ist Info_url, nicht info_url. Suchen Sie nach nackten Wörtern in Array-Schlüsseln und in Zugriffen der Form $array[key]:

grep -rnE '\$[A-Za-z_][A-Za-z0-9_]*\[\s*[A-Za-z_][A-Za-z0-9_]*\s*\]' --include='*.php' .
grep -rnE '^\s*(return array\(\s*)?[A-Za-z_][A-Za-z0-9_]*\s*=>' --include='*.php' .

Jeder Treffer ist eine Zeile zum Ansehen: Eine echte Konstante wie PHP_EOL oder eine Klassenkonstante ist in Ordnung, ein Wort, das als String gemeint ist, braucht Anführungszeichen.

2. Statisch aufgerufene Instanzmethoden #

PHP 7 erlaubte ClassName::method() auf einer Methode ohne static, mit einem Deprecation-Hinweis, und $this war darin undefiniert. PHP 8 wirft eine Ausnahme. Aus se7enxweb/sevenx_themes_media, Commit f7d93c0, in einem Template-Operator:

// before: classAttributeContent() is an instance method of eZSelectionType
$classContent = eZSelectionType::classAttributeContent( $classAttr );

// after: ask the class attribute for its content, which calls the datatype for you
$classContent = $classAttr->attribute( 'content' );

Die allgemeine Lösung ist, sich zuerst eine Instanz zu holen oder, wie hier, den übergeordneten Aufruf zu verwenden, den der Kernel anbietet. Lesen Sie die Kernel-Methode, bevor Sie irgendetwas static hinzufügen: Wenn sie $this verwendet, kann sie nicht statisch sein.

3. Eingebaute Funktionen prüfen ihre Argumenttypen #

Die meisten eingebauten Funktionen werfen jetzt einen TypeError, wenn sie einen Typ erhalten, mit dem sie nichts anfangen können. Die, auf die alter Code am häufigsten trifft:

Aus se7enxweb/explayouts_ui_api, Commit 2a95edc: Ein Block, dessen Definition keine Einstellungen hatte, ließ den Handler bei false, und method_exists() brach die ganze Anfrage ab, sodass die Seitenleiste des Editors endlos lud:

// before
$itemViewTypes = method_exists( $handler, 'getItemViewTypes' ) ? $handler->getItemViewTypes() : array();

// after
$itemViewTypes = is_object( $handler ) && method_exists( $handler, 'getItemViewTypes' )
    ? $handler->getItemViewTypes()
    : array();

implode() mit den Argumenten in der alten Reihenfolge wurde bei der Prüfung für PHP 8.0 im OAuth-Modul des Kernels, in ezstarrating und in swark gefunden (PHP-8.0-Unterstützung).

4. Zu wenige Argumente #

Eine Benutzerfunktion mit weniger Argumenten aufzurufen, als sie verlangt, war eine Warnung; jetzt ist es ein ArgumentCountError. Ebenso der Aufruf einer eingebauten Funktion ohne ein Argument, das sie braucht: crypt() ohne Salt war einer der Befunde in der LDAP-Benutzerklasse des Kernels, behoben mit einem zufälligen Passwort aus random_bytes().

Auch das Gegenteil zählt: Eine Funktion, die in einem späteren PHP ein Argument hinzubekommen hat, ergibt auf dem älteren einen ArgumentCountError. fputcsv() mit seinem $eol-Argument (hinzugefügt in PHP 8.1) bricht auf PHP 8.0 ab, daher verzweigt der Kernel dort anhand von PHP_VERSION_ID.

5. Methoden, die nicht zu ihrer Elternklasse passen #

PHP 8 prüft beim Laden der Klasse jede Methode, die eine Methode der Elternklasse überschreibt. Eine Abweichung ist ein fataler Fehler, auch wenn die Methode nie aufgerufen wird. Zwei Beispiele aus der Prüfung für PHP 8.0:

Um so einen Fehler zu beheben, öffnen Sie die Elternklasse im Kernel und übernehmen Sie ihre Signatur genau: dieselben Parameter, dieselben Standardwerte, dieselben Referenzzeichen. Sie dürfen am Ende optionale Parameter hinzufügen; Sie dürfen keine entfernen.

6. Methoden, die es nie gab #

Alter Code ruft manchmal eine Methode auf, die nicht existiert, in einem Zweig, der nie erreicht wurde oder nur mit einer durch @ verschluckten Warnung. PHP 8 macht den Zweig fatal. Aus se7enxweb/explayouts_site_api, Commit 031d380:

// before: eZURLAliasML::fetchByNodeID() does not exist
return '/' . eZURLAliasML::fetchByNodeID( $value->mainLocationId() );

// after
$node = $value->mainLocationId() > 0 ? eZContentObjectTreeNode::fetch( (int)$value->mainLocationId() ) : null;
return $node instanceof eZContentObjectTreeNode ? '/' . $node->attribute( 'url_alias' ) : '';

Wann immer Sie in altem Code einen Kernel-Klassennamen sehen, prüfen Sie, ob die Methode existiert, bevor Sie ihr vertrauen:

grep -n "function fetchByNodeID" kernel/classes/ezurlaliasml.php

7. Entfernte Funktionen #

Der Aufruf einer Funktion, die PHP entfernt hat (each(), create_function(), split(), ereg(), mysql_query() ...), ergibt Call to undefined function. Diese haben ein eigenes Kapitel: Entfernte PHP-Funktionen und ihr Ersatz.

8. Konstruktoren, die nicht aufgerufen werden #

Dies ist überhaupt kein Fehler, und genau das macht es schlimmer: PHP 8 führt eine Methode mit dem Namen ihrer Klasse nicht mehr als Konstruktor aus, also wird das Objekt erzeugt, ohne eingerichtet zu werden, und der Fehler tritt später an einer anderen Stelle auf. Siehe Konstruktoren alten Stils und statische Aufrufe.

Ein Test, der die meisten findet #

Führen Sie jeden Einstiegspunkt einmal mit eingeschalteter Debug-Ausgabe aus, wobei jeder Fehler gemeldet wird:

php -d error_reporting=-1 -d display_errors=1 bin/php/ezexec.php extension/myoldext/bin/php/somescript.php

Öffnen Sie Webseiten jeweils mit eingeschalteter Debug-Ausgabe. Für Klassen findet ein kleines Skript, das sie nur lädt, Signaturabweichungen sofort:

<?php
// extension/myoldext/tests/load_all_classes.php: run with php bin/php/ezexec.php
$autoload = include 'var/autoload/ezp_extension.php';
foreach ( $autoload as $class => $file )
{
    if ( strpos( $file, 'extension/myoldext/' ) === 0 && !class_exists( $class ) && !interface_exists( $class ) )
    {
        echo "Not loaded: $class ($file)\n";
    }
}
echo "Done\n";

Das Laden einer Klasse kompiliert alle ihre Methoden, daher erscheint hier jeder „must be compatible“-Fehler, ob die Methode je aufgerufen wird oder nicht.

Verwandte Seiten #

• Zurück: Bestandsaufnahme einer alten Erweiterung
• Weiter: Veraltetes in PHP 8.1 bis 8.5
• PHP-8.0-Unterstützung
• Inkompatible Änderungen in PHP 8.0 im PHP-Handbuch
• Erweiterungen debuggen
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.