tutorial-template-engines.md 11.9 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
    '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'],
27
                    'uses' => ['yii\bootstrap'],
28 29 30 31 32
                ],
                // ...
            ],
        ],
    ],
Alexander Makarov committed
33
]
34 35
```

Larry Ullman committed
36 37
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:
38 39 40 41 42

```
"yiisoft/yii2-smarty": "*",
"yiisoft/yii2-twig": "*",
```
43
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.
44 45 46 47

Twig
----

48 49
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
50
in your `$this->render()` controller call:
51 52

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

56 57 58
### Template syntax

The best resource to learn Twig basics is its official documentation you can find at
59
[twig.sensiolabs.org](http://twig.sensiolabs.org/documentation). Additionally there are Yii-specific syntax extensions
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
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'})) }}
82
{{ void(myObject.my_function({'a' : 'b'})) }}
83 84
```

85 86 87 88 89 90 91 92 93
#### Setting object properties

There's a special function called `set` that allows you to set property of an object. For example, the following
in the template will change page title:

```
{{ set(this, 'title', 'New title') }}
```

94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
#### Importing namespaces and classes

You can import additional classes and namespaces right in the template:

```
Namespace import:
{{ use('/app/widgets') }}

Class import:
{{ use('/yii/widgets/ActiveForm') }}

Aliased class import:
{{ use({'alias' => '/app/widgets/MyWidget'}) }}
```

109
#### Referencing other templates
110

111
There are two ways of referencing templates in `include` and `extends` statements:
112 113 114

```
{% include "comment.twig" %}
115
{% extends "post.twig" %}
116 117 118 119 120

{% include "@app/views/snippets/avatar.twig" %}
{% extends "@app/views/layouts/2columns.twig" %}
```

121 122
In the first case the view will be searched relatively to the current template path. For `comment.twig` and `post.twig`
that means these will be searched in the same directory as the currently rendered template.
123 124 125

In the second case we're using path aliases. All the Yii aliases such as `@app` are available by default.

126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
#### Widgets

Extension helps using widgets in convenient way converting their syntax to function calls:

```
{{ use('yii/bootstrap') }}
{{ nav_bar_begin({
    'brandLabel': 'My Company',
}) }}
    {{ nav_widget({
        'options': {
            'class': 'navbar-nav navbar-right',
        },
        'items': [{
            'label': 'Home',
            'url': '/site/index',
        }]
    }) }}
{{ nav_bar_end() }}
```

In the template above `nav_bar_begin`, `nav_bar_end` or `nav_widget` consists of two parts. First part is widget name
coverted to lowercase and underscores: `NavBar` becomes `nav_bar`, `Nav` becomes `nav`. `_begin`, `_end` and `_widget`
are the same as `::begin()`, `::end()` and `::widget()` calls of a widget.

One could also use more generic `widget_end()` that executes `Widget::end()`.

#### Assets

Assets could be registered the following way:

```
{{ use('yii/web/JqueryAsset') }}
{{ register_jquery_asset() }}
```

In the call above `register` identifies that we're working with assets while `jquery_asset` translates to `JqueryAsset`
class that we've already imported with `use`.

165
#### Forms
Alexander Makarov committed
166

167
You can build forms the following way:
168

Alexander Makarov committed
169
```
170 171
{{ use('yii/widgets/ActiveForm') }}
{% set form = active_form_begin({
172 173 174 175 176 177 178 179 180
    '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>
181
{{ active_form_end() }}
Alexander Makarov committed
182 183 184
```


185
#### URLs
Alexander Makarov committed
186

187
There are two functions you can use for building URLs:
188 189 190

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

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

196
#### Additional variables
197

198
Within Twig templates the following variables are always defined:
199 200 201

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

203 204 205 206 207 208
### 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
209

210 211
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:
212 213 214

```php
'globals' => [
215 216
    'html' => '\yii\helpers\Html',
    'name' => 'Carsten',
217
    'GridView' => '\yii\grid\GridView',
218 219 220
],
```

Larry Ullman committed
221
Once configured, in your template you can use the globals in the following way:
222 223

```
yupe committed
224
Hello, {{name}}! {{ html.a('Please login', 'site/login') | raw }}.
225 226

{{ GridView.widget({'dataProvider' : provider}) | raw }}
227 228
```

229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
#### 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
248

Larry Ullman committed
249
Additional filters may be added via the application configuration's `filters` option:
250 251 252

