Merge pull request #8 from kenjis/add-functions

Add functionality to add functions with config

Author: kenjis

README.md

@@ -71,7 +71,7 @@ Remove comment marks below and fix the path for `Autoloader.php`:
 $this->load->library('twig');
 ~~~
 
-You can override the default configration:
+You can override the default configuration:
 
 ~~~php
 $config = [
@@ -126,6 +126,20 @@ $twig = $this->twig->getTwig();
 
 Some helpers are added the functionality of auto-escaping for security.
 
+### Adding Your Functions
+
+You can add your functions with configuration:
+
+~~~php
+$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.
+
 ### Reference
 
 #### Documentation

libraries/Twig.php

@@ -26,9 +26,9 @@ class Twig
 	];
 
 	/**
-	 * @var bool Whether added CodeIgniter functions or not
+	 * @var bool Whether functions are added or not
 	 */
-	private $add_ci_functions = FALSE;
+	private $functions_added = FALSE;
 
 	/**
 	 * @var Twig_Environment
@@ -49,6 +49,21 @@ public function __construct($params = [])
 		];
 
 		$this->config = array_merge($this->config, $params);
+
+		if (isset($params['functions']))
+		{
+			$this->functions_asis = 
+				array_unique(
+					array_merge($this->functions_asis, $params['functions'])
+				);
+		}
+		if (isset($params['functions_safe']))
+		{
+			$this->functions_safe = 
+				array_unique(
+					array_merge($this->functions_safe, $params['functions_safe'])
+				);
+		}
 	}
 
 	protected function resetTwig()
@@ -132,18 +147,18 @@ public function display($view, $params = [])
 	public function render($view, $params = [])
 	{
 		$this->createTwig();
-		// We call addCIFunctions() here, because we must call addCIFunctions()
+		// We call addFunctions() here, because we must call addFunctions()
 		// after loading CodeIgniter functions in a controller.
-		$this->addCIFunctions();
+		$this->addFunctions();
 
 		$view = $view . '.twig';
 		return $this->twig->render($view, $params);
 	}
 
-	protected function addCIFunctions()
+	protected function addFunctions()
 	{
 		// Runs only once
-		if ($this->add_ci_functions)
+		if ($this->functions_added)
 		{
 			return;
 		}
@@ -189,7 +204,7 @@ protected function addCIFunctions()
 			);
 		}
 
-		$this->add_ci_functions = TRUE;
+		$this->functions_added = TRUE;
 	}
 
 	/**
@@ -198,7 +213,7 @@ protected function addCIFunctions()
 	 * @param array  $attributes [changed] only array is acceptable
 	 * @return string
 	 */
-	protected function safe_anchor($uri = '', $title = '', $attributes = [])
+	public function safe_anchor($uri = '', $title = '', $attributes = [])
 	{
 		$uri = html_escape($uri);
 		$title = html_escape($title);

tests/libraries/TwigTest.php

@@ -6,7 +6,7 @@ public static function setUpBeforeClass()
     {
         parent::setUpBeforeClass();
         $CI =& get_instance();
-        $CI->load->library('Twig');
+        $CI->load->library('twig');
         $CI->load->helper('url_helper');
         $CI->load->helper('form_helper');
     }
@@ -44,7 +44,7 @@ public function testAddGlobal()
         $this->assertEquals('<title>Twig Test Site</title>'."\n", $output);
     }
 
-    public function testAddCIFunctionsRunsOnlyOnce()
+    public function testAddFunctionsRunsOnlyOnce()
     {
         $obj = new Twig(['paths' => __DIR__ . '/../templates/']);
 
@@ -53,26 +53,55 @@ public function testAddCIFunctionsRunsOnlyOnce()
         ];
 
         $ref_obj = new ReflectionObject($obj);
-        $ref_property = $ref_obj->getProperty('add_ci_functions');
+        $ref_property = $ref_obj->getProperty('functions_added');
         $ref_property->setAccessible(true);
-        $add_ci_functions = $ref_property->getValue($obj);
-        $this->assertEquals(false, $add_ci_functions);
+        $functions_added = $ref_property->getValue($obj);
+        $this->assertEquals(false, $functions_added);
 
         $output = $obj->render('welcome', $data);
 
         $ref_obj = new ReflectionObject($obj);
-        $ref_property = $ref_obj->getProperty('add_ci_functions');
+        $ref_property = $ref_obj->getProperty('functions_added');
         $ref_property->setAccessible(true);
-        $add_ci_functions = $ref_property->getValue($obj);
-        $this->assertEquals(true, $add_ci_functions);
+        $functions_added = $ref_property->getValue($obj);
+        $this->assertEquals(true, $functions_added);
 
         // Calls render() twice
         $output = $obj->render('welcome', $data);
 
         $ref_obj = new ReflectionObject($obj);
-        $ref_property = $ref_obj->getProperty('add_ci_functions');
+        $ref_property = $ref_obj->getProperty('functions_added');
         $ref_property->setAccessible(true);
-        $add_ci_functions = $ref_property->getValue($obj);
-        $this->assertEquals(true, $add_ci_functions);
+        $functions_added = $ref_property->getValue($obj);
+        $this->assertEquals(true, $functions_added);
     }
+
+    public function testFunctionAsIs()
+    {
+        $obj = new Twig([
+            'paths' => __DIR__ . '/../templates/',
+            'functions' => ['md5'],
+            'cache' => false,
+        ]);
+        
+        $output = $obj->render('functions_asis');
+        $this->assertEquals('900150983cd24fb0d6963f7d28e17f72'."\n", $output);
+    }
+
+    public function testFunctionSafe()
+    {
+        $obj = new Twig([
+            'paths' => __DIR__ . '/../templates/',
+            'functions_safe' => ['test_safe'],
+            'cache' => false,
+        ]);
+        
+        $output = $obj->render('functions_safe');
+        $this->assertEquals('<s>test</s>'."\n", $output);
+    }
+}
+
+function test_safe()
+{
+    return '<s>test</s>';
 }

tests/templates/functions_asis.twig

@@ -0,0 +1 @@
+{{ md5('abc') }}

tests/templates/functions_safe.twig

@@ -0,0 +1 @@
+{{ test_safe() }}