Issue #2901230: Rename StoreContext to CurrentStore

Author: bojanz

modules/cart/src/Form/AddToCartForm.php

@@ -8,7 +8,7 @@
 use Drupal\commerce_cart\CartProviderInterface;
 use Drupal\commerce_order\Resolver\OrderTypeResolverInterface;
 use Drupal\commerce_price\Resolver\ChainPriceResolverInterface;
-use Drupal\commerce_store\StoreContextInterface;
+use Drupal\commerce_store\CurrentStoreInterface;
 use Drupal\Component\Datetime\TimeInterface;
 use Drupal\Core\Entity\ContentEntityForm;
 use Drupal\Core\Entity\EntityInterface;
@@ -46,11 +46,11 @@ class AddToCartForm extends ContentEntityForm implements AddToCartFormInterface
   protected $orderTypeResolver;
 
   /**
-   * The store context.
+   * The current store.
    *
-   * @var \Drupal\commerce_store\StoreContextInterface
+   * @var \Drupal\commerce_store\CurrentStoreInterface
    */
-  protected $storeContext;
+  protected $currentStore;
 
   /**
    * The chain base price resolver.
@@ -88,20 +88,20 @@ class AddToCartForm extends ContentEntityForm implements AddToCartFormInterface
    *   The cart provider.
    * @param \Drupal\commerce_order\Resolver\OrderTypeResolverInterface $order_type_resolver
    *   The order type resolver.
-   * @param \Drupal\commerce_store\StoreContextInterface $store_context
-   *   The store context.
+   * @param \Drupal\commerce_store\CurrentStoreInterface $current_store
+   *   The current store.
    * @param \Drupal\commerce_price\Resolver\ChainPriceResolverInterface $chain_price_resolver
    *   The chain base price resolver.
    * @param \Drupal\Core\Session\AccountInterface $current_user
    *   The current user.
    */
-  public function __construct(EntityManagerInterface $entity_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info, TimeInterface $time, CartManagerInterface $cart_manager, CartProviderInterface $cart_provider, OrderTypeResolverInterface $order_type_resolver, StoreContextInterface $store_context, ChainPriceResolverInterface $chain_price_resolver, AccountInterface $current_user) {
+  public function __construct(EntityManagerInterface $entity_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info, TimeInterface $time, CartManagerInterface $cart_manager, CartProviderInterface $cart_provider, OrderTypeResolverInterface $order_type_resolver, CurrentStoreInterface $current_store, ChainPriceResolverInterface $chain_price_resolver, AccountInterface $current_user) {
     parent::__construct($entity_manager, $entity_type_bundle_info, $time);
 
     $this->cartManager = $cart_manager;
     $this->cartProvider = $cart_provider;
     $this->orderTypeResolver = $order_type_resolver;
-    $this->storeContext = $store_context;
+    $this->currentStore = $current_store;
     $this->chainPriceResolver = $chain_price_resolver;
     $this->currentUser = $current_user;
   }
@@ -117,7 +117,7 @@ public static function create(ContainerInterface $container) {
       $container->get('commerce_cart.cart_manager'),
       $container->get('commerce_cart.cart_provider'),
       $container->get('commerce_order.chain_order_type_resolver'),
-      $container->get('commerce_store.store_context'),
+      $container->get('commerce_store.current_store'),
       $container->get('commerce_price.chain_price_resolver'),
       $container->get('current_user')
     );
@@ -261,7 +261,7 @@ protected function selectStore(PurchasableEntityInterface $entity) {
       throw new \Exception('The given entity is not assigned to any store.');
     }
     else {
-      $store = $this->storeContext->getStore();
+      $store = $this->currentStore->getStore();
       if (!in_array($store, $stores)) {
         // Indicates that the site listings are not filtered properly.
         throw new \Exception("The given entity can't be purchased from the current store.");

modules/price/src/Plugin/Field/FieldFormatter/PriceCalculatedFormatter.php

@@ -6,7 +6,7 @@
 use Drupal\commerce\PurchasableEntityInterface;
 use Drupal\commerce_price\NumberFormatterFactoryInterface;
 use Drupal\commerce_price\Resolver\ChainPriceResolverInterface;
-use Drupal\commerce_store\StoreContextInterface;
+use Drupal\commerce_store\CurrentStoreInterface;
 use Drupal\Core\Cache\Cache;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Field\FieldDefinitionInterface;
@@ -51,11 +51,11 @@ class PriceCalculatedFormatter extends PriceDefaultFormatter implements Containe
   protected $currentUser;
 
   /**
-   * The store context.
+   * The current store.
    *
-   * @var \Drupal\commerce_store\StoreContextInterface
+   * @var \Drupal\commerce_store\CurrentStoreInterface
    */
-  protected $storeContext;
+  protected $currentStore;
 
   /**
    * Constructs a new PriceCalculatedFormatter object.
@@ -80,16 +80,16 @@ class PriceCalculatedFormatter extends PriceDefaultFormatter implements Containe
    *   The number formatter factory.
    * @param \Drupal\commerce_price\Resolver\ChainPriceResolverInterface $chain_price_resolver
    *   The chain price resolver.
-   * @param \Drupal\commerce_store\StoreContextInterface $store_context
-   *   The store context.
+   * @param \Drupal\commerce_store\CurrentStoreInterface $current_store
+   *   The current store.
    * @param \Drupal\Core\Session\AccountInterface $current_user
    *   The current user.
    */
-  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityTypeManagerInterface $entity_type_manager, NumberFormatterFactoryInterface $number_formatter_factory, ChainPriceResolverInterface $chain_price_resolver, StoreContextInterface $store_context, AccountInterface $current_user) {
+  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityTypeManagerInterface $entity_type_manager, NumberFormatterFactoryInterface $number_formatter_factory, ChainPriceResolverInterface $chain_price_resolver, CurrentStoreInterface $current_store, AccountInterface $current_user) {
     parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $entity_type_manager, $number_formatter_factory);
 
     $this->chainPriceResolver = $chain_price_resolver;
-    $this->storeContext = $store_context;
+    $this->currentStore = $current_store;
     $this->currencyStorage = $entity_type_manager->getStorage('commerce_currency');
     $this->currentUser = $current_user;
   }
@@ -109,7 +109,7 @@ public static function create(ContainerInterface $container, array $configuratio
       $container->get('entity_type.manager'),
       $container->get('commerce_price.number_formatter_factory'),
       $container->get('commerce_price.chain_price_resolver'),
-      $container->get('commerce_store.store_context'),
+      $container->get('commerce_store.current_store'),
       $container->get('current_user')
     );
   }