```php
'filters' => [
253
    'jsonEncode' => '\yii\helpers\Json::encode',
254 255 256
],
```

257
Then in the template you can apply filter using the following syntax:
258 259 260 261 262 263

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


264 265 266
Smarty
------

267 268 269
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:
270 271

```php
272
return $this->render('renderer.tpl', ['username' => 'Alex']);
273 274
```

275 276 277 278 279 280
### Template syntax

The best resource to learn Smarty template syntax is its official documentation you can find at
[www.smarty.net](http://www.smarty.net/docs/en/). Additionally there are Yii-specific syntax extensions
described below.

281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
#### Setting object properties

There's a special function called `set` that allows you to set common properties of the view and controller. Currently
available properties are `title`, `theme` and `layout`:

```
{set title="My Page"}
{set theme="frontend"}
{set layout="main.tpl"}
```

For title there's dedicated block as well:

```
{title}My Page{/title}
```

#### Setting meta tags

Meta tags could be set like to following:

```
{meta keywords="Yii,PHP,Smarty,framework"}
```

There's also dedicated block for description:

```
{description}This is my page about Smarty extension{/description}
```

#### Calling object methods

Sometimes you need calling

#### Importing static classes, using widgets as functions and blocks

You can import additional static classes right in the template:

```
{use class="yii\helpers\Html"}
{Html::mailto('eugenia@example.com')}
```

If you want you can set custom alias:

```
{use class="yii\helpers\Html" as="Markup"}
{Markup::mailto('eugenia@example.com')}
```

Extension helps using widgets in convenient way converting their syntax to function calls or blocks. For regular widgets
function could be used like the following:

```
{use class='@yii\grid\GridView' type='function'}
{GridView dataProvider=$provider}
```

For widgets with `begin` and `end` methods such as ActiveForm it's better to use block:

```
{use class='yii\widgets\ActiveForm' type='block'}
{ActiveForm assign='form' id='login-form' action='/form-handler' options=['class' => 'form-horizontal']}
    {$form->field($model, 'firstName')}
    <div class="form-group">
        <div class="col-lg-offset-1 col-lg-11">
            <input type="submit" value="Login" class="btn btn-primary" />
        </div>
    </div>
{/ActiveForm}
```

If you're using particular widget a lot, it is a good idea to declare it in application config and remove `{use class`
call from templates:
356

357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
```php
'components' => [
    'view' => [
        // ...
        'renderers' => [
            'tpl' => [
                'class' => 'yii\smarty\ViewRenderer',
                'widgets' => [
                    'blocks' => [
                        'ActiveForm' => '\yii\widgets\ActiveForm',
                    ],
                ],
            ],
        ],
    ],
],
```

#### Referencing other templates

There are two main ways of referencing templates in `include` and `extends` statements:

```
{include 'comment.tpl'}
{extends 'post.tpl'}

{include '@app/views/snippets/avatar.tpl'}
{extends '@app/views/layouts/2columns.tpl'}
```

In the first case the view will be searched relatively to the current template path. For `comment.tpl` and `post.tpl`
that means these will be searched in the same directory as the currently rendered template.

In the second case we're using path aliases. All the Yii aliases such as `@app` are available by default.

#### CSS, JavaScript and asset bundles

In order to register JavaScript and CSS files the following syntax could be used:

```
{registerJsFile url='http://maps.google.com/maps/api/js?sensor=false' position='POS_END'}
{registerCssFile url='@assets/css/normalizer.css'}
```

If you need JavaScript and CSS directly in the template there are convenient blocks:

```
{registerJs key='show' position='POS_LOAD'}
    $("span.show").replaceWith('<div class="show">');
{/registerJs}

{registerCss}
div.header {
    background-color: #3366bd;
    color: white;
}
{/registerCss}
```

Asset bundles could be registered the following way:

```
{use class="yii\web\JqueryAsset"}
{JqueryAsset::register($this)|void}
```

Here we're using `void` modifier because we don't need method call result.

#### URLs

There are two functions you can use for building URLs:
428 429 430

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

434
`path` generates relative URL while `url` generates absolute one. Internally both are using [[\yii\helpers\Url]].
435

436
#### Additional variables
437

438
Within Smarty templates the following variables are always defined:
439 440 441

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

443 444 445 446 447 448 449 450
#### Accessing config params

Yii parameters that are available in your application through `Yii::$app->params->something` could be used the following
way:

```
`{#something#}`
```