yiiext / twig-renderer
Twig renderer for the Yii Framework.
Installs: 79 495
Dependents: 1
Suggesters: 0
Security: 0
Stars: 70
Watchers: 14
Forks: 30
Open Issues: 15
Type:yii-extension
Requires
- php: >=5.1.0
- twig/twig: 1.*
This package is auto-updated.
Last update: 2024-11-05 19:09:53 UTC
README
This extension allows you to use Twig templates in Yii.
Resources
Requirements
- Yii 1.0 or above
Installation
Installing manually
- Extract the release file under
vendor/Twig
. - Download and extract all Twig files from
fabpot-Twig-______.zip\fabpot-Twig-______\lib\Twig\
underprotected/vendor/Twig
. - Add the following to your config file 'components' section:
<?php 'viewRenderer' => array( 'class' => 'ext.ETwigViewRenderer', // All parameters below are optional, change them to your needs 'fileExtension' => '.twig', 'options' => array( 'autoescape' => true, ), 'extensions' => array( 'My_Twig_Extension', ), 'globals' => array( 'html' => 'CHtml' ), 'functions' => array( 'rot13' => 'str_rot13', ), 'filters' => array( 'jencode' => 'CJSON::encode', ), // Change template syntax to Smarty-like (not recommended) 'lexerOptions' => array( 'tag_comment' => array('{*', '*}'), 'tag_block' => array('{', '}'), 'tag_variable' => array('{$', '}') ), ),
Installing via Composer
- Get Composer
- Create file protected/composer.json if absent:
{ "repositories":[ { "type":"package", "package":{ "name":"yiiext/twig-renderer", "version":"1.1.15", "source":{ "type":"git", "url":"https://github.com/yiiext/twig-renderer", "reference":"v1.1.15" } } } ], "require":{ "php":">=5.3.0", "yiisoft/yii": "dev-master", "twig/twig": "1.*", "yiiext/twig-renderer":"1.1.*" } }
- Run
composer update
in the protected folder of your app. - Add the following to your config file 'components' section:
<?php 'viewRenderer' => array( 'class' => 'application.vendor.yiiext.twig-renderer.ETwigViewRenderer', 'twigPathAlias' => 'application.vendor.twig.twig.lib.Twig', // All parameters below are optional, change them to your needs 'fileExtension' => '.twig', 'options' => array( 'autoescape' => true, ), 'extensions' => array( 'My_Twig_Extension', ), 'globals' => array( 'html' => 'CHtml' ), 'functions' => array( 'rot13' => 'str_rot13', ), 'filters' => array( 'jencode' => 'CJSON::encode', ), // Change template syntax to Smarty-like (not recommended) 'lexerOptions' => array( 'tag_comment' => array('{*', '*}'), 'tag_block' => array('{', '}'), 'tag_variable' => array('{$', '}') ), ),
Usage
- See Twig syntax.
- Current controller properties are accessible via {{this.pageTitle}}.
- Yii::app() object is accessible via {{App}}.
- Yii's core static classes (for example, CHtml) are accessible via {{C.ClassNameWithoutFirstC.Method}} (example: {{C.Html.textField(name,'value')}})
- To call functions or methods which return non-string result wrap these calls with 'void' function: {{void(App.clientScript.registerScriptFile(...))}}
Widgets usage example
<div id="mainmenu"> {{ this.widget('zii.widgets.CMenu',{ 'items':[ {'label':'Home', 'url':['/site/index']}, {'label':'About', 'url':{0:'/site/page', 'view':'about'} }, {'label':'Contact', 'url':['/site/contact']}, {'label':'Login', 'url':['/site/login'], 'visible':App.user.isGuest}, {'label':'Logout ('~App.user.name~')', 'url':['/site/logout'], 'visible':not App.user.isGuest} ] }, true) }} </div><!-- mainmenu -->