add replicating model event

laravel · Mar 31, 2019 · 7d24f91 · 7d24f91
1 parent a7e91c8
commit 7d24f91
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/src/Illuminate/Database/Eloquent/Concerns/HasEvents.php b/src/Illuminate/Database/Eloquent/Concerns/HasEvents.php
@@ -96,7 +96,7 @@ public function getObservableEvents()
         return array_merge(
             [
                 'retrieved', 'creating', 'created', 'updating', 'updated',
-                'saving', 'saved', 'restoring', 'restored',
+                'saving', 'saved', 'restoring', 'restored', 'replicating',
                 'deleting', 'deleted', 'forceDeleted',
             ],
             $this->observables
@@ -303,6 +303,17 @@ public static function created($callback)
         static::registerModelEvent('created', $callback);
     }
 
+    /**
+     * Register a replicating model event with the dispatcher.
+     *
+     * @param  \Closure|string  $callback
+     * @return void
+     */
+    public static function replicating($callback)
+    {
+        static::registerModelEvent('replicating', $callback);
+    }
+
     /**
      * Register a deleting model event with the dispatcher.
      *

diff --git a/src/Illuminate/Database/Eloquent/Model.php b/src/Illuminate/Database/Eloquent/Model.php
@@ -1175,6 +1175,8 @@ public function replicate(array $except = null)
             $instance->setRawAttributes($attributes);
 
             $instance->setRelations($this->relations);
+
+            $instance->fireModelEvent('replicating', false);
         });
     }
 

diff --git a/tests/Database/DatabaseEloquentModelTest.php b/tests/Database/DatabaseEloquentModelTest.php
@@ -1507,6 +1507,18 @@ public function testReplicateCreatesANewModelInstanceWithSameAttributeValues()
         $this->assertNull($replicated->updated_at);
     }
 
+    public function testReplicatingEventIsFiredWhenReplicatingModel()
+    {
+        $model = new EloquentModelStub;
+
+        $model->setEventDispatcher($events = m::mock(Dispatcher::class));
+        $events->shouldReceive('dispatch')->once()->with('eloquent.replicating: '.get_class($model), m::on(function ($m) use ($model) {
+            return $model->is($m);
+        }));
+
+        $model->replicate();
+    }
+
     public function testIncrementOnExistingModelCallsQueryAndSetsAttribute()
     {
         $model = m::mock(EloquentModelStub::class.'[newQueryWithoutRelationships]');