Pourquoi l'utiliser ? Exemples Téléchargements Manuel Plug-ins Autres outils Support Forum Témoignages Vos sites
English 
Site : www.tinybutstrong.com
Auteur : skrol29
Date : 2009-06-12
*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*
TinyButStrong
version 3.5
*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*.^.*
 

Template Engine pour Pro et débutants
sous PHP 4 et 5
 

Plan de ce fichier d'aide :
Rubrique Description
   
• Présentation  
    Principes de base  
    Installation  
    Mini exemples  
• Coté PHP  
    • Pour commencer  
        méthode LoadTemplate() charge le contenu d'un modèle à partir d'un fichier
        méthode MergeBlock() fusionne une partie du modèle avec une source de données
        méthode Show() traitements automatiques et affichage du résultat
    • Avancé  
        méthode GetBlockSource() retourne le source de la définition d'un bloc
        méthode MergeField() fusionne un champ particulier avec une valeur
        méthode PlugIn() exécute une action d'un plug-in
        propriété Assigned prépare les informations pour une fusion ultérieure
        propriété NoErr empêche les messages d'erreur
        propriété Render pour modifier les options de fin de fusion
        propriété Source retourne le contenu courant du résultat de la fusion
        propriété TplVars retourne les variables du modèle
        Programmation Orientée Objet (POO) pour que TBS vous facilite la POO.
• Coté HTML  
    • les champs TBS  
        définition et syntaxe  
        paramètres  
        ordre de traitement des paramètres  
        les champs [var]  
        les champs [var] Spéciaux  
    • les blocs TBS  
        définition et syntaxes  
        paramètres  
        sections de bloc  
        affichage en série (en colonnes)  
        les sous-blocs  
        sous-blocs automatiques  
        sous-blocs avec requêtes dynamiques  
    • Autre  
        champs et blocs automatiques  
        sous-modèles  
        vue d'ensemble de l'affichage conditionnel  
• Coder des plug-ins  
    Plug-ins de base de données  
    Autres plug-ins  
• Résumés  
    paramètres des champs TBS  
    paramètres des blocs TBS  
    noms de champs et blocs spéciaux  
Présentation :

TinyButStrong (TBS) est une classe PHP utile pour développer une application en séparant proprement vos scripts PHP de vos pages HTML. Avec TBS, les pages HTML sont générées dynamiquement en fusionnant un modèle avec des données. C'est ce qu'on appelle un moteur de modèle (Template Engine).

TBS tient son nom du fait qu'il ne présente que 8 fonctions mais qu'il permet de faire le maximum. Il est ••• très très fort ••• pour fusionner des modèles de pages HTML avec vos variables PHP ou vos requêtes MySQL, PostgreSQL, ou SQLite.

TBS a été conçu pour que vous puissiez développer avec facilité vos modèles depuis n'importe quel éditeur HTML visuel (comme Dreamweaver ou FrontPage), mais si vous avez l'habitude d'utiliser un éditeur textuel il est tout aussi pratique. TBS permet aussi de créer du JavaScript dynamiquement.

Comme son nom l'indique, TBS est simple à utiliser, puissant et rapide. Il est complètement °~° freeware °~°.

Principes de base :

Du coté HTML :
Vous concevez une page qui n'a pas besoin de contenir de script PHP, ni de programmation. Dans cette page vous placez des balises TBS aux endroits où doivent s'afficher les données dynamiques. Cette page est appelée un 'modèle'. Il existe deux types de balises : les 'champs' qui servent à afficher une donnée dynamiquement, et les 'blocs' qui servent à définir une zone, le plus souvent pour afficher les enregistrements d'une source de données.

Du coté PHP :
Vous utilisez une variable objet TBS pour piloter la fusion de votre modèle HTML avec des données. à la fin, TBS affiche le résultat de la fusion.


Installation :

1. Copiez le fichier tbs_class.php dans un répertoire de votre site Web.
2. Au début de votre programme PHP, ajoutez les lignes :
  include_once('tbs_class.php');
  $TBS = new clsTinyButStrong ;
Remarque : si le fichier tbs_class.php se trouve dans un répertoire différent de celui de votre programme, vous devrez préciser le répertoire devant le nom du fichier.

Explications et détails techniques :

TinyButStrong est un librairie écrite en PHP, c'est un composant à référencer dans vos propres programmes PHP. En terme technique, TinyButStrong est une 'classe' d'objet PHP ; le nom de cette classe est clsTinyButStrong.
La variable $TBS que ajoutez en début de programme sert à piloter la fusion de votre modèle depuis votre application PHP. En terme technique, la variable $TBS est une 'instance' de la classe clsTinyButStrong.


Mini exemples :

Exemple 1 :
Modèle Html Programme Php Résultat
<html>
 <body>
  [var.message]
 </body>
</html>

<?

include_once('tbs_class.php');
$TBS = new clsTinyButStrong ;
$TBS->LoadTemplate('template.htm') ;

$message = 'Hello' ;
$TBS->Show() ;

?>
<html>
 <body>
  Hello
 </body>
</html>

Exemple 2 :
Modèle Html Programme Php Résultat
<table>
 <tr><td>[blk.val;block=tr]</td></tr>
</table>

<?

include_once('tbs_class.php');
$TBS = new clsTinyButStrong ;
$TBS->LoadTemplate('template.htm') ;

$liste = array('X','Y','Z') ;
$TBS->MergeBlock('blk',$liste) ;
$TBS->Show() ;

?>
<table>
 <tr><td>X</td></tr>
 <tr><td>Y</td></tr>
 <tr><td>Z</td></tr>
</table>
Coté PHP :
Le pilotage de la fusion d'un modèle se fait dans un programme PHP en utilisant une variable objet déclaré à partir de la classe clsTinyButStrong.
Exemple de déclaration : $TBS = new clsTinyButStrong ;
Cet objet vous permet de charger un modèle, piloter sa fusion avec des données, puis afficher le résultat.

Exemple de code PHP :

include_once('tbs_class.php');
$TBS = new clsTinyButStrong ;
$TBS->LoadTemplate('template.htm') ;
$TBS->MergeBlock('ctry','mysql','SELECT * FROM t_coutry') ;
$TBS->Show() ;

Voici la liste des propriétés et méthodes d'un objet TinyButStrong :

Méthode LoadTemplate() :
Charge un modèle en vue de son traitement pour la fusion.
Le contenu complet du fichier est enregistré dans la propriété Source de l'objet TinyButStrong, et les champ [onload] sont fusionnés.
Si le fichier n'est pas trouvé il sera aussi recherché dans le répertoire du dernier modèle chargé (depuis TBS version 3.2.0).

Syntaxe : $TBS->LoadTemplate(string Fichier{, string HtmlCharSet})

Argument Description
Fichier Chemin local ou absolu du fichier modèle à charger.
Cette valeur peut être null ou '' (chaine vide) pour des actions spéciales. Voir les détails ci-dessous.
HtmlCharSet Facultatif. Indique l'encodage des caractères (charset) à utiliser pour la conversion Html des données lorsqu'elles seront fusionnées. La valeur par défaut est '' (chaîne vide) qui équivaut à 'ISO-8859-1' (Latin 1).

