[Translateable] Document the usage of refresh query hint if cache is used #2960
Conversation
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
…latable (doctrine-extensions#1021) If query caching is enabled the TranslationWalker won't be used anymore once the query is cached. Therefore the `Query::HINT_REFRESH` won't be set automatically. This leads to the issue, that once a translateable entity is loaded a second query with another locale won't update the translateable properties in the entity. Adding the `Query::HINT_REFRESH` manually to the query will fix the issue.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This addition to the documentation helps to prevent for running into the issue #1021.
This is the issue in short:
If query caching is enabled the
TranslationWalkerwon't be used anymore once the query is cached. Therefore theQuery::HINT_REFRESH, which is normally set by theTranslationWalker, won't be set automatically.This leads to the issue, that once a translatable entity is loaded a second query with another locale won't update the translatable properties in the entity.
Adding the
Query::HINT_REFRESHmanually to the query will fix the issue.