[Form] Fixed option support in Form component

symfony · fabpot · Apr 11, 2012 · Apr 5, 2012 · Mar 23, 2012 · Apr 5, 2012
commit b7330456b698f7dd10bd2171c7075fc34c13858e
diff --git a/CHANGELOG-2.1.md b/CHANGELOG-2.1.md
@@ -256,7 +256,6 @@ To get the diff between two versions, go to https://github.com/symfony/symfony/c
  * forms now don't create an empty object anymore if they are completely
    empty and not required. The empty value for such forms is null.
  * added constant Guess::VERY_HIGH_CONFIDENCE
- * FormType::getDefaultOptions() now sees default options defined by parent types
  * [BC BREAK] FormType::getParent() does not see default options anymore
  * [BC BREAK] The methods `add`, `remove`, `setParent`, `bind` and `setData`
    in class Form now throw an exception if the form is already bound
@@ -266,6 +265,8 @@ To get the diff between two versions, go to https://github.com/symfony/symfony/c
    "single_text" unless "with_seconds" is set to true
  * checkboxes of in an expanded multiple-choice field don't include the choice
    in their name anymore. Their names terminate with "[]" now.
+ * [BC BREAK] FormType::getDefaultOptions() and FormType::getAllowedOptionValues()
+   don't receive an options array anymore.
 
 ### HttpFoundation
 

diff --git a/UPGRADE-2.1.md b/UPGRADE-2.1.md
@@ -282,7 +282,7 @@
     ```
 
   * The options passed to the `getParent()` method of form types no longer
-    contain default options.
+    contain default options. They only contain the options passed by the user.
 
     You should check if options exist before attempting to read their value.
 
@@ -303,6 +303,42 @@
         return isset($options['widget']) && 'single_text' === $options['widget'] ? 'text' : 'choice';
     }
     ```
+
+  * The methods `getDefaultOptions()` and `getAllowedOptionValues()` of form
+    types no longer receive an option array.
+
+    You can specify options that depend on other options using closures instead.
+
+    Before:
+
+    ```
+    public function getDefaultOptions(array $options)
+    {
+        $defaultOptions = array();
+
+        if ($options['multiple']) {
+            $defaultOptions['empty_data'] = array();
+        }
+
+        return $defaultOptions;
+    }
+    ```
+
+    After:
+
+    ```
+    public function getDefaultOptions()
+    {
+        $return array(
+            'empty_data' => function (Options $options, $previousValue) {
+                return $options['multiple'] ? array() : $previousValue;
+            }
+        );
+    }
+    ```
+
+    The second argument `$previousValue` does not have to be specified if not
+    needed.
 
   * The `add()`, `remove()`, `setParent()`, `bind()` and `setData()` methods in
     the Form class now throw an exception if the form is already bound.

diff --git a/src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php b/src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php
@@ -19,6 +19,7 @@
 use Symfony\Bridge\Doctrine\Form\EventListener\MergeDoctrineCollectionListener;
 use Symfony\Bridge\Doctrine\Form\DataTransformer\CollectionToArrayTransformer;
 use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Options;
 
 abstract class DoctrineType extends AbstractType
 {
@@ -42,37 +43,43 @@ public function buildForm(FormBuilder $builder, array $options)
         }
     }
 
