The Templating Component

2.1 version

Unmaintained

2.0 2.1 2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3

The Templating Component

The Templating Component¶

Templating provides all the tools needed to build any kind of template system.

It provides an infrastructure to load template files and optionally monitor them for changes. It also provides a concrete template engine implementation using PHP with additional tools for escaping and separating templates into blocks and layouts.

Installation¶

You can install the component in 2 different ways:

Use the official Git repository (https://github.com/symfony/Templating);
Install it via Composer (symfony/templating on Packagist).

Usage¶

The Symfony\Component\Templating\PhpEngine class is the entry point of the component. It needs a template name parser (Symfony\Component\Templating\TemplateNameParserInterface) to convert a template name to a template reference and template loader (Symfony\Component\Templating\Loader\LoaderInterface) to find the template associated to a reference:

use Symfony\Component\Templating\PhpEngine;
use Symfony\Component\Templating\TemplateNameParser;
use Symfony\Component\Templating\Loader\FilesystemLoader;

$loader = new FilesystemLoader(__DIR__ . '/views/%name%');

$view = new PhpEngine(new TemplateNameParser(), $loader);

echo $view->render('hello.php', array('firstname' => 'Fabien'));

The render() method executes the file views/hello.php and returns the output text.

<!-- views/hello.php -->
Hello, <?php echo $firstname ?>!

Template Inheritance with Slots¶

The template inheritance is designed to share layouts with many templates.

<!-- views/layout.php -->
<html>
    <head>
        <title><?php $view['slots']->output('title', 'Default title') ?></title>
    </head>
    <body>
        <?php $view['slots']->output('_content') ?>
    </body>
</html>

The extend() method is called in the sub-template to set its parent template.

<!-- views/page.php -->
<?php $view->extend('layout.php') ?>

<?php $view['slots']->set('title', $page->title) ?>

<h1>
    <?php echo $page->title ?>
</h1>
<p>
    <?php echo $page->body ?>
</p>

To use template inheritance, the Symfony\Component\Templating\Helper\SlotsHelper helper must be registered:

use Symfony\Component\Templating\Helper\SlotsHelper;

$view->set(new SlotsHelper());

// Retrieve page object
$page = ...;

echo $view->render('page.php', array('page' => $page));

Note

Multiple levels of inheritance is possible: a layout can extend an other layout.

Output Escaping¶

This documentation is still being written.

The Asset Helper¶

This documentation is still being written.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.