8000 Document 4.3 `marking_store` changes. Have reservations from a DX per… · symfony/symfony-docs@6f51164 · GitHub
[go: up one dir, main page]

Skip to content

Commit 6f51164

Browse files
committed
Document 4.3 marking_store changes. Have reservations from a DX perspective, see https://github.com/symfony/symfony/pull/30551/files#r268391471
1 parent 73fdf61 commit 6f51164

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

workflow/usage.rst

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,9 @@ like this:
4343
audit_trail:
4444
enabled: true
4545
marking_store:
46-
type: 'multiple_state' # or 'single_state'
46+
type: 'method'
4747
arguments:
48+
- false
4849
- 'currentPlace'
4950
supports:
5051
- App\Entity\BlogPost
@@ -80,7 +81,8 @@ like this:
8081
<framework:workflow name="blog_publishing" type="workflow">
8182
<framework:audit-trail enabled="true"/>
8283
83-
<framework:marking-store type="single_state">
84+
<framework:marking-store type="method">
85+
<framework:argument>false</framework:argument>
8486
<framework:argument>currentPlace</framework:argument>
8587
</framework:marking-store>
8688
@@ -127,8 +129,11 @@ like this:
127129
'enabled' => true
128130
],
129131
'marking_store' => [
130-
'type' => 'multiple_state', // or 'single_state'
131-
'arguments' => ['currentPlace'],
132+
'type' => 'method',
133+
'arguments' => [
134+
false,
135+
'currentPlace',
136+
],
132137
],
133138
'supports' => ['App\Entity\BlogPost'],
134139
'places' => [
@@ -167,14 +172,14 @@ As configured, the following property is used by the marking store::
167172

168173
.. note::
169174

170-
The marking store type could be "multiple_state" or "single_state".
171-
A single state marking store does not support a model being on multiple places
172-
at the same time.
175+
The Workflow Component supports workflows that can be in one or multiple places
176+
(states) at the same time. To restrict a workflow to a single state, set the first
177+
argument to ``true`` when defining the ``marking_store``.
173178

174179
.. tip::
175180

176-
The ``type`` (default value ``single_state``) and ``arguments`` (default
177-
value ``marking``) attributes of the ``marking_store`` option are optional.
181+
The ``type`` (default value ``method``) and ``arguments`` (default
182+
values ``false`` and ``marking``) attributes of the ``marking_store`` option are optional.
178183
If omitted, their default values will be used.
179184

180185
.. tip::

0 commit comments

Comments
 (0)
0