Updated Smarty and Twig view to allow newly added Extension directory with urlFor extensions

Author: silentworks

Views/Extension/README.markdown

@@ -0,0 +1,41 @@
+# View Extensions
+This is where you can define all you custom functions in the template parser method of choice, I have currently included
+Twig and Smarty to allow Slim's urlFor() funtion in the template(view). You can add additional functions, filters, plugins to
+the Extension directory under the template parser directory of choice.
+
+## Twig
+### How to use
+To use this in Twig just include the code below at the top of your Slim index.php file after including TwigView.
+
+	TwigView::$twigExtensions = array(
+	    'Extension_Twig_Slim',
+	);
+
+Inside your Smarty template you would write:
+
+	{{ urlFor('hello', {"name": "Josh", "age": "19"}) }}
+
+You can easily pass variables that are objects or arrays by doing:
+
+	<a href="{{ urlFor('hello', {"name": person.name, "age": person.age}) }}">Hello {{ name }}</a>
+
+The $twigExtensions take an array of extension class name which need to follow the naming convention starting with __Extension_Twig__,
+this might seem like a overkill to add Slim's urlFor but it makes organising your project easier as your project becomes larger.
+
+## Smarty
+### How to use
+To use this in Smarty just include the code below at the top of your Slim index.php after including SmartyView.
+
+	SmartyView::$smartyExtensions = array(
+		dirname(__FILE__) . '/Views/Extension/Smarty',
+	);
+
+Inside your Smarty template you would write:
+
+	{urlFor name="hello" options="name.Josh|age.26"}
+
+You can easily pass variables that are arrays using the (.) or object using the (->) by doing:
+
+	<a href="{urlFor name="hello" options="name.{$person.name}|age.{$person.age}"}">Hello {$name}</a>
+
+The $smartyExtensions take an array of extension directories, this follows the Smarty naming convention provided in the Smarty docs.

Views/Extension/Smarty/function.urlFor.php

@@ -0,0 +1,28 @@
+<?php
+/*
+ * Smarty plugin
+ * -------------------------------------------------------------
+ * File:     function.urlFor.php
+ * Type:     function
+ * Name:     urlFor
+ * Purpose:  outputs url for a function with the defined name method
+ * -------------------------------------------------------------
+ */
+function smarty_function_urlFor($params, $template)
+{
+	$name = isset($params['name']) ? $params['name'] : '';
+	$url = Slim::getInstance()->urlFor($name);
+
+	if (isset($params['options']))
+	{
+		$options = explode('|', $params['options']);
+		foreach ($options as $option) {
+			list($key, $value) = explode('.', $option);
+			$opts[$key] = $value;
+		}
+
+		$url = Slim::getInstance()->urlFor($name, $opts);
+	}
+
+	return $url;
+}

Views/Extension/Twig/Slim.php

@@ -0,0 +1,16 @@
+<?php
+
+class Extension_Twig_Slim extends Twig_Extension
+{
+    public function getName()
+    {
+        return 'slim';
+    }
+
+    public function getFunctions()
+    {
+        return array(
+            'urlFor' => new Twig_Function_Function('Slim::getInstance()->urlFor'),
+        );
+    }
+}

Views/Extension/TwigAutoloader.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of Twig.
+ *
+ * (c) 2009 Fabien Potencier
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * Autoloads Twig Extensions classes.
+ *
+ * @package    twig
+ * @author     Fabien Potencier <[email protected]>
+ */
+class Twig_Extensions_Autoloader
+{
+    /**
+     * Registers Twig_Extensions_Autoloader as an SPL autoloader.
+     */
+    static public function register()
+    {
+        ini_set('unserialize_callback_func', 'spl_autoload_call');
+        spl_autoload_register(array(new self, 'autoload'));
+    }
+
+    /**
+     * Handles autoloading of classes.
+     *
+     * @param  string  $class  A class name.
+     *
+     * @return boolean Returns true if the class has been loaded
+     */
+    static public function autoload($class)
+    {
+        if (0 !== strpos($class, 'Extension_Twig')) {
+            return;
+        }
+
+        if (file_exists($file = dirname(dirname(__FILE__)) . '/' . str_replace('_', '/', $class).'.php')) {
+            require $file;
+        }
+    }
+}

Views/SmartyView.php

@@ -65,6 +65,11 @@ class SmartyView extends Slim_View {
      */
     public static $smartyTemplatesDirectory = 'templates';
 
+    /**
+     * @var SmartyExtensions The Smarty extensions directory you want to load plugins from
+     */
+    public static $smartyExtensions = array();
+
     /**
      * @var persistent instance of the Smarty object
      */
@@ -99,6 +104,9 @@ public static function getInstance() {
             require_once self::$smartyDirectory . '/Smarty.class.php';
             self::$smartyInstance = new Smarty();
             self::$smartyInstance->template_dir = is_null(self::$smartyTemplatesDirectory) ? $this->getTemplatesDirectory() : self::$smartyTemplatesDirectory;
+            if ( self::$smartyExtensions ) {
+                self::$smartyInstance->setPluginsDir(self::$smartyExtensions);
+            }
             if ( self::$smartyCompileDirectory ) {
                 self::$smartyInstance->compile_dir  = self::$smartyCompileDirectory;
             }
@@ -110,4 +118,4 @@ public static function getInstance() {
     }
 }
 
-?>
+?>

Views/TwigView.php

@@ -84,6 +84,13 @@ public function getEnvironment() {
                 $loader,
                 self::$twigOptions
             );
+
+            require_once dirname(__FILE__) . '/Extension/TwigAutoloader.php';
+            Twig_Extensions_Autoloader::register();
+
+            foreach (self::$twigExtensions as $ext) {
+                $this->twigEnvironment->addExtension(new $ext);
+            }
         }
         return $this->twigEnvironment;
     }