@@ -118,8 +118,7 @@ public static function create(ContainerInterface $container, array $configuratio
    * {@inheritdoc}
    */
   public function viewElements(FieldItemListInterface $items, $langcode) {
-    $store = $this->storeContext->getStore();
-    $context = new Context($this->currentUser, $store);
+    $context = new Context($this->currentUser, $this->currentStore->getStore());
     $elements = [];
     /** @var \Drupal\commerce_price\Plugin\Field\FieldType\PriceItem $item */
     foreach ($items as $delta => $item) {

modules/store/commerce_store.services.yml

@@ -1,6 +1,6 @@
 services:
-  commerce_store.store_context:
-    class: Drupal\commerce_store\StoreContext
+  commerce_store.current_store:
+    class: Drupal\commerce_store\CurrentStore
     arguments: ['@request_stack', '@commerce_store.chain_store_resolver']
 
   commerce_store.chain_store_resolver:
@@ -16,12 +16,12 @@ services:
 
   commerce_store.store_country_resolver:
     class: Drupal\commerce_store\Resolver\StoreCountryResolver
-    arguments: ['@commerce_store.store_context']
+    arguments: ['@commerce_store.current_store']
     tags:
       - { name: commerce.country_resolver, priority: -90 }
 
   cache_context.store:
     class: Drupal\commerce_store\Cache\Context\StoreCacheContext
-    arguments: ['@commerce_store.store_context']
+    arguments: ['@commerce_store.current_store']
     tags:
       - { name: cache.context}

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

@@ -2,7 +2,7 @@
 
 namespace Drupal\commerce_store\Cache\Context;
 
-use Drupal\commerce_store\StoreContextInterface;
+use Drupal\commerce_store\CurrentStoreInterface;
 use Drupal\Core\Cache\Context\CacheContextInterface;
 use Drupal\Core\Cache\CacheableMetadata;
 
@@ -14,20 +14,20 @@
 class StoreCacheContext implements CacheContextInterface {
 
   /**
-   * The store context.
+   * The current store.
    *
-   * @var \Drupal\commerce_store\StoreContextInterface
+   * @var \Drupal\commerce_store\CurrentStoreInterface
    */
-  protected $storeContext;
+  protected $currentStore;
 
   /**
    * Constructs a new StoreCacheContext class.
    *
-   * @param \Drupal\commerce_store\StoreContextInterface $context
-   *   The store context.
+   * @param \Drupal\commerce_store\CurrentStoreInterface $current_store
+   *   The current store.
    */
-  public function __construct(StoreContextInterface $context) {
-    $this->storeContext = $context;
+  public function __construct(CurrentStoreInterface $current_store) {
+    $this->currentStore = $current_store;
   }
 
   /**
@@ -41,7 +41,7 @@ public static function getLabel() {
    * {@inheritdoc}
    */
   public function getContext() {
-    return $this->storeContext->getStore()->id();
+    return $this->currentStore->getStore()->id();
   }
 
   /**

modules/store/src/StoreContext.php renamed to modules/store/src/CurrentStore.php

@@ -6,7 +6,7 @@
 use Symfony\Component\HttpFoundation\RequestStack;
 
 /**
- * Holds a reference to the active store, resolved on demand.
+ * Holds a reference to the current store, resolved on demand.
  *
  * The ChainStoreResolver runs the registered store resolvers one by one until
  * one of them returns the store.
@@ -19,7 +19,7 @@
  * @see \Drupal\commerce_store\Resolver\ChainStoreResolver
  * @see \Drupal\commerce_store\Resolver\DefaultStoreResolver
  */
-class StoreContext implements StoreContextInterface {
+class CurrentStore implements CurrentStoreInterface {
 
   /**
    * The request stack.
@@ -43,7 +43,7 @@ class StoreContext implements StoreContextInterface {
   protected $stores;
 
   /**
-   * Constructs a new StoreContext object.
+   * Constructs a new CurrentStore object.
    *
    * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
    *   The request stack.

modules/store/src/StoreContextInterface.php renamed to modules/store/src/CurrentStoreInterface.php

@@ -4,10 +4,8 @@
 
 /**
  * Holds a reference to the active store, resolved on demand.
- *
- * @see \Drupal\commerce_store\StoreContext
  */
-interface StoreContextInterface {
+interface CurrentStoreInterface {
 
   /**
    * Gets the active store for the current request.

modules/store/src/Plugin/views/argument_default/ActiveStore.php

@@ -2,7 +2,7 @@
 
 namespace Drupal\commerce_store\Plugin\views\argument_default;
 
-use Drupal\commerce_store\StoreContextInterface;
+use Drupal\commerce_store\CurrentStoreInterface;
 use Drupal\Core\Cache\Cache;
 use Drupal\Core\Cache\CacheableDependencyInterface;
 use Drupal\views\Plugin\views\argument_default\ArgumentDefaultPluginBase;
@@ -19,11 +19,11 @@
 class ActiveStore extends ArgumentDefaultPluginBase implements CacheableDependencyInterface {
 
   /**
-   * The store context.
+   * The current store.
    *
-   * @var \Drupal\commerce_store\StoreContextInterface
+   * @var \Drupal\commerce_store\CurrentStoreInterface
    */
-  protected $storeContext;
+  protected $currentStore;
 
   /**
    * Constructs a PluginBase object.
@@ -34,12 +34,13 @@ class ActiveStore extends ArgumentDefaultPluginBase implements CacheableDependen
    *   The plugin_id for the plugin instance.
    * @param mixed $plugin_definition
    *   The plugin implementation definition.
-   * @param \Drupal\commerce_store\StoreContextInterface $store_context
-   *   The store context.
+   * @param \Drupal\commerce_store\CurrentStoreInterface $current_store
+   *   The current store.
    */
-  public function __construct(array $configuration, $plugin_id, $plugin_definition, StoreContextInterface $store_context) {
+  public function __construct(array $configuration, $plugin_id, $plugin_definition, CurrentStoreInterface $current_store) {
     parent::__construct($configuration, $plugin_id, $plugin_definition);
-    $this->storeContext = $store_context;
+
+    $this->currentStore = $current_store;
   }
 
   /**
@@ -50,15 +51,15 @@ public static function create(ContainerInterface $container, array $configuratio
       $configuration,
       $plugin_id,
       $plugin_definition,
-      $container->get('commerce_store.store_context')
+      $container->get('commerce_store.current_store')
     );
   }
 
   /**
    * {@inheritdoc}
    */
   public function getArgument() {
-    return $this->storeContext->getStore()->id();
+    return $this->currentStore->getStore()->id();
   }
 
   /**
@@ -79,7 +80,7 @@ public function getCacheContexts() {
    * {@inheritdoc}
    */
   public function getCacheTags() {
-    return $this->storeContext->getStore()->getCacheTags();
+    return $this->currentStore->getStore()->getCacheTags();
   }
 
 }

modules/store/src/Resolver/StoreCountryResolver.php

@@ -4,7 +4,7 @@
 
 use Drupal\commerce\Country;
 use Drupal\commerce\Resolver\CountryResolverInterface;
-use Drupal\commerce_store\StoreContextInterface;
+use Drupal\commerce_store\CurrentStoreInterface;
 
 /**
  * Returns the store's billing country.
@@ -20,27 +20,27 @@
 class StoreCountryResolver implements CountryResolverInterface {
 
   /**
-   * The store context.
+   * The current store.
    *
-   * @var \Drupal\commerce_store\StoreContextInterface
+   * @var \Drupal\commerce_store\CurrentStoreInterface
    */
-  protected $storeContext;
+  protected $currentStore;
 
   /**
    * Constructs a new StoreCountryResolver object.
    *
-   * @param \Drupal\commerce_store\StoreContextInterface $store_context
-   *   The store context.
+   * @param \Drupal\commerce_store\CurrentStoreInterface $current_store
+   *   The current store.
    */
-  public function __construct(StoreContextInterface $store_context) {
-    $this->storeContext = $store_context;
+  public function __construct(CurrentStoreInterface $current_store) {
+    $this->currentStore = $current_store;
   }
 
   /**
    * {@inheritdoc}
    */
   public function resolve() {
-    $store = $this->storeContext->getStore();
+    $store = $this->currentStore->getStore();
     if ($store) {
       return new Country($store->getAddress()->getCountryCode());
     }