Skip to content

[WiP] Document Workflow 4.3 changes #11211

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.

Sign up for GitHub

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

Closed
wants to merge 4 commits into from
Closed

[WiP] Document Workflow 4.3 changes #11211

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e1c0e04
Document 4.3 `marking_store` changes. Have reservations from a DX per…
pbowyer Mar 23, 2019
6c636cb
Update `initial_place` to `initial_places`.
pbowyer Mar 23, 2019
6cac400
Incorporate feedback from @lyrixx
pbowyer Apr 7, 2019
4320d54
Change to `initial_marking` in the State Machine documentation
pbowyer Apr 7, 2019
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
Prev Previous commit
Next Next commit
Incorporate feedback from @lyrixx
  • Loading branch information
@pbowyer
pbowyer committed Apr 7, 2019
commit 6cac400bfb9e87fc37e9cc6ee04d8a8548fd187b
38 changes: 19 additions & 19 deletions workflow/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,12 @@ like this:
audit_trail:
enabled: true
marking_store:
type: 'method'
arguments:
- false
- 'currentPlace'
# Method will become the default value in Symfony 5.0
type: method
property: currentPlace
supports:
- App\Entity\BlogPost
initial_places: [draft]
initial_marking: [draft]
places:
- draft
- review
Expand Down Expand Up @@ -81,10 +80,9 @@ like this:
<framework:workflow name="blog_publishing" type="workflow">
<framework:audit-trail enabled="true"/>

<framework:marking-store type="method">
<framework:argument>false</framework:argument>
<framework:argument>currentPlace</framework:argument>
</framework:marking-store>
<framework:initial-marking>draft</framework:initial-marking>
<!-- Method will become the default value in Symfony 5.0 -->
<framework:marking-store type="method" property="state" />

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't use XML config, can someone please provide the initial_places code for it.

Copy link
Contributor

Choose a reason for hiding this comment

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

You can add many like this https://github.com/symfony/symfony/pull/30468/files#diff-0b1fae456d162214b077b0e1be47b40cR11.

Copy link
Member

Choose a reason for hiding this comment

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

It would be nice to add it in the code doc.
Here is the final ref

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe I've done this correctly!

<framework:support>App\Entity\BlogPost</framework:support>

Expand Down Expand Up @@ -129,14 +127,12 @@ like this:
'enabled' => true
],
'marking_store' => [
// Method will become the default value in Symfony 5.0
'type' => 'method',
'arguments' => [
false,
'currentPlace',
],
'property' => 'currentPlace',
],
'supports' => ['App\Entity\BlogPost'],
'initial_places' => ['draft'],
'initial_marking' => ['draft'],
'places' => [
'draft',
'review',
Expand Down Expand Up @@ -174,14 +170,18 @@ As configured, the following property is used by the marking store::
.. note::

The Workflow Component supports workflows that can be in one or multiple places
(states) at the same time. To restrict a workflow to a single state, set the first
argument to ``true`` when defining the ``marking_store``.
(states) at the same time.

If the subject can be in only on state: use a state machine. In that case, the
property (named ``marking`` by default) will be a string.

If the subject can be in many places: use a workflow. In that case, the property will be an array.

.. tip::

The ``type`` (default value ``method``) and ``arguments`` (default
values ``false`` and ``marking``) attributes of the ``marking_store`` option are optional.
If omitted, their default values will be used.
The ``type`` (default value ``method``) and ``property`` (default
value ``marking``) attributes of the ``marking_store`` option are optional.
If omitted, the default values will be used.

.. tip::

Expand Down