Defines a generic class for passing cacheability metadata.
Hierarchy
- class \Drupal\Core\Cache\CacheableMetadata implements RefinableCacheableDependencyInterface uses RefinableCacheableDependencyTrait
Related topics
- Cache API
- Information about the Drupal Cache API
File
- core/lib/Drupal/Core/Cache/CacheableMetadata.php, line 10
Namespace
Drupal\Core\Cache
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| CacheableMetadata::applyTo | public | function | Applies the values of this CacheableMetadata object to a render array. |
| CacheableMetadata::createFromObject | public static | function | Creates a CacheableMetadata object from a depended object. |
| CacheableMetadata::createFromRenderArray | public static | function | Creates a CacheableMetadata object with values taken from a render array. |
| CacheableMetadata::getCacheContexts | public | function | The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts |
| CacheableMetadata::getCacheMaxAge | public | function | The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge |
| CacheableMetadata::getCacheTags | public | function | The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags |
| CacheableMetadata::merge | public | function | Merges the values of another CacheableMetadata object with this one. |
| CacheableMetadata::setCacheContexts | public | function | Sets cache contexts. |
| CacheableMetadata::setCacheMaxAge | public | function | Sets the maximum age (in seconds). |
| CacheableMetadata::setCacheTags | public | function | Sets cache tags. |
| RefinableCacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. |
| RefinableCacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. |
| RefinableCacheableDependencyTrait::$cacheTags | protected | property | Cache tags. |
| RefinableCacheableDependencyTrait::addCacheableDependency | public | function | Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency |
| RefinableCacheableDependencyTrait::addCacheContexts | public | function | Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts |
| RefinableCacheableDependencyTrait::addCacheTags | public | function | Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags |
| RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge |
Please login to continue.