Workflows and State Machines

Workflows

A workflow is a model of a process in your application. It may be the process of how a blog post goes from draft to review and publish. Another example is when a user submits a series of different forms to complete a task. Such processes are best kept away from your models and should be defined in configuration.

ワークフローは、アプリケーション内のプロセスのモデルです。これは、ブログ投稿が下書きからレビューおよび公開に至るまでのプロセスである可能性があります。もう 1 つの例は、ユーザーがタスクを完了するために一連の異なるフォームを送信する場合です。このようなプロセスは、モデルから遠ざけるのが最善であり、構成で定義する必要があります。

A definition of a workflow consists of places and actions to get from one place to another. The actions are called transitions. A workflow also needs to know each object's position in the workflow. The marking store writes the current place to a property on the object.

ワークフローの定義は、ある場所から別の場所に移動する場所とアクションで構成されます。アクションはトランジションと呼ばれます。ワークフローは、ワークフロー内の各オブジェクトの位置を知る必要もあります。マーキング ストアは、現在の場所をオブジェクトのプロパティに書き込みます。

Note

ノート

The terminology above is commonly used when discussing workflows and Petri nets

上記の用語は、ワークフローとペトリネットについて説明するときに一般的に使用されます

Examples

The simplest workflow looks like this. It contains two places and one transition.

最も単純なワークフローは次のようになります。 2 つの場所と 1 つのトランジションが含まれています。

Workflows could be more complicated when they describe a real business case. The workflow below describes the process to fill in a job application.

実際のビジネス ケースを説明するワークフローは、より複雑になる可能性があります。以下のワークフローでは、求人応募に記入するプロセスについて説明します。

When you fill in a job application in this example there are 4 to 7 steps depending on the job you are applying for. Some jobs require personality tests, logic tests and/or formal requirements to be answered by the user. Some jobs don't. The GuardEvent is used to decide what next steps are allowed for a specific application.

この例の求人応募に記入する場合、応募する仕事に応じて 4 ～ 7 つのステップがあります。一部のジョブでは、ユーザーが回答する性格テスト、論理テスト、および/または正式な要件が必要です。一部のジョブはそうではありません。 GuardEvent は、特定のアプリケーションに許可される次のステップを決定するために使用されます。

By defining a workflow like this, there is an overview how the process looks like. The process logic is not mixed with the controllers, models or view. The order of the steps can be changed by changing the configuration only.

このようにワークフローを定義することで、プロセスがどのように見えるかを概観できます。プロセス ロジックは、コントローラー、モデル、またはビューと混在していません。ステップの順序は、構成を変更するだけで変更できます。

State Machines

A state machine is a subset of a workflow and its purpose is to hold a state of your model. The most important differences between them are:

ステート マシンはワークフローのサブセットであり、その目的はモデルの状態を保持することです。それらの最も重要な違いは次のとおりです。
  • Workflows can be in more than one place at the same time, whereas state machines can't;
    ワークフローは同時に複数の場所に配置できますが、ステートマシンはできません。
  • In order to apply a transition, workflows require that the object is in all the previous places of the transition, whereas state machines only require that the object is at least in one of those places.
    遷移を適用するために、ワークフローではオブジェクトが遷移の前のすべての場所にある必要がありますが、ステート マシンでは、オブジェクトがそれらの場所の少なくとも 1 つにあることだけが必要です。

Example

A pull request starts in an initial "start" state, then a state "test" for e.g. running tests on continuous integration stack. When this is finished, the pull request is in the "review" state, where contributors can require changes, reject or accept the pull request. At any time, you can also "update" the pull request, which will result in another continuous integration run.

プル リクエストは、最初の "start" 状態で開始され、次に状態 "test" で開始されます。継続的インテグレーション スタックで実行中のテスト。これが完了すると、プル リクエストは「レビュー」状態になり、コントリビューターは変更を要求したり、プル リクエストを拒否または承認したりできます。いつでも、プル リクエストを「更新」することもできます。これにより、別の継続的インテグレーションが実行されます。

Below is the configuration for the pull request state machine.

以下は、プル リクエスト ステート マシンの構成です。
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# config/packages/workflow.yaml
framework:
    workflows:
        pull_request:
            type: 'state_machine'
            marking_store:
                 type: 'method'
                 property: 'currentPlace'
            supports:
                - App\Entity\PullRequest
            initial_marking: start
            places:
                - start
                - coding
                - test
                - review
                - merged
                - closed
            transitions:
                submit:
                    from: start
                    to: test
                update:
                    from: [coding, test, review]
                    to: test
                wait_for_review:
                    from: test
                    to: review
                request_change:
                    from: review
                    to: coding
                accept:
                    from: review
                    to: merged
                reject:
                    from: review
                    to: closed
                reopen:
                    from: closed
                    to: review

In a Symfony application using the default services.yaml configuration, you can get this state machine by injecting the Workflow registry service:

デフォルトの services.yaml 構成を使用する Symfony アプリケーションでは、ワークフロー レジストリ サービスを注入することで、このステート マシンを取得できます。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
// ...
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 (Workflow) or state machine (StateMachine) you have defined in your configuration. This means that you can use workflow.pull_request or state_machine.pull_request respectively in your service definitions to access the proper service:

symfony は、構成で定義した各ワークフロー (Workflow) またはステート マシン (StateMachine) のサービスを自動的に作成します。これは、適切なサービスにアクセスするために、サービス定義でそれぞれ workflow.pull_request または state_machine.pull_request を使用できることを意味します。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
// ...
use App\Entity\PullRequest;
use Symfony\Component\Workflow\StateMachine;

class SomeService
{
    private $stateMachine;

    public function __construct(StateMachine $stateMachine)
    {
        $this->stateMachine = $stateMachine;
    }

    public function someMethod(PullRequest $pullRequest)
    {
        $this->stateMachine->apply($pullRequest, 'wait_for_review', [
            'log_comment' => 'My logging comment for the wait for review transition.',
        ]);
        // ...
    }

    // ...
}

Automatic and Manual Validation

During cache warmup, Symfony validates the workflows and state machines that are defined in configuration files. If your workflows or state machines are defined programmatically instead of in a configuration file, you can validate them with the WorkflowValidator and StateMachineValidator:

キャッシュのウォームアップ中に、Symfony は構成ファイルで定義されているワークフローとステート マシンを検証します。ワークフローまたはステート マシンが構成ファイルではなくプログラムで定義されている場合は、WorkflowValidator および StateMachineValidator を使用してそれらを検証できます。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
// ...
use Symfony\Component\Workflow\Definition;
use Symfony\Component\Workflow\StateMachine;
use Symfony\Component\Workflow\Validator\StateMachineValidator;

$states = ['created', 'activated', 'deleted'];
$stateTransitions = [
    new Transition('activate', 'created', 'activated'),
    // This duplicate event "from" the "created" state is invalid
    new Transition('activate', 'created', 'deleted'),
    new Transition('delete', 'activated', 'deleted'),
];

// No validation is done upon initialization
$definition = new Definition($states, $stateTransitions);

$validator = new StateMachineValidator();
// Throws InvalidDefinitionException in case of an invalid definition
$validator->validate($definition, 'My First StateMachine');