Skip to content

Commit 992be34

Browse files
Workflow configuration
1 parent 892bbda commit 992be34

File tree

1 file changed

+41
-29
lines changed

1 file changed

+41
-29
lines changed

reference/configuration/framework.rst

Lines changed: 41 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -198,14 +198,14 @@ Configuration
198198
* :ref:`enabled <reference-workflows-enabled>`
199199
* :ref:`name <reference-workflows-name>`
200200

201-
* `audit_trail`_
202-
* `initial_place`_
203-
* `marking_store`_
204-
* `places`_
201+
* :ref:`type <reference-workflows-type>`
205202
* `supports`_
206203
* `support_strategy`_
204+
* `marking_store`_
205+
* `places`_
206+
* `initial_place`_
207207
* `transitions`_
208-
* :ref:`type <reference-workflows-type>`
208+
* `audit_trail`_
209209

210210
secret
211211
~~~~~~
@@ -2249,15 +2249,28 @@ name
22492249

22502250
Name of the workflow you want to create.
22512251

2252-
audit_trail
2253-
"""""""""""
2252+
.. _reference-workflows-type:
22542253

2255-
**type**: ``array``
2254+
type
2255+
""""
22562256

2257-
initial_place
2258-
"""""""""""""
2257+
**type**: ``string`` **possible values**: ``'workflow'`` or ``'state_machine'``
22592258

2260-
**type**: ``string`` **default**: ``null``
2259+
Defines the kind of workflow that is going to be created, which can be either
2260+
a normal workflow or a state machine. Read :doc:`this article </workflow/introduction>`
2261+
to know their differences.
2262+
2263+
supports
2264+
""""""""
2265+
2266+
**type**: ``string`` | ``array``
2267+
2268+
Object(s) that is(are) supported by this workflow configuration.
2269+
2270+
support_strategy
2271+
""""""""""""""""
2272+
2273+
**type**: ``string``
22612274

22622275
marking_store
22632276
"""""""""""""
@@ -2276,15 +2289,16 @@ places
22762289

22772290
**type**: ``array``
22782291

2279-
supports
2280-
""""""""
2292+
All available places for this workflow configuration.
22812293

2282-
**type**: ``string`` | ``array``
2294+
initial_place
2295+
"""""""""""""
22832296

2284-
support_strategy
2285-
""""""""""""""""
2297+
**type**: ``string`` **default**: ``null``
22862298

2287-
**type**: ``string``
2299+
One of the ``places`` or ``null``.
2300+
If not null and the supported object is not already initialized via the workflow,
2301+
this place will be set.
22882302

22892303
transitions
22902304
"""""""""""
@@ -2293,22 +2307,20 @@ transitions
22932307

22942308
Each marking store can define any of these options:
22952309

2296-
* ``from`` (**type**: ``string``)
2297-
* ``guard`` (**type**: ``string``) a :doc:`ExpressionLanguage </components/expression_language>`
2310+
* ``name`` (**type**: ``string``) the name of the transition
2311+
* ``guard`` (**type**: ``string``) an :doc:`ExpressionLanguage </components/expression_language>`
22982312
compatible expression to block the transition
2299-
* ``name`` (**type**: ``string``)
2300-
* ``to`` (**type**: ``string``)
2313+
* ``from`` (**type**: ``string`` or ``array``) value from the ``places``,
2314+
multiple values are allowed for both ``workflow`` and ``statemachine``
2315+
* ``to`` (**type**: ``string`` or ``array``) value from the ``places``,
2316+
multiple values are allowed only for ``workflow``
23012317

2302-
.. _reference-workflows-type:
2303-
2304-
type
2305-
""""
2318+
audit_trail
2319+
"""""""""""
23062320

2307-
**type**: ``string`` **possible values**: ``'workflow'`` or ``'state_machine'``
2321+
**type**: ``bool``
23082322

2309-
Defines the kind of workflow that is going to be created, which can be either
2310-
a normal workflow or a state machine. Read :doc:`this article </workflow/introduction>`
2311-
to know their differences.
2323+
Whether to enable automatically the :class:`Symfony\\Component\\Workflow\\EventListener\\AuditTrailListener`.
23122324

23132325
.. _`HTTP Host header attacks`: http://www.skeletonscribe.net/2013/05/practical-http-host-header-attacks.html
23142326
.. _`Security Advisory Blog post`: https://symfony.com/blog/security-releases-symfony-2-0-24-2-1-12-2-2-5-and-2-3-3-released#cve-2013-4752-request-gethost-poisoning

0 commit comments

Comments
 (0)