$tpl->assign($nom, $valeur);

Cette méthode vous permet de créer une variable de template. Une variable de template n'est accessible qu'au niveau du template. C'est avec cette méthode que vous pouvez donc passer des données (valeurs statiques, objets, itérateurs, etc..) au template pour vous en servir à générer du contenu.

Vous pouvez également créer ou modifier une variable directement dans le fichier tpl en utilisant.

  {assign $nom = $valeur}

• *Important** : le nom de la variable de template doit respecter les conventions de nommage des noms de variables PHP. Par exemple, le nom ne doit pas contenir de tiret ou d'autres signes de ponctuations. Il ne doit contenir que des lettres avec éventuellement des chiffres et le caractère souligné (_).

Idem que assign, à ceci prés que la valeur est passée par référence, ce qui évite une copie et donc une consommation de la mémoire excessive. À utiliser par exemple si vous passez des tableaux volumineux.

Idem que assign, mais la valeur est assignée à la variable uniquement si celle-ci n'existe pas.

    $tpl->assignZone($name, $zoneSelector, $params);

Le paramètre params est facultatif. Cette méthode est un raccourci de :

   $tpl->assign($name, jZone::get($zoneSelector, $params));

Idem que assignZone, mais la valeur est assignée à la variable uniquement si celle-ci n'existe pas.

Si vous voulez récupérer la valeur d'une variable de template déjà initialisée, vous pouvez utiliser cette méthode.

  $value = $tpl->get('foo');

Une fois que les variables sont initialisées, vous pouvez appeler la méthode fetch pour générer le contenu du template et le récupérer. Vous donnerez à cette méthode le sélecteur du fichier de template.

  $contenu = $tpl->fetch('mymodule~mytemplate');

L'appel de cette méthode n'est indispensable que dans le cas où vous avez instancié vous même l'objet jTpl.

Il existe une autre méthode, mais que vous n'appellerez certainement jamais puisque les objets jResponse le font à votre place : display.

  $tpl->display('mymodule~mytemplate');

Le contenu du template est évalué et affiché directement.

Les instructions jTpl sont spécifiées entre accolades : {instruction....}.

Si vous voulez inclure des accolades dans le source, sans que ce soit interprété par jTpl, vous pouvez utiliser {ldelim} pour {, et {rdelim} pour }. Si vous avez un bloc contenant plusieurs accolades (comme du code javascript), vous pouvez aussi utiliser l'alternative avec {literal} :

  <script type="text/javascript">
   {literal}
      for(i=0;i<max;i++) {
         if(foo){ ...}
      }
   {/literal}
  </script>

Si vous voulez mettre des commentaires qui ne seront pas inclus dans le contenu généré, utilisez {*...*}

   <p>bla bla</p>
   {* ceci est un commentaire *}

Vous pouvez étaler une instruction sur plusieurs lignes :

<div>
{zone 
    'foo~bar',
    array(
        'foo1'=>$foo1,
        'foo2'=>$foo2)}
</div>

Une expression jTpl est identique à une expression PHP et renvoie, comme dans PHP, une valeur. Vous pouvez utiliser les opérateurs PHP classiques, les objets, etc... Vous utiliserez les expressions au niveau des arguments des instructions jtpl. On peut utiliser les variables de templates qu'on a passé à jTpl, comme des variables classiques en PHP. Voici un exemple d'expression simple :

   $nom_variable_de_template

Une expression peut contenir aussi des sélecteurs de locale, en utilisant une syntaxe spécifique à jTpl. Ce type de sélecteur doit être placé entre "@". jTpl ira chercher la chaîne correspondante dans la langue courante :

   @mon_module~cle.chaine.localisee@."fooo bar"

La chaîne correspondant à mon_module~cle.chaine.localisee sera récupérée et concaténée à "fooo bar".

À l'intérieur du nom de la clé, on peut indiquer un nom de variable de template. Cela permet ainsi de construire un nom de clé dynamiquement.

   @mon_module~cle.chaine.$nom_variable_template.autre@."fooo bar"

