Indentare codice PHP

Come viene calcolato il rientro

Lo strumento tiene un contatore di profondità. Ogni parentesi graffa aperta aggiunge un livello e ogni parentesi chiusa ne toglie uno. Ogni riga viene riempita con il numero di spazi scelto moltiplicato per la profondità corrente. Il rientro è sempre fatto di spazi, mai di tabulazioni.

Ecco la stessa funzione con ciascuna impostazione. L’input era function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}.

Con 4 spazi:

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

Con 2 spazi:

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

2 spazi o 4 spazi

Quattro spazi è la convenzione più diffusa nei progetti PHP ed è quella che chiede la maggior parte delle guide di stile. Due spazi mantiene più stretto il codice molto annidato, utile quando lo incolli in un campo piccolo di un ticket o in un messaggio di chat. Usa quello che usa il tuo team.

Cose da sapere

• Le tabulazioni nell’input non vengono conservate, perché lo spazio attorno a parentesi graffe e punti e virgola viene ricostruito.
• Il rientro dipende solo dalle parentesi graffe. Il codice che continua su più righe dentro parentesi tonde, come un array lungo, non riceve un rientro in più.
• Una parentesi graffa dentro un commento o un heredoc viene comunque contata, e questo può spostare la profondità di tutto ciò che segue.
• Le parentesi graffe sbilanciate non vengono segnalate. Se finiscono le parentesi chiuse, la profondità si ferma a zero e le righe successive non vengono indentate.

Come sistemare il codice che ha perso il rientro

Il rientro spesso scompare quando il codice passa da un campo di modulo, un’email, uno strumento di chat o un file di log. Incollarlo qui ricostruisce la struttura a partire dalle parentesi graffe, quindi non devi riallineare ogni riga a mano. Aiuta soprattutto con le classi, dove metodi e corpi stanno a profondità diverse, e con le funzioni lunghe che hanno più cicli e condizioni annidati.

Controlla il risultato

Dopo la formattazione, scorri il bordo sinistro. Ogni parentesi graffa chiusa deve allinearsi alla riga che ha aperto il suo blocco. Se l’ultima graffa è rientrata, o se il codice dopo un blocco è spostato troppo a destra, nel tuo input manca o avanza una parentesi. Correggi prima quella e rilancia lo strumento.