[Form] Cached the form type hierarchy in order to improve performance

symfony · fabpot · Jul 13, 2012 · Jul 12, 2012 · Jul 13, 2012 · Jul 13, 2012
commit cd7835d8d2f68de96d3d4d33e9b744c86d519a8f
diff --git a/UPGRADE-2.1.md b/UPGRADE-2.1.md
@@ -249,6 +249,16 @@
     public function finishView(FormViewInterface $view, FormInterface $form, array $options)
     ```
 
+  * The method `createBuilder` was removed from `FormTypeInterface` for performance
+    reasons. It is now not possible anymore to use custom implementations of
+    `FormBuilderInterface` for specific form types.
+
+    If you are in such a situation, you can subclass `FormRegistry` instead and override
+    `resolveType` to return a custom `ResolvedFormTypeInterface` implementation, within
+    which you can create your own `FormBuilderInterface` implementation. You should
+    register this custom registry class under the service name "form.registry" in order
+    to replace the default implementation.
+
   * If you previously inherited from `FieldType`, you should now inherit from
     `FormType`. You should also set the option `compound` to `false` if your field
     is not supposed to contain child fields.
@@ -1001,6 +1011,24 @@
     ));
     ```
 
+  * The methods `addType`, `hasType` and `getType` in `FormFactory` are deprecated
+    and will be removed in Symfony 2.3. You should use the methods with the same
+    name on the `FormRegistry` instead.
+
+    Before:
+
+    ```
+    $this->get('form.factory')->addType(new MyFormType());
+    ```
+
+    After:
+
+    ```
+    $registry = $this->get('form.registry');
+
+    $registry->addType($registry->resolveType(new MyFormType()));
+    ```
+
 ### Validator
 
   * The methods `setMessage()`, `getMessageTemplate()` and

diff --git a/src/Symfony/Bridge/Doctrine/CHANGELOG.md b/src/Symfony/Bridge/Doctrine/CHANGELOG.md
@@ -7,3 +7,4 @@ CHANGELOG
  * added a default implementation of the ManagerRegistry
  * added a session storage for Doctrine DBAL
  * DoctrineOrmTypeGuesser now guesses "collection" for array Doctrine type
+ * DoctrineType now caches its choice lists in order to improve performance
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/form.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/form.xml
@@ -6,13 +6,14 @@
 
     <parameters>
         <parameter key="form.extension.class">Symfony\Component\Form\Extension\DependencyInjection\DependencyInjectionExtension</parameter>
+        <parameter key="form.registry.class">Symfony\Component\Form\FormRegistry</parameter>
         <parameter key="form.factory.class">Symfony\Component\Form\FormFactory</parameter>
         <parameter key="form.type_guesser.validator.class">Symfony\Component\Form\Extension\Validator\ValidatorTypeGuesser</parameter>
     </parameters>
 
     <services>
-        <!-- FormFactory -->
-        <service id="form.factory" class="%form.factory.class%">
+        <!-- FormRegistry -->
+        <service id="form.registry" class="%form.registry.class%">
             <argument type="collection">
                 <!--
                 We don't need to be able to add more extensions.
@@ -23,6 +24,11 @@
             </argument>
         </service>
 
+        <!-- FormFactory -->
+        <service id="form.factory" class="%form.factory.class%">
+            <argument type="service" id="form.registry" />
+        </service>
+
         <!-- DependencyInjectionExtension -->
         <service id="form.extension" class="%form.extension.class%" public="false">
             <argument type="service" id="service_container" />

