symfony/src/Symfony/Bundle/FoundationBundle/Templating/Engine.php

<?php

namespace Symfony\Bundle\FoundationBundle\Templating;

use Symfony\Components\Templating\Engine as BaseEngine;
use Symfony\Components\Templating\Loader\LoaderInterface;
use Symfony\Components\OutputEscaper\Escaper;
use Symfony\Components\DependencyInjection\ContainerInterface;

/*
 * This file is part of the Symfony package.
 *
 * (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.
 */

/**
 * This engine knows how to render Symfony templates and automatically
 * escapes template parameters.
 *
 * @package    Symfony
 * @subpackage Framework_FoundationBundle
 * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
 */
class Engine extends BaseEngine
{
    protected $container;
    protected $escaper;
    protected $level;

    /**
     * Constructor.
     *
     * @param ContainerInterface $container A ContainerInterface instance
     * @param LoaderInterface    $loader    A loader instance
     * @param array              $renderers An array of renderer instances
     * @param mixed              $escaper   The escaper to use (or false to disable escaping)
     */
    public function __construct(ContainerInterface $container, LoaderInterface $loader, array $renderers = array(), $escaper)
    {
        $this->level = 0;
        $this->container = $container;
        $this->escaper = $escaper;

        foreach ($this->container->findAnnotatedServiceIds('templating.renderer') as $id => $attributes) {
            if (isset($attributes[0]['alias'])) {
                $renderers[$attributes[0]['alias']] = $this->container->get($id);
            }
        }

        parent::__construct($loader, $renderers);

        $this->helpers = array();
        foreach ($this->container->findAnnotatedServiceIds('templating.helper') as $id => $attributes) {
            if (isset($attributes[0]['alias'])) {
                $this->helpers[$attributes[0]['alias']] = $id;
            }
        }
    }

    public function render($name, array $parameters = array())
    {
        ++$this->level;

        list(, $options) = $this->splitTemplateName($name);
        if ('php' === $options['renderer'])
        {
            // escape only once
            if (1 === $this->level && !isset($parameters['_data'])) {
                $parameters = $this->escapeParameters($parameters);
            }
        }

        $content = parent::render($name, $parameters);

        --$this->level;

        return $content;
    }

    public function has($name)
    {
        return isset($this->helpers[$name]);
    }

    /**
     * @throws \InvalidArgumentException When the helper is not defined
     */
    public function get($name)
    {
        if (!isset($this->helpers[$name])) {
            throw new \InvalidArgumentException(sprintf('The helper "%s" is not defined.', $name));
        }

        if (is_string($this->helpers[$name])) {
            $this->helpers[$name] = $this->container->get('templating.helper.'.$name);
            $this->helpers[$name]->setCharset($this->charset);
        }

        return $this->helpers[$name];
    }

    protected function escapeParameters(array $parameters)
    {
        if (false !== $this->escaper) {
            Escaper::setCharset($this->getCharset());

            $parameters['_data'] = Escaper::escape($this->escaper, $parameters);
            foreach ($parameters['_data'] as $key => $value) {
                $parameters[$key] = $value;
            }
        } else {
            $parameters['_data'] = Escaper::escape('raw', $parameters);
        }

        return $parameters;
    }

    // Bundle:controller:action(:renderer)
    public function splitTemplateName($name, array $defaults = array())
    {
        $parts = explode(':', $name, 4);

        if (sizeof($parts) < 3) {
            throw new \InvalidArgumentException(sprintf('Template name "%s" is not valid.', $name));
        }

        $options = array_replace(
            array(
                'renderer' => 'php',
                'format'   => '',
            ),
            $defaults,
            array(
                'bundle'     => str_replace('\\', '/', $parts[0]),
                'controller' => $parts[1],
            )
        );

        if (isset($parts[3]) && $parts[3]) {
            $options['renderer'] = $parts[3];
        }

        $format = $this->container->getRequestService()->getRequestFormat();
        if (null !== $format && 'html' !== $format) {
            $options['format'] = '.'.$format;
        }

        return array($parts[2], $options);
    }
}