PHP embutido em HTML

Conforme adiantado, uma das características que mais atrapalham a legibilidade de um código PHP é o fato de ele poder ser embutido em um HTML de forma desordenada. Esta característica da linguagem tem uma finalidade útil, já que permite manter uma equipe focada no HTML + CSS (layout) e outra equipe focada no PHP (lógica de negócio). Mas, para isso ocorrer, o "PHP embutido em HTML" deve ser mínimo possível. Isso significa que, o ideal, é que se utilize os delimitadores de código PHP apenas em pontos específicos do HTML e não para embutir gigantescos blocos de código PHP.

Em geral, o HTML deve ter pontos específicos onde imprimem valores armazenados em variáveis ou que invocam funções ou métodos. Nestas funções/métodos, podem existir lógicas mais complexas, mas que ficam em arquivos externos e totalmente PHP. Desta forma, o objetivo do HTML é apresentar, de maneira clara, como será a estrutura da página ou de uma parte da página gerada dinamicamente.

Um exemplo de código HTML com PHP embutido e que serve exclusivamente para servir de base para uma fácil visualização da estrutura do layout segue abaixo:


Para utilizar este arquivo, o cliente acessaria um script totalmente PHP. Este script montaria os dados do objeto $pagina e faria um "include" no arquivo apresentado acima. Desta forma, os "pontos-chave" do layout seriam carregados com informações específicas da página desejada.

Em geral, deve-se evitar a utilização de loops ou estruturas de controle dentro de códigos PHP embutidos em HTML. Mas, caso isso seja essencial, o ideal é utilizar a sintaxe alternativa destas estruturas (http://www.php.net/manual/en/control-structures.alternative-syntax.php). Ao invés de utilizar "abre chaves" e "fecha chaves" para delimitar um bloco de comandos, utilizar "dois pontos" para indicar início do bloco e uma palavra-chave para indicar o final. Veja um exemplo:


Note que usando esta notação, o final do foreach fica explícito, aumentando a legibilidade.

ini_set('memory_limit', '128M');

$time = time();
foreach ($itens as $item) {
    if ($item->tamanho > $tamanho_minimo) {
        foreach ($item->elementos as $elemento) {
            if ($elemento->visivel) {
                echo '<p>';
                if ($data > $time) {
                    echo 'teste';
                }
                echo $elemento->nome;
                echo '</p>';
            }
        }
    }
}