vendor/shopware/core/Content/Flow/Dispatching/StorableFlow.php line 72

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Flow\Dispatching;
  5. use Shopware\Core\Content\Flow\FlowException;
  6. use Shopware\Core\Framework\Context;
  7. use Shopware\Core\Framework\Event\FlowEvent;
  8. use Shopware\Core\Framework\Event\FlowEventAware;
  9. use Shopware\Core\Framework\Feature;
  10. use Shopware\Core\Framework\Log\Package;
  12. /**
  13.  * @internal
  14.  */
  15. #[Package('business-ops')]
  16. class StorableFlow
  17. {
  18.     protected ?FlowState $state = null;
  20.     /**
  21.      * @var array<string, mixed>
  22.      */
  23.     protected array $config = [];
  25.     protected string $name;
  27.     protected Context $context;
  29.     /**
  30.      * @var array<string, mixed>
  31.      */
  32.     protected array $store = [];
  34.     /**
  35.      * @var array<string, mixed>
  36.      */
  37.     protected array $data = [];
  39.     /**
  40.      * @deprecated tag:v6.5.0 Will be removed
  41.      */
  42.     private ?FlowEventAware $originalEvent = null;
  44.     /**
  45.      * @deprecated tag:v6.5.0 Will be removed
  46.      */
  47.     private ?FlowEvent $flowEvent = null;
  49.     /**
  50.      * @param array<string, mixed> $store
  51.      * @param array<string, mixed> $data
  52.      */
  53.     public function __construct(
  54.         string $name,
  55.         Context $context,
  56.         array $store = [],
  57.         array $data = []
  58.     ) {
  59.         $this->name = $name;
  60.         $this->context = $context;
  61.         $this->data = $data;
  62.         $this->store = $store;
  63.     }
  65.     /**
  66.      * @deprecated tag:v6.5.0 Will be removed
  67.      */
  68.     public function setOriginalEvent(FlowEventAware $event): void
  69.     {
  70.         Feature::triggerDeprecationOrThrow(
  71.             'v6.5.0.0',
  72.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0')
  73.         );
  75.         $this->originalEvent = $event;
  76.     }
  78.     /**
  79.      * @deprecated tag:v6.5.0 Will be removed
  80.      */
  81.     public function getOriginalEvent(): ?FlowEventAware
  82.     {
  83.         Feature::triggerDeprecationOrThrow(
  84.             'v6.5.0.0',
  85.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0')
  86.         );
  88.         return $this->originalEvent;
  89.     }
  91.     /**
  92.      * @deprecated tag:v6.5.0 Will be removed
  93.      */
  94.     public function setFlowEvent(FlowEvent $event): void
  95.     {
  96.         Feature::triggerDeprecationOrThrow(
  97.             'v6.5.0.0',
  98.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0')
  99.         );
  101.         $this->flowEvent = $event;
  102.     }
  104.     /**
  105.      * @deprecated tag:v6.5.0 Will be removed
  106.      */
  107.     public function getFlowEvent(): ?FlowEvent
  108.     {
  109.         Feature::triggerDeprecationOrThrow(
  110.             'v6.5.0.0',
  111.             Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0')
  112.         );
  114.         return $this->flowEvent;
  115.     }
  117.     public function getName(): string
  118.     {
  119.         return $this->name;
  120.     }
  122.     public function getContext(): Context
  123.     {
  124.         return $this->context;
  125.     }
  127.     /**
  128.      * @param mixed $value
  129.      */
  130.     public function setStore(string $key, $value): void
  131.     {
  132.         $this->store[$key] = $value;
  133.     }
  135.     public function hasStore(string $key): bool
  136.     {
  137.         return \array_key_exists($key, $this->store);
  138.     }
  140.     /**
  141.      * @param mixed $default
  142.      *
  143.      * @return mixed
  144.      */
  145.     public function getStore(string $key, $default = null)
  146.     {
  147.         return $this->store[$key] ?? $default;
  148.     }
  150.     /**
  151.      * @return array<string, mixed>
  152.      */
  153.     public function stored(): array
  154.     {
  155.         return $this->store;
  156.     }
  158.     /**
  159.      * @param mixed $value
  160.      */
  161.     public function setData(string $key, $value): void
  162.     {
  163.         $this->data[$key] = $value;
  164.     }
  166.     public function hasData(string $key): bool
  167.     {
  168.         return \array_key_exists($key, $this->data);
  169.     }
  171.     /**
  172.      * @param mixed $default
  173.      *
  174.      * @return mixed
  175.      */
  176.     public function getData(string $key, $default = null)
  177.     {
  178.         $value = $this->data[$key] ?? $default;
  180.         if (\is_callable($value)) {
  181.             $this->data[$key] = $value($this);
  182.         }
  184.         return $this->data[$key] ?? $default;
  185.     }
  187.     /**
  188.      * @return array<string, mixed>
  189.      */
  190.     public function data(): array
  191.     {
  192.         foreach ($this->data as $key => $data) {
  193.             $this->getData($key);
  194.         }
  196.         return $this->data;
  197.     }
  199.     /**
  200.      * @param array<int, mixed> $args
  201.      */
  202.     public function lazy(string $key, callable $closure, array $args): void
  203.     {
  204.         $this->data[$key] = $closure($args);
  205.     }
  207.     /**
  208.      * @param array<string, mixed> $config
  209.      */
  210.     public function setConfig(array $config): void
  211.     {
  212.         $this->config = $config;
  213.     }
  215.     /**
  216.      * @return array<string, mixed>
  217.      */
  218.     public function getConfig(): array
  219.     {
  220.         return $this->config;
  221.     }
  223.     public function setFlowState(FlowState $state): void
  224.     {
  225.         $this->state = $state;
  226.     }
  228.     public function getFlowState(): FlowState
  229.     {
  230.         if (!$this->state) {
  231.             throw FlowException::methodNotCompatible('getFlowState()', self::class);
  232.         }
  234.         return $this->state;
  235.     }
  237.     public function stop(): void
  238.     {
  239.         if (!$this->state) {
  240.             throw FlowException::methodNotCompatible('stop()', self::class);
  241.         }
  243.         $this->state->stop = true;
  244.     }
  245. }