IsFrontPathCacheContext
class IsFrontPathCacheContext implements CacheContextInterface (View source)
Defines a cache context for whether the URL is the front page of the site.
Cache context ID: 'url.path.is_front'.
Properties
| protected PathMatcherInterface | $pathMatcher |
Methods
Returns the label of the cache context.
Returns the string representation of the cache context.
Gets the cacheability metadata for the context.
Details
__construct(PathMatcherInterface $path_matcher)
Constructs an IsFrontPathCacheContext object.
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.