Integrate Twig with CodeIgniter 4
Try this I hope it will help you
Install Composer and run the following command to get the latest version:
composer require "twig/twig:^3.0"
Then after installation add this line of code to the baseController initController method just after the parent::initController, just like the code below
namespace App\Controllers;use CodeIgniter\Controller;use CodeIgniter\HTTP\RequestInterface;use CodeIgniter\HTTP\ResponseInterface;use Psr\Log\LoggerInterface;class BaseController extends Controller{ protected $helpers = []; protected $twig; // protected $helper = []; public function initController(RequestInterface $request, ResponseInterface $response, LoggerInterface $logger) { parent::initController($request, $response, $logger); $appPaths = new \Config\Paths(); $appViewPaths = $appPaths->viewDirectory; $loader = new \Twig\Loader\FilesystemLoader($appViewPaths); $this->twig = new \Twig\Environment($loader, [ 'cache' => WRITEPATH.'/cache/twig', ]); }}So with this now you can call the view files in other controllers extends to parent controller BaseControllere.g
namespace App\Controllers;class Home extends BaseController{ public function index () { // To load a template from a Twig environment, call the load() method which returns a \Twig\TemplateWrapper instance: $template = $this->twig->load('index.html'); // To render the template with some variables, call the render() method: return $template->render(['the' => 'variables', 'go' => 'here']); // The display() method is a shortcut to output the rendered template. // OR You can also load and render the template in one fell swoop: return $this->twig->render('index.html', ['the' => 'variables', 'go' => 'here']); // If a template defines blocks, they can be rendered individually via the renderBlock() call: return $template->renderBlock('block_name', ['the' => 'variables', 'go' => 'here']); // Note any of them above will work }}If you still want to use view() with twig like codeigniter 4 default view function you can modify the Common.php file in app directoryby adding this block of code below.
if (!function_exists('view')){ function view($tpl, $data = []) { $appPaths = new \Config\Paths(); $appViewPaths = $appPaths->viewDirectory; $loader = new \Twig\Loader\FilesystemLoader($appViewPaths); $twig = new \Twig\Environment($loader, [ 'cache' => WRITEPATH.'/cache/twig', ]); if (!stripos($tpl, '.twig')) { $tpl = $tpl . '.twig'; } return $twig->render($tpl, $data); }}Then in controller call it like this
return view('index.php', ['name' => 'Chibueze Agwu'])Then in view file index.php
<!DOCTYPE html><html> <head> <title>My Webpage</title> </head> <body> <h1>My Webpage</h1> {{ name }} </body></html>This will output
My Webpage
Chibueze Agwu
I haven't test this code but I hope it will work. If not call my attentions.In order to obey the the rule of DRY (DO NOT REPEAT YOURSELF), you can go ahead to improve the code I will do that later
I found the solution some time ago and I'm posting it in case some people stumble across the question.
First of all, all your controllers must extend
BaseController; this controller is available by default when you install CodeIgniter 4.Create a custom helper file and put in
[project-name]/appstarter/app/Helpers.
IMPORTANT
- the name of your helper must be
[name]_helper.phpor it will not work!
for example mine is called custom_helper.php
Create the following function in the custom helper you just created:
use Twig\Environment; use Twig\Extension\DebugExtension; use Twig\Loader\FilesystemLoader; use Twig\TwigFilter; if (!function_exists('twig_conf')) { function twig_conf() { // the follwing line of code is the only one needed to make Twig work // the lines of code that follow are optional $loader = new FilesystemLoader('Views', '../app/'); // to be able to use the 'dump' function in twig files $twig = new Environment($loader, ['debug' => true]); $twig->addExtension(new DebugExtension()); // twig lets you create custom filters $filter = new TwigFilter('_base_url', function ($asset) { return base_url() . '/' . $asset; }); $twig->addFilter($filter); return $twig; } }
NOTE
- before creating any custom filter, make sure Twig doesn't already has one built-in.
Now in the
BaseControlleryou'll find an empty array called$helpers. You must put the name of your custom helper in it. Mine is calledcustom_helper.php; so the code looks like this for me:protected $helpers = ['custom'];Just below the array you'll find the constructor for
BaseControllerand this is where the Twig library will be initialized; by calling the function you created in your custom helper:public function initController(RequestInterface $request, ResponseInterface $response, LoggerInterface $logger) { parent::initController($request, $response, $logger); $this->twig = twig_conf();}Now you are good to go! To render your twig files in any controller:
return $this->twig->render('twig_name', $dataArray);
Try this I hope it will help you.
Install Composer and run the following command to get the latest version:
composer require "twig/twig:^3.0"