A trait that allows you to clone readonly properties in PHP 8.1
This package provides a trait that allows you to clone objects with readonly properties in PHP 8.1. You can read an in-depth explanation as to why this is necessary here.
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You’ll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
You can install the package via composer:
composer require spatie/php-cloneable
In PHP 8.1, readonly properties aren’t allowed to be overridden as soon as they are initialized. That also means that cloning an object and changing one of its readonly properties isn’t allowed. It’s likely that PHP will get some kind of
clone with functionality in the future, but for now you can work around this issue by using this package.
Spatie\Cloneable\Cloneable adds a
with method to whatever class you want to be cloneable, which you can pass one or more parameters. Note that you’re required to use named arguments.
A common practice would be to implement specific
with* methods on the classes themselves:
- This package will skip calling the constructor when cloning an object, meaning any logic in the constructor won’t be executed.
withmethod will do a shallow clone, meaning that nested objects aren’t cloned as well.
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.