Merge pull request #20 from sweetspotio/feature/collection-query-bus-example

Collection query bus example

Author: m0sviatoslav

config/api_platform/User/User.yaml

@@ -5,12 +5,15 @@ Acme\Domain\User\User:
   collectionOperations:
     get:
       method: GET
-      output: Acme\UI\Http\Rest\Presentation\User\UserView
-      normalization_context:
-        groups: [ profile ]
-    get_v2:
-      path: v2/users
-      method: GET
+      filters: [ 'user.search_filter' ]
+        output: Acme\UI\Http\Rest\Presentation\User\UserView
+        normalization_context:
+          groups: [ profile ]
+      get_v2:
+        path: v2/users
+        method: GET
+        query: Acme\Application\UseCase\Query\User\GetUsers\GetUsersQuery
+        filters: [ 'user.search_filter' ]
       output: Acme\UI\Http\Rest\Presentation\User\UserProfileView
     post:
       method: POST

config/packages/api_platform.yaml

@@ -12,12 +12,20 @@ api_platform:
     jsonhal: [ 'application/hal+json' ]
     jsonld: [ 'application/ld+json' ]
     html: [ 'text/html' ]
+  collection:
+    pagination:
+      client_items_per_page: true
+      items_per_page_parameter_name: limit
+      items_per_page: 50
   swagger:
     versions: [3]
     api_keys:
       Bearer:
         name: Bearer
         type: header
+
+  path_segment_name_generator: api_platform.path_segment_name_generator.dash
+
   exception_to_status:
     # The 4 following handlers are registered by default, keep those lines to prevent unexpected side effects
     Symfony\Component\Serializer\Exception\ExceptionInterface: 400 # Use a raw status code (recommended)

config/services.yaml

@@ -58,5 +58,20 @@ services:
     resource: '../src/UI/Http/Web/Controller/*'
     tags: [ 'controller.service_arguments' ]
 
+  Acme\Application\UseCase\Query\CollectionQueryFactory:
+    arguments:
+      $collectionOptions: '%api_platform.collection.pagination%'
+
+  acme.user_resource.search_filter:
+    parent: 'api_platform.doctrine.orm.search_filter'
+    arguments: [ { credentials.email: "partial" } ]
+    tags: [ { name: 'api_platform.filter', id: 'user.search_filter' } ]
+    # The following are mandatory only if a _defaults section is defined
+    # You may want to isolate filters in a dedicated file to avoid adding them
+    autowire: false
+    autoconfigure: false
+
+  Acme\Application\UseCase\Query\User\GetUsers\GetUsersQueryHandler:
+    arguments: ['api_platform.doctrine.orm.default.collection_data_provider']
   # add more service definitions when explicit configuration is needed
   # please note that last definitions always *replace* previous ones

src/Application/UseCase/Query/User/GetUsers/GetUsersQuery.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Acme\Application\UseCase\Query\User\GetUsers;
+
+use Acme\Application\UseCase\Query\CollectionQuery;
+use Acme\Domain\User\User;
+
+class GetUsersQuery extends CollectionQuery
+{
+    public static function createWithContext(array $context): CollectionQuery
+    {
+        return new self($context);
+    }
+
+    public static function resourceClass(): string
+    {
+        return User::class;
+    }
+}

src/Application/UseCase/Query/User/GetUsers/GetUsersQueryDataTransformer.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Acme\Application\UseCase\Query\User\GetUsers;
+
+use Acme\Application\UseCase\Query\CollectionQueryFactory;
+use ApiPlatform\Core\DataTransformer\DataTransformerInterface;
+
+class GetUsersQueryDataTransformer implements DataTransformerInterface
+{
+    private CollectionQueryFactory $factory;
+
+    public function __construct(CollectionQueryFactory $factory)
+    {
+        $this->factory = $factory;
+    }
+
+    public function supportsTransformation($data, string $to, array $context = []): bool
+    {
+        return GetUsersQuery::class === ($context['query'] ?? false);
+    }
+
+    public function transform($object, string $to, array $context = [])
+    {
+        return $this->factory->createCollectionQuery(GetUsersQuery::class, $context);
+    }
+}

src/Application/UseCase/Query/User/GetUsers/GetUsersQueryHandler.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Acme\Application\UseCase\Query\User\GetUsers;
+
+use Acme\Infrastructure\Shared\Bus\Query\QueryHandlerInterface;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\CollectionDataProvider;
+
+class GetUsersQueryHandler implements QueryHandlerInterface
+{
+    private CollectionDataProvider $provider;
+
+    public function __construct(CollectionDataProvider $provider)
+    {
+        $this->provider = $provider;
+    }
+
+    public function __invoke(GetUsersQuery $data): iterable
+    {
+        return $this->provider->getCollection(
+            $data->resourceClass(),
+            $data->collectionOperationName(),
+            $data->context()
+        );
+    }
+
+}

src/Domain/User/User.php

@@ -43,11 +43,6 @@ public static function create(
         return $user;
     }
 
-    public function getUuid(): string
-    {
-        return $this->getAggregateRootId();
-    }
-
     public function signIn(string $plainPassword): void
     {
         if (!$this->credentials->password->match($plainPassword)) {

src/UI/Http/Rest/Controller/User/GetUserByEmailController.php

@@ -22,8 +22,6 @@ public function __invoke(Request $request, string $email)
     {
         $query = new FindByEmailQuery($email);
 
-        $user = $this->ask($query);
-
-        return UserView::create($user);
+        return $this->ask($query);
     }
 }