Was das Tool macht
Der PHP-Formatierer macht aus unordentlichem, minifiziertem oder uneinheitlich eingerücktem PHP sauberen Code, der dem Coding-Standard der Community folgt. Er beherrscht moderne Syntax wie typisierte und readonly-Properties, Constructor Promotion, Arrow Functions, Enums, match-Ausdrücke und Attribute.
Unter der Haube läuft Prettier mit dem offiziellen PHP-Plugin – dieselbe Kombination, die viele Laravel- und Symfony-Teams in ihren Editoren und Pre-Commit-Hooks einsetzen –, sodass das Ergebnis dem entspricht, was dein Tooling erzeugen würde.
So benutzt du es
- Füge PHP-Code ein oder öffne eine
.php-Datei. Das öffnende<?php-Tag ist bei kurzen Snippets optional. - Der formatierte Code erscheint schon beim Tippen rechts.
- Passe die Optionen an:
- Einrückung: 4 Leerzeichen sind der PSR-Standard; 2 Leerzeichen und Tabs gibt es auch.
- Zeilenbreite: Längere Zeilen werden umbrochen, wo die Syntax es zulässt.
- Klammern: Klammern von Klassen und Funktionen in die nächste Zeile (PER / PSR-12) oder in dieselbe Zeile setzen.
- PHP-Version: die älteste Version, auf der der Code laufen muss.
- Einfache Anführungszeichen und Nachgestellte Kommas für mehrzeilige Listen.
- Kopier das Ergebnis oder lade es herunter.
Enthält der Code einen Syntaxfehler, nennt die Meldung, was der Parser erwartet hat, sowie Zeile und Spalte, an der er abgebrochen hat.
Beispiel
Das Beispiel ist ein Controller im Laravel-Stil, bei dem alles zusammengequetscht ist: ein gruppiertes use-Statement, ein Property-Array, Constructor Promotion, ein Validierungsaufruf, ein einzeiliges if und ein array_map mit einer Arrow Function. Nach dem Formatieren wandert die Klammer jeder Methode in eine eigene Zeile, Operatoren und => bekommen Leerzeichen, der if-Rumpf wird aufgeklappt, und die langen response()->json()-Aufrufe werden mit einem Array-Element pro Zeile und nachgestellten Kommas umbrochen.
Was das Tool nicht ändert
Der Formatierer ändert nur das Layout. Er benennt keine Variablen um, sortiert keine use-Statements, wandelt array() nicht in die Kurzschreibweise um und korrigiert keine Logik. Kommentare, auch PHPDoc-Blöcke, bleiben erhalten und werden zusammen mit dem umgebenden Code neu eingerückt.
Tipps
- Verwende dieselbe Zeilenbreite und PHP-Version wie in der Prettier- oder PHP-CS-Fixer-Konfiguration deines Projekts, um unnötige Änderungen in Diffs zu vermeiden.
- Ein Snippet aus einem Log oder Stacktrace lässt sich nach dem Formatieren viel leichter lesen.
- Wenn du Code in einem Issue teilst, formatiere ihn vorher, damit sich Reviewer auf die Funktion konzentrieren können.
FAQ
› Welchem Coding Style folgt das Tool?
Standardmäßig folgt die Ausgabe dem PER Coding Style, dem von PHP-FIG veröffentlichten Nachfolger von PSR-12. Klammern von Klassen und Methoden stehen in einer eigenen Zeile, Klammern von Kontrollstrukturen bleiben in derselben Zeile, und eingerückt wird mit vier Leerzeichen.
› Warum spielt die PHP-Version eine Rolle?
Manche Syntax ist erst ab einer bestimmten Version gültig. Nachgestellte Kommas in Parameterlisten zum Beispiel brauchen PHP 8.0, bei einer älteren Zielversion lässt der Formatierer sie also weg. Wähl die älteste Version, auf der dein Code laufen muss.
› Kann das Tool Dateien formatieren, die HTML und PHP mischen?
Ja. Template-Dateien mit Inline-HTML und kurzen Echo-Tags werden unterstützt. Die PHP-Teile werden formatiert, das HTML dazwischen bleibt unverändert.
› Wird mein Code hochgeladen?
Nein. Der Formatierer läuft vollständig in deinem Browser, und nichts wird an einen Server gesendet.