HTML_Template_IT::touchBlock() (Previous) (Next) HTML_Template_Sigma
View this page in Last updated: Sun, 28 Sep 2008
English | French | German | Hungarian | Japanese | Polish | Spanish | Plain HTML

HTML_Template_PHPLIB

HTML_Template_PHPLIB est une version PEARisée de la fameuse classe de template PHPLIB. Il fourni des variables et des blocs reproduisibles. Le code original de PHPLIB peut-être trouvé sur phplib.sf.net.

Concept

Quand vous utilisez HTML_Template_PHPLIB pour générér du HTML ou un code depuis des modèles, vous devez suivre les étapes suivantes:

  1. Créer une instance de la classe template

  2. Charger le fichier template

  3. Définir les blocs

  4. Initialiser les variables, parser les blocs

  5. Terminer et afficher

Les Variables sont des placeholders dans votre code HTML qui pourront être remplacée dynamiquement par valeurs venant d'une base de donnée ou calculées dans votre code. Voici un exemple de variable {CODE_AUTHOR}: Vous entourez le nom de variable d'accolades. Le nom de la variable peut contenir n'importe quel caractères autres que les "blancs". (espace, tabulation, retour à la ligne)

Les Blocs mettent en évidence des morceaux de code HTML et peuvent être réutilisés, p.e. une ligne <tr> dans une table. Les blocs sont définis en utilisant des commentaires HTML contenant BEGIN ou END, et le nom du bloc. Example: 

<table>
 <caption>Auteurs</caption>
 <thead>
  <tr><th>Nom</th><th>Email</th></tr>
 </thead>
 <tbody>
<!-- BEGIN ligneAuteur -->
  <tr><td>{AUTHOR_NAME}</td><td>{AUTHOR_EMAIL}</td></tr>
<!-- END ligneAuteur -->
 </tbody>
</table>

Exemple simple

Exemple 47-143. Fichier template: auteurs.tpl

<html>
 <head><title>{TITRE_PAGE}</title></head>
 <body>
  <table>
   <caption>Auteurs</caption>
   <thead>
    <tr><th>Nom</th><th>Email</th></tr>
   </thead>
   <tfoot>
    <tr><td colspan="2">{QTE_AUTEURS}</td></tr>
   </tfoot>
   <tbody>
<!-- BEGIN ligneAuteur -->
    <tr><td>{AUTHOR_NAME}</td><td>{AUTHOR_EMAIL}</td></tr>
<!-- END ligneAuteur -->
   </tbody>
  </table>
 </body>
</html>

Exemple 47-144. Code PHP : auteurs.php


<?php
//Nous voulons afficher la liste des auteurs
$listeDesAuteurs = array(
    'Christian Weiske'  => 'cweiske@php.net',
    'Bjoern Schotte'     => 'schotte@mayflower.de'
);

require_once 'HTML/Template/PHPLIB.php';
//On crée un objet template
$t =& new HTML_Template_PHPLIB(dirname(__FILE__), 'keep');
//On charge le modèle
$t->setFile('auteurs', 'auteurs.tpl');
//On prépare les blocs
$t->setBlock('auteurs', 'ligneAuteur', 'ligneAuteur_ref');

//On initialise quelques variables
$t->setVar('QTE_AUTEURS', count($listeDesAuteurs));
$t->setVar('TITRE_PAGE', 'Les auteurs du code sont au ' . date('d-m-Y'));

//Affichons les auteurs
foreach ($listeDesAuteurs as $nom => $email) {
    $t->setVar('AUTHOR_NAME', $nom);
    $t->setVar('AUTHOR_EMAIL', $email);
    $t->parse('ligneAuteur_ref', 'ligneAuteur', true);
}

//On termine et on affiche
echo $t->finish($t->parse('OUT', 'auteurs'));
?>

Charger les fichiers

Les fichiers template sont relatifs à un dossier root configurable. Vous pouvez le spécifier directement dans le constructeur (premier paramètre, par défaut .) ou avec la méthode setRoot().

Les fichiers sont référencés via des noms de handle. Pour cela vous appelez la méthode setFile()et spécifier le nom du handle en premier paramètre, et le nom du fichier comme second paramètre. Pour accélérer les choses, vous pouvez passer à la méthode un tableau asssociatif de paires handle - nom de fichier.

