mitmario.dev

Eine zweite Abhängigkeit

PHP Sandbox 3 Min Lesezeit 3 BeispieleLektion 4 von 7

In vendor/ liegen nach composer require ramsey/uuid drei Pakete, obwohl in der composer.json nur eines steht. Bestellt hast du nur ramsey/uuid, also willst du wissen, woher die beiden anderen kommen und ob sie im Projekt etwas zu suchen haben.

Pakete benutzen selbst Pakete

Ein Wunsch, drei Pakete
<?php

declare(strict_types=1);

$wunsch = json_decode(file_get_contents("composer.json"), true);
$tatsache = json_decode(file_get_contents("composer.lock"), true);

$gewuenscht = [];
foreach ($wunsch["require"] as $name => $bereich) {
    // php ist keine Bibliothek, sondern eine Bedingung an die
    // Laufzeit. Es zaehlt hier deshalb nicht mit.
    if ($name !== "php") {
        $gewuenscht[$name] = $bereich;
    }
}

echo "Gewünscht:   ", count($gewuenscht), "\n";
echo "Installiert: ", count($tatsache["packages"]), "\n\n";

foreach ($tatsache["packages"] as $paket) {
    $woher = isset($gewuenscht[$paket["name"]]) ? "selbst gewählt" : "mitgebracht";
    echo str_pad($paket["name"], 20), str_pad($paket["version"], 10), $woher, "\n";
}

Die Autoren von ramsey/uuid haben das Rechnen mit sehr großen Zahlen nicht selbst geschrieben, weil es dafür schon ein Paket gab. Also steht in ihrer composer.json ein require auf brick/math, und in brick/math steckt vielleicht noch etwas anderes.

brick/math ist damit eine Abhängigkeit (englisch dependency) von ramsey/uuid, und alle zusammen bilden den Abhängigkeitsbaum. Composer läuft ihn vollständig ab, bevor es irgendetwas lädt. Heruntergeladen wird erst, wenn eine Kombination gefunden ist, mit der alle Bedingungen gleichzeitig erfüllt sind. Deshalb liegen in vendor/ mehr Ordner, als in deiner composer.json stehen. ls vendor zeigt neben autoload.php drei Ordner, brick, composer und ramsey. Der mittlere gehört Composer selbst, dort liegt der Autoloader. Unter ramsey liegen zwei Pakete, wie ls vendor/ramsey zeigt.

Im Beispiel werden beide Listen gelesen und gegenübergestellt, ein selbst gewähltes Paket gegen zwei mitgebrachte. Denselben Baum zeigt composer show --tree im Terminal, und der Befehl liegt auch in der Befehlsleiste dieses Beispiels. Fünf Bedingungen stehen darin, eine je Zeile:

  • ramsey/uuid verlangt brick/math im Bereich >=0.8.16 <=0.18
  • und ramsey/collection als ^1.2 || ^2.0, wobei der doppelte senkrechte Strich „oder“ heißt
  • dazu selbst php ^8.0
  • brick/math wiederum verlangt php ^8.2, ramsey/collection verlangt php ^8.1

Alle fünf müssen gleichzeitig stimmen, auch die drei Angaben zu PHP. Mit diesem Lockfile wäre auf einem Hosting mit PHP 8.1 hier schon Schluss, weil brick/math in Version 0.18 mehr verlangt. composer install bricht dort mit Your lock file does not contain a compatible set of packages ab. Darunter stehen die Gründe, jeder mit der PHP-Version, die nicht reicht. Der erste ist die eigene composer.json, die schon php ^8.2 verlangt, und gleich danach kommt brick/math 0.18.0 requires php ^8.2. Composer sagt das vor dem Herunterladen und nicht erst danach.

Andersherum fragt composer why brick/math, wer dieses Paket verlangt hat. Die Antwort ist eine Zeile, ramsey/uuid 4.9.3 requires brick/math (>=0.8.16 <=0.18). Die Versionen sind die aus der Maschine dieses Kurses. Auf deinem Rechner können sie neuer sein, die Form bleibt.

Die neueste Version, die zu allen passt

Composer sucht die höchste Version, mit der alle Bedingungen zusammen aufgehen. Steht in deiner composer.json eine ältere Version von brick/math fest, nimmt Composer eben eine etwas ältere Version von ramsey/uuid, nämlich die letzte, die mit deiner Festlegung noch klarkommt.

Geht das nicht mehr auf, bricht die Installation ab. Composer nennt dann die ganze Kette bis zu der Bedingung, an der es scheitert. Eine feste Versionsnummer in der eigenen composer.json hält also nicht nur dein Paket fest, sondern auch alles, was davon abhängt.

Ein Paket ohne Abhängigkeiten

Und eines, das nichts mitbringt
<?php

declare(strict_types=1);

// Dieselbe Auswertung, ein anderes Paket.

$wunsch = json_decode(file_get_contents("composer.json"), true);
$tatsache = json_decode(file_get_contents("composer.lock"), true);

$gewuenscht = [];
foreach ($wunsch["require"] as $name => $bereich) {
    if ($name !== "php") {
        $gewuenscht[$name] = $bereich;
    }
}