diff --git a/src/Symfony/Component/Form/AbstractType.php b/src/Symfony/Component/Form/AbstractType.php
@@ -20,8 +20,9 @@
 abstract class AbstractType implements FormTypeInterface
 {
     /**
-     * The extensions for this type
-     * @var array An array of FormTypeExtensionInterface instances
+     * @var array
+     *
+     * @deprecated Deprecated since version 2.1, to be removed in 2.3.
      */
     private $extensions = array();
 
@@ -46,14 +47,6 @@ public function finishView(FormViewInterface $view, FormInterface $form, array $
     {
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function createBuilder($name, FormFactoryInterface $factory, array $options)
-    {
-        return null;
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -98,21 +91,26 @@ public function getParent()
     }
 
     /**
-     * {@inheritdoc}
+     * Sets the extensions for this type.
+     *
+     * @param array $extensions An array of FormTypeExtensionInterface
+     *
+     * @throws Exception\UnexpectedTypeException if any extension does not implement FormTypeExtensionInterface
+     *
+     * @deprecated Deprecated since version 2.1, to be removed in 2.3.
      */
     public function setExtensions(array $extensions)
     {
-        foreach ($extensions as $extension) {
-            if (!$extension instanceof FormTypeExtensionInterface) {
-                throw new UnexpectedTypeException($extension, 'Symfony\Component\Form\FormTypeExtensionInterface');
-            }
-        }
-
         $this->extensions = $extensions;
     }
 
     /**
-     * {@inheritdoc}
+     * Returns the extensions associated with this type.
+     *
+     * @return array An array of FormTypeExtensionInterface
+     *
+     * @deprecated Deprecated since version 2.1, to be removed in 2.3. Use
+     *             {@link ResolvedFormTypeInterface::getTypeExtensions()} instead.
      */
     public function getExtensions()
     {

diff --git a/src/Symfony/Component/Form/CHANGELOG.md b/src/Symfony/Component/Form/CHANGELOG.md
@@ -86,6 +86,7 @@ CHANGELOG
    * `hasAttribute`
    * `getClientData`
  * added FormBuilder methods
+   * `getTypes`
    * `addViewTransformer`
    * `getViewTransformers`
    * `resetViewTransformers`
@@ -157,3 +158,15 @@ CHANGELOG
  * deprecated the options "data_timezone" and "user_timezone" in DateType, DateTimeType and TimeType
    and renamed them to "model_timezone" and "view_timezone"
  * fixed: TransformationFailedExceptions thrown in the model transformer are now caught by the form
+ * added FormRegistry and ResolvedFormTypeInterface
+ * deprecated FormFactory methods
+   * `addType`
+   * `hasType`
+   * `getType`
+ * [BC BREAK] FormFactory now expects a FormRegistryInterface as constructor argument
+ * [BC BREAK] The method `createBuilder` in FormTypeInterface is not supported anymore for performance reasons
+ * [BC BREAK] Removed `setTypes` from FormBuilder
+ * deprecated AbstractType methods
+   * `getExtensions`
+   * `setExtensions`
+ * ChoiceType now caches its created choice lists to improve performance
diff --git a/src/Symfony/Component/Form/Extension/Core/Type/FormType.php b/src/Symfony/Component/Form/Extension/Core/Type/FormType.php
@@ -20,7 +20,6 @@
 use Symfony\Component\Form\Extension\Core\EventListener\BindRequestListener;
 use Symfony\Component\Form\Extension\Core\EventListener\TrimListener;
 use Symfony\Component\Form\Extension\Core\DataMapper\PropertyPathMapper;
-use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\Form\Exception\FormException;
 use Symfony\Component\OptionsResolver\Options;
 use Symfony\Component\OptionsResolver\OptionsResolverInterface;
@@ -93,8 +92,8 @@ public function buildView(FormViewInterface $view, FormInterface $form, array $o
         }
 
         $types = array();
-        foreach ($form->getConfig()->getTypes() as $type) {
-            $types[] = $type->getName();
+        for ($type = $form->getConfig()->getType(); null !== $type; $type = $type->getParent()) {
+            array_unshift($types, $type->getName());
         }
 
         if (!$translationDomain) {
@@ -211,14 +210,6 @@ public function setDefaultOptions(OptionsResolverInterface $resolver)
         ));
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function createBuilder($name, FormFactoryInterface $factory, array $options)
-    {
-        return new FormBuilder($name, $options['data_class'], new EventDispatcher(), $factory, $options);
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/src/Symfony/Component/Form/Form.php b/src/Symfony/Component/Form/Form.php
@@ -195,11 +195,17 @@ public function getPropertyPath()
      * @return array An array of FormTypeInterface
      *
      * @deprecated Deprecated since version 2.1, to be removed in 2.3. Use
-     *             {@link getConfig()} and {@link FormConfigInterface::getTypes()} instead.
+     *             {@link getConfig()} and {@link FormConfigInterface::getType()} instead.
      */
     public function getTypes()
     {
-        return $this->config->getTypes();
+        $types = array();
+
+        for ($type = $this->config->getType(); null !== $type; $type = $type->getParent()) {
+            array_unshift($types, $type->getInnerType());
+        }
+
+        return $types;
     }
 
     /**
@@ -948,34 +954,7 @@ public function createView(FormViewInterface $parent = null)
             $parent = $this->parent->createView();
         }
 
-        $view = new FormView($this->config->getName());
-
-        $view->setParent($parent);
-
-        $types = (array) $this->config->getTypes();
-        $options = $this->config->getOptions();
-
-        foreach ($types as $type) {
-            $type->buildView($view, $this, $options);
-
-            foreach ($type->getExtensions() as $typeExtension) {
-                $typeExtension->buildView($view, $this, $options);
-            }
-        }
-
-        foreach ($this->children as $child) {
-            $view->add($child->createView($view));
-        }
-
-        foreach ($types as $type) {
-            $type->finishView($view, $this, $options);
-
-            foreach ($type->getExtensions() as $typeExtension) {
-                $typeExtension->finishView($view, $this, $options);
-            }
-        }
-
-        return $view;
+        return $this->config->getType()->createView($this, $parent);
     }
 
     /**

diff --git a/src/Symfony/Component/Form/FormBuilder.php b/src/Symfony/Component/Form/FormBuilder.php
@@ -115,10 +115,10 @@ public function create($name, $type = null, array $options = array())
         }
 
         if (null !== $type) {
-            return $this->getFormFactory()->createNamedBuilder($name, $type, null, $options, $this);
+            return $this->factory->createNamedBuilder($name, $type, null, $options, $this);
         }
 
-        return $this->getFormFactory()->createBuilderForProperty($this->getDataClass(), $name, null, $options, $this);
+        return $this->factory->createBuilderForProperty($this->getDataClass(), $name, null, $options, $this);
     }
 
     /**
@@ -266,4 +266,23 @@ public function getIterator()
     {
         return new \ArrayIterator($this->children);
     }
+
+    /**
+     * Returns the types used by this builder.
+     *
+     * @return array An array of FormTypeInterface
+     *
+     * @deprecated Deprecated since version 2.1, to be removed in 2.3. Use
+     *             {@link FormConfigInterface::getType()} instead.
+     */
+    public function getTypes()
+    {
+        $types = array();
+
+        for ($type = $this->getType(); null !== $type; $type = $type->getParent()) {
+            array_unshift($types, $type->getInnerType());
+        }
+
+        return $types;
+    }
 }
diff --git a/src/Symfony/Component/Form/FormConfig.php b/src/Symfony/Component/Form/FormConfig.php
@@ -59,9 +59,9 @@ class FormConfig implements FormConfigEditorInterface
     private $compound = false;
 
     /**
-     * @var array
+     * @var ResolvedFormTypeInterface
      */
-    private $types = array();
+    private $type;
 
     /**
      * @var array
@@ -377,9 +377,9 @@ public function getCompound()
     /**
      * {@inheritdoc}
      */
-    public function getTypes()
+    public function getType()
     {
-        return $this->types;
+        return $this->type;
     }
 
     /**
@@ -671,9 +671,9 @@ public function setCompound($compound)
     /**
      * {@inheritdoc}
      */
-    public function setTypes(array $types)
+    public function setType(ResolvedFormTypeInterface $type)
     {
-        $this->types = $types;
+        $this->type = $type;
 
         return $this;
     }

diff --git a/src/Symfony/Component/Form/FormConfigEditorInterface.php b/src/Symfony/Component/Form/FormConfigEditorInterface.php
@@ -213,11 +213,11 @@ public function setCompound($compound);
     /**
      * Set the types.
      *
-     * @param array $types An array FormTypeInterface
+     * @param ResolvedFormTypeInterface $type The type of the form.
      *
      * @return self The configuration object.
      */
-    public function setTypes(array $types);
+    public function setType(ResolvedFormTypeInterface $type);
 
     /**
      * Sets the initial data of the form.

diff --git a/src/Symfony/Component/Form/FormConfigInterface.php b/src/Symfony/Component/Form/FormConfigInterface.php
@@ -79,9 +79,9 @@ public function getCompound();
     /**
      * Returns the form types used to construct the form.
      *
-     * @return array An array of {@link FormTypeInterface} instances.
+     * @return ResolvedFormTypeInterface The form's type.
      */
-    public function getTypes();
+    public function getType();
 
     /**
      * Returns the view transformers of the form.