fix(object-mapper): ObjectMapperProvider can handle non paginated collections

Author: senaria

src/State/Provider/ObjectMapperProvider.php

@@ -40,7 +40,11 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
     {
         $data = $this->decorated->provide($operation, $uriVariables, $context);
 
-        if (!$this->objectMapper || !\is_object($data) || !$operation->canMap()) {
+        if (!$this->objectMapper || !$operation->canMap()) {
+            return $data;
+        }
+
+        if (!\is_object($data) && !\is_array($data)) {
             return $data;
         }
 
@@ -49,6 +53,8 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
 
         if ($data instanceof PaginatorInterface) {
             $data = new ArrayPaginator(array_map(fn ($v) => $this->objectMapper->map($v, $operation->getClass()), iterator_to_array($data)), 0, \count($data));
+        } elseif (\is_array($data)) {
+            $data = array_map(fn ($v) => $this->objectMapper->map($v, $operation->getClass()), $data);
         } else {
             $data = $this->objectMapper->map($data, $operation->getClass());
         }

tests/Fixtures/TestBundle/ApiResource/Issue7563/BookDto.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue7563;
+
+use ApiPlatform\Doctrine\Orm\State\Options;
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Metadata\GetCollection;
+use ApiPlatform\Tests\Fixtures\TestBundle\Entity\Book;
+use ApiPlatform\Tests\Fixtures\TestBundle\ObjectMapper\IsbnToCustomIsbnTransformer;
+use Symfony\Component\ObjectMapper\Attribute\Map;
+
+#[Get(
+    stateOptions: new Options(entityClass: Book::class)
+)]
+#[GetCollection(
+    stateOptions: new Options(entityClass: Book::class)
+)]
+#[Map(source: Book::class)]
+class BookDto
+{
+    public function __construct(
+        #[Map(source: 'id')]
+        public ?int $id = null,
+        #[Map(source: 'name')]
+        public ?string $name = null,
+        #[Map(source: 'isbn', transform: IsbnToCustomIsbnTransformer::class)]
+        public ?string $customIsbn = null,
+    ) {
+    }
+}

tests/Fixtures/TestBundle/ObjectMapper/IsbnToCustomIsbnTransformer.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\ObjectMapper;
+
+use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue7563\BookDto;
+use ApiPlatform\Tests\Fixtures\TestBundle\Entity\Book;
+use Symfony\Component\ObjectMapper\TransformCallableInterface;
+
+/**
+ * @implements TransformCallableInterface<Book, BookDto>
+ */
+final readonly class IsbnToCustomIsbnTransformer implements TransformCallableInterface
+{
+    public function __invoke(mixed $value, object $source, ?object $target): mixed
+    {
+        return 'custom'.$value;
+    }
+}

tests/Fixtures/app/config/config_common.yml

@@ -270,6 +270,10 @@ services:
         tags:
             - name: 'api_platform.state_processor'
 
+    ApiPlatform\Tests\Fixtures\TestBundle\ObjectMapper\IsbnToCustomIsbnTransformer:
+        tags:
+            - name: 'object_mapper.transform_callable'
+
     app.messenger_handler.messenger_with_response:
         class: 'ApiPlatform\Tests\Fixtures\TestBundle\MessengerHandler\MessengerWithResponseHandler'
         tags:

tests/Functional/State/Provider/Issue7563Test.php

@@ -0,0 +1,107 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Functional\State\Provider;
+
+use ApiPlatform\Symfony\Bundle\Test\ApiTestCase;
+use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue7563\BookDto;
+use ApiPlatform\Tests\Fixtures\TestBundle\Entity\Book;
+use ApiPlatform\Tests\RecreateSchemaTrait;
+use ApiPlatform\Tests\SetupClassResourcesTrait;
+
+/**
+ * Tests for ObjectMapperProvider to verify object mapping works correctly
+ * for single items, paginated collections, and unpaginated collections.
+ */
+final class Issue7563Test extends ApiTestCase
+{
+    use RecreateSchemaTrait;
+    use SetupClassResourcesTrait;
+
+    protected static ?bool $alwaysBootKernel = false;
+
+    /**
+     * @return class-string[]
+     */
+    public static function getResources(): array
+    {
+        return [BookDto::class];
+    }
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->recreateSchema([Book::class]);
+        $this->loadFixtures();
+    }
+
+    private function loadFixtures(): void
+    {
+        $manager = $this->getManager();
+
+        for ($i = 1; $i <= 5; ++$i) {
+            $book = new Book();
+            $book->name = 'Book '.$i;
+            $book->isbn = 'ISBN-'.$i;
+            $manager->persist($book);
+        }
+
+        $manager->flush();
+    }
+
+    public function testGetSingleBookDto(): void
+    {
+        // When
+        self::createClient()->request('GET', '/book_dtos/1');
+
+        // Then
+        self::assertResponseIsSuccessful();
+        self::assertJsonContains([
+            '@type' => 'BookDto',
+            'id' => 1,
+            'name' => 'Book 1',
+            'customIsbn' => 'customISBN-1',
+        ]);
+    }
+
+    public function testGetCollectionBookDtoPaginated(): void
+    {
+        // When
+        $response = self::createClient()->request('GET', '/book_dtos');
+
+        // Then
+        self::assertResponseIsSuccessful();
+
+        $json = $response->toArray();
+        self::assertCount(3, $json['hydra:member']);
+        foreach ($response->toArray()['hydra:member'] as $member) {
+            self::assertStringStartsWith('customISBN-', $member['customIsbn']);
+        }
+    }
+
+    public function testGetCollectionBookDtoUnpaginated(): void
+    {
+        // When
+        $response = self::createClient()->request('GET', '/book_dtos?pagination=false');
+
+        // Then
+        self::assertResponseIsSuccessful();
+
+        $json = $response->toArray();
+        self::assertCount(5, $json['hydra:member']);
+        foreach ($json['hydra:member'] as $member) {
+            self::assertStringStartsWith('customISBN-', $member['customIsbn']);
+        }
+    }
+}