| Both sides previous revisionPrevious revision | |
| documentation:rack:reference:templates [2023/08/31 23:06] – Martijn Luinstra | documentation:rack:reference:templates [2023/08/31 23:12] (current) – Martijn Luinstra |
|---|
| ====== Templates ====== | ====== Templates ====== |
| |
| Every template is an instance of the <php>Template</php> 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. | 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> | <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> |
| |
| <WRAP box round> | <WRAP box round> |
| ===== Home ===== | ====== Home ====== |
| page_id: index | page_id: index |
| \\ | |
| \\ | |
| </WRAP> | </WRAP> |
| <HTML> | |
| box | |
| <div style="padding: 1em; border: solid 1px #999; border-radius: 0.2em;"> | |
| <h1>Home</h1> | |
| page_id: index | |
| </div> | |
| </HTML>\\ | |
| |
| ===== Template functions ===== | ===== Template functions ===== |
| All global functions are available in templates. The template class provides the following additional functions for escaping data to prevent XSS attacks. | All global functions are available in templates. The template class provides the following additional functions for escaping data to prevent XSS attacks. |
| |
| * <php>html($data)</php> Escapes data to be used as (part of) an HTML element's content. | * ''%%html($data)%%'' Escapes data to be used as (part of) an HTML element's content. |
| * <php>attr($data)</php> Escapes data to be used as (part of) an HTML element's attributes. | * ''%%attr($data)%%'' Escapes data to be used as (part of) an HTML element's attributes. |
| * <php>format_plain_text($text)</php> Escapes and wraps paragraphs in ''<p>'' elements. | * ''%%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. | Remember! No data is escaped by default. Always explicitly escape your template variables and be careful which data you access in templates. |
| Author: <a href="<?= $this->attr($url_to_author_page) ?>"><?= $this->html($author_name) ?></a> | Author: <a href="<?= $this->attr($url_to_author_page) ?>"><?= $this->html($author_name) ?></a> |
| </section> | </section> |
| </code php> | </code> |
| |
| |
| 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. |