$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 passed by reference, so you can assigne huge array without duplicating them in memory.

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');

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.

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

If you want to include curly braces in your template, outside of a jTpl instruction, 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 *}

You can write an instruction on several lines:

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

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. You use jtpl expressions as arguments of jtpl instructions. Here is a simple expression:

   $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; ?>

Since Jelix 1.1, for more complex expressions , you can use the syntax with =:

  {=$myvariable}
  {=intval($myvariable)*3}

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 example, are simple aliases 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 that some plugins are provided and are specific conditional statements, like ifacl2 'a.right'. You can use the else statement for all of them begining by "if".

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

  {foreach $iterator_or_array as $key=>$value}
    // code here
  {/foreach}

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

The expression should be identical as the expression of the for in PHP.