[Workflow] config doc

noniagriconomie · wouterj · commit 34e7cc52d88b · 2019-08-12T22:37:58.000+02:00
diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst
@@ -255,7 +255,7 @@ Configuration
   * :ref:`name <reference-workflows-name>`
 
     * `audit_trail`_
-    * `initial_place`_
+    * `initial_marking`_
     * `marking_store`_
     * `places`_
     * `supports`_
@@ -2736,12 +2736,12 @@ audit_trail
 If set to ``true``, the :class:`Symfony\\Component\\Workflow\\EventListener\\AuditTrailListener`
 will be enabled.
 
-initial_place
-"""""""""""""
+initial_marking
+"""""""""""""""
 
-**type**: ``string`` **default**: ``null``
+**type**: ``string`` | ``array``
 
-One of the ``places`` or ``null``. If not null and the supported object is not
+One of the ``places`` or ``empty``. If not null and the supported object is not
 already initialized via the workflow, this place will be set.
 
 marking_store
@@ -2753,8 +2753,7 @@ Each marking store can define any of these options:
 
 * ``arguments`` (**type**: ``array``)
 * ``service`` (**type**: ``string``)
-* ``type`` (**type**: ``string`` **possible values**: ``'multiple_state'`` or
-  ``'single_state'``)
+* ``type`` (**type**: ``string`` **allow value**: ``'method'``)
 
 places
 """"""
diff --git a/workflow.rst b/workflow.rst
@@ -54,12 +54,12 @@ like this:
                     audit_trail:
                         enabled: true
                     marking_store:
-                        type: 'multiple_state' # or 'single_state'
-                        arguments:
+                        type: 'method'
+                        property:
                             - 'currentPlace'
                     supports:
                         - App\Entity\BlogPost
-                    initial_place: draft
+                    initial_marking: draft
                     places:
                         - draft
                         - reviewed
@@ -134,8 +134,8 @@ like this:
                         'enabled' => true
                     ],
                     'marking_store' => [
-                        'type' => 'multiple_state', // or 'single_state'
-                        'arguments' => ['currentPlace']
+                        'type' => 'method'
+                        'property' => ['currentPlace']
                     ],
                     'supports' => ['App\Entity\BlogPost'],
                     'places' => [
@@ -177,18 +177,6 @@ As configured, the following property is used by the marking store::
         public $content;
     }
 
-.. note::
-
-    The marking store type could be "multiple_state" or "single_state". A single
-    state marking store does not support a model being on multiple places at the
-    same time.
-
-.. tip::
-
-    The ``type`` (default value ``single_state``) and ``arguments`` (default
-    value ``marking``) attributes of the ``marking_store`` option are optional.
-    If omitted, their default values will be used.
-
 .. tip::
 
     Setting the ``audit_trail.enabled`` option to ``true`` makes the application
diff --git a/workflow/introduction.rst b/workflow/introduction.rst
@@ -79,7 +79,7 @@ Below is the configuration for the pull request state machine.
                     type: 'state_machine'
                     supports:
                         - App\Entity\PullRequest
-                    initial_place: start
+                    initial_marking: start
                     places:
                         - start
                         - coding
