feature #13990 [Form] Add flexibility for EntityType (raziel057)

fabpot · fabpot · commit 317d30b6efd4 · 2015-08-01T14:00:55.000+02:00
This PR was submitted for the 2.7 branch but it was merged into the 2.8 branch instead (closes #13990). Discussion ---------- [Form] Add flexibility for EntityType | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | Sometimes it can be usefull to return null rather than a QueryBuilder from the closure attached to the ``query_builder`` attribute of an EntityType. For example, if I have the following method in a "DelegateRepository", which can return a QueryBuilder or null: ```php public function getQbForOfficers() { $permanentMeeting = $this->getEntityManager()->getRepository('MyBundle:PermanentMeeting')->findOneBy(array()); if ($permanentMeeting === null || $permanentMeeting->getMeeting() === null) { return null; } $qb = $this->getEntityManager()->createQueryBuilder(); $qb->select('p') ->from('MyBundle:Delegate', 'p') ->andWhere('p.meeting = :meetingId') ->setParameter('meetingId', $permanentMeeting->getMeeting()->getId()); return $qb; } ``` To be able to present a list without entries when creating an entity field like this: ```php $event->getForm()->add('officers', 'entity', array( 'class' => 'MyBundle:Delegate', 'property' => 'fullName', 'query_builder' => function(EntityRepository $er) use ($meeting, $delegationId) { return $er->getQbForOfficers(); } ))); ``` Rather than using the "choices" attributes (more verbose and which requires the injection of the entityManager): ```php $qb = $this->entityManager->getRepository('PTCNoventoBundle:Delegate')->getQbForOfficers(); $officers = ($qb !== null) ? $qb->getQuery()->getResult() : array(); $event->getForm()->add('officers', 'entity', array( 'class' => 'PTCNoventoBundle:Delegate', 'property' => 'fullName', 'choices' => $officers, )); ``` Commits ------- e0a1294 [Form] Add flexibility for EntityType
diff --git a/src/Symfony/Bridge/Doctrine/Form/ChoiceList/ORMQueryBuilderLoader.php b/src/Symfony/Bridge/Doctrine/Form/ChoiceList/ORMQueryBuilderLoader.php
@@ -30,7 +30,7 @@ class ORMQueryBuilderLoader implements EntityLoaderInterface
      *
      * This property should only be accessed through queryBuilder.
      *
-     * @var QueryBuilder
+     * @var QueryBuilder|null
      */
     private $queryBuilder;
 
@@ -68,7 +68,7 @@ public function __construct($queryBuilder, $manager = null, $class = null)
 
             $queryBuilder = $queryBuilder($manager->getRepository($class));
 
-            if (!$queryBuilder instanceof QueryBuilder) {
+            if (null !== $queryBuilder && !$queryBuilder instanceof QueryBuilder) {
                 throw new UnexpectedTypeException($queryBuilder, 'Doctrine\ORM\QueryBuilder');
             }
         }
@@ -81,6 +81,10 @@ public function __construct($queryBuilder, $manager = null, $class = null)
      */
     public function getEntities()
     {
+        if (null === $this->queryBuilder) {
+            return array();
+        }
+        
         return $this->queryBuilder->getQuery()->execute();
     }
 
@@ -89,6 +93,10 @@ public function getEntities()
      */
     public function getEntitiesByIds($identifier, array $values)
     {
+        if (null === $this->queryBuilder) {
+            return array();
+        }
+        
         $qb = clone ($this->queryBuilder);
         $alias = current($qb->getRootAliases());
         $parameter = 'ORMQueryBuilderLoader_getEntitiesByIds_'.$identifier;
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Form/Type/EntityTypeTest.php b/src/Symfony/Bridge/Doctrine/Tests/Form/Type/EntityTypeTest.php
@@ -212,6 +212,19 @@ public function testConfigureQueryBuilderWithClosureReturningNonQueryBuilder()
 
         $field->submit('2');
     }
+    
+    public function testConfigureQueryBuilderWithClosureReturningNull()
+    {
+        $field = $this->factory->createNamed('name', 'entity', null, array(
+            'em' => 'default',
+            'class' => self::SINGLE_IDENT_CLASS,
+            'query_builder' => function () {
+                return null;
+            },
+        ));
+
+        $this->assertEquals(array(), $field->createView()->vars['choices']);
+    }
 
     public function testSetDataSingleNull()
     {

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class ORMQueryBuilderLoader implements EntityLoaderInterface`
`30`	`30`	`*`
`31`	`31`	`* This property should only be accessed through queryBuilder.`
`32`	`32`	`*`
`33`		`- * @var QueryBuilder`
	`33`	`+ * @var QueryBuilder\|null`
`34`	`34`	`*/`
`35`	`35`	`private $queryBuilder;`
`36`	`36`
`@@ -68,7 +68,7 @@ public function __construct($queryBuilder, $manager = null, $class = null)`
`68`	`68`
`69`	`69`	`$queryBuilder = $queryBuilder($manager->getRepository($class));`
`70`	`70`
`71`		`- if (!$queryBuilder instanceof QueryBuilder) {`
	`71`	`+ if (null !== $queryBuilder && !$queryBuilder instanceof QueryBuilder) {`
`72`	`72`	`throw new UnexpectedTypeException($queryBuilder, 'Doctrine\ORM\QueryBuilder');`
`73`	`73`	`}`
`74`	`74`	`}`
`@@ -81,6 +81,10 @@ public function __construct($queryBuilder, $manager = null, $class = null)`
`81`	`81`	`*/`
`82`	`82`	`public function getEntities()`
`83`	`83`	`{`
	`84`	`+ if (null === $this->queryBuilder) {`
	`85`	`+ return array();`
	`86`	`+ }`
	`87`	`+`
`84`	`88`	`return $this->queryBuilder->getQuery()->execute();`
`85`	`89`	`}`
`86`	`90`
`@@ -89,6 +93,10 @@ public function getEntities()`
`89`	`93`	`*/`
`90`	`94`	`public function getEntitiesByIds($identifier, array $values)`
`91`	`95`	`{`
	`96`	`+ if (null === $this->queryBuilder) {`
	`97`	`+ return array();`
	`98`	`+ }`
	`99`	`+`
`92`	`100`	`$qb = clone ($this->queryBuilder);`
`93`	`101`	`$alias = current($qb->getRootAliases());`
`94`	`102`	`$parameter = 'ORMQueryBuilderLoader_getEntitiesByIds_'.$identifier;`