Formattatore di codice PHP

Cosa significa qui rendere leggibile

Un formattatore cambia solo il layout. Il codice deve fare la stessa cosa prima e dopo. Questo strumento applica una breve lista di regole di layout:

• Ogni punto e virgola chiude una riga.
• Ogni parentesi graffa di apertura va su una riga propria, e così ogni graffa di chiusura.
• Il codice dentro le graffe è rientrato di un livello per ogni profondità di annidamento.
• Le virgole sono seguite da un unico spazio.
• Le righe vuote nel risultato vengono rimosse.

Non aggiunge spazi attorno agli operatori, non rinomina nulla e non riordina il codice.

Un esempio prima e dopo

Input:

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

Risultato con 4 spazi:

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

Nota che il tag di apertura resta sulla stessa riga della prima istruzione quando incolli tutto su una riga. Se lo vuoi separato, metti il tag su una riga propria nell’input.

Quando usare un’alternativa

Lo strumento conta le graffe e i punti e virgola come semplici caratteri. Non analizza PHP, quindi non può seguire la guida di stile di un progetto, andare a capo sulle righe lunghe o correggere gli spazi attorno a operatori come = e +. Commenti, heredoc e cicli for (;;) possono venire male, perché un punto e virgola al loro interno viene trattato come gli altri. Per una base di codice completa, usa un correttore configurato nel tuo editor o nella pipeline di build, e tieni questa pagina per le pulizie occasionali.

Formattare una funzione con un ciclo

Input compatto:

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

Ogni graffa apre un nuovo livello, quindi il corpo del ciclo finisce due livelli più a destra e il return torna a un livello. Leggendo dall’alto in basso ora si vede che il ciclo somma in $sum e che la funzione lo restituisce dopo. Nella versione su una sola riga era difficile da notare.

Scegliere 2 o 4 spazi

Quattro spazi è la larghezza comune nel codice PHP ed è la più facile da scorrere. Scegli 2 quando il codice è molto annidato o quando il posto in cui lo incollerai è stretto, come un messaggio di chat. L’impostazione cambia solo il rientro, mai le interruzioni di riga.

Controlla il risultato

Il codice formattato è più facile da rivedere, ed è proprio questo lo scopo. Leggilo una volta per cercare graffe mancanti o in più, perché lo strumento le conta senza segnalare i problemi. Se il rientro si sposta in modo strano verso la fine, la causa più comune è una graffa senza coppia nel tuo input.