-
Notifications
You must be signed in to change notification settings - Fork 82
Added mention about the date filters and HTTP cache #2989
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
Open
mnocon
wants to merge
2
commits into
5.0
Choose a base branch
from
date-twig-filters
base: 5.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -25,3 +25,33 @@ The filters also accept an optional `timezone` parameter for displaying date and | |||||
| ``` html+twig | ||||||
| {{ content.contentInfo.publishedDate|ibexa_short_datetime('PST') }} | ||||||
| ``` | ||||||
|
|
||||||
| ## Considerations for usage outside back office | ||||||
|
|
||||||
| The filters rely on user preferences. | ||||||
| When the preferences are not set, for example for logged out users, the filters fallback to a default date format. | ||||||
|
Contributor
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.
Suggested change
|
||||||
| In case of some filters, the fallback date format contains locale-aware fragments, for example: full name of the month or day. | ||||||
|
Contributor
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.
Suggested change
|
||||||
| When combined with [reverse proxies like Varnish or Fastly](http_cache.md), it's possible to cache a localized version of a date and display it to other users, even if they're not using the same locale. | ||||||
|
|
||||||
| Consider these alternatives: | ||||||
|
|
||||||
| - Use Twig's built-in `date` filter with a fixed, locale-independent format | ||||||
|
|
||||||
| ``` html+twig | ||||||
| {{ content.contentInfo.publishedDate|date('Y-m-d H:i:s') }} | ||||||
| ``` | ||||||
|
|
||||||
| - Use ESI for dynamic rendering of the date | ||||||
|
|
||||||
| ``` html+twig | ||||||
| {{ render_esi(controller('App\\Controller\\CustomDateController::format', { | ||||||
| 'date': content.contentInfo.publishedDate | ||||||
| })) }} | ||||||
| ``` | ||||||
|
|
||||||
| Don't cache the ESI response. | ||||||
| By implementing this solution, you can keep the date format locale-aware. | ||||||
|
|
||||||
| - Client-side JavaScript formatting | ||||||
|
|
||||||
| For more information, see [HTTP Cache](http_cache.md) and [Delivering personalized responses](context_aware_cache.md#personalize-responses). | ||||||
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.
Sounds better IMO