Si votre modèle utilise un charset spécial, indiquez la valeur Html de ce charset.
Dans une page Html, le charset se trouve en tête du fichier, dans l'attribut 'content' d'une balise <Meta>. Les charset supportés par TBS sont ceux supportés par la fonction htmlentities() de Php. Par exemple : 'BIG5' (chinois) ou 'EUCJP' (japonais).

Portée de la recherche du fichier :
Si le fichier n'est pas trouvé, il sera aussi recherché dans le répertoire du dernier modèle ou sous-modèle chargé.
Depuis TBS version 3.3.0, le fichier est aussi recherché dans le include_path.

Pas de conversion Html :
Si vous utilisez la valeur False pour l'argument HtmlCharSet, alors les données ne seront pas converties lors de la fusion avec le modèle.

Fonction utilisateur :
Si votre charset n'est pas supporté par PHP, vous pouvez désigner une fonction utilisateur qui réalise la conversion Html. Pour cela, utilisez l'argument HtmlCharSet avec la syntaxe '=myfunction'.
Depuis TBS version 3.0, il est aussi possible d'indiquer une méthode de classe (voir POO).
Depuis TBS version 3.3.0, cette fonction utilisateur devrait avoir un second argument pour la conversion des sauts-de-lignes.
Voici un exemple qui donne la syntaxe attendue :
function f_StrToXml($Txt string,$ConvBr boolean) {
// Convertie une chaîne en texte XML.
  $x = htmlspecialchars(utf8_encode($Txt));
  if ($ConvBr) {
    $x = nl2br($x); // Convertie tout type de saut-de-ligne
    $x = str_replace('<br />', '<text:line-break/>',$x);
  return $x;
}


Ajouter le fichier à la suite du modèle en cours :

Vous pouvez utiliser le mot-clé '+' à la place du charset pour que le fichier spécifié soit ajouté à la fin du modèle en cours au lieu de l'écraser. Le charset utilisé est alors le même que pour le premier modèle.

Actions spéciales :
Depuis TBS version 3.4.0.
Si Fichierest null, alors toutes les actions par défaut (Plugins, balises [onload], et Charset) sont appliquées sans charger aucun fichier.
Si Fichier est '' (chaine vide), alors seul le charset est modifié, sans faire rien aucune autre action.
Exemple :
$TBS->Source = $modele; // charge le modèle depuis une chaine
$TBS->LoadTemplate(null,'BIG5'); // lance les plugins s'il y en a, et fusionne les balises [onload] s'il y en a
...
$TBS->LoadTemplate('',false); // remplace le charset pas aucun-charset
Méthode MergeBlock() :
Fusionne un ou plusieurs blocs TBS avec les données d'une source d'enregistrements.
Par défaut, cette méthode retourne le nombre d'enregistrements fusionnés (plus exactement, elle retourne le numéro du dernier enregistrement), mais elle peut aussi retourner le jeu complet des enregistrements fusionnés (voir argument NomBloc).

TinyButStrong supporte plusieurs types de sources de données en natif :
Données Php : un tableau ; une chaîne texte, un nombre.
Base de données : MySQL ; PostgreSQL ; SQLite.
Mais vous pouvez aussi en ajouter de nouveaux : 'plug-ins de base de données'.

Syntaxe : int $TBS->MergeBlock(string NomBloc, mixed Source{, string Requête})
Argument Description
NomBloc Indique le nom du bloc TBS à fusionner.
Vous pouvez fusionner plusieurs blocs avec les mêmes données en indiquant leurs noms séparés par des virgules. Si vous ajoutez '*' comme nom de bloc, alors la méthode retournera le jeu complet des enregistrements fusionnés sous forme de tableau PHP, à la place du nombre d'enregistrements.
Historique : le mot clé '*' est supporté depuis TBS version 3.0.
Source

Variable ou mot-clé qui désigne la source de données pour la fusion.
Le tableau ci-dessous indique les valeurs possibles selon le type de source de données.

Requête Facultatif. Indique la requête SQL qui retourne les données à fusionner.
Le tableau ci-dessous indique les valeurs possibles selon le type de source de données.

Liaison entre le bloc et les enregistrements :

La méthode MergeBlock() recherche le bloc TBS avec le nom spécifié dans votre modèle. Puis, le bloc TBS est répété autant de fois qu'il y a d'enregistrement dans la source de données.
Pour afficher les données d'un enregistrement, vous devez utiliser un champ TBS lié. Un champ TBS est lié lorsque son nom est composé du nom du bloc, suivi d'un point et du nom d'une colonne ou d'une clé du jeu d'enregistrements. Un champ lié doit se trouver à l'intérieur du bloc.

Exemple :
Nom du bloc : bloc1
Colonnes retournées par la requête : champ1,champ2,champ3
Champs TBS liés : [bloc1.champ1], [bloc1.champ2], [bloc1.champ3]

Si aucune définition de bloc n'est trouvée dans le modèle, La méthode MergeBlock() fusionnera le premier enregistrement avec tous les champs liés trouvés dans le modèle.

Vous pouvez définir des blocs plus évolués. Pour plus d'information, consultez la rubrique Blocs TBS.

Fusionner plusieurs blocs avec les mêmes données :

Vous pouvez fusionner plusieurs blocs avec les mêmes données en indiquant leurs noms séparés par des virgules dans l'argument NomBloc. Dans ce cas, la requête n'est ouverte qu'une seule fois et les enregistrements sont mis dans un cache afin de remplir les blocs.
Exemple : $TBS->MergeBlock('bloc1,bloc2,bloc3','mysql','SELECT * FROM MaTable');

Retourner l'ensemble des enregistrements fusionnés :

Dans certains cas, il vous sera peut être pratique de récupérer l'ensemble des enregistrements fusionnés après la fusion. Pour cela, il suffit d'ajouter le mot-clé '*' dans la liste des noms de bloc. Utilisez cette fonctionnalité avec parcimonie car elle conserve les données fusionnées en mémoire ce qui consomme plus ressource.
Exemple : $data = $TBS->MergeBlock('bloc1,*','mysql','SELECT * FROM MaTable');

Décompte des enregistrements :


Pour afficher le numéro d'enregistrement dans le modèle, utilisez un champ TBS lié à la colonne virtuelle '#'. Si vous placez ce champ en dehors du bloc, il affichera le nombre total d'enregistrements.
Exemple : [bloc1.#]

La colonne virtuelle '$' permet d'afficher la clé de l'enregistrement en cours lorsque la source de données est un tableau Php (array).
Exemple: [bloc1.$]

Utilisation des arguments Source et Requête selon le type de source de données :

Type de source de données Source Requête
Assigné (*) Le mot-clé 'assigned', ou omis -
Texte (*) Le mot-clé 'text' Un texte
Nombre (*) Le mot-clé 'num' Un nombre
ou un tableau spécial (voir plus bas)
Vide (*) Le mot-clé 'clear' -
Conditionnel (*) Le mot-clé 'cond' -
Tableau PHP (*) Un tableau Php -
Le mot-clé 'array' Un tableau Php
Le mot-clé 'array' Une chaîne texte qui représente un tableau contenu ou encapsulé dans une variable PHP globale (voir ci-après)
PHP ArrayObject Un object PHP.
Supportés en natif depuis TBS version 3.5.0.
-
PHP Iterator
PHP IteratorAggregate
MySQL Une ressource de connexion MySql ou le mot-clé 'mysql' Une requête SQL
Une ressource de résultat MySql -
PostgreSQL Une ressource de connexion PostgreSql Une requête SQL
Une ressource de résultat PostgreSql -
SQLite Une ressource de connexion SQLite Une requête SQLite
Une ressource de résultat SQLite -
Personnalisé
Un mot-clé, un objet ou une ressource non listé dans ce tableau.
Voir le paragraphe 'plug-ins de base de données'.
Une requête SQL ou autre chose.
(*) Voir explications dans la rubrique ci-après.

Source de données Php :

Assigné
L'argument Source doit être le mot-clé 'assigned' ou doit être omis.
Le bloc est fusionné avec les arguments définis dans la propriété Assigned.
Exemple : $TBS->MergeBlock('b1');
Historique : le mot clé 'assigned' est supporté depuis TBS version 3.5.

Texte
L'argument Source doit être égal à 'text'.
Tout le bloc est remplacé par le texte contenu dans la paramètre Requête. Les champs liés ne sont pas gérés sauf '#' qui retourne 1, ou 0 si Requête est une chaîne vide.
Exemple : $TBS->MergeBlock('b1','text','Bonjour, comment allez-vous ?');

Nombre
L'argument Source doit être égal à 'num'.
L'argument Requête peut être soit un nombre, soit un tableau.

arg Requête Jeu d'enregistrements retourné
Nombre : Ce nombre doit être supérieur ou égale à zéro. Le jeu d'enregistrement retourné est composé d'une colonne 'val' dont la valeur va de 1 à ce nombre.
Tableau : Ce tableau doit contenir une clé 'min' et une clé 'max' et éventuellement une clé 'step'.
Le jeu d'enregistrement retourné est composé d'une colonne 'val' qui va de la valeur de 'min' à la valeur de 'max'.
Exemples :
$TBS->MergeBlock('b1','num',12);
$TBS->MergeBlock('b2','num',array('min'=>20,'max'=>30));
$TBS->MergeBlock('b3','num',array('min'=>10,'max'=>20,'step'=>2));

Vide
L'argument Source doit être le mot-clé 'clear'.
Tous les blocs et leurs sections sont supprimés. C'est la même chose que fusionner avec un tableau vide.
Exemple : $TBS->MergeBlock('b1','clear');

Conditionnel
L'argument Source doit être le mot-clé 'cond'.
Le bloc est fusionné comme si c'était un bloc conditionnel onload et onshow. Le bloc n'est pas fusionné avec des données et donc il ne doit pas avoir de champ TBS lié. Chaque section de bloc doit avoir un paramètre when ou un paramètre default. Voir bloc conditionnel pour plus de détails.
Exemple : $TBS->MergeBlock('bz','cond');

Tableau
L'argument Source doit être un tableau Php (type Array), ou le mot-clé 'array'. Si le mot-clé 'array' est utilisé, alors l'argument Requête doit être un tableau Php ou une chaîne texte qui représente tableau contenu ou encapsulé par une variable Php globale.

Syntaxe de la chaîne : 'globvar[item1][item2]...'
'globvar' est le nom d'un variable globale $globvar qui doit être un tableau.
'item1' et 'item2' sont des clés d'un item ou d'un sous item de $globvar.
Exemple:
$TBS->MergeBlock('bloc1','array','jours[lun]');
Cela va fusionner 'block1' avec $jours['lun'] qui est supposé être un tableau.
Il est possible de représenter un nom de variable sans item.
Exemple:
$TBS->MergeBlock('bloc1','array','jours');

Il y a deux avantages à utiliser une chaîne pour représenter le tableau :
-> Les items seront lus directement dans le tableau (assigné par référence) au lieu de lire une copie des items. Cela peut améliorer les performances.
-> Vous pouvez utiliser des requêtes dynamiques.

Afficher la clé de l'enregistrement en cours :
Vous pouvez utiliser la colonne virtuelle '$' qui affiche la clé de l'enregistrement en cours. Cela peut être particulièrement utile pour les sous-blocs avec requêtes dynamiques.
Exemple: [bloc1.$]

Structure des tableaux supportés :

Les items du tableau spécifié peuvent être de deux types : des valeurs simples avec des clés associées (cas 1), ou des valeurs tableaux dont les items sont eux-mêmes des valeurs simples avec des clés associées (cas 2).

Cas 1 :
Exemple : ['clé1']=>valeur1
['clé2']=>valeur2
...
Le jeu d'enregistrement retourné est composé d'une colonne 'key' contenant le nom de la clé, et d'une colonne 'val' contenant la valeur de la clé.

Cas 2 :
Exemple : [0] => (['colonne1']=>valeur1-0 ; ['colonne2']=>valeur2-0 ; ...)
[1] => (['colonne1']=>valeur1-1 ; ['colonne2']=>valeur2-1 ; ...)
[2] => (['colonne1']=>valeur1-2 ; ['colonne2']=>valeur2-2 ; ...)
...
Le jeu d'enregistrement retourné est composé des colonnes 'colonne1', 'colonne2', ... avec leurs valeurs associées.
Méthode Show() :
Termine la fusion.

Syntaxe : $TBS->Show({int Render})

La méthode Show() exécute les actions suivantes :
- fusion des champs [var],
- fusion des champs [onshow],
- affiche le résultat (cette action peut être annulée par la propriété ou l'argument Render),
- termine le script (cette action peut être annulée par la propriété ou l'argument Render).

La propriété et l'argument Render permettent de régler le comportement de la méthode Show().
Consultez la propriété Render pour plus d'information.
Méthode GetBlockSource() :
Retourne le source d'un bloc TBS.
Seule la définition de la première section du bloc sera retournée à moins que l'argument Sections soit à True.
Si aucun bloc n'est trouvé, la méthode retourne la valeur False.

Syntaxe : string $TBS->GetBlockSource(string NomBloc {, boolean Sections}{, boolean BalisesDef})

Argument Description
NomBloc Nom du bloc à rechercher.
Sections Facultatif. La valeur par défaut est False.
Si ce paramètre est à True, la méthode retourne un tableau contenant les définitions de toutes les sections du bloc nommé. La première section est retournée dans l'élément [1] du tableau.
BalisesDef Facultatif. La valeur par défaut est True.
Par défaut, la méthode GetBlockSource() retourne le source du bloc avec ses balises de définition. Si vous souhaitez que ces balises soient retirées, forcez l'argument BalisesDef à False. Si le bloc est défini avec une syntaxe simplifiée alors les balises de définition de bloc ne seront de toute façon pas supprimées car elles sont aussi des balises de champ.
Historique : cet argument est supporté depuis TBS version 3.0.

Cette méthode permet de récupérer le source d'un bloc afin de gérer manuellement sa fusion. Si par la suite vous souhaitez remplacer le bloc par du texte, vous pouvez utiliser ma méthode MergeBlock() avec le paramètre 'text'.
Méthode MergeField() :
Fusionne un ou plusieurs champs TBS avec une valeur fixe ou en appelant une fonction utilisateur.
Depuis TBS version 3.0, il est aussi possible d'indiquer une méthode de classe (voir POO).
Tous les champs du modèle ayant le nom de base indiqué seront fusionnés.
Il est aussi possible de fusionner les champs spéciaux [var], [onload] et [onshow] (voir plus bas).

Syntaxe : $TBS->MergeField(string NomBase, mixed X {, boolean ModeFonction}{, array PrmParDefaut})

Argument Description
NomBase Le nom de base des champs TBS. Par exemple 'compte'.
X La valeur à afficher (ou une chaîne représentant le nom d'une fonction utilisateur si l'argument ModeFonction est à true).
ModeFonction

Indique que la valeur à afficher est calculée par une fonction utilisateur. La valeur par défaut est false. Si cet argument est à true, alors X doit être une chaîne texte donnant le nom de la fonction utilisateur. Cette fonction doit exister et avoir la syntaxe décrite ci-après.

PrmParDefaut

Liste des paramètres à appliquer par défaut aux champs fusionnés. Les paramètres doivent être donnés sous forme d'un tableau PHP associatif. Si un paramètre est défini à la fois dans l'argument PrmParDefaut et dans le champ, c'est le paramètre du champ qui sera pris en compte.
Cet argument est supportés depuis TBS version 3.5.0.


Fusion avec une valeur :

X peut être un numérique, une chaîne, un tableau ou un objet. Pour un tableau ou un objet, les noms de champs TBS doivent avoir des suffixes comme pour les champs [var].

Exemple :
$TBS->MergeField('compte',array('id'=>55,'nom'=>'Bob'));
Dans cet exemple, les champs [compte.id] et [compte.nom] seront fusionnés.

Fusion avec une fonction utilisateur :

TBS appelle une fonction utilisateur pour chaque champ trouvé dans le modèle.
Cette fonction doit avoir la syntaxe suivante:
function fct_utilisateur($Subname [, $PrmLst]) {...}
Lors de l'appel à la fonction, son argument $Subname a pour valeur le suffixe du nom du champ (par exemple pour un champ nommé 'ml.titre', $Subname aura pour valeur 'titre'). Et l'argument optionnel $PrmLst contient un tableau associatif avec les paramètres du champ. La fonction doit retourner la valeur à fusionner.

Exemple :
$TBS->MergeField('ml','m_multilangue',true);
...
function m_multilangue($Subname) {
  global $langue_id;
  $rs = mysql_query("SELECT texte_$langue_id AS txt FROM t_langue WHERE cle='$Subname");
  $rec = mysql_fetch_array($rs);
  return $rec['txt'] ;
}
Dans cet exemple, un champ tel que [ml.titre] sera fusionné avec la valeur retournée par m_multilangue('titre').

Fusion de champs spéciaux :


Vous pouvez vous servir de la méthode MergeField() pour forcer la fusion des champs spéciaux [var], [onload] et [onshow]. Mais dans ce cas, seul le premier argument doit être indiqué.
Exemple : $TBS->MergeField('var');
Historique : la fusion des champs spéciaux est supportée depuis TBS version 3.0. Elle remplace l'ancienne méthode MergeSpecial() qui n'est plus supportée.

Méthode PlugIn() :
Permet d'appeler une commande d'un plug-in TBS ou d'installer un plug-in TBS.

Syntaxe : mixed $TBS->PlugIn(mixed arg1, mixed arg2, ...)

Rappel : pour que votre plug-in TBS fonctionne, sont script PHP doit préalablement être inséré dans votre application.
Exemple : include_once('tbs_plugin_xxx.php');
De plus, chaque plug-in TBS doit avoir une clé comme expliqué au chapitre Plug-ins.

Appeler une commande d'un plug-in :
Utilisez la clé du plug-in comme argument principal. Les arguments suivants sont propres au plug-in appelé.
Exemple :
$TBS->PlugIn(TBS_XXX,$arg1,arg2);
Dans cet exemple, le plug-in identifié par la clé TBS_XXX est invoqué.
Remarque : lorsque vous vous appelez une commande d'un plug-in pour la première fois, ce plug-in est installé automatiquement sur l'instance TBS ($TBS).

Installer un plug-in :
Bien que certains plug-in soient installés automatiquement, dans d'autres cas il peut être utile de faire une installation manuelle. Pour cela on utilise la constante TBS_INSTALL avec la clé du plug-in .
Exemple :

$TBS->PlugIn(TBS_INSTALL,TBS_XXX);
Dans cet exemple, le plug-in identifié par la clé TBS_XXX est installé.
Remarques :
* Un plug-in est installé relativement à une instance de TBS (une variable $TBS par exemple ). Si vous utilisez une deuxième instance de TBS (par exemple $TBS2) alors il vous faudra aussi installer le plug-in sur cette instance.
* Un plug-ins est installé automatiquement lors que vous appelez une de ses commandes à l'aide de la méthode PlugIn() (voir plus haut).


Historique : la méthode PlugIn() est supportée depuis TBS version 3.0.
Propriété Assigned :
Permet de définir les informations pour une fusion ultérieure qui peut être automatique ou manuelle.

Syntaxe : array $TBS->Assigned

La propriété Assigned est un tableau PHP définie par l'utilisateur. On y enregistre les arguments des méthodes MergeBlock() ou MergeField(). Les arguments doivent être enregistrés dans un tableau PHP avec des clés numériques et ordonnées en suivant la syntaxe de ces méthodes. Il est possible d'utiliser des clés chaines optionnelles pour définir certains comportements :
Clé optionnelle Description
'type'=>'mergeblock' Indique qu'il s'agit d'arguments pour la méthode MergeBlock(). Cette clé est facultative puisque c'est le comportement par défaut.
'type'=>'mergefield' Indique qu'il s'agit d'arguments pour la méthode MergeField().
'auto'=>'onload' Indique que la fusion doit être lancée automatiquement après les balises [onload].
'auto'=>'onshow' Indique que la fusion doit être lancée automatiquement après les balises [onshow].
'merged'=>0 Cette clé est ajoutée automatiquement par TBS lors de la fusion. Elle compte le nombre de fois où cette entrée a été fusionnée.

Exemple de fusion manuelle :
$TBS->Assigned['b'] = array('b1,b2', &$cnx_id, 'SELECT id, nom FROM table1');
...
$TBS->MergeBlock('b'); // fusionne les blocks b1 et b2 avec la requête SQL

Exemple de fusion automatique :
$TBS->Assigned['b'] = array('b1,b2', &$cnx_id, 'SELECT id, nom FROM table1', 'auto'=>'onload');

Exemple de fusion de champs :
$TBS->Assigned['f1'] = array('f1', $data, 'type'=>'mergefield');
...
$TBS->MergeField('f1'); // fusionne le ou les champs f1 avec le tableau $data

Remarques :
- Pour fusionner un bloc ou un champ déjà assigné, il suffit d'appeler la méthode correspondante avec seulement le nom de la clé assignée. Vous pouvez ajouter l'argument Source = 'assigned', mais cela est facultatif car il s'agit de la valeur par défaut. En d'autres termes, $TBS->MergeBlock('b') équivaut à $TBS->MergeBlock('b', 'assigned').
- Une assignation avec 'auto'=>'onload' ne serra bien sûr fusionnée que si elle est définie avant d'appeler méthode LoadTemplate().
- Vous pouvez passer des arguments par référence dans vos assignations. C'est particulièrement utile pour PHP 4 qui passe les objets en copie par défaut.


Historique : la propriété Assigned est supportée depuis TBS version 3.5.
Propriété NoErr :
Permet d'empêcher l'affichage de tous les messages d'erreur TinyButStrong pour les opérations qui suivent. Par défaut la valeur est à false. Les erreurs qui n'ont pas été affichées peuvent toutefois être restituées avec le champ spécial [var..error_msg]. De plus vous pouvez contrôler la présence d'erreur grâce à la propriété ErrCount qui compte les erreurs TBS indépendanement de NoErr.

Syntaxe : boolean $TBS->NoErr

Exemple : $TBS->NoErr = true; // plus aucun message d'erreur ne s'affiche.

La propriété NoErr est pratique dans deux cas :
- Pour les sites professionnels mis en production pour lesquels aucun message d'erreur ne doit être affiché. Attention car vous n'avez plus aucune indication sur le bon déroulement de votre fusion. Il est souvent plus judicieux d'utiliser le paramètre noerr qui permet d'annuler des messages sur une balise TBS bien précise.
- Pour les fusions qui n'acceptent pas les messages d'erreur basic de TinuButStrong. Par exemple un document OpenOffice ne pourra pas s'ouvrir correctement si une erreur TBS survient. Utilisez $TBS->NoErr=true et le champ [var..error_msg] pour afficher les erreurs TBS dans un emplacement lisible de votre document OpenOffice.

Historique :
- La propriété NoErr est supportée depuis TBS version 3.0.
- Le champ spécial [var..error_msg] est supporté depuis TBS version 3.5.0.
Propriété Render :
Détermine comment doit se terminer la fusion.
Sa valeur doit être une combinaison des constantes du tableau ci-dessous.
Par défaut, sa valeur est (TBS_OUTPUT + TBS_EXIT).

Syntaxe : int $TBS->Render

La propriété Render influe sur le comportement des méthodes Show().

Constante Description
TBS_NOTHING Indique qu'aucune action ci-dessous n'est effectuée à la fin de la fusion.
TBS_OUTPUT Indique que le résultat de la fusion doit être affiché. (utilisation de la commande PHP Echo)
TBS_EXIT Indique qu'on doit quitter le script juste après la fin de la fusion.
Propriété Source :
Cette propriété contient le source du modèle en cours de fusion. Elle est en lecture/écriture.
Lorsque TinyButStrong opère une fusion (en utilisant la méthode MergeBlock() par exemple), la propriété Source est modifiée immédiatement.

Syntaxe : string $TBS->Source

Remarques :
- La méthode LoadTemplate() charge un fichier dans la propriété Source et fusionne automatiquement les champs [onload]. Il se peut donc que Source soit un peu différent du modèle initial après LoadTemplate().
- La méthode Show() fusionne automatiquement les champs [onshow] et [var] avant d'afficher le résultat.

Pour charger un modèle contenue dans une variable Php, vous pouvez coder :
$TBS->Source = $mon_modele;
$TBS->MergeField('onload'); // force la fusion des champs [onload] si il y en a

Pour récupérer le résultat à la fin d'une fusion, vous pouvez coder :
$TBS->Show(TBS_NOTHING) // termine la fusion sans quitter ni afficher le résultat
$resultat = $TBS->Source;
Propriété TplVars :
Contient le tableau des variables de modèle correspondant au modèle en cours.

Syntaxe : array $TBS->TplVars

Vous pouvez définir des variables de modèle en utilisant un ou des champs automatiques onload avec le paramètre tplvars. Tous les paramètres qui suivent le paramètre tplvars sont ajoutés à la propriété TplVars quand la méthode LoadTemplate() est appelée.
Exemple :
  [onload;tplvars;template_version='1.12.27';template_date='2004-10-26']
Cette balise TBS va créer deux items équivalents au code PHP suivant :
 $TBS->TplVars['template_version'] = '1.12.27';
 $TBS->TplVars['template_date'] = '2004-10-26';
Remarques :
- Le paramètre tplvars ne fonctionne qu'avec les champs automatiques onload.
- Vous pouvez utiliser le paramètre tplvars plusieurs fois dans le même modèle.
Programmation Orientée Objet (POO):
TinyButStrong intègre une technique pour faire appel à des méthodes ou des propriétés d'objets que vous avez codés du côté PHP.

Appels à des méthodes de classe sans objet crées :
Les fonctionnalités TBS suivantes supportent l'appel à des méthodes de classe sans objet crées.
Fonctionnalité Exemple
Paramètre ondata [blk1.colonne1;block=tr;ondata=MaClasse.methA]
Paramètre onformat [blk1.colonne2;onformat=MaClasse.methB]
Méthode LoadTemplate() $TBS->LoadTemplate('monmodele.htm','=MaClasse.methC');
Méthode MergeField() $TBS->MergeField('nomchamp','MaClasse.methD',true);
Remarque : Les méthodes appelées par cette technique doivent respecter la syntaxe de fonction attendue par la fonctionnalité (voir description de la fonctionnalité correspondante).

Appels à des objets crées :

TBS possède une propriété ObjectRef qui est à false par défaut, et dont vous pouvez vous servir pour référencer vos objets déjà crées. Vous pouvez référencer un objet directement sur la propriété ObjectRef, ou bien vous pouvez en référencer plusieurs à l'aide de tableaux PHP.
Exemple :
$TBS->ObjectRef =& $MonObjet1;
   Vous pouvez utiliser un tableau si vous avez plusieurs objets à référencer :
$TBS->ObjectRef['item1'] =& $MonObjet1;
$TBS->ObjectRef['item2'] =& $MonObjet2;
   Vous pouvez utilisez autant de niveau que vous le souhaitez :
$TBS->ObjectRef['item3']['a'][0] =& $MonObjet3;
Remarques :
* Pensez à utiliser l'assignation par référence à l'aide de "=&" au lieu de "=", sinon une copie de l'objet sera créée.
* Une fois un objet référencé sous ObjectRef, ses sous-objets seront aussi accessibles par la syntaxe TBS.

• Utilisation d'ObjectRef dans les champs [var] :
Utilisez le symbole '~' pour appeler ce qui est référencé sous ObjectRef.
Par exemple :
Le champ   Ferra appel à
[var.~propA]   $TBS->ObjectRef->propA
[var.~propA.propB]   $TBS->ObjectRef->propA->propB
[var.~item2.propA]   $TBS->ObjectRef['item2']->propA
[var.~item2.methX]   $TBS->ObjectRef['item2']->methX()
[var.~item2.methY(a,b)]   $TBS->ObjectRef['item2']->methY('a','b')
Remarques :
TBS opère un contrôle de cohérence, il déterminera de lui même si votre définition de champ [var] fait appel à ObjectRef via un item d'un tableau, une propriété d'objet ou une méthode d'objet. Dans tous les cas, faites bien attention à ce que votre champ [var] doit au final retourner une valeur et non pas un objet.

• Utilisation d'ObjectRef dans d'autres fonctionnalités TBS :
Les fonctionnalités TBS suivantes supportent l'appel à des méthodes d'objets référencés sous ObjectRef.
Fonctionnalité Exemple
Paramètre ondata [blk1.colonne1;block=tr;ondata=~item1.methA]
Paramètre onformat [blk1.colonne2;onformat=~item1.methB]
Méthode LoadTemplate() $TBS->LoadTemplate('monmodele.htm','=~item1.methC');
Méthode MergeField() $TBS->MergeField('nomchamp','~item1.methD',true);
Méthode MergeBlock() $TBS->MergeBlock('blk1','~madb','SELECT * FROM t_table');
Remarque : Les méthodes appelées par cette technique doivent respecter la syntaxe de fonction attendue par la fonctionnalité (voir description de la fonctionnalité correspondante).


Coté HTML :
Vous concevez votre modèle en plaçant des balises TBS aux endroits où doivent figurer les données.

Il existe deux types de balises TBS : les champs et les blocs.

Un champ TBS est une balise TBS qui doit être remplacé par une donnée simple. Il est possible de spécifier un format d'affichage ainsi que d'autres paramètres. La syntaxe des champs TBS est décrite ci-après.

Un bloc TBS est une région qui devra être répétée. Il est défini par une ou deux balises TBS.
Le plus souvent il s'agit d'une ligne d'un tableau HTML. La syntaxe des blocs TBS est décrite ci-après.


Les champs TBS :
Un champ TBS est une balise TBS qui doit être remplacé par une donnée simple.
Un champ TBS doit avoir un nom pour l'identifier (qui n'est pas obligatoirement unique) et il peut avoir des paramètres pour modifier la valeur affichée.

Syntaxe : HTML ... [NomChamp{;param1}{;param2}{;param3}{...}] ... HTML

Élément Description
NomChamp Le nom du champ.
Attention : les noms de champs commençant par var. , onload et onshow sont réservés pour les champs [var], les champs automatiques.
param1 Facultatif. Un ou plusieurs paramètres de la liste ci-dessous, séparés par des ';'.
Certains paramètres peuvent être affectés d'une valeur en utilisant le caractère '='.
Exemple : frm=0.00
Si la valeur du paramètre contient des espaces, des points-virgules ou des guillemets, alors vous pouvez utiliser les guillemets simples comme délimiteurs.
Exemple : frm='0 000.00'
Utilisez deux guillemets simples pour définir un caractère guillemet dans une chaîne délimitée.
Exemple : ifempty='coucou c''est moi'

Il est possible d'imbriquer des champs TBS les uns dans les autres.
Cela veut dire que vous pouvez écrire ceci : [var.v1; if [var.v2]=1]. Mais :
- pour les champs [var], vous devez vous assurer que v2 sera fusionné avant v1.
- pour les champs de blocs, vous devez vous assurer que la colonne v2 est avant la colonne v1.

Paramètres des champs :

Paramètre Description
htmlconv=val Permet de forcer ou empêcher la conversion de la donnée en texte Html.
La valeur val peut être l'un des mots-clés suivants :
yes : (valeur par défaut) Force la conversion en Html avec sauts de ligne.
no : Empêche la conversion en Html. Utile pour modifier du code Javascript ou modifier le source HTML.
nobr : Force la conversion en Html sans les sauts de ligne (utile pour la balise <pre> par exemple).
wsp : Préserve les espaces blancs (utile pour les espaces de début de ligne).
esc : Pas de conversion Html et double les caractères guillemets simples (').
js : Convertie la donnée en une chaîne qui peut être insérée entre des délimiteurs texte JavaScript
look : Convertie la donnée en Html si aucune balise Html n'est trouvée dans cette donnée.
Vous pouvez spécifier plusieurs mots-clés en utilisant le séparateur '+'. Exemple : htmlconv=yes+js
. (point) Si la donnée est vide, on affiche un espace Html insécable. Utile pour les cellules d'un tableau.
ifempty=val Si la donnée est vide, on la remplace par la valeur indiquée.
att=chemin Déplace le champ en cours dans un attribut d'une balise XML/HTML avant d'être fusionné. Ce paramètre est très utile quand il est trop difficile pour le concepteur du modèle de placer un champ TBS dans un attribut.
La valeur chemin doit indiquer l'emplacement de l'attribut relativement au champ en cours.
Si l'attribut n'existe pas dans la balise spécifiée, alors il est crée.
Si l'attribut existe déjà dans la balise spécifiée et qu'il a déjà une valeur, alors le champ remplace toute la valeur en cours.
Vous pouvez choisir de placer le champ en tant que valeur ajoutée grâce au paramètre attadd.
Vous pouvez supprimer l'attribut en cas de valeur vide grâce au paramètre magnet=#.

Syntaxe pour la valeur chemin : [+][balise1+balise2+balise3+...#]attribut
Par défaut, l'attribut est recherché avant le champ en cours. Mais si '+' est le premier caractère du chemin alors il est cherché après. Si aucune liste de balise n'est spécifiée alors l'attribut est regardé dans la première balise rencontrée dans la direction de la recherche. Si une liste de balise est utilisée, balise1 est recherché en premier, puis balise2, ... indépendamment du sens de la recherche (avant/après). Vous pouvez placer un nom de balise entre un ou plusieurs niveaux de parenthèses afin de spécifier que la balise recherchée doit encapsuler le champ en cours.

Exemples :
[var.x;att=class] se déplace dans l' attribut 'class' de la première balise placée avant.
[var.x;att=div#class] se déplace dans l' attribut 'class' du premier <div> placé avant.
[var.x;att=+div#class] se déplace dans l' attribut 'class' du premier <div> placé après.
[var.x;att=((div))#class] se déplace dans l' attribut 'class' du second <div> encapsulant placé avant.
[var.x;att=table+div#class] se déplace dans l' attribut 'class' du premier <div> après le premier <table> placé avant.

Remarques :
- La méthode MergeBlock() ne peut pas déplacer un champ TBS par dessus un autre champ TBS placé après lui. Cela produit une erreur TBS.
- Quand un attribut n'aucune valeur avant que le champ ne soit déplacé, alors TBS choisoi quel délimiteur de chaine il doit utiliser en fonction des autres attributs (XML/HTML accepte (") et (')). Vous pouvez forcer le délimiteur que vous voulez à l'aide de la propriété $TBS->AttDelim.

Historique: Le paramètre att est supporté depuis TBS version 3.5.0
attadd S'utilise avec la paramètre att. Indique que le champ s'ajoute à la valeur de l'attribut au lieu remplacer la valeur de l'attribut.
Historique: Le paramètre attadd est supporté depuis TBS version 3.5.0
magnet=tag
ou
magnet=expr
Assigne une balise Html magnétique à un champ TBS. Une balise magnétique est gardée telle quelle quand le champ à une valeur, et elle est supprimée quand le champ est null ou chaîne vide. Le paramètre magnet a la même syntaxe que le paramètre block, c'est à dire que expr doit être une balise Html ou une expression de bloc étendu.
Exemple :
(<a href="[var.lien;magnet=a]">cliquez ici</a>)
Résultat pour $lien='www.tbs.com': (<a href="www.tbs.com">cliquez ici</a>)
Résultat pour $lien='': ()
Par défaut, la balise Html magnétique doit être un couple de balises ouvrante-fermante (comme <a></a>) dont la première balise est placée avant le champ TBS. Mais cela peut être changé en utilisant le paramètre mtype (voir ci-après).
Depuis TBS version 3.3.0, les paramètres ope=nif:x et ope=minv peuvent améliorer l'utilisation du paramètre magnet.
Remarque : les paramètres if then else sont traités avant le paramètre magnet.
mtype=val S'utilise avec la paramètre magnet. Définit le comportement de la balise magnétique.

Valeur Comportement magnétique lorsque le champ est nul ou chaîne vide
m*m C'est la valeur par défaut. Supprime le couple de balises qui entoure le champ TBS. Tout ce qui se trouve entre ces balises est aussi supprimé. Il est possible de placer le champ TBS à l'intérieur de l'une des balises.
Exemple :
(<a href="[var.lien;magnet=a]">cliquez ici</a>)
Résultat pour $lien='www.tbs.com': (<a href="www.tbs.com">cliquez ici</a>)
Resultat pour $lien='': ()
m+m Supprime le couple de balises qui entoure le champ TBS, mais conserve ce qui est entre les balises.
Exemple :
(<a href="mailto:[blk.email;magnet=a;mtype=m+m]">[blk.nom]</a>)
Résultat pour $email='moi@tbs.com': (<a href="mailto:moi@tbs.com">MonNom</a>)
Résultat pour $email='': (MyName)
m* Supprime la balise simple qui se trouve avant le champ TBS, ainsi que tout de qui se trouve entre la balise et le champ.
Exemple 1: <img href="[var.link;magnet=img;mtype=m*]">
Exemple 2: <br> [var.address;magnet=br]
*m Supprime la balise simple qui se trouve après le champ TBS, ainsi que tout de qui se trouve entre la balise et le champ.
Exemple : [var.address;magnet=br;mtype=*m]<br>
comm Étendre les limites du champ TBS jusqu'aux limites de la balise Html commentaire Html qui l'entoure, ou bien jusqu'aux limites d'un autre couple de balise Html.
Exemple :
xxx <!-- [mochamp;comm] des commentaires ici --> yyy
ou
xxx <div> [monchamp;comm=div] des commentaires ici </div> yyy
sont strictement identiques à :
xxx [monchamp] yyy
Ce paramètre particulièrement pratique pour l'élaboration du modèle avec un éditeur HTML visuel (tel que Dreamweaver ou FrontPage).
Historique : Le support pour les balises Html autres que commentaire a été ajouté à TBS 3.0.
noerr Empêche l'affichage de certains messages d'erreurs TBS. Quand un message peut être annulé, cela est mentionné dans le message.
file=nomfichier Remplace le champ par le contenu du fichier. Nomfichier peut être une chaîne fixe ou une expression.
Vous pouvez utiliser le mot-clé [val] dans l'expression pour insérer la valeur du champ en cours.
Vous pouvez utiliser des champs [var] dans l'expression.
Exemples :
[onload;file=entete.html]
[onload;file=[var.fichier]]
Si le fichier n'est pas trouvé il sera aussi recherché dans le répertoire du dernier modèle chargé (depuis TBS version 3.2.0).
Si nomfichier est une chaîne vide, alors aucun message d'erreur n'est affiché, c'est comme si le paramètre file est ignoré. Cela peut être utilisé pour gérer l'insertion conditionnelle de fichier.
Exemple :
[onload;file=[var.insertion;if [val]=1;then 'entete.html';else '']]
Vous trouverez plus de détails sur ce paramètre la rubrique Sous-modèles.
Voir aussi : getbody script
getbody=listebalise S'utilise avec le paramètre file ou script. Indique qu'on ne charge pas le fichier entièrement mais seulement certaines parties XML/HTML définie par la liste de balises. Les balises de la liste doivent être séparées par des plus (+), et placées entre parenthèses si vous voulez que les balises elles-mêmes soient récupérées avec leur contenu. Si le fichier contient plusieurs patries XML/HTML, alors toutes ces parties seront automatiquement concaténées. Si le paramètre getbody est utilisé sans valeur, alors la balise <body> est prise par défaut.
Exemple :
[onload;file=entete.htm;getbody=(script)+(style)+body]

Historique : le paramètre getbody est supporté depuis TBS version 3.0. Dans les versions précédentes, il était opéré automatiquement lors de l'utilisation du paramètre file. Maintenant il devient explicite.
La liste de balise est supportée depuis TBS version 3.5.0. Avant cette version, la valeur de getbody ne peut être qu'une balise unique sans parenthèses.
script=nomfichier Exécute le script PHP juste avant le remplacement du champ.
Nomfichier peut être une chaîne fixe ou une expression.
Vous pouvez utiliser le mot-clé [val] dans l'expression pour insérer la valeur du champ en cours.
Vous pouvez utiliser des champs [var] dans l'expression.
Si le fichier n'est pas trouvé il sera aussi recherché dans le répertoire du dernier modèle chargé (depuis TBS version 3.2.0).
* Tenez compte du fait que dans votre script les variables PHP seront forcément locales au lieu de globales. Cela est dû à ce que le script est appelé depuis une méthode de TBS. Pour atteindre ou définir une variable globale dans votre script, vous devez utiliser l'instruction Php global ou le tableau $GLOBAL.
* TBS met à disposition des variables locales prédéfinies que vous pouvez utiliser dans votre script :
- $CurrVal se réfère à la valeur du champ en cours. Elle peut être modifiée.
- $CurrPrm se réfère au tableau de paramètre du champ en cours.
- $this se réfère à l'instance en cours de TBS. (Voir le paramètre subtpl pour un bon usage)
* Le paramètre script est sensible au paramètre if. Si le champ possède un paramètre if, alors le script n'est exécuté que si la condition est vérifiée.
Voir le chapitre Sous-modèles pour plus d'information sur l'utilisation de ce paramètre en mode sous-modèle.
subtpl S'utilise avec le paramètre script ou onformat.
Active le mode sous-modèle pendant l'exécution du script ou de la fonction.
Voir le chapitre Sous-modèles pour plus d'information.
if exp1=exp2 Affiche la donnée si la condition est vérifiée, sinon n'affiche rien à moins que les paramètres then ou else soient utilisés.
Les opérateurs supportés sont :
= ou == égale
!= différent
+- supérieur strictement
+=- supérieur ou égal
-+ inférieur strictement
-=+ inférieur ou égal
~= vérifie l'expression rationnelle (depuis TBS version 3.0)
exp1 et exp2 doivent être des expressions numériques ou textes.
Vous pouvez utiliser le mot-clé [val] dans l'expression pour insérer la valeur du champ en cours.
Vous pouvez utiliser des champs [var] dans l'expression.
Les expressions peuvent contenir d'autres champs TBS, mais vous devez vous assurer qu'ils soient fusionnés avant le champ contenant.
Depuis TBS version 3.0, il est aussi possible de définir plusieurs couple de if/then dans le même champ.
Voir paramètres then et else pour des exemples.
then val1 Si le paramètre if a été défini et que sa condition est vérifiée, alors la donnée sera replacée par val1.
Depuis TBS version 3.0, il est aussi possible de définir plusieurs couples de if/then dans le même champ.
Exemple :
[var.image;if [val]='';then 'image0.gif']
[var.x;if [val]=1;then 'un';if [val]=2;then 'deux';else 'plus']
Vous pouvez utiliser le mot-clé [val] dans l'expression pour insérer la valeur du champ en cours.
Vous pouvez utiliser des champs [var] dans l'expression.
else val2 Si le paramètre if a été défini et que sa condition n'est pas vérifiée, alors la donnée sera replacée par val2.
Exemple :
[var.error_id;if [val]=0;then 'pas d''erreur';else 'erreur constatée']
Vous pouvez utiliser le mot-clé [val] dans l'expression pour insérer la valeur du champ en cours.
Vous pouvez utiliser des champs [var] dans l'expression.
onformat=nom_fct Indique le nom d'un fonction PHP utilisateur qui sera exécutée avant la fusion du champ.
Depuis TBS version 3.0, il est aussi possible d'indiquer une méthode de classe (voir POO).
La fonction nom_fct doit avoir la syntaxe suivante :
  function nom_fct($NomChamp,&$CurrVal,{&$CurrPrm,{&$TBS}}) { ... }
  Argument Description
  $NomChamp Retourne le nom du champ qui appel la fonction (lecture seule).
  $CurrVal Retourne la valeur en cours (lecture/écriture ; ne pas oublier le & dans la déclaration de la variable).
  $CurrPrm Facultatif. Fait référence au tableau des paramètres du champ courant (ne pas oublier le & dans la déclaration de la variable).
  $TBS Facultatif. Fait référence à l'instance courante de TBS. (ne pas oublier le & dans la déclaration de la variable).
Utilisez cet argument avec prudence. Il est fournit pour le mode Sous-modèle.
Voir le paragraphe 'Sous-modèles' pour plus de détails sur l'utilisation de ces arguments en mode sous-modèle.
protect=val Permet de protéger ou non la donnée à fusionner en remplaçant les caractères '[' pour leur équivalent Html '&#91;'. La valeur val peut être l'un des mots-clés suivants :
  yes : (valeur par défaut) la donnée est protégée.
  no : la donnée n'est pas protégée.
Par défaut, toutes données fusionnées avec un modèle sont protégées sauf s'il s'agit de l'inclusion d'un autre fichier. Il est fortement recommandé de protéger les valeurs affichées lorsque qu'il s'agit de données saisies librement comme sur un forum par exemple.
Il est néanmoins possible de désactiver la protection par défaut en mettant la propriété $TBS->Protect à false.
ope=action Effectue une ou plusieurs opérations sur la valeur à fusionner. Vous pouvez définir plusieurs opération à exécuter en ordre en les séparant par des virgules (,).
Exemple :
[var.x;ope=add:-1,mod:10]
Les opérations supportées sont :
max:n Limite la chaîne texte à un maximum de (n) caractères. Si la chaîne est coupée, alors sa fin est remplacée par des pointillés '...'.
Exemple : [var.libelle;ope=max:10]
Ajoutez le paramètre maxhtml pour indiquer que la valeur à fusionner peut contenir des caractères Html. Ajoutez le paramètre maxend pour changer le symbole de coupe.
Exemple : [var.libelle;ope=max:10;maxhtml;maxend='+']
mod:n Applique le modulo n à la valeur à fusionner. Exemple : [var.numlig;ope=mod:7]
add:n Ajoute le numérique n à la valeur à fusionner. Exemple : [var.numero;ope=add:-1]
mul:n Mutliplie la valeur à fusionner par n.
div:n Divise la valeur à fusionner par n.
list Si la valeur à fusionner est un tableau Php, alors ses items sont affichés séparés par une virgule (,).
Exemple : [var.tableau;ope=list]
Ajoutez le paramètre valsep pour changer le séparateur d'item.
Exemple : [var.tableau;ope=list;valsep='+']
nif:x Si la valeur est égale à 'x' alors elle est remplacée par '' (chaîne vide). Cette opération est conçue pour faire fonctionner le paramètre magnet avec d'autres valeurs que ''. (supporté depuis TBS version 3.3.0)
minv Remplace la valeur par '' (chaîne vide) mais le paramètre magnet ne prendra en compte que l'ancienne valeur. Cette opération est conçue pour rendre complètement invisible un champ TBS qui actionne un magnet. (supporté depuis TBS version 3.3.0)
Historique :
- Le paramètre ope est supporté depuis TBS version 3.0. Il remplace le paramètre max qui n'existe plus depuis cette version.
- Les opérations multiples et "mul" et "div" sont supportées depuis TBS version 3.2.0
frm=format Spécifie un format d'affichage pour une donnée de type date/heure ou numérique. Il est possible d'utiliser un format conditionnel qui change selon le signe de la valeur. Le format est considéré de type numérique s'il contient le caractère 0, sinon il est considéré de type date/heure. La valeur à fusionner n'influe pas sur le type de format.

Format date/heure :

Il s'agit d'un format semblable au format VisualBasic. Les mots-clés suivants sont reconnus :
d, dd, ddd, dddd : numéro du jour, numéro du jour sur deux chiffres, nom du jour court, nom du jour complet. Ajoutez le mot-clé (locale) pour afficher des noms locaux.
xx affiche st, nd, rd ou th selon le numéro du jour.
w numéro de jour de la semaine (de 0 à 6)
m, mm, mmm, mmmm : numéro du mois, numéros du mois sur deux chiffres, nom du mois court, nom du mois complet. Ajoutez le mot-clé (locale) pour afficher des noms locaux.
yy, yyyy : année sur deux chiffes, années complète.
hh, rr, nn, ss : heure-24, heure-12, minutes, secondes forcées à deux chiffres.
h, r heure-24, heure-12
ampm, AMPM : indice "am" ou "pm", indice "AM" ou "PM".
(locale) Affiche des noms de jour et de mois locaux. Le langage local peut être défini à l'aide de la fonction PHP setlocale(). Elle ne fonctionne que si les paramètres locaux ont été définis sur le serveur. Pour des raisons propres à PHP, en mode local xx ne fonctionne pas et d fait comme dd.

Les autres caractères sont conservés. Il est possible de mettre de protéger des chaînes texte en les plaçant entre guillemets doubles (").

Exemples :
[chp;frm=dd/mm/yyyy] affichera 21/12/2002
[chp;frm='yyyy-mm-dd hh:nn:ss'] affichera 2002-12-21 15:45:03

Historique :
- Les mots-clés ampm et AMPM sont supportés depuis TBS version 3.0.
- Le mot-clé hm supportés depuis TBS version 3.0 est déprécié et remplacé par rr depuis TBS 3.2.0.
- Les mots-clés rr, r et h sont supportés depuis TBS version 3.2.0.
- Me mot-clé (locale) est supporté depuis TBS version 3.4.0.


Format numérique :

Pour définir la partie décimale, utilisez un expression du type '0x0...' où 'x' est le séparateur de décimal, et '0...' est une répétition de zéro correspondant au nombre de décimales.
S'il n'y a aucune décimale, utilisez le format '0.' (avec un point).

Pour définir un séparateur de milliers, utilisez une expression du type '0z000x...' où 'z' est le séparateur de milliers. S'il n'y a aucune décimale, utilisez le format '0z000.' (avec un point).

Si le format contient le caractère '%', alors la valeur affichée sera multipliée par 100. Le caractère '%' reste affiché.

Le format numérique peut contenir d'autres chaînes texte. Mais seule l'expression de zéro placée la plus à droite sera considérée comme un format, les autres caractères seront conservés.

Exemples :
Valeur Champ Affichage
2456,1426 [chp;frm='0,000'] 2456,143
  [