php - Using Moustache as a templating language in Symfony 2

Question

I'm starting to use symfony 2 but I'd like to use moustache as the templating language instead of Twig or PHP. I wan't to use moustache because it's totally logicless and because I can also use it in javascript if I decide to handle the rendering of the template clientside.

How to do that?

Answer 1

Some extra info extending @m2mdas answer.

If you are not yet familiar with Symfony templating systems and bundle configuration take a look at these before you start coding:

• How to expose a Semantic Configuration for a Bundle
• Creating and using Templates
• How to use PHP instead of Twig for Templates

And now a quick recipe to get you started. Take the following as loose examples, no need to stick with the names choosed.

1. Create a Resources/config/mustache.xml to define your services and to identify your template engine service (tag it as "templating.engine").

You could use Yaml and PHP instead of XML but the latter is prefered for "public" bundles.

<service id="mustache" class="Mustache">
    <file>Mustache.php</file>
</service>

<service id="templating.engine.mustache" class="MustacheBundleMustacheEngine" public="false">
        <argument type="service" id="mustache" />
        <argument type="service" id="templating.name_parser"/>
        <argument type="service" id="templating.loader" />
        <tag name="templating.engine" />
</service>

Examples:

• Twig
• PHP
• Smarty

2. Create an Extension class to handle the semantic configuration for your bundle.

<?php

namespace MustacheBundle;

use SymfonyComponentHttpKernelDependencyInjectionExtension;
use SymfonyComponentDependencyInjectionLoaderXmlFileLoader;

class MustacheExtension extends Extension
{
    $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
    $loader->load('mustache.xml');

    // you may parse the $configs array here
    // see: http://symfony.com/doc/current/cookbook/bundles/extension.html#parsing-the-configs-array
}

The presence of the previous class means that you can now define a mustache configuration namespace in any configuration file.

Examples:

• Twig
• Smarty

3. [Optional] Create a Configuration class to validate and merge configuration

<?php

namespace MustacheDependencyInjection;

use SymfonyComponentConfigDefinitionBuilderTreeBuilder;
use SymfonyComponentConfigDefinitionConfigurationInterface;

class Configuration implements ConfigurationInterface
{
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('mustache');

        // see: http://symfony.com/doc/current/cookbook/bundles/extension.html#validation-and-merging-with-a-configuration-class
    }
}

Examples:

• Twig
• Smarty

4. Create a MustacheEngine that implements EngineInterface

<?php

namespace MustacheBundle;

use SymfonyBundleFrameworkBundleTemplatingEngineInterface;
use SymfonyComponentTemplatingTemplateNameParserInterface;
use SymfonyComponentTemplatingLoaderLoaderInterface;

use SymfonyComponentHttpFoundationResponse;

class MustacheBundle implements EngineInterface
{
    public function __construct(Mustache $mustache, TemplateNameParserInterface $parser, LoaderInterface $loader)
    {
        $this->mustache = $mustache;
        $this->parser = $parser;
    }

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

        return $this->mustache->render($template);
    }

    // Renders a view and returns a Response.
    public function renderResponse($view, array $parameters = array(), Response $response = null)
    {
        if (null === $response) {
            $response = new Response();
        }

        $response->setContent($this->render($view, $parameters));

        return $response;
    }

    // Returns true if the template exists.
    public function exists($name)
    {
        try {
            $this->load($name);
        } catch (InvalidArgumentException $e) {
            return false;
        }

        return true;
    }

    // Returns true if this class is able to render the given template.
    public function supports($name)
    {
        $template = $this->parser->parse($name);

        return 'mustache' === $template->get('engine');
    }

    // Loads the given template.
    // Should return the template name or a Mustache template object
    protected function load($name)
    {
        $template = $this->parser->parse($name);
        $template = $this->loader->load($template);

        return (string) $template;
    }

Examples:

• Twig
• PHP
• Smarty

5. Enable your shiny new template engine in the application configuration file:

# app/config/config.yml
templating:    { engines: ['twig', 'mustache'] }

6. Try it

<?php
// src/Acme/HelloBundle/Controller/HelloController.php

public function indexAction($name)
{
    return $this->render('AcmeHelloBundle:Hello:index.html.mustache', array('name' => $name));
}

You may share a link to your bundle repository so we can track progress and help if needed. Good luck.