vendor/shopware/core/System/SalesChannel/SalesChannelContext.php line 26

  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\Defaults;
  14. use Shopware\Core\Framework\Context;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Pricing\CashRoundingConfig;
  16. use Shopware\Core\Framework\Log\Package;
  17. use Shopware\Core\Framework\Struct\StateAwareTrait;
  18. use Shopware\Core\Framework\Struct\Struct;
  19. use Shopware\Core\System\Currency\CurrencyEntity;
  20. use Shopware\Core\System\SalesChannel\Exception\ContextPermissionsLockedException;
  21. use Shopware\Core\System\Tax\Exception\TaxNotFoundException;
  22. use Shopware\Core\System\Tax\TaxCollection;
  24. #[Package('core')]
  25. class SalesChannelContext extends Struct
  26. {
  27.     use StateAwareTrait;
  29.     /**
  30.      * Unique token for context, e.g. stored in session or provided in request headers
  31.      *
  32.      * @var string
  33.      */
  34.     protected $token;
  36.     /**
  37.      * @var CustomerGroupEntity
  38.      */
  39.     protected $currentCustomerGroup;
  41.     /**
  42.      * @var CurrencyEntity
  43.      */
  44.     protected $currency;
  46.     /**
  47.      * @var SalesChannelEntity
  48.      */
  49.     protected $salesChannel;
  51.     /**
  52.      * @var TaxCollection
  53.      */
  54.     protected $taxRules;
  56.     /**
  57.      * @var CustomerEntity|null
  58.      */
  59.     protected $customer;
  61.     /**
  62.      * @var PaymentMethodEntity
  63.      */
  64.     protected $paymentMethod;
  66.     /**
  67.      * @var ShippingMethodEntity
  68.      */
  69.     protected $shippingMethod;
  71.     /**
  72.      * @var ShippingLocation
  73.      */
  74.     protected $shippingLocation;
  76.     /**
  77.      * @var array<string, bool>
  78.      */
  79.     protected $permissions = [];
  81.     /**
  82.      * @var bool
  83.      */
  84.     protected $permisionsLocked = false;
  86.     /**
  87.      * @var string|null
  88.      */
  89.     protected $imitatingUserId;
  91.     /**
  92.      * @var Context
  93.      */
  94.     protected $context;
  96.     /**
  97.      * @internal
  98.      *
  99.      * @param array<string, string[]> $areaRuleIds
  100.      */
  101.     public function __construct(
  102.         Context $baseContext,
  103.         string $token,
  104.         private ?string $domainId,
  105.         SalesChannelEntity $salesChannel,
  106.         CurrencyEntity $currency,
  107.         CustomerGroupEntity $currentCustomerGroup,
  108.         TaxCollection $taxRules,
  109.         PaymentMethodEntity $paymentMethod,
  110.         ShippingMethodEntity $shippingMethod,
  111.         ShippingLocation $shippingLocation,
  112.         ?CustomerEntity $customer,
  113.         protected CashRoundingConfig $itemRounding,
  114.         protected CashRoundingConfig $totalRounding,
  115.         protected array $areaRuleIds = []
  116.     ) {
  117.         $this->currentCustomerGroup = $currentCustomerGroup;
  118.         $this->currency = $currency;
  119.         $this->salesChannel = $salesChannel;
  120.         $this->taxRules = $taxRules;
  121.         $this->customer = $customer;
  122.         $this->paymentMethod = $paymentMethod;
  123.         $this->shippingMethod = $shippingMethod;
  124.         $this->shippingLocation = $shippingLocation;
  125.         $this->token = $token;
  126.         $this->context = $baseContext;
  127.         $this->imitatingUserId = null;
  128.     }
  130.     public function getCurrentCustomerGroup(): CustomerGroupEntity
  131.     {
  132.         return $this->currentCustomerGroup;
  133.     }
  135.     public function getCurrency(): CurrencyEntity
  136.     {
  137.         return $this->currency;
  138.     }
  140.     public function getSalesChannel(): SalesChannelEntity
  141.     {
  142.         return $this->salesChannel;
  143.     }
  145.     public function getTaxRules(): TaxCollection
  146.     {
  147.         return $this->taxRules;
  148.     }
  150.     /**
  151.      * Get the tax rules depend on the customer billing address
  152.      * respectively the shippingLocation if there is no customer
  153.      */
  154.     public function buildTaxRules(string $taxId): TaxRuleCollection
  155.     {
  156.         $tax = $this->taxRules->get($taxId);
  158.         if ($tax === null || $tax->getRules() === null) {
  159.             throw new TaxNotFoundException($taxId);
  160.         }
  162.         if ($tax->getRules()->first() !== null) {
  163.             // NEXT-21735 - This is covered randomly
  164.             // @codeCoverageIgnoreStart
  165.             return new TaxRuleCollection([
  166.                 new TaxRule($tax->getRules()->first()->getTaxRate(), 100),
  167.             ]);
  168.             // @codeCoverageIgnoreEnd
  169.         }
  171.         return new TaxRuleCollection([
  172.             new TaxRule($tax->getTaxRate(), 100),
  173.         ]);
  174.     }
  176.     public function getCustomer(): ?CustomerEntity
  177.     {
  178.         return $this->customer;
  179.     }
  181.     public function getPaymentMethod(): PaymentMethodEntity
  182.     {
  183.         return $this->paymentMethod;
  184.     }
  186.     public function getShippingMethod(): ShippingMethodEntity
  187.     {
  188.         return $this->shippingMethod;
  189.     }
  191.     public function getShippingLocation(): ShippingLocation
  192.     {
  193.         return $this->shippingLocation;
  194.     }
  196.     public function getContext(): Context
  197.     {
  198.         return $this->context;
  199.     }
  201.     /**
  202.      * @return string[]
  203.      */
  204.     public function getRuleIds(): array
  205.     {
  206.         return $this->getContext()->getRuleIds();
  207.     }
  209.     /**
  210.      * @param array<string> $ruleIds
  211.      */
  212.     public function setRuleIds(array $ruleIds): void
  213.     {
  214.         $this->getContext()->setRuleIds($ruleIds);
  215.     }
  217.     /**
  218.      * @internal
  219.      *
  220.      * @return array<string, string[]>
  221.      */
  222.     public function getAreaRuleIds(): array
  223.     {
  224.         return $this->areaRuleIds;
  225.     }
  227.     /**
  228.      * @internal
  229.      *
  230.      * @param string[] $areas
  231.      *
  232.      * @return string[]
  233.      */
  234.     public function getRuleIdsByAreas(array $areas): array
  235.     {
  236.         $ruleIds = [];
  238.         foreach ($areas as $area) {
  239.             if (empty($this->areaRuleIds[$area])) {
  240.                 continue;
  241.             }
  243.             $ruleIds = array_unique(array_merge($ruleIds, $this->areaRuleIds[$area]));
  244.         }
  246.         return array_values($ruleIds);
  247.     }
  249.     /**
  250.      * @internal
  251.      *
  252.      * @param array<string, string[]> $areaRuleIds
  253.      */
  254.     public function setAreaRuleIds(array $areaRuleIds): void
  255.     {
  256.         $this->areaRuleIds = $areaRuleIds;
  257.     }
  259.     public function lockRules(): void
  260.     {
  261.         $this->getContext()->lockRules();
  262.     }
  264.     public function lockPermissions(): void
  265.     {
  266.         $this->permisionsLocked = true;
  267.     }
  269.     public function getToken(): string
  270.     {
  271.         return $this->token;
  272.     }
  274.     public function getTaxState(): string
  275.     {
  276.         return $this->context->getTaxState();
  277.     }
  279.     public function setTaxState(string $taxState): void
  280.     {
  281.         $this->context->setTaxState($taxState);
  282.     }
  284.     public function getTaxCalculationType(): string
  285.     {
  286.         return $this->getSalesChannel()->getTaxCalculationType();
  287.     }
  289.     /**
  290.      * @return array<string, bool>
  291.      */
  292.     public function getPermissions(): array
  293.     {
  294.         return $this->permissions;
  295.     }
  297.     /**
  298.      * @param array<string, bool> $permissions
  299.      */
  300.     public function setPermissions(array $permissions): void
  301.     {
  302.         if ($this->permisionsLocked) {
  303.             throw new ContextPermissionsLockedException();
  304.         }
  306.         $this->permissions = array_filter($permissions);
  307.     }
  309.     public function getApiAlias(): string
  310.     {
  311.         return 'sales_channel_context';
  312.     }
  314.     public function hasPermission(string $permission): bool
  315.     {
  316.         return \array_key_exists($permission, $this->permissions) && $this->permissions[$permission];
  317.     }
  319.     public function getSalesChannelId(): string
  320.     {
  321.         return $this->getSalesChannel()->getId();
  322.     }
  324.     public function addState(string ...$states): void
  325.     {
  326.         $this->context->addState(...$states);
  327.     }
  329.     public function removeState(string $state): void
  330.     {
  331.         $this->context->removeState($state);
  332.     }
  334.     public function hasState(string ...$states): bool
  335.     {
  336.         return $this->context->hasState(...$states);
  337.     }
  339.     /**
  340.      * @return string[]
  341.      */
  342.     public function getStates(): array
  343.     {
  344.         return $this->context->getStates();
  345.     }
  347.     public function getDomainId(): ?string
  348.     {
  349.         return $this->domainId;
  350.     }
  352.     public function setDomainId(?string $domainId): void
  353.     {
  354.         $this->domainId = $domainId;
  355.     }
  357.     /**
  358.      * @return string[]
  359.      */
  360.     public function getLanguageIdChain(): array
  361.     {
  362.         return $this->context->getLanguageIdChain();
  363.     }
  365.     public function getLanguageId(): string
  366.     {
  367.         return $this->context->getLanguageId();
  368.     }
  370.     public function getVersionId(): string
  371.     {
  372.         return $this->context->getVersionId();
  373.     }
  375.     public function considerInheritance(): bool
  376.     {
  377.         return $this->context->considerInheritance();
  378.     }
  380.     public function getTotalRounding(): CashRoundingConfig
  381.     {
  382.         return $this->totalRounding;
  383.     }
  385.     public function setTotalRounding(CashRoundingConfig $totalRounding): void
  386.     {
  387.         $this->totalRounding = $totalRounding;
  388.     }
  390.     public function getItemRounding(): CashRoundingConfig
  391.     {
  392.         return $this->itemRounding;
  393.     }
  395.     public function setItemRounding(CashRoundingConfig $itemRounding): void
  396.     {
  397.         $this->itemRounding = $itemRounding;
  398.     }
  400.     public function getCurrencyId(): string
  401.     {
  402.         return $this->getCurrency()->getId();
  403.     }
  405.     public function ensureLoggedIn(bool $allowGuest = true): void
  406.     {
  407.         if ($this->customer === null) {
  408.             throw CartException::customerNotLoggedIn();
  409.         }
  411.         if (!$allowGuest && $this->customer->getGuest()) {
  412.             throw CartException::customerNotLoggedIn();
  413.         }
  414.     }
  416.     public function getCustomerId(): ?string
  417.     {
  418.         return $this->customer?->getId();
  419.     }
  421.     public function getImitatingUserId(): ?string
  422.     {
  423.         return $this->imitatingUserId;
  424.     }
  426.     public function setImitatingUserId(?string $imitatingUserId): void
  427.     {
  428.         $this->imitatingUserId = $imitatingUserId;
  429.     }
  431.     /**
  432.      * @template TReturn of mixed
  433.      *
  434.      * @param callable(SalesChannelContext): TReturn $callback
  435.      *
  436.      * @return TReturn the return value of the provided callback function
  437.      */
  438.     public function live(callable $callback): mixed
  439.     {
  440.         $before = $this->context;
  442.         $this->context = $this->context->createWithVersionId(Defaults::LIVE_VERSION);
  444.         $result = $callback($this);
  446.         $this->context = $before;
  448.         return $result;
  449.     }
  451.     public function getCountryId(): string
  452.     {
  453.         return $this->shippingLocation->getCountry()->getId();
  454.     }
  456.     public function getCustomerGroupId(): string
  457.     {
  458.         return $this->currentCustomerGroup->getId();
  459.     }
  460. }