This package provides simple Twig integration for CodeIgniter 3.x.
Warning
CodeIgniter 3 has not been updated for over a year already. It also does not support PHP 8.2. No official announcement has been made, but there is almost no maintainer. Upgrading to CodeIgniter 4 is strongly recommended.
If you use CodeIgniter4, check 4.x branch.
codeigniter/ └── application/ └── libraries/ └── Twig.php - PHP 5.4.0 or later
- Twig 1.38.0 or later (Also, simply checked with Twig v2.x)
$ cd /path/to/codeigniter/ $ composer require kenjis/codeigniter-ss-twig:^1.0 Install libraries/Twig.php to your CodeIgniter application folder:
$ php vendor/kenjis/codeigniter-ss-twig/install.php - Above command always overwrites exisiting files.
- You must run it at CodeIgniter project root folder.
Download the latest Twig v1.x: https://github.com/twigphp/Twig/releases
Unzip and install to application/third_party folder.
Download the latest codeigniter-ss-twig: https://github.com/kenjis/codeigniter-ss-twig/releases
Unzip and copy codeigniter-ss-twig/libraries/Twig.php to application/libraries folder.
Remove comment marks below and fix the path for Autoloader.php:
--- a/libraries/Twig.php +++ b/libraries/Twig.php @@ -9,10 +9,8 @@ */ // If you don't use Composer, uncomment below -/* require_once APPPATH . 'third_party/Twig-1.xx.x/lib/Twig/Autoloader.php'; Twig_Autoloader::register(); -*/ class Twig {$this->load->library('twig');You can override the default configuration:
$config = [ 'paths' => ['/path/to/twig/templates', VIEWPATH], 'cache' => '/path/to/twig/cache', ]; $this->load->library('twig', $config);Render Twig template and output to browser:
$this->twig->display('welcome', $data);Above code renders views/welcome.twig.
Note: I've changed the method name from
render()todisplay(). Nowrender()method returns string only.
Render Twig template:
$output = $this->twig->render('welcome', $data);Above code renders views/welcome.twig.
$this->twig->addGlobal('sitename', 'My Awesome Site');$twig = $this->twig->getTwig();base_urlsite_urlanchorform_openform_closeform_errorform_hiddenset_value
Some helpers are added the functionality of auto-escaping for security.
You can add your functions with configuration:
$config = [ 'functions' => ['my_helper'], 'functions_safe' => ['my_safe_helper'], ]; $this->load->library('twig', $config);If your function explicitly outputs HTML code, you will want the raw output to be printed. In such a case, use functions_safe, and you have to make sure the output of the function is XSS free.
- https://github.com/kenjis/codeigniter-twig-samples
- https://github.com/kenjis/codeigniter-tettei-apps
$ cd codeigniter-ss-twig $ composer install $ vendor/bin/phpunit