$tpl->assign($name, $value);

This method allows you to create a template variable. A template variable is only accessible in the template level. You will then use this method to pass data (static values, objects, iterators, etc) to the template to be able to use it for content generation.

You can also create or modify a variable directly in the template, using:

  {assign $name = $value}

• *Important** : the name of a template variable should follow syntaxic rules for a name of a PHP variable. the name should contain only letters, numbers or "_".

Same purpose of the assign method, but the value is assigned only if the variable doesn't exist.

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

The params parameters is optional. This method is a shortcut for:

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

Same as assignZone, but the content of the zone is assigned only if the variable doesn't exist.

If you want to get the value of a template variable that is already initialized, you can use this method :

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

There are two other methods that you nearly won't us because the jResponse objects do it instead of you :

• display ($tplSelector) : launching the generation of content of the template indicated in the selector passed as argument and sends it directly to the browser.
• fetch ($tplSelector) : the same as display, except that it sends the content in return.

After variables are created and initialized, you can call the "fetch" method to generate the content of the template, and to retrieve it. You give the selector of the file template as the first parameter.

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

You call this method only if you have instanciate the jTpl object. In other case, you needn't to call it.

There is an other method you won't never call, since jResponse objects use it : display.

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

It generates the content and ouput it directly.

Statements in jTpl are specified between curly braces : {instruction ...}

If you want to include curly braces in the template, in an other context than a jtpl statement, you can use {ldelim} for "{", or {rdelim} for "}".

If you have a block with several curly braces, like in a piece of code of javascript, you can use {literal} instead of {ldelim} or {rdelim}.

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

If you want to put comments which won't be include in the resulting content, use {*...*}

   <p>bla bla</p>
   {* this is a comment *}

A jtpl expression is identical to a PHP expression, and return a value, like in PHP. You can use classical PHP operators, objects, array etc. You can use also template variables, like any PHP variables.

   $template_variable

An expression can also contain some selector of locales, by using a specific syntax. This selectors should be introduced between two "@".

   @my_module~key.localized.string@."fooo bar"

It is equal to this PHP code :

   jLocale("my_module~key.localized.string")."fooo bar"

Inside a locale key, you can use some template variables. It allows to construct dynamically a locale key:

   @my_module~key.$variable.string@."fooo bar"

It is equal to this PHP code :

   jLocale("my_module~key.".$variable.".string")."fooo bar"

To display the result of an expression, you should put it between curly braces. The first element of the expression should be a variable or a locale selector.

  {$myvariable}
  {$myvariable * 3}
  {$myvariable." - ".@mod~message.ok@}
  {@modul~a.key.of.locale@."-".$anOtherVariable}
  {@modul~a.key.$dynamique@."-".$anOtherVariable}

This is equal to

  <?php echo $myvariable; ?>
  <?php echo $myvariable * 3; ?>
  <?php echo $myvariable." - ".jLocale::get("mod~message.ok"); ?>
  <?php echo jLocale::get("modul~a.key.of.locale")."-".$anOtherVariable; ?>
  <?php echo jLocale::get("modul~a.key.".$dynamique)."-".$anOtherVariable; ?>

Some variables are predefined so you have not to assign them:

• $j_basepath : it contains the url path of the directory of the application (this is the value of the parameter "basePath" in the configuration)
• $j_jelixwww : it contains the url path of the directory jelix-www (this is the value of the parameter "jelixWWWPath" in the configuration)
• $j_themepath : it contains the url path of the directory of the current theme in www
• $j_datenow : current date (aaaa-mm-jj)
• $j_timenow : current hour (hh:mm:ss)

A modifier is a function which modify the output of an expression. You can use many modifiers at the same time. It works in fact like modifiers of Smarty:

  {$avariable|upper}
  {$avariable|upper|escxml}
  {$aUrl|escurl}

It is equal to:

  <?php echo strtoupper($avariable);?>
  <?php echo htmlspecialchars(strtoupper($avariable));?>
  <?php echo rawurlencode($aUrl);?>

Some modifiers, like those in the previous exemple, are simple alias to some native PHP functions:

• upper (strtoupper)
• lower (strtolower)
• escxml (htmlspecialchars)
• strip_tags (strip_tags)
• escurl (rawurlencode)
• capitalize (ucwords)

Many others are function defined in plugins for jTpl. See the list in the API reference

modifiers with parameters ¶

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

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

Note : parentheses are not needed around the condition.

  {while condition}
    // code here
  {/while}

Note : parentheses are not needed around the condition.

  {foreach expression}
    // code here
  {/foreach}

Note : don't use parentheses

  {for expression}
    // code here
  {/for}

The expression should be identical as the expression of the "for" in PHP. However, you mustn't use parentheses.