Template API

Descrição

Mecanismo de Template para PHP5

Mecanismos de Template permitem manter o código HTML em arquivos externos que ficam completamente livres de código PHP. Dessa forma, consegue-se manter a lógica de programação (PHP) separada da estrutura visual (HTML ou XML, CSS, etc).

Se você já é familiar ao uso de mecanismos de template PHP, esta classe inclui algumas melhorias: automaticamente detecta blocos, mantém uma lista interna das variáveis que existem, limpa automaticamente blocos "filhos", avisando quando tentamos chamar blocos ou variáveis que são existem, avisando quando criamos blocos "mal formados", e outras pequenas ajudas.

Leia o tutorial para maiores detalhes de uso, mensagens de erro, etc.

version: 1.3
author: Rael G.C. (rael.gc@gmail.com)

Resumo dos métodos

Template __construct (string $filename, [boolean $accurate = false])

void addFile (string $varname, string $filename)

void clearVar (string $varname)

void parseBlock (string $block, [boolean $append = false])

string getContent ()

void show ()

Métodos

Constructor __construct

Cria um novo template, usando $filename como arquivo principal

Quando o parâmetro $accurate é true, a substituição dos blocos no arquivo final será perfeitamente fiel ao arquivo original, isto é, todas as tabulações serão removidas. Isso vai ter um pequeno prejuízo na performance, que pode variar de acordo com a versão do PHP em uso. Mas é útil quando estamos usando tags HTML como <pre> ou <code>. Em outros casos, ou melhor, quase sempre, nunca se mexe no valor de $accurate.

Template __construct (string $filename, [boolean $accurate = false])

string $filename: caminho do arquivo que será lido
boolean $accurate: true para fazer substituição fiel das tabulações

addFile

Adiciona o conteúdo do arquivo identificado por $filename na variável de template identificada por $varname

void addFile (string $varname, string $filename)

string $varname: uma variável de template existente
string $filename: arquivo a ser carregado

clearVar

Limpa o valor de uma variável

void clearVar (string $varname)

string $varname: nome da variável

parseBlock

Mostra um bloco.

Esse método deve ser chamado quando um bloco deve ser mostrado. Sem isso, o bloco não irá aparecer no conteúdo final.

Se o parâmetro $append for true, o conteúdo do bloco será adicionado ao conteúdo que já existia antes. Ou seja, use true quando quiser que o bloco seja duplicado.

void parseBlock (string $block, [boolean $append = false])

string $block: nome do bloco que deve ser mostrado
boolean $append: true se o conteúdo anterior deve ser mantido (ou seja, para duplicar o bloco)

getContent

Retorna o conteúdo final, sem mostrá-lo na tela.

Se você quer mostrá-lo na tela, use o método Template::show().

string getContent ()

show

Mostra na tela o conteúdo final.

void show ()

Documentation generated on Tue, 26 Feb 2008 07:38:54 -0300 by phpDocumentor 1.3.0RC3