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.

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

Change table to defination list #1724

Merged
merged 1 commit into from
Feb 23, 2022
Merged

Change table to defination list #1724

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
28 changes: 18 additions & 10 deletions Documentation/ApiOverview/CachingFramework/Index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,16 +78,24 @@ This both adds an additional layer for validating slugs as well as reduces the p
Various configuration options exist to configure the `cHash` behavior via :php:`$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']`
in the file :file:`LocalConfiguration.php` or :file:`AdditionalConfiguration.php`:

================================== ====================================================================================================================================================================
Option Description
================================== ====================================================================================================================================================================
cachedParametersWhiteList Only the given parameters will be evaluated in the cHash calculation. Example: tx_news_pi1[uid]
requireCacheHashPresenceParameters Configure Parameters that require a cHash. If no cHash is given but one of the parameters are set, then TYPO3 triggers the configured cHash Error behavior
excludedParameters The given parameters will be ignored in the cHash calculation. Example: L,tx_search_pi1[query]
excludedParametersIfEmpty Configure Parameters only being relevant for the cHash if there's an associated value available. Set excludeAllEmptyParameters to true to skip all empty parameters.
excludeAllEmptyParameters If true, all parameters which are relevant for cHash are only considered if they are non-empty.
================================== ====================================================================================================================================================================

:confval:`cachedParametersWhiteList`
Only the given parameters will be evaluated in the cHash calculation.
Example: tx_news_pi1[uid]

:confval:`requireCacheHashPresenceParameters`
Configure Parameters that require a cHash. If no cHash is given but one of the parameters
are set, then TYPO3 triggers the configured cHash Error behavior

:confval:`excludedParameters`
The given parameters will be ignored in the cHash calculation. Example: L,tx_search_pi1[query]

:confval:`excludedParametersIfEmpty`
Configure Parameters only being relevant for the cHash if there's an associated value available.
Set excludeAllEmptyParameters to true to skip all empty parameters.

:confval:`excludeAllEmptyParameters`
If true, all parameters which are relevant for cHash are only considered if they are non-empty.

All properties can be configured with an array of values. Besides exact matches (*equals*) it is possible to apply partial matches at
the beginning of a parameter (*startsWith*) or inline occurrences (*contains*).

Expand Down