1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Cache
  7. \
  8. CacheableResponseInterface

CacheableResponseInterface

interface CacheableResponseInterface (View source)

Defines an interface for responses that can expose cacheability metadata.

Methods

$this
addCacheableDependency(CacheableDependencyInterface|mixed $dependency)

Adds a dependency on an object: merges its cacheability metadata.

CacheableMetadata
getCacheableMetadata()

Returns the cacheability metadata for this response.

Details

at line 28
$this addCacheableDependency(CacheableDependencyInterface|mixed $dependency)

Adds a dependency on an object: merges its cacheability metadata.

For instance, when a response depends on some configuration, an entity, or an access result, we must make sure their cacheability metadata is present on the response. This method makes doing that simple.

Parameters

CacheableDependencyInterface|mixed $dependency

The dependency. If the object implements CacheableDependencyInterface, then its cacheability metadata will be used. Otherwise, the passed in object must be assumed to be uncacheable, so max-age 0 is set.

Return Value

$this

See also

CacheableMetadata::createFromObject

at line 35
CacheableMetadata getCacheableMetadata()

Returns the cacheability metadata for this response.

Return Value

CacheableMetadata