Le système de template de phpBB

Date de publication : 18/07/2005 , Date de mise a jour : 18/07/2005

Par Genova (Autres articles)
 

Apprenez à utiliser le système de template du forum phpBB, inspiré du programme PHPLib. Ce tutorial est basé principalement sur des exemples, aussi quelque soit votre niveau vous arriverez sans peine à l'exploiter.

Introduction

Installer le système

include('template.php');

1. Les bases de l'utilisation du système

1.1. Votre premier fichier parsé

<?php
include('template.php');
?>

<b>test !</b>

<?php
include('template.php');

// On créé une instance de la classe template, passez en paramètre le répertoire ou se trouvent tous vos fichiers templates
$template = new Template('./');

// On assigne a un alias "test" le nom du fichier .tpl qu'on compte utiliser
$template->set_filenames(array('test' => 'test.tpl'));

// On parse le fichier HTML, c'est à dire qu'on assigne aux fichier template toutes les données qu'on à créer dans le .php
$template->pparse('test');
?>

1.2. Les variables de templates

Je m'appel <b>{NAME}</b> et mon adresse IP est : <i>{IP}</i>

<?php
include('template.php');

// On créé une instance de la classe template, passez en paramètre le répertoire ou se trouvent tous vos fichiers templates
$template = new Template('./');

// On assigne a un alias "test" le nom du fichier .tpl qu'on compte utiliser
$template->set_filenames(array('test' => 'test.tpl'));

// On assigne un tableau de variables au template, en clef se situe le nom de la variable dans 
// le fichier .tpl, en valeur ce qu'on lui donne comme valeur
$template->assign_vars(array(
	'NAME' =>		'Genova',
	'IP' =>			$_SERVER['REMOTE_ADDR'],
));

// On parse le fichier HTML, c'est à dire qu'on assigne aux fichier template toutes les données qu'on à créer dans le .php
$template->pparse('test');
?>

2. Les blocs

2.1. Créer un bloc

<!-- BEGIN mon_bloc -->
<b>Hello ! Mon nom est {NAME} et mon IP est : {IP}</b><br />
<!-- END mon_bloc -->

<?php
include('template.php');

// On créé une instance de la classe template, passez en paramètre le répertoire ou se trouvent tous vos fichiers templates
$template = new Template('./');

// On assigne a un alias "test" le nom du fichier .tpl qu'on compte utiliser
$template->set_filenames(array('test' => 'test.tpl'));

// On assigne un tableau de variables au template, en clef se situe le nom de la variable dans 
// le fichier .tpl, en valeur ce qu'on lui donne comme valeur
$template->assign_vars(array(
	'NAME' =>		'Genova',
	'IP' =>			$_SERVER['REMOTE_ADDR'],
));

// On va afficher 5 fois le bloc
for ($i = 0; $i < 5; $i++)
{
	// Cette fonction va créer le bloc, a chaque passage elle empilera le bloc a la suite, c'est à dire que 
	// l'appeler 5 fois de suite va créer le bloc 5 fois
	$template->assign_block_vars('mon_bloc', array());
}

// On parse le fichier HTML, c'est à dire qu'on assigne aux fichier template toutes les données qu'on à créer dans le .php
$template->pparse('test');
?>

2.2. Les blocs imbriqués

<!-- BEGIN mon_bloc -->
<b>Je suis dans le premier bloc</b><br />
	<!-- BEGIN mon_second_bloc -->
	<i>Je suis dans le second bloc moi par contre</i><br />
	<!-- END mon_second_bloc -->
<br />
<!-- END mon_bloc -->

<?php
include('template.php');

// On créé une instance de la classe template, passez en paramètre le répertoire ou se trouvent tous vos fichiers templates
$template = new Template('./');

// On assigne a un alias "test" le nom du fichier .tpl qu'on compte utiliser
$template->set_filenames(array('test' => 'test.tpl'));

// On va afficher 3 fois le premier bloc
for ($i = 0; $i < 3; $i++)
{
	// Cette fonction va créer le bloc, a chaque passage elle empilera le bloc a la suite
	$template->assign_block_vars('mon_bloc', array());

	// On va afficher a chaque fois autant de fois le second bloc que $i
	for ($j = 0; $j < $i + 1; $j++)
	{
		// Veuillez noter que pour créer un second bloc dans un bloc parent, il faut les écrire avec la
		// notation mon_bloc.mon_second_bloc.mon_troisieme_bloc.etc ...
		$template->assign_block_vars('mon_bloc.mon_second_bloc', array());
	}
}

