Twig官方手册

最新推荐文章于 2021-04-12 13:37:26 发布
最新推荐文章于 2021-04-12 13:37:26 发布
阅读量1.5w 收藏 2
点赞数
分类专栏： 编程与应用

原手册被墙了，人工搬运过来。


Introduction

This is the documentation for Twig, the flexible, fast, and secure template engine for PHP.

If you have any exposure to other text-based template languages, such as Smarty, Django, or Jinja, you should feel right at home with Twig. It's both designer and developer friendly by sticking to PHP's principles and adding functionality useful for templating environments.

The key-features are...

  • Fast: Twig compiles templates down to plain optimized PHP code. The overhead compared to regular PHP code was reduced to the very minimum.
  • Secure: Twig has a sandbox mode to evaluate untrusted template code. This allows Twig to be used as a template language for applications where users may modify the template design.
  • Flexible: Twig is powered by a flexible lexer and parser. This allows the developer to define its own custom tags and filters, and create its own DSL.

Prerequisites

Twig needs at least PHP 5.2.4 to run.

Installation

The recommended way to install Twig is via Composer:

1
 
composer require "twig/twig:~1.0"

To learn more about the other installation methods, read the installation chapter; it also explains how to install the Twig C extension.

Basic API Usage

This section gives you a brief introduction to the PHP API for Twig.

1
2
3
4
5
6
7
8
 
require_once '/path/to/vendor/autoload.php';

$loader = new Twig_Loader_Array(
    'index' => 'Hello {{ name }}!',
);
$twig = new Twig_Environment($loader);

echo $twig->render('index', array('name' => 'Fabien'));

Twig uses a loader (Twig_Loader_Array) to locate templates, and an environment (Twig_Environment) to store the configuration.

The render() method loads the template passed as a first argument and renders it with the variables passed as a second argument.

As templates are generally stored on the filesystem, Twig also comes with a filesystem loader:

1
2
3
4
5
6
 
$loader = new Twig_Loader_Filesystem('/path/to/templates');
$twig = new Twig_Environment($loader, array(
    'cache' => '/path/to/compilation_cache',
));

echo $twig->render('index.html', array('name' => 'Fabien'));

If you are not using Composer, use the Twig built-in autoloader:

1
2
 
require_once '/path/to/lib/Twig/Autoloader.php';
Twig_Autoloader::register();

Twig for Developers

This chapter describes the API to Twig and not the template language. It will be most useful as reference to those implementing the template interface to the application and not those who are creating Twig templates.

Basics

Twig uses a central object called the environment (of class Twig_Environment). Instances of this class are used to store the configuration and extensions, and are used to load templates from the file system or other locations.

Most applications will create one Twig_Environment object on application initialization and use that to load templates. In some cases it's however useful to have multiple environments side by side, if different configurations are in use.

The simplest way to configure Twig to load templates for your application looks roughly like this:

1
2
3
4
5
6
7
 
require_once '/path/to/lib/Twig/Autoloader.php';
Twig_Autoloader::register();

$loader = new Twig_Loader_Filesystem('/path/to/templates');
$twig = new Twig_Environment($loader, array(
    'cache' => '/path/to/compilation_cache',
));

This will create a template environment with the default settings and a loader that looks up the templates in the /path/to/templates/ folder. Different loaders are available and you can also write your own if you want to load templates from a database or other resources.

Notice that the second argument of the environment is an array of options. The cache option is a compilation cache directory, where Twig caches the compiled templates to avoid the parsing phase for sub-sequent requests. It is very different from the cache you might want to add for the evaluated templates. For such a need, you can use any available PHP cache library.

To load a template from this environment you just have to call the loadTemplate() method which then returns a Twig_Template instance:

1
 
$template = $twig->loadTemplate('index.html');

To render the template with some variables, call the render() method:

1
 
echo $template->render(array('the' => 'variables', 'go' => 'here'));

The display() method is a shortcut to output the template directly.

You can also load and render the template in one fell swoop:

1
 
echo $twig->render('index.html', array('the' => 'variables', 'go' => 'here'));

Environment Options

When creating a new Twig_Environment instance, you can pass an array of options as the constructor second argument:

1
 
$twig = new Twig_Environment($loader, array('debug' => true));

The following options are available:

  • debug: When set to true, the generated templates have a __toString() method that you can use to display the generated nodes (default to false).
  • charset: The charset used by the templates (default to utf-8).
  • base_template_class: The base template class to use for generated templates (default to Twig_Template).
  • cache: An absolute path where to store the compiled templates, or false to disable caching (which is the default).
  • auto_reload: When developing with Twig, it's useful to recompile the template whenever the source code changes. If you don't provide a value for the auto_reload option, it will be determined automatically based on the debug value.
  • strict_variables: If set to false, Twig will silently ignore invalid variables (variables and or attributes/methods that do not exist) and replace them with a null value. When set to true, Twig throws an exception instead (default to false).
  • autoescape: If set to true, auto-escaping will be enabled by default for all templates (default to true). As of Twig 1.8, you can set the escaping strategy to use (html, js, false to disable). As of Twig 1.9, you can set the escaping strategy to use (css, url, html_attr, or a PHP callback that takes the template "filename" and must return the escaping strategy to use -- the callback cannot be a function name to avoid collision with built-in escaping strategies).
  • optimizations: A flag that indicates which optimizations to apply (default to -1 -- all optimizations are enabled; set it to 0 to disable).

Loaders

Loaders are responsible for loading templates from a resource such as the file system.

Compilation Cache

All template loaders can cache the compiled templates on the filesystem for future reuse. It speeds up Twig a lot as templates are only compiled once; and the performance boost is even larger if you use a PHP accelerator such as APC. See the cache and auto_reloadoptions of Twig_Environment above for more information.

Built-in Loaders

Here is a list of the built-in loaders Twig provides:

Twig_Loader_Filesystem

New in version 1.10: The prependPath() and support for namespaces were added in Twig 1.10.

Twig_Loader_Filesystem loads templates from the file system. This loader can find templates in folders on the file system and is the preferred way to load them:

1
 
$loader = new Twig_Loader_Filesystem($templateDir);

It can also look for templates in an array of directories:

1
 
$loader = new Twig_Loader_Filesystem(array($templateDir1, $templateDir2));

With such a configuration, Twig will first look for templates in $templateDir1 and if they do not exist, it will fallback to look for them in the $templateDir2.

You can add or prepend paths via the addPath() and prependPath() methods:

1
2
 
$loader->addPath($templateDir3);
$loader->prependPath($templateDir4);

The filesystem loader also supports namespaced templates. This allows to group your templates under different namespaces which have their own template paths.

When using the setPaths(), addPath(), and prependPath() methods, specify the namespace as the second argument (when not specified, these methods act on the "main" namespace):

1
 
$loader->addPath($templateDir, 'admin');

Namespaced templates can be accessed via the special @namespace_name/template_path notation:

1
 
$twig->render('@admin/index.html', array());
Twig_Loader_Array

Twig_Loader_Array loads a template from a PHP array. It's passed an array of strings bound to template names:

1
2
3
4
5
6
 
$loader = new Twig_Loader_Array(array(
    'index.html' => 'Hello {{ name }}!',
));
$twig = new Twig_Environment($loader);

echo $twig->render('index.html', array('name' => 'Fabien'));

This loader is very useful for unit testing. It can also be used for small projects where storing all templates in a single PHP file might make sense.

When using the Array or String loaders with a cache mechanism, you should know that a new cache key is generated each time a template content "changes" (the cache key being the source code of the template). If you don't want to see your cache grows out of control, you need to take care of clearing the old cache file by yourself.

Twig_Loader_Chain

Twig_Loader_Chain delegates the loading of templates to other loaders:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
 
$loader1 = new Twig_Loader_Array(array(
    'base.html' => '{% block content %}{% endblock %}',
));
$loader2 = new Twig_Loader_Array(array(
    'index.html' => '{% extends "base.html" %}{% block content %}Hello {{ name }}{% endblock %}',
    'base.html'  => 'Will never be loaded',
));

$loader = new Twig_Loader_Chain(array($loader1, $loader2));

$twig = new Twig_Environment($loader);

When looking for a template, Twig will try each loader in turn and it will return as soon as the template is found. When rendering theindex.html template from the above example, Twig will load it with $loader2 but the base.html template will be loaded from $loader1.

Twig_Loader_Chain accepts any loader that implements Twig_LoaderInterface.

You can also add loaders via the addLoader() method.

Create your own Loader

All loaders implement the Twig_LoaderInterface:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
interface Twig_LoaderInterface
{
    /**
     * Gets the source code of a template, given its name.
     *
     * @param  string $name string The name of the template to load
     *
     * @return string The template source code
     */
    function getSource($name);

    /**
     * Gets the cache key to use for the cache for a given template name.
     *
     * @param  string $name string The name of the template to load
     *
     * @return string The cache key
     */
    function getCacheKey($name);

    /**
     * Returns true if the template is still fresh.
     *
     * @param string    $name The template name
     * @param timestamp $time The last modification time of the cached template
     */
    function isFresh($name, $time);
}

The isFresh() method must return true if the current cached template is still fresh, given the last modification time, or false otherwise.

As of Twig 1.11.0, you can also implement Twig_ExistsLoaderInterface to make your loader faster when used with the chain loader.

Using Extensions

Twig extensions are packages that add new features to Twig. Using an extension is as simple as using the addExtension() method:

1
 
$twig->addExtension(new Twig_Extension_Sandbox());

Twig comes bundled with the following extensions:

  • Twig_Extension_Core: Defines all the core features of Twig.
  • Twig_Extension_Escaper: Adds automatic output-escaping and the possibility to escape/unescape blocks of code.
  • Twig_Extension_Sandbox: Adds a sandbox mode to the default Twig environment, making it safe to evaluate untrusted code.
  • Twig_Extension_Optimizer: Optimizes the node tree before compilation.

The core, escaper, and optimizer extensions do not need to be added to the Twig environment, as they are registered by default.

Built-in Extensions

This section describes the features added by the built-in extensions.

Read the chapter about extending Twig to learn how to create your own extensions.

Core Extension

The core extension defines all the core features of Twig:

Escaper Extension

The escaper extension adds automatic output escaping to Twig. It defines a tag, autoescape, and a filter, raw.

When creating the escaper extension, you can switch on or off the global output escaping strategy:

1
2
 
$escaper = new Twig_Extension_Escaper('html');
$twig->addExtension($escaper);

