From a2281d22413dc10f1f7ad3c1a17063a65250d956 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Pineau?= Date: Tue, 13 Aug 2024 17:03:35 +0200 Subject: [PATCH] [Workflow] Do to talk about workflow, and explain what support option is for --- components/workflow.rst | 18 --------------- workflow/workflow-and-state-machine.rst | 30 +++---------------------- 2 files changed, 3 insertions(+), 45 deletions(-) diff --git a/components/workflow.rst b/components/workflow.rst index 8ca201b0859..2e5e1eb0aa6 100644 --- a/components/workflow.rst +++ b/components/workflow.rst @@ -55,23 +55,6 @@ The ``Workflow`` can now help you to decide what *transitions* (actions) are all on a blog post depending on what *place* (state) it is in. This will keep your domain logic in one place and not spread all over your application. -When you define multiple workflows you should consider using a ``Registry``, -which is an object that stores and provides access to different workflows. -A registry will also help you to decide if a workflow supports the object you -are trying to use it with:: - - use Acme\Entity\BlogPost; - use Acme\Entity\Newsletter; - use Symfony\Component\Workflow\Registry; - use Symfony\Component\Workflow\SupportStrategy\InstanceOfSupportStrategy; - - $blogPostWorkflow = ...; - $newsletterWorkflow = ...; - - $registry = new Registry(); - $registry->addWorkflow($blogPostWorkflow, new InstanceOfSupportStrategy(BlogPost::class)); - $registry->addWorkflow($newsletterWorkflow, new InstanceOfSupportStrategy(Newsletter::class)); - Usage ----- @@ -100,7 +83,6 @@ method to initialize the object property:: // ... $blogPost = new BlogPost(); - $workflow = $registry->get($blogPost); // initiate workflow $workflow->getMarking($blogPost); diff --git a/workflow/workflow-and-state-machine.rst b/workflow/workflow-and-state-machine.rst index 7d50cf0ac15..1d2ba6fcfc7 100644 --- a/workflow/workflow-and-state-machine.rst +++ b/workflow/workflow-and-state-machine.rst @@ -81,6 +81,7 @@ Below is the configuration for the pull request state machine. marking_store: type: 'method' property: 'currentPlace' + # The supports options is useful only if you are using twig functions ('workflow_*') supports: - App\Entity\PullRequest initial_marking: start @@ -132,6 +133,7 @@ Below is the configuration for the pull request state machine. currentPlace + App\Entity\PullRequest start @@ -202,6 +204,7 @@ Below is the configuration for the pull request state machine. $pullRequest ->type('state_machine') + // The supports options is useful only if you are using twig functions ('workflow_*') ->supports(['App\Entity\PullRequest']) ->initialMarking(['start']); @@ -252,33 +255,6 @@ Below is the configuration for the pull request state machine. ->to(['review']); }; -In a Symfony application using the -:ref:`default services.yaml configuration `, -you can get this state machine by injecting the Workflow registry service:: - - // ... - use App\Entity\PullRequest; - use Symfony\Component\Workflow\Registry; - - class SomeService - { - private $workflows; - - public function __construct(Registry $workflows) - { - $this->workflows = $workflows; - } - - public function someMethod(PullRequest $pullRequest) - { - $stateMachine = $this->workflows->get($pullRequest, 'pull_request'); - $stateMachine->apply($pullRequest, 'wait_for_review'); - // ... - } - - // ... - } - Symfony automatically creates a service for each workflow (:class:`Symfony\\Component\\Workflow\\Workflow`) or state machine (:class:`Symfony\\Component\\Workflow\\StateMachine`) you have defined in your configuration. This means that you can use ``workflow.pull_request``