Skip to content
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.

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

Overview table for events #9039

Merged
merged 5 commits into from
Oct 14, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/en/reference/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,42 @@ Now you can test the ``$eventSubscriber`` instance to see if the
echo 'pre foo invoked!';
}

Events Overview
---------------

+-----------------------------+-----------------------+-----------+
| Event | Dispatched by | Lifecycle |
| | | Callback |
+=============================+=======================+===========+
| ``preRemove`` | ``$em->remove()`` | Yes |
+-----------------------------+-----------------------+-----------+
| ``postRemove`` | ``$em->flush()`` | Yes |
+-----------------------------+-----------------------+-----------+
| ``prePersist`` | ``$em->persist()`` | Yes |
| | on *initial* persist | |
+-----------------------------+-----------------------+-----------+
| ``postPersist`` | ``$em->flush()`` | Yes |
+-----------------------------+-----------------------+-----------+
| ``preUpdate`` | ``$em->flush()`` | Yes |
+-----------------------------+-----------------------+-----------+
| ``postUpdate`` | ``$em->flush()`` | Yes |
+-----------------------------+-----------------------+-----------+
| ``postLoad`` | Loading from database | Yes |
+-----------------------------+-----------------------+-----------+
| ``loadClassMetadata`` | Loading of mapping | No |
| | metadata | |
+-----------------------------+-----------------------+-----------+
| ``onClassMetadataNotFound`` | ``MappingException`` | No |
+-----------------------------+-----------------------+-----------+
| ``preFlush`` | ``$em->flush()`` | Yes |
+-----------------------------+-----------------------+-----------+
| ``onFlush`` | ``$em->flush()`` | No |
+-----------------------------+-----------------------+-----------+
| ``postFlush`` | ``$em->flush()`` | No |
+-----------------------------+-----------------------+-----------+
| ``onClear`` | ``$em->clear()`` | No |
+-----------------------------+-----------------------+-----------+

Naming convention
~~~~~~~~~~~~~~~~~

Expand Down