Add new mergeVisible, mergeHidden and mergeAppends methods. (#56678)

* Add new mergeVisible, mergeHidden and mergeAppends methods.

* Spelling error

* Style fixes

Author: jonerickson

src/Illuminate/Database/Eloquent/Concerns/HasAttributes.php

@@ -2385,6 +2385,19 @@ public function setAppends(array $appends)
         return $this;
     }
 
+    /**
+     * Merge new appended attributes with existing appended attributes on the model.
+     *
+     * @param  array<string>  $appends
+     * @return $this
+     */
+    public function mergeAppends(array $appends)
+    {
+        $this->appends = array_values(array_unique(array_merge($this->appends, $appends)));
+
+        return $this;
+    }
+
     /**
      * Return whether the accessor attribute has been appended.
      *

src/Illuminate/Database/Eloquent/Concerns/HidesAttributes.php

@@ -41,6 +41,19 @@ public function setHidden(array $hidden)
         return $this;
     }
 
+    /**
+     * Merge new hidden attributes with existing hidden attributes on the model.
+     *
+     * @param  array<string>  $hidden
+     * @return $this
+     */
+    public function mergeHidden(array $hidden)
+    {
+        $this->hidden = array_values(array_unique(array_merge($this->hidden, $hidden)));
+
+        return $this;
+    }
+
     /**
      * Get the visible attributes for the model.
      *
@@ -64,6 +77,19 @@ public function setVisible(array $visible)
         return $this;
     }
 
+    /**
+     * Merge new visible attributes with existing visible attributes on the model.
+     *
+     * @param  array<string>  $visible
+     * @return $this
+     */
+    public function mergeVisible(array $visible)
+    {
+        $this->visible = array_values(array_unique(array_merge($this->visible, $visible)));
+
+        return $this;
+    }
+
     /**
      * Make the given, typically hidden, attributes visible.
      *

tests/Database/DatabaseEloquentModelTest.php

@@ -1495,6 +1495,18 @@ public function testHidden()
         $this->assertArrayNotHasKey('age', $array);
     }
 
+    public function testMergeHiddenMergesHidden()
+    {
+        $model = new EloquentModelHiddenStub;
+
+        $hiddenCount = count($model->getHidden());
+        $this->assertContains('foo', $model->getHidden());
+
+        $model->mergeHidden(['bar']);
+        $this->assertCount($hiddenCount + 1, $model->getHidden());
+        $this->assertContains('bar', $model->getHidden());
+    }
+
     public function testVisible()
     {
         $model = new EloquentModelStub(['name' => 'foo', 'age' => 'bar', 'id' => 'baz']);
@@ -1504,6 +1516,18 @@ public function testVisible()
         $this->assertArrayNotHasKey('age', $array);
     }
 
+    public function testMergeVisibleMergesVisible()
+    {
+        $model = new EloquentModelVisibleStub;
+
+        $visibleCount = count($model->getVisible());
+        $this->assertContains('foo', $model->getVisible());
+
+        $model->mergeVisible(['bar']);
+        $this->assertCount($visibleCount + 1, $model->getVisible());
+        $this->assertContains('bar', $model->getVisible());
+    }
+
     public function testDynamicHidden()
     {
         $model = new EloquentModelDynamicHiddenStub(['name' => 'foo', 'age' => 'bar', 'id' => 'baz']);
@@ -2421,6 +2445,18 @@ public function testAppendingOfAttributes()
         $this->assertEquals([], $model->toArray());
     }
 
+    public function testMergeAppendsMergesAppends()
+    {
+        $model = new EloquentModelAppendsStub;
+
+        $appendsCount = count($model->getAppends());
+        $this->assertEquals(['is_admin', 'camelCased', 'StudlyCased'], $model->getAppends());
+
+        $model->mergeAppends(['bar']);
+        $this->assertCount($appendsCount + 1, $model->getAppends());
+        $this->assertContains('bar', $model->getAppends());
+    }
+
     public function testGetMutatedAttributes()
     {
         $model = new EloquentModelGetMutatorsStub;
@@ -3905,6 +3941,18 @@ public function getHidden()
     }
 }
 
+class EloquentModelVisibleStub extends Model
+{
+    protected $table = 'stub';
+    protected $visible = ['foo'];
+}
+
+class EloquentModelHiddenStub extends Model
+{
+    protected $table = 'stub';
+    protected $hidden = ['foo'];
+}
+
 class EloquentModelDynamicVisibleStub extends Model
 {
     protected $table = 'stub';