From 32e93ba84dfcd3c5537855c1c567ac8638b8f200 Mon Sep 17 00:00:00 2001
From: Alexandre Daubois <alex.daubois@gmail.com>
Date: Tue, 10 Jan 2023 20:31:50 +0100
Subject: [PATCH] [Form] Add `group_by` option for EnumType

---
 reference/forms/types/enum.rst | 53 ++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)

diff --git a/reference/forms/types/enum.rst b/reference/forms/types/enum.rst
index 63bca396c4b..c8bd18d2c04 100644
--- a/reference/forms/types/enum.rst
+++ b/reference/forms/types/enum.rst
@@ -92,6 +92,59 @@ These options inherit from the :doc:`ChoiceType </reference/forms/types/choice>`
 
 .. include:: /reference/forms/types/options/expanded.rst.inc
 
+``group_by``
+~~~~~~~~~~~~
+
+**type**: ``string`` or ``callable`` or :class:`Symfony\\Component\\PropertyAccess\\PropertyPath` **default**: ``null``
+
+You can group the ``<option>`` elements of a ``<select>`` into ``<optgroup>``
+by passing a multi-dimensional array to ``choices``. See the
+:ref:`Grouping Options <form-choices-simple-grouping>` section about that.
+
+The ``group_by`` option is an alternative way to group choices, which gives you
+a bit more flexibility.
+
+Let's add a few cases to our ``TextAlign`` enumeration::
+
+    // src/Config/TextAlign.php
+    namespace App\Config;
+
+    enum TextAlign: string
+    {
+        case UpperLeft = 'Upper Left aligned';
+        case LowerLeft = 'Lower Left aligned';
+
+        case Center = 'Center aligned';
+
+        case UpperRight = 'Upper Right aligned';
+        case LowerRight = 'Lower Right aligned';
+    }
+
+We can now group choices by the enum case value::
+
+    use App\Config\TextAlign;
+    use Symfony\Component\Form\Extension\Core\Type\EnumType;
+    // ...
+
+    $builder->add('alignment', EnumType::class, [
+        'class' => TextAlign::class,
+        'group_by' => function(TextAlign $choice, int $key, string $value): ?string {
+            if (str_starts_with($value, 'Upper')) {
+                return 'Upper';
+            }
+
+            if (str_starts_with($value, 'Lower')) {
+                return 'Lower';
+            }
+
+            return 'Other';
+        }
+    ]);
+
+This callback will group choices in 3 categories: ``Upper``, ``Lower`` and ``Other``.
+
+If you return ``null``, the option won't be grouped.
+
 .. include:: /reference/forms/types/options/multiple.rst.inc
 
 .. include:: /reference/forms/types/options/placeholder.rst.inc