[WIP] Add Twig functions for cmf_document_path and cmf_document_url

DependencyInjection/CmfRoutingExtension.php

@@ -34,6 +34,7 @@ public function load(array $configs, ContainerBuilder $container)
     {
         $config = $this->processConfiguration(new Configuration(), $configs);
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader->load('services.xml');
 
         if ($config['dynamic']['enabled']) {
             // load this even if no explicit enabled value but some configuration

Resources/config/services.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <parameters>
+        <parameter key="cmf_routing.twig_extension.class">Symfony\Cmf\Bundle\CoreBundle\Twig\Extension</parameter>
+        <parameter key="cmf_routing.twig_extension.route_not_found_log_level">400</parameter>
+    </parameters>
+
+    <services>
+        <service id="cmf_routing.twig_extension" class="%cmf_routing.twig_extension.class%">
+            <argument type="service" id="router" />
+            <argument type="service" id="logger" on-invalid="ignore" />
+            <argument>%cmf_routing.twig_extension.route_not_found_log_level%</argument>
+            <tag name="twig.extension" />
+        </service>
+    </services>
+</container>
+

Tests/Unit/Twig/Extension/RoutingExtensionTest.php

@@ -0,0 +1,55 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2014 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Tests\Twig\Extension;
+
+use Symfony\Cmf\Component\Routing\Test\CmfUnitTestCase;
+use Symfony\Component\Routing\Exception\RouteNotFoundException;
+use Symfony\Cmf\Bundle\RoutingBundle\Twig\Extension\RoutingExtension;
+
+class RoutingExtensionTest extends CmfUnitTestCase
+{
+    protected $generator;
+
+    public function setUp()
+    {
+        $this->notFoundGenerator = $this->buildMock('Symfony\\Component\\Routing\\Generator\\UrlGeneratorInterface');
+        $this->notFoundGenerator->expects($this->any())
+            ->method('generate')
+            ->will($this->throwException(new RouteNotFoundException));
+    }
+
+    public function testCmfDocumentPathLogsRouteNotFoundException()
+    {
+        $logger = $this->buildMock('Psr\Log\LoggerInterface');
+
+        $logger->expects($this->once())
+            ->method('log');
+
+        $extension = new RoutingExtension($this->notFoundGenerator, $logger);
+
+        $extension->getDocumentPath('/test/bad/path');
+    }
+
+    public function testCmfDocumentUrlLogsRouteNotFoundException()
+    {
+        $logger = $this->buildMock('Psr\Log\LoggerInterface');
+
+        $logger->expects($this->once())
+            ->method('log');
+
+        $extension = new RoutingExtension($this->notFoundGenerator, $logger);
+
+        $extension->getDocumentUrl('/test/bad/path');
+    }
+
+}

Twig/Extension/RoutingExtension.php

@@ -0,0 +1,105 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2014 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Twig\Extension;
+
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Routing\Exception\RouteNotFoundException;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+
+class RoutingExtension extends \Twig_Extension
+{
+    /**
+     * @var UrlGeneratorInterface
+     */
+    protected $generator;
+
+    /**
+     * @var LoggerInterface
+     */
+    protected $logger;
+
+    /**
+     * @var mixed
+     */
+    protected $routeNotFoundLogLevel;
+
+    /**
+     * @param UrlGeneratorInterface $generator 
+     */
+    public function __construct(UrlGeneratorInterface $generator, LoggerInterface $logger = null, $routeNotFoundLogLevel = 300)
+    {
+        $this->generator = $generator;
+        $this->logger = $logger;
+        $this->routeNotFoundLogLevel = $routeNotFoundLogLevel;
+    }
+
+    /**
+     * {@inheritdoc}
+     * TODO: Should Symfony\Bridge\Twig\Extension\RoutingExtension::isUrlGenerationSafe should be used/duplicated?
+     */
+    public function getFunctions()
+    {
+        $functions = array(
+            new \Twig_SimpleFunction('cmf_document_path', array($this, 'getDocumentPath')),
+            new \Twig_SimpleFunction('cmf_document_url', array($this, 'getDocumentUrl')),
+        );
+
+        return $functions;
+    }
+
+    public function getDocumentPath($id, array $parameters = array(), $relative = false)
+    {
+        try {
+            return $this->generator->generate($id, $parameters, $relative ? UrlGeneratorInterface::RELATIVE_PATH : UrlGeneratorInterface::ABSOLUTE_PATH);
+        } catch (RouteNotFoundException $e) {
+            $this->handleRouteNotFound($id, $parameters, $e);
+        }
+    }
+
+    public function getDocumentUrl($id, array $parameters = array(), $schemeRelative = false)
+    {
+        try {
+            return $this->generator->generate($id, $parameters, $schemeRelative ? UrlGeneratorInterface::NETWORK_PATH : UrlGeneratorInterface::ABSOLUTE_URL);
+        } catch (RouteNotFoundException $e) {
+            $this->handleRouteNotFound($id, $parameters, $e);
+        }
+    }
+
+    /**
+     * Handle a RouteNotFound exception
+     * 
+     * @param string $id The document id (/cms/routes/route1)
+     * @param array $parameters Route parameters
+     */
+    protected function handleRouteNotFound($id, array $parameters, RouteNotFoundException $exception)
+    {
+        if (!$this->logger) {
+            return false;
+        }
+
+        $this->logger->log(
+            $this->routeNotFoundLogLevel,
+            'Route Not Found: '.$id,
+            array(
+                'id' => $id,
+                'parameters' => $parameters,
+                'exception' => $exception->getMessage()
+            )
+        );
+    }
+
+    public function getName()
+    {
+        return 'cmf_routing';
+    }
+}