If set to html, all variables in templates are escaped (using the html escaping strategy), except those using the raw filter:

1
 
{{ article.to_html|raw }}

You can also change the escaping mode locally by using the autoescape tag (see the autoescape doc for the syntax used before Twig 1.8):

1
2
3
4
5
 
{% autoescape 'html' %}
    {{ var }}
    {{ var|raw }}      {# var won't be escaped #}
    {{ var|escape }}   {# var won't be double-escaped #}
{% endautoescape %}

The autoescape tag has no effect on included files.

The escaping rules are implemented as follows:

  • Literals (integers, booleans, arrays, ...) used in the template directly as variables or filter arguments are never automatically escaped:

    1
2
3
4
    		 
    {{ "Twig<br />" }} {# won't be escaped #}

{% set text = "Twig<br />" %}
{{ text }} {# will be escaped #}

  • Expressions which the result is always a literal or a variable marked safe are never automatically escaped:

    {{ foo ? "Twig<br />" : "<br />Twig" }} {# won't be escaped #}

{% set text = "Twig<br />" %}
{{ foo ? text : "<br />Twig" }} {# will be escaped #}

{% set text = "Twig<br />" %}
{{ foo ? text|raw : "<br />Twig" }} {# won't be escaped #}

{% set text = "Twig<br />" %}
{{ foo ? text|escape : "<br />Twig" }} {# the result of the expression won't be escaped #}

  • Escaping is applied before printing, after any other filter is applied:

    1
    		 
    {{ var|upper }} {# is equivalent to {{ var|upper|escape }} #}

  • The raw filter should only be used at the end of the filter chain:

    1
2
3
    		 
    {{ var|raw|upper }} {# will be escaped #}

{{ var|upper|raw }} {# won't be escaped #}

  • Automatic escaping is not applied if the last filter in the chain is marked safe for the current context (e.g. html or js). escape andescape('html') are marked safe for HTML, escape('js') is marked safe for JavaScript, raw is marked safe for everything.

    1
2
3
4
5
    		 
    {% autoescape 'js' %}
    {{ var|escape('html') }} {# will be escaped for HTML and JavaScript #}
    {{ var }} {# will be escaped for JavaScript #}
    {{ var|escape('js') }} {# won't be double-escaped #}
{% endautoescape %}

Note that autoescaping has some limitations as escaping is applied on expressions after evaluation. For instance, when working with concatenation, {{ foo|raw ~ bar }} won't give the expected result as escaping is applied on the result of the concatenation, not on the individual variables (so, the raw filter won't have any effect here).

Sandbox Extension

The sandbox extension can be used to evaluate untrusted code. Access to unsafe attributes and methods is prohibited. The sandbox security is managed by a policy instance. By default, Twig comes with one policy class: Twig_Sandbox_SecurityPolicy. This class allows you to white-list some tags, filters, properties, and methods:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
 
$tags = array('if');
$filters = array('upper');
$methods = array(
    'Article' => array('getTitle', 'getBody'),
);
$properties = array(
    'Article' => array('title', 'body'),
);
$functions = array('range');
$policy = new Twig_Sandbox_SecurityPolicy($tags, $filters, $methods, $properties, $functions);

With the previous configuration, the security policy will only allow usage of the if tag, and the upper filter. Moreover, the templates will only be able to call the getTitle() and getBody() methods on Article objects, and the title and body public properties. Everything else won't be allowed and will generate a Twig_Sandbox_SecurityError exception.

The policy object is the first argument of the sandbox constructor:

1
2
 
$sandbox = new Twig_Extension_Sandbox($policy);
$twig->addExtension($sandbox);

By default, the sandbox mode is disabled and should be enabled when including untrusted template code by using the sandbox tag:

1
2
3
 
{% sandbox %}
    {% include 'user.html' %}
{% endsandbox %}

You can sandbox all templates by passing true as the second argument of the extension constructor:

1
 
$sandbox = new Twig_Extension_Sandbox($policy, true);

Optimizer Extension

The optimizer extension optimizes the node tree before compilation:

1
 
$twig->addExtension(new Twig_Extension_Optimizer());

By default, all optimizations are turned on. You can select the ones you want to enable by passing them to the constructor:

1
2
3
 
$optimizer = new Twig_Extension_Optimizer(Twig_NodeVisitor_Optimizer::OPTIMIZE_FOR);

$twig->addExtension($optimizer);

Twig supports the following optimizations:

  • Twig_NodeVisitor_Optimizer::OPTIMIZE_ALL, enables all optimizations (this is the default value).
  • Twig_NodeVisitor_Optimizer::OPTIMIZE_NONE, disables all optimizations. This reduces the compilation time, but it can increase the execution time and the consumed memory.
  • Twig_NodeVisitor_Optimizer::OPTIMIZE_FOR, optimizes the for tag by removing the loop variable creation whenever possible.
  • Twig_NodeVisitor_Optimizer::OPTIMIZE_RAW_FILTER, removes the raw filter whenever possible.
  • Twig_NodeVisitor_Optimizer::OPTIMIZE_VAR_ACCESS, simplifies the creation and access of variables in the compiled templates whenever possible.

Exceptions

Twig can throw exceptions:

  • Twig_Error: The base exception for all errors.
  • Twig_Error_Syntax: Thrown to tell the user that there is a problem with the template syntax.
  • Twig_Error_Runtime: Thrown when an error occurs at runtime (when a filter does not exist for instance).
  • Twig_Error_Loader: Thrown when an error occurs during template loading.
  • Twig_Sandbox_SecurityError: Thrown when an unallowed tag, filter, or method is called in a sandboxed template.


Extending Twig

This section describes how to extend Twig as of Twig 1.12. If you are using an older version, read the legacy chapter instead.

Twig can be extended in many ways; you can add extra tags, filters, tests, operators, global variables, and functions. You can even extend the parser itself with node visitors.

The first section of this chapter describes how to extend Twig easily. If you want to reuse your changes in different projects or if you want to share them with others, you should then create an extension as described in the following section.

When extending Twig without creating an extension, Twig won't be able to recompile your templates when the PHP code is updated. To see your changes in real-time, either disable template caching or package your code into an extension (see the next section of this chapter).

Before extending Twig, you must understand the differences between all the different possible extension points and when to use them.

First, remember that Twig has two main language constructs:

  • {{ }}: used to print the result of an expression evaluation;
  • {% %}: used to execute statements.

To understand why Twig exposes so many extension points, let's see how to implement a Lorem ipsum generator (it needs to know the number of words to generate).

You can use a lipsum tag:

1
 
{% lipsum 40 %}

That works, but using a tag for lipsum is not a good idea for at least three main reasons:

  • lipsum is not a language construct;

  • The tag outputs something;

  • The tag is not flexible as you cannot use it in an expression:

    {{ 'some text' ~ {% lipsum 40 %} ~ 'some more text' }}

In fact, you rarely need to create tags; and that's good news because tags are the most complex extension point of Twig.

Now, let's use a lipsum filter:

1
 
{{ 40|lipsum }}

Again, it works, but it looks weird. A filter transforms the passed value to something else but here we use the value to indicate the number of words to generate (so, 40 is an argument of the filter, not the value we want to transform).

Next, let's use a lipsum function:

1
 
{{ lipsum(40) }}

Here we go. For this specific example, the creation of a function is the extension point to use. And you can use it anywhere an expression is accepted:

1
2
3
 
{{ 'some text' ~ lipsum(40) ~ 'some more text' }}

{% set lipsum = lipsum(40) %}

Last but not the least, you can also use a global object with a method able to generate lorem ipsum text:

1
 
{{ text.lipsum(40) }}

As a rule of thumb, use functions for frequently used features and global objects for everything else.

Keep in mind the following when you want to extend Twig:

What? Implementation difficulty? How often? When?
macro trivial frequent Content generation
global trivial frequent Helper object
function trivial frequent Content generation
filter trivial frequent Value transformation
tag complex rare DSL language construct
test trivial rare Boolean decision
operator trivial rare Values transformation

Globals

A global variable is like any other template variable, except that it's available in all templates and macros:

1
2
 
$twig = new Twig_Environment($loader);
$twig->addGlobal('text', new Text());

You can then use the text variable anywhere in a template:

1
 
{{ text.lipsum(40) }}

Filters

Creating a filter is as simple as associating a name with a PHP callable:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
 
// an anonymous function
$filter = new Twig_SimpleFilter('rot13', function ($string) {
    return str_rot13($string);
});

// or a simple PHP function
$filter = new Twig_SimpleFilter('rot13', 'str_rot13');

// or a class method
$filter = new Twig_SimpleFilter('rot13', array('SomeClass', 'rot13Filter'));

The first argument passed to the Twig_SimpleFilter constructor is the name of the filter you will use in templates and the second one is the PHP callable to associate with it.

Then, add the filter to your Twig environment:

1
2
 
$twig = new Twig_Environment($loader);
$twig->addFilter($filter);

And here is how to use it in a template:

1
2
3
 
{{ 'Twig'|rot13 }}

{# will output Gjvt #}

When called by Twig, the PHP callable receives the left side of the filter (before the pipe |) as the first argument and the extra arguments passed to the filter (within parentheses ()) as extra arguments.

For instance, the following code:

1
2
 
{{ 'TWIG'|lower }}
{{ now|date('d/m/Y') }}

is compiled to something like the following:

1
2
 
<?php echo strtolower('TWIG') ?>
<?php echo twig_date_format_filter($now, 'd/m/Y') ?>

The Twig_SimpleFilter class takes an array of options as its last argument:

1
 
$filter = new Twig_SimpleFilter('rot13', 'str_rot13', $options);

Environment-aware Filters

If you want to access the current environment instance in your filter, set the needs_environment option to true; Twig will pass the current environment as the first argument to the filter call:

1
2
3
4
5
6
 
$filter = new Twig_SimpleFilter('rot13', function (Twig_Environment $env, $string) {
    // get the current charset for instance
    $charset = $env->getCharset();

    return str_rot13($string);
}, array('needs_environment' => true));

Context-aware Filters

If you want to access the current context in your filter, set the needs_context option to true; Twig will pass the current context as the first argument to the filter call (or the second one if needs_environment is also set to true):

1
2
3
4
5
6
7
 
$filter = new Twig_SimpleFilter('rot13', function ($context, $string) {
    // ...
}, array('needs_context' => true));

$filter = new Twig_SimpleFilter('rot13', function (Twig_Environment $env, $context, $string) {
    // ...
}, array('needs_context' => true, 'needs_environment' => true));

Automatic Escaping

If automatic escaping is enabled, the output of the filter may be escaped before printing. If your filter acts as an escaper (or explicitly outputs HTML or JavaScript code), you will want the raw output to be printed. In such a case, set the is_safe option:

1
 
$filter = new Twig_SimpleFilter('nl2br', 'nl2br', array('is_safe' => array('html')));

Some filters may need to work on input that is already escaped or safe, for example when adding (safe) HTML tags to originally unsafe output. In such a case, set the pre_escape option to escape the input data before it is run through your filter:

1
 
$filter = new Twig_SimpleFilter('somefilter', 'somefilter', array('pre_escape' => 'html', 'is_safe' => array('html')));

Dynamic Filters

A filter name containing the special * character is a dynamic filter as the * can be any string:

1
2
3
 
$filter = new Twig_SimpleFilter('*_path', function ($name, $arguments) {
    // ...
});

The following filters will be matched by the above defined dynamic filter:

  • product_path
  • category_path

A dynamic filter can define more than one dynamic parts:

1
2
3
 
$filter = new Twig_SimpleFilter('*_path_*', function ($name, $suffix, $arguments) {
    // ...
});

The filter will receive all dynamic part values before the normal filter arguments, but after the environment and the context. For instance, a call to 'foo'|a_path_b() will result in the following arguments to be passed to the filter: ('a', 'b', 'foo').

Functions

Functions are defined in the exact same way as filters, but you need to create an instance of Twig_SimpleFunction:

1
2
3
4
5
 
$twig = new Twig_Environment($loader);
$function = new Twig_SimpleFunction('function_name', function () {
    // ...
});
$twig->addFunction($function);

Functions support the same features as filters, except for the pre_escape and preserves_safety options.

Tests

Tests are defined in the exact same way as filters and functions, but you need to create an instance of Twig_SimpleTest:

1
2
3
4
5
 
$twig = new Twig_Environment($loader);
$test = new Twig_SimpleTest('test_name', function () {
    // ...
});
$twig->addTest($test);

Tests allow you to create custom application specific logic for evaluating boolean conditions. As a simple example, let's create a Twig test that checks if objects are 'red':

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
 
$twig = new Twig_Environment($loader)
$test = new Twig_SimpleTest('red', function ($value) {
    if (isset($value->color) && $value->color == 'red') {
        return true;
    }
    if (isset($value->paint) && $value->paint == 'red') {
        return true;
    }
    return false;
});
$twig->addTest($test);

Test functions should always return true/false.

When creating tests you can use the node_class option to provide custom test compilation. This is useful if your test can be compiled into PHP primitives. This is used by many of the tests built into Twig:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
 
$twig = new Twig_Environment($loader)
$test = new Twig_SimpleTest(
    'odd',
    null,
    array('node_class' => 'Twig_Node_Expression_Test_Odd'));
$twig->addTest($test);

class Twig_Node_Expression_Test_Odd extends Twig_Node_Expression_Test
{
    public function compile(Twig_Compiler $compiler)
    {
        $compiler
            ->raw('(')
            ->subcompile($this->getNode('node'))
            ->raw(' % 2 == 1')
            ->raw(')')
        ;
    }
}

The above example shows how you can create tests that use a node class. The node class has access to one sub-node called 'node'. This sub-node contains the value that is being tested. When the odd filter is used in code such as:

1
 
{% if my_value is odd %}

The node sub-node will contain an expression of my_value. Node-based tests also have access to the arguments node. This node will contain the various other arguments that have been provided to your test.

Tags

One of the most exciting features of a template engine like Twig is the possibility to define new language constructs. This is also the most complex feature as you need to understand how Twig's internals work.

Let's create a simple set tag that allows the definition of simple variables from within a template. The tag can be used like follows:

1
2
3
4
5
 
{% set name = "value" %}

{{ name }}

{# should output value #}

The set tag is part of the Core extension and as such is always available. The built-in version is slightly more powerful and supports multiple assignments by default (cf. the template designers chapter for more information).

Three steps are needed to define a new tag:

  • Defining a Token Parser class (responsible for parsing the template code);
  • Defining a Node class (responsible for converting the parsed code to PHP);
  • Registering the tag.

Registering a new tag

Adding a tag is as simple as calling the addTokenParser method on the Twig_Environment instance:

1
2
 
$twig = new Twig_Environment($loader);
$twig->addTokenParser(new Project_Set_TokenParser());

Defining a Token Parser

Now, let's see the actual code of this class:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
 
class Project_Set_TokenParser extends Twig_TokenParser
{
    public function parse(Twig_Token $token)
    {
        $parser = $this->parser;
        $stream = $parser->getStream();

        $name = $stream->expect(Twig_Token::NAME_TYPE)->getValue();
        $stream->expect(Twig_Token::OPERATOR_TYPE, '=');
        $value = $parser->getExpressionParser()->parseExpression();
        $stream->expect(Twig_Token::BLOCK_END_TYPE);

        return new Project_Set_Node($name, $value, $token->getLine(), $this->getTag());
    }

    public function getTag()
    {
        return 'set';
    }
}

The getTag() method must return the tag we want to parse, here set.

The parse() method is invoked whenever the parser encounters a set tag. It should return a Twig_Node instance that represents the node (the Project_Set_Node calls creating is explained in the next section).

The parsing process is simplified thanks to a bunch of methods you can call from the token stream ($this->parser->getStream()):

  • getCurrent(): Gets the current token in the stream.
  • next(): Moves to the next token in the stream, but returns the old one.
  • test($type), test($value) or test($type, $value): Determines whether the current token is of a particular type or value (or both). The value may be an array of several possible values.
  • expect($type[, $value[, $message]]): If the current token isn't of the given type/value a syntax error is thrown. Otherwise, if the type and value are correct, the token is returned and the stream moves to the next token.
  • look(): Looks a the next token without consuming it.

Parsing expressions is done by calling the parseExpression() like we did for the set tag.

Reading the existing TokenParser classes is the best way to learn all the nitty-gritty details of the parsing process.

Defining a Node

The Project_Set_Node class itself is rather simple:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
 
class Project_Set_Node extends Twig_Node
{
    public function __construct($name, Twig_Node_Expression $value, $line, $tag = null)
    {
        parent::__construct(array('value' => $value), array('name' => $name), $line, $tag);
    }

    public function compile(Twig_Compiler $compiler)
    {
        $compiler
            ->addDebugInfo($this)
            ->write('$context[\''.$this->getAttribute('name').'\'] = ')
            ->subcompile($this->getNode('value'))
            ->raw(";\n")
        ;
    }
}

The compiler implements a fluid interface and provides methods that helps the developer generate beautiful and readable PHP code:

  • subcompile(): Compiles a node.
  • raw(): Writes the given string as is.
  • write(): Writes the given string by adding indentation at the beginning of each line.
  • string(): Writes a quoted string.
  • repr(): Writes a PHP representation of a given value (see Twig_Node_For for a usage example).
  • addDebugInfo(): Adds the line of the original template file related to the current node as a comment.
  • indent(): Indents the generated code (see Twig_Node_Block for a usage example).
  • outdent(): Outdents the generated code (see Twig_Node_Block for a usage example).

Creating an Extension

The main motivation for writing an extension is to move often used code into a reusable class like adding support for internationalization. An extension can define tags, filters, tests, operators, global variables, functions, and node visitors.

Creating an extension also makes for a better separation of code that is executed at compilation time and code needed at runtime. As such, it makes your code faster.

Most of the time, it is useful to create a single extension for your project, to host all the specific tags and filters you want to add to Twig.

When packaging your code into an extension, Twig is smart enough to recompile your templates whenever you make a change to it (when auto_reload is enabled).

Before writing your own extensions, have a look at the Twig official extension repository:http://github.com/twigphp/Twig-extensions.

An extension is a class that implements the following interface:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
interface Twig_ExtensionInterface
{
    /**
     * Initializes the runtime environment.
     *
     * This is where you can load some file that contains filter functions for instance.
     *
     * @param Twig_Environment $environment The current Twig_Environment instance
     */
    function initRuntime(Twig_Environment $environment);

    /**
     * Returns the token parser instances to add to the existing list.
     *
     * @return array An array of Twig_TokenParserInterface or Twig_TokenParserBrokerInterface instances
     */
    function getTokenParsers();

    /**
     * Returns the node visitor instances to add to the existing list.
     *
     * @return array An array of Twig_NodeVisitorInterface instances
     */
    function getNodeVisitors();

    /**
     * Returns a list of filters to add to the existing list.
     *
     * @return array An array of filters
     */
    function getFilters();

    /**
     * Returns a list of tests to add to the existing list.
     *
     * @return array An array of tests
     */
    function getTests();

    /**
     * Returns a list of functions to add to the existing list.
     *
     * @return array An array of functions
     */
    function getFunctions();

    /**
     * Returns a list of operators to add to the existing list.
     *
     * @return array An array of operators
     */
    function getOperators();

    /**
     * Returns a list of global variables to add to the existing list.
     *
     * @return array An array of global variables
     */
    function getGlobals();

    /**
     * Returns the name of the extension.
     *
     * @return string The extension name
     */
    function getName();
}

To keep your extension class clean and lean, it can inherit from the built-in Twig_Extension class instead of implementing the whole interface. That way, you just need to implement the getName() method as the Twig_Extension provides empty implementations for all other methods.

The getName() method must return a unique identifier for your extension.

Now, with this information in mind, let's create the most basic extension possible:

1
2
3
4
5
6
7
 
class Project_Twig_Extension extends Twig_Extension
{
    public function getName()
    {
        return 'project';
    }
}

Of course, this extension does nothing for now. We will customize it in the next sections.

Twig does not care where you save your extension on the filesystem, as all extensions must be registered explicitly to be available in your templates.

You can register an extension by using the addExtension() method on your main Environment object:

1
2
 
$twig = new Twig_Environment($loader);
$twig->addExtension(new Project_Twig_Extension());

Of course, you need to first load the extension file by either using require_once() or by using an autoloader (seespl_autoload_register()).

The bundled extensions are great examples of how extensions work.

Globals

Global variables can be registered in an extension via the getGlobals() method:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
 
class Project_Twig_Extension extends Twig_Extension
{
    public function getGlobals()
    {
        return array(
            'text' => new Text(),
        );
    }

    // ...
}

Functions

Functions can be registered in an extension via the getFunctions() method:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
 
class Project_Twig_Extension extends Twig_Extension
{
    public function getFunctions()
    {
        return array(
            new Twig_SimpleFunction('lipsum', 'generate_lipsum'),
        );
    }

    // ...
}

Filters

To add a filter to an extension, you need to override the getFilters() method. This method must return an array of filters to add to the Twig environment:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
 
class Project_Twig_Extension extends Twig_Extension
{
    public function getFilters()
    {
        return array(
            new Twig_SimpleFilter('rot13', 'str_rot13'),
        );
    }

    // ...
}

Tags

Adding a tag in an extension can be done by overriding the getTokenParsers() method. This method must return an array of tags to add to the Twig environment:

1
2
3
4
5
6
7
8
9
 
class Project_Twig_Extension extends Twig_Extension
{
    public function getTokenParsers()
    {
        return array(new Project_Set_TokenParser());
    }

    // ...
}

In the above code, we have added a single new tag, defined by the Project_Set_TokenParser class. The Project_Set_TokenParser class is responsible for parsing the tag and compiling it to PHP.

Operators

The getOperators() methods lets you add new operators. Here is how to add !, ||, and && operators:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
 
class Project_Twig_Extension extends Twig_Extension
{
    public function getOperators()
    {
        return array(
            array(
                '!' => array('precedence' => 50, 'class' => 'Twig_Node_Expression_Unary_Not'),
            ),
            array(
                '||' => array('precedence' => 10, 'class' => 'Twig_Node_Expression_Binary_Or', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '&&' => array('precedence' => 15, 'class' => 'Twig_Node_Expression_Binary_And', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
            ),
        );
    }

    // ...
}

Tests

The getTests() method lets you add new test functions:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
 
class Project_Twig_Extension extends Twig_Extension
{
    public function getTests()
    {
        return array(
            new Twig_SimpleTest('even', 'twig_test_even'),
        );
    }

    // ...
}

Overloading

To overload an already defined filter, test, operator, global variable, or function, re-define it in an extension and register it as late as possible (order matters):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
class MyCoreExtension extends Twig_Extension
{
    public function getFilters()
    {
        return array(
            new Twig_SimpleFilter('date', array($this, 'dateFilter')),
        );
    }

    public function dateFilter($timestamp, $format = 'F j, Y H:i')
    {
        // do something different from the built-in date filter
    }

    public function getName()
    {
        return 'project';
    }
}

$twig = new Twig_Environment($loader);
$twig->addExtension(new MyCoreExtension());

Here, we have overloaded the built-in date filter with a custom one.

If you do the same on the Twig_Environment itself, beware that it takes precedence over any other registered extensions:

1
2
3
4
5
6
7
 
$twig = new Twig_Environment($loader);
$twig->addFilter(new Twig_SimpleFilter('date', function ($timestamp, $format = 'F j, Y H:i') {
    // do something different from the built-in date filter
}));
// the date filter will come from the above registration, not
// from the registered extension below
$twig->addExtension(new MyCoreExtension());

Note that overloading the built-in Twig elements is not recommended as it might be confusing.

Testing an Extension

Functional Tests

You can create functional tests for extensions simply by creating the following file structure in your test directory:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
 
Fixtures/
    filters/
        foo.test
        bar.test
    functions/
        foo.test
        bar.test
    tags/
        foo.test
        bar.test
IntegrationTest.php

The IntegrationTest.php file should look like this:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
 
class Project_Tests_IntegrationTest extends Twig_Test_IntegrationTestCase
{
    public function getExtensions()
    {
        return array(
            new Project_Twig_Extension1(),
            new Project_Twig_Extension2(),
        );
    }

    public function getFixturesDir()
    {
        return dirname(__FILE__).'/Fixtures/';
    }
}

Fixtures examples can be found within the Twig repository tests/Twig/Fixtures directory.

Node Tests

Testing the node visitors can be complex, so extend your test cases from Twig_Test_NodeTestCase. Examples can be found in the Twig repository tests/Twig/Node directory.



Twig Internals

Twig is very extensible and you can easily hack it. Keep in mind that you should probably try to create an extension before hacking the core, as most features and enhancements can be handled with extensions. This chapter is also useful for people who want to understand how Twig works under the hood.

How does Twig work?

The rendering of a Twig template can be summarized into four key steps:

  • Load the template: If the template is already compiled, load it and go to theevaluation step, otherwise:
    • First, the lexer tokenizes the template source code into small pieces for easier processing;
    • Then, the parser converts the token stream into a meaningful tree of nodes (the Abstract Syntax Tree);
    • Eventually, the compiler transforms the AST into PHP code.
  • Evaluate the template: It basically means calling the display() method of the compiled template and passing it the context.

The Lexer

The lexer tokenizes a template source code into a token stream (each token is an instance of Twig_Token, and the stream is an instance ofTwig_TokenStream). The default lexer recognizes 13 different token types:

  • Twig_Token::BLOCK_START_TYPE, Twig_Token::BLOCK_END_TYPE: Delimiters for blocks ({% %})
  • Twig_Token::VAR_START_TYPE, Twig_Token::VAR_END_TYPE: Delimiters for variables ({{ }})
  • Twig_Token::TEXT_TYPE: A text outside an expression;
  • Twig_Token::NAME_TYPE: A name in an expression;
  • Twig_Token::NUMBER_TYPE: A number in an expression;
  • Twig_Token::STRING_TYPE: A string in an expression;
  • Twig_Token::OPERATOR_TYPE: An operator;
  • Twig_Token::PUNCTUATION_TYPE: A punctuation sign;
  • Twig_Token::INTERPOLATION_START_TYPE, Twig_Token::INTERPOLATION_END_TYPE (as of Twig 1.5): Delimiters for string interpolation;
  • Twig_Token::EOF_TYPE: Ends of template.

You can manually convert a source code into a token stream by calling the tokenize() method of an environment:

1
 
$stream = $twig->tokenize($source, $identifier);

As the stream has a __toString() method, you can have a textual representation of it by echoing the object:

1
 
echo $stream."\n";

Here is the output for the Hello {{ name }} template:

1
2
3
4
5
 
TEXT_TYPE(Hello )
VAR_START_TYPE()
NAME_TYPE(name)
VAR_END_TYPE()
EOF_TYPE()

The default lexer (Twig_Lexer) can be changed by calling the setLexer() method:

1
 
$twig->setLexer($lexer);

The Parser

The parser converts the token stream into an AST (Abstract Syntax Tree), or a node tree (an instance of Twig_Node_Module). The core extension defines the basic nodes like: for, if, ... and the expression nodes.

You can manually convert a token stream into a node tree by calling the parse() method of an environment:

1
 
$nodes = $twig->parse($stream);

Echoing the node object gives you a nice representation of the tree:

1
 
echo $nodes."\n";

Here is the output for the Hello {{ name }} template:

1
2
3
4
5
6
 
Twig_Node_Module(
  Twig_Node_Text(Hello )
  Twig_Node_Print(
    Twig_Node_Expression_Name(name)
  )
)

The default parser (Twig_TokenParser) can be changed by calling the setParser() method:

1
 
$twig->setParser($parser);

The Compiler

The last step is done by the compiler. It takes a node tree as an input and generates PHP code usable for runtime execution of the template.

You can manually compile a node tree to PHP code with the compile() method of an environment:

1
 
$php = $twig->compile($nodes);

The generated template for a Hello {{ name }} template reads as follows (the actual output can differ depending on the version of Twig you are using):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
 
/* Hello {{ name }} */
class __TwigTemplate_1121b6f109fe93ebe8c6e22e3712bceb extends Twig_Template
{
    protected function doDisplay(array $context, array $blocks = array())
    {
        // line 1
        echo "Hello ";
        echo twig_escape_filter($this->env, $this->getContext($context, "name"), "html", null, true);
    }

    // some more code
}

The default compiler (Twig_Compiler) can be changed by calling the setCompiler() method:

1
 
$twig->setCompiler($compiler);

Twig for Template Designers

This document describes the syntax and semantics of the template engine and will be most useful as reference to those creating Twig templates.

Synopsis

A template is simply a text file. It can generate any text-based format (HTML, XML, CSV, LaTeX, etc.). It doesn't have a specific extension, .html or .xml are just fine.

A template contains variables or expressions, which get replaced with values when the template is evaluated, and tags, which control the logic of the template.

Below is a minimal template that illustrates a few basics. We will cover further details later on:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
 
<!DOCTYPE html>
<html>
    <head>
        <title>My Webpage</title>
    </head>
    <body>
        <ul id="navigation">
        {% for item in navigation %}
            <li><a href="{{ item.href }}">{{ item.caption }}</a></li>
        {% endfor %}
        </ul>

        <h1>My Webpage</h1>
        {{ a_variable }}
    </body>
</html>

There are two kinds of delimiters: {% ... %} and {{ ... }}. The first one is used to execute statements such as for-loops, the latter prints the result of an expression to the template.

IDEs Integration

Many IDEs support syntax highlighting and auto-completion for Twig:

Variables

The application passes variables to the templates for manipulation in the template. Variables may have attributes or elements you can access, too. The visual representation of a variable depends heavily on the application providing it.

You can use a dot (.) to access attributes of a variable (methods or properties of a PHP object, or items of a PHP array), or the so-called "subscript" syntax ([]):

1
2
 
{{ foo.bar }}
{{ foo['bar'] }}

When the attribute contains special characters (like - that would be interpreted as the minus operator), use the attribute function instead to access the variable attribute:

1
2
 
{# equivalent to the non-working foo.data-foo #}
{{ attribute(foo, 'data-foo') }}

It's important to know that the curly braces are not part of the variable but the print statement. When accessing variables inside tags, don't put the braces around them.

If a variable or attribute does not exist, you will receive a null value when the strict_variables option is set to false; alternatively, ifstrict_variables is set, Twig will throw an error (see environment options).

Implementation

For convenience's sake foo.bar does the following things on the PHP layer:

  • check if foo is an array and bar a valid element;
  • if not, and if foo is an object, check that bar is a valid property;
  • if not, and if foo is an object, check that bar is a valid method (even if bar is the constructor - use __construct() instead);
  • if not, and if foo is an object, check that getBar is a valid method;
  • if not, and if foo is an object, check that isBar is a valid method;
  • if not, return a null value.

foo['bar'] on the other hand only works with PHP arrays:

  • check if foo is an array and bar a valid element;
  • if not, return a null value.

If you want to access a dynamic attribute of a variable, use the attribute function instead.

Global Variables

The following variables are always available in templates:

  • _self: references the current template;
  • _context: references the current context;
  • _charset: references the current charset.

Setting Variables

You can assign values to variables inside code blocks. Assignments use the set tag:

1
2
3
 
{% set foo = 'foo' %}
{% set foo = [1, 2] %}
{% set foo = {'foo': 'bar'} %}

Filters

Variables can be modified by filters. Filters are separated from the variable by a pipe symbol (|) and may have optional arguments in parentheses. Multiple filters can be chained. The output of one filter is applied to the next.

The following example removes all HTML tags from the name and title-cases it:

1
 
{{ name|striptags|title }}

Filters that accept arguments have parentheses around the arguments. This example will join a list by commas:

1
 
{{ list|join(', ') }}

To apply a filter on a section of code, wrap it in the filter tag:

1
2
3
 
{% filter upper %}
    This text becomes uppercase
{% endfilter %}

Go to the filters page to learn more about built-in filters.

Functions

Functions can be called to generate content. Functions are called by their name followed by parentheses (()) and may have arguments.

For instance, the range function returns a list containing an arithmetic progression of integers:

1
2
3
 
{% for i in range(0, 3) %}
    {{ i }},
{% endfor %}

Go to the functions page to learn more about the built-in functions.

Named Arguments

New in version 1.12: Support for named arguments was added in Twig 1.12.

1
2
3
 
{% for i in range(low=1, high=10, step=2) %}
    {{ i }},
{% endfor %}

Using named arguments makes your templates more explicit about the meaning of the values you pass as arguments:

1
2
3
4
5
 
{{ data|convert_encoding('UTF-8', 'iso-2022-jp') }}

{# versus #}

{{ data|convert_encoding(from='iso-2022-jp', to='UTF-8') }}

Named arguments also allow you to skip some arguments for which you don't want to change the default value:

1
2
3
4
5
 
{# the first argument is the date format, which defaults to the global date format if null is passed #}
{{ "now"|date(null, "Europe/Paris") }}

{# or skip the format value by using a named argument for the time zone #}
{{ "now"|date(timezone="Europe/Paris") }}

You can also use both positional and named arguments in one call, in which case positional arguments must always come before named arguments:

1
 
{{ "now"|date('d/m/Y H:i', timezone="Europe/Paris") }}

Each function and filter documentation page has a section where the names of all arguments are listed when supported.

Control Structure

A control structure refers to all those things that control the flow of a program - conditionals (i.e. if/elseif/else), for-loops, as well as things like blocks. Control structures appear inside {% ... %} blocks.

For example, to display a list of users provided in a variable called users, use the for tag:

1
2
3
4
5
6
 
<h1>Members</h1>
<ul>
    {% for user in users %}
        <li>{{ user.username|e }}</li>
    {% endfor %}
</ul>

The if tag can be used to test an expression:

1
2
3
4
5
6
7
 
{% if users|length > 0 %}
    <ul>
        {% for user in users %}
            <li>{{ user.username|e }}</li>
        {% endfor %}
    </ul>
{% endif %}

Go to the tags page to learn more about the built-in tags.

Comments

To comment-out part of a line in a template, use the comment syntax {# ... #}. This is useful for debugging or to add information for other template designers or yourself:

1
2
3
4
5
 
{# note: disabled template because we no longer use this
    {% for user in users %}
        ...
    {% endfor %}
#}

Including other Templates

The include tag is useful to include a template and return the rendered content of that template into the current one:

1
 
{% include 'sidebar.html' %}

Per default included templates are passed the current context.

The context that is passed to the included template includes variables defined in the template:

1
2
3
 
{% for box in boxes %}
    {% include "render_box.html" %}
{% endfor %}

The included template render_box.html is able to access box.

The filename of the template depends on the template loader. For instance, the Twig_Loader_Filesystem allows you to access other templates by giving the filename. You can access templates in subdirectories with a slash:

1
 
{% include "sections/articles/sidebar.html" %}

This behavior depends on the application embedding Twig.

Template Inheritance

The most powerful part of Twig is template inheritance. Template inheritance allows you to build a base "skeleton" template that contains all the common elements of your site and defines blocks that child templates can override.

Sounds complicated but it is very basic. It's easier to understand it by starting with an example.

Let's define a base template, base.html, which defines a simple HTML skeleton document that you might use for a simple two-column page:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
 
<!DOCTYPE html>
<html>
    <head>
        {% block head %}
            <link rel="stylesheet" href="style.css" />
            <title>{% block title %}{% endblock %} - My Webpage</title>
        {% endblock %}
    </head>
    <body>
        <div id="content">{% block content %}{% endblock %}</div>
        <div id="footer">
            {% block footer %}
                &copy; Copyright 2011 by <a href="http://domain.invalid/">you</a>.
            {% endblock %}
        </div>
    </body>
</html>

In this example, the block tags define four blocks that child templates can fill in. All the block tag does is to tell the template engine that a child template may override those portions of the template.

A child template might look like this:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
 
{% extends "base.html" %}

{% block title %}Index{% endblock %}
{% block head %}
    {{ parent() }}
    <style type="text/css">
        .important { color: #336699; }
    </style>
{% endblock %}
{% block content %}
    <h1>Index</h1>
    <p class="important">
        Welcome to my awesome homepage.
    </p>
{% endblock %}

The extends tag is the key here. It tells the template engine that this template "extends" another template. When the template system evaluates this template, first it locates the parent. The extends tag should be the first tag in the template.

Note that since the child template doesn't define the footer block, the value from the parent template is used instead.

It's possible to render the contents of the parent block by using the parent function. This gives back the results of the parent block:

1
2
3
4
5
 
{% block sidebar %}
    <h3>Table Of Contents</h3>
    ...
    {{ parent() }}
{% endblock %}

The documentation page for the extends tag describes more advanced features like block nesting, scope, dynamic inheritance, and conditional inheritance.

Twig also supports multiple inheritance with the so called horizontal reuse with the help of the use tag. This is an advanced feature hardly ever needed in regular templates.

HTML Escaping

When generating HTML from templates, there's always a risk that a variable will include characters that affect the resulting HTML. There are two approaches: manually escaping each variable or automatically escaping everything by default.

Twig supports both, automatic escaping is enabled by default.

Automatic escaping is only supported if the escaper extension has been enabled (which is the default).

Working with Manual Escaping

If manual escaping is enabled, it is your responsibility to escape variables if needed. What to escape? Any variable you don't trust.

Escaping works by piping the variable through the escape or e filter:

1
 
{{ user.username|e }}

By default, the escape filter uses the html strategy, but depending on the escaping context, you might want to explicitly use any other available strategies:

1
2
3
4
 
{{ user.username|e('js') }}
{{ user.username|e('css') }}
{{ user.username|e('url') }}
{{ user.username|e('html_attr') }}

Working with Automatic Escaping

Whether automatic escaping is enabled or not, you can mark a section of a template to be escaped or not by using the autoescape tag:

1
2
3
 
{% autoescape %}
    Everything will be automatically escaped in this block (using the HTML strategy)
{% endautoescape %}

By default, auto-escaping uses the html escaping strategy. If you output variables in other contexts, you need to explicitly escape them with the appropriate escaping strategy:

1
2
3
 
{% autoescape 'js' %}
    Everything will be automatically escaped in this block (using the JS strategy)
{% endautoescape %}

Escaping

It is sometimes desirable or even necessary to have Twig ignore parts it would otherwise handle as variables or blocks. For example if the default syntax is used and you want to use {{ as raw string in the template and not start a variable you have to use a trick.

The easiest way is to output the variable delimiter ({{) by using a variable expression:

1
 
{{ '{{' }}

For bigger sections it makes sense to mark a block verbatim.

Macros

New in version 1.12: Support for default argument values was added in Twig 1.12.

Macros are comparable with functions in regular programming languages. They are useful to reuse often used HTML fragments to not repeat yourself.

A macro is defined via the macro tag. Here is a small example (subsequently called forms.html) of a macro that renders a form element:

1
2
3
 
{% macro input(name, value, type, size) %}
    <input type="{{ type|default('text') }}" name="{{ name }}" value="{{ value|e }}" size="{{ size|default(20) }}" />
{% endmacro %}

Macros can be defined in any template, and need to be "imported" via the import tag before being used:

1
2
3
 
{% import "forms.html" as forms %}

<p>{{ forms.input('username') }}</p>

Alternatively, you can import individual macro names from a template into the current namespace via the from tag and optionally alias them:

1
2
3
4
5
6
7
8
 
{% from 'forms.html' import input as input_field %}

<dl>
    <dt>Username</dt>
    <dd>{{ input_field('username') }}</dd>
    <dt>Password</dt>
    <dd>{{ input_field('password', '', 'password') }}</dd>
</dl>

A default value can also be defined for macro arguments when not provided in a macro call:

1
2
3
 
{% macro input(name, value = "", type = "text", size = 20) %}
    <input type="{{ type }}" name="{{ name }}" value="{{ value|e }}" size="{{ size }}" />
{% endmacro %}

Expressions

Twig allows expressions everywhere. These work very similar to regular PHP and even if you're not working with PHP you should feel comfortable with it.

The operator precedence is as follows, with the lowest-precedence operators listed first: b-and, b-xor, b-or, or, and, ==, !=, <,>, >=, <=, in, matches, starts with, ends with, .., +, -, ~, *, /, //, %, is, **, |, [], and .:

1
2
3
4
5
6
7
 
{% set greeting = 'Hello ' %}
{% set name = 'Fabien' %}

{{ greeting ~ name|lower }}   {# Hello fabien #}

{# use parenthesis to change precedence #}
{{ (greeting ~ name)|lower }} {# hello fabien #}

Literals

New in version 1.5: Support for hash keys as names and expressions was added in Twig 1.5.

The simplest form of expressions are literals. Literals are representations for PHP types such as strings, numbers, and arrays. The following literals exist:

  • "Hello World": Everything between two double or single quotes is a string. They are useful whenever you need a string in the template (for example as arguments to function calls, filters or just to extend or include a template). A string can contain a delimiter if it is preceded by a backslash (\) -- like in 'It\'s good'.

  • 42 / 42.23: Integers and floating point numbers are created by just writing the number down. If a dot is present the number is a float, otherwise an integer.

  • ["foo", "bar"]: Arrays are defined by a sequence of expressions separated by a comma (,) and wrapped with squared brackets ([]).

  • {"foo": "bar"}: Hashes are defined by a list of keys and values separated by a comma (,) and wrapped with curly braces ({}):

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
    		 
    {# keys as string #}
{ 'foo': 'foo', 'bar': 'bar' }

{# keys as names (equivalent to the previous hash) -- as of Twig 1.5 #}
{ foo: 'foo', bar: 'bar' }

{# keys as integer #}
{ 2: 'foo', 4: 'bar' }

{# keys as expressions (the expression must be enclosed into parentheses) -- as of Twig 1.5 #}
{ (1 + 1): 'foo', (a ~ 'b'): 'bar' }

  • true / false: true represents the true value, false represents the false value.

  • null: null represents no specific value. This is the value returned when a variable does not exist. none is an alias for null.

Arrays and hashes can be nested:

1
 
{% set foo = [1, {"foo": "bar"}] %}

Using double-quoted or single-quoted strings has no impact on performance but string interpolation is only supported in double-quoted strings.

Math

Twig allows you to calculate with values. This is rarely useful in templates but exists for completeness' sake. The following operators are supported:

  • +: Adds two objects together (the operands are casted to numbers). {{ 1 + 1 }} is 2.
  • -: Subtracts the second number from the first one. {{ 3 - 2 }} is 1.
  • /: Divides two numbers. The returned value will be a floating point number. {{ 1 / 2 }} is {{ 0.5 }}.
  • %: Calculates the remainder of an integer division. {{ 11 % 7 }} is 4.
  • //: Divides two numbers and returns the floored integer result. {{ 20 // 7 }} is 2, {{ -20 // 7 }} is -3 (this is just syntactic sugar for the round filter).
  • *: Multiplies the left operand with the right one. {{ 2 * 2 }} would return 4.
  • **: Raises the left operand to the power of the right operand. {{ 2 ** 3 }} would return 8.

Logic

You can combine multiple expressions with the following operators:

  • and: Returns true if the left and the right operands are both true.
  • or: Returns true if the left or the right operand is true.
  • not: Negates a statement.
  • (expr): Groups an expression.

Twig also support bitwise operators (b-and, b-xor, and b-or).

Comparisons

The following comparison operators are supported in any expression: ==, !=, <, >, >=, and <=.

You can also check if a string starts with or ends with another string:

1
2
3
4
5
 
{% if 'Fabien' starts with 'F' %}
{% endif %}

{% if 'Fabien' ends with 'n' %}
{% endif %}

For complex string comparisons, the matches operator allows you to use regular expressions:

1
2
 
{% if phone matches '/^[\\d\\.]+$/' %}
{% endif %}

Containment Operator

The in operator performs containment test.

It returns true if the left operand is contained in the right:

1
2
3
4
5
 
{# returns true #}

{{ 1 in [1, 2, 3] }}

{{ 'cd' in 'abcde' }}

You can use this filter to perform a containment test on strings, arrays, or objects implementing the Traversable interface.

To perform a negative test, use the not in operator:

1
2
3
4
 
{% if 1 not in [1, 2, 3] %}

{# is equivalent to #}
{% if not (1 in [1, 2, 3]) %}

Test Operator

The is operator performs tests. Tests can be used to test a variable against a common expression. The right operand is name of the test:

1
2
3
 
{# find out if a variable is odd #}

{{ name is odd }}

Tests can accept arguments too:

1
 
{% if post.status is constant('Post::PUBLISHED') %}

Tests can be negated by using the is not operator:

1
2
3
4
 
{% if post.status is not constant('Post::PUBLISHED') %}

{# is equivalent to #}
{% if not (post.status is constant('Post::PUBLISHED')) %}

Go to the tests page to learn more about the built-in tests.

Other Operators

New in version 1.12.0: Support for the extended ternary operator was added in Twig 1.12.0.

The following operators are very useful but don't fit into any of the other categories:

  • ..: Creates a sequence based on the operand before and after the operator (this is just syntactic sugar for the range function).

  • |: Applies a filter.

  • ~: Converts all operands into strings and concatenates them. {{ "Hello " ~ name ~ "!" }} would return (assuming name is 'John') Hello John!.

  • ., []: Gets an attribute of an object.

  • ?:: The ternary operator:

    {{ foo ? 'yes' : 'no' }}

{# as of Twig 1.12.0 #}
{{ foo ?: 'no' }} is the same as {{ foo ? foo : 'no' }}
{{ foo ? 'yes' }} is the same as {{ foo ? 'yes' : '' }}

String Interpolation

New in version 1.5: String interpolation was added in Twig 1.5.

String interpolation (#{expression}) allows any valid expression to appear within a double-quoted string. The result of evaluating that expression is inserted into the string:

1
2
 
{{ "foo #{bar} baz" }}
{{ "foo #{1 + 2} baz" }}

Whitespace Control

New in version 1.1: Tag level whitespace control was added in Twig 1.1.

The first newline after a template tag is removed automatically (like in PHP.) Whitespace is not further modified by the template engine, so each whitespace (spaces, tabs, newlines etc.) is returned unchanged.

Use the spaceless tag to remove whitespace between HTML tags:

1
2
3
4
5
6
7
 
{% spaceless %}
    <div>
        <strong>foo bar</strong>
    </div>
{% endspaceless %}

{# output will be <div><strong>foo bar</strong></div> #}

In addition to the spaceless tag you can also control whitespace on a per tag level. By using the whitespace control modifier on your tags, you can trim leading and or trailing whitespace:

1
2
3
4
5
6
7
 
{% set value = 'no spaces' %}
{#- No leading/trailing whitespace -#}
{%- if true -%}
    {{- value -}}
{%- endif -%}

{# output 'no spaces' #}

The above sample shows the default whitespace control modifier, and how you can use it to remove whitespace around tags. Trimming space will consume all whitespace for that side of the tag. It is possible to use whitespace trimming on one side of a tag:

1
2
3
4
 
{% set value = 'no spaces' %}
<li>    {{- value }}    </li>

{# outputs '<li>no spaces    </li>' #}

Extensions

Twig can be easily extended.

If you are looking for new tags, filters, or functions, have a look at the Twig official extension repository.

If you want to create your own, read the Creating an Extension chapter.


Deprecated Features

This document lists all deprecated features in Twig. Deprecated features are kept for backward compatibility and removed in the next major release (a feature that was deprecated in Twig 1.x is removed in Twig 2.0).

Token Parsers

  • As of Twig 1.x, the token parser broker sub-system is deprecated. The following class and interface will be removed in 2.0:
    • Twig_TokenParserBrokerInterface
    • Twig_TokenParserBroker

Extensions

  • As of Twig 1.x, the ability to remove an extension is deprecated and theTwig_Environment::removeExtension() method will be removed in 2.0.

PEAR

PEAR support has been discontinued in Twig 1.15.1, and no PEAR packages are provided anymore. Use Composer instead.

Filters

  • As of Twig 1.x, use Twig_SimpleFilter to add a filter. The following classes and interfaces will be removed in 2.0:
    • Twig_FilterInterface
    • Twig_FilterCallableInterface
    • Twig_Filter
    • Twig_Filter_Function
    • Twig_Filter_Method
    • Twig_Filter_Node
  • As of Twig 2.x, the Twig_SimpleFilter class is deprecated and will be removed in Twig 3.x (use Twig_Filter instead). In Twig 2.x,Twig_SimpleFilter is just an alias for Twig_Filter.

Functions

  • As of Twig 1.x, use Twig_SimpleFunction to add a function. The following classes and interfaces will be removed in 2.0:
    • Twig_FunctionInterface
    • Twig_FunctionCallableInterface
    • Twig_Function
    • Twig_Function_Function
    • Twig_Function_Method
    • Twig_Function_Node
  • As of Twig 2.x, the Twig_SimpleFunction class is deprecated and will be removed in Twig 3.x (use Twig_Function instead). In Twig 2.x,Twig_SimpleFunction is just an alias for Twig_Function.

Tests

  • As of Twig 1.x, use Twig_SimpleTest to add a test. The following classes and interfaces will be removed in 2.0:
    • Twig_TestInterface
    • Twig_TestCallableInterface
    • Twig_Test
    • Twig_Test_Function
    • Twig_Test_Method
    • Twig_Test_Node
  • As of Twig 2.x, the Twig_SimpleTest class is deprecated and will be removed in Twig 3.x (use Twig_Test instead). In Twig 2.x,Twig_SimpleTest is just an alias for Twig_Test.
  • The sameas and divisibleby tests are deprecated in favor of same as and divisible by respectively.

Nodes

  • As of Twig 1.x, Node::toXml() is deprecated and will be removed in Twig 2.0.

Interfaces

  • As of Twig 2.x, the following interfaces are deprecated and empty (they will be removed in Twig 3.0):
  • Twig_CompilerInterface (use Twig_Compiler instead)
  • Twig_LexerInterface (use Twig_Lexer instead)
  • Twig_NodeInterface (use Twig_Node instead)
  • Twig_ParserInterface (use Twig_Parser instead)
  • Twig_ExistsLoaderInterface (merged with Twig_LoaderInterface)
  • Twig_TemplateInterface (use Twig_Template instead, and use those constants Twig_Template::ANY_CALL, Twig_Template::ARRAY_CALL, Twig_Template::METHOD_CALL)

Globals

  • As of Twig 2.x, the ability to register a global variable after the runtime or the extensions have been initialized is not possible anymore (but changing the value of an already registered global is possible).

Recipes

Making a Layout conditional

Working with Ajax means that the same content is sometimes displayed as is, and sometimes decorated with a layout. As Twig layout template names can be any valid expression, you can pass a variable that evaluates to true when the request is made via Ajax and choose the layout accordingly:

1
2
3
4
5
 
{% extends request.ajax ? "base_ajax.html" : "base.html" %}

{% block content %}
    This is the content to be displayed.
{% endblock %}

Making an Include dynamic

When including a template, its name does not need to be a string. For instance, the name can depend on the value of a variable:

1
 
{% include var ~ '_foo.html' %}

If var evaluates to index, the index_foo.html template will be rendered.

As a matter of fact, the template name can be any valid expression, such as the following:

1
 
{% include var|default('index') ~ '_foo.html' %}

Overriding a Template that also extends itself

A template can be customized in two different ways:

  • Inheritance: A template extends a parent template and overrides some blocks;
  • Replacement: If you use the filesystem loader, Twig loads the first template it finds in a list of configured directories; a template found in a directory replaces another one from a directory further in the list.

But how do you combine both: replace a template that also extends itself (aka a template in a directory further in the list)?

Let's say that your templates are loaded from both .../templates/mysite and .../templates/default in this order. The page.twig template, stored in .../templates/default reads as follows:

1
2
3
4
5
 
{# page.twig #}
{% extends "layout.twig" %}

{% block content %}
{% endblock %}

You can replace this template by putting a file with the same name in .../templates/mysite. And if you want to extend the original template, you might be tempted to write the following:

1
2
 
{# page.twig in .../templates/mysite #}
{% extends "page.twig" %} {# from .../templates/default #}

Of course, this will not work as Twig will always load the template from .../templates/mysite.

It turns out it is possible to get this to work, by adding a directory right at the end of your template directories, which is the parent of all of the other directories: .../templates in our case. This has the effect of making every template file within our system uniquely addressable. Most of the time you will use the "normal" paths, but in the special case of wanting to extend a template with an overriding version of itself we can reference its parent's full, unambiguous template path in the extends tag:

1
2
 
{# page.twig in .../templates/mysite #}
{% extends "default/page.twig" %} {# from .../templates #}

This recipe was inspired by the following Django wiki page: http://code.djangoproject.com/wiki/ExtendingTemplates

Customizing the Syntax

Twig allows some syntax customization for the block delimiters. It's not recommended to use this feature as templates will be tied with your custom syntax. But for specific projects, it can make sense to change the defaults.

To change the block delimiters, you need to create your own lexer object:

1
2
3
4
5
6
7
8
9
 
$twig = new Twig_Environment();

$lexer = new Twig_Lexer($twig, array(
    'tag_comment'   => array('{#', '#}'),
    'tag_block'     => array('{%', '%}'),
    'tag_variable'  => array('{{', '}}'),
    'interpolation' => array('#{', '}'),
));
$twig->setLexer($lexer);

Here are some configuration example that simulates some other template engines syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
 
// Ruby erb syntax
$lexer = new Twig_Lexer($twig, array(
    'tag_comment'  => array('<%#', '%>'),
    'tag_block'    => array('<%', '%>'),
    'tag_variable' => array('<%=', '%>'),
));

// SGML Comment Syntax
$lexer = new Twig_Lexer($twig, array(
    'tag_comment'  => array('<!--#', '-->'),
    'tag_block'    => array('<!--', '-->'),
    'tag_variable' => array('${', '}'),
));

// Smarty like
$lexer = new Twig_Lexer($twig, array(
    'tag_comment'  => array('{*', '*}'),
    'tag_block'    => array('{', '}'),
    'tag_variable' => array('{$', '}'),
));

Using dynamic Object Properties

When Twig encounters a variable like article.title, it tries to find a title public property in the article object.

It also works if the property does not exist but is rather defined dynamically thanks to the magic __get() method; you just need to also implement the __isset() magic method like shown in the following snippet of code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
 
class Article
{
    public function __get($name)
    {
        if ('title' == $name) {
            return 'The title';
        }

        // throw some kind of error
    }

    public function __isset($name)
    {
        if ('title' == $name) {
            return true;
        }

        return false;
    }
}

Accessing the parent Context in Nested Loops

Sometimes, when using nested loops, you need to access the parent context. The parent context is always accessible via the loop.parentvariable. For instance, if you have the following template data:

1
2
3
4
5
6
 
$data = array(
    'topics' => array(
        'topic1' => array('Message 1 of topic 1', 'Message 2 of topic 1'),
        'topic2' => array('Message 1 of topic 2', 'Message 2 of topic 2'),
    ),
);

And the following template to display all messages in all topics:

1
2
3
4
5
6
 
{% for topic, messages in topics %}
    * {{ loop.index }}: {{ topic }}
  {% for message in messages %}
      - {{ loop.parent.loop.index }}.{{ loop.index }}: {{ message }}
  {% endfor %}
{% endfor %}

The output will be similar to:

1
2
3
4
5
6
 
* 1: topic1
  - 1.1: The message 1 of topic 1
  - 1.2: The message 2 of topic 1
* 2: topic2
  - 2.1: The message 1 of topic 2
  - 2.2: The message 2 of topic 2

In the inner loop, the loop.parent variable is used to access the outer context. So, the index of the current topic defined in the outer for loop is accessible via the loop.parent.loop.index variable.

Defining undefined Functions and Filters on the Fly

When a function (or a filter) is not defined, Twig defaults to throw a Twig_Error_Syntax exception. However, it can also call a callback(any valid PHP callable) which should return a function (or a filter).

For filters, register callbacks with registerUndefinedFilterCallback(). For functions, use registerUndefinedFunctionCallback():

1
2
3
4
5
6
7
8
9
 
// auto-register all native PHP functions as Twig functions
// don't try this at home as it's not secure at all!
$twig->registerUndefinedFunctionCallback(function ($name) {
    if (function_exists($name)) {
        return new Twig_Function_Function($name);
    }

    return false;
});

If the callable is not able to return a valid function (or filter), it must return false.

If you register more than one callback, Twig will call them in turn until one does not return false.

As the resolution of functions and filters is done during compilation, there is no overhead when registering these callbacks.

Validating the Template Syntax

When template code is provided by a third-party (through a web interface for instance), it might be interesting to validate the template syntax before saving it. If the template code is stored in a $template variable, here is how you can do it:

1
2
3
4
5
6
7
 
try {
    $twig->parse($twig->tokenize($template));

    // the $template is valid
} catch (Twig_Error_Syntax $e) {
    // $template contains one or more syntax errors
}

If you iterate over a set of files, you can pass the filename to the tokenize() method to get the filename in the exception message:

1
2
3
4
5
6
7
8
9
 
foreach ($files as $file) {
    try {
        $twig->parse($twig->tokenize($template, $file));

        // the $template is valid
    } catch (Twig_Error_Syntax $e) {
        // $template contains one or more syntax errors
    }
}

This method won't catch any sandbox policy violations because the policy is enforced during template rendering (as Twig needs the context for some checks like allowed methods on objects).

Refreshing modified Templates when APC is enabled and apc.stat = 0

When using APC with apc.stat set to 0 and Twig cache enabled, clearing the template cache won't update the APC cache. To get around this, one can extend Twig_Environment and force the update of the APC cache when Twig rewrites the cache:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
 
class Twig_Environment_APC extends Twig_Environment
{
    protected function writeCacheFile($file, $content)
    {
        parent::writeCacheFile($file, $content);

        // Compile cached file into bytecode cache
        apc_compile_file($file);
    }
}

Reusing a stateful Node Visitor

When attaching a visitor to a Twig_Environment instance, Twig uses it to visit all templates it compiles. If you need to keep some state information around, you probably want to reset it when visiting a new template.

This can be easily achieved with the following code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
 
protected $someTemplateState = array();

public function enterNode(Twig_NodeInterface $node, Twig_Environment $env)
{
    if ($node instanceof Twig_Node_Module) {
        // reset the state as we are entering a new template
        $this->someTemplateState = array();
    }

    // ...

    return $node;
}

Using the Template name to set the default Escaping Strategy

New in version 1.8: This recipe requires Twig 1.8 or later.

The autoescape option determines the default escaping strategy to use when no escaping is applied on a variable. When Twig is used to mostly generate HTML files, you can set it to html and explicitly change it to js when you have some dynamic JavaScript files thanks to the autoescape tag:

1
2
3
 
{% autoescape 'js' %}
    ... some JS ...
{% endautoescape %}

But if you have many HTML and JS files, and if your template names follow some conventions, you can instead determine the default escaping strategy to use based on the template name. Let's say that your template names always end with .html for HTML files, .js for JavaScript ones, and .css for stylesheets, here is how you can configure Twig:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
class TwigEscapingGuesser
{
    function guess($filename)
    {
        // get the format
        $format = substr($filename, strrpos($filename, '.') + 1);

        switch ($format) {
            case 'js':
                return 'js';
            case 'css':
                return 'css';
            case 'html':
            default:
                return 'html';
        }
    }
}

$loader = new Twig_Loader_Filesystem('/path/to/templates');
$twig = new Twig_Environment($loader, array(
    'autoescape' => array(new TwigEscapingGuesser(), 'guess'),
));

This dynamic strategy does not incur any overhead at runtime as auto-escaping is done at compilation time.

Using a Database to store Templates

If you are developing a CMS, templates are usually stored in a database. This recipe gives you a simple PDO template loader you can use as a starting point for your own.

First, let's create a temporary in-memory SQLite3 database to work with:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
 
$dbh = new PDO('sqlite::memory:');
$dbh->exec('CREATE TABLE templates (name STRING, source STRING, last_modified INTEGER)');
$base = '{% block content %}{% endblock %}';
$index = '
{% extends "base.twig" %}
{% block content %}Hello {{ name }}{% endblock %}
';
$now = time();
$dbh->exec("INSERT INTO templates (name, source, last_modified) VALUES ('base.twig', '$base', $now)");
$dbh->exec("INSERT INTO templates (name, source, last_modified) VALUES ('index.twig', '$index', $now)");

We have created a simple templates table that hosts two templates: base.twig and index.twig.

Now, let's define a loader able to use this database:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
class DatabaseTwigLoader implements Twig_LoaderInterface, Twig_ExistsLoaderInterface
{
    protected $dbh;

    public function __construct(PDO $dbh)
    {
        $this->dbh = $dbh;
    }

    public function getSource($name)
    {
        if (false === $source = $this->getValue('source', $name)) {
            throw new Twig_Error_Loader(sprintf('Template "%s" does not exist.', $name));
        }

        return $source;
    }

    // Twig_ExistsLoaderInterface as of Twig 1.11
    public function exists($name)
    {
        return $name === $this->getValue('name', $name);
    }

    public function getCacheKey($name)
    {
        return $name;
    }

    public function isFresh($name, $time)
    {
        if (false === $lastModified = $this->getValue('last_modified', $name)) {
            return false;
        }

        return $lastModified <= $time;
    }

    protected function getValue($column, $name)
    {
        $sth = $this->dbh->prepare('SELECT '.$column.' FROM templates WHERE name = :name');
        $sth->execute(array(':name' => (string) $name));

        return $sth->fetchColumn();
    }
}

Finally, here is an example on how you can use it:

1
2
3
4
 
$loader = new DatabaseTwigLoader($dbh);
$twig = new Twig_Environment($loader);

echo $twig->render('index.twig', array('name' => 'Fabien'));

Using different Template Sources

This recipe is the continuation of the previous one. Even if you store the contributed templates in a database, you might want to keep the original/base templates on the filesystem. When templates can be loaded from different sources, you need to use theTwig_Loader_Chain loader.

As you can see in the previous recipe, we reference the template in the exact same way as we would have done it with a regular filesystem loader. This is the key to be able to mix and match templates coming from the database, the filesystem, or any other loader for that matter: the template name should be a logical name, and not the path from the filesystem:

1
2
3
4
5
6
7
8
9
 
$loader1 = new DatabaseTwigLoader($dbh);
$loader2 = new Twig_Loader_Array(array(
    'base.twig' => '{% block content %}{% endblock %}',
));
$loader = new Twig_Loader_Chain(array($loader1, $loader2));

$twig = new Twig_Environment($loader);

echo $twig->render('index.twig', array('name' => 'Fabien'));

Now that the base.twig templates is defined in an array loader, you can remove it from the database, and everything else will still work as before.


Coding Standards

When writing Twig templates, we recommend you to follow these official coding standards:

  • Put one (and only one) space after the start of a delimiter ({{, {%, and {#) and before the end of a delimiter (}}, %}, and #}):

    1
2
3
    		 
    {{ foo }}
{# comment #}
{% if foo %}{% endif %}

    When using the whitespace control character, do not put any spaces between it and the delimiter:

    1
2
3
    		 
    {{- foo -}}
{#- comment -#}
{%- if foo -%}{%- endif -%}

  • Put one (and only one) space before and after the following operators: comparison operators (==, !=, <, >, >=, <=), math operators (+, -,/, *, %, //, **), logic operators (not, and, or), ~, is, in, and the ternary operator (?:):

    {{ 1 + 2 }}
{{ foo ~ bar }}
{{ true ? true : false }}

  • Put one (and only one) space after the : sign in hashes and , in arrays and hashes:

    1
2
    		 
    {{ [1, 2, 3] }}
{{ {'foo': 'bar'} }}

  • Do not put any spaces after an opening parenthesis and before a closing parenthesis in expressions:

    1
    		 
    {{ 1 + (2 * 3) }}

  • Do not put any spaces before and after string delimiters:

    1
2
    		 
    {{ 'foo' }}
{{ "foo" }}

  • Do not put any spaces before and after the following operators: |, ., .., []:

    1
2
3
4
    		 
    {{ foo|upper|lower }}
{{ user.name }}
{{ user[name] }}
{% for i in 1..12 %}{% endfor %}

  • Do not put any spaces before and after the parenthesis used for filter and function calls:

    1
2
    		 
    {{ foo|default('foo') }}
{{ range(1..10) }}

  • Do not put any spaces before and after the opening and the closing of arrays and hashes:

    1
2
    		 
    {{ [1, 2, 3] }}
{{ {'foo': 'bar'} }}

  • Use lower cased and underscored variable names:

    1
2
    		 
    {% set foo = 'foo' %}
{% set foo_bar = 'foo' %}

  • Indent your code inside tags (use the same indentation as the one used for the target language of the rendered template):

    1
2
3
4
5
    		 
    {% block foo %}
   {% if true %}
       true
   {% endif %}
{% endblock %}

Functions

Filters

Tags


原文地址：http://twig.sensiolabs.org/doc/index.html


maray
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
twig模本引擎-中文手册-pdf版
05-12
Twig模版语言入门
for023的专栏
02-12 786
Twig中有两种定界符{% ... %} 和 {{ ... }} ， 前一种用来执行语句，比如for循环、IF判断、过滤等操作，后一种模版中用来显示变量。 Twig常用用法 可用符号 == != >= 部分符号的含义如下 ~：连接两字符串，相当于 PHP 中的点号 //：整除 **：乘方，相当于 PHP 中的 ^ b-and、b-or、b-xor：按位与、按位或、按位异或 -
php twig中文手册,使用技巧 · Twig 中文文档 · 看云
weixin_32484447的博客
04-12 776
#使用技巧##显示弃用通知> Twig 1.21新增的。被弃用的特性会产生弃用通知(通过调用PHP函数``trigger_error()`` )。默认地，弃用通知是沉默的，不会显示或记录。要便捷地删除模版中的所有已被弃用的特性用法，需要编写并运行以下脚本：require_once __DIR__.'/vendor/autoload.php';$twig = create_your_twig_...
php twig中文手册,介绍 · Twig 中文文档 · 看云
weixin_34168167的博客
04-12 281
# 介绍这是Twig模板引擎的文档。Twig是一款灵活、快速、安全的PHP模板引擎。如果你接触过其他基于文本的模板语言，比如 Smarty、Django、或者Jinja，你便能轻松掌握Twig。它坚持PHP的原则，并为模板环境添加了有用的功能，使其同时保持对设计师和开发者友好。Twig拥有以下关键特性：-快速：Twig将模板编译为纯粹的，最优化的PHP代码。它的开销与常规的PHP代码相比，已经降到...
TWIG 模板设计 快速入门手册 中文
热门推荐
jiaochangyun的专栏
01-09 3万+
写了好几篇关于twig的东西。。居然还没写个快速入门之类的。现在就写 来源 http://twig.sensiolabs.org/doc/templates.html 概要 twig 的模板就是普通的文本文件，也不需要特别的扩展名，.html .htm .twig 都可以。 模板内的 变量 和 表达式 会在运行的时候被解析替换，标签（tags）会来控制模板的逻辑 下面是个最小型的模板，用
Twig模板开发手册
04-07
web网站开发，Twig模板使用官方手册。在Symfony等框架中使用很方便。
twig模板手册
09-05
twig手册pdf版本的，带有锚点，使用特方便
twig标记说明
06-28
Twig 是个 简单而强力的模板，学习sf的朋友可以看看她。
TWIG 模板引擎 快速入门手册
chajinglong的专栏
07-06 9368
有关TWIG 模板引擎 快速入门手册需要原文、英文的朋友们，可以在这里找到     http://twig.sensiolabs.org/doc/templates.html TWIG The flexible, fast, and secure template engine for PHP       Twig for Templat
twig使用文档
03-07
模版引擎twig使用介绍，以及相关过滤器内容和介绍，方便掌握
php twig中文手册,twig 中文手册下载
weixin_29254673的博客
04-12 158
twig是比较快的php模板引擎，可以将模板编译成纯粹的优化php代码，具有很好的扩展性，灵活的词法分析程序和分析器功能，小编提供的twig 中文手册，从简单的安装到最后的代码生成都有详细的介绍，帮助用户快速掌握twig。从事php开发的朋友可以下载！twig变量介绍变量程序会传递给模板若干变量，你需要在模板里输出他们。例如输出 $hello[html] view plaincopyprint?{...
php twig中文手册,安装 · Twig 中文文档 · 看云
weixin_30399511的博客
04-12 260
# 安装其实，安装Twig有多种方法。### 安装Twig PHP package通过Composer安装(推荐)安装 [Composer](https://getcomposer.org/download/)，然后运行以下命令获取最新版Twig：~~~composer require twig/twig:~1.0~~~### 安装压缩包版1. 从[下载页面](https://github.com...
twig模板引擎详解（上集：设计师篇）【twig模板引擎中文使用教程】
云客的技术博客【云游天下 做客四方】
07-17 4415
前文：本文是《云客drupal源码分析》系列的番外篇，由于drupal采用了twig模板引擎，因此该篇将详细介绍twig，但不会涉及drupal任何内容，是原生twig的使用详解，分上下两集，上集供设计师阅读，讲解在模板中的使用，下集供php程序开发人员阅读，讲解程序调用、扩展开发。 本篇为上集，额外介绍了安装等必要内容，以便首次接触人员查阅，纯模板设计师可以跳过。 官网地址：https://t...
框架引入twig模板引擎
追 憶
10-03 3649
今天我们来讲一下在框架中使用twig模板引擎，首先使用composer进行下载。 在composer.json文件中添加肩头所指的内容，进入文件所在的目录的命令行，运行composer update,twig就下载完成了。 接下来我们来进行使用。在所有控制器的公共父类Controller的render方法中，我们改为以下内容。 public functionrender($fil
twig一些常用的用法总结
银狐的专栏
11-10 1万+
twig一些常用的用法总结
symfony框架Twig模板语言的使用
彭世瑜的博客
07-17 2248
php的Twig模板语言：类似python的jinja2，语法什么的都是类似python 模板继承 模板路径：app/Resources/views/ 母版：base.html.twig &lt;!DOCTYPE html&gt; &lt;html lang="zh-CN"&gt; &lt;head&gt; &lt;meta charset="utf-8"&gt; &lt;meta htt
解决Model.fit_generator (from tensorflow.python.keras.engine.training) is deprecated and will be remov
whysayso的博客
11-27 8305
解决WARNING:tensorflow:From :1: Model.fit_generator (from tensorflow.python.keras.engine.training) is deprecated and will be removed in a future version. Instructions for updating: Please use Model.fit, which supports generators. 文档在这：https://www.tensorflow.
thinphp5.1使用Parsedown解析markdown文件并用模板输出
最新发布
06-10
使用 Thin PHP 5.1 来解析 Markdown 文件并用模板输出，需要安装 Parsedown 和 Twig 两个库。 首先，通过 Composer 安装这两个库： ``` composer require erusev/parsedown composer require twig/twig ``` 然后，创建一个 PHP 文件，例如 `index.php`，来处理 Markdown 文件： ```php <?php require_once 'vendor/autoload.php'; use Twig\Environment; use Twig\Loader\FilesystemLoader; use Parsedown; // 读取 Markdown 文件内容 $md = file_get_contents('path/to/markdown/file.md'); // 将 Markdown 转换为 HTML $Parsedown = new Parsedown(); $html = $Parsedown->text($md); // 使用 Twig 模板引擎输出 HTML $loader = new FilesystemLoader('path/to/templates'); $twig = new Environment($loader); echo $twig->render('template.html', ['html' => $html]); ``` 在上述代码中，`path/to/markdown/file.md` 是 Markdown 文件的路径，`path/to/templates` 是模板文件的路径，`template.html` 是模板文件名。 在模板文件中，可以使用 `{{ html|raw }}` 输出 HTML 内容。 例如，`template.html` 文件可以这样写： ```html <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>Markdown to HTML</title> </head> <body> {{ html|raw }} </body> </html> ``` 以上代码会将 Markdown 文件转换为 HTML，并使用 Twig 模板引擎输出 HTML 内容。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值