diff --git a/extensions/yii/twig/CHANGELOG.md b/extensions/yii/twig/CHANGELOG.md index 85b09d5..85ea863 100644 --- a/extensions/yii/twig/CHANGELOG.md +++ b/extensions/yii/twig/CHANGELOG.md @@ -5,6 +5,7 @@ Yii Framework 2 twig extension Change Log ---------------------------- - no changes in this release. +- Add File based Twig loader for better caching and usability of twig's file based function 2.0.0 alpha, December 1, 2013 ----------------------------- diff --git a/extensions/yii/twig/TwigSimpleFileLoader.php b/extensions/yii/twig/TwigSimpleFileLoader.php new file mode 100644 index 0000000..2ffaddd --- /dev/null +++ b/extensions/yii/twig/TwigSimpleFileLoader.php @@ -0,0 +1,76 @@ + + * @version 1.0.0 + */ +class TwigSimpleFileLoader implements \Twig_LoaderInterface { + + /** + * @var string Path to directory + */ + private $_dir; + + /* + * @param @dir string path to directory + */ + public function __construct($dir) + { + $this->_dir=$dir; + } + + /** + * Compare a file's freshness with previously stored timestamp + * + * @param $name string file name to check + * @param $time int timestamp to compare with + * @return bool true if file is still fresh and not changes, false otherwise + */ + public function isFresh($name, $time) + { + return filemtime($this->getFilePath($name))<=$time; + } + + /** + * get the source of given file name + * + * @param $name string file name + * @return string contents of given file name + */ + public function getSource($name) + { + return file_get_contents($this->getFilePath($name)); + } + + /** + * get a unique key that can represent this file uniquely among other files. + * @param $name + * @return string + */ + public function getCacheKey($name) + { + return $this->getFilePath($name); + } + + /** + * internally used to get absolute path of given file name + * @param $name string file name + * @return string absolute path of file + */ + protected function getFilePath($name){ + return $this->_dir.'/'.$name; + } + +} \ No newline at end of file diff --git a/extensions/yii/twig/ViewRenderer.php b/extensions/yii/twig/ViewRenderer.php index 7483f04..05f66d7 100644 --- a/extensions/yii/twig/ViewRenderer.php +++ b/extensions/yii/twig/ViewRenderer.php @@ -13,6 +13,7 @@ use Yii; use yii\base\View; use yii\base\ViewRenderer as BaseViewRenderer; use yii\helpers\Html; +use yii\twig\TwigSimpleFileLoader; /** * TwigViewRenderer allows you to use Twig templates in views. @@ -28,35 +29,100 @@ class ViewRenderer extends BaseViewRenderer public $cachePath = '@runtime/Twig/cache'; /** - * @var array extentions list. - */ - public $extensions = []; - - /** * @var array Twig options * @see http://twig.sensiolabs.org/doc/api.html#environment-options */ public $options = []; - /** - * @var \Twig_Environment + /** + * @var array Objects or static classes + * Keys of array are names to call in template, values - objects or names of static class as string + * Example: array('html'=>'\yii\helpers\Html') + * Than in template: {{ html.link('Login', 'site/login') }} + */ + public $globals = []; + + /** + * @var array Custom functions + * Keys of array are names to call in template, values - names of functions or static methods of some class + * Example: array('rot13'=>'str_rot13', 'link'=>'\yii\helpers\Html::link') + * Than in template: {{ rot13('test') }} or {{ link('Login', 'site/login') }} + */ + public $functions = []; + + /** + * @var array Custom filters + * Keys of array are names to call in template, values - names of functions or static methods of some class + * Example: array('rot13'=>'str_rot13', 'jsonEncode'=>'\yii\helpers\Json::encode') + * Then in template: {{ 'test'|rot13 }} or {{ model|jsonEncode }} + */ + public $filters = []; + + /** + * @var array Custom extensions + * Example: array('Twig_Extension_Sandbox', 'Twig_Extension_Text') + */ + public $extensions = []; + + /** + * @var array Twig lexer options + * @see http://twig.sensiolabs.org/doc/recipes.html#customizing-the-syntax + * Example: Smarty-like syntax + * array( + * 'tag_comment' => array('{*', '*}'), + * 'tag_block' => array('{', '}'), + * 'tag_variable' => array('{$', '}') + * ) + */ + public $lexerOptions = []; + + /** + * @var \Twig_Environment twig environment object that do all rendering twig templates */ public $twig; public function init() { - $loader = new \Twig_Loader_String(); - $this->twig = new \Twig_Environment($loader, array_merge([ + $this->twig = new \Twig_Environment(null, array_merge([ 'cache' => Yii::getAlias($this->cachePath), + 'charset' => Yii::$app->charset, ], $this->options)); - + + // Adding custom extensions if (!empty($this->extensions)) { foreach ($this->extensions as $extension) { $this->twig->addExtension(new $extension()); } } + // Adding custom globals (objects or static classes) + if (!empty($this->globals)) { + $this->addGlobals($this->globals); + } + // Adding custom functions + if (!empty($this->functions)) { + $this->addFunctions($this->functions); + } + // Adding custom filters + if (!empty($this->filters)) { + $this->addFilters($this->filters); + } + // Adding custom extensions + if (!empty($this->extensions)) { + $this->addExtensions($this->extensions); + } + // Change lexer syntax + if (!empty($this->lexerOptions)) { + $this->setLexerOptions($this->lexerOptions); + } + + + // Adding global 'void' function (usage: {{void(App.clientScript.registerScriptFile(...))}}) + $this->twig->addFunction('void', new \Twig_Function_Function(function($argument){ + + })); + $this->twig->addFunction('path', new \Twig_Function_Function(function ($path, $args = []) { return Html::url(array_merge([$path], $args)); })); @@ -64,6 +130,7 @@ class ViewRenderer extends BaseViewRenderer $this->twig->addGlobal('app', \Yii::$app); } + /** * Renders a view file. * @@ -79,6 +146,95 @@ class ViewRenderer extends BaseViewRenderer public function render($view, $file, $params) { $this->twig->addGlobal('this', $view); - return $this->twig->render(file_get_contents($file), $params); + $this->twig->setLoader(new TwigSimpleFileLoader(dirname($file))); + return $this->twig->render(pathinfo($file,PATHINFO_BASENAME), $params); + } + + /** + * Adds global objects or static classes + * @param array $globals @see self::$globals + */ + public function addGlobals($globals) + { + foreach ($globals as $name => $value) { + if (!is_object($value)) { + $value = new ViewRendererStaticClassProxy($value); + } + $this->twig->addGlobal($name, $value); + } + } + + /** + * Adds custom functions + * @param array $functions @see self::$functions + */ + public function addFunctions($functions) + { + $this->_addCustom('Function', $functions); + } + + /** + * Adds custom filters + * @param array $filters @see self::$filters + */ + public function addFilters($filters) + { + $this->_addCustom('Filter', $filters); + } + + /** + * Adds custom extensions + * @param array $extensions @see self::$extensions + */ + public function addExtensions($extensions) + { + foreach ($extensions as $extName) { + $this->twig->addExtension(new $extName()); + } + } + + /** + * Sets Twig lexer options to change templates syntax + * @param array $options @see self::$lexerOptions + */ + public function setLexerOptions($options) + { + $lexer = new \Twig_Lexer($this->twig, $options); + $this->twig->setLexer($lexer); + } + + /** + * Adds custom function or filter + * @param string $classType 'Function' or 'Filter' + * @param array $elements Parameters of elements to add + * @throws \Exception + */ + private function _addCustom($classType, $elements) + { + $classFunction = 'Twig_'.$classType.'_Function'; + + foreach ($elements as $name => $func) { + $twigElement = null; + + switch ($func) { + // Just a name of function + case is_string($func): + $twigElement = new $classFunction($func); + break; + // Name of function + options array + case is_array($func) && is_string($func[0]) && isset($func[1]) && is_array($func[1]): + $twigElement = new $classFunction($func[0], $func[1]); + break; + } + + if ($twigElement !== null) { + $this->twig->{'add'.$classType}($name, $twigElement); + } else { + throw new \Exception(Yii::t('yiiext', + 'Incorrect options for "{classType}" [{name}]', + array('{classType}'=>$classType, '{name}'=>$name))); + } + } } } + diff --git a/extensions/yii/twig/ViewRendererStaticClassProxy.php b/extensions/yii/twig/ViewRendererStaticClassProxy.php new file mode 100644 index 0000000..0a4a598 --- /dev/null +++ b/extensions/yii/twig/ViewRendererStaticClassProxy.php @@ -0,0 +1,44 @@ + + * @version 1.0.0 + */ +class ViewRendererStaticClassProxy +{ + private $_staticClassName; + + public function __construct($staticClassName) { + $this->_staticClassName = $staticClassName; + } + + public function __get($property) + { + $class = new \ReflectionClass($this->_staticClassName); + return $class->getStaticPropertyValue($property); + } + + public function __set($property, $value) + { + $class = new \ReflectionClass($this->_staticClassName); + $class->setStaticPropertyValue($property, $value); + return $value; + } + + public function __call($method, $arguments) + { + return call_user_func_array(array($this->_staticClassName, $method), $arguments); + } +} \ No newline at end of file