-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Mention lazy loading for Doctrine event listeners #8080
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
Closed
Closed
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -214,5 +214,60 @@ interface and have an event method for each event it subscribes to:: | |
|
||
For a full reference, see chapter `The Event System`_ in the Doctrine documentation. | ||
|
||
Lazy loading for Event Listeners | ||
-------------------------------- | ||
|
||
One subtle difference between listeners and subscribers is that Symfony can load | ||
entity listeners lazily. This means that your listener class will only be fetched | ||
from the service container (and thus be instantiated) once the event it is linked | ||
to actually fires. | ||
|
||
Lazy loading might give you a slight performance improvement when your listener | ||
runs for events that rarely fire. Also, it can help you when you run into | ||
*circular dependency issues* that may occur when your listener service in turn | ||
depends on the DBAL connection. | ||
|
||
To mark a listener service as lazily loaded, just add the ``lazy`` attribute | ||
to the tag like so: | ||
|
||
.. configuration-block:: | ||
|
||
.. code-block:: yaml | ||
|
||
services: | ||
my.listener: | ||
class: AppBundle\EventListener\SearchIndexer | ||
tags: | ||
- { name: doctrine.event_listener, event: postPersist, lazy: true } | ||
|
||
.. code-block:: xml | ||
|
||
<?xml version="1.0" ?> | ||
<container xmlns="http://symfony.com/schema/dic/services" | ||
xmlns:doctrine="http://symfony.com/schema/dic/doctrine"> | ||
|
||
<services> | ||
<service id="my.listener" class="AppBundle\EventListener\SearchIndexer"> | ||
<tag name="doctrine.event_listener" event="postPersist" lazy="true" /> | ||
</service> | ||
</services> | ||
</container> | ||
|
||
.. code-block:: php | ||
|
||
use AppBundle\EventListener\SearchIndexer; | ||
use AppBundle\EventListener\SearchIndexer2; | ||
use AppBundle\EventListener\SearchIndexerSubscriber; | ||
|
||
$container | ||
->register('my.listener', SearchIndexer::class) | ||
->addTag('doctrine.event_listener', array('event' => 'postPersist', 'lazy' => 'true')) | ||
; | ||
|
||
.. note:: | ||
|
||
Marking an event listener as ``lazy`` has nothing to do with lazy serivce | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Typo |
||
definitions which are described :doc:`in their own section </service_container/lazy_services>` | ||
|
||
.. _`The Event System`: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html | ||
.. _`the Doctrine Documentation`: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html#entity-listeners |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems there's no need for those two last use statements.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@HeahDude Removed