[TwigBundle] Move the code filters to a dedicated extensions

A dedicated extension now exists for the code-related filters for Twig. The dependency to service_container was also removed, to use CodeHelper, instead
symfony · May 24, 2011 · f83c137 · f83c137
1 parent 73bd9c7
commit f83c137
Show file tree

Hide file tree

Showing 3 changed files with 102 additions and 57 deletions.
diff --git a/src/Symfony/Bundle/TwigBundle/Extension/CodeExtension.php b/src/Symfony/Bundle/TwigBundle/Extension/CodeExtension.php
@@ -0,0 +1,97 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\TwigBundle\Extension;
+
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Bundle\FrameworkBundle\Templating\Helper\CodeHelper;
+
+/**
+ *
+ * @author Fabien Potencier <fabien@symfony.com>
+ * @author Alexandre Salomé <alexandre.salome@gmail.com>
+ */
+class CodeExtension extends \Twig_Extension
+{
+    private $helper;
+
+    /**
+     * Constructor of Twig Extension to provide functions for code formatting
+     *
+     * @param Symfony\Bundle\FrameworkBundle\Templating\Helper\CodeHelper $helper Helper to use
+     */
+    public function __construct(CodeHelper $helper)
+    {
+        $this->helper = $helper;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFilters()
+    {
+        return array(
+            'abbr_class'            => new \Twig_Filter_Method($this, 'abbrClass', array('is_safe' => array('html'))),
+            'abbr_method'           => new \Twig_Filter_Method($this, 'abbrMethod', array('is_safe' => array('html'))),
+            'format_args'           => new \Twig_Filter_Method($this, 'formatArgs', array('is_safe' => array('html'))),
+            'format_args_as_text'   => new \Twig_Filter_Method($this, 'formatArgsAsText'),
+            'file_excerpt'          => new \Twig_Filter_Method($this, 'fileExcerpt', array('is_safe' => array('html'))),
+            'format_file'           => new \Twig_Filter_Method($this, 'formatFile', array('is_safe' => array('html'))),
+            'format_file_from_text' => new \Twig_Filter_Method($this, 'formatFileFromText', array('is_safe' => array('html'))),
+            'file_link'             => new \Twig_Filter_Method($this, 'getFileLink', array('is_safe' => array('html'))),
+        );
+    }
+
+    public function abbrClass($class)
+    {
+        return $this->helper->abbrClass($class);
+    }
+
+    public function abbrMethod($method)
+    {
+        return $this->helper->abbrMethod($method);
+    }
+
+    public function formatArgs($args)
+    {
+        return $this->helper->formatArgs($args);
+    }
+
+    public function formatArgsAsText($args)
+    {
+        return $this->helper->formatArgsAsText($args);
+    }
+
+    public function fileExcerpt($file, $line)
+    {
+        return $this->helper->fileExcerpt($file, $line);
+    }
+
+    public function formatFile($file, $line, $text = null)
+    {
+        return $this->helper->formatFile($file, $line, $text);
+    }
+
+    public function getFileLink($file, $line)
+    {
+        return $this->helper->getFileLink($file, $line);
+    }
+
+    public function formatFileFromText($text)
+    {
+        return $this->helper->formatFileFromText($text);
+    }
+
+    public function getName()
+    {
+        return 'code';
+    }
+}
diff --git a/src/Symfony/Bundle/TwigBundle/Extension/TemplatingExtension.php b/src/Symfony/Bundle/TwigBundle/Extension/TemplatingExtension.php
@@ -26,23 +26,6 @@ public function __construct(ContainerInterface $container)
         $this->container = $container;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getFilters()
-    {
-        return array(
-            'abbr_class'            => new \Twig_Filter_Method($this, 'abbrClass', array('is_safe' => array('html'))),
-            'abbr_method'           => new \Twig_Filter_Method($this, 'abbrMethod', array('is_safe' => array('html'))),
-            'format_args'           => new \Twig_Filter_Method($this, 'formatArgs', array('is_safe' => array('html'))),
-            'format_args_as_text'   => new \Twig_Filter_Method($this, 'formatArgsAsText'),
-            'file_excerpt'          => new \Twig_Filter_Method($this, 'fileExcerpt', array('is_safe' => array('html'))),
-            'format_file'           => new \Twig_Filter_Method($this, 'formatFile', array('is_safe' => array('html'))),
-            'format_file_from_text' => new \Twig_Filter_Method($this, 'formatFileFromText', array('is_safe' => array('html'))),
-            'file_link'             => new \Twig_Filter_Method($this, 'getFileLink', array('is_safe' => array('html'))),
-        );
-    }
-
     /**
      * Returns a list of functions to add to the existing list.
      *
@@ -82,46 +65,6 @@ public function getAssetsVersion($packageName = null)
         return $this->container->get('templating.helper.assets')->getVersion($packageName);
     }
 
-    public function abbrClass($class)
-    {
-        return $this->container->get('templating.helper.code')->abbrClass($class);
-    }
-
-    public function abbrMethod($method)
-    {
-        return $this->container->get('templating.helper.code')->abbrMethod($method);
-    }
-
-    public function formatArgs($args)
-    {
-        return $this->container->get('templating.helper.code')->formatArgs($args);
-    }
-
-    public function formatArgsAsText($args)
-    {
-        return $this->container->get('templating.helper.code')->formatArgsAsText($args);
-    }
-
-    public function fileExcerpt($file, $line)
-    {
-        return $this->container->get('templating.helper.code')->fileExcerpt($file, $line);
-    }
-
-    public function formatFile($file, $line, $text = null)
-    {
-        return $this->container->get('templating.helper.code')->formatFile($file, $line, $text);
-    }
-
-    public function getFileLink($file, $line)
-    {
-        return $this->container->get('templating.helper.code')->getFileLink($file, $line);
-    }
-
-    public function formatFileFromText($text)
-    {
-        return $this->container->get('templating.helper.code')->formatFileFromText($text);
-    }
-
     /**
      * Returns the name of the extension.
      *

diff --git a/src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml b/src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml
@@ -48,6 +48,11 @@
             <argument type="service" id="templating.helper.actions" />
         </service>
 
+        <service id="twig.extension.code" class="Symfony\Bundle\TwigBundle\Extension\CodeExtension" public="false">
+            <tag name="twig.extension" />
+            <argument type="service" id="templating.helper.code" />
+        </service>
+
         <service id="twig.extension.routing" class="Symfony\Bridge\Twig\Extension\RoutingExtension" public="false">
             <tag name="twig.extension" />
             <argument type="service" id="router" />