StoreCacheContext.php in Commerce Core 8.2

Namespace

Drupal\commerce_store\Cache\Context

File

modules/store/src/Cache/Context/StoreCacheContext.php

<?php

namespace Drupal\commerce_store\Cache\Context;

use Drupal\commerce_store\CurrentStoreInterface;
use Drupal\Core\Cache\Context\CacheContextInterface;
use Drupal\Core\Cache\CacheableMetadata;

/**
 * Defines the StoreCacheContext service, for "per store" caching.
 *
 * Cache context ID: 'store'.
 */
class StoreCacheContext implements CacheContextInterface {

  /**
   * The current store.
   *
   * @var \Drupal\commerce_store\CurrentStoreInterface
   */
  protected $currentStore;

  /**
   * Constructs a new StoreCacheContext class.
   *
   * @param \Drupal\commerce_store\CurrentStoreInterface $current_store
   *   The current store.
   */
  public function __construct(CurrentStoreInterface $current_store) {
    $this->currentStore = $current_store;
  }

  /**
   * {@inheritdoc}
   */
  public static function getLabel() {
    return t('Store');
  }

  /**
   * {@inheritdoc}
   */
  public function getContext() {
    $store = $this->currentStore
      ->getStore();
    return $store ? $store
      ->id() : '0';
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheableMetadata() {
    return new CacheableMetadata();
  }

}

Classes

Name	Description
StoreCacheContext	Defines the StoreCacheContext service, for "per store" caching.