<?php declare(strict_types=1);
namespace Shopware\Core\System\SalesChannel;
use Shopware\Core\Checkout\Cart\Delivery\Struct\ShippingLocation;
use Shopware\Core\Checkout\Cart\Tax\Struct\TaxRule;
use Shopware\Core\Checkout\Cart\Tax\Struct\TaxRuleCollection;
use Shopware\Core\Checkout\Customer\Aggregate\CustomerGroup\CustomerGroupEntity;
use Shopware\Core\Checkout\Customer\CustomerEntity;
use Shopware\Core\Checkout\Payment\PaymentMethodEntity;
use Shopware\Core\Checkout\Shipping\ShippingMethodEntity;
use Shopware\Core\Framework\Context;
use Shopware\Core\Framework\Struct\Struct;
use Shopware\Core\System\Currency\CurrencyEntity;
use Shopware\Core\System\SalesChannel\Exception\ContextPermissionsLockedException;
use Shopware\Core\System\SalesChannel\Exception\ContextRulesLockedException;
use Shopware\Core\System\Tax\Exception\TaxNotFoundException;
use Shopware\Core\System\Tax\TaxCollection;
class SalesChannelContext extends Struct
{
/**
* Unique token for context, e.g. stored in session or provided in request headers
*
* @var string
*/
protected $token;
/**
* @var CustomerGroupEntity
*/
protected $currentCustomerGroup;
/**
* @var CustomerGroupEntity
*/
protected $fallbackCustomerGroup;
/**
* @var CurrencyEntity
*/
protected $currency;
/**
* @var SalesChannelEntity
*/
protected $salesChannel;
/**
* @var TaxCollection
*/
protected $taxRules;
/**
* @var CustomerEntity|null
*/
protected $customer;
/**
* @var PaymentMethodEntity
*/
protected $paymentMethod;
/**
* @var ShippingMethodEntity
*/
protected $shippingMethod;
/**
* @var ShippingLocation
*/
protected $shippingLocation;
/**
* @var array
*/
protected $rulesIds;
/**
* @var bool
*/
protected $rulesLocked = false;
/**
* @var array
*/
protected $permissions = [];
/**
* @var bool
*/
protected $permisionsLocked = false;
/**
* @var Context
*/
private $context;
public function __construct(
Context $baseContext,
string $token,
SalesChannelEntity $salesChannel,
CurrencyEntity $currency,
CustomerGroupEntity $currentCustomerGroup,
CustomerGroupEntity $fallbackCustomerGroup,
TaxCollection $taxRules,
PaymentMethodEntity $paymentMethod,
ShippingMethodEntity $shippingMethod,
ShippingLocation $shippingLocation,
?CustomerEntity $customer,
array $rulesIds = []
) {
$this->currentCustomerGroup = $currentCustomerGroup;
$this->fallbackCustomerGroup = $fallbackCustomerGroup;
$this->currency = $currency;
$this->salesChannel = $salesChannel;
$this->taxRules = $taxRules;
$this->customer = $customer;
$this->paymentMethod = $paymentMethod;
$this->shippingMethod = $shippingMethod;
$this->shippingLocation = $shippingLocation;
$this->rulesIds = $rulesIds;
$this->token = $token;
$this->context = $baseContext;
}
public function getCurrentCustomerGroup(): CustomerGroupEntity
{
return $this->currentCustomerGroup;
}
public function getFallbackCustomerGroup(): CustomerGroupEntity
{
return $this->fallbackCustomerGroup;
}
public function getCurrency(): CurrencyEntity
{
return $this->currency;
}
public function getSalesChannel(): SalesChannelEntity
{
return $this->salesChannel;
}
public function getTaxRules(): TaxCollection
{
return $this->taxRules;
}
/**
* Get the tax rules depend on the customer billing address
* respectively the shippingLocation if there is no customer
*/
public function buildTaxRules(string $taxId): TaxRuleCollection
{
$tax = $this->taxRules->get($taxId);
if ($tax === null || $tax->getRules() === null) {
throw new TaxNotFoundException($taxId);
}
if ($tax->getRules()->first() !== null) {
return new TaxRuleCollection([
new TaxRule($tax->getRules()->first()->getTaxRate(), 100),
]);
}
return new TaxRuleCollection([
new TaxRule($tax->getTaxRate(), 100),
]);
}
public function getCustomer(): ?CustomerEntity
{
return $this->customer;
}
public function getPaymentMethod(): PaymentMethodEntity
{
return $this->paymentMethod;
}
public function getShippingMethod(): ShippingMethodEntity
{
return $this->shippingMethod;
}
public function getShippingLocation(): ShippingLocation
{
return $this->shippingLocation;
}
public function getContext(): Context
{
return $this->context;
}
public function getRuleIds(): array
{
return $this->rulesIds;
}
public function setRuleIds(array $ruleIds): void
{
if ($this->rulesLocked) {
throw new ContextRulesLockedException();
}
$this->rulesIds = array_filter(array_values($ruleIds));
$this->getContext()->setRuleIds($this->rulesIds);
}
public function lockRules(): void
{
$this->rulesLocked = true;
}
public function lockPermissions(): void
{
$this->permisionsLocked = true;
}
public function getToken(): string
{
return $this->token;
}
public function getTaxState(): string
{
return $this->context->getTaxState();
}
public function setTaxState(string $taxState): void
{
$this->context->setTaxState($taxState);
}
public function getPermissions(): array
{
return $this->permissions;
}
public function setPermissions(array $permissions): void
{
if ($this->permisionsLocked) {
throw new ContextPermissionsLockedException();
}
$this->permissions = array_filter($permissions);
}
public function hasPermission(string $permission): bool
{
return $this->permissions[$permission] ?? false;
}
public function getApiAlias(): string
{
return 'sales_channel_context';
}
}