Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 34e7cc5

Browse filesBrowse files
noniagriconomiewouterj
authored andcommitted
[Workflow] config doc
1 parent e8d6eb4 commit 34e7cc5
Copy full SHA for 34e7cc5

File tree

3 files changed

+12
-25
lines changed
Filter options

3 files changed

+12
-25
lines changed

‎reference/configuration/framework.rst

Copy file name to clipboardExpand all lines: reference/configuration/framework.rst
+6-7Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ Configuration
255255
* :ref:`name <reference-workflows-name>`
256256

257257
* `audit_trail`_
258-
* `initial_place`_
258+
* `initial_marking`_
259259
* `marking_store`_
260260
* `places`_
261261
* `supports`_
@@ -2736,12 +2736,12 @@ audit_trail
27362736
If set to ``true``, the :class:`Symfony\\Component\\Workflow\\EventListener\\AuditTrailListener`
27372737
will be enabled.
27382738

2739-
initial_place
2740-
"""""""""""""
2739+
initial_marking
2740+
"""""""""""""""
27412741

2742-
**type**: ``string`` **default**: ``null``
2742+
**type**: ``string`` | ``array``
27432743

2744-
One of the ``places`` or ``null``. If not null and the supported object is not
2744+
One of the ``places`` or ``empty``. If not null and the supported object is not
27452745
already initialized via the workflow, this place will be set.
27462746

27472747
marking_store
@@ -2753,8 +2753,7 @@ Each marking store can define any of these options:
27532753

27542754
* ``arguments`` (**type**: ``array``)
27552755
* ``service`` (**type**: ``string``)
2756-
* ``type`` (**type**: ``string`` **possible values**: ``'multiple_state'`` or
2757-
``'single_state'``)
2756+
* ``type`` (**type**: ``string`` **allow value**: ``'method'``)
27582757

27592758
places
27602759
""""""

‎workflow.rst

Copy file name to clipboardExpand all lines: workflow.rst
+5-17Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@ like this:
5454
audit_trail:
5555
enabled: true
5656
marking_store:
57-
type: 'multiple_state' # or 'single_state'
58-
arguments:
57+
type: 'method'
58+
property:
5959
- 'currentPlace'
6060
supports:
6161
- App\Entity\BlogPost
62-
initial_place: draft
62+
initial_marking: draft
6363
places:
6464
- draft
6565
- reviewed
@@ -134,8 +134,8 @@ like this:
134134
'enabled' => true
135135
],
136136
'marking_store' => [
137-
'type' => 'multiple_state', // or 'single_state'
138-
'arguments' => ['currentPlace']
137+
'type' => 'method'
138+
'property' => ['currentPlace']
139139
],
140140
'supports' => ['App\Entity\BlogPost'],
141141
'places' => [
@@ -177,18 +177,6 @@ As configured, the following property is used by the marking store::
177177
public $content;
178178
}
179179

180-
.. note::
181-
182-
The marking store type could be "multiple_state" or "single_state". A single
183-
state marking store does not support a model being on multiple places at the
184-
same time.
185-
186-
.. tip::
187-
188-
The ``type`` (default value ``single_state``) and ``arguments`` (default
189-
value ``marking``) attributes of the ``marking_store`` option are optional.
190-
If omitted, their default values will be used.
191-
192180
.. tip::
193181

194182
Setting the ``audit_trail.enabled`` option to ``true`` makes the application

‎workflow/introduction.rst

Copy file name to clipboardExpand all lines: workflow/introduction.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Below is the configuration for the pull request state machine.
7979
type: 'state_machine'
8080
supports:
8181
- App\Entity\PullRequest
82-
initial_place: start
82+
initial_marking: start
8383
places:
8484
- start
8585
- coding

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.