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

  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 function getSource(): ContextSource
  82.     {
  83.         return $this->source;
  84.     }
  86.     public function getVersionId(): string
  87.     {
  88.         return $this->versionId;
  89.     }
  91.     public function getLanguageId(): string
  92.     {
  93.         return $this->languageIdChain[0];
  94.     }
  96.     public function getCurrencyId(): string
  97.     {
  98.         return $this->currencyId;
  99.     }
  101.     public function getCurrencyFactor(): float
  102.     {
  103.         return $this->currencyFactor;
  104.     }
  106.     /**
  107.      * @return array<string>
  108.      */
  109.     public function getRuleIds(): array
  110.     {
  111.         return $this->ruleIds;
  112.     }
  114.     /**
  115.      * @return non-empty-array<string>
  116.      */
  117.     public function getLanguageIdChain(): array
  118.     {
  119.         return $this->languageIdChain;
  120.     }
  122.     public function createWithVersionId(string $versionId): self
  123.     {
  124.         $context = new self(
  125.             $this->source,
  126.             $this->ruleIds,
  127.             $this->currencyId,
  128.             $this->languageIdChain,
  129.             $versionId,
  130.             $this->currencyFactor,
  131.             $this->considerInheritance,
  132.             $this->taxState,
  133.             $this->rounding
  134.         );
  135.         $context->scope = $this->scope;
  137.         foreach ($this->getExtensions() as $key => $extension) {
  138.             $context->addExtension($key, $extension);
  139.         }
  141.         return $context;
  142.     }
  144.     /**
  145.      * @template TReturn of mixed
  146.      *
  147.      * @param callable(Context): TReturn $callback
  148.      *
  149.      * @return TReturn the return value of the provided callback function
  150.      */
  151.     public function scope(string $scope, callable $callback)
  152.     {
  153.         $currentScope = $this->getScope();
  154.         $this->scope = $scope;
  156.         try {
  157.             $result = $callback($this);
  158.         } finally {
  159.             $this->scope = $currentScope;
  160.         }
  162.         return $result;
  163.     }
  165.     public function getScope(): string
  166.     {
  167.         return $this->scope;
  168.     }
  170.     public function considerInheritance(): bool
  171.     {
  172.         return $this->considerInheritance;
  173.     }
  175.     public function setConsiderInheritance(bool $considerInheritance): void
  176.     {
  177.         $this->considerInheritance = $considerInheritance;
  178.     }
  180.     public function getTaxState(): string
  181.     {
  182.         return $this->taxState;
  183.     }
  185.     public function setTaxState(string $taxState): void
  186.     {
  187.         $this->taxState = $taxState;
  188.     }
  190.     public function isAllowed(string $privilege): bool
  191.     {
  192.         if ($this->source instanceof AdminApiSource) {
  193.             return $this->source->isAllowed($privilege);
  194.         }
  196.         return true;
  197.     }
  199.     /**
  200.      * @param array<string> $ruleIds
  201.      */
  202.     public function setRuleIds(array $ruleIds): void
  203.     {
  204.         if ($this->rulesLocked) {
  205.             throw new ContextRulesLockedException();
  206.         }
  208.         $this->ruleIds = array_filter(array_values($ruleIds));
  209.     }
  211.     /**
  212.      * @template TReturn of mixed
  213.      *
  214.      * @param callable(Context): TReturn $function
  215.      *
  216.      * @return TReturn
  217.      */
  218.     public function enableInheritance(callable $function)
  219.     {
  220.         $previous = $this->considerInheritance;
  221.         $this->considerInheritance = true;
  222.         $result = $function($this);
  223.         $this->considerInheritance = $previous;
  225.         return $result;
  226.     }
  228.     /**
  229.      * @template TReturn of mixed
  230.      *
  231.      * @param callable(Context): TReturn $function
  232.      *
  233.      * @return TReturn
  234.      */
  235.     public function disableInheritance(callable $function)
  236.     {
  237.         $previous = $this->considerInheritance;
  238.         $this->considerInheritance = false;
  239.         $result = $function($this);
  240.         $this->considerInheritance = $previous;
  242.         return $result;
  243.     }
  245.     public function getApiAlias(): string
  246.     {
  247.         return 'context';
  248.     }
  250.     public function getRounding(): CashRoundingConfig
  251.     {
  252.         return $this->rounding;
  253.     }
  255.     public function setRounding(CashRoundingConfig $rounding): void
  256.     {
  257.         $this->rounding = $rounding;
  258.     }
  260.     public function lockRules(): void
  261.     {
  262.         $this->rulesLocked = true;
  263.     }
  264. }