mitmario.dev

Eigener Code mit Autoloading

PHP Sandbox 4 Min Lesezeit 3 BeispieleLektion 5 von 7

Bei fünfzig require-Zeilen bindest du irgendwo dieselbe Datei zweimal ein. Dann gibt es einen Fatal error, weil die Klasse darin schon existiert (Cannot redeclare class, in PHP 8.2 noch Cannot declare class …, because the name is already in use).

Namensräume, so weit man sie hier braucht

Ein Namensraum (englisch namespace) ist so etwas wie ein Vorname für deine Klassen. Steht am Anfang einer Datei die Zeile namespace App\Modell;, dann heißt die Klasse Notiz in dieser Datei mit vollem Namen App\Modell\Notiz. Der Backslash trennt dabei die Teile, so wie der Schrägstrich Ordner trennt.

Damit dürfen zwei Klassen Notiz heißen, deine und die aus einem Paket, solange ihre Namensräume verschieden sind. Im Kurs gab es das Problem bisher nicht, in einem Projekt mit Paketen kommt es aber schnell. Ohne Namensräume gäbe es nur eine Notiz im ganzen Programm, und sobald die zweite eingebunden wird, bricht PHP ab.

Eine use-Zeile wie use App\Modell\Notiz; oben in einer Datei sagt PHP, welche Notiz gemeint ist, wenn weiter unten nur Notiz steht. Alles Weitere zu Namensräumen kommt in Lektion 13.5. Für diese Lektion reichen die zwei Zeilen.

Autoloading ist eine Textersetzung

Ein Autoloader von Hand
<?php

declare(strict_types=1);

// spl_autoload_register meldet eine Funktion an, die PHP genau dann
// fragt, wenn es eine Klasse noch nicht kennt. Mehr steckt hinter
// Autoloading nicht.

spl_autoload_register(function (string $klasse): void {
    $praefix = "App\\";

    if (!str_starts_with($klasse, $praefix)) {
        return;
    }

    $rest = substr($klasse, strlen($praefix));
    $datei = "src/" . str_replace("\\", "/", $rest) . ".php";

    echo "  gefragt nach: ", $klasse, "\n";
    echo "  gesucht in:   ", $datei, "\n";

    if (is_file(__DIR__ . "/" . $datei)) {
        require __DIR__ . "/" . $datei;
    }
});

echo "Vor der ersten Benutzung ist noch nichts geladen.\n";

$notiz = new App\Modell\Notiz();

echo "Geladen: ", get_debug_type($notiz), "\n";
echo "Inhalt:  ", $notiz->text, "\n";

Im Beispiel arbeitet ein Autoloader von Hand, ohne Composer. Ohne die zwei echo-Zeilen, die nur zum Zusehen da sind, sind es vierzehn Zeilen. spl_autoload_register() meldet eine Funktion an, und PHP ruft sie genau dann auf, wenn eine Klasse gebraucht wird, die es noch nicht kennt. Die Funktion bekommt den vollen Klassennamen und hat nur eine Aufgabe, nämlich die passende Datei einzubinden.

Der Weg vom Namen zum Pfad ist die ganze Regel:

  1. Fängt der Klassenname mit App\ an? Wenn nicht, ist diese Funktion nicht zuständig.
  2. Präfix abschneiden, aus jedem Backslash einen Schrägstrich machen, .php anhängen.
  3. Vorn den Ordner davor, der zum Präfix gehört.

Aus App\Modell\Notiz wird so src/Modell/Notiz.php, Buchstabe für Buchstabe und in Groß und Klein. Diese Regel heißt PSR-4. PSR steht für PHP Standards Recommendation, und die Nummer 4 ist die Absprache darüber, wie ein Klassenname in einen Dateipfad übersetzt wird. Composers Autoloader kennt sie und kommt auch mit Paketen zurecht, die sich nicht daran halten, und deshalb reicht ein einziger Autoloader für alle Pakete und für deinen eigenen Code.

In der Ausgabe steht die erste Zeile da, bevor der Autoloader überhaupt gefragt wurde. Gerufen wird er erst beim new, und nur dann. Hast du zwanzig Klassen im Projekt und benutzt in einem Aufruf zwei davon, werden auch nur zwei Dateien geladen.

Nach Aufzeichnen siehst du diesen Sprung im Reiter Debug als Weg durch die Datei. Nach der Zeile mit new geht es nach oben in die Funktion, und klasse steht mit dem vollen Namen da. Dann kommen rest und datei dazu, und nach dem require geht es unten mit der Zeile Geladen: weiter.

Warum die Groß- und Kleinschreibung zählt

Der Dateiname zählt
<?php

declare(strict_types=1);

