fix(laravel): visible and hidden fields support (#6538)

* fix(laravel): visible and hidden fields support

* fix test

* fix tests

* fix PHPStan

Author: dunglas

src/Laravel/Eloquent/Metadata/ModelMetadata.php

@@ -264,12 +264,12 @@ private function getColumnDefault(array $column, Model $model): mixed
      */
     private function attributeIsHidden(string $attribute, Model $model): bool
     {
-        if (\count($model->getHidden()) > 0) {
-            return \in_array($attribute, $model->getHidden(), true);
+        if ($visible = $model->getVisible()) {
+            return !\in_array($attribute, $visible, true);
         }
 
-        if (\count($model->getVisible()) > 0) {
-            return !\in_array($attribute, $model->getVisible(), true);
+        if ($hidden = $model->getHidden()) {
+            return \in_array($attribute, $hidden, true);
         }
 
         return false;

src/Laravel/Tests/JsonLdTest.php

@@ -275,4 +275,20 @@ public function testApiDocsRegex(): void
         $response = $this->get('/api/notexists', ['accept' => 'application/ld+json']);
         $response->assertNotFound();
     }
+
+    public function testHidden(): void
+    {
+        $response = $this->get('/api/posts/1/comments/1', ['accept' => 'application/ld+json']);
+        $response->assertStatus(200);
+        $response->assertHeader('content-type', 'application/ld+json; charset=utf-8');
+        $response->assertJsonMissingPath('internalNote');
+    }
+
+    public function testVisible(): void
+    {
+        $response = $this->get('/api/books', ['accept' => 'application/ld+json']);
+        $response->assertStatus(200);
+        $response->assertHeader('content-type', 'application/ld+json; charset=utf-8');
+        $this->assertStringNotContainsString('internalNote', (string) $response->getContent());
+    }
 }

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

@@ -50,7 +50,7 @@ class Comment extends Model
 {
     use HasFactory;
 
-    protected $visible = ['text', 'post'];
+    protected $hidden = ['internal_note'];
 
     public function post(): BelongsTo
     {

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

@@ -37,6 +37,7 @@ public function definition(): array
             'author_id' => AuthorFactory::new(),
             'isbn' => fake()->isbn13(),
             'publication_date' => fake()->optional()->date(),
+            'internal_note' => fake()->text(),
         ];
     }
 }

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

@@ -40,6 +40,7 @@ public function definition(): array
         return [
             'post_id' => PostFactory::new(),
             'text' => fake()->text(),
+            'internal_note' => fake()->optional()->text(),
         ];
     }
 }

src/Laravel/workbench/database/migrations/2023_07_15_231244_create_book_table.php

@@ -32,6 +32,7 @@ public function up(): void
             $table->string('name');
             $table->string('isbn');
             $table->date('publication_date')->nullable();
+            $table->text('internal_note')->nullable();
             $table->integer('author_id')->unsigned();
             $table->foreign('author_id')->references('id')->on('authors');
             $table->timestamps();
@@ -53,6 +54,7 @@ public function up(): void
         Schema::create('comments', function (Blueprint $table): void {
             $table->id();
             $table->text('text');
+            $table->text('internal_note')->nullable();
             $table->integer('post_id')->unsigned();
             $table->foreign('post_id')->references('id')->on('posts');
             $table->timestamps();