Embellisseur de code PHP

Ce que signifie embellir ici

Un embellisseur ne modifie que la mise en page. Le code doit faire la même chose avant et après. Cet outil applique une courte liste de règles de mise en page :

• Chaque point-virgule termine une ligne.
• Chaque accolade ouvrante est placée sur sa propre ligne, et chaque accolade fermante aussi.
• Le code à l’intérieur des accolades est indenté d’un niveau par profondeur d’imbrication.
• Les virgules sont suivies d’un seul espace.
• Les lignes vides du résultat sont supprimées.

Il n’ajoute pas d’espaces autour des opérateurs, ne renomme rien et ne réordonne pas le code.

Un exemple avant et après

Entrée :

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

Résultat avec 4 espaces :

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

Remarquez que la balise d’ouverture reste sur la même ligne que la première instruction lorsque vous collez tout sur une seule ligne. Mettez la balise sur sa propre ligne dans votre entrée si vous voulez qu’elle reste séparée.

Quand utiliser autre chose

L’outil considère les accolades et les points-virgules comme de simples caractères. Il n’analyse pas le PHP : il ne peut donc pas suivre le guide de style d’un projet, couper les longues lignes ni corriger l’espacement autour d’opérateurs comme = ou +. Les commentaires, les heredocs et les boucles for (;;) peuvent mal ressortir, car un point-virgule qui s’y trouve est traité comme les autres. Pour une base de code complète, utilisez un correcteur configuré dans votre éditeur ou dans votre chaîne de build, et gardez cette page pour les nettoyages ponctuels.

Embellir une fonction avec une boucle

Entrée compacte :

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

Chaque accolade ouvre un nouveau niveau : le corps de la boucle se trouve donc deux niveaux plus bas, et le return revient à un niveau. En lisant de haut en bas, on voit maintenant que la boucle ajoute des valeurs à $sum et que la fonction le renvoie ensuite. Dans la version sur une seule ligne, c’était difficile à voir.

Choisir 2 ou 4 espaces

Quatre espaces est la largeur courante en code PHP et la plus facile à parcourir. Choisissez 2 lorsque le code est très imbriqué ou que l’endroit où vous le collerez est étroit, comme un message de chat. Ce réglage ne change que l’indentation, jamais les sauts de ligne.

Vérifiez le résultat

Un code embelli est plus facile à relire, et c’est justement l’objectif. Relisez-le une fois pour repérer des accolades manquantes ou en trop, car l’outil les compte sans signaler les problèmes. Si l’indentation dérive bizarrement vers la fin, la cause habituelle est une accolade sans pendant dans votre entrée.