spl_autoload_register(function (string $klasse): void {
    $praefix = "App\\";

    if (!str_starts_with($klasse, $praefix)) {
        return;
    }

    $rest = substr($klasse, strlen($praefix));
    $datei = "src/" . str_replace("\\", "/", $rest) . ".php";

    echo "  gesucht in: ", $datei, "\n";

    if (is_file(__DIR__ . "/" . $datei)) {
        require __DIR__ . "/" . $datei;
    }
});

$notiz = new App\Modell\Notiz();

echo "Hierher kommt das Programm nicht mehr.\n";

Im zweiten Beispiel heißt die Datei notiz.php statt Notiz.php, sonst ist alles gleich. Der Autoloader sucht nach src/Modell/Notiz.php, findet nichts, und PHP bricht mit Uncaught Error: Class "App\Modell\Notiz" not found ab.

Dass es nur am Namen liegt, zeigt mv src/Modell/notiz.php src/Modell/Notiz.php im Terminal. Danach läuft php index.php bis zur letzten Zeile durch. Zurück geht es mit demselben Befehl andersherum, mv src/Modell/Notiz.php src/Modell/notiz.php. Von selbst kommt die alte Datei nicht zurück, denn geschrieben wird nur, was du im Editor geändert hast.

Auf einem Windows-Rechner läuft dasselbe Projekt, weil dort notiz.php und Notiz.php dieselbe Datei sind. Auf einem Linux-Server nicht, und dort zeigt sich der Fehler erst nach dem Hochladen.

Dieselbe Arbeit, von Composer erledigt

Dasselbe von Composer
<?php

declare(strict_types=1);

// Eine einzige Zeile, und danach ist beides da: das fremde Paket
// und der eigene Code aus src/.
require __DIR__ . "/vendor/autoload.php";

$notiz = new App\Modell\Notiz("Milch kaufen");

echo "Klasse:  ", get_debug_type($notiz), "\n";
echo "Text:    ", $notiz->text, "\n";
echo "Kennung: ", $notiz->kennung, "\n";

In der Praxis schreibt niemand den Autoloader von Hand. Man trägt die Regel in die composer.json ein, in einen Block autoload und darin einen Block psr-4. Darin steht die Zuordnung selbst, links das Präfix "App\\" und rechts der Ordner "src/". Im Beispiel steht sie schon in der composer.json.

Die zwei Backslashes hinter App gehören zu JSON und nicht zu PHP. Ein Backslash leitet dort Sonderzeichen ein, ein echter muss deshalb verdoppelt werden. Gemeint ist trotzdem nur einer.

Danach lädt vendor/autoload.php die Pakete und deinen eigenen Code. Im Beispiel benutzt die eigene Klasse App\Modell\Notiz das fremde ramsey/uuid, und in index.php steht trotzdem nur eine einzige require-Zeile.

Trägt man den Block nachträglich ein, kennt der Autoloader ihn erst, wenn Composer die Autoload-Dateien mit composer dump-autoload neu erzeugt hat. In diesem Kurs läuft der Befehl vor jedem Lauf von selbst, sobald die composer.json der Lektion einen Block autoload hat, auch ohne Paket. Tippen kannst du ihn trotzdem, er braucht kein Netz. Er meldet Generating autoload files, und cat vendor/composer/autoload_psr4.php zeigt danach, was dabei entstanden ist. Am Ende der Datei steht deine Zuordnung, 'App\\' => array($baseDir . '/src'), davor die drei Zeilen der Pakete.

Ohne den Block in der composer.json meldet php index.php dasselbe Class "App\Modell\Notiz" not found wie beim falschen Dateinamen. Diesmal liegt es daran, dass Composer den Ordner src/ gar nicht kennt. Das Paket daneben lädt weiter, nur dein eigener Code nicht mehr.

Die Klassen im Beispiel kennst du aus Lektion 6.7, neu sind nur der Namensraum und die use-Zeile darüber. In Abschnitt 17 lädt dein eigenes src/ genauso, ohne eine einzige require-Zeile.

Im Reiter Praxis schreibst du die Klasse Speicher so, dass index.php sie über den Autoloader findet.

Zum Mitnehmen

PSR-4 macht aus einem Klassennamen einen Pfad, indem es das Präfix gegen einen Ordner tauscht und aus jedem Backslash einen Schrägstrich macht, mit Groß und Klein. Steht die Zuordnung im Block autoload der composer.json, lädt vendor/autoload.php den eigenen Code genauso wie die Pakete.

Jetzt du

Basis Konto, kostenlos

Zu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.

Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.

In diesem Kurs läuft dein Code auf einem Server. Dafür hat das Basis Konto 1 Stunde im Monat, mehr Zeit gibt es mit dem Premium Konto.

Was in dieser Lektion steckt

  • Artikel mit 3 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.