symfony/symfony-docsPublic

NotificationsYou must be signed in to change notification settings
Fork5.2k
Star2.3k

Added explaination on context in events and initial marking#13947

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

epitre wants to merge2 commits intosymfony:masterfromShaurifr:eventWithContext

Closed

Added explaination on context in events and initial marking#13947

epitre wants to merge2 commits intosymfony:masterfromShaurifr:eventWithContext

Conversation

Copy link

Contributor

epitre commentedJul 9, 2020

No description provided.

carsonbot added the Status: Needs Review label

Jul 9, 2020

epitre mentioned this pull request

Jul 9, 2020

[Workflow] Added Context to Workflow Eventsymfony/symfony#37539

Merged

epitre force-pushed theeventWithContext branch from692ca8b to58e28f2Compare

July 9, 2020 10:37

Added explaination on context in events and initial marking

82a94f7

epitre force-pushed theeventWithContext branch from58e28f2 to82a94f7Compare

July 9, 2020 10:50

Copy link

pluk77 commentedJul 9, 2020

@epitre Nice solution, which will indeed also solve the issue of the non-dispatched initial entered event.

Copy link

pluk77 commentedJul 9, 2020

@epitre Perhaps you can also add a note about the initial marking option to make it clear it is optional and will default to the first place if not defined.

Copy link

ContributorAuthor

epitre commentedJul 9, 2020

@epitre Perhaps you can also add a note about the initial marking option to make it clear it is optional and will default to the first place if not defined.

it is explained here :https://github.com/symfony/symfony-docs/pull/13947/files#diff-c94d89e3669d4257383cfe5faf73e644R97

Copy link

pluk77 commentedJul 9, 2020

@epitre Perhaps you can also add a note about the initial marking option to make it clear it is optional and will default to the first place if not defined.
it is explained here :https://github.com/symfony/symfony-docs/pull/13947/files#diff-c94d89e3669d4257383cfe5faf73e644R97

I was more referring to the config optioninitial_marking in the workflow configuration file (yml, xml, php). It is not clear from the current docs that the initial marking will always be the place that is first in the list of defined places, unless you set a different place usinginitial_marking.

Even if you do not instantiate the workflow by usinggetMarking() but go directly toapply() the subject will still be placed in the initial place first if there is no marking on the subject yet.

Hope I am making sense?

u-mulder reviewed

Jul 10, 2020

View reviewed changes

components/workflow.rst Outdated

		@@ -94,6 +94,16 @@ you can retrieve a workflow from it and use it as follows::
		$workflow->can($blogPost, 'publish'); // True
		$workflow->getEnabledTransitions($blogPost); // $blogPost can perform transition "publish" or "reject"

		If you want to initiate your worflow, you can simply call ``getMarking``::

Copy link

Contributor

u-mulderJul 10, 2020

Choose a reason for hiding this comment

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

workflow withk

Copy link

ContributorAuthor

epitreJul 11, 2020

Choose a reason for hiding this comment

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

thanks

typo

a3fd749

lyrixx added a commit to symfony/symfony that referenced this pull request

Aug 12, 2020

feature#37539[Workflow] Added Context to Workflow Event (epitre)

25095d8

This PR was merged into the 5.2-dev branch.Discussion----------[Workflow] Added Context to Workflow EventThere's also a default context for the initial marking event.| Q             | A| ------------- | ---| Branch?       | master| Bug fix?      | no| New feature?  | yes| Deprecations? | no| Tickets       |Fix#37421| License       | MIT| Doc PR        |symfony/symfony-docs#13947This time, I need context in the events, because, sometimes, the transition is automatic and sometimes, it is manual. I want to be able to make the difference. I figured using the context for that is a good idea. I hope you do too :)By the way, I believe it alsofixes#37421 . I took@pluk77 request to be able to differentiate an initial marking by having a default context in that caseCommits-------bfe07dd Added Context to Workflow Event There's also a default context for the initial marking event.

symfony-splitter pushed a commit to symfony/twig-bridge that referenced this pull request

Aug 12, 2020

feature #37539 [Workflow] Added Context to Workflow Event (epitre)

93fec2c

This PR was merged into the 5.2-dev branch.Discussion----------[Workflow] Added Context to Workflow EventThere's also a default context for the initial marking event.| Q             | A| ------------- | ---| Branch?       | master| Bug fix?      | no| New feature?  | yes| Deprecations? | no| Tickets       | Fix #37421| License       | MIT| Doc PR        |symfony/symfony-docs#13947This time, I need context in the events, because, sometimes, the transition is automatic and sometimes, it is manual. I want to be able to make the difference. I figured using the context for that is a good idea. I hope you do too :)By the way, I believe it also fixes #37421 . I took@pluk77 request to be able to differentiate an initial marking by having a default context in that caseCommits-------bfe07dda83 Added Context to Workflow Event There's also a default context for the initial marking event.