fix(laravel): Allow LinksHandler to handle polymorphic relationships

Author: jonerickson

src/Laravel/Eloquent/State/LinksHandler.php

@@ -22,6 +22,7 @@
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphOneOrMany;
 
 /**
  * @implements LinksHandlerInterface<Model>
@@ -103,6 +104,13 @@ private function buildQuery(Builder $builder, Link $link, mixed $identifier): Bu
         if ($from = $link->getFromProperty()) {
             $relation = $this->application->make($link->getFromClass());
             $relationQuery = $relation->{$from}();
+
+            if ($relationQuery instanceof MorphOneOrMany) {
+                return $builder
+                    ->where($relationQuery->getForeignKeyName(), $identifier)
+                    ->where($relationQuery->getMorphType(), $relationQuery->getMorphClass());
+            }
+
             if (!method_exists($relationQuery, 'getQualifiedForeignKeyName') && method_exists($relationQuery, 'getQualifiedForeignPivotKeyName')) {
                 return $builder->getModel()
                     ->join(

src/Laravel/Tests/EloquentTest.php

@@ -19,9 +19,12 @@
 use Illuminate\Support\Str;
 use Orchestra\Testbench\Concerns\WithWorkbench;
 use Orchestra\Testbench\TestCase;
+use Workbench\App\Models\PostWithMorphMany;
 use Workbench\Database\Factories\AuthorFactory;
 use Workbench\Database\Factories\BookFactory;
+use Workbench\Database\Factories\CommentMorphFactory;
 use Workbench\Database\Factories\GrandSonFactory;
+use Workbench\Database\Factories\PostWithMorphManyFactory;
 use Workbench\Database\Factories\WithAccessorFactory;
 
 class EloquentTest extends TestCase
@@ -538,4 +541,41 @@ public function testPostWithEmptyMorphMany(): void
             'comments' => [['content' => 'hello']],
         ]);
     }
+
+    public function testPostCommentsCollectionFromMorphMany(): void
+    {
+        PostWithMorphManyFactory::new()->create();
+
+        CommentMorphFactory::new()->count(5)->create([
+            'commentable_id' => 1,
+            'commentable_type' => PostWithMorphMany::class,
+        ]);
+
+        $response = $this->getJson('/api/post_with_morph_manies/1/comments', [
+            'accept' => 'application/ld+json',
+        ]);
+        $response->assertStatus(200);
+        $response->assertJsonCount(5, 'member');
+    }
+
+    public function testPostCommentItemFromMorphMany(): void
+    {
+        PostWithMorphManyFactory::new()->create();
+
+        CommentMorphFactory::new()->count(5)->create([
+            'commentable_id' => 1,
+            'commentable_type' => PostWithMorphMany::class,
+        ])->first();
+
+        $response = $this->getJson('/api/post_with_morph_manies/1/comments/1', [
+            'accept' => 'application/ld+json',
+        ]);
+        $response->assertStatus(200);
+        $response->assertJson([
+            '@context' => '/api/contexts/CommentMorph',
+            '@id' => '/api/post_with_morph_manies/1/comments/1',
+            '@type' => 'CommentMorph',
+            'id' => 1,
+        ]);
+    }
 }

src/Laravel/workbench/app/Models/CommentMorph.php

@@ -14,12 +14,40 @@
 namespace Workbench\App\Models;
 
 use ApiPlatform\Metadata\ApiProperty;
-use ApiPlatform\Metadata\NotExposed;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Metadata\GetCollection;
+use ApiPlatform\Metadata\Link;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Symfony\Component\Serializer\Attribute\Groups;
 
-#[NotExposed]
+#[ApiResource(
+    operations: [
+        new GetCollection(
+            uriTemplate: '/post_with_morph_manies/{id}/comments',
+            uriVariables: [
+                'id' => new Link(
+                    fromProperty: 'comments',
+                    fromClass: PostWithMorphMany::class,
+                ),
+            ]
+        ),
+        new Get(
+            uriTemplate: '/post_with_morph_manies/{postId}/comments/{id}',
+            uriVariables: [
+                'postId' => new Link(
+                    fromProperty: 'comments',
+                    fromClass: PostWithMorphMany::class,
+                ),
+                'id' => new Link(
+                    fromClass: CommentMorph::class,
+                ),
+            ]
+        ),
+    ]
+)]
+#[ApiProperty(identifier: true, serialize: new Groups(['comments']), property: 'id')]
 #[ApiProperty(serialize: new Groups(['comments']), property: 'content')]
 class CommentMorph extends Model
 {

src/Laravel/workbench/database/factories/CommentFactory.php

@@ -17,7 +17,7 @@
 use Workbench\App\Models\Comment;
 
 /**
- * @template TModel of \Workbench\App\Models\Author
+ * @template TModel of \Workbench\App\Models\Comment
  *
  * @extends \Illuminate\Database\Eloquent\Factories\Factory<TModel>
  */

src/Laravel/workbench/database/factories/CommentMorphFactory.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Workbench\App\Models\CommentMorph;
+
+/**
+ * @template TModel of \Workbench\App\Models\CommentMorph
+ *
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<TModel>
+ */
+class CommentMorphFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var class-string<TModel>
+     */
+    protected $model = CommentMorph::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'commentable_id' => PostWithMorphManyFactory::new(),
+            'commentable_type' => PostWithMorphManyFactory::class,
+            'content' => fake()->text(),
+        ];
+    }
+}

src/Laravel/workbench/database/factories/PostFactory.php

@@ -17,7 +17,7 @@
 use Workbench\App\Models\Post;
 
 /**
- * @template TModel of \Workbench\App\Models\Author
+ * @template TModel of \Workbench\App\Models\Post
  *
  * @extends \Illuminate\Database\Eloquent\Factories\Factory<TModel>
  */

src/Laravel/workbench/database/factories/PostWithMorphManyFactory.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Workbench\App\Models\PostWithMorphMany;
+
+/**
+ * @template TModel of \Workbench\App\Models\PostWithMorphMany
+ *
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<TModel>
+ */
+class PostWithMorphManyFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var class-string<TModel>
+     */
+    protected $model = PostWithMorphMany::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'title' => fake()->unique()->sentence(10),
+            'content' => fake()->sentences(10, true),
+        ];
+    }
+}