si $nom_variable_template vaut "foo", alors la clé sera "mon_module~cle.chaine.foo.autre". Cette expression est équivalente au code php :

   jLocale("on_module~cle.".$nom_variable_template.".autre")."fooo bar"

Il faut mettre l'expression entre accolades. Elle doit commencer par un nom de variable ou par un sélecteur de locale :

  {$mavariable}
  {$mavariable * 3}
  {$mavariable." - ".@mod~message.ok@}
  {@modul~une.cle.de.locale@."-".$uneAutreVariable}
  {@modul~une.cle.$dynamique@."-".$uneAutreVariable}

Ceci est équivalent en php à

  <?php echo $mavariable; ?>
  <?php echo $mavariable * 3; ?>
  <?php echo $mavariable." - ".jLocale::get("mod~message.ok"); ?>
  <?php echo jLocale::get("modul~une.cle.de.locale")."-".$uneAutreVariable; ?>
  <?php echo jLocale::get("modul~une.cle.".$dynamique)."-".$uneAutreVariable; ?>

Pour les expressions plus complexes ne commençant pas par un nom de variable ou de locale, on peut utiliser le signe "=" :

  {=$mavariable}
  {=intval($mavariable) * 65}

Pour apporter une certaine facilité, des variables de templates prédéfinies ont été ajoutées :

• $j_basepath : contient le chemin url du répertoire de l'application (paramètre de configuration basePath)
• $j_jelixwww : contient le chemin url vers le contenu du répertoire jelix-www (paramètre de configuration jelixWWWPath)
• $j_themepath : contient le chemin url vers le répertoire du thème courant
• $j_datenow : date courante (aaaa-mm-jj)
• $j_timenow : heure courante (hh:mm:ss)
• $j_locale : code de la langue courante (valeur de $gJConfig->locale)

Un modificateur est en fait une fonction qui va modifier le contenu qui va être affiché. Cela fonctionne comme dans smarty. On peut mettre plusieurs modificateurs à la suite :

  {$unevariable|upper}
  {$unevariable|upper|escxml}
  {$uneUrl|escurl}

Ceci est en fait équivalent à :

  <?php echo strtoupper($unevariable);?>
  <?php echo htmlspecialchars(strtoupper($unevariable));?>
  <?php echo rawurlencode($uneUrl);?>

Les modificateurs indiqués en exemple sont de simples alias à des fonctions existantes, mais vous pouvez créer vos propres modificateurs, pouvant accepter plusieurs arguments.

Les modificateurs existants et leur équivalent php :

• upper (strtoupper)
• lower (strtolower)
• escxml and eschtml (htmlspecialchars)
• strip_tags (strip_tags)
• escurl (rawurlencode)
• capitalize (ucwords)
• stripslashes (stripslashes)
• upperfirst (ucfirst)

D'autres sont fournis. Voir la liste sur la référence API.

Modificateur avec paramètres ¶

  <p>la date est {$myDate|jdatetime:'db_date','timestamp'}.</p>

  {if condition_1}
     // code ici
  {elseif condition_2}
     // code ici
  {else}
     // code ici
  {/if}

Notez aussi qu'il y a des plugins pour faire des "if" specifiques comme @@ifacl2 'un.droit'@@ pour tester un droit. Avec tout ces plugins en "if", vous pouvez utiliser un else.

Boucle conditionnelle:

  {while condition}
    // code ici
  {/while}

Boucle sur un iterateur ou un tableau:

  {foreach $iterateur_ou_tableau as $cle => $valeur}
    // code ici
  {/foreach}

  {for expression}
    // code ici
  {/for}

L'expression est bien sûr semblable à celle du "for" en PHP.

Vous pouvez avoir l'équivalent d'un break dans une boucle, en utilisant {break} :

  {while condition}
    ...
     {if ...}  {break} {/if}
    ....
  {/while}