Exemple 47-145. Charger le fichier de template


<?php
$t =& new HTML_Template_PHPLIB(dirname(__FILE__), 'keep');
$t->setFile('auteurs', 'auteurs.tpl');
?>

Définir les blocs

Si vous voulez réutiliser certaines partie de votre code HTML plusieurs fois, par exemple les lignes d'un tableau, vous pouvez définir des blocs comme dans l'exemple décris ci-dessus.

Les blocs ne sont pas automatiquement détectés, ils doivent être explicitement défini via la méthode setBlock(). Cette méthode prend comme premier paramètre le handle du fichier dans le quel le bloc est situé. Le nom du handle qui défini le contenu du bloc en second paramètre. Le nouvel handle de bloc en troisième paramètre.

Exemple 47-146. Définir un bloc


<?php
$t->setBlock('auteurs', 'ligneAuteur', 'ligneAuteur_ref');
?>

Dans l'exemple de template (disponible via le handle auteurs), un bloc appelé ligneAuteur est défini. Le handle du bloc est maintenant ligneAuteur_ref.

Initialisation des variables

C'est une partie des plus facile : Il suffit d'utiliser la méthode setVar() avec un nom de variable et sa nouvelle valeur. Un troisème paramètre optionnel booléen dit s'il faut ajouter le nouveau contenu à l'ancien. Par défaut, ce paramètre est à faux et le contenu est écrasé.

Exemple 47-147. Initialisation d'une variable


<?php
$t->setVar('AUTHOR_NAME', 'Christian Weiske');
?>

L'initialisation des variables influence toutes les variables du modèle, sans tenir compte du fait quelle soit situées dans un bloc ou non.

Parser les blocs

Une fois que toutes les variables d'un bloc sont initialiser, you want to "save" them to be able to re-use the block another time. La méthode parse() est ici bien pratique. First parameter is the variable/handle in which the block content shall be stored, second is the handle name of the block. Le troisième paramètre précise s'il faut ajouter le contenu du bloc a ce qui se trouve dans le handel cible. S'il n'est pas donné la valeur false sera considerée. mais c'est probablement ce que vous souhaitiez.

Exemple 47-148. Traiter un bloc


<?php
foreach ($listeDesAuteurs as $nom => $email) {
    $t->setVar('AUTHOR_NAME', $nom);
    $t->setVar('AUTHOR_EMAIL', $email);
    $t->parse('ligneAuteur_ref', 'ligneAuteur', true);
}
?>

Dans cet exemple, le handle ligneAuteur_ref est remplis avec le contenu du bloc ligneAuteur. Si le dernier paramètre était à false au lieu de true on n'aurait au final que la dernière ligne.

Terminer & afficher

Quand vous en avez fini avec les variables à initialiser et les blocs à traiter, il est temps de d'envoyer le contenu à votre client. En premier lieu, vous devez parse()r le contenu du file handle into a new handle.

Pour supprimer toutes les variables et les blocs inutilisés, vous devrez faire un appel à la méthode finish(). En fonction des valeurs passées au second paramètre du constructeur unknowns (ou passées plus tard via la méthode setUnknowns()), les variables non initilaisée seront supprimées (remove), conservées (keep) ou mise dans un commentaire (comment).

Pour afficher votre HTML, vous pouvez utilise directement la valeur ce que retourne la méthodefinish(), ou utiliser la méthode get() pour récuperer le contenu.

Exemple 47-149. Terminer un fichier et générer l'affichage


<?php
$t->parse('OUT', 'auteurs');
$htmlcode = $t->finish(
    $tpl->get('OUT')
);
echo $htmlcode;
?>

Exemple 47-150. Terminer un fichier et générer l'affichage


<?php
echo $tpl->finish($t->parse('OUT', 'auteurs'));
?>
HTML_Template_IT::touchBlock() (Previous) (Next) HTML_Template_Sigma
Download Documentation Last updated: Sun, 28 Sep 2008
Do you think that something on this page is wrong? Please file a bug report or add a note.
User Notes:
There are no user contributed notes for this page.