Nullable-Parameter und Typdeklarationen #

Teil 4, Kapitel 8. Dieses Kapitel behandelt die Deprecation, die Sie in altem Code unter PHP 8.4 und neuer am häufigsten sehen werden, den implizit nullable Parameter, und seinen nahen Verwandten, einen optionalen Parameter vor einem erforderlichen. Außerdem gibt es Regeln, wie Sie altem Code Typdeklarationen hinzufügen, ohne Aufrufer zu brechen.

Die Deprecation #

Deprecated: myOldExtHelper::render(): Implicitly marking parameter $node as nullable is deprecated,
the explicit nullable type must be used instead

Sie stammt von einem Parameter, der eine Klasse oder einen Typ und null als Standardwert hat:

function render( eZContentObjectTreeNode $node = null )

PHP hat hier wegen des Standardwerts schon immer null erlaubt. PHP 8.4 möchte, dass Sie das im Typ ausdrücken.

Die Lösung #

Fügen Sie ein Fragezeichen hinzu:

function render( ?eZContentObjectTreeNode $node = null )

Das ist alles. ?Type funktioniert seit PHP 7.1, die Lösung läuft also auf jedem PHP, das Exponential 6 unterstützt, und Aufrufer sind nicht betroffen: Sie konnten vorher null übergeben und können es weiterhin.

Aus se7enxweb/expsite_api, Commit 0f708f4:

// before
public function __construct( eZContentObject $object = null )

// after
public function __construct( ?eZContentObject $object = null )

Die Commit-Nachricht nennt den Grund, warum es wichtig war: Die alte Form wurde „bei jeder Anfrage gemeldet, die eines erzeugt (die Suchseite tut es)“. se7enxweb/expquery_translator hat in Commit 8ddf68d dieselbe Änderung an 35 Parametern in 27 Dateien vorgenommen und sie mit php -l unter PHP 8.0 und 8.5 sowie mit einer Abfrage durch den Parser auf beiden Versionen überprüft.

Jeden Fall finden #

grep -rnE '[(,]\s*(array|callable|string|int|float|bool|iterable|object|self|[A-Z][A-Za-z0-9_\\]+)\s+&?\$[A-Za-z0-9_]+\s*=\s*null' --include='*.php' extension/myoldext/

Jeder Treffer ohne ? vor dem Typ und ohne |null in einem Union-Typ muss behoben werden. Die eigene Syntaxprüfung von PHP 8.4 meldet sie ebenfalls:

find extension/myoldext -name '*.php' -print0 | xargs -0 -n1 php8.4 -d error_reporting=-1 -l 2>&1 | grep -i nullable

(Verwenden Sie statt php8.4 den Pfad eines PHP-8.4- oder PHP-8.5-Binarys auf Ihrem System.)

Interfaces und Elternklassen #

Wenn der Parameter zu einer Methode gehört, die ein Interface implementiert oder eine Methode der Elternklasse überschreibt, beheben Sie zuerst das Interface oder die Elternklasse, dann jede Implementierung. In se7enxweb/expquery_translator haben sich die abstrakte Methode Visitor::visit( Node $node, ?Visitor $subVisitor = null, $options = null ) und alle ihre Implementierungen im selben Commit geändert. PHP akzeptiert ein Kind, das großzügiger ist als die Elternklasse, daher bleibt bei einer Änderung im selben Commit jeder Schritt ladbar.

Wenn die Elternklasse eine Kernel-Klasse ist, sehen Sie sich die aktuelle Signatur im Kernel an und übernehmen Sie sie. Die Methoden des Kernels selbst wurden zwischen 6.0.8 und 6.0.11 für PHP 8.4 und 8.5 geändert (PHP-8-Unterstützung), daher kann ein Override, der gegen einen älteren Kernel geschrieben wurde, heute von seiner Elternklasse abweichen.

Optionale Parameter vor erforderlichen #

Die zweite Deprecation dieser Familie ist ein Standardwert an einem Parameter, auf den ein erforderlicher folgt:

// a default that can never be used: $handlerParameters is required after it
protected function buildBoostFunctions( $boostFunctions = null, &$handlerParameters )

PHP 8.0 meldet das als veraltet, weil der Standardwert nie greifen kann. Aus se7enxweb/ezfind, Commit 4134cbb:

// after: the default removed, the only caller passes both
protected function buildBoostFunctions( $boostFunctions, &$handlerParameters )

Prüfen Sie jeden Aufrufer, bevor Sie den Standardwert entfernen. Wenn ein Aufrufer das erste Argument weglässt, war er bereits kaputt.

Typdeklarationen zu altem Code hinzufügen #

Typdeklarationen lassen Fehler dort erscheinen, wo sie gemacht werden, statt drei Aufrufe später. Es lohnt sich, sie einer alten Erweiterung hinzuzufügen, aber nur dort, wo Sie jeden Aufrufer kontrollieren.

Typen, die Sie unter PHP 8.0, dem ältesten PHP von Exponential 6, verwenden können: skalare Typen, ?Type, Union-Typen (int|string), mixed, static als Rückgabetyp. Typen, die Sie unter 8.0 nicht verwenden können: never, Intersection-Typen, null oder false als eigenständiger Typ, readonly-Eigenschaften, Enums.

Werte aus dem Kernel sind oft false, wo neuerer Code null verwenden würde. eZContentObject::fetch() liefert null, wenn nichts gefunden wird, aber viele ältere Kernel-Funktionen liefern false. Ein Rückgabetyp ?eZContentObject an Ihrer eigenen Hülle ist falsch, wenn sie ein solches false durchreicht. Prüfen Sie, was die Kernel-Methode zurückgibt, bevor Sie den Typ deklarieren:

<?php
class myOldExtObjectLoader
{
    /**
     * @return eZContentObject|null
     */
    public static function load( int $objectID ): ?eZContentObject
    {
        $object = eZContentObject::fetch( $objectID );
        return $object instanceof eZContentObject ? $object : null;
    }
}

Die instanceof-Prüfung macht aus dem, was der Kernel zurückgegeben hat, den Typ, den Sie versprochen haben.

Verwandte Seiten #

• Zurück: Konstruktoren alten Stils und statische Aufrufe
• Weiter: Dynamische Eigenschaften
• Veraltetes in PHP 8.1 bis 8.5
• Typdeklarationen im PHP-Handbuch
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.