Changed DoctrineChoiceLoader caching logic

malarzm · malarzm · commit 999c70be309d · 2015-05-15T14:39:35.000+02:00
diff --git a/src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php b/src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php
@@ -89,6 +89,24 @@ public static function createChoiceName($choice, $key, $value)
     {
         return (string) $value;
     }
+    
+    /**
+     * Gets important parts from QueryBuilder that will allow to cache its results.
+     * For instance in ORM two query builders with an equal SQL string and
+     * equal parameters are considered to be equal.
+     * 
+     * @param object $queryBuilder
+     * 
+     * @return array|false Array with important QueryBuilder parts or false if
+     *                     they can't be determined
+     * 
+     * @internal This method is public to be usable as callback. It should not
+     *           be used in user code.
+     */
+    public function getQueryBuilderPartsForCachingHash($queryBuilder)
+    {
+        return false;
+    }
 
     public function __construct(ManagerRegistry $registry, PropertyAccessorInterface $propertyAccessor = null, ChoiceListFactoryInterface $choiceListFactory = null)
     {
@@ -115,29 +133,28 @@ public function configureOptions(OptionsResolver $resolver)
         $type = $this;
 
         $choiceLoader = function (Options $options) use ($choiceListFactory, &$choiceLoaders, $type) {
-            // This closure and the "query_builder" options should be pushed to
-            // EntityType in Symfony 3.0 as they are specific to the ORM
 
             // Unless the choices are given explicitly, load them on demand
             if (null === $options['choices']) {
-                // We consider two query builders with an equal SQL string and
-                // equal parameters to be equal
-                $qbParts = $options['query_builder'] instanceof \Doctrine\ORM\QueryBuilder
-                    ? array(
-                        $options['query_builder']->getQuery()->getSQL(),
-                        $options['query_builder']->getParameters()->toArray(),
-                    )
-                    : null;
-
-                $hash = CachingFactoryDecorator::generateHash(array(
-                    $options['em'],
-                    $options['class'],
-                    $qbParts,
-                    $options['loader'],
-                ));
-
-                if (isset($choiceLoaders[$hash])) {
-                    return $choiceLoaders[$hash];
+                
+                $hash = null;
+                $qbParts = null;
+                
+                // If there is no QueryBuilder we can safely cache DoctrineChoiceLoader,
+                // also if concrete Type can return important QueryBuilder parts to generate
+                // hash key we go for it as well
+                if (!$options['query_builder'] || false !== ($qbParts = $type->getQueryBuilderPartsForCachingHash($options['query_builder']))) {
+                    
+                    $hash = CachingFactoryDecorator::generateHash(array(
+                        $options['em'],
+                        $options['class'],
+                        $qbParts,
+                        $options['loader'],
+                    ));
+
+                    if (isset($choiceLoaders[$hash])) {
+                        return $choiceLoaders[$hash];
+                    }
                 }
 
                 if ($options['loader']) {
@@ -149,15 +166,19 @@ public function configureOptions(OptionsResolver $resolver)
                     $entityLoader = $type->getLoader($options['em'], $queryBuilder, $options['class']);
                 }
 
-                $choiceLoaders[$hash] = new DoctrineChoiceLoader(
+                $doctrineChoiceLoader = new DoctrineChoiceLoader(
                     $choiceListFactory,
                     $options['em'],
                     $options['class'],
                     $options['id_reader'],
                     $entityLoader
                 );
+                
+                if ($hash !== null) {
+                    $choiceLoaders[$hash] = $doctrineChoiceLoader;
+                }
 
-                return $choiceLoaders[$hash];
+                return $doctrineChoiceLoader;
             }
         };
 
diff --git a/src/Symfony/Bridge/Doctrine/Form/Type/EntityType.php b/src/Symfony/Bridge/Doctrine/Form/Type/EntityType.php
@@ -60,4 +60,23 @@ public function getName()
     {
         return 'entity';
     }
+    
+    /**
+     * We consider two query builders with an equal SQL string and
+     * equal parameters to be equal.
+     * 
+     * @param QueryBuilder $queryBuilder
+     * 
+     * @return array
+     * 
+     * @internal This method is public to be usable as callback. It should not
+     *           be used in user code.
+     */
+    public function getQueryBuilderPartsForCachingHash($queryBuilder)
+    {
+        return array(
+                $queryBuilder->getQuery()->getSQL(),
+                $queryBuilder->getParameters()->toArray(),
+        );
+    }
 }
