myclabs/DeepCopy is a open-source project on GitHub, written primarily in PHP. It has 8.9k stars. Create deep copies (clones) of your objects
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
DeepCopy helps you create deep copies (clones) of your objects. It is designed to handle cycles in the association graph.
Table of Contents
How
Why
Using simply clone
Overriding __clone()
With DeepCopy
How it works
Going further
Matchers
Property name
Specific property
Type
Filters
SetNullFilter
KeepFilter
DoctrineCollectionFilter
DoctrineEmptyCollectionFilter
DoctrineProxyFilter
ReplaceFilter
ShallowCopyFilter
Edge cases
Contributing
Tests
How?
Install with Composer:
composer require myclabs/deep-copy
Use it:
use DeepCopy\DeepCopy;
$copier = new DeepCopy();
$myCopy = $copier->copy($myObject);
Why?
How do you create copies of your objects?
$myCopy = clone $myObject;
How do you create deep copies of your objects (i.e. copying also all the objects referenced in the properties)?
You use __clone() and implement the behavior
yourself.
But how do you handle cycles in the association graph?
Now you're in for a big mess :(
Using simply clone
Overriding __clone()
With DeepCopy
How it works
DeepCopy recursively traverses all the object's properties and clones them. To avoid cloning the same object twice it
keeps a map of source objects to their copies and thus preserves the object graph.
To use it:
use function DeepCopy\deep_copy;
$copy = deep_copy($var);
Alternatively, you can create your own DeepCopy instance to configure it differently for example:
use DeepCopy\DeepCopy;
$copier = new DeepCopy(true);
$copy = $copier->copy($var);
You may want to roll your own deep copy function:
namespace Acme;
use DeepCopy\DeepCopy;
function deep_copy($var)
{
static $copier = null;
if (null === $copier) {
$copier = new DeepCopy(true);
}
return $copier->copy($var);
}
Going further
You can add filters to customize the copy process.
The method to add a filter is DeepCopy\DeepCopy::addFilter($filter, $matcher),
with $filter implementing DeepCopy\Filter\Filter
and $matcher implementing DeepCopy\Matcher\Matcher.
We provide some generic filters and matchers.
Matchers
DeepCopy\Matcher applies on a object attribute.
DeepCopy\TypeMatcher applies on any element found in graph, including array elements.
Property name
The PropertyNameMatcher will match a property by its name:
use DeepCopy\Matcher\PropertyNameMatcher;
// Will apply a filter to any property of any objects named "id"
$matcher = new PropertyNameMatcher('id');
Specific property
The PropertyMatcher will match a specific property of a specific class:
use DeepCopy\Matcher\PropertyMatcher;
// Will apply a filter to the property "id" of any objects of the class "MyClass"
$matcher = new PropertyMatcher('MyClass', 'id');
Type
The TypeMatcher will match any element by its type (instance of a class or any value that could be parameter of
gettype() function):
use DeepCopy\TypeMatcher\TypeMatcher;
// Will apply a filter to any object that is an instance of Doctrine\Common\Collections\Collection
$matcher = new TypeMatcher('Doctrine\Common\Collections\Collection');
Filters
DeepCopy\Filter applies a transformation to the object attribute matched by DeepCopy\Matcher
DeepCopy\TypeFilter applies a transformation to any element matched by DeepCopy\TypeMatcher
By design, matching a filter will stop the chain of filters (i.e. the next ones will not be applied).
Using the (ChainableFilter) won't stop the chain of filters.
SetNullFilter (filter)
Let's say for example that you are copying a database record (or a Doctrine entity), so you want the copy not to have
any ID:
use DeepCopy\DeepCopy;
use DeepCopy\Filter\SetNullFilter;
use DeepCopy\Matcher\PropertyNameMatcher;
$object = MyClass::load(123);
echo $object->id; // 123
$copier = new DeepCopy();
$copier->addFilter(new SetNullFilter(), new PropertyNameMatcher('id'));
$copy = $copier->copy($object);
echo $copy->id; // null
KeepFilter (filter)
If you want a property to remain untouched (for example, an association to an object):
use DeepCopy\DeepCopy;
use DeepCopy\Filter\KeepFilter;
use DeepCopy\Matcher\PropertyMatcher;
$copier = new DeepCopy();
$copier->addFilter(new KeepFilter(), new PropertyMatcher('MyClass', 'category'));
$copy = $copier->copy($object);
// $copy->category has not been touched
ChainableFilter (filter)
If you use cloning on proxy classes, you might want to apply two filters for:
loading the data
applying a transformation
You can use the ChainableFilter as a decorator of the proxy loader filter, which won't stop the chain of filters (i.e.
the next ones may be applied).
use DeepCopy\DeepCopy;
use DeepCopy\Filter\ChainableFilter;
use DeepCopy\Filter\Doctrine\DoctrineProxyFilter;
use DeepCopy\Filter\SetNullFilter;
use DeepCopy\Matcher\Doctrine\DoctrineProxyMatcher;
use DeepCopy\Matcher\PropertyNameMatcher;
$copier = new DeepCopy();
$copier->addFilter(new ChainableFilter(new DoctrineProxyFilter()), new DoctrineProxyMatcher());
$copier->addFilter(new SetNullFilter(), new PropertyNameMatcher('id'));
$copy = $copier->copy($object);
echo $copy->id; // null
DoctrineCollectionFilter (filter)
If you use Doctrine and want to copy an entity, you will need to use the DoctrineCollectionFilter:
use DeepCopy\DeepCopy;
use DeepCopy\Filter\Doctrine\DoctrineCollectionFilter;
use DeepCopy\Matcher\PropertyTypeMatcher;
$copier = new DeepCopy();
$copier->addFilter(new DoctrineCollectionFilter(), new PropertyTypeMatcher('Doctrine\Common\Collections\Collection'));
$copy = $copier->copy($object);
DoctrineEmptyCollectionFilter (filter)
If you use Doctrine and want to copy an entity who contains a Collection that you want to be reset, you can use the
DoctrineEmptyCollectionFilter
use DeepCopy\DeepCopy;
use DeepCopy\Filter\Doctrine\DoctrineEmptyCollectionFilter;
use DeepCopy\Matcher\PropertyMatcher;
$copier = new DeepCopy();
$copier->addFilter(new DoctrineEmptyCollectionFilter(), new PropertyMatcher('MyClass', 'myProperty'));
$copy = $copier->copy($object);
// $copy->myProperty will return an empty collection
DoctrineProxyFilter (filter)
If you use Doctrine and use cloning on lazy loaded entities, you might encounter errors mentioning missing fields on a
Doctrine proxy class (...\__CG__\Proxy).
You can use the DoctrineProxyFilter to load the actual entity behind the Doctrine proxy class.
Make sure, though, to put this as one of your very first filters in the filter chain so that the entity is loaded
before other filters are applied!
We recommend to decorate the DoctrineProxyFilter with the ChainableFilter to allow applying other filters to the
cloned lazy loaded entities.
use DeepCopy\DeepCopy;
use DeepCopy\Filter\Doctrine\DoctrineProxyFilter;
use DeepCopy\Matcher\Doctrine\DoctrineProxyMatcher;
$copier = new DeepCopy();
$copier->addFilter(new ChainableFilter(new DoctrineProxyFilter()), new DoctrineProxyMatcher());
$copy = $copier->copy($object);
// $copy should now contain a clone of all entities, including those that were not yet fully loaded.
ReplaceFilter (type filter)
If you want to replace the value of a property:
use DeepCopy\DeepCopy;
use DeepCopy\Filter\ReplaceFilter;
use DeepCopy\Matcher\PropertyMatcher;
$copier = new DeepCopy();
$callback = function ($currentValue) {
return $currentValue . ' (copy)'
};
$copier->addFilter(new ReplaceFilter($callback), new PropertyMatcher('MyClass', 'title'));
$copy = $copier->copy($object);
// $copy->title will contain the data returned by the callback, e.g. 'The title (copy)'
If you want to replace whole element:
use DeepCopy\DeepCopy;
use DeepCopy\TypeFilter\ReplaceFilter;
use DeepCopy\TypeMatcher\TypeMatcher;
$copier = new DeepCopy();
$callback = function (MyClass $myClass) {
return get_class($myClass);
};
$copier->addTypeFilter(new ReplaceFilter($callback), new TypeMatcher('MyClass'));
$copy = $copier->copy([new MyClass, 'some string', new MyClass]);
// $copy will contain ['MyClass', 'some string', 'MyClass']
The $callback parameter of the ReplaceFilter constructor accepts any PHP callable.
ShallowCopyFilter (type filter)
Stop DeepCopy from recursively copying element, using standard clone instead:
use DeepCopy\DeepCopy;
use DeepCopy\TypeFilter\ShallowCopyFilter;
use DeepCopy\TypeMatcher\TypeMatcher;
use Mockery as m;
$this->deepCopy = new DeepCopy();
$this->deepCopy->addTypeFilter(
new ShallowCopyFilter,
new TypeMatcher(m\MockInterface::class)
);
$myServiceWithMocks = new MyService(m::mock(MyDependency1::class), m::mock(MyDependency2::class));
// All mocks will be just cloned, not deep copied
Edge cases
The following structures cannot be deep-copied with PHP Reflection. As a result they are shallow cloned and filters are
not applied. There is two ways for you to handle them:
Implement your own __clone() method
Use a filter with a type matcher
Contributing
DeepCopy is distributed under the MIT license.
Tests
Running the tests is simple:
vendor/bin/phpunit
Support
Get professional support via the Tidelift Subscription.
No homepage URL was recorded for myclabs/DeepCopy in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
How active is development on myclabs/DeepCopy?
The most recent commit recorded on myclabs/DeepCopy was 3 months ago, based on the GitHub push timestamp. The repository has 107 forks — one of the better signals of community interest.
How many stars does myclabs/DeepCopy have?
myclabs/DeepCopy has 8.9k GitHub stars — refresh the page for the live number, or check github.com/myclabs/DeepCopy. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is myclabs/DeepCopy open source?
Yes — myclabs/DeepCopy ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/myclabs/DeepCopy.
What topics is myclabs/DeepCopy associated with?
GitHub's repository topics for myclabs/DeepCopy: "clone", "clone-deep". TopGit's editorial category is open-source.
Where do I read more about myclabs/DeepCopy?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/myclabs/DeepCopy is the definitive source.
Read full README in the tab above.
Still deciding about DeepCopy?
One click hands the question to an AI along with this page — see what it says about DeepCopy.