2010-01-04 14:26:20 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Symfony\Components\Templating;
|
|
|
|
|
|
|
|
use Symfony\Components\Templating\Loader\LoaderInterface;
|
|
|
|
use Symfony\Components\Templating\Renderer\PhpRenderer;
|
2010-01-29 08:51:39 +00:00
|
|
|
use Symfony\Components\Templating\Renderer\RendererInterface;
|
2010-03-13 13:29:56 +00:00
|
|
|
use Symfony\Components\Templating\Helper\HelperInterface;
|
2010-01-04 14:26:20 +00:00
|
|
|
|
|
|
|
/*
|
2010-04-07 01:51:29 +01:00
|
|
|
* This file is part of the Symfony package.
|
2010-01-04 14:26:20 +00:00
|
|
|
*
|
|
|
|
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
|
|
|
*
|
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Engine is the main class of the templating component.
|
|
|
|
*
|
|
|
|
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
|
|
|
|
*/
|
|
|
|
class Engine
|
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
protected $loader;
|
|
|
|
protected $renderers;
|
|
|
|
protected $current;
|
|
|
|
protected $helpers;
|
|
|
|
protected $parents;
|
|
|
|
protected $stack;
|
|
|
|
protected $charset;
|
|
|
|
protected $cache;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
*
|
|
|
|
* @param LoaderInterface $loader A loader instance
|
|
|
|
* @param array $renderers An array of renderer instances
|
|
|
|
* @param array $helpers A array of helper instances
|
|
|
|
*/
|
|
|
|
public function __construct(LoaderInterface $loader, array $renderers = array(), array $helpers = array())
|
2010-01-04 14:26:20 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->loader = $loader;
|
|
|
|
$this->renderers = $renderers;
|
|
|
|
$this->helpers = array();
|
|
|
|
$this->parents = array();
|
|
|
|
$this->stack = array();
|
|
|
|
$this->charset = 'UTF-8';
|
|
|
|
$this->cache = array();
|
|
|
|
|
|
|
|
$this->addHelpers($helpers);
|
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!isset($this->renderers['php'])) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->renderers['php'] = new PhpRenderer();
|
|
|
|
}
|
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
foreach ($this->renderers as $renderer) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$renderer->setEngine($this);
|
|
|
|
}
|
2010-01-04 14:26:20 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Renders a template.
|
|
|
|
*
|
|
|
|
* The template name is composed of segments separated by a colon (:).
|
|
|
|
* By default, this engine knows how to parse templates with one or two segments:
|
|
|
|
*
|
|
|
|
* * index: The template logical name is index and the renderer is php
|
|
|
|
* * index:twig: The template logical name is index and the renderer is twig
|
|
|
|
*
|
|
|
|
* @param string $name A template name
|
|
|
|
* @param array $parameters An array of parameters to pass to the template
|
|
|
|
*
|
|
|
|
* @return string The evaluated template as a string
|
|
|
|
*
|
|
|
|
* @throws \InvalidArgumentException if the renderer does not exist or if the template does not exist
|
|
|
|
* @throws \RuntimeException if the template cannot be rendered
|
|
|
|
*/
|
|
|
|
public function render($name, array $parameters = array())
|
2010-01-04 14:26:20 +00:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (isset($this->cache[$name])) {
|
2010-07-21 22:04:53 +01:00
|
|
|
list($tpl, $options, $template) = $this->cache[$name];
|
2010-05-07 15:09:11 +01:00
|
|
|
} else {
|
2010-07-21 22:04:53 +01:00
|
|
|
list($tpl, $options) = $this->splitTemplateName($name);
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
// load
|
2010-07-21 22:04:53 +01:00
|
|
|
$template = $this->loader->load($tpl, $options);
|
2010-05-06 12:25:53 +01:00
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if (false === $template) {
|
2010-05-06 12:25:53 +01:00
|
|
|
throw new \InvalidArgumentException(sprintf('The template "%s" does not exist (renderer: %s).', $name, $options['renderer']));
|
|
|
|
}
|
|
|
|
|
2010-07-21 22:04:53 +01:00
|
|
|
$this->cache[$name] = array($tpl, $options, $template);
|
2010-05-06 12:25:53 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
$this->current = $name;
|
|
|
|
$this->parents[$name] = null;
|
|
|
|
|
|
|
|
// renderer
|
|
|
|
$renderer = $template->getRenderer() ? $template->getRenderer() : $options['renderer'];
|
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!isset($this->renderers[$options['renderer']])) {
|
2010-05-06 12:25:53 +01:00
|
|
|
throw new \InvalidArgumentException(sprintf('The renderer "%s" is not registered.', $renderer));
|
|
|
|
}
|
|
|
|
|
|
|
|
// render
|
2010-05-07 15:09:11 +01:00
|
|
|
if (false === $content = $this->renderers[$renderer]->evaluate($template, $parameters)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
throw new \RuntimeException(sprintf('The template "%s" cannot be rendered (renderer: %s).', $name, $renderer));
|
|
|
|
}
|
|
|
|
|
|
|
|
// decorator
|
2010-05-07 15:09:11 +01:00
|
|
|
if ($this->parents[$name]) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$slots = $this->get('slots');
|
|
|
|
$this->stack[] = $slots->get('_content');
|
|
|
|
$slots->set('_content', $content);
|
|
|
|
|
|
|
|
$content = $this->render($this->parents[$name], $parameters);
|
|
|
|
|
|
|
|
$slots->set('_content', array_pop($this->stack));
|
|
|
|
}
|
|
|
|
|
|
|
|
return $content;
|
2010-01-04 14:26:20 +00:00
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Outputs a rendered template.
|
|
|
|
*
|
|
|
|
* @param string $name A template name
|
|
|
|
* @param array $parameters An array of parameters to pass to the template
|
|
|
|
*
|
|
|
|
* @see render()
|
|
|
|
*/
|
|
|
|
public function output($name, array $parameters = array())
|
2010-02-05 14:54:34 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
echo $this->render($name, $parameters);
|
2010-02-05 14:54:34 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets a helper value.
|
|
|
|
*
|
|
|
|
* @param string $name The helper name
|
|
|
|
*
|
|
|
|
* @return mixed The helper value
|
|
|
|
*
|
|
|
|
* @throws \InvalidArgumentException if the helper is not defined
|
|
|
|
*/
|
|
|
|
public function __get($name)
|
|
|
|
{
|
|
|
|
return $this->$name = $this->get($name);
|
2010-01-04 14:26:20 +00:00
|
|
|
}
|
|
|
|
|
2010-05-20 12:50:14 +01:00
|
|
|
/**
|
2010-05-25 17:16:08 +01:00
|
|
|
* Returns true if the helper is defined.
|
2010-05-20 12:50:14 +01:00
|
|
|
*
|
|
|
|
* @param string $name The helper name
|
|
|
|
*
|
|
|
|
* @return Boolean true if the helper is defined, false otherwise
|
|
|
|
*/
|
|
|
|
public function __isset($name)
|
|
|
|
{
|
|
|
|
return isset($this->helpers[$name]);
|
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* @param Helper[] $helpers An array of helper
|
|
|
|
*/
|
|
|
|
public function addHelpers(array $helpers = array())
|
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
foreach ($helpers as $alias => $helper) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->set($helper, is_int($alias) ? null : $alias);
|
|
|
|
}
|
|
|
|
}
|
2010-01-04 14:26:20 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Sets a helper.
|
|
|
|
*
|
|
|
|
* @param HelperInterface $value The helper instance
|
|
|
|
* @param string $alias An alias
|
|
|
|
*/
|
|
|
|
public function set(HelperInterface $helper, $alias = null)
|
2010-01-04 14:26:20 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->helpers[$helper->getName()] = $helper;
|
2010-05-07 15:09:11 +01:00
|
|
|
if (null !== $alias) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->helpers[$alias] = $helper;
|
|
|
|
}
|
|
|
|
|
|
|
|
$helper->setCharset($this->charset);
|
2010-01-04 14:26:20 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Returns true if the helper if defined.
|
|
|
|
*
|
|
|
|
* @param string $name The helper name
|
|
|
|
*
|
|
|
|
* @return Boolean true if the helper is defined, false otherwise
|
|
|
|
*/
|
|
|
|
public function has($name)
|
2010-01-04 14:26:20 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return isset($this->helpers[$name]);
|
2010-01-04 14:26:20 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets a helper value.
|
|
|
|
*
|
|
|
|
* @param string $name The helper name
|
|
|
|
*
|
|
|
|
* @return HelperInterface The helper instance
|
|
|
|
*
|
|
|
|
* @throws \InvalidArgumentException if the helper is not defined
|
|
|
|
*/
|
|
|
|
public function get($name)
|
2010-01-04 14:26:20 +00:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!isset($this->helpers[$name])) {
|
2010-05-06 12:25:53 +01:00
|
|
|
throw new \InvalidArgumentException(sprintf('The helper "%s" is not defined.', $name));
|
|
|
|
}
|
2010-01-04 14:26:20 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->helpers[$name];
|
|
|
|
}
|
2010-01-04 14:26:20 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Decorates the current template with another one.
|
|
|
|
*
|
|
|
|
* @param string $template The decorator logical name
|
|
|
|
*/
|
|
|
|
public function extend($template)
|
|
|
|
{
|
|
|
|
$this->parents[$this->current] = $template;
|
2010-01-04 14:26:20 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Escapes a string by using the current charset.
|
|
|
|
*
|
|
|
|
* @param string $value A string to escape
|
|
|
|
*
|
|
|
|
* @return string The escaped string or the original value if not a string
|
|
|
|
*/
|
|
|
|
public function escape($value)
|
2010-01-04 14:26:20 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return is_string($value) || (is_object($value) && method_exists($value, '__toString')) ? htmlspecialchars($value, ENT_QUOTES, $this->charset) : $value;
|
2010-01-04 14:26:20 +00:00
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the charset to use.
|
|
|
|
*
|
|
|
|
* @param string $charset The charset
|
|
|
|
*/
|
|
|
|
public function setCharset($charset)
|
2010-01-04 14:26:20 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->charset = $charset;
|
2010-01-04 14:26:20 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets the current charset.
|
|
|
|
*
|
|
|
|
* @return string The current charset
|
|
|
|
*/
|
|
|
|
public function getCharset()
|
2010-02-05 14:54:34 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->charset;
|
2010-02-05 14:54:34 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets the loader associated with this engine.
|
|
|
|
*
|
|
|
|
* @return LoaderInterface A LoaderInterface instance
|
|
|
|
*/
|
|
|
|
public function getLoader()
|
2010-01-28 06:56:34 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->loader;
|
2010-01-28 06:56:34 +00:00
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets a template renderer.
|
|
|
|
*
|
|
|
|
* @param string $name The renderer name
|
|
|
|
* @param RendererInterface $renderer A RendererInterface instance
|
|
|
|
*/
|
|
|
|
public function setRenderer($name, RendererInterface $renderer)
|
2010-01-28 06:56:34 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->renderers[$name] = $renderer;
|
|
|
|
$renderer->setEngine($this);
|
2010-01-28 06:56:34 +00:00
|
|
|
}
|
|
|
|
|
2010-05-20 16:23:33 +01:00
|
|
|
public function splitTemplateName($name)
|
2010-05-06 12:25:53 +01:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (false !== $pos = strpos($name, ':')) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$renderer = substr($name, $pos + 1);
|
|
|
|
$name = substr($name, 0, $pos);
|
2010-05-07 15:09:11 +01:00
|
|
|
} else {
|
2010-05-06 12:25:53 +01:00
|
|
|
$renderer = 'php';
|
|
|
|
}
|
|
|
|
|
|
|
|
return array($name, array('renderer' => $renderer));
|
|
|
|
}
|
2010-01-04 14:26:20 +00:00
|
|
|
}
|