Added Twig extension that add ability to render enum value label

Author: Yann Eugoné

DependencyInjection/EnumExtension.php

@@ -21,5 +21,6 @@ public function load(array $config, ContainerBuilder $container)
         $xmlLoader->load('services.xml');
         $xmlLoader->load('form_types.xml');
         $xmlLoader->load('validators.xml');
+        $xmlLoader->load('twig.xml');
     }
 }

Resources/config/twig.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" ?>
+
+<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">
+
+    <services>
+
+        <service id="twig.extension.enum" class="EnumBundle\Twig\Extension\EnumExtension">
+            <argument type="service" id="enum.registry"/>
+
+            <tag name="twig.extension" alias="enum"/>
+        </service>
+
+    </services>
+
+</container>

Tests/Twig/Extension/EnumExtensionTest.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace EnumBundle\Tests\Twig\Extension;
+
+use EnumBundle\Registry\EnumRegistryInterface;
+use EnumBundle\Twig\Extension\EnumExtension;
+
+/**
+ * @author Yann Eugoné <[email protected]>
+ */
+class EnumExtensionTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var EnumRegistryInterface|\Prophecy\Prophecy\ObjectProphecy
+     */
+    private $registry;
+
+    protected function setUp()
+    {
+        $this->registry = $this->prophesize('EnumBundle\Registry\EnumRegistryInterface');
+    }
+
+    protected function tearDown()
+    {
+        unset(
+            $this->registry
+        );
+    }
+
+    public function testEnumLabel()
+    {
+        $enum = $this->prophesize('EnumBundle\Enum\EnumInterface');
+        $enum->getChoices()
+            ->willReturn(['foo' => 'FOO', 'bar' => 'BAR']);
+
+        $this->registry->get('test')
+            ->willReturn($enum->reveal());
+
+        $twig = $this->createEnvironment();
+
+        $this->assertSame(
+            'FOO',
+            $twig->createTemplate("{{ 'foo'|enum_label('test') }}")->render([])
+        );
+        $this->assertSame(
+            'BAR',
+            $twig->createTemplate("{{ enum_label('bar', 'test') }}")->render([])
+        );
+
+        $this->assertSame(
+            'not_exist',
+            $twig->createTemplate("{{ 'not_exist'|enum_label('test') }}")->render([])
+        );
+        $this->assertSame(
+            'not_exist',
+            $twig->createTemplate("{{ enum_label('not_exist', 'test') }}")->render([])
+        );
+    }
+
+    /**
+     * @return \Twig_Environment
+     */
+    protected function createEnvironment()
+    {
+        $loader = new \Twig_Loader_Array([]);
+        $twig = new \Twig_Environment($loader, ['debug' => true, 'cache' => false, 'autoescape' => false]);
+        $twig->addExtension($this->createExtension());
+
+        return $twig;
+    }
+
+    /**
+     * @return EnumExtension
+     */
+    private function createExtension()
+    {
+        return new EnumExtension($this->registry->reveal());
+    }
+}

Twig/Extension/EnumExtension.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace EnumBundle\Twig\Extension;
+
+use EnumBundle\Registry\EnumRegistryInterface;
+use Twig_Extension;
+
+/**
+ * @author Yann Eugoné <[email protected]>
+ */
+class EnumExtension extends Twig_Extension
+{
+    /**
+     * @var EnumRegistryInterface
+     */
+    private $registry;
+
+    /**
+     * @param EnumRegistryInterface $registry
+     */
+    public function __construct(EnumRegistryInterface $registry)
+    {
+        $this->registry = $registry;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFunctions()
+    {
+        return [
+            new \Twig_SimpleFunction('enum_label', [ $this, 'getLabel' ]),
+        ];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFilters()
+    {
+        return [
+            new \Twig_SimpleFilter('enum_label', [ $this, 'getLabel' ]),
+        ];
+    }
+
+    /**
+     * @param string $value
+     * @param string $enum
+     *
+     * @return string
+     */
+    public function getLabel($value, $enum)
+    {
+        $choices = $this->registry->get($enum)->getChoices();
+
+        if (isset($choices[$value])) {
+            return $choices[$value];
+        }
+
+        return $value;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'enum';
+    }
+}

composer.json

@@ -10,7 +10,8 @@
     ],
     "require": {
         "php": ">=5.5",
-        "symfony/framework-bundle": "~2.7"
+        "symfony/framework-bundle": "~2.7",
+        "twig/twig": "~1.20|~2.0"
     },
     "require-dev": {
         "symfony/form": "~2.7",