Skip to content

Clarify the "enter(-ed)" events #9210

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 2 commits into from
Closed

Clarify the "enter(-ed)" events #9210

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
815edcc
Clarify the "enter(-ed)" events
thePanz Feb 20, 2018
b16681b
Minor reword
javiereguiluz Feb 23, 2018
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
15 changes: 8 additions & 7 deletions workflow/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ order:
* ``workflow.[workflow name].guard.[transition name]``

``workflow.leave``
The object is about to leave a place.
The subject is about to leave a place.

The three events being dispatched are:

Expand All @@ -212,7 +212,7 @@ order:
* ``workflow.[workflow name].leave.[place name]``

``workflow.transition``
The object is going through this transition.
The subject is going through this transition.

The three events being dispatched are:

Expand All @@ -221,8 +221,9 @@ order:
* ``workflow.[workflow name].transition.[transition name]``

``workflow.enter``
The object entered a new place. This is the first event where the object
is marked as being in the new place.
The subject is about to enter a new place. This event is triggered just
before the subject places are updated, which means that the marking of the
subject is not yet updated with the new places.

The three events being dispatched are:

Expand All @@ -231,8 +232,8 @@ order:
* ``workflow.[workflow name].enter.[place name]``

``workflow.entered``
Similar to ``workflow.enter``, except the marking store is updated before this
event (making it a good place to flush data in Doctrine).
The subject has entered in the places and the marking is updated (making it a good
place to flush data in Doctrine).

The three events being dispatched are:

Expand All @@ -241,7 +242,7 @@ order:
* ``workflow.[workflow name].entered.[place name]``

``workflow.announce``
Triggered for each transition that now is accessible for the object.
Triggered for each transition that now is accessible for the subject.

The three events being dispatched are:

Expand Down