src/Core/Framework/Context.php line 17

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework;
  5. use Shopware\Core\Checkout\Cart\Price\Struct\CartPrice;
  6. use Shopware\Core\Defaults;
  7. use Shopware\Core\Framework\Api\Context\AdminApiSource;
  8. use Shopware\Core\Framework\Api\Context\ContextSource;
  9. use Shopware\Core\Framework\Api\Context\SystemSource;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Pricing\CashRoundingConfig;
  11. use Shopware\Core\Framework\Log\Package;
  12. use Shopware\Core\Framework\Struct\StateAwareTrait;
  13. use Shopware\Core\Framework\Struct\Struct;
  14. use Shopware\Core\System\SalesChannel\Exception\ContextRulesLockedException;
  16. #[Package('core')]
  17. class Context extends Struct
  18. {
  19.     use StateAwareTrait;
  21.     final public const SYSTEM_SCOPE = 'system';
  22.     final public const USER_SCOPE = 'user';
  23.     final public const CRUD_API_SCOPE = 'crud';
  25.     final public const SKIP_TRIGGER_FLOW = 'skipTriggerFlow';
  27.     /**
  28.      * @var non-empty-array<string>
  29.      */
  30.     protected array $languageIdChain;
  32.     protected string $scope = self::USER_SCOPE;
  34.     protected bool $rulesLocked = false;
  36.     /**
  37.      * @param array<string> $languageIdChain
  38.      * @param array<string> $ruleIds
  39.      */
  40.     public function __construct(
  41.         protected ContextSource $source,
  42.         protected array $ruleIds = [],
  43.         protected string $currencyId = Defaults::CURRENCY,
  44.         array $languageIdChain = [Defaults::LANGUAGE_SYSTEM],
  45.         protected string $versionId = Defaults::LIVE_VERSION,
  46.         protected float $currencyFactor = 1.0,
  47.         protected bool $considerInheritance = false,
  48.         /**
  49.          * @see CartPrice::TAX_STATE_GROSS, CartPrice::TAX_STATE_NET, CartPrice::TAX_STATE_FREE
  50.          */
  51.         protected string $taxState = CartPrice::TAX_STATE_GROSS,
  52.         protected CashRoundingConfig $rounding = new CashRoundingConfig(2, 0.01, true)
  53.     ) {
  54.         if ($source instanceof SystemSource) {
  55.             $this->scope = self::SYSTEM_SCOPE;
  56.         }
  58.         if (empty($languageIdChain)) {
  59.             throw new \InvalidArgumentException('Argument languageIdChain must not be empty');
  60.         }
  62.         /** @var non-empty-array<string> $chain */
  63.         $chain = array_keys(array_flip(array_filter($languageIdChain)));
  64.         $this->languageIdChain = $chain;
  65.     }
  67.     /**
  68.      * @internal
  69.      */
  70.     public static function createDefaultContext(?ContextSource $source = null): self
  71.     {
  72.         $source ??= new SystemSource();
  74.         return new self($source);
  75.     }
  77.     public function getSource(): ContextSource
  78.     {
  79.         return $this->source;
  80.     }
  82.     public function getVersionId(): string
  83.     {
  84.         return $this->versionId;
  85.     }
  87.     public function getLanguageId(): string
  88.     {
  89.         return $this->languageIdChain[0];
  90.     }
  92.     public function getCurrencyId(): string
  93.     {
  94.         return $this->currencyId;
  95.     }
  97.     public function getCurrencyFactor(): float
  98.     {
  99.         return $this->currencyFactor;
  100.     }
  102.     /**
  103.      * @return array<string>
  104.      */
  105.     public function getRuleIds(): array
  106.     {
  107.         return $this->ruleIds;
  108.     }
  110.     /**
  111.      * @return non-empty-array<string>
  112.      */
  113.     public function getLanguageIdChain(): array
  114.     {
  115.         return $this->languageIdChain;
  116.     }
  118.     public function createWithVersionId(string $versionId): self
  119.     {
  120.         $context = new self(
  121.             $this->source,
  122.             $this->ruleIds,
  123.             $this->currencyId,
  124.             $this->languageIdChain,
  125.             $versionId,
  126.             $this->currencyFactor,
  127.             $this->considerInheritance,
  128.             $this->taxState,
  129.             $this->rounding
  130.         );
  131.         $context->scope = $this->scope;
  133.         foreach ($this->getExtensions() as $key => $extension) {
  134.             $context->addExtension($key, $extension);
  135.         }
  137.         return $context;
  138.     }
  140.     /**
  141.      * @return mixed the return value of the provided callback function
  142.      */
  143.     public function scope(string $scope, callable $callback)
  144.     {
  145.         $currentScope = $this->getScope();
  146.         $this->scope = $scope;
  148.         try {
  149.             $result = $callback($this);
  150.         } finally {
  151.             $this->scope = $currentScope;
  152.         }
  154.         return $result;
  155.     }
  157.     public function getScope(): string
  158.     {
  159.         return $this->scope;
  160.     }
  162.     public function considerInheritance(): bool
  163.     {
  164.         return $this->considerInheritance;
  165.     }
  167.     public function setConsiderInheritance(bool $considerInheritance): void
  168.     {
  169.         $this->considerInheritance = $considerInheritance;
  170.     }
  172.     public function getTaxState(): string
  173.     {
  174.         return $this->taxState;
  175.     }
  177.     public function setTaxState(string $taxState): void
  178.     {
  179.         $this->taxState = $taxState;
  180.     }
  182.     public function isAllowed(string $privilege): bool
  183.     {
  184.         if ($this->source instanceof AdminApiSource) {
  185.             return $this->source->isAllowed($privilege);
  186.         }
  188.         return true;
  189.     }
  191.     /**
  192.      * @param array<string> $ruleIds
  193.      */
  194.     public function setRuleIds(array $ruleIds): void
  195.     {
  196.         if ($this->rulesLocked) {
  197.             throw new ContextRulesLockedException();
  198.         }
  200.         $this->ruleIds = array_filter(array_values($ruleIds));
  201.     }
  203.     /**
  204.      * @return mixed
  205.      */
  206.     public function enableInheritance(callable $function)
  207.     {
  208.         $previous = $this->considerInheritance;
  209.         $this->considerInheritance = true;
  210.         $result = $function($this);
  211.         $this->considerInheritance = $previous;
  213.         return $result;
  214.     }
  216.     /**
  217.      * @return mixed
  218.      */
  219.     public function disableInheritance(callable $function)
  220.     {
  221.         $previous = $this->considerInheritance;
  222.         $this->considerInheritance = false;
  223.         $result = $function($this);
  224.         $this->considerInheritance = $previous;
  226.         return $result;
  227.     }
  229.     public function getApiAlias(): string
  230.     {
  231.         return 'context';
  232.     }
  234.     public function getRounding(): CashRoundingConfig
  235.     {
  236.         return $this->rounding;
  237.     }
  239.     public function setRounding(CashRoundingConfig $rounding): void
  240.     {
  241.         $this->rounding = $rounding;
  242.     }
  244.     public function lockRules(): void
  245.     {
  246.         $this->rulesLocked = true;
  247.     }
  248. }