You are here

public function WishlistCacheContext::getCacheableMetadata in Commerce Wishlist 8.3

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.

Return value

\Drupal\Core\Cache\CacheableMetadata A cacheable metadata object.

Overrides CacheContextInterface::getCacheableMetadata

File

src/Cache/Context/WishlistCacheContext.php, line 61

Class

WishlistCacheContext
Defines the WishlistCacheContext service, for "per wishlist" caching.

Namespace

Drupal\commerce_wishlist\Cache\Context

Code

public function getCacheableMetadata() {
  $metadata = new CacheableMetadata();
  foreach ($this->wishlistProvider
    ->getWishlists($this->account) as $wishlist) {
    $metadata
      ->addCacheableDependency($wishlist);
  }
  return $metadata;
}