fix(laravel): eloquent accessors (#6668)

Author: soyuka

src/Laravel/Eloquent/Metadata/Factory/Property/EloquentPropertyMetadataFactory.php

@@ -77,7 +77,7 @@ public function create(string $resourceClass, string $property, array $options =
                 'collection', 'encrypted:collection' => new Type(Type::BUILTIN_TYPE_ITERABLE, $p['nullable'], Collection::class, true),
                 'encrypted:array' => new Type(Type::BUILTIN_TYPE_ARRAY, $p['nullable']),
                 'encrypted:object' => new Type(Type::BUILTIN_TYPE_OBJECT, $p['nullable']),
-                default => new Type(\in_array($builtinType, Type::$builtinTypes, true) ? $builtinType : Type::BUILTIN_TYPE_STRING, $p['nullable']),
+                default => new Type(\in_array($builtinType, Type::$builtinTypes, true) ? $builtinType : Type::BUILTIN_TYPE_STRING, $p['nullable'] ?? true),
             };
 
             return $propertyMetadata

src/Laravel/Eloquent/Metadata/Factory/Property/EloquentPropertyNameCollectionMetadataFactory.php

@@ -53,7 +53,7 @@ public function create(string $resourceClass, array $options = []): PropertyName
 
         // When it's an Eloquent model we read attributes from database (@see ShowModelCommand)
         foreach ($this->modelMetadata->getAttributes($model) as $property) {
-            if (!$property['primary'] && $property['hidden']) {
+            if (!($property['primary'] ?? null) && $property['hidden']) {
                 continue;
             }
 

src/Laravel/Tests/EloquentTest.php

@@ -368,4 +368,10 @@ public function testWrongOrderFilter(): void
         $res = $this->get('/api/authors?order[name]=something', ['Accept' => ['application/ld+json']]);
         $this->assertEquals($res->getStatusCode(), 422);
     }
+
+    public function testWithAccessor(): void
+    {
+        $res = $this->get('/api/with_accessors/1', ['Accept' => ['application/ld+json']]);
+        $this->assertArraySubset(['name' => 'test'], $res->json());
+    }
 }

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

@@ -0,0 +1,34 @@
+<?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\Models;
+
+use ApiPlatform\Metadata\ApiResource;
+use Illuminate\Database\Eloquent\Casts\Attribute;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+#[ApiResource]
+class WithAccessor extends Model
+{
+    use HasFactory;
+
+    protected $hidden = ['created_at', 'updated_at', 'id'];
+
+    protected function name(): Attribute
+    {
+        return Attribute::make(
+            get: fn (string $value) => 'test',
+        );
+    }
+}

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

@@ -0,0 +1,44 @@
+<?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\Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Workbench\App\Models\WithAccessor;
+
+/**
+ * @template TModel of \Workbench\App\Models\WithAccessor
+ *
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<TModel>
+ */
+class WithAccessorFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var class-string<TModel>
+     */
+    protected $model = WithAccessor::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'name' => strtolower(fake()->name()),
+        ];
+    }
+}

src/Laravel/workbench/database/migrations/2024_09_24_065934_create_with_accessors_table.php

@@ -0,0 +1,38 @@
+<?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);
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('with_accessors', function (Blueprint $table): void {
+            $table->id();
+            $table->string('name');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('with_accessors');
+    }
+};

src/Laravel/workbench/database/seeders/DatabaseSeeder.php

@@ -20,6 +20,7 @@
 use Workbench\Database\Factories\PostFactory;
 use Workbench\Database\Factories\SluggableFactory;
 use Workbench\Database\Factories\UserFactory;
+use Workbench\Database\Factories\WithAccessorFactory;
 
 class DatabaseSeeder extends Seeder
 {
@@ -32,5 +33,6 @@ public function run(): void
         PostFactory::new()->has(CommentFactory::new()->count(10))->count(10)->create();
         SluggableFactory::new()->count(10)->create();
         UserFactory::new()->create();
+        WithAccessorFactory::new()->create();
     }
 }