vendor/shopware/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.      * @param callable(Context): mixed $callback
  142.      *
  143.      * @return mixed the return value of the provided callback function
  144.      */
  145.     public function scope(string $scope, callable $callback)
  146.     {
  147.         $currentScope = $this->getScope();
  148.         $this->scope = $scope;
  150.         try {
  151.             $result = $callback($this);
  152.         } finally {
  153.             $this->scope = $currentScope;
  154.         }
  156.         return $result;
  157.     }
  159.     public function getScope(): string
  160.     {
  161.         return $this->scope;
  162.     }
  164.     public function considerInheritance(): bool
  165.     {
  166.         return $this->considerInheritance;
  167.     }
  169.     public function setConsiderInheritance(bool $considerInheritance): void
  170.     {
  171.         $this->considerInheritance = $considerInheritance;
  172.     }
  174.     public function getTaxState(): string
  175.     {
  176.         return $this->taxState;
  177.     }
  179.     public function setTaxState(string $taxState): void
  180.     {
  181.         $this->taxState = $taxState;
  182.     }
  184.     public function isAllowed(string $privilege): bool
  185.     {
  186.         if ($this->source instanceof AdminApiSource) {
  187.             return $this->source->isAllowed($privilege);
  188.         }
  190.         return true;
  191.     }
  193.     /**
  194.      * @param array<string> $ruleIds
  195.      */
  196.     public function setRuleIds(array $ruleIds): void
  197.     {
  198.         if ($this->rulesLocked) {
  199.             throw new ContextRulesLockedException();
  200.         }
  202.         $this->ruleIds = array_filter(array_values($ruleIds));
  203.     }
  205.     /**
  206.      * @param callable(Context): mixed $function
  207.      *
  208.      * @return mixed
  209.      */
  210.     public function enableInheritance(callable $function)
  211.     {
  212.         $previous = $this->considerInheritance;
  213.         $this->considerInheritance = true;
  214.         $result = $function($this);
  215.         $this->considerInheritance = $previous;
  217.         return $result;
  218.     }
  220.     /**
  221.      * @param callable(Context): mixed $function
  222.      *
  223.      * @return mixed
  224.      */
  225.     public function disableInheritance(callable $function)
  226.     {
  227.         $previous = $this->considerInheritance;
  228.         $this->considerInheritance = false;
  229.         $result = $function($this);
  230.         $this->considerInheritance = $previous;
  232.         return $result;
  233.     }
  235.     public function getApiAlias(): string
  236.     {
  237.         return 'context';
  238.     }
  240.     public function getRounding(): CashRoundingConfig
  241.     {
  242.         return $this->rounding;
  243.     }
  245.     public function setRounding(CashRoundingConfig $rounding): void
  246.     {
  247.         $this->rounding = $rounding;
  248.     }
  250.     public function lockRules(): void
  251.     {
  252.         $this->rulesLocked = true;
  253.     }
  254. }