-    public function getDefaultOptions(array $options)
+    public function getDefaultOptions()
     {
-        $defaultOptions = array(
-            'em'                => null,
-            'class'             => null,
-            'property'          => null,
-            'query_builder'     => null,
-            'loader'            => null,
-            'group_by'          => null,
-        );
+        $registry = $this->registry;
+        $type = $this;
 
-        $options = array_replace($defaultOptions, $options);
+        $loader = function (Options $options) use ($type, $registry) {
+            if (null !== $options['query_builder']) {
+                $manager = $registry->getManager($options['em']);
 
-        if (!isset($options['choice_list'])) {
-            $manager = $this->registry->getManager($options['em']);
-
-            if (isset($options['query_builder'])) {
-                $options['loader'] = $this->getLoader($manager, $options);
+                return $type->getLoader($manager, $options['query_builder'], $options['class']);
             }
 
-            $defaultOptions['choice_list'] = new EntityChoiceList(
+            return null;
+        };
+
+        $choiceList = function (Options $options) use ($registry) {
+            $manager = $registry->getManager($options['em']);
+
+            return new EntityChoiceList(
                 $manager,
                 $options['class'],
                 $options['property'],
                 $options['loader'],
                 $options['choices'],
                 $options['group_by']
             );
-        }
+        };
 
-        return $defaultOptions;
+        return array(
+            'em'                => null,
+            'class'             => null,
+            'property'          => null,
+            'query_builder'     => null,
+            'loader'            => $loader,
+            'choice_list'       => $choiceList,
+            'group_by'          => null,
+        );
     }
 
     /**
@@ -82,7 +89,7 @@ public function getDefaultOptions(array $options)
      * @param array $options
      * @return EntityLoaderInterface
      */
-    abstract protected function getLoader(ObjectManager $manager, array $options);
+    abstract public function getLoader(ObjectManager $manager, $queryBuilder, $class);
 
     public function getParent(array $options)
     {

diff --git a/src/Symfony/Bridge/Doctrine/Form/Type/EntityType.php b/src/Symfony/Bridge/Doctrine/Form/Type/EntityType.php
@@ -23,12 +23,12 @@ class EntityType extends DoctrineType
      * @param array $options
      * @return ORMQueryBuilderLoader
      */
-    protected function getLoader(ObjectManager $manager, array $options)
+    public function getLoader(ObjectManager $manager, $queryBuilder, $class)
     {
         return new ORMQueryBuilderLoader(
-            $options['query_builder'],
+            $queryBuilder,
             $manager,
-            $options['class']
+            $class
         );
     }
 

diff --git a/src/Symfony/Bridge/Propel1/Form/Type/ModelType.php b/src/Symfony/Bridge/Propel1/Form/Type/ModelType.php
@@ -14,6 +14,7 @@
 use Symfony\Bridge\Propel1\Form\ChoiceList\ModelChoiceList;
 use Symfony\Bridge\Propel1\Form\DataTransformer\CollectionToArrayTransformer;
 use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Options;
 use Symfony\Component\Form\FormBuilder;
 
 /**
@@ -30,8 +31,18 @@ public function buildForm(FormBuilder $builder, array $options)
         }
     }
 
-    public function getDefaultOptions(array $options)
+    public function getDefaultOptions()
     {
+        $choiceList = function (Options $options) {
+            return new ModelChoiceList(
+                $options['class'],
+                $options['property'],
+                $options['choices'],
+                $options['query'],
+                $options['group_by']
+            );
+        };
+
         $defaultOptions = array(
             'template'          => 'choice',
             'multiple'          => false,
@@ -40,23 +51,10 @@ public function getDefaultOptions(array $options)
             'property'          => null,
             'query'             => null,
             'choices'           => null,
+            'choice_list'       => $choiceList,
             'group_by'          => null,
             'by_reference'      => false,
         );
-
-        $options = array_replace($defaultOptions, $options);
-
-        if (!isset($options['choice_list'])) {
-            $defaultOptions['choice_list'] = new ModelChoiceList(
-                $options['class'],
-                $options['property'],
-                $options['choices'],
-                $options['query'],
-                $options['group_by']
-            );
-        }
-
-        return $defaultOptions;
     }
 
     public function getParent(array $options)

diff --git a/...dle/SecurityBundle/Tests/Functional/Bundle/CsrfFormLoginBundle/Form/UserLoginFormType.php b/...dle/SecurityBundle/Tests/Functional/Bundle/CsrfFormLoginBundle/Form/UserLoginFormType.php
@@ -76,7 +76,7 @@ public function buildForm(FormBuilder $builder, array $options)
     /**
      * @see Symfony\Component\Form\AbstractType::getDefaultOptions()
      */
-    public function getDefaultOptions(array $options)
+    public function getDefaultOptions()
     {
         /* Note: the form's intention must correspond to that for the form login
          * listener in order for the CSRF token to validate successfully.

diff --git a/src/Symfony/Component/Form/AbstractType.php b/src/Symfony/Component/Form/AbstractType.php
@@ -96,7 +96,7 @@ public function createBuilder($name, FormFactoryInterface $factory, array $optio
      *
      * @return array The default options
      */
-    public function getDefaultOptions(array $options)
+    public function getDefaultOptions()
     {
         return array();
     }
@@ -108,7 +108,7 @@ public function getDefaultOptions(array $options)
      *
      * @return array The allowed option values
      */
-    public function getAllowedOptionValues(array $options)
+    public function getAllowedOptionValues()
     {
         return array();
     }

diff --git a/src/Symfony/Component/Form/AbstractTypeExtension.php b/src/Symfony/Component/Form/AbstractTypeExtension.php
@@ -65,7 +65,7 @@ public function buildViewBottomUp(FormView $view, FormInterface $form)
      *
      * @return array
      */
-    public function getDefaultOptions(array $options)
+    public function getDefaultOptions()
     {
         return array();
     }
@@ -77,7 +77,7 @@ public function getDefaultOptions(array $options)
      *
      * @return array The allowed option values
      */
-    public function getAllowedOptionValues(array $options)
+    public function getAllowedOptionValues()
     {
         return array();
     }