CodeIgniter Simple and Secure Twig
, (*1)
This package provides simple Twig integration for CodeIgniter 3.x., (*2)
[!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., (*3)
If you use CodeIgniter4, check 4.x branch., (*4)
Folder Structure
codeigniter/
└── application/
└── libraries/
└── Twig.php
Requirements
- PHP 5.4.0 or later
- Twig 1.38.0 or later (Also, simply checked with Twig v2.x)
Installation
With Composer
$ cd /path/to/codeigniter/
$ composer require kenjis/codeigniter-ss-twig:^1.0
Install libraries/Twig.php to your CodeIgniter application folder:, (*5)
$ php vendor/kenjis/codeigniter-ss-twig/install.php
- Above command always overwrites exisiting files.
- You must run it at CodeIgniter project root folder.
Without Composer
Download the latest Twig v1.x: https://github.com/twigphp/Twig/releases, (*6)
Unzip and install to application/third_party folder., (*7)
Download the latest codeigniter-ss-twig: https://github.com/kenjis/codeigniter-ss-twig/releases, (*8)
Unzip and copy codeigniter-ss-twig/libraries/Twig.php to application/libraries folder., (*9)
Remove comment marks below and fix the path for Autoloader.php:, (*10)
--- 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
{
Usage
Loading Twig Library
$this->load->library('twig');
You can override the default configuration:, (*11)
$config = [
'paths' => ['/path/to/twig/templates', VIEWPATH],
'cache' => '/path/to/twig/cache',
];
$this->load->library('twig', $config);
Rendering Templates
Render Twig template and output to browser:, (*12)
$this->twig->display('welcome', $data);
Above code renders views/welcome.twig., (*13)
Note: I've changed the method name from render() to display(). Now render() method returns string only., (*14)
Render Twig template:, (*15)
$output = $this->twig->render('welcome', $data);
Above code renders views/welcome.twig., (*16)
Adding a Global Variable
$this->twig->addGlobal('sitename', 'My Awesome Site');
Getting Twig_Environment Instance
$twig = $this->twig->getTwig();
Supported CodeIgniter Helpers
base_urlsite_urlanchorform_openform_closeform_errorform_hiddenset_value
Some helpers are added the functionality of auto-escaping for security., (*17)
Adding Your Functions
You can add your functions with configuration:, (*18)
$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., (*19)
Reference
Documentation
- http://twig.sensiolabs.org/documentation
Samples
- https://github.com/kenjis/codeigniter-twig-samples
- https://github.com/kenjis/codeigniter-tettei-apps
How to Run Tests
$ cd codeigniter-ss-twig
$ composer install
$ vendor/bin/phpunit
Wallogit.com
