Back to top
You are here: start / documentation / rack / reference / templates

Page Tools

Show page Old revisions Backlinks

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
documentation:rack:reference:templates [2018/05/25 17:44] – [Template inheritance] Martijn Luinstradocumentation:rack:reference:templates [2023/08/31 21:12] (current) – Martijn Luinstra
Line 1: Line 1:
 ====== Templates ====== ====== Templates ======
  
-Every template is an instance of the <php>Template</php> class defined in ''include/utils.php''.+Every template is an instance of the ''Template'' class defined in ''include/utils.php''. Rack templates are parsed and executed as PHP and therefore can execute arbitrary PHP code. However, it is advised to keep it simple in order to maintain separation between rendering and internal logic. This page covers the documentation of functionality that is specific to templates. 
 + 
 +<WRAP danger>**WARNING!** No data is escaped by default. Always explicitly escape your template variables and be careful which data you access in templates.</WRAP> 
 + 
 +===== Template variables (context) ===== 
 + 
 +Templates are intitialized with a context object, which is an associative array. The individual elements of this array are made available in the templates as regular variables (see [[http://php.net/manual/en/function.extract.php|extract]]). Consider the context  
 + 
 +<code php> 
 +$context = [ 
 +  'title' => 'Home', 
 +  'page_id' => 'index' 
 +]; 
 +</code> 
 + 
 +and the template 
 + 
 +<code php> 
 +<html> 
 +  <head> 
 +    <title><?= $title ?></title> 
 +  </head> 
 +  <body> 
 +     <h1><?= $title ?></h1> 
 +     page_id: <?= $page_id ?> 
 +  </body> 
 +</html> 
 +</code> 
 + 
 +which renders as 
 + 
 +<WRAP box round> 
 +====== Home ====== 
 +page_id: index 
 +</WRAP> 
 + 
 +===== Template functions ===== 
 + 
 +All global functions are available in templates. The template class provides the following additional functions for escaping data to prevent XSS attacks. 
 + 
 +  * ''%%html($data)%%'' Escapes data to be used as (part of) an HTML element's content. 
 +  * ''%%attr($data)%%'' Escapes data to be used as (part of) an HTML element's attributes. 
 +  * ''%%format_plain_text($text)%%'' Escapes and wraps paragraphs in ''<p>'' elements. 
 + 
 +Remember! No data is escaped by default. Always explicitly escape your template variables and be careful which data you access in templates. 
 + 
 +The following snippet shows how these functions should be used. 
 + 
 +<code php> 
 +<section> 
 +  <h1><?= $this->html($title) ?></h1> 
 +  <?= $this->format_plain_text($some_text) ?> 
 +  Author: <a href="<?= $this->attr($url_to_author_page) ?>"><?= $this->html($author_name) ?></a> 
 +</section> 
 +</code> 
  
 ===== Template inheritance ===== ===== Template inheritance =====
Line 7: Line 62:
 Rack templates support basic template inheritance, provided by the following functions: Rack templates support basic template inheritance, provided by the following functions:
  
-  * <php>Template->extends($template)</php> This function sets the parent template, where <php>$template</php> as a path relative to the current template. +  * ''%%Template->extends($template)%%'' This function sets the parent template, where <php>$template</php> as a path relative to the current template. 
-  * <php>Template->begin($block_name)</php> This function begins a new block. +  * ''%%Template->begin($block_name)%%'' This function begins a new block. 
-  * <php>Template->end()</php> This function ends a block.+  * ''%%Template->end()%%'' This function ends a block.
  
 Note that nested blocks are not supported and that blocks are only allowed in templates that extend a parent template. Note that nested blocks are not supported and that blocks are only allowed in templates that extend a parent template.
Line 34: Line 89:
 </file> </file>
  
 +===== More control structures =====
  
-===== Context ===== +Rack templates are parsed and executed as PHP and therefore can execute arbitrary PHP code. However, it is advised to keep it simple in order to maintain separation between rendering and internal logic.
- +
-Templates are intitialized with a context object, which is an associative array. The individual elements of this array are made available in the templates as regular variables (see [[http://php.net/manual/en/function.extract.php|extract]]). Consider the context  +
- +
-<PHP> +
-$context = [ +
-  'title' => 'Home', +
-  'page_id' => 'index' +
-]; +
-</PHP> +
- +
-and the template +
- +
-<PHP> +
-<html> +
-  <head> +
-    <title><?= $title ?></title> +
-  </head> +
-  <body> +
-     <h1><?= $title ?></h1> +
-     page_id: <?= $page_id ?> +
-  </body> +
-</html> +
-</PHP> +
- +
-which renders as +
- +
-<HTML> +
-<div style="padding: 1em; border: solid 1px #999; border-radius: 0.2em;"> +
-  <h1>Home</h1> +
-  page_id: index +
-</div> +
-</HTML>\\ +
- +
-===== Template functions =====+
  
 +By convention, templates use the [[http://php.net/manual/en/control-structures.alternative-syntax.php|Alternative syntax]] for PHP control structures. Definitions of non-anonymous functions in templates are forbidden (by design) and anonymous functions should only be used in templates in exceptional situations.
documentation/rack/reference/templates.1527270272.txt.gz · Last modified: 2022/04/03 14:00 (external edit)