Abschnitt 9 · Lektion 1
Warum Pakete
Eine Kurzform für die Adresszeile, gebaut aus einem Titel, klingt nach zehn Minuten Arbeit. Kleinbuchstaben, alles Fremde durch Bindestriche ersetzen, fertig.
Jeden Baustein in diesem Kurs hast du bisher selbst geschrieben, und das war Absicht. Wie eine Sprache funktioniert, sieht man am besten an Code, den man selbst getippt hat. In einem Projekt, das jahrelang laufen soll, holt man sich solche Bausteine dagegen fertig, als Paket.
Eine Kurzform von Hand
<?php
declare(strict_types=1);
// Aus einem Titel eine Kurzform fuer die Adresszeile machen.
// Sieht nach zehn Minuten Arbeit aus.
function kurzform(string $titel): string
{
$klein = strtolower($titel);
$nurWorte = preg_replace("/[^a-z0-9]+/", "-", $klein);
return trim($nurWorte, "-");
}
foreach (["Grüße aus Köln", "Straße & Weg", "Übung macht den Meister"] as $titel) {
echo $titel, " -> ", kurzform($titel), "\n";
} Auf den ersten Blick sieht das Ergebnis richtig aus, auf den zweiten nicht. Aus Grüße aus Köln
wird gr-e-aus-k-ln, aus Straße & Weg wird stra-e-weg, und das Ü am Anfang fällt ganz weg.
Schuld ist die Zeile mit preg_replace(). Sie ersetzt alles, was auf ein Muster passt, und das
Muster [^a-z0-9] heißt „alles außer den Buchstaben a bis z und den Ziffern“. Ein ü ist keiner
davon, also fliegt es raus. Für eine deutsche Seite ist die Funktion damit unbrauchbar.
Solche Muster heißen reguläre Ausdrücke (englisch regular expressions). Im Kurs kommen sie nur an wenigen Stellen vor, meist fertig im gegebenen Code, und für diese Lektion reicht, was das eine hier tut.
Dieselbe Funktion nach drei Nachträgen
<?php
declare(strict_types=1);
// Dieselbe Funktion, nachdem drei Kollegen je einen Fehler gemeldet
// haben. Sie laeuft hier absichtlich nicht, sie ist zum Ansehen da.
function kurzform(string $titel): string
{
// Nachtrag Mai: Umlaute wurden verschluckt (Ticket 118)
$ersatz = ["ä" => "ae", "ö" => "oe", "ü" => "ue", "ß" => "ss"];
$titel = strtr(mb_strtolower($titel), $ersatz);
// Nachtrag Juli: das kaufmaennische Und fiel raus (Ticket 140)
$titel = str_replace("&", " und ", $titel);
// Nachtrag September: franzoesische Titel wurden zu Bindestrichen
// $titel = ...? Wie war das noch mit den Akzenten?
$nurWorte = preg_replace("/[^a-z0-9]+/", "-", $titel);
return trim($nurWorte, "-");
} Das ist dieselbe Funktion, zwei Jahre später. Sie läuft hier nicht, denn es geht darum, wie sie gewachsen ist, und nicht um ihre Ausgabe.
Jeder Nachtrag war für sich vernünftig, und keiner war falsch. Trotzdem will am Ende niemand mehr
den Code anfassen. Er liegt in vier Projekten in vier verschiedenen Ständen, und welcher davon der
neueste ist, weiß keiner mehr. So entstehen die Ordner mit den Namen helfer_alt, helfer_neu und
helfer_neu2.
Jemand anders hat dieselbe Funktion geschrieben, dieselben drei Meldungen bekommen und noch vierzig weitere dazu, und er pflegt sie seit acht Jahren. Sein Paket kannst du einfach benutzen.
Was eine Kennung wirklich kostet
<?php
declare(strict_types=1);
// Eine eindeutige Kennung, wie sie jede Bestellung braucht.
// Sechs Zeilen, und jede einzelne davon muss stimmen.
function kennung(): string
{
$daten = random_bytes(16);
// Vier Bit fuer die Version, zwei fuer die Variante. Steht so im
// Standard, und ohne diese zwei Zeilen ist es keine Kennung nach
// Version 4, sondern nur Zufall in der richtigen Laenge.
$daten[6] = chr(ord($daten[6]) & 0x0f | 0x40);
$daten[8] = chr(ord($daten[8]) & 0x3f | 0x80);
return vsprintf("%s%s-%s-%s-%s-%s%s%s", str_split(bin2hex($daten), 4));
}
echo kennung(), "\n";
echo kennung(), "\n"; Ein zweites Beispiel, weil das erste zu harmlos ist. Jede Bestellung und jeder Datensatz braucht irgendwann eine eindeutige Kennung, und die übliche Form heißt UUID. Sie besteht aus 32 Ziffern in Sechzehnerschreibweise, in fünf Gruppen geteilt.
Die Funktion im Beispiel erzeugt eine, und zwar korrekt. In den beiden Zeilen mit den Bitmasken steckt der Standard, denn vier Bit tragen die Versionsnummer und zwei weitere die Variante. Ohne sie kommt ein Text heraus, der aussieht wie eine UUID, aber keine ist, und der Unterschied fällt frühestens auf, wenn ein anderes System deine Kennungen prüft.
Woher die beiden Zeilen kommen, steht nur im Standard, und den muss man dafür gelesen haben.
<?php
declare(strict_types=1);
require __DIR__ . "/vendor/autoload.php";
use Ramsey\Uuid\Uuid;
echo Uuid::uuid4(), "\n";
echo Uuid::uuid4(), "\n"; Dasselbe mit ramsey/uuid. Eine Zeile bindet das Paket ein, eine kürzt den langen Klassennamen ab,
und übrig bleibt Uuid::uuid4(). Heraus kommt dieselbe Art Kennung wie im Beispiel davor, nur hat
diesmal jemand anders den Standard gelesen, und zwar gründlicher.
Wie das Paket in die Sandbox kommt, steht in Lektion 9.3. Hier zählt nur der Vergleich der beiden Dateien nebeneinander.
Was Composer daraus macht
Composer ist der Paketverwalter (englisch package manager) von PHP, und er verwaltet drei Dinge:
- eine Liste deiner Wünsche in der Datei
composer.json, also welche Pakete du willst und in welcher ungefähren Version, - eine Liste der Tatsachen in
composer.lock, also welche Pakete wirklich installiert wurden, auf die Ziffer genau und samt allem, was sie selbst noch mitgebracht haben, - den Ordner
vendor/, in dem der fremde Code liegt. Darin änderst du nichts, er gehört Composer.
Die Pakete selbst liegen auf Packagist, dem Verzeichnis für PHP-Pakete. Dort siehst du zu jedem Paket, wie oft es installiert wurde und wo sein Quelltext liegt.
Warum vendor/ nicht in die Versionsverwaltung gehört
Die Versionsverwaltung (englisch version control, meist Git) ist das Werkzeug, das jeden Stand
deines Codes aufhebt. Der Ordner vendor/ kommt dort nicht hinein und wird auch nicht mit
hochgeladen. Nichts darin hast du selbst geschrieben, er ist groß, und er lässt sich jederzeit
wiederherstellen. Aus composer.json und composer.lock baut ein einziger Befehl denselben Stand
noch einmal auf, auf jedem Rechner und auf dem Server.
Deshalb steht vendor/ in der Datei .gitignore, in der ein Projekt aufzählt, was Git auslassen
soll. composer.json und composer.lock kommen dagegen mit hinein, denn ohne sie ließe sich der
Ordner nicht wieder aufbauen.
Zum Mitnehmen
Selbst geschriebener Code für eine Kurzform oder eine Kennung wächst mit jeder Meldung, und ein gepflegtes Paket bringt das Wissen dahinter schon mit. Composer schreibt auf, was du willst und was installiert ist, und baut daraus den Ordner vendor jederzeit wieder auf.
Jetzt du
Basis Konto, kostenlosIm Editor änderst du die Beispiele dieser Lektion und lässt sie gleich laufen. So merkst du am schnellsten, ob es sitzt.
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 4 Beispielen zum Ausprobieren
Steht hier, ohne Konto lesbar.