echo "Gewünscht:   ", count($gewuenscht), "\n";
echo "Installiert: ", count($tatsache["packages"]), "\n\n";

foreach ($tatsache["packages"] as $paket) {
    echo str_pad($paket["name"], 20), $paket["version"], "\n";
}

nikic/fast-route ist das Gegenstück, ein Wunsch und ein Paket ohne Baum. Die einzige Bedingung darin ist eine PHP-Version, und die ist so alt, dass sie heute jeder erfüllt. composer show --tree zeigt hier eine Zeile mit php >=5.4.0 darunter, sonst nichts.

Darauf kannst du beim Aussuchen achten. Ein Paket ohne Abhängigkeiten ist leichter zu überblicken, aktualisiert sich seltener und holt dir nichts ins Projekt, das du nie ausgesucht hast. Ein Baum ist umgekehrt kein Grund zur Panik, solange du weißt, was darin hängt.

Vor jedem require frage ich mich:

  • Brauche ich das wirklich, oder sind es zehn Zeilen eigener Code?
  • Wird das Paket gepflegt? Auf Packagist steht, wann die letzte Version erschien.
  • Wie viel kommt mit, und kenne ich, was mitkommt, wenigstens dem Namen nach?

Bei der Kurzform für die Adresszeile vom Anfang dieses Abschnitts lautet die Antwort „Paket“. Bei einer Funktion, die zwei Zahlen addiert, lautet sie „selbst schreiben“, auch wenn es dafür ein Paket gibt.

Der Router, den du gleich brauchst

Wie ein Router einen Pfad einordnet
<?php

declare(strict_types=1);

require __DIR__ . "/vendor/autoload.php";

$dispatcher = FastRoute\simpleDispatcher(function (FastRoute\RouteCollector $r) {
    $r->addRoute("GET", "/preise", "preisliste");
    $r->addRoute("GET", "/bestellung/{nr:\d+}", "bestellseite");
});

foreach (["/preise", "/bestellung/77", "/bestellung/abc"] as $pfad) {
    echo $pfad, ":\n";
    var_dump($dispatcher->dispatch("GET", $pfad));
    echo "\n";
}

nikic/fast-route beantwortet nur die Frage, zu welchem Stück Code ein Pfad gehört. Das brauchst du ab Abschnitt 16, und dort baust du es selbst. Hier siehst du zuerst, wie es aussieht, wenn es jemand fertig gebaut hat.

Zwei Dinge stehen im Beispiel:

  • simpleDispatcher() bekommt eine anonyme Funktion aus Lektion 6.6, und darin werden mit addRoute() die Regeln angemeldet. Jede Regel besteht aus Methode, Pfadmuster und einem Wert, den du frei wählst, hier ein Text, später der Name einer Funktion. Methode meint die Art der Anfrage, mit der ein Browser eine Seite holt. GET heißt „gib mir diese Seite“, mehr dazu in Abschnitt 10.
  • In geschweiften Klammern steht ein Platzhalter. {nr:\d+} erlaubt an dieser Stelle nur Ziffern und nennt den Wert nr. Hinter dem Doppelpunkt steht ein regulärer Ausdruck, \d+ heißt „eine Ziffer oder mehr“. Ohne den Doppelpunkt und das Muster dahinter passt alles bis zum nächsten Schrägstrich.

dispatch() gibt ein Array zurück, und das var_dump im Beispiel zeigt seinen Aufbau. An Stelle 0 steht das Ergebnis der Suche. 1 heißt gefunden, 0 nicht gefunden und 2 „den Pfad gibt es, aber nicht mit dieser Methode“. Wenn du die Zahlen nicht auswendig lernen willst, vergleichst du mit den Konstanten FastRoute\Dispatcher::FOUND und FastRoute\Dispatcher::NOT_FOUND.

An Stelle 1 steht bei einem Treffer dein Wert, an Stelle 2 die Platzhalter als Zuordnung, also ["nr" => "77"]. Der Wert dort ist Text und keine Zahl, obwohl das Muster nur Ziffern erlaubt hat. Im var_dump steht string(2) "77". Was aus einer Adresse kommt, bleibt Text, auch in Abschnitt 10 und 11.

Beim dritten Pfad im Beispiel ist das Array dagegen nur einen Eintrag lang. Abfangen musst du das nicht, denn nach einem Fehlschlag gibt es schlicht nichts weiter zu sagen, keinen Wert und keine Platzhalter. Steigst du nach dem Vergleich mit FOUND aus, greifst du auf die Stellen 1 und 2 ohnehin nicht mehr zu.

In der Aufgabe meldest du selbst zwei Regeln an und ordnest damit eine Handvoll Pfade ein.

Zum Mitnehmen

Ein Paket bringt oft weitere mit, und Composer installiert nur eine Kombination, bei der alle Bedingungen zugleich aufgehen, auch die an die PHP-Version. Ein Router wie nikic/fast-route ordnet einen Pfad einer Regel zu und gibt die Platzhalter als Text zurück.

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.