CHANGELOG.md

CHANGELOG

8.2

• Allow prefixing entries with ! in the $eventsToDispatch constructor argument of Workflow and StateMachine to permanently disable an event; e.g. new Workflow(..., eventsToDispatch: ['!workflow.announce']) fires every event except workflow.announce. The GuardEvent can never be suppressed; !workflow.guard throws an InvalidArgumentException. Mixing allow-list and block-list entries also throws an InvalidArgumentException.

8.1

• Add support for dumping listeners in Graphviz diagrams

8.0

• Add method getEnabledTransition() to WorkflowInterface

• Add $nbToken argument to Marking::mark() and Marking::unmark()

• Add $asArc argument to Transition::getFroms() and Transition::getTos()

• Remove Event::getWorkflow() method

  Before

  use Symfony\Component\Workflow\Attribute\AsCompletedListener;
  use Symfony\Component\Workflow\Event\CompletedEvent;
  
  class MyListener
  {
      #[AsCompletedListener('my_workflow', 'to_state2')]
      public function terminateOrder(CompletedEvent $event): void
      {
          $subject = $event->getSubject();
          if ($event->getWorkflow()->can($subject, 'to_state3')) {
              $event->getWorkflow()->apply($subject, 'to_state3');
          }
      }
  }

  After

  use Symfony\Component\DependencyInjection\Attribute\Target;
  use Symfony\Component\Workflow\Attribute\AsCompletedListener;
  use Symfony\Component\Workflow\Event\CompletedEvent;
  use Symfony\Component\Workflow\WorkflowInterface;
  
  class MyListener
  {
      public function __construct(
          #[Target('my_workflow')]
          private readonly WorkflowInterface $workflow,
      ) {
      }
  
      #[AsCompletedListener('my_workflow', 'to_state2')]
      public function terminateOrder(CompletedEvent $event): void
      {
          $subject = $event->getSubject();
          if ($this->workflow->can($subject, 'to_state3')) {
              $this->workflow->apply($subject, 'to_state3');
          }
      }
  }

  Or

  use Symfony\Component\DependencyInjection\ServiceLocator;
  use Symfony\Component\DependencyInjection\Attribute\AutowireLocator;
  use Symfony\Component\Workflow\Attribute\AsTransitionListener;
  use Symfony\Component\Workflow\Event\TransitionEvent;
  
  class GenericListener
  {
      public function __construct(
          #[AutowireLocator('workflow', 'name')]
          private ServiceLocator $workflows
      ) {
      }
  
      #[AsTransitionListener]
      public function doSomething(TransitionEvent $event): void
      {
          $workflow = $this->workflows->get($event->getWorkflowName());
      }
  }

7.4

• Add support for BackedEnum in MethodMarkingStore
• Add support for weighted transitions
• Add a command to dump a workflow definition in different formats (dot, plantuml, mermaid)

7.3

• Deprecate Event::getWorkflow() method

7.1

• Add method getEnabledTransition() to WorkflowInterface
• Automatically register places from transitions
• Add support for workflows that need to store many tokens in the marking
• Add method getName() in event classes to build event names in subscribers

7.0

• Require explicit argument when calling Definition::setInitialPlaces()
• GuardEvent::getContext() method has been removed. Method was not supposed to be called within guard event listeners as it always returned an empty array anyway.
• Remove GuardEvent::getContext() method without replacement

6.4

• Add with-metadata option to the workflow:dump command to include places, transitions and workflow's metadata into dumped graph
• Add support for storing marking in a property
• Add a profiler
• Add support for multiline descriptions in PlantUML diagrams
• Add PHP attributes to register listeners and guards
• Deprecate GuardEvent::getContext() method that will be removed in 7.0
• Revert: Mark Symfony\Component\Workflow\Registry as internal
• Add WorkflowGuardListenerPass (moved from FrameworkBundle)

6.2

• Mark Symfony\Component\Workflow\Registry as internal
• Deprecate calling Definition::setInitialPlaces() without arguments

