vendor/shopware/core/System/SalesChannel/BaseContext.php line 81

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\SalesChannel;
  5. use Shopware\Core\Checkout\Cart\Delivery\Struct\ShippingLocation;
  6. use Shopware\Core\Checkout\Customer\Aggregate\CustomerGroup\CustomerGroupEntity;
  7. use Shopware\Core\Checkout\Payment\PaymentMethodEntity;
  8. use Shopware\Core\Checkout\Shipping\ShippingMethodEntity;
  9. use Shopware\Core\Framework\Context;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Pricing\CashRoundingConfig;
  11. use Shopware\Core\Framework\Feature;
  12. use Shopware\Core\System\Currency\CurrencyEntity;
  13. use Shopware\Core\System\Tax\TaxCollection;
  15. /**
  16.  * @package core
  17.  *
  18.  * @internal Use SalesChannelContext for extensions
  19.  */
  20. class BaseContext
  21. {
  22.     protected CustomerGroupEntity $currentCustomerGroup;
  24.     protected CustomerGroupEntity $fallbackCustomerGroup;
  26.     protected CurrencyEntity $currency;
  28.     protected SalesChannelEntity $salesChannel;
  30.     protected TaxCollection $taxRules;
  32.     protected PaymentMethodEntity $paymentMethod;
  34.     protected ShippingMethodEntity $shippingMethod;
  36.     protected ShippingLocation $shippingLocation;
  38.     protected Context $context;
  40.     private CashRoundingConfig $itemRounding;
  42.     private CashRoundingConfig $totalRounding;
  44.     /**
  45.      * @deprecated tag:v6.5.0 - Parameter $fallbackCustomerGroup is deprecated and will be removed
  46.      */
  47.     public function __construct(
  48.         Context $baseContext,
  49.         SalesChannelEntity $salesChannel,
  50.         CurrencyEntity $currency,
  51.         CustomerGroupEntity $currentCustomerGroup,
  52.         CustomerGroupEntity $fallbackCustomerGroup,
  53.         TaxCollection $taxRules,
  54.         PaymentMethodEntity $paymentMethod,
  55.         ShippingMethodEntity $shippingMethod,
  56.         ShippingLocation $shippingLocation,
  57.         CashRoundingConfig $itemRounding,
  58.         CashRoundingConfig $totalRounding
  59.     ) {
  60.         $this->currentCustomerGroup = $currentCustomerGroup;
  61.         $this->fallbackCustomerGroup = $fallbackCustomerGroup;
  62.         $this->currency = $currency;
  63.         $this->salesChannel = $salesChannel;
  64.         $this->taxRules = $taxRules;
  65.         $this->paymentMethod = $paymentMethod;
  66.         $this->shippingMethod = $shippingMethod;
  67.         $this->shippingLocation = $shippingLocation;
  68.         $this->context = $baseContext;
  69.         $this->itemRounding = $itemRounding;
  70.         $this->totalRounding = $totalRounding;
  71.     }
  73.     public function getCurrentCustomerGroup(): CustomerGroupEntity
  74.     {
  75.         return $this->currentCustomerGroup;
  76.     }
  78.     /**
  79.      * @deprecated tag:v6.5.0 - Fallback customer group is deprecated and will be removed, use getCurrentCustomerGroup instead
  80.      */
  81.     public function getFallbackCustomerGroup(): CustomerGroupEntity
  82.     {
  83.         Feature::triggerDeprecationOrThrow(
  84.             'v6.5.0.0',
  85.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'getCurrentCustomerGroup')
  86.         );
  88.         return $this->fallbackCustomerGroup;
  89.     }
  91.     public function getCurrency(): CurrencyEntity
  92.     {
  93.         return $this->currency;
  94.     }
  96.     public function getSalesChannel(): SalesChannelEntity
  97.     {
  98.         return $this->salesChannel;
  99.     }
  101.     public function getTaxRules(): TaxCollection
  102.     {
  103.         return $this->taxRules;
  104.     }
  106.     public function getPaymentMethod(): PaymentMethodEntity
  107.     {
  108.         return $this->paymentMethod;
  109.     }
  111.     public function getShippingMethod(): ShippingMethodEntity
  112.     {
  113.         return $this->shippingMethod;
  114.     }
  116.     public function getShippingLocation(): ShippingLocation
  117.     {
  118.         return $this->shippingLocation;
  119.     }
  121.     public function getContext(): Context
  122.     {
  123.         return $this->context;
  124.     }
  126.     public function getTaxState(): string
  127.     {
  128.         return $this->context->getTaxState();
  129.     }
  131.     public function getApiAlias(): string
  132.     {
  133.         return 'base_channel_context';
  134.     }
  136.     /**
  137.      * @codeCoverageIgnore
  138.      */
  139.     public function getTotalRounding(): CashRoundingConfig
  140.     {
  141.         return $this->totalRounding;
  142.     }
  144.     /**
  145.      * @codeCoverageIgnore
  146.      */
  147.     public function getItemRounding(): CashRoundingConfig
  148.     {
  149.         return $this->itemRounding;
  150.     }
  152.     public function getCurrencyId(): string
  153.     {
  154.         return $this->getCurrency()->getId();
  155.     }
  156. }