Indenter du code PHP

Comment l’indentation est calculée

L’outil tient un compteur de profondeur. Chaque accolade ouvrante ajoute un niveau et chaque accolade fermante en retire un. Chaque ligne est complétée par le nombre d’espaces choisi multiplié par la profondeur actuelle. L’indentation utilise toujours des espaces, jamais des tabulations.

Voici la même fonction avec chaque réglage. L’entrée était function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}.

Avec 4 espaces :

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

Avec 2 espaces :

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

2 espaces ou 4 espaces

Quatre espaces est la convention habituelle dans les projets PHP, et celle que demandent la plupart des guides de style. Deux espaces garde le code très imbriqué plus étroit, ce qui aide lorsqu’on le colle dans un petit champ de ticket ou un message de chat. Adoptez celle de votre équipe.

Points à connaître

• Les tabulations de l’entrée ne sont pas conservées, car les espaces autour des accolades et des points-virgules sont reconstruits.
• L’indentation ne dépend que des accolades. Le code qui se poursuit sur plusieurs lignes à l’intérieur de parenthèses, comme un long tableau, n’est pas indenté davantage.
• Une accolade placée dans un commentaire ou un heredoc est tout de même comptée, ce qui peut décaler la profondeur de tout ce qui suit.
• Les accolades non équilibrées ne sont pas signalées. Si les accolades fermantes manquent, la profondeur reste à zéro et les lignes suivantes ne sont pas indentées.

Réparer du code qui a perdu son indentation

L’indentation disparaît souvent lorsque le code passe par un champ de formulaire, un e-mail, un outil de discussion ou un fichier journal. Le coller ici reconstruit la structure à partir des accolades, vous n’avez donc pas à réaligner chaque ligne à la main. Cela aide surtout pour les classes, où les méthodes et leurs corps sont à des profondeurs différentes, et pour les longues fonctions qui contiennent plusieurs boucles et conditions imbriquées.

Vérifiez le résultat

Une fois le code formaté, parcourez le bord gauche. Chaque accolade fermante doit être alignée sur la ligne qui a ouvert son bloc. Si la dernière accolade est indentée, ou si le code qui suit un bloc est décalé trop loin, une accolade manque ou est en trop dans votre entrée. Corrigez cela d’abord, puis relancez l’outil.