6.0

• Remove InvalidTokenConfigurationException

5.4

• Add support for getting updated context after a transition

5.3

• Deprecate InvalidTokenConfigurationException
• Added MermaidDumper to dump Workflow graphs in the Mermaid.js flowchart format

5.2.0

• Added Workflow::getEnabledTransition() to easily retrieve a specific transition object
• Added context to the event dispatched
• Dispatch an event when the subject enters in the workflow for the very first time
• Added a default context to the previous event
• Added support for specifying which events should be dispatched when calling workflow->apply()

5.1.0

• Added context to TransitionException and its child classes whenever they are thrown in Workflow::apply()
• Added Registry::has() to check if a workflow exists
• Added support for $context[Workflow::DISABLE_ANNOUNCE_EVENT] = true when calling workflow->apply() to not fire the announce event

5.0.0

• Added argument $context to MarkingStoreInterface::setMarking()

4.4.0

• Marked all dispatched event classes as @final

4.3.0

• Trigger entered event for subject entering in the Workflow for the first time.

• Added a context to Workflow::apply(). The MethodMarkingStore could be used to leverage this feature.

• The TransitionEvent is able to modify the context.

• Add style to transitions by declaring metadata:

  use Symfony\Component\Workflow\Definition; use Symfony\Component\Workflow\Metadata\InMemoryMetadataStore;

  $transitionsMetadata = new \SplObjectStorage(); $transitionsMetadata[$transition] = [ 'color' => 'Red', 'arrow_color' => '#00ff00', ]; $inMemoryMetadataStore = new InMemoryMetadataStore([], [], $transitionsMetadata);

  return new Definition($places, $transitions, null, $inMemoryMetadataStore);

• Dispatch GuardEvent on workflow.guard

• Dispatch LeaveEvent on workflow.leave

• Dispatch TransitionEvent on workflow.transition

• Dispatch EnterEvent on workflow.enter

• Dispatch EnteredEvent on workflow.entered

• Dispatch CompletedEvent on workflow.completed

• Dispatch AnnounceEvent on workflow.announce

• Added support for many initialPlaces

• Deprecated DefinitionBuilder::setInitialPlace() method, use DefinitionBuilder::setInitialPlaces() instead.

• Deprecated the MultipleStateMarkingStore class, use the MethodMarkingStore instead.

• Deprecated the SingleStateMarkingStore class, use the MethodMarkingStore instead.

4.1.0

• Deprecated the DefinitionBuilder::reset() method, use the clear() one instead.
• Deprecated the usage of add(Workflow $workflow, $supportStrategy) in Workflow/Registry, use addWorkflow(WorkflowInterface, $supportStrategy) instead.
• Deprecated the usage of SupportStrategyInterface, use WorkflowSupportStrategyInterface instead.
• The Workflow class now implements WorkflowInterface.
• Deprecated the class ClassInstanceSupportStrategy in favor of the class InstanceOfSupportStrategy.
• Added TransitionBlockers as a way to pass around reasons why exactly transitions can't be made.
• Added a MetadataStore.
• Added Registry::all to return all the workflows associated with the specific subject.

4.0.0

• Removed class name support in WorkflowRegistry::add() as second parameter.

3.4.0

• Added guard is_valid() method support.
• Added support for Event::getWorkflowName() for "announce" events.
• Added workflow.completed events which are fired after a transition is completed.

3.3.0

• Added support for expressions to guard transitions and added an is_granted() function that can be used in these expressions to use the authorization checker.
• The DefinitionBuilder class now provides a fluent interface.
• The AuditTrailListener now includes the workflow name in its log entries.
• Added workflow.entered events which is fired after the marking has been set.
• Deprecated class name support in WorkflowRegistry::add() as second parameter. Wrap the class name in an instance of ClassInstanceSupportStrategy instead.
• Added support for Event::getWorkflowName().
• Added SupportStrategyInterface to allow custom strategies to decide whether or not a workflow supports a subject.
• Added ValidateWorkflowPass.