vendor/shopware/core/Framework/Event/FlowEvent.php line 34

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Event;
  5. use Shopware\Core\Content\Flow\Dispatching\FlowState;
  6. use Shopware\Core\Framework\Context;
  7. use Shopware\Core\Framework\Event\EventData\EventDataCollection;
  8. use Shopware\Core\Framework\Feature;
  9. use Shopware\Core\Framework\Log\Package;
  10. use Symfony\Contracts\EventDispatcher\Event;
  12. /**
  13.  * @deprecated tag:v6.5.0 - Will be removed, use `FlowAction::handleFlow()` instead
  14.  */
  15. #[Package('business-ops')]
  16. class FlowEvent extends Event
  17. {
  18.     private FlowState $state;
  20.     /**
  21.      * @var array<string, mixed>
  22.      */
  23.     private $config;
  25.     private string $actionName;
  27.     /**
  28.      * @param array<string, mixed>|null $config
  29.      */
  30.     public function __construct(string $actionName, FlowState $state, ?array $config = [])
  31.     {
  32.         Feature::triggerDeprecationOrThrow(
  33.             'v6.5.0.0',
  34.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  35.         );
  37.         $this->actionName = $actionName;
  38.         $this->state = $state;
  39.         $this->config = $config ?? [];
  40.     }
  42.     public function getEvent(): FlowEventAware
  43.     {
  44.         Feature::triggerDeprecationOrThrow(
  45.             'v6.5.0.0',
  46.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  47.         );
  49.         return $this->state->event;
  50.     }
  52.     /**
  53.      * @return array<string, mixed>
  54.      */
  55.     public function getConfig(): array
  56.     {
  57.         Feature::triggerDeprecationOrThrow(
  58.             'v6.5.0.0',
  59.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  60.         );
  62.         return $this->config;
  63.     }
  65.     public function getActionName(): string
  66.     {
  67.         Feature::triggerDeprecationOrThrow(
  68.             'v6.5.0.0',
  69.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  70.         );
  72.         return $this->actionName;
  73.     }
  75.     public static function getAvailableData(): EventDataCollection
  76.     {
  77.         Feature::triggerDeprecationOrThrow(
  78.             'v6.5.0.0',
  79.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  80.         );
  82.         return new EventDataCollection();
  83.     }
  85.     public function getName(): string
  86.     {
  87.         Feature::triggerDeprecationOrThrow(
  88.             'v6.5.0.0',
  89.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  90.         );
  92.         return $this->state->event->getName();
  93.     }
  95.     public function getContext(): Context
  96.     {
  97.         Feature::triggerDeprecationOrThrow(
  98.             'v6.5.0.0',
  99.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  100.         );
  102.         return $this->state->event->getContext();
  103.     }
  105.     public function getFlowState(): FlowState
  106.     {
  107.         Feature::triggerDeprecationOrThrow(
  108.             'v6.5.0.0',
  109.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  110.         );
  112.         return $this->state;
  113.     }
  115.     public function stop(): void
  116.     {
  117.         Feature::triggerDeprecationOrThrow(
  118.             'v6.5.0.0',
  119.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  120.         );
  122.         $this->state->stop = true;
  123.     }
  124. }