Skip to content

Add section about Workflows and State Machine validation #12541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 3, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions workflow/workflow-and-state-machine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -302,4 +302,27 @@ to access the proper service::
// ...
}

Validation: automatic and manual
--------------
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like some - are missing

Workflows and state machines that are defined in a configuration file will be validated automatically during cache warmup. No validation is done upon object instantiation itself. This means that when a workflow or state machine is defined manually instead of using a configuration file, one should consider to perform validation manually as well using either (:class:`Symfony\\Component\\Workflow\\Validator\\WorkflowValidator`) or (:class:`Symfony\\Component\\Workflow\\Validator\\StateMachineValidator`), for example::

// ...
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'),
];

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

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is an extra \n here


.. _`Petri nets`: https://en.wikipedia.org/wiki/Petri_net