Laravel replicate(): Duplicate Eloquent Models Safely

Copying Eloquent models in Laravel using the replicate() method can be done safely, but there are some important caveats to consider. The method returns an unsaved copy of the original model, which means that nothing is written to the database until you explicitly call the save() method.

One thing to be aware of is that replicate() automatically skips certain columns when creating the copy. These include the primary key, the created_at and updated_at columns, any columns listed in the uniqueIds() method, and any columns decorated with the #[Refreshes] attribute. In addition, you can pass an array of column names to the replicate() method to explicitly exclude them from being copied.

One potential trap with replicate() is that it can copy unique columns, such as a slug. If the slug already exists in the database, attempting to save the copy will result in a Duplicate entry error. To avoid this issue, you can manually exclude the unique columns or modify their values before saving the copy.

Another trap is that replicate() copies all attribute values, including secrets and counters. If a post has an API token and a view count, duplicating the post using replicate() will result in the new copy having the same token and view count as the original. To avoid this, you should explicitly exclude any sensitive or countable columns from the copy.

Additionally, if you try to duplicate a soft-deleted record using replicate(), the copy will also be soft-deleted, as the deleted_at timestamp is copied as well. To avoid this, you can include the deleted_at column in the list of excluded columns when using replicate() on a trashed record.

Finally, when duplicating records that have related models, such as a post with comments, the copy will only contain the new post without any associated comments. To duplicate the related models as well, you need to replicate each related model explicitly and attach it to the new copy. It is recommended to perform this operation inside a transaction to ensure that all changes are committed together and to avoid any inconsistencies in the database.