Embelezador de código PHP

O que embelezar significa aqui

Um embelezador altera apenas o layout. O código deve fazer a mesma coisa antes e depois. Esta ferramenta aplica uma lista curta de regras de layout:

• Cada ponto e vírgula encerra uma linha.
• Cada chave de abertura fica em uma linha própria, e cada chave de fechamento também.
• O código dentro das chaves é indentado um nível por profundidade de aninhamento.
• As vírgulas são seguidas de um único espaço.
• As linhas em branco do resultado são removidas.

Ela não adiciona espaços em torno de operadores, não renomeia nada e não reordena o código.

Um exemplo de antes e depois

Entrada:

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

Resultado com 4 espaços:

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

Note que a tag de abertura permanece na mesma linha da primeira instrução quando você cola tudo em uma linha só. Coloque a tag em uma linha própria na sua entrada se quiser que ela fique separada.

Quando usar outra coisa

A ferramenta trata chaves e ponto e vírgulas como caracteres comuns. Ela não analisa o PHP, então não consegue seguir o guia de estilo de um projeto, quebrar linhas longas nem corrigir o espaçamento em torno de operadores como = e +. Comentários, heredocs e laços for (;;) podem sair errados, porque um ponto e vírgula dentro deles é tratado como qualquer outro. Para uma base de código completa, use um corretor configurado no seu editor ou no pipeline de build, e deixe esta página para limpezas pontuais.

Embelezando uma função com laço

Entrada compacta:

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

Cada chave abre um nível novo, então o corpo do laço fica dois níveis para dentro e o return volta para um nível. Lendo de cima para baixo, agora dá para ver que o laço soma em $sum e que a função devolve o valor depois. Na versão de uma linha isso era difícil de perceber.

Escolhendo 2 ou 4 espaços

Quatro espaços é a largura comum em código PHP e a mais fácil de percorrer com os olhos. Escolha 2 quando o código for muito aninhado ou quando o lugar onde você vai colar for estreito, como uma mensagem de chat. A configuração altera apenas a indentação, nunca as quebras de linha.

Confira o resultado

Código embelezado é mais fácil de revisar, e esse é o objetivo. Leia uma vez para procurar chaves faltando ou sobrando, porque a ferramenta as conta sem relatar problemas. Se a indentação sair estranha perto do fim, a causa habitual é uma chave sem par na sua entrada.