// On parse le fichier HTML, c'est à dire qu'on assigne aux fichier template toutes les données qu'on à créer dans le .php
$template->pparse('test');
?>

2.3. La notation des sous blocs

<!-- BEGIN bloc1 -->
	<!-- BEGIN bloc2 -->
		<!-- BEGIN bloc3 -->
		<!-- END bloc3 -->
	<!-- END bloc2 -->
<!-- END bloc1 -->

2.4. Les variables de blocs

Voici une variable globale au template qui vaut : {VAR_GLOBAL}<br />
<!-- BEGIN mon_bloc -->
<b>Hello ! Mon nom est {mon_bloc.NAME}</b><br />
<!-- END mon_bloc -->

<?php
include('template.php');

// On créé une instance de la classe template, passez en paramètre le répertoire ou se trouvent tous vos fichiers templates
$template = new Template('./');

// On assigne a un alias "test" le nom du fichier .tpl qu'on compte utiliser
$template->set_filenames(array('test' => 'test.tpl'));

// On assigne un tableau de variables au template, en clef se situe le nom de la variable dans 
// le fichier .tpl, en valeur ce qu'on lui donne comme valeur
$template->assign_vars(array(
	'VAR_GLOBAL' =>		'une certaine valeur',
));

// On créé un tableau
$ary = array('pierre', 'paul', 'jacques');

// La boucle prendra successivement les valeurs du tableau
foreach ($ary AS $value)
{
	// Cette fonction va créer le bloc, a chaque passage elle empilera le bloc a la suite
	$template->assign_block_vars('mon_bloc', array(
		'NAME' =>		$value,
	));
}

// On parse le fichier HTML, c'est à dire qu'on assigne aux fichier template toutes les données qu'on à créer dans le .php
$template->pparse('test');
?>

2.5. La notation des variables de blocs

{VARIABLE_GLOBALE}
<!-- BEGIN bloc1 -->
	Bonjour {bloc1.VARIABLE1}
	<!-- BEGIN bloc2 -->
		<!-- BEGIN bloc3 -->
		voici {bloc1.bloc2.bloc3.VARIABLE3} ainsi que {bloc1.bloc2.VARIABLE2}
		<!-- END bloc3 -->
	<!-- END bloc2 -->
<!-- END bloc1 -->

{VARIABLE_GLOBALE}
<!-- BEGIN bloc1 -->
	Bonjour {bloc1.VARIABLE1}
	<!-- BEGIN bloc2 -->
		<!-- BEGIN bloc3 -->
		voici {bloc1.bloc2.bloc3.VARIABLE3} ainsi que {bloc1.bloc2.VARIABLE2}
		<!-- END bloc3 -->
		Cette variable n'existe pas et est fausse : {bloc1.bloc2.bloc3.VARIABLE4}
	<!-- END bloc2 -->
<!-- END bloc1 -->

2.6. Un exemple d'utilisation des blocs avec phpBB

<table>
   <!-- BEGIN user -->
   <tr>
      <td>{user.ID}</td>
      <td>{user.NAME}</td>
   </tr>
   <!-- END user -->
</table>

// On prend les valeurs de la table phpbb_users
$sql = 'SELECT user_id, username FROM ' . USERS_TABLE;
$result = $db->sql_query($sql) OR die('erreur SQL');

$template->set_filenames(array('body' => 'test.tpl');

while ($user = $db->sql_fetchrow($result))
{
	// On affiche les membres ligne par ligne
	$template->assign_block_vars('user', array(
		'ID' => $user['user_id'],
		'NAME' => $user['username']
	));
}

$template->pparse('body');

3. Solutions aux quelques erreurs que vous pourrez rencontrer

3.1. Template->make_filename(): Error - file (...)fichier.tpl does not exist

3.2. Parse error: parse error, unexpected $end in (...)template.php(127) : eval()'d code on line 114

3.3. Template->loadfile(): No file specified for handle alias