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

Open in your IDE?
  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\Feature;
  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\SalesChannel\Exception\ContextRulesLockedException;
  22. use Shopware\Core\System\Tax\Exception\TaxNotFoundException;
  23. use Shopware\Core\System\Tax\TaxCollection;
  25. #[Package('core')]
  26. class SalesChannelContext extends Struct
  27. {
  28. use StateAwareTrait;
  30. /**
  31. * Unique token for context, e.g. stored in session or provided in request headers
  32. *
  33. * @var string
  34. */
  35. protected $token;
  37. /**
  38. * @var CustomerGroupEntity
  39. */
  40. protected $currentCustomerGroup;
  42. /**
  43. * @var CustomerGroupEntity
  44. */
  45. protected $fallbackCustomerGroup;
  47. /**
  48. * @var CurrencyEntity
  49. */
  50. protected $currency;
  52. /**
  53. * @var SalesChannelEntity
  54. */
  55. protected $salesChannel;
  57. /**
  58. * @var TaxCollection
  59. */
  60. protected $taxRules;
  62. /**
  63. * @var CustomerEntity|null
  64. */
  65. protected $customer;
  67. /**
  68. * @var PaymentMethodEntity
  69. */
  70. protected $paymentMethod;
  72. /**
  73. * @var ShippingMethodEntity
  74. */
  75. protected $shippingMethod;
  77. /**
  78. * @var ShippingLocation
  79. */
  80. protected $shippingLocation;
  82. /**
  83. * @var string[]
  84. */
  85. protected $rulesIds;
  87. /**
  88. * @var array<string, string[]>
  89. */
  90. protected array $areaRuleIds;
  92. /**
  93. * @var bool
  94. */
  95. protected $rulesLocked = false;
  97. /**
  98. * @var mixed[]
  99. */
  100. protected $permissions = [];
  102. /**
  103. * @var bool
  104. */
  105. protected $permisionsLocked = false;
  107. /**
  108. * @var Context
  109. */
  110. protected $context;
  112. /**
  113. * @var CashRoundingConfig
  114. */
  115. private $itemRounding;
  117. /**
  118. * @var CashRoundingConfig
  119. */
  120. private $totalRounding;
  122. /**
  123. * @var string|null
  124. */
  125. private $domainId;
  127. /**
  128. * @deprecated tag:v6.5.0 - __construct will be internal, use context factory to create a new context
  129. * @deprecated tag:v6.5.0 - Parameter $fallbackCustomerGroup is deprecated and will be removed
  130. *
  131. * @param array<string> $rulesIds
  132. * @param array<string, string[]> $areaRuleIds
  133. */
  134. public function __construct(
  135. Context $baseContext,
  136. string $token,
  137. ?string $domainId,
  138. SalesChannelEntity $salesChannel,
  139. CurrencyEntity $currency,
  140. CustomerGroupEntity $currentCustomerGroup,
  141. CustomerGroupEntity $fallbackCustomerGroup,
  142. TaxCollection $taxRules,
  143. PaymentMethodEntity $paymentMethod,
  144. ShippingMethodEntity $shippingMethod,
  145. ShippingLocation $shippingLocation,
  146. ?CustomerEntity $customer,
  147. CashRoundingConfig $itemRounding,
  148. CashRoundingConfig $totalRounding,
  149. array $rulesIds = [],
  150. array $areaRuleIds = []
  151. ) {
  152. $this->currentCustomerGroup = $currentCustomerGroup;
  153. $this->fallbackCustomerGroup = $fallbackCustomerGroup;
  154. $this->currency = $currency;
  155. $this->salesChannel = $salesChannel;
  156. $this->taxRules = $taxRules;
  157. $this->customer = $customer;
  158. $this->paymentMethod = $paymentMethod;
  159. $this->shippingMethod = $shippingMethod;
  160. $this->shippingLocation = $shippingLocation;
  161. $this->rulesIds = $rulesIds;
  162. $this->areaRuleIds = $areaRuleIds;
  163. $this->token = $token;
  164. $this->context = $baseContext;
  165. $this->itemRounding = $itemRounding;
  166. $this->totalRounding = $totalRounding;
  167. $this->domainId = $domainId;
  168. }
  170. public function getCurrentCustomerGroup(): CustomerGroupEntity
  171. {
  172. return $this->currentCustomerGroup;
  173. }
  175. /**
  176. * @deprecated tag:v6.5.0 - Fallback customer group is deprecated and will be removed, use getCurrentCustomerGroup instead
  177. */
  178. public function getFallbackCustomerGroup(): CustomerGroupEntity
  179. {
  180. Feature::triggerDeprecationOrThrow(
  181. 'v6.5.0.0',
  182. Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'getCurrentCustomerGroup()')
  183. );
  185. return $this->fallbackCustomerGroup;
  186. }
  188. public function getCurrency(): CurrencyEntity
  189. {
  190. return $this->currency;
  191. }
  193. public function getSalesChannel(): SalesChannelEntity
  194. {
  195. return $this->salesChannel;
  196. }
  198. public function getTaxRules(): TaxCollection
  199. {
  200. return $this->taxRules;
  201. }
  203. /**
  204. * Get the tax rules depend on the customer billing address
  205. * respectively the shippingLocation if there is no customer
  206. */
  207. public function buildTaxRules(string $taxId): TaxRuleCollection
  208. {
  209. $tax = $this->taxRules->get($taxId);
  211. if ($tax === null || $tax->getRules() === null) {
  212. throw new TaxNotFoundException($taxId);
  213. }
  215. if ($tax->getRules()->first() !== null) {
  216. // NEXT-21735 - This is covered randomly
  217. // @codeCoverageIgnoreStart
  218. return new TaxRuleCollection([
  219. new TaxRule($tax->getRules()->first()->getTaxRate(), 100),
  220. ]);
  221. // @codeCoverageIgnoreEnd
  222. }
  224. return new TaxRuleCollection([
  225. new TaxRule($tax->getTaxRate(), 100),
  226. ]);
  227. }
  229. public function getCustomer(): ?CustomerEntity
  230. {
  231. return $this->customer;
  232. }
  234. public function getPaymentMethod(): PaymentMethodEntity
  235. {
  236. return $this->paymentMethod;
  237. }
  239. public function getShippingMethod(): ShippingMethodEntity
  240. {
  241. return $this->shippingMethod;
  242. }
  244. public function getShippingLocation(): ShippingLocation
  245. {
  246. return $this->shippingLocation;
  247. }
  249. public function getContext(): Context
  250. {
  251. return $this->context;
  252. }
  254. /**
  255. * @return string[]
  256. */
  257. public function getRuleIds(): array
  258. {
  259. return $this->rulesIds;
  260. }
  262. /**
  263. * @param array<string> $ruleIds
  264. */
  265. public function setRuleIds(array $ruleIds): void
  266. {
  267. if ($this->rulesLocked) {
  268. throw new ContextRulesLockedException();
  269. }
  271. $this->rulesIds = array_filter(array_values($ruleIds));
  272. $this->getContext()->setRuleIds($this->rulesIds);
  273. }
  275. /**
  276. * @internal
  277. *
  278. * @return array<string, string[]>
  279. */
  280. public function getAreaRuleIds(): array
  281. {
  282. return $this->areaRuleIds;
  283. }
  285. /**
  286. * @internal
  287. *
  288. * @param string[] $areas
  289. *
  290. * @return string[]
  291. */
  292. public function getRuleIdsByAreas(array $areas): array
  293. {
  294. $ruleIds = [];
  296. foreach ($areas as $area) {
  297. if (empty($this->areaRuleIds[$area])) {
  298. continue;
  299. }
  301. $ruleIds = array_unique(array_merge($ruleIds, $this->areaRuleIds[$area]));
  302. }
  304. return array_values($ruleIds);
  305. }
  307. /**
  308. * @internal
  309. *
  310. * @param array<string, string[]> $areaRuleIds
  311. */
  312. public function setAreaRuleIds(array $areaRuleIds): void
  313. {
  314. $this->areaRuleIds = $areaRuleIds;
  315. }
  317. public function lockRules(): void
  318. {
  319. $this->rulesLocked = true;
  320. }
  322. public function lockPermissions(): void
  323. {
  324. $this->permisionsLocked = true;
  325. }
  327. public function getToken(): string
  328. {
  329. return $this->token;
  330. }
  332. public function getTaxState(): string
  333. {
  334. return $this->context->getTaxState();
  335. }
  337. public function setTaxState(string $taxState): void
  338. {
  339. $this->context->setTaxState($taxState);
  340. }
  342. public function getTaxCalculationType(): string
  343. {
  344. return $this->getSalesChannel()->getTaxCalculationType();
  345. }
  347. /**
  348. * @return mixed[]
  349. */
  350. public function getPermissions(): array
  351. {
  352. return $this->permissions;
  353. }
  355. /**
  356. * @param mixed[] $permissions
  357. */
  358. public function setPermissions(array $permissions): void
  359. {
  360. if ($this->permisionsLocked) {
  361. throw new ContextPermissionsLockedException();
  362. }
  364. $this->permissions = array_filter($permissions);
  365. }
  367. public function getApiAlias(): string
  368. {
  369. return 'sales_channel_context';
  370. }
  372. public function hasPermission(string $permission): bool
  373. {
  374. return \array_key_exists($permission, $this->permissions) && (bool) $this->permissions[$permission];
  375. }
  377. public function getSalesChannelId(): string
  378. {
  379. return $this->getSalesChannel()->getId();
  380. }
  382. public function addState(string ...$states): void
  383. {
  384. $this->context->addState(...$states);
  385. }
  387. public function removeState(string $state): void
  388. {
  389. $this->context->removeState($state);
  390. }
  392. public function hasState(string ...$states): bool
  393. {
  394. return $this->context->hasState(...$states);
  395. }
  397. /**
  398. * @return string[]
  399. */
  400. public function getStates(): array
  401. {
  402. return $this->context->getStates();
  403. }
  405. public function getDomainId(): ?string
  406. {
  407. return $this->domainId;
  408. }
  410. public function setDomainId(?string $domainId): void
  411. {
  412. $this->domainId = $domainId;
  413. }
  415. /**
  416. * @return string[]
  417. */
  418. public function getLanguageIdChain(): array
  419. {
  420. return $this->context->getLanguageIdChain();
  421. }
  423. public function getLanguageId(): string
  424. {
  425. return $this->context->getLanguageId();
  426. }
  428. public function getVersionId(): string
  429. {
  430. return $this->context->getVersionId();
  431. }
  433. public function considerInheritance(): bool
  434. {
  435. return $this->context->considerInheritance();
  436. }
  438. public function getTotalRounding(): CashRoundingConfig
  439. {
  440. return $this->totalRounding;
  441. }
  443. public function setTotalRounding(CashRoundingConfig $totalRounding): void
  444. {
  445. $this->totalRounding = $totalRounding;
  446. }
  448. public function getItemRounding(): CashRoundingConfig
  449. {
  450. return $this->itemRounding;
  451. }
  453. public function setItemRounding(CashRoundingConfig $itemRounding): void
  454. {
  455. $this->itemRounding = $itemRounding;
  456. }
  458. public function getCurrencyId(): string
  459. {
  460. return $this->getCurrency()->getId();
  461. }
  463. public function ensureLoggedIn(bool $allowGuest = true): void
  464. {
  465. if ($this->customer === null) {
  466. throw CartException::customerNotLoggedIn();
  467. }
  469. if (!$allowGuest && $this->customer->getGuest()) {
  470. throw CartException::customerNotLoggedIn();
  471. }
  472. }
  474. public function getCustomerId(): ?string
  475. {
  476. return $this->customer ? $this->customer->getId() : null;
  477. }
  478. }