symfony/src/Symfony/Bundle/FrameworkBundle/Templating/TemplateNameParser.php

<?php

/*
 * 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.
 */

namespace Symfony\Bundle\FrameworkBundle\Templating;

use Symfony\Component\Templating\TemplateNameParser as BaseTemplateNameParser;
use Symfony\Component\HttpKernel\Kernel;

/**
 * TemplateNameParser parsers template name from the short notation
 * "bundle:section:template.renderer.format" to a template name
 * and an array of options.
 *
 * @author Fabien Potencier <fabien.potencier@symfony-project.com>
 */
class TemplateNameParser extends BaseTemplateNameParser
{
    protected $kernel;

    /**
     * Constructor.
     *
     * @param Kernel $kernel A Kernel instance
     */
    public function __construct(Kernel $kernel)
    {
        $this->kernel = $kernel;
    }

    /**
     * Parses a template to a template name and an array of options.
     *
     * @param string $name     A template name
     * @param array  $defaults An array of default options
     *
     * @return array An array composed of the template name and an array of options
     */
    public function parse($name, array $defaults = array())
    {
        $parts = explode(':', $name);
        if (3 !== count($parts)) {
            throw new \InvalidArgumentException(sprintf('Template name "%s" is not valid (format is "bundle:section:template.renderer.format").', $name));
        }

        $bundle = null;
        if ($parts[0]) {
            foreach ($this->kernel->getBundles() as $b) {
                if ($parts[0] !== $b->getName()) {
                    continue;
                }

                foreach (array_keys($this->kernel->getBundleDirs()) as $prefix) {
                    if (0 === $pos = strpos($b->getNamespace(), $prefix)) {
                        $bundle = str_replace($prefix.'\\', '', $b->getNamespace());

                        break 2;
                    }
                }
            }

            if (null === $bundle) {
                throw new \InvalidArgumentException(sprintf('Unable to find a valid bundle name for template "%s".', $name));
            }
        }

        $options = array_replace(
            array(
                'format' => '',
            ),
            $defaults,
            array(
                // bundle is used as part of the template path, so we need /
                'bundle'     => str_replace('\\', '/', $bundle),
                'controller' => $parts[1],
            )
        );

        $elements = explode('.', $parts[2]);
        if (3 !== count($elements)) {
            throw new \InvalidArgumentException(sprintf('Template name "%s" is not valid (format is "bundle:section:template.renderer.format").', $name));
        }

        $parts[2] = $elements[0];
        $options['renderer'] = $elements[1];
        $options['format'] = $elements[2];

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