feat: remove static generator & provide a way to cache query (#677)

api-platform · Aug 25, 2016 · 3c49700 · 3c49700
1 parent e249b33
commit 3c49700
Show file tree

Hide file tree

Showing 32 changed files with 524 additions and 340 deletions.
diff --git a/src/Bridge/Doctrine/Orm/CollectionDataProvider.php b/src/Bridge/Doctrine/Orm/CollectionDataProvider.php
@@ -13,6 +13,7 @@
 
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryCollectionExtensionInterface;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultExtensionInterface;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
 use ApiPlatform\Core\DataProvider\CollectionDataProviderInterface;
 use ApiPlatform\Core\Exception\ResourceClassNotSupportedException;
 use Doctrine\Common\Persistence\ManagerRegistry;
@@ -50,9 +51,9 @@ public function getCollection(string $resourceClass, string $operationName = nul
 
         $repository = $manager->getRepository($resourceClass);
         $queryBuilder = $repository->createQueryBuilder('o');
-
+        $queryNameGenerator = new QueryNameGenerator();
         foreach ($this->collectionExtensions as $extension) {
-            $extension->applyToCollection($queryBuilder, $resourceClass, $operationName);
+            $extension->applyToCollection($queryBuilder, $queryNameGenerator, $resourceClass, $operationName);
 
             if ($extension instanceof QueryResultExtensionInterface) {
                 if ($extension->supportsResult($resourceClass, $operationName)) {

diff --git a/src/Bridge/Doctrine/Orm/Extension/EagerLoadingExtension.php b/src/Bridge/Doctrine/Orm/Extension/EagerLoadingExtension.php
@@ -11,6 +11,7 @@
 
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Extension;
 
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use Doctrine\ORM\Mapping\ClassMetadataInfo;
 use Doctrine\ORM\QueryBuilder;
 
@@ -25,15 +26,15 @@ final class EagerLoadingExtension implements QueryCollectionExtensionInterface,
     /**
      * {@inheritdoc}
      */
-    public function applyToCollection(QueryBuilder $queryBuilder, string $resourceClass, string $operationName = null)
+    public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
     {
         $this->joinRelations($queryBuilder, $resourceClass);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function applyToItem(QueryBuilder $queryBuilder, string $resourceClass, array $identifiers, string $operationName = null)
+    public function applyToItem(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, array $identifiers, string $operationName = null)
     {
         $this->joinRelations($queryBuilder, $resourceClass);
     }

diff --git a/src/Bridge/Doctrine/Orm/Extension/FilterExtension.php b/src/Bridge/Doctrine/Orm/Extension/FilterExtension.php
@@ -13,6 +13,7 @@
 
 use ApiPlatform\Core\Api\FilterCollection;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\FilterInterface;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use Doctrine\ORM\QueryBuilder;
 
@@ -36,7 +37,7 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa
     /**
      * {@inheritdoc}
      */
-    public function applyToCollection(QueryBuilder $queryBuilder, string $resourceClass, string $operationName = null)
+    public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
     {
         $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
         $resourceFilters = $resourceMetadata->getCollectionOperationAttribute($operationName, 'filters', [], true);
@@ -47,7 +48,7 @@ public function applyToCollection(QueryBuilder $queryBuilder, string $resourceCl
 
         foreach ($this->filters as $filterName => $filter) {
             if (in_array($filterName, $resourceFilters) && $filter instanceof FilterInterface) {
-                $filter->apply($queryBuilder, $resourceClass, $operationName);
+                $filter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operationName);
             }
         }
     }

diff --git a/src/Bridge/Doctrine/Orm/Extension/OrderExtension.php b/src/Bridge/Doctrine/Orm/Extension/OrderExtension.php
@@ -11,6 +11,7 @@
 
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Extension;
 
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use Doctrine\ORM\QueryBuilder;
 
 /**
@@ -31,7 +32,7 @@ public function __construct(string $order = null)
     /**
      * {@inheritdoc}
      */
-    public function applyToCollection(QueryBuilder $queryBuilder, string $resourceClass, string $operationName = null)
+    public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
     {
         $classMetaData = $queryBuilder->getEntityManager()->getClassMetadata($resourceClass);
         $identifiers = $classMetaData->getIdentifier();

diff --git a/src/Bridge/Doctrine/Orm/Extension/PaginationExtension.php b/src/Bridge/Doctrine/Orm/Extension/PaginationExtension.php
@@ -13,6 +13,7 @@
 
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Paginator;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryChecker;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
 use Doctrine\Common\Persistence\ManagerRegistry;
@@ -57,7 +58,7 @@ public function __construct(ManagerRegistry $managerRegistry, RequestStack $requ
     /**
      * {@inheritdoc}
      */
-    public function applyToCollection(QueryBuilder $queryBuilder, string $resourceClass, string $operationName = null)
+    public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
     {
         $request = $this->requestStack->getCurrentRequest();
         if (null === $request) {

diff --git a/src/Bridge/Doctrine/Orm/Extension/QueryCollectionExtensionInterface.php b/src/Bridge/Doctrine/Orm/Extension/QueryCollectionExtensionInterface.php
@@ -11,6 +11,7 @@
 
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Extension;
 
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use Doctrine\ORM\QueryBuilder;
 
 /**
@@ -26,5 +27,5 @@ interface QueryCollectionExtensionInterface
      * @param string       $resourceClass
      * @param string       $operationName
      */
-    public function applyToCollection(QueryBuilder $queryBuilder, string $resourceClass, string $operationName = null);
+    public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null);
 }
diff --git a/src/Bridge/Doctrine/Orm/Extension/QueryItemExtensionInterface.php b/src/Bridge/Doctrine/Orm/Extension/QueryItemExtensionInterface.php
@@ -11,6 +11,7 @@
 
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Extension;
 
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use Doctrine\ORM\QueryBuilder;
 
 /**
@@ -27,5 +28,5 @@ interface QueryItemExtensionInterface
      * @param array        $identifiers
      * @param string|null  $operationName
      */
-    public function applyToItem(QueryBuilder $queryBuilder, string $resourceClass, array $identifiers, string $operationName = null);
+    public function applyToItem(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, array $identifiers, string $operationName = null);
 }
diff --git a/src/Bridge/Doctrine/Orm/Filter/AbstractFilter.php b/src/Bridge/Doctrine/Orm/Filter/AbstractFilter.php
@@ -11,7 +11,7 @@
 
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Filter;
 
-use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
 use ApiPlatform\Core\Util\RequestParser;
 use Doctrine\Common\Persistence\ManagerRegistry;
@@ -180,22 +180,23 @@ protected function extractProperties(Request $request) : array
     /**
      * Adds the necessary joins for a nested property.
      *
-     * @param string       $property
-     * @param string       $rootAlias
-     * @param QueryBuilder $queryBuilder
+     * @param string                      $property
+     * @param string                      $rootAlias
+     * @param QueryBuilder                $queryBuilder
+     * @param QueryNameGeneratorInterface $queryNameGenerator
      *
      * @throws InvalidArgumentException If property is not nested
      *
      * @return array An array where the first element is the join $alias of the leaf entity,
      *               and the second element is the $field name
      */
-    protected function addJoinsForNestedProperty(string $property, string $rootAlias, QueryBuilder $queryBuilder) : array
+    protected function addJoinsForNestedProperty(string $property, string $rootAlias, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator) : array
     {
         $propertyParts = $this->splitPropertyParts($property);
         $parentAlias = $rootAlias;
 
         foreach ($propertyParts['associations'] as $association) {
-            $alias = QueryNameGenerator::generateJoinAlias($association);
+            $alias = $queryNameGenerator->generateJoinAlias();
             $queryBuilder->leftJoin(sprintf('%s.%s', $parentAlias, $association), $alias);
             $parentAlias = $alias;
         }

diff --git a/src/Bridge/Doctrine/Orm/Filter/BooleanFilter.php b/src/Bridge/Doctrine/Orm/Filter/BooleanFilter.php
@@ -11,7 +11,7 @@
 
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Filter;
 
-use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\DBAL\Types\Type as DBALType;
 use Doctrine\ORM\QueryBuilder;
@@ -24,9 +24,6 @@
  */
 class BooleanFilter extends AbstractFilter
 {
-    /*
-     * @var RequestStack
-     */
     private $requestStack;
 
     public function __construct(ManagerRegistry $managerRegistry, RequestStack $requestStack, array $properties = null)
@@ -44,7 +41,7 @@ public function __construct(ManagerRegistry $managerRegistry, RequestStack $requ
      * For each property passed, if the resource does not have such property or if the order value is different from
      * 1, 0, true, false, on, off (case insensitive) the property is ignored.
      */
-    public function apply(QueryBuilder $queryBuilder, string $resourceClass, string $operationName = null)
+    public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
     {
         $request = $this->requestStack->getCurrentRequest();
         if (null === $request) {
@@ -72,9 +69,9 @@ public function apply(QueryBuilder $queryBuilder, string $resourceClass, string
             $field = $property;
 
             if ($this->isPropertyNested($property)) {
-                list($alias, $field) = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder);
+                list($alias, $field) = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder, $queryNameGenerator);
             }
-            $valueParameter = QueryNameGenerator::generateParameterName($field);
+            $valueParameter = $queryNameGenerator->generateParameterName();
 
             $queryBuilder
                 ->andWhere(sprintf('%s.%s = :%s', $alias, $field, $valueParameter))

diff --git a/src/Bridge/Doctrine/Orm/Filter/DateFilter.php b/src/Bridge/Doctrine/Orm/Filter/DateFilter.php
@@ -11,7 +11,7 @@
 
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Filter;
 
-use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\ORM\QueryBuilder;
 use Symfony\Component\HttpFoundation\RequestStack;
@@ -53,7 +53,7 @@ public function __construct(ManagerRegistry $managerRegistry, RequestStack $requ
     /**
      * {@inheritdoc}
      */
-    public function apply(QueryBuilder $queryBuilder, string $resourceClass, string $operationName = null)
+    public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
     {
         if (null === ($request = $this->requestStack->getCurrentRequest())) {
             return;
@@ -79,7 +79,7 @@ public function apply(QueryBuilder $queryBuilder, string $resourceClass, string
                 $parentAlias = $alias;
 
                 foreach ($propertyParts['associations'] as $association) {
-                    $alias = QueryNameGenerator::generateJoinAlias($association);
+                    $alias = $queryNameGenerator->generateJoinAlias();
                     $queryBuilder->join(sprintf('%s.%s', $parentAlias, $association), $alias);
                     $parentAlias = $alias;
                 }
@@ -96,6 +96,7 @@ public function apply(QueryBuilder $queryBuilder, string $resourceClass, string
             if (isset($values[self::PARAMETER_BEFORE])) {
                 $this->addWhere(
                     $queryBuilder,
+                    $queryNameGenerator,
                     $alias,
                     $field,
                     self::PARAMETER_BEFORE,
@@ -107,6 +108,7 @@ public function apply(QueryBuilder $queryBuilder, string $resourceClass, string
             if (isset($values[self::PARAMETER_AFTER])) {
                 $this->addWhere(
                     $queryBuilder,
+                    $queryNameGenerator,
                     $alias,
                     $field,
                     self::PARAMETER_AFTER,
@@ -120,16 +122,17 @@ public function apply(QueryBuilder $queryBuilder, string $resourceClass, string
     /**
      * Adds the where clause according to the chosen null management.
      *
-     * @param QueryBuilder $queryBuilder
-     * @param string       $alias
-     * @param string       $field
-     * @param string       $operator
-     * @param string       $value
-     * @param string|null  $nullManagement
+     * @param QueryBuilder                $queryBuilder
+     * @param QueryNameGeneratorInterface $queryNameGenerator
+     * @param string                      $alias
+     * @param string                      $field
+     * @param string                      $operator
+     * @param string                      $value
+     * @param string|null                 $nullManagement
      */
-    private function addWhere(QueryBuilder $queryBuilder, string $alias, string $field, string $operator, string $value, string $nullManagement = null)
+    private function addWhere(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $alias, string $field, string $operator, string $value, string $nullManagement = null)
     {
-        $valueParameter = QueryNameGenerator::generateParameterName(sprintf('%s_%s', $field, $operator));
+        $valueParameter = $queryNameGenerator->generateParameterName();
         $baseWhere = sprintf('%s.%s %s :%s', $alias, $field, self::PARAMETER_BEFORE === $operator ? '<=' : '>=', $valueParameter);
 
         if (null === $nullManagement || self::EXCLUDE_NULL === $nullManagement) {

diff --git a/src/Bridge/Doctrine/Orm/Filter/FilterInterface.php b/src/Bridge/Doctrine/Orm/Filter/FilterInterface.php
@@ -12,6 +12,7 @@
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Filter;
 
 use ApiPlatform\Core\Api\FilterInterface as BaseFilterInterface;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use Doctrine\ORM\QueryBuilder;
 
 /**
@@ -24,9 +25,10 @@ interface FilterInterface extends BaseFilterInterface
     /**
      * Applies the filter.
      *
-     * @param QueryBuilder $queryBuilder
-     * @param string       $resourceClass
-     * @param string|null  $operationName
+     * @param QueryBuilder                $queryBuilder
+     * @param QueryNameGeneratorInterface $queryNameGenerator
+     * @param string                      $resourceClass
+     * @param string|null                 $operationName
      */
-    public function apply(QueryBuilder $queryBuilder, string $resourceClass, string $operationName = null);
+    public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null);
 }
diff --git a/src/Bridge/Doctrine/Orm/Filter/NumericFilter.php b/src/Bridge/Doctrine/Orm/Filter/NumericFilter.php
@@ -11,7 +11,7 @@
 
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Filter;
 
-use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\DBAL\Types\Type as DBALType;
 use Doctrine\ORM\QueryBuilder;
@@ -37,9 +37,6 @@ class NumericFilter extends AbstractFilter
         DBALType::SMALLINT => true,
     ];
 
-    /*
-     * @var RequestStack
-     */
     private $requestStack;
 
     public function __construct(ManagerRegistry $managerRegistry, RequestStack $requestStack, array $properties = null)
@@ -56,7 +53,7 @@ public function __construct(ManagerRegistry $managerRegistry, RequestStack $requ
      *
      * For each property passed, if the resource does not have such property or if the  value is not numerical the property is ignored.
      */
-    public function apply(QueryBuilder $queryBuilder, string $resourceClass, string $operationName = null)
+    public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
     {
         $request = $this->requestStack->getCurrentRequest();
         if (null === $request) {
@@ -81,9 +78,9 @@ public function apply(QueryBuilder $queryBuilder, string $resourceClass, string
             $field = $property;
 
             if ($this->isPropertyNested($property)) {
-                list($alias, $field) = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder);
+                list($alias, $field) = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder, $queryNameGenerator);
             }
-            $valueParameter = QueryNameGenerator::generateParameterName($field);
+            $valueParameter = $queryNameGenerator->generateParameterName();
 
             $queryBuilder
                 ->andWhere(sprintf('%s.%s = :%s', $alias, $field, $valueParameter))

diff --git a/src/Bridge/Doctrine/Orm/Filter/OrderFilter.php b/src/Bridge/Doctrine/Orm/Filter/OrderFilter.php
@@ -11,6 +11,7 @@
 
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Filter;
 
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\ORM\QueryBuilder;
 use Symfony\Component\HttpFoundation\Request;
@@ -50,7 +51,7 @@ public function __construct(ManagerRegistry $managerRegistry, RequestStack $requ
      * For each property passed, if the resource does not have such property or if the order value is different from
      * `asc` or `desc` (case insensitive), the property is ignored.
      */
-    public function apply(QueryBuilder $queryBuilder, string $resourceClass, string $operationName = null)
+    public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
     {
         $request = $this->requestStack->getCurrentRequest();
         if (null === $request) {
@@ -77,7 +78,7 @@ public function apply(QueryBuilder $queryBuilder, string $resourceClass, string
             $field = $property;
 
             if ($this->isPropertyNested($property)) {
-                list($alias, $field) = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder);
+                list($alias, $field) = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder, $queryNameGenerator);
             }
 
             $queryBuilder->addOrderBy(sprintf('%s.%s', $alias, $field), $order);