vendor/shopware/core/Framework/Context.php line 16

  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;
  15. use Symfony\Component\Serializer\Annotation\Ignore;
  17. #[Package('core')]
  18. class Context extends Struct
  19. {
  20.     use StateAwareTrait;
  22.     final public const SYSTEM_SCOPE = 'system';
  23.     final public const USER_SCOPE = 'user';
  24.     final public const CRUD_API_SCOPE = 'crud';
  26.     final public const SKIP_TRIGGER_FLOW = 'skipTriggerFlow';
  28.     /**
  29.      * @var non-empty-array<string>
  30.      */
  31.     protected array $languageIdChain;
  33.     protected string $scope = self::USER_SCOPE;
  35.     protected bool $rulesLocked = false;
  37.     #[Ignore]
  38.     protected $extensions = [];
  40.     /**
  41.      * @param array<string> $languageIdChain
  42.      * @param array<string> $ruleIds
  43.      */
  44.     public function __construct(
  45.         protected ContextSource $source,
  46.         protected array $ruleIds = [],
  47.         protected string $currencyId = Defaults::CURRENCY,
  48.         array $languageIdChain = [Defaults::LANGUAGE_SYSTEM],
  49.         protected string $versionId = Defaults::LIVE_VERSION,
  50.         protected float $currencyFactor = 1.0,
  51.         protected bool $considerInheritance = false,
  52.         /**
  53.          * @see CartPrice::TAX_STATE_GROSS, CartPrice::TAX_STATE_NET, CartPrice::TAX_STATE_FREE
  54.          */
  55.         protected string $taxState = CartPrice::TAX_STATE_GROSS,
  56.         protected CashRoundingConfig $rounding = new CashRoundingConfig(2, 0.01, true)
  57.     ) {
  58.         if ($source instanceof SystemSource) {
  59.             $this->scope = self::SYSTEM_SCOPE;
  60.         }
  62.         if (empty($languageIdChain)) {
  63.             throw new \InvalidArgumentException('Argument languageIdChain must not be empty');
  64.         }
  66.         /** @var non-empty-array<string> $chain */
  67.         $chain = array_keys(array_flip(array_filter($languageIdChain)));
  68.         $this->languageIdChain = $chain;
  69.     }
  71.     /**
  72.      * @internal
  73.      */
  74.     public static function createDefaultContext(?ContextSource $source = null): self
  75.     {
  76.         $source ??= new SystemSource();
  78.         return new self($source);
  79.     }
  81.     public static function createCLIContext(?ContextSource $source = null): self
  82.     {
  83.         return self::createDefaultContext($source);
  84.     }
  86.     public function getSource(): ContextSource
  87.     {
  88.         return $this->source;
  89.     }
  91.     public function getVersionId(): string
  92.     {
  93.         return $this->versionId;
  94.     }
  96.     public function getLanguageId(): string
  97.     {
  98.         return $this->languageIdChain[0];
  99.     }
  101.     public function getCurrencyId(): string
  102.     {
  103.         return $this->currencyId;
  104.     }
  106.     public function getCurrencyFactor(): float
  107.     {
  108.         return $this->currencyFactor;
  109.     }
  111.     /**
  112.      * @return array<string>
  113.      */
  114.     public function getRuleIds(): array
  115.     {
  116.         return $this->ruleIds;
  117.     }
  119.     /**
  120.      * @return non-empty-array<string>
  121.      */
  122.     public function getLanguageIdChain(): array
  123.     {
  124.         return $this->languageIdChain;
  125.     }
  127.     public function createWithVersionId(string $versionId): self
  128.     {
  129.         $context = new self(
  130.             $this->source,
  131.             $this->ruleIds,
  132.             $this->currencyId,
  133.             $this->languageIdChain,
  134.             $versionId,
  135.             $this->currencyFactor,
  136.             $this->considerInheritance,
  137.             $this->taxState,
  138.             $this->rounding
  139.         );
  140.         $context->scope = $this->scope;
  142.         foreach ($this->getExtensions() as $key => $extension) {
  143.             $context->addExtension($key, $extension);
  144.         }
  146.         return $context;
  147.     }
  149.     /**
  150.      * @template TReturn of mixed
  151.      *
  152.      * @param \Closure(Context): TReturn $callback
  153.      *
  154.      * @return TReturn the return value of the provided callback function
  155.      */
  156.     public function scope(string $scope, \Closure $callback)
  157.     {
  158.         $currentScope = $this->getScope();
  159.         $this->scope = $scope;
  161.         try {
  162.             $result = $callback($this);
  163.         } finally {
  164.             $this->scope = $currentScope;
  165.         }
  167.         return $result;
  168.     }
  170.     public function getScope(): string
  171.     {
  172.         return $this->scope;
  173.     }
  175.     public function considerInheritance(): bool
  176.     {
  177.         return $this->considerInheritance;
  178.     }
  180.     public function setConsiderInheritance(bool $considerInheritance): void
  181.     {
  182.         $this->considerInheritance = $considerInheritance;
  183.     }
  185.     public function getTaxState(): string
  186.     {
  187.         return $this->taxState;
  188.     }
  190.     public function setTaxState(string $taxState): void
  191.     {
  192.         $this->taxState = $taxState;
  193.     }
  195.     public function isAllowed(string $privilege): bool
  196.     {
  197.         if ($this->source instanceof AdminApiSource) {
  198.             return $this->source->isAllowed($privilege);
  199.         }
  201.         return true;
  202.     }
  204.     /**
  205.      * @param array<string> $ruleIds
  206.      */
  207.     public function setRuleIds(array $ruleIds): void
  208.     {
  209.         if ($this->rulesLocked) {
  210.             throw new ContextRulesLockedException();
  211.         }
  213.         $this->ruleIds = array_filter(array_values($ruleIds));
  214.     }
  216.     /**
  217.      * @template TReturn of mixed
  218.      *
  219.      * @param \Closure(Context): TReturn $function
  220.      *
  221.      * @return TReturn
  222.      */
  223.     public function enableInheritance(\Closure $function)
  224.     {
  225.         $previous = $this->considerInheritance;
  226.         $this->considerInheritance = true;
  227.         $result = $function($this);
  228.         $this->considerInheritance = $previous;
  230.         return $result;
  231.     }
  233.     /**
  234.      * @template TReturn of mixed
  235.      *
  236.      * @param \Closure(Context): TReturn $function
  237.      *
  238.      * @return TReturn
  239.      */
  240.     public function disableInheritance(\Closure $function)
  241.     {
  242.         $previous = $this->considerInheritance;
  243.         $this->considerInheritance = false;
  244.         $result = $function($this);
  245.         $this->considerInheritance = $previous;
  247.         return $result;
  248.     }
  250.     public function getApiAlias(): string
  251.     {
  252.         return 'context';
  253.     }
  255.     public function getRounding(): CashRoundingConfig
  256.     {
  257.         return $this->rounding;
  258.     }
  260.     public function setRounding(CashRoundingConfig $rounding): void
  261.     {
  262.         $this->rounding = $rounding;
  263.     }
  265.     public function lockRules(): void
  266.     {
  267.         $this->rulesLocked = true;
  268.     }
  269. }