Commit82a94f7

committed

Added explaination on context in events and initial marking

1 parent57e3020 commit82a94f7Copy full SHA for 82a94f7

File tree

+25

-0

lines changed

+25

-0

lines changed

Lines changed: 10 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,16 @@ you can retrieve a workflow from it and use it as follows::`
`94`	`94`	`$workflow->can($blogPost, 'publish'); // True`
`95`	`95`	`$workflow->getEnabledTransitions($blogPost); // $blogPost can perform transition "publish" or "reject"`
`96`	`96`
	`97`	+If you want to initiate your worflow, you can simply call ``getMarking``::
	`98`	`+`
	`99`	`+ // ...`
	`100`	`+ $blogPost = new BlogPost();`
	`101`	`+ $workflow = $registry->get($blogPost);`
	`102`	`+`
	`103`	`+ // initiate workflow`
	`104`	`+ $workflow->getMarking($blogPost);`
	`105`	`+`
	`106`	`+`
`97`	`107`	`Learn more`
`98`	`108`	`----------`
`99`	`109`

Lines changed: 15 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -356,11 +356,26 @@ order:`
`356`	`356`
`357`	`357`	The ``Workflow::DISABLE_ANNOUNCE_EVENT`` constant was introduced in Symfony 5.1.
`358`	`358`
	`359`	`+ ..versionadded::5.2`
	`360`	`+`
	`361`	`+ The context will be accessible in all the events::`
	`362`	`+`
	`363`	`+ // $context must be an array`
	`364`	`+ $context = ['context'];`
	`365`	`+ $workflow->apply($subject, $transitionName, $context);`
	`366`	`+`
	`367`	`+ // in an event listener`
	`368`	`+ $context = $event->getContext(); // returns ['context']`
	`369`	`+`
`359`	`370`	`..note::`
`360`	`371`
`361`	`372`	`The leaving and entering events are triggered even for transitions that stay`
`362`	`373`	`in same place.`
`363`	`374`
	`375`	`+..note::`
	`376`	`+`
	`377`	+ If you initialize the marking by calling ``$workflow->getMarking($object);``, then the ``workflow.[workflow name].entered.[initial place name]`` will be called with a default context ``Workflow::DEFAULT_INITIAL_CONTEXT``
	`378`	`+`
`364`	`379`	`Here is an example of how to enable logging for every time a "blog_publishing"`
`365`	`380`	`workflow leaves a place::`
`366`	`381`

Comments

(0)