Add support for sorting fields (weighted sort)

yceruto · yceruto · commit 025aba9981ec · 2021-04-03T00:29:25.000-04:00
diff --git a/src/Symfony/Component/Form/CHANGELOG.md b/src/Symfony/Component/Form/CHANGELOG.md
@@ -15,6 +15,7 @@ CHANGELOG
  * Added a `choice_translation_parameters` option to `ChoiceType`
  * Add `UuidType` and `UlidType`
  * Dependency on `symfony/intl` was removed. Install `symfony/intl` if you are using `LocaleType`, `CountryType`, `CurrencyType`, `LanguageType` or `TimezoneType`.
+ * Add `weight` option and sorting form fields.
 
 5.2.0
 -----
diff --git a/src/Symfony/Component/Form/Extension/Core/Type/BaseType.php b/src/Symfony/Component/Form/Extension/Core/Type/BaseType.php
@@ -107,6 +107,7 @@ public function buildView(FormView $view, FormInterface $form, array $options)
             'translation_domain' => $translationDomain,
             'label_translation_parameters' => $labelTranslationParameters,
             'attr_translation_parameters' => $attrTranslationParameters,
+            'weight' => $options['weight'],
             // Using the block name here speeds up performance in collection
             // forms, where each entry has the same full block name.
             // Including the type is important too, because if rows of a
@@ -135,11 +136,13 @@ public function configureOptions(OptionsResolver $resolver)
             'attr' => [],
             'translation_domain' => null,
             'auto_initialize' => true,
+            'weight' => 0,
         ]);
 
         $resolver->setAllowedTypes('block_prefix', ['null', 'string']);
         $resolver->setAllowedTypes('attr', 'array');
         $resolver->setAllowedTypes('row_attr', 'array');
         $resolver->setAllowedTypes('label_html', 'bool');
+        $resolver->setAllowedTypes('weight', 'int');
     }
 }
diff --git a/src/Symfony/Component/Form/Form.php b/src/Symfony/Component/Form/Form.php
@@ -1044,11 +1044,29 @@ public function createView(FormView $parent = null)
             $view->children[$name] = $child->createView($view);
         }
 
+        $this->sort($view->children);
+
         $type->finishView($view, $this, $options);
 
         return $view;
     }
 
+    /**
+     * Sorts view's children based on their weight value.
+     */
+    private function sort(array &$children): void
+    {
+        $c = [];
+        $n = 0;
+        foreach ($children as $name => $child) {
+            $c[$name] = ['w' => $child->vars['weight'], 'n' => $n++];
+        }
+
+        uksort($children, static function ($a, $b) use ($c): int {
+            return $c[$a]['w'] === $c[$b]['w'] ? $c[$a]['n'] <=> $c[$b]['n'] : $c[$a]['w'] <=> $c[$b]['w'];
+        });
+    }
+
     /**
      * Normalizes the underlying data if a model transformer is set.
      *
diff --git a/src/Symfony/Component/Form/Tests/CompoundFormTest.php b/src/Symfony/Component/Form/Tests/CompoundFormTest.php
@@ -958,10 +958,12 @@ public function testCreateViewWithChildren()
             ->getForm();
         $view = new FormView();
         $field1View = new FormView();
+        $field1View->vars['weight'] = 0;
         $type1
             ->method('createView')
             ->willReturn($field1View);
         $field2View = new FormView();
+        $field2View->vars['weight'] = 0;
         $type2
             ->method('createView')
             ->willReturn($field2View);
diff --git a/src/Symfony/Component/Form/Tests/Extension/Core/Type/FormTypeTest.php b/src/Symfony/Component/Form/Tests/Extension/Core/Type/FormTypeTest.php
@@ -836,6 +836,29 @@ public function testFormAttrAsStringWithNoId()
         $this->assertSame($view->vars['id'], $view['child1']->vars['attr']['form']);
         $this->assertSame($view->vars['id'], $view['child2']->vars['attr']['form']);
     }
+
+    public function testSortingViewChildrenBasedOnWeightOption()
+    {
+        $view = $this->factory->createNamedBuilder('parent', self::TESTED_TYPE)
+            ->add('child1', null, ['weight' => 1])
+            ->add('child2')
+            ->add('child3', null, ['weight' => 1])
+            ->add('child4')
+            ->add('child5', null, ['weight' => -1])
+            ->add('child6')
+            ->getForm()
+            ->createView();
+
+        $expected = [
+            'child5',
+            'child2',
+            'child4',
+            'child6',
+            'child1',
+            'child3',
+        ];
+        $this->assertSame($expected, array_keys($view->children));
+    }
 }
 
 class Money
diff --git a/src/Symfony/Component/Form/Tests/Fixtures/Descriptor/resolved_form_type_1.json b/src/Symfony/Component/Form/Tests/Fixtures/Descriptor/resolved_form_type_1.json
@@ -62,7 +62,8 @@
                 "row_attr",
                 "setter",
                 "translation_domain",
-                "upload_max_size_message"
+                "upload_max_size_message",
+                "weight"
             ]
         },
         "extension": {
diff --git a/src/Symfony/Component/Form/Tests/Fixtures/Descriptor/resolved_form_type_1.txt b/src/Symfony/Component/Form/Tests/Fixtures/Descriptor/resolved_form_type_1.txt
@@ -40,6 +40,7 @@ Symfony\Component\Form\Extension\Core\Type\ChoiceType (Block prefix: "choice")
                                                        setter                                                
                                                        translation_domain                                    
                                                        upload_max_size_message                               
+                                                       weight                                                
  ------------------------------- -------------------- ------------------------------ ----------------------- 
 
 Parent types
diff --git a/src/Symfony/Component/Form/Tests/Fixtures/Descriptor/resolved_form_type_2.json b/src/Symfony/Component/Form/Tests/Fixtures/Descriptor/resolved_form_type_2.json
@@ -41,7 +41,8 @@
             "setter",
             "translation_domain",
             "trim",
-            "upload_max_size_message"
+            "upload_max_size_message",
+            "weight"
         ],
         "overridden": [],
         "parent": [],
diff --git a/src/Symfony/Component/Form/Tests/Fixtures/Descriptor/resolved_form_type_2.txt b/src/Symfony/Component/Form/Tests/Fixtures/Descriptor/resolved_form_type_2.txt
@@ -44,5 +44,6 @@ Symfony\Component\Form\Extension\Core\Type\FormType (Block prefix: "form")
   translation_domain            
   trim                          
   upload_max_size_message       
+  weight                        
  ------------------------------ 
 
