PHP-Code-Beautifier

Was Verschönern hier bedeutet

Ein Beautifier verändert nur das Layout. Der Code soll vorher und nachher dasselbe tun. Dieses Tool wendet eine kurze Liste von Layoutregeln an:

• Jedes Semikolon beendet eine Zeile.
• Jede öffnende geschweifte Klammer steht in einer eigenen Zeile, und jede schließende ebenfalls.
• Code innerhalb geschweifter Klammern wird pro Verschachtelungstiefe um eine Ebene eingerückt.
• Auf jedes Komma folgt ein einzelnes Leerzeichen.
• Leerzeilen im Ergebnis werden entfernt.

Es fügt keine Leerzeichen um Operatoren ein, benennt nichts um und ordnet den Code nicht neu.

Ein Beispiel vorher und nachher

Eingabe:

<?php class User{private $name;public function getName(){return $this->name;}}

Ergebnis mit 4 Leerzeichen:

<?php class User
{
    private $name;
    public function getName()
    {
        return $this->name;
    }
}

Beachte, dass das öffnende Tag in derselben Zeile wie die erste Anweisung bleibt, wenn du alles in eine Zeile einfügst. Setze das Tag in deiner Eingabe in eine eigene Zeile, wenn es getrennt stehen soll.

Wann du etwas anderes verwenden solltest

Das Tool zählt geschweifte Klammern und Semikolons als gewöhnliche Zeichen. Es parst kein PHP, kann daher keinem Projekt-Stilguide folgen, lange Zeilen nicht umbrechen und den Abstand um Operatoren wie = oder + nicht korrigieren. Kommentare, Heredocs und for (;;)-Schleifen können daneben gehen, weil ein Semikolon darin wie jedes andere behandelt wird. Für eine vollständige Codebasis nutze einen in deinem Editor oder deiner Build-Pipeline konfigurierten Fixer und verwende diese Seite für einzelne schnelle Aufräumarbeiten.

Eine Funktion mit Schleife verschönern

Kompakte Eingabe:

function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}

Jede geschweifte Klammer öffnet eine neue Ebene, daher liegt der Schleifenrumpf zwei Ebenen tiefer und das return kehrt auf eine Ebene zurück. Liest du von oben nach unten, siehst du nun, dass die Schleife $sum aufsummiert und die Funktion danach den Wert zurückgibt. In der einzeiligen Fassung war das schwer zu erkennen.

2 oder 4 Leerzeichen wählen

Vier Leerzeichen sind die übliche Breite in PHP-Code und am leichtesten zu überblicken. Wähle 2, wenn der Code stark verschachtelt ist oder die Zielstelle schmal ist, etwa eine Chatnachricht. Die Einstellung ändert nur die Einrückung, niemals die Zeilenumbrüche.

Ergebnis prüfen

Formatierter Code lässt sich leichter prüfen, und genau darum geht es. Lies ihn einmal auf fehlende oder überzählige Klammern durch, denn das Tool zählt sie, ohne Probleme zu melden. Wenn die Einrückung gegen Ende seltsam verrutscht, liegt die häufigste Ursache in einer ungepaarten Klammer deiner Eingabe.