clarify workflow events #8048
Merged
clarify workflow events #8048
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dbu
commented
Jun 15, 2017
|
|
||
| * ``workflow.guard`` | ||
| * ``workflow.[workflow name].guard`` | ||
| * ``workflow.[workflow name].guard.[transition name]`` |
There was a problem hiding this comment.
i found it illogic that these events are shown below, when they are also events, just a special type of events.
weaverryan
approved these changes
Jun 17, 2017
| @@ -198,6 +211,14 @@ events are dispatched: | |||
| * ``workflow.[workflow name].announce`` | |||
| * ``workflow.[workflow name].announce.[transition name]`` | |||
|
|
|||
| When a state transition is initiated, the events are fired in the following order: | |||
|
|
|||
| - guard: Validate whether the transition is allowed at all (see below); | |||
There was a problem hiding this comment.
Let's link the see below part
| - leave: The object is about to leave a place; | ||
| - transition: The object is going through this transition; | ||
| - enter: The object entered a new place. This is the first event where the object' is marked as being in the new place; | ||
| - announce: Triggered once for each workflow that now is available for the object. |
There was a problem hiding this comment.
I wonder if we could integrate this with the event list above so it's all in one place. Perhaps the name (guard), then indented below the description, then bullets below that with the 3 events. We do something here https://github.com/symfony/symfony-docs/blob/master/introduction/http_fundamentals.rst for GET POST stuff
There was a problem hiding this comment.
thanks. see #8060 for this. it looks nice, at least in the github preview
There was a problem hiding this comment.
Oh, I already opened #8059 in the meantime. 🙈
|
Thank you David. |
xabbuh
added a commit
that referenced
this pull request
Jun 18, 2017
This PR was merged into the 3.2 branch. Discussion ---------- clarify workflow events i was a bit confused by what the events exactly mean. after reading through the code and testing some things, this is what i found. Commits ------- 0070621 clarify workflow events
xabbuh
added a commit
that referenced
this pull request
Jun 18, 2017
xabbuh
added a commit
that referenced
this pull request
Jun 18, 2017
* 3.2: [#8048] some minor tweaks [#8013] revert wrong data provider change correct PHP code Added a missing <script> tag in an example clarify workflow events minor tweak Fix comment to be consistent with the example Reworded the article about slashes in routing placeholders Minor reword of code contribution standards
xabbuh
added a commit
that referenced
this pull request
Jun 18, 2017
* 3.4: [#8048] some minor tweaks [#8013] revert wrong data provider change correct PHP code Added a missing <script> tag in an example Fix variable name in CSFR token example code [AUTOWIRE] Fix invalid yaml code clarify workflow events minor tweak Fix comment to be consistent with the example fix invalid code lines and remove extra space Reworded the article about slashes in routing placeholders Minor reword of code contribution standards
xabbuh
added a commit
that referenced
this pull request
Jun 22, 2017
…abbuh) This PR was merged into the 3.2 branch. Discussion ---------- [Workflow] rearrange how workflow events are presented see @weaverryan's suggestion in #8048 (comment) Commits ------- f7405d2 rearrange how workflow events are presented
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
i was a bit confused by what the events exactly mean. after reading through the code and testing some things, this is what i found.