Add support for displaying enums

docs/reference/field_types.rst

@@ -16,6 +16,7 @@ Fieldtype                                           Description
 ``FieldDescriptionInterface::TYPE_DATETIME``        display a formatted date and time. Accepts the options ``format`` and ``timezone``
 ``FieldDescriptionInterface::TYPE_STRING``          display a text
 ``FieldDescriptionInterface::TYPE_EMAIL``           display a mailto link. Accepts the options ``as_string``, ``subject`` and ``body``
+``FieldDescriptionInterface::TYPE_ENUM``            display the name of a backed enum
 ``FieldDescriptionInterface::TYPE_TEXTAREA``        display a textarea
 ``FieldDescriptionInterface::TYPE_TRANS``           translate the value with a provided ``catalogue`` (translation domain) and ``format`` (sprintf format) option
 ``FieldDescriptionInterface::TYPE_FLOAT``           display a number

src/FieldDescription/FieldDescriptionInterface.php

@@ -44,6 +44,7 @@ interface FieldDescriptionInterface
     public const TYPE_DATETIME = 'datetime';
     public const TYPE_TEXTAREA = 'textarea';
     public const TYPE_EMAIL = 'email';
+    public const TYPE_ENUM = 'enum';
     public const TYPE_TRANS = 'trans';
     public const TYPE_STRING = 'string';
     public const TYPE_INTEGER = 'integer';

src/Resources/views/CRUD/display_enum.html.twig

@@ -0,0 +1,14 @@
+{#
+
+This file is part of the Sonata package.
+
+(c) Thomas Rabaix <[email protected]>
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+
+#}
+
+{%- apply spaceless %}
+    {{ value.name }}
+{% endapply -%}

src/Resources/views/CRUD/list_enum.html.twig

@@ -0,0 +1,16 @@
+{#
+
+This file is part of the Sonata package.
+
+(c) Thomas Rabaix <[email protected]>
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+
+#}
+
+{% extends get_admin_template('base_list_field', admin.code) %}
+
+{% block field %}
+    {%- include '@SonataAdmin/CRUD/display_enum.html.twig' with { value: value } only -%}
+{% endblock %}

src/Resources/views/CRUD/show_enum.html.twig

@@ -0,0 +1,16 @@
+{#
+
+This file is part of the Sonata package.
+
+(c) Thomas Rabaix <[email protected]>
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+
+#}
+
+{% extends '@SonataAdmin/CRUD/base_show_field.html.twig' %}
+
+{% block field %}
+    {%- include '@SonataAdmin/CRUD/display_enum.html.twig' with { value: value } only -%}
+{% endblock %}

src/Templating/TemplateRegistryInterface.php

@@ -30,6 +30,7 @@ interface TemplateRegistryInterface
         FieldDescriptionInterface::TYPE_TIME => '@SonataAdmin/CRUD/show_time.html.twig',
         FieldDescriptionInterface::TYPE_DATETIME => '@SonataAdmin/CRUD/show_datetime.html.twig',
         FieldDescriptionInterface::TYPE_EMAIL => '@SonataAdmin/CRUD/show_email.html.twig',
+        FieldDescriptionInterface::TYPE_ENUM => '@SonataAdmin/CRUD/show_enum.html.twig',
         FieldDescriptionInterface::TYPE_TRANS => '@SonataAdmin/CRUD/show_trans.html.twig',
         FieldDescriptionInterface::TYPE_STRING => '@SonataAdmin/CRUD/base_show_field.html.twig',
         FieldDescriptionInterface::TYPE_INTEGER => '@SonataAdmin/CRUD/base_show_field.html.twig',
@@ -56,6 +57,7 @@ interface TemplateRegistryInterface
         FieldDescriptionInterface::TYPE_DATETIME => '@SonataAdmin/CRUD/list_datetime.html.twig',
         FieldDescriptionInterface::TYPE_TEXTAREA => '@SonataAdmin/CRUD/list_string.html.twig',
         FieldDescriptionInterface::TYPE_EMAIL => '@SonataAdmin/CRUD/list_email.html.twig',
+        FieldDescriptionInterface::TYPE_ENUM => '@SonataAdmin/CRUD/list_enum.html.twig',
         FieldDescriptionInterface::TYPE_TRANS => '@SonataAdmin/CRUD/list_trans.html.twig',
         FieldDescriptionInterface::TYPE_STRING => '@SonataAdmin/CRUD/list_string.html.twig',
         FieldDescriptionInterface::TYPE_INTEGER => '@SonataAdmin/CRUD/list_string.html.twig',

tests/Fixtures/Enum/Suit.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\AdminBundle\Tests\Fixtures\Enum;
+
+enum Suit: string {
+    case Hearts = 'H';
+    case Diamonds = 'D';
+    case Clubs = 'C';
+    case Spades = 'S';
+}

tests/Twig/Extension/RenderElementExtensionTest.php

@@ -21,6 +21,7 @@
 use Sonata\AdminBundle\Templating\MutableTemplateRegistryInterface;
 use Sonata\AdminBundle\Templating\TemplateRegistryInterface;
 use Sonata\AdminBundle\Tests\Fixtures\Entity\FooToString;
+use Sonata\AdminBundle\Tests\Fixtures\Enum\Suit;
 use Sonata\AdminBundle\Tests\Fixtures\StubFilesystemLoader;
 use Sonata\AdminBundle\Twig\Extension\RenderElementExtension;
 use Sonata\AdminBundle\Twig\Extension\XEditableExtension;
@@ -516,7 +517,7 @@ public function testRenderRelationElementWithClosure(): void
      */
     public function getRenderListElementTests(): array
     {
-        return [
+        $elements = [
             [
                 '<td class="sonata-ba-list-field sonata-ba-list-field-string" objectId="12345"> Example </td>',
                 FieldDescriptionInterface::TYPE_STRING,
@@ -1496,14 +1497,26 @@ class="x-editable"
                 ],
             ],
         ];
+
+        // TODO: Remove the "if" check when dropping support of PHP < 8.1 and add the case to the list
+        if (\PHP_VERSION_ID >= 80100) {
+            $elements[] = [
+                '<td class="sonata-ba-list-field sonata-ba-list-field-enum" objectId="12345"> Hearts </td>',
+                FieldDescriptionInterface::TYPE_ENUM,
+                Suit::Hearts,
+                [],
+            ];
+        }
+
+        return $elements;
     }
 
     /**
      * @phpstan-return array<array{string, string, mixed, array<string, mixed>}>
      */
     public function getRenderViewElementTests(): array
     {
-        return [
+        $elements = [
             ['<th>Data</th> <td>Example</td>', FieldDescriptionInterface::TYPE_STRING, 'Example', ['safe' => false]],
             ['<th>Data</th> <td>Example</td>', FieldDescriptionInterface::TYPE_STRING, 'Example', ['safe' => false]],
             ['<th>Data</th> <td>Example</td>', FieldDescriptionInterface::TYPE_TEXTAREA, 'Example', ['safe' => false]],
@@ -2000,6 +2013,18 @@ class="sonata-readmore"
                 ],
             ],
         ];
+
+        // TODO: Remove the "if" check when dropping support of PHP < 8.1 and add the case to the list
+        if (\PHP_VERSION_ID >= 80100) {
+            $elements[] = [
+                '<th>Data</th> <td>Hearts</td>',
+                FieldDescriptionInterface::TYPE_ENUM,
+                Suit::Hearts,
+                [],
+            ];
+        }
+
+        return $elements;
     }
 
     /**