2015-10-30 16:15:58 +00:00
|
|
|
<?php
|
2016-02-03 22:22:56 +00:00
|
|
|
/**
|
|
|
|
* Holds the templating engine class.
|
2016-03-08 23:07:58 +00:00
|
|
|
*
|
2016-02-03 22:22:56 +00:00
|
|
|
* @package Sakura
|
|
|
|
*/
|
|
|
|
|
2015-10-30 16:15:58 +00:00
|
|
|
namespace Sakura;
|
|
|
|
|
2015-10-31 18:14:54 +00:00
|
|
|
use Twig_Environment;
|
|
|
|
use Twig_Extension_StringLoader;
|
|
|
|
use Twig_Loader_Filesystem;
|
2016-02-27 16:46:16 +00:00
|
|
|
use Twig_SimpleFunction;
|
2015-10-31 18:14:54 +00:00
|
|
|
|
2015-10-30 16:15:58 +00:00
|
|
|
/**
|
2016-02-02 21:04:15 +00:00
|
|
|
* Sakura wrapper for Twig.
|
2016-03-08 23:07:58 +00:00
|
|
|
*
|
2015-10-30 16:15:58 +00:00
|
|
|
* @package Sakura
|
2016-02-02 21:04:15 +00:00
|
|
|
* @author Julian van de Groep <me@flash.moe>
|
2015-10-30 16:15:58 +00:00
|
|
|
*/
|
|
|
|
class Template
|
|
|
|
{
|
2016-02-02 21:04:15 +00:00
|
|
|
/**
|
|
|
|
* The variables passed on to the templating engine.
|
2016-03-08 23:07:58 +00:00
|
|
|
*
|
2016-02-02 21:04:15 +00:00
|
|
|
* @var array
|
|
|
|
*/
|
2016-02-04 20:56:40 +00:00
|
|
|
private static $vars = [];
|
2016-02-02 21:04:15 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The templating engine.
|
2016-03-08 23:07:58 +00:00
|
|
|
*
|
2016-02-02 21:04:15 +00:00
|
|
|
* @var Twig_Environment
|
|
|
|
*/
|
2016-04-01 15:31:05 +00:00
|
|
|
private static $engine;
|
2016-02-02 21:04:15 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The template name.
|
2016-03-08 23:07:58 +00:00
|
|
|
*
|
2016-02-02 21:04:15 +00:00
|
|
|
* @var string
|
|
|
|
*/
|
2016-04-01 15:31:05 +00:00
|
|
|
public static $name;
|
|
|
|
|
2016-02-02 21:04:15 +00:00
|
|
|
/**
|
|
|
|
* The file extension used by template files
|
|
|
|
*/
|
2016-02-04 20:56:40 +00:00
|
|
|
const FILE_EXT = '.twig';
|
2015-10-31 18:14:54 +00:00
|
|
|
|
2016-07-30 13:48:09 +00:00
|
|
|
/**
|
|
|
|
* List of utility functions to add to templating
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
protected static $utility = [
|
|
|
|
'route',
|
|
|
|
'config',
|
|
|
|
'session_id',
|
|
|
|
'json_decode',
|
|
|
|
'byte_symbol',
|
|
|
|
];
|
|
|
|
|
2016-02-02 21:04:15 +00:00
|
|
|
/**
|
|
|
|
* Set the template name.
|
2016-03-08 23:07:58 +00:00
|
|
|
*
|
2016-02-02 21:04:15 +00:00
|
|
|
* @param string $name The name of the template directory.
|
|
|
|
*/
|
2016-02-04 20:56:40 +00:00
|
|
|
public static function set($name)
|
2015-11-01 13:26:05 +00:00
|
|
|
{
|
2015-10-31 18:14:54 +00:00
|
|
|
// Set variables
|
2016-04-01 15:31:05 +00:00
|
|
|
self::$name = $name;
|
|
|
|
|
2015-10-31 18:14:54 +00:00
|
|
|
// Reinitialise
|
2016-02-04 20:56:40 +00:00
|
|
|
self::init();
|
2015-10-31 18:14:54 +00:00
|
|
|
}
|
|
|
|
|
2016-02-02 21:04:15 +00:00
|
|
|
/**
|
|
|
|
* Initialise the templating engine.
|
|
|
|
*/
|
2016-02-04 20:56:40 +00:00
|
|
|
public static function init()
|
2015-11-01 13:26:05 +00:00
|
|
|
{
|
2016-07-30 13:48:09 +00:00
|
|
|
$views_dir = ROOT . 'resources/views/';
|
|
|
|
|
2015-10-31 18:14:54 +00:00
|
|
|
// Initialise Twig Filesystem Loader
|
2016-07-30 13:48:09 +00:00
|
|
|
$twigLoader = new Twig_Loader_Filesystem([$views_dir . self::$name, $views_dir . 'shared/']);
|
2015-10-31 18:14:54 +00:00
|
|
|
|
|
|
|
// Environment variable
|
2016-07-30 13:48:09 +00:00
|
|
|
$twigEnv = [
|
|
|
|
'cache' => config("performance.template_cache")
|
|
|
|
? realpath(ROOT . config("performance.cache_dir") . 'views')
|
|
|
|
: false,
|
|
|
|
'auto_reload' => true,
|
|
|
|
'debug' => config("dev.twig_debug"),
|
|
|
|
];
|
2015-10-31 18:14:54 +00:00
|
|
|
|
|
|
|
// And now actually initialise the templating engine
|
2016-04-01 15:31:05 +00:00
|
|
|
self::$engine = new Twig_Environment($twigLoader, $twigEnv);
|
2015-10-31 18:14:54 +00:00
|
|
|
|
|
|
|
// Load String template loader
|
2016-04-01 15:31:05 +00:00
|
|
|
self::$engine->addExtension(new Twig_Extension_StringLoader());
|
2016-02-27 16:46:16 +00:00
|
|
|
|
2016-07-30 13:48:09 +00:00
|
|
|
// Add utility functions
|
|
|
|
foreach (self::$utility as $utility) {
|
|
|
|
self::$engine->addFunction(new Twig_SimpleFunction($utility, $utility));
|
|
|
|
}
|
2015-10-31 18:14:54 +00:00
|
|
|
}
|
|
|
|
|
2016-02-02 21:04:15 +00:00
|
|
|
/**
|
|
|
|
* Merge the parse variables.
|
2016-03-08 23:07:58 +00:00
|
|
|
*
|
2016-02-02 21:04:15 +00:00
|
|
|
* @param array $vars The new variables.
|
|
|
|
*/
|
2016-02-04 20:56:40 +00:00
|
|
|
public static function vars($vars)
|
2015-11-01 13:26:05 +00:00
|
|
|
{
|
2016-02-04 20:56:40 +00:00
|
|
|
self::$vars = array_merge(self::$vars, $vars);
|
2015-10-31 18:14:54 +00:00
|
|
|
}
|
|
|
|
|
2016-02-02 21:04:15 +00:00
|
|
|
/**
|
|
|
|
* Render a template file.
|
2016-03-08 23:07:58 +00:00
|
|
|
*
|
2016-02-02 21:04:15 +00:00
|
|
|
* @param string $file The filename/path
|
2016-03-08 23:07:58 +00:00
|
|
|
*
|
2016-02-02 21:04:15 +00:00
|
|
|
* @return bool|string An error or the HTML.
|
|
|
|
*/
|
2016-02-04 20:56:40 +00:00
|
|
|
public static function render($file)
|
2015-10-31 18:14:54 +00:00
|
|
|
{
|
2016-07-29 19:31:36 +00:00
|
|
|
return self::$engine->render($file . self::FILE_EXT, self::$vars);
|
2015-10-31 18:14:54 +00:00
|
|
|
}
|
2015-10-30 16:15:58 +00:00
|
|
|
}
|