Skip to content

[SoftDeleteable] Document the $handlePostFlushEvent option #2994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −0
Open

[SoftDeleteable] Document the $handlePostFlushEvent option #2994

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions doc/soft-deleteable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,22 @@ $listener = new SoftDeleteableListener();
$om->getEventManager()->addEventSubscriber($listener);
```

### Removing Soft-Deleted Entities from the Identity Map

When an entity is soft-deleted, it remains managed by Doctrine and can still be queried by its primary key as it stays
in the identity map.
To automatically remove such entities after a flush, enable the `$handlePostFlushEvent` option:

```php
$listener = new SoftDeleteableListener(true);
```

This detaches soft-deleted entities from the identity map but may cause issues if a deleted entity is still referenced
by another managed entity with cascade persist, as later `flush()` calls may treat it as new and attempt to re-insert
it.

Enable this option only if you need deleted entities to be fully detached after flushing.

### Configuring Filters

To automatically filter out soft-deleted records from all queries, you need to register and enable the appropriate filter for your object manager.
Expand Down
Loading