Event dispatcher for clone events [#2800203]

Hi guys, I think would be nice if there are some clone events to hook up, it allows not only to make custom modifications, but to third party modules add support to node clone in the D8 way, for example to support Paragraph or Field collection.

I created patch to start working on this feature, please have a look and make you patches/suggestions.

Thanks!

Comment	File	Size	Author
#14	entity_clone-add_pre_and_post_clone_events-2800203-14.patch	7.01 KB	colan
#14	8.x-1.x: PHP 5.6 & MySQL 5.5, D8.4 39 pass PHP 7.1 & MySQL 5.5, D8.4 39 pass PHP 7 & MySQL 5.5, D8.4 39 pass
#13	entity_clone-add_pre_and_post_clone_events-2800203-13.patch	7.12 KB	colan
#13	8.x-1.x: PHP 5.6 & MySQL 5.5, D8.4 39 pass
#13	interdiff-2800203-10-13-do-not-test.diff	1.52 KB	colan
#13
#10	event_dispatcher_for-2800203-10.patch	6.23 KB	vpeltot
#10	8.x-1.x: PHP 5.6 & MySQL 5.5, D8.4 39 pass PHP 7.1 & MySQL 5.5, D8.4 39 pass PHP 7 & MySQL 5.5, D8.4 39 pass
#5	entity_clone-event_dispatcher-2800203-5.patch	8.92 KB	ruloweb
#5	8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 37 pass, 4 fail PHP 5.6 & MySQL 5.5, D8.4 39 pass PHP 7.1 & MySQL 5.5, D8.4 39 pass PHP 7 & MySQL 5.5, D8.4 39 pass
#2	entity_clone-event_dispatcher-2800203-2.patch	5.83 KB	ruloweb
#2	8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 37 pass, 4 fail PHP 5.6 & MySQL 5.5, D8.3 37 pass, 4 fail

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

14 September 2016 at 18:24

ruloweb created an issue. See original summary.

Comment #2

ruloweb CreditAttribution: ruloweb commented 14 September 2016 at 19:11

Status:

Active

» Needs review

File	Size
entity_clone-event_dispatcher-2800203-2.patch	5.83 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 37 pass, 4 fail PHP 5.6 & MySQL 5.5, D8.3 37 pass, 4 fail

Comment #3

14 September 2016 at 19:13

Status:

Needs review

» Needs work

The last submitted patch, 2: entity_clone-event_dispatcher-2800203-2.patch, failed testing.

Comment #4

14 September 2016 at 19:13

The last submitted patch, 2: entity_clone-event_dispatcher-2800203-2.patch, failed testing.

Comment #5

ruloweb CreditAttribution: ruloweb at Media.Monks commented 16 September 2016 at 14:35

Status:

Needs work

» Needs review

File	Size
entity_clone-event_dispatcher-2800203-5.patch	8.92 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 37 pass, 4 fail PHP 5.6 & MySQL 5.5, D8.4 39 pass PHP 7.1 & MySQL 5.5, D8.4 39 pass PHP 7 & MySQL 5.5, D8.4 39 pass

New patch. This one adds 4 events:

PRE_CLONE and POST_CLONE events run inside submitForm() method, before/after cloneEntity() method.

PRE_SAVE and POST_SAVE events run inside cloneEntity() method, before/after save() method. If you create an event subscriber which calls to cloneEntity(), this event turns recursive.

I managed to create a recursive solution for cloning Paragraphs and Field collections with these two last events #2706639-18: Support for sub-entity cloning.

Comment #6

16 September 2016 at 14:17

Status:

Needs review

» Needs work

The last submitted patch, 5: entity_clone-event_dispatcher-2800203-5.patch, failed testing.

Comment #7

16 September 2016 at 14:17

The last submitted patch, 5: entity_clone-event_dispatcher-2800203-5.patch, failed testing.

Comment #8

Erik Frèrejean

Dutch

🏴‍☠️

CreditAttribution: Erik Frèrejean at KennisMeester commented 11 November 2016 at 12:59

I actually was just working on a very similar patch, but going the "hook" way, using hooks very similar to the regular "presave"/"update" hooks. Just applied the patch in #5, which works like a charm. I however only have a need for the PRE_SAVE event, so haven't tested the others.

Comment #9

vpeltot CreditAttribution: vpeltot commented 25 September 2017 at 13:05

I'm OK to add the two PRE_CLONE and POST_CLONE events.
But for the PRE_SAVE and the POST_SAVE I think it's the core responsability to dispatch all entity operations (#2551893: Add events for matching entity hooks)

Rename the Events namespace and directory to Event (to respect all core modules subdirectory definition)

Comment #10

vpeltot CreditAttribution: vpeltot commented 25 September 2017 at 14:02

File	Size
event_dispatcher_for-2800203-10.patch	6.23 KB
8.x-1.x: PHP 5.6 & MySQL 5.5, D8.4 39 pass PHP 7.1 & MySQL 5.5, D8.4 39 pass PHP 7 & MySQL 5.5, D8.4 39 pass

2 files were hidden/shown/deleted

File	Size
entity_clone-event_dispatcher-2800203-2.patch	5.83 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 37 pass, 4 fail PHP 5.6 & MySQL 5.5, D8.3 37 pass, 4 fail
entity_clone-event_dispatcher-2800203-5.patch	8.92 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 37 pass, 4 fail PHP 5.6 & MySQL 5.5, D8.4 39 pass PHP 7.1 & MySQL 5.5, D8.4 39 pass PHP 7 & MySQL 5.5, D8.4 39 pass

Comment #11

vpeltot CreditAttribution: vpeltot commented 25 September 2017 at 14:06

Status:

Needs work

» Needs review

Comment #12

Erik Frèrejean

Dutch

🏴‍☠️

CreditAttribution: Erik Frèrejean at KennisMeester commented 26 September 2017 at 07:12

@vpeltot, with regard to your PRE_SAVE/POST_SAVE comment I agree that these should be emitted by core, however my case (and I'm probably not the only one) I need to perform some changes on the entity pre save but only when a clone is happening. When relying on the core pre save action there is no way AFAIK to recognize that the entity is created from the clone action.

Comment #13

colan

he/him

English

Toronto 🇨🇦

CreditAttribution: colan at Colan Schwartz Consulting commented 2 October 2017 at 21:11

File	Size
interdiff-2800203-10-13-do-not-test.diff	1.52 KB

entity_clone-add_pre_and_post_clone_events-2800203-13.patch	7.12 KB
8.x-1.x: PHP 5.6 & MySQL 5.5, D8.4 39 pass

#12: To handle that, I'm not sure if we should re-add the events or add something to the entity so that we know it's being cloned. Let's commit the other stuff first as we know we definitely need it. Then we can keep talking about this other thing.

I've made the following changes to match the style guidelines:

Used lowerCamelCase on the property name.
Added missing parameter descriptions.

Comment #14

colan

he/him

English

Toronto 🇨🇦

CreditAttribution: colan at Colan Schwartz Consulting commented 3 October 2017 at 15:23

File	Size
entity_clone-add_pre_and_post_clone_events-2800203-14.patch	7.01 KB
8.x-1.x: PHP 5.6 & MySQL 5.5, D8.4 39 pass PHP 7.1 & MySQL 5.5, D8.4 39 pass PHP 7 & MySQL 5.5, D8.4 39 pass

Some of the src/Form/EntityCloneForm.php includes conflict with (and are already handled by) #2908414: Error on abort and redirects - one patch to solve everything so that needs to be applied first. Here's what was changed. I can't run a real interdiff as it doesn't work.

< @@ -5,10 +5,12 @@ namespace Drupal\entity_clone\Form;
<  use Drupal\Core\Entity\EntityTypeManager;
<  use Drupal\Core\Form\FormBase;
---
> @@ -8,7 +8,10 @@ use Drupal\Core\Form\FormBase;
154d151
< -use Drupal\Core\Entity\Entity;

Tests will probably fail until #2908414: Error on abort and redirects - one patch to solve everything is committed.

Comment #15

3 October 2017 at 15:25

Status:

Needs review

» Needs work

The last submitted patch, 14: entity_clone-add_pre_and_post_clone_events-2800203-14.patch, failed testing. View results

Comment #16

colan

he/him

English

Toronto 🇨🇦

CreditAttribution: colan at Colan Schwartz Consulting commented 3 October 2017 at 15:27

Status:

Needs work

» Needs review

Resetting status for humans as we're expecting this to fail for the time being.

Comment #17

4 October 2017 at 05:33

vpeltot committed 7e01336 on 8.x-1.x

Issue #2800203 by colan, ruloweb, vpeltot: Event dispatcher for clone...

Comment #18

vpeltot CreditAttribution: vpeltot commented 4 October 2017 at 05:34

Status:

Needs review

» Fixed

Thanks @all

Comment #19

vpeltot CreditAttribution: vpeltot commented 4 October 2017 at 05:52

Status:

Fixed

» Closed (fixed)

Comment #20

cosmicdreams CreditAttribution: cosmicdreams at Nerdery commented 8 November 2018 at 18:46

So happy to have found this.

Is there any documentation that describes how you can integrate a custom entity into entity clone using these events? Would be great to see a code example of this.