SiteCacheContext
class SiteCacheContext extends RequestStackCacheContextBase implements CacheContextInterface (View source)
Defines the SiteCacheContext service, for "per site" caching.
Cache context ID: 'url.site'.
A "site" is defined as the combination of URI scheme, domain name, port and base path. It allows for varying between the same site being accessed via different entry points. (Different sites in a multisite setup have separate databases.) For example: http://example.com and http://www.example.com.
Properties
| protected RequestStack | $requestStack | The request stack. |
from RequestStackCacheContextBase |
Methods
Constructs a new RequestStackCacheContextBase class.
Returns the label of the cache context.
Returns the string representation of the cache context.
Gets the cacheability metadata for the context.
Details
__construct(RequestStack $request_stack)
Constructs a new RequestStackCacheContextBase class.
static string
getLabel()
Returns the label of the cache context.
string
getContext()
Returns the string representation of the cache context.
A cache context service's name is used as a token (placeholder) cache key, and is then replaced with the string returned by this method.
CacheableMetadata
getCacheableMetadata()
Gets the cacheability metadata for the context.
There are three valid cases for the returned CacheableMetadata object:
- An empty object means this can be optimized away safely.
- A max-age of 0 means that this context can never be optimized away. It will never bubble up and cache tags will not be used.
- Any non-zero max-age and cache tags will bubble up into the cache item if this is optimized away to allow for invalidation if the context value changes.