template.md 2.64 KB
Newer Older
1 2 3
Using template engines
======================

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

7 8
The `view` component is responsible for rendering views. You can add a custom template engines by reconfiguring this
component's behavior:
9 10

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

32 33 34 35 36 37 38 39 40
In the config above we're using Smarty and Twig. In order to get these extensions in your project you need to modify
your `composer.json` to include

```
"yiisoft/yii2-smarty": "*",
"yiisoft/yii2-twig": "*",
```

in `require` section and then run `composer update`.
41 42 43 44

Twig
----

45 46
To use Twig, you need to create templates in files with 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  when calling `$this->render()`
47 48 49
or `$this->renderPartial()` from your controller:

```php
Alexander Makarov committed
50
echo $this->render('renderer.twig', ['username' => 'Alex']);
51 52 53 54
```

### Additional functions

55
Yii adds the following construct to the standard Twig syntax:
56 57 58 59 60

```php
<a href="{{ path('blog/view', {'alias' : post.alias}) }}">{{ post.title }}</a>
```

61
Internally, the `path()` function calls Yii's `Html::url()` method.
62 63 64

### Additional variables

65 66 67 68
Within Twig templates, you can also make use of these variables:

- `app`, which equates to `\Yii::$app`
- `this`, which equates to the current `View` object
69 70 71 72

Smarty
------

73
To use Smarty, you need to create templates in files with 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  when calling `$this->render()`
74 75 76
or `$this->renderPartial()` from your controller:

```php
Alexander Makarov committed
77
echo $this->render('renderer.tpl', ['username' => 'Alex']);
78 79 80 81
```

### Additional functions

82
Yii adds the following construct to the standard Smarty syntax:
83 84 85 86 87

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

88
Internally, the `path()` function calls Yii's `Html::url()` method.
89 90 91

### Additional variables

92 93 94 95
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
96