riesenia / cakephp-duplicatable
CakePHP ORM plugin for duplicating entities (including related entities)
Installs: 290 170
Dependents: 4
Suggesters: 0
Security: 0
Stars: 52
Watchers: 9
Forks: 19
Open Issues: 5
Type:cakephp-plugin
Requires
- cakephp/orm: ^5.0
Requires (Dev)
- cakephp/cakephp: ^5.0
- cakephp/cakephp-codesniffer: ^5.0
- phpunit/phpunit: ^10.1
README
This plugin contains a behavior that handles duplicating entities including related data.
Installation
Using composer
composer require riesenia/cakephp-duplicatable
Load plugin using
bin/cake plugin load Duplicatable
Usage
This behavior provides multiple methods for your Table
objects.
Method duplicate
This behavior provides a duplicate
method for the table. It takes the primary key of the record to duplicate as its only argument.
Using this method will clone the record defined by the primary key provided as well as all related records as defined in the configuration.
Method duplicateEntity
This behavior provides a duplicateEntity
method for the table. It mainly acts as the duplicate
method except it does not save the duplicated record but returns the Entity to be saved instead. This is useful if you need to manipulate the Entity before saving it.
Configuration options:
- finder - finder to use to get entities. Set it to "translations" to fetch and duplicate translations, too. Defaults to "all". It is possible to set an array for more finders.
- contain - set related entities that will be duplicated
- remove - fields that will be removed from the entity
- set - fields that will be set to provide value or callable to modify the value. If you provide a callable, it will take the entity being cloned as the only argument
- prepend - fields that will have value prepended by the provided text
- append - fields that will have value appended by provided text
- saveOptions - options for save on primary table
- preserveJoinData - if
_joinData
property inBelongsToMany
relations should be preserved - defaults tofalse
due to tricky nature of this association
Examples
class InvoicesTable extends Table { public function initialize(array $config): void { parent::initialize($config); // add Duplicatable behavior $this->addBehavior('Duplicatable.Duplicatable', [ // table finder 'finder' => 'all', // duplicate also items and their properties 'contain' => ['InvoiceItems.InvoiceItemProperties'], // remove created field from both invoice and items 'remove' => ['created', 'invoice_items.created'], // mark invoice as copied 'set' => [ 'name' => function($entity) { return md5($entity->name) . ' ' . $entity->name; }, 'copied' => true ], // prepend properties name 'prepend' => ['invoice_items.invoice_items_properties.name' => 'NEW '], // append copy to the name 'append' => ['name' => ' - copy'] ]); // associations (InvoiceItems table hasMany InvoiceItemProperties) $this->hasMany('InvoiceItems', [ 'foreignKey' => 'invoice_id', 'className' => 'InvoiceItems' ]); } } // ... somewhere in the controller $this->Invoices->duplicate(4);
Sometimes you need to access the original entity, e.g. for setting an ancestor/parent id reference.
In this case you can leverage the $original
entity being passed in as 2nd argument:
'set' => [ 'ancestor_id' => function ($entity, $original) { return $original->id; }, ],