tutorial-template-engines.md 5.65 KB
Newer Older
1 2 3
Using template engines
======================

4
> Note: This section is under development.
Qiang Xue committed
5

Larry Ullman committed
6
By default, Yii uses PHP as its template language, but you can configure Yii to support other rendering engines, such as
7
[Twig](http://twig.sensiolabs.org/) or [Smarty](http://www.smarty.net/).
8

Larry Ullman committed
9
The `view` component is responsible for rendering views. You can add a custom template engine by reconfiguring this
10
component's behavior:
11 12

```php
Alexander Makarov committed
13
[
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
    'components' => [
        'view' => [
            'class' => 'yii\web\View',
            'renderers' => [
                'tpl' => [
                    'class' => 'yii\smarty\ViewRenderer',
                    //'cachePath' => '@runtime/Smarty/cache',
                ],
                'twig' => [
                    'class' => 'yii\twig\ViewRenderer',
                    //'cachePath' => '@runtime/Twig/cache',
                    //'options' => [], /*  Array of twig options */
                    'globals' => ['html' => '\yii\helpers\Html'],
                ],
                // ...
            ],
        ],
    ],
Alexander Makarov committed
32
]
33 34
```

Larry Ullman committed
35 36
In the code above, both Smarty and Twig are configured to be useable by the view files. But in order to get these extensions into your project, you need to also modify
your `composer.json` file to include them, too:
37 38 39 40 41

```
"yiisoft/yii2-smarty": "*",
"yiisoft/yii2-twig": "*",
```
42
That code would be added to the `require` section of `composer.json`. After making that change and saving the file, you can install the extensions by running `composer update --prefer-dist` in the command-line.
43 44 45 46

Twig
----

47 48
To use Twig, you need to create templates in files that have the `.twig` extension (or use another file extension but
configure the component accordingly). Unlike standard view files, when using Twig you must include the extension
49
in your `$this->render()` controller call:
50 51

```php
52
return $this->render('renderer.twig', ['username' => 'Alex']);
53 54
```

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
### Template syntax

The best resource to learn Twig basics is its official documentation you can find at
[twig.sensiolabs.org](http://twig.sensiolabs.org/documentation). Additionally there are Yii-specific addtions
described below.

#### Method and function calls

If you need result you can call a method or a function using the following syntax:

```
{% set result = my_function({'a' : 'b'}) %}
{% set result = myObject.my_function({'a' : 'b'}) %}
```

If you need to echo result instead of assigning it to a variable:

```
{{ my_function({'a' : 'b'}) }}
{{ myObject.my_function({'a' : 'b'}) }}
```

In case you don't need result you shoud use `void` wrapper:

```
{{ void(my_function({'a' : 'b'})) }}
{{ void(myObject.my_function({'a' : 'b'})} }}
```

#### Forms
Alexander Makarov committed
85

86 87
There are two form helper functions `form_begin` and `form_end` to make using forms more convenient:

Alexander Makarov committed
88
```
89 90 91 92 93 94 95 96 97 98 99
{% set form = form_begin({
    'id' : 'login-form',
    'options' : {'class' : 'form-horizontal'},
}) %}
    {{ form.field(model, 'username') | raw }}
    {{ form.field(model, 'password').passwordInput() | raw }}

    <div class="form-group">
        <input type="submit" value="Login" class="btn btn-primary" />
    </div>
{{ form_end() }}
Alexander Makarov committed
100 101 102
```


103
#### URLs
Alexander Makarov committed
104

105
There are two functions you can use for building URLs:
106 107 108

```php
<a href="{{ path('blog/view', {'alias' : post.alias}) }}">{{ post.title }}</a>
Alexander Makarov committed
109
<a href="{{ url('blog/view', {'alias' : post.alias}) }}">{{ post.title }}</a>
110 111
```

Alexander Makarov committed
112
`path` generates relative URL while `url` generates absolute one. Internally both are using [[\yii\helpers\Url]].
113

114
#### Additional variables
115

116
Within Twig templates the following variables are always defined:
117 118 119

- `app`, which equates to `\Yii::$app`
- `this`, which equates to the current `View` object
120

121 122 123 124 125 126
### Additional configuration

Yii Twig extension allows you to define your own syntax and bring regular helper classes into templates. Let's review
configuration options.

#### Globals
127

128 129
You can add global helpers or values via the application configuration's `globals` variable. You can define both Yii
helpers and your own variables there:
130 131 132

```php
'globals' => [
133 134
    'html' => '\yii\helpers\Html',
    'name' => 'Carsten',
135
    'GridView' => '\yii\grid\GridView',
136 137 138
],
```

Larry Ullman committed
139
Once configured, in your template you can use the globals in the following way:
140 141

```
yupe committed
142
Hello, {{name}}! {{ html.a('Please login', 'site/login') | raw }}.
143 144

{{ GridView.widget({'dataProvider' : provider}) | raw }}
145 146
```

147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
#### Functions

You can define additional functions like the following:

```php
'functions' => [
    'rot13' => 'str_rot13',
    'truncate' => '\yii\helpers\StringHelper::truncate',
],
```

In template they could be used like the following:

```
`{{ rot13('test') }}`
`{{ truncate(post.text, 100) }}`
```

#### Filters
166

Larry Ullman committed
167
Additional filters may be added via the application configuration's `filters` option:
168 169 170

```php
'filters' => [
171
    'jsonEncode' => '\yii\helpers\Json::encode',
172 173 174
],
```

175
Then in the template you can apply filter using the following syntax:
176 177 178 179 180 181

```
{{ model|jsonEncode }}
```


182 183 184
Smarty
------

Larry Ullman committed
185 186
To use Smarty, you need to create templates in files that have the `.tpl` extension (or use another file extension but configure the component accordingly). Unlike standard view files, when using Smarty you must include the extension in your `$this->render()`
or `$this->renderPartial()` controller calls:
187 188

```php
189
return $this->render('renderer.tpl', ['username' => 'Alex']);
190 191 192 193
```

### Additional functions

194
Yii adds the following construct to the standard Smarty syntax:
195 196 197 198 199

```php
<a href="{path route='blog/view' alias=$post.alias}">{$post.title}</a>
```

200
Internally, the `path()` function calls Yii's `Url::to()` method.
201 202 203

### Additional variables

204 205 206 207
Within Smarty templates, you can also make use of these variables:

- `$app`, which equates to `\Yii::$app`
- `$this`, which equates to the current `View` object
208