Merge pull request #65 from kenjis/feat-filter-support

feat: filter support

Author: kenjis

ChangeLog.md

@@ -1,5 +1,15 @@
 # Change Log for CodeIgniter Simple and Secure Twig
 
+## v4.2.0 (Unreleased)
+
+### Changed
+
+- Require:
+    - PHP 7.4 or later.
+    - Twig 3.4.3 or later.
+    - CodeIgniter 4.2.11 or later.
+- Add functionality to add your filters. See [README](README.md#adding-your-functions--filters).
+
 ## v4.1.0 (2022-09-20)
 
 ### Changed
@@ -51,7 +61,7 @@
 
 ### Added
 
-* Add functionality to add your functions. See [README](README.md#adding-your-functions).
+* Add functionality to add your functions. See [README](README.md#adding-your-functions--filters).
 
 ## v0.1.0 (2015/11/17)
 

README.md

@@ -8,9 +8,9 @@ If you use CodeIgniter3, check [master](https://github.com/kenjis/codeigniter-ss
 
 ## Requirements
 
-* PHP 7.3 or later
-* CodeIgniter 4.2 or later
-* Twig 3.3.8 or later
+* PHP 7.4 or later
+* CodeIgniter 4.2.11 or later
+* Twig 3.4.3 or later
 
 ## Installation
 
@@ -33,8 +33,8 @@ You can override the default configuration:
 
 ~~~php
 $config = [
-	'paths' => ['/path/to/twig/templates', VIEWPATH],
-	'cache' => '/path/to/twig/cache',
+    'paths' => ['/path/to/twig/templates', VIEWPATH],
+    'cache' => '/path/to/twig/cache',
 ];
 $this->twig = new \Kenjis\CI4Twig\Twig($config);
 ~~~
@@ -71,25 +71,26 @@ $twig = $this->twig->getTwig();
 
 ### Supported CodeIgniter Helpers
 
-* `base_url`
-* `site_url`
-* `anchor`
-* `form_open`
-* `form_close`
-* `form_error`
-* `form_hidden`
-* `set_value`
+* `base_url()`
+* `site_url()`
+* `anchor()`
+* `form_open()`
+* `form_close()`
+* `form_error()`
+* `form_hidden()`
+* `set_value()`
 
 Some helpers are added the functionality of auto-escaping for security.
 
-### Adding Your Functions
+### Adding Your Functions & Filters
 
-You can add your functions with configuration:
+You can add your functions and filters with configuration:
 
 ~~~php
 $config = [
-	'functions' => ['my_helper'],
-	'functions_safe' => ['my_safe_helper'],
+    'functions'      => ['my_helper'],
+    'functions_safe' => ['my_safe_helper'],
+    'filters'        => ['my_filter'],
 ];
 $this->twig = new \Kenjis\CI4Twig\Twig($config);
 ~~~

src/CI4Twig/Twig.php

@@ -16,6 +16,7 @@
 use Twig\Error\SyntaxError;
 use Twig\Extension\DebugExtension;
 use Twig\Loader\FilesystemLoader;
+use Twig\TwigFilter;
 use Twig\TwigFunction;
 
 class Twig
@@ -40,6 +41,11 @@ class Twig
         'site_url',
     ];
 
+    /**
+     * @var array Filters to add to Twig
+     */
+    private array $filters = [];
+
     /**
      * @var array Functions with `is_safe` option
      *
@@ -61,6 +67,11 @@ class Twig
      */
     private bool $functions_added = false;
 
+    /**
+     * @var bool Whether filters are added or not
+     */
+    private bool $filters_added = false;
+
     private ?Environment $twig = null;
 
     /**
@@ -87,6 +98,13 @@ public function __construct($params = [])
             unset($params['functions_safe']);
         }
 
+        if (isset($params['filters'])) {
+            $this->filters = array_unique(
+                array_merge($this->filters, $params['filters'])
+            );
+            unset($params['filters']);
+        }
+
         if (isset($params['paths'])) {
             $this->paths = $params['paths'];
             unset($params['paths']);
@@ -176,15 +194,35 @@ public function display($view, $params = [])
     public function render($view, $params = []): string
     {
         $this->createTwig();
+
         // We call addFunctions() here, because we must call addFunctions()
         // after loading CodeIgniter functions in a controller.
         $this->addFunctions();
+        $this->addFilters();
 
         $view = $view . '.twig';
 
         return $this->twig->render($view, $params);
     }
 
+    protected function addFilters()
+    {
+        // Runs only once
+        if ($this->filters_added) {
+            return;
+        }
+
+        foreach ($this->filters as $filter) {
+            if (function_exists($filter)) {
+                $this->twig->addFilter(
+                    new TwigFilter($filter, $filter)
+                );
+            }
+        }
+
+        $this->filters_added = true;
+    }
+
     protected function addFunctions()
     {
         // Runs only once
@@ -196,10 +234,7 @@ protected function addFunctions()
         foreach ($this->functions_asis as $function) {
             if (function_exists($function)) {
                 $this->twig->addFunction(
-                    new TwigFunction(
-                        $function,
-                        $function
-                    )
+                    new TwigFunction($function, $function)
                 );
             }
         }

tests/CI4Twig/TwigTest.php

@@ -19,7 +19,7 @@ public static function setUpBeforeClass(): void
         helper('form');
     }
 
-    public function testRedner()
+    public function testRender()
     {
         $obj = new Twig(['paths' => __DIR__ . '/../templates/']);
 
@@ -110,4 +110,18 @@ public function testFunctionSafe()
         $output = $obj->render('functions_safe');
         $this->assertSame("<s>test</s>\n", $output);
     }
+
+    public function testFilter()
+    {
+        $obj = new Twig(
+            [
+                'paths'   => __DIR__ . '/../templates/',
+                'filters' => ['str_rot13'],
+                'cache'   => false,
+            ]
+        );
+
+        $output = $obj->render('filters');
+        $this->assertSame("PbqrVtavgre Fvzcyr naq Frpher Gjvt\n", $output);
+    }
 }

tests/templates/filters.twig

@@ -0,0 +1 @@
+{{ 'CodeIgniter Simple and Secure Twig'|str_rot13 }}