PHP-kodformaterare

Vad formatering innebär här

En kodformaterare ändrar bara layouten. Koden ska göra samma sak före och efter. Verktyget tillämpar en kort lista med layoutregler:

• Varje semikolon avslutar en rad.
• Varje öppnande klammer hamnar på en egen rad, och varje avslutande klammer likaså.
• Kod inuti klammerparenteser indenteras en nivå per kapslingsdjup.
• Kommatecken följs av ett enda mellanslag.
• Tomma rader i resultatet tas bort.

Det lägger inte till mellanslag runt operatorer, byter inte namn på något och ordnar inte om koden.

Ett exempel med före och efter

Indata:

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

Resultat med 4 mellanslag:

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

Lägg märke till att den öppnande taggen stannar på samma rad som den första satsen när du klistrar in allt på en rad. Lägg taggen på en egen rad i din indata om du vill att den ska stå separat.

När du bör använda något annat

Verktyget räknar klammerparenteser och semikolon som vanliga tecken. Det tolkar inte PHP, så det kan inte följa en projektets stilguide, radbryta långa rader eller rätta mellanslag runt operatorer som = och +. Kommentarer, heredoc-block och for (;;)-loopar kan bli fel, eftersom ett semikolon i dem behandlas som vilket annat semikolon som helst. För en hel kodbas bör du köra en konfigurerad formaterare i din editor eller i ditt byggflöde och använda den här sidan för snabba engångsstädningar.

Formatera en funktion med en loop

Kompakt indata:

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

Varje klammer öppnar en ny nivå, så loopens innehåll hamnar två nivåer in och return hamnar tillbaka på en nivå. Läser du uppifrån och ner ser du nu att loopen adderar till $sum och att funktionen returnerar det efteråt. I den enradiga versionen var det svårt att se.

Välja 2 eller 4 mellanslag

Fyra mellanslag är den vanliga bredden i PHP-kod och är lättast att skanna. Välj 2 när koden är djupt kapslad eller när stället du klistrar in i är smalt, till exempel i ett chattmeddelande. Inställningen ändrar bara indraget, aldrig radbrytningarna.

Kontrollera resultatet

Formaterad kod är lättare att granska, och det är just poängen. Läs igenom den en gång efter saknade eller extra klammerparenteser, eftersom verktyget räknar dem utan att rapportera problem. Om indraget glider konstigt mot slutet är en oparad klammer i din indata den vanliga orsaken.