Bonsoir à tous,
Voici la documentation des filtres des templates. Tout d'abord, qu'est-ce qu'un filtre ? Il s'agit de fonctions qui permettent d'agir sur des variables (normales / blocs), afin qu'elles puissent avoir un comportement différent suivant le contexte ou elles sont utilisées.
ATTENTION, les filtres ne s'utilisent que sur les variables (variables "normales", variables de blocs, variables des foreach (KEY, VALUE)).
Utilisation des filtres
Il n'y a ici qu'une partie TPL ; si vous voulez appliquer un filtre sur une variable, il vous faut ajouter juste après le nom de la variable, séparé par un |, le nom du filtre à utiliser. Vous pouvez aussi en utiliser plusieurs, en les séparant par un |.
Code TPL
{MA_VAR|capitalize} /* Pour plop, affichera PLOP */
{MA_VAR|minimize|protect} /* pour <strong>PlOp</strong>, affichera <strong>plop</strong> */
/* Attention, ne courez pas au bug pour cet affichage, je vous donne le rendu html ^^' */
<block name="mon_bloc">
{mon_bloc.MA_VAR|capitalize}
</block>
<foreach ary="{$ARRAY}">
{VALUE,ARRAY|capitalize}
{KEY,ARRAY|ceil}
</foreach>
Notez que vous pouvez toujours utiliser le fait de retourner la valeur d'une variable, qu'elle soit filtrée ou non :
Code TPL
{$MA_VAR|capitalize} /* Pour plop, retournera PLOP */
{$MA_VAR|minimize|protect} /* pour <strong>PlOp</strong>, retournera <strong>plop</strong> */
/* Attention, ne courez pas au bug pour cet affichage, je vous donne le rendu html ^^' */
/* etc. */
Depuis la version 1.8.0, vous pouvez passer des arguments à vos filtres. Ils pourront être de n'importe quel type (chaine de caractère, entier, variable, ...), et seront parsé dans leur type respectif ou seront échappés en chaines de caractère. Ils seront séparés par des : :
Code TPL
{MAVAR|cut:40:'[...]'}
Implémentaion de nouveaux filtres
Oui, vous lisez bien, vous n'êtes pas fous ! Vous pouvez
ajouter de nouveaux filtres pour vos templates. Pour cela, il vous suffit de regarder la classe Talus_TPL_Filters, et de lui ajouter une nouvelle méthode publique statique, du nom du filtre à ajouter. Dans l'exemple qui vient, nous allons voir omment ajouter un formattage simple de date !
Code PHP
<?php
class Talus_TPL_Filters {
// -- .... Des filtres, encore des filtres, toujours des filtres...
// -- Oh, un nouveau filtre !
public static function date($arg){
return date('d/m/Y', (int) $arg);
}
}
Attention, si votre template est déjà compilé avec un filtre n'existant pas encore dans la liste des filtres (genre rajouté après compilation), pensez à recompiler votre template (en supprimant le fichier cache correspondant, ou en appelant la méthode Talus_TPL_Cache::destroy()) !
Si vous désirez créer un filtre avec des paramètres, renseignez les (je vous conseille en optionnel) dans la déclaration de la méthode statique après $arg (qui représente la variable en elle-même).
Code PHP
<?php
/**
* Coupe une chaine de caractères (sans interrompre un mot)
*
* @param string $arg chaine à couper
* @param integer $max nombre maximum de caractères
* @param string $finish chaine de caractère à appliquer en fin si $str est coupée.
* @return string
*/
public static function cut($arg, $max = 50, $finish = '...'){
if (strlen($arg) <= $max){
return $arg;
}
$max = intval($max) - strlen($finish);
$arg = substr($arg, 0, $max + 1);
$arg = strrev(strpbrk(strrev($arg), " \t\n\r\0\x0B"));
return rtrim($arg) . $finish;
}
C'est fini pour les filtres :).
Chapitre Précédent : Les Blocs
Chapitre Suivant : La fin : Parsage du TPL !
Home
» Talus' Works » Talus' TPL » Documentation » Les Filtres » Lecture du Sujet » Page 1 
#1 - Le 02/10/2008, à 23:55
