src/Core/System/SalesChannel/SalesChannelContext.php line 24

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\SalesChannel;
  5. use Shopware\Core\Checkout\Cart\CartException;
  6. use Shopware\Core\Checkout\Cart\Delivery\Struct\ShippingLocation;
  7. use Shopware\Core\Checkout\Cart\Tax\Struct\TaxRule;
  8. use Shopware\Core\Checkout\Cart\Tax\Struct\TaxRuleCollection;
  9. use Shopware\Core\Checkout\Customer\Aggregate\CustomerGroup\CustomerGroupEntity;
  10. use Shopware\Core\Checkout\Customer\CustomerEntity;
  11. use Shopware\Core\Checkout\Payment\PaymentMethodEntity;
  12. use Shopware\Core\Checkout\Shipping\ShippingMethodEntity;
  13. use Shopware\Core\Framework\Context;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Pricing\CashRoundingConfig;
  15. use Shopware\Core\Framework\Log\Package;
  16. use Shopware\Core\Framework\Struct\StateAwareTrait;
  17. use Shopware\Core\Framework\Struct\Struct;
  18. use Shopware\Core\System\Currency\CurrencyEntity;
  19. use Shopware\Core\System\SalesChannel\Exception\ContextPermissionsLockedException;
  20. use Shopware\Core\System\Tax\Exception\TaxNotFoundException;
  21. use Shopware\Core\System\Tax\TaxCollection;
  23. #[Package('core')]
  24. class SalesChannelContext extends Struct
  25. {
  26.     use StateAwareTrait;
  28.     /**
  29.      * Unique token for context, e.g. stored in session or provided in request headers
  30.      *
  31.      * @var string
  32.      */
  33.     protected $token;
  35.     /**
  36.      * @var CustomerGroupEntity
  37.      */
  38.     protected $currentCustomerGroup;
  40.     /**
  41.      * @var CurrencyEntity
  42.      */
  43.     protected $currency;
  45.     /**
  46.      * @var SalesChannelEntity
  47.      */
  48.     protected $salesChannel;
  50.     /**
  51.      * @var TaxCollection
  52.      */
  53.     protected $taxRules;
  55.     /**
  56.      * @var CustomerEntity|null
  57.      */
  58.     protected $customer;
  60.     /**
  61.      * @var PaymentMethodEntity
  62.      */
  63.     protected $paymentMethod;
  65.     /**
  66.      * @var ShippingMethodEntity
  67.      */
  68.     protected $shippingMethod;
  70.     /**
  71.      * @var ShippingLocation
  72.      */
  73.     protected $shippingLocation;
  75.     /**
  76.      * @var mixed[]
  77.      */
  78.     protected $permissions = [];
  80.     /**
  81.      * @var bool
  82.      */
  83.     protected $permisionsLocked = false;
  85.     /**
  86.      * @var Context
  87.      */
  88.     protected $context;
  90.     /**
  91.      * @internal
  92.      *
  93.      * @param array<string, string[]> $areaRuleIds
  94.      */
  95.     public function __construct(
  96.         Context $baseContext,
  97.         string $token,
  98.         private ?string $domainId,
  99.         SalesChannelEntity $salesChannel,
  100.         CurrencyEntity $currency,
  101.         CustomerGroupEntity $currentCustomerGroup,
  102.         TaxCollection $taxRules,
  103.         PaymentMethodEntity $paymentMethod,
  104.         ShippingMethodEntity $shippingMethod,
  105.         ShippingLocation $shippingLocation,
  106.         ?CustomerEntity $customer,
  107.         private CashRoundingConfig $itemRounding,
  108.         private CashRoundingConfig $totalRounding,
  109.         protected array $areaRuleIds = []
  110.     ) {
  111.         $this->currentCustomerGroup = $currentCustomerGroup;
  112.         $this->currency = $currency;
  113.         $this->salesChannel = $salesChannel;
  114.         $this->taxRules = $taxRules;
  115.         $this->customer = $customer;
  116.         $this->paymentMethod = $paymentMethod;
  117.         $this->shippingMethod = $shippingMethod;
  118.         $this->shippingLocation = $shippingLocation;
  119.         $this->token = $token;
  120.         $this->context = $baseContext;
  121.     }
  123.     public function getCurrentCustomerGroup(): CustomerGroupEntity
  124.     {
  125.         return $this->currentCustomerGroup;
  126.     }
  128.     public function getCurrency(): CurrencyEntity
  129.     {
  130.         return $this->currency;
  131.     }
  133.     public function getSalesChannel(): SalesChannelEntity
  134.     {
  135.         return $this->salesChannel;
  136.     }
  138.     public function getTaxRules(): TaxCollection
  139.     {
  140.         return $this->taxRules;
  141.     }
  143.     /**
  144.      * Get the tax rules depend on the customer billing address
  145.      * respectively the shippingLocation if there is no customer
  146.      */
  147.     public function buildTaxRules(string $taxId): TaxRuleCollection
  148.     {
  149.         $tax = $this->taxRules->get($taxId);
  151.         if ($tax === null || $tax->getRules() === null) {
  152.             throw new TaxNotFoundException($taxId);
  153.         }
  155.         if ($tax->getRules()->first() !== null) {
  156.             // NEXT-21735 - This is covered randomly
  157.             // @codeCoverageIgnoreStart
  158.             return new TaxRuleCollection([
  159.                 new TaxRule($tax->getRules()->first()->getTaxRate(), 100),
  160.             ]);
  161.             // @codeCoverageIgnoreEnd
  162.         }
  164.         return new TaxRuleCollection([
  165.             new TaxRule($tax->getTaxRate(), 100),
  166.         ]);
  167.     }
  169.     public function getCustomer(): ?CustomerEntity
  170.     {
  171.         return $this->customer;
  172.     }
  174.     public function getPaymentMethod(): PaymentMethodEntity
  175.     {
  176.         return $this->paymentMethod;
  177.     }
  179.     public function getShippingMethod(): ShippingMethodEntity
  180.     {
  181.         return $this->shippingMethod;
  182.     }
  184.     public function getShippingLocation(): ShippingLocation
  185.     {
  186.         return $this->shippingLocation;
  187.     }
  189.     public function getContext(): Context
  190.     {
  191.         return $this->context;
  192.     }
  194.     /**
  195.      * @return string[]
  196.      */
  197.     public function getRuleIds(): array
  198.     {
  199.         return $this->getContext()->getRuleIds();
  200.     }
  202.     /**
  203.      * @param array<string> $ruleIds
  204.      */
  205.     public function setRuleIds(array $ruleIds): void
  206.     {
  207.         $this->getContext()->setRuleIds($ruleIds);
  208.     }
  210.     /**
  211.      * @internal
  212.      *
  213.      * @return array<string, string[]>
  214.      */
  215.     public function getAreaRuleIds(): array
  216.     {
  217.         return $this->areaRuleIds;
  218.     }
  220.     /**
  221.      * @internal
  222.      *
  223.      * @param string[] $areas
  224.      *
  225.      * @return string[]
  226.      */
  227.     public function getRuleIdsByAreas(array $areas): array
  228.     {
  229.         $ruleIds = [];
  231.         foreach ($areas as $area) {
  232.             if (empty($this->areaRuleIds[$area])) {
  233.                 continue;
  234.             }
  236.             $ruleIds = array_unique(array_merge($ruleIds, $this->areaRuleIds[$area]));
  237.         }
  239.         return array_values($ruleIds);
  240.     }
  242.     /**
  243.      * @internal
  244.      *
  245.      * @param array<string, string[]> $areaRuleIds
  246.      */
  247.     public function setAreaRuleIds(array $areaRuleIds): void
  248.     {
  249.         $this->areaRuleIds = $areaRuleIds;
  250.     }
  252.     public function lockRules(): void
  253.     {
  254.         $this->getContext()->lockRules();
  255.     }
  257.     public function lockPermissions(): void
  258.     {
  259.         $this->permisionsLocked = true;
  260.     }
  262.     public function getToken(): string
  263.     {
  264.         return $this->token;
  265.     }
  267.     public function getTaxState(): string
  268.     {
  269.         return $this->context->getTaxState();
  270.     }
  272.     public function setTaxState(string $taxState): void
  273.     {
  274.         $this->context->setTaxState($taxState);
  275.     }
  277.     public function getTaxCalculationType(): string
  278.     {
  279.         return $this->getSalesChannel()->getTaxCalculationType();
  280.     }
  282.     /**
  283.      * @return mixed[]
  284.      */
  285.     public function getPermissions(): array
  286.     {
  287.         return $this->permissions;
  288.     }
  290.     /**
  291.      * @param mixed[] $permissions
  292.      */
  293.     public function setPermissions(array $permissions): void
  294.     {
  295.         if ($this->permisionsLocked) {
  296.             throw new ContextPermissionsLockedException();
  297.         }
  299.         $this->permissions = array_filter($permissions);
  300.     }
  302.     public function getApiAlias(): string
  303.     {
  304.         return 'sales_channel_context';
  305.     }
  307.     public function hasPermission(string $permission): bool
  308.     {
  309.         return \array_key_exists($permission, $this->permissions) && (bool) $this->permissions[$permission];
  310.     }
  312.     public function getSalesChannelId(): string
  313.     {
  314.         return $this->getSalesChannel()->getId();
  315.     }
  317.     public function addState(string ...$states): void
  318.     {
  319.         $this->context->addState(...$states);
  320.     }
  322.     public function removeState(string $state): void
  323.     {
  324.         $this->context->removeState($state);
  325.     }
  327.     public function hasState(string ...$states): bool
  328.     {
  329.         return $this->context->hasState(...$states);
  330.     }
  332.     /**
  333.      * @return string[]
  334.      */
  335.     public function getStates(): array
  336.     {
  337.         return $this->context->getStates();
  338.     }
  340.     public function getDomainId(): ?string
  341.     {
  342.         return $this->domainId;
  343.     }
  345.     public function setDomainId(?string $domainId): void
  346.     {
  347.         $this->domainId = $domainId;
  348.     }
  350.     /**
  351.      * @return string[]
  352.      */
  353.     public function getLanguageIdChain(): array
  354.     {
  355.         return $this->context->getLanguageIdChain();
  356.     }
  358.     public function getLanguageId(): string
  359.     {
  360.         return $this->context->getLanguageId();
  361.     }
  363.     public function getVersionId(): string
  364.     {
  365.         return $this->context->getVersionId();
  366.     }
  368.     public function considerInheritance(): bool
  369.     {
  370.         return $this->context->considerInheritance();
  371.     }
  373.     public function getTotalRounding(): CashRoundingConfig
  374.     {
  375.         return $this->totalRounding;
  376.     }
  378.     public function setTotalRounding(CashRoundingConfig $totalRounding): void
  379.     {
  380.         $this->totalRounding = $totalRounding;
  381.     }
  383.     public function getItemRounding(): CashRoundingConfig
  384.     {
  385.         return $this->itemRounding;
  386.     }
  388.     public function setItemRounding(CashRoundingConfig $itemRounding): void
  389.     {
  390.         $this->itemRounding = $itemRounding;
  391.     }
  393.     public function getCurrencyId(): string
  394.     {
  395.         return $this->getCurrency()->getId();
  396.     }
  398.     public function ensureLoggedIn(bool $allowGuest = true): void
  399.     {
  400.         if ($this->customer === null) {
  401.             throw CartException::customerNotLoggedIn();
  402.         }
  404.         if (!$allowGuest && $this->customer->getGuest()) {
  405.             throw CartException::customerNotLoggedIn();
  406.         }
  407.     }
  409.     public function getCustomerId(): ?string
  410.     {
  411.         return $this->customer ? $this->customer->getId() : null;
  412.     }
  413. }