PHP-codeverfraaier

Wat verfraaien hier betekent

Een verfraaier wijzigt alleen de indeling. De code moet voor en na hetzelfde doen. Deze tool past een korte lijst indelingsregels toe:

• Elke puntkomma sluit een regel af.
• Elke openingsaccolade staat op een eigen regel, en elke sluitingsaccolade ook.
• Code binnen accolades wordt één niveau per nestingdiepte ingesprongen.
• Komma’s worden gevolgd door één spatie.
• Lege regels in het resultaat worden verwijderd.

Hij voegt geen spaties rond operatoren toe, hernoemt niets en herschikt de code niet.

Een voorbeeld voor en na

Invoer:

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

Resultaat met 4 spaties:

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

Let op: de openingstag blijft op dezelfde regel als de eerste instructie wanneer je alles op één regel plakt. Zet de tag in je invoer op een eigen regel als je wilt dat hij apart staat.

Wanneer je iets anders moet gebruiken

De tool telt accolades en puntkomma’s als gewone tekens. Hij ontleedt geen PHP, dus hij kan een projectstijlgids niet volgen, lange regels niet afbreken en de spaties rond operatoren zoals = en + niet corrigeren. Opmerkingen, heredocs en for (;;)-lussen kunnen verkeerd uitpakken, omdat een puntkomma daarin als elke andere wordt behandeld. Gebruik voor een volledige codebase een fixer die in je editor of buildpijplijn is ingesteld, en houd deze pagina voor losse opschoonbeurten.

Een functie met een lus verfraaien

Compacte invoer:

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

Elke accolade opent een nieuw niveau, dus de lusinhoud staat twee niveaus diep en de return keert terug naar één niveau. Lees je van boven naar beneden, dan zie je nu dat de lus optelt in $sum en dat de functie daarna de waarde teruggeeft. In de versie op één regel was dat lastig te zien.

2 of 4 spaties kiezen

Vier spaties is de gebruikelijke breedte in PHP-code en het makkelijkst te scannen. Kies 2 wanneer de code diep genest is of wanneer de plek waar je plakt smal is, zoals een chatbericht. De instelling wijzigt alleen de inspringing, nooit de regeleinden.

Controleer het resultaat

Verfraaide code is makkelijker te beoordelen, en dat is het doel. Lees hem één keer na op ontbrekende of extra accolades, want de tool telt ze zonder problemen te melden. Als de inspringing aan het eind vreemd verschuift, is de gebruikelijke oorzaak een accolade zonder paar in je invoer.