feat(laravel): stateOptions modelClass for eloquent (#7020)

refactor(laravel): using trait to handle modelClass option
test(laravel): add test to validate the modelClass option

Co-authored-by: Guillaume Durand <guillaume.durand@6tm.com>

Author: soyuka

src/Laravel/Eloquent/State/CollectionProvider.php

@@ -16,6 +16,7 @@
 use ApiPlatform\Laravel\Eloquent\Extension\QueryExtensionInterface;
 use ApiPlatform\Laravel\Eloquent\Paginator;
 use ApiPlatform\Laravel\Eloquent\PartialPaginator;
+use ApiPlatform\Metadata\Exception\RuntimeException;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\Pagination\Pagination;
 use ApiPlatform\State\ProviderInterface;
@@ -29,6 +30,7 @@
 final class CollectionProvider implements ProviderInterface
 {
     use LinksHandlerLocatorTrait;
+    use ModelClassTrait;
 
     /**
      * @param LinksHandlerInterface<Model>      $linksHandler
@@ -45,8 +47,12 @@ public function __construct(
 
     public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
     {
-        /** @var Model $model */
-        $model = new ($operation->getClass())();
+        $resourceClass = $this->getModelClass($operation);
+        $model = new $resourceClass();
+
+        if (!$model instanceof Model) {
+            throw new RuntimeException(\sprintf('The class "%s" is not an Eloquent model.', $resourceClass));
+        }
 
         if ($handleLinks = $this->getLinksHandler($operation)) {
             $query = $handleLinks($model->query(), $uriVariables, ['operation' => $operation, 'modelClass' => $operation->getClass()] + $context);

src/Laravel/Eloquent/State/ItemProvider.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Laravel\Eloquent\State;
 
 use ApiPlatform\Laravel\Eloquent\Extension\QueryExtensionInterface;
+use ApiPlatform\Metadata\Exception\RuntimeException;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\ProviderInterface;
 use Illuminate\Database\Eloquent\Model;
@@ -25,6 +26,7 @@
 final class ItemProvider implements ProviderInterface
 {
     use LinksHandlerLocatorTrait;
+    use ModelClassTrait;
 
     /**
      * @param LinksHandlerInterface<Model>      $linksHandler
@@ -40,7 +42,12 @@ public function __construct(
 
     public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
     {
-        $model = new ($operation->getClass())();
+        $resourceClass = $this->getModelClass($operation);
+        $model = new $resourceClass();
+
+        if (!$model instanceof Model) {
+            throw new RuntimeException(\sprintf('The class "%s" is not an Eloquent model.', $resourceClass));
+        }
 
         if ($handleLinks = $this->getLinksHandler($operation)) {
             $query = $handleLinks($model->query(), $uriVariables, ['operation' => $operation] + $context);

src/Laravel/Eloquent/State/LinksHandlerLocatorTrait.php

@@ -26,7 +26,7 @@ trait LinksHandlerLocatorTrait
 
     private function getLinksHandler(Operation $operation): ?callable
     {
-        if (!($options = $operation->getStateOptions()) || !$options instanceof Options) {
+        if (!($options = $operation->getStateOptions()) || !$options instanceof Options || !$options->getHandleLinks()) {
             return null;
         }
 

src/Laravel/Eloquent/State/ModelClassTrait.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\Laravel\Eloquent\State;
+
+use ApiPlatform\Metadata\Exception\RuntimeException;
+use ApiPlatform\Metadata\Operation;
+
+/**
+ * @internal
+ */
+trait ModelClassTrait
+{
+    /**
+     * @return class-string
+     */
+    private function getModelClass(Operation $operation): string
+    {
+        $modelClass = $operation->getClass();
+
+        if (($options = $operation->getStateOptions()) && $options instanceof Options && $options->getModelClass()) {
+            $modelClass = $options->getModelClass();
+        }
+
+        if (!$modelClass || !class_exists($modelClass)) {
+            throw new RuntimeException(\sprintf('No class found on operation %s.', $operation->getName()));
+        }
+
+        return $modelClass;
+    }
+}

src/Laravel/Eloquent/State/Options.php

@@ -23,6 +23,7 @@ class Options implements OptionsInterface
      * @see LinksHandlerInterface
      */
     public function __construct(
+        protected ?string $modelClass = null,
         protected mixed $handleLinks = null,
     ) {
     }
@@ -39,4 +40,17 @@ public function withHandleLinks(mixed $handleLinks): self
 
         return $self;
     }
+
+    public function getModelClass(): ?string
+    {
+        return $this->modelClass;
+    }
+
+    public function withModelClass(?string $modelClass): self
+    {
+        $self = clone $this;
+        $self->modelClass = $modelClass;
+
+        return $self;
+    }
 }

src/Laravel/Tests/JsonLdTest.php

@@ -357,4 +357,16 @@ public function testSimilarRoutesWithFormat(): void
         $response->assertStatus(200);
         $this->assertSame('/api/staff_position_histories', $response->json()['@id']);
     }
+
+    public function testResourceWithOptionModel(): void
+    {
+        $response = $this->get('/api/resource_with_models?page=1', ['accept' => 'application/ld+json']);
+        $response->assertStatus(200);
+        $response->assertHeader('content-type', 'application/ld+json; charset=utf-8');
+        $response->assertJsonFragment([
+            '@context' => '/api/contexts/ResourceWithModel',
+            '@id' => '/api/resource_with_models',
+            '@type' => 'Collection',
+        ]);
+    }
 }

src/Laravel/workbench/app/ApiResource/ResourceWithModel.php

@@ -0,0 +1,36 @@
+<?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 Workbench\App\ApiResource;
+
+use ApiPlatform\Laravel\Eloquent\State\CollectionProvider;
+use ApiPlatform\Laravel\Eloquent\State\ItemProvider;
+use ApiPlatform\Laravel\Eloquent\State\Options;
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Metadata\GetCollection;
+use Workbench\App\Models\Book;
+
+#[ApiResource(
+    operations: [
+        new GetCollection(provider: CollectionProvider::class),
+        new Get(provider: ItemProvider::class),
+    ],
+    stateOptions: new Options(modelClass: Book::class),
+)]
+class ResourceWithModel
+{
+    #[ApiProperty(identifier: true)]
+    public ?string $id = null;
+}