Commit08a12ec

committed

[Workflow] Document the EventNameTrait

1 parent3dba331 commit08a12ecCopy full SHA for 08a12ec

File tree

+15

-1

lines changed

+15

-1

lines changed

Lines changed: 15 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -496,6 +496,7 @@ workflow leaves a place::`
`496`	`496`	`use Psr\Log\LoggerInterface;`
`497`	`497`	`use Symfony\Component\EventDispatcher\EventSubscriberInterface;`
`498`	`498`	`use Symfony\Component\Workflow\Event\Event;`
	`499`	`+ use Symfony\Component\Workflow\Event\LeaveEvent;`
`499`	`500`
`500`	`501`	`class WorkflowLoggerSubscriber implements EventSubscriberInterface`
`501`	`502`	`{`
`@@ -518,11 +519,24 @@ workflow leaves a place::`
`518`	`519`	`public static function getSubscribedEvents(): array`
`519`	`520`	`{`
`520`	`521`	`return [`
`521`		`- 'workflow.blog_publishing.leave' => 'onLeave',`
	`522`	`+ LeaveEvent::getName('blog_publishing') => 'onLeave',`
	`523`	`+ // if you prefer, you can write the event name manually like this:`
	`524`	`+ // 'workflow.blog_publishing.leave' => 'onLeave',`
`522`	`525`	`];`
`523`	`526`	`}`
`524`	`527`	`}`
`525`	`528`
	`529`	`+..tip::`
	`530`	`+`
	`531`	+ All built-in workflow events define the ``getName(?string $workflowName, ?string $transitionOrPlaceName)``
	`532`	`+ method to build the full event name without having to deal with strings.`
	`533`	`+ You can also use this method in your custom events via the`
	`534`	+:class:`Symfony\\Component\\Workflow\\Event\\EventNameTrait`.
	`535`	`+`
	`536`	`+ ..versionadded::7.1`
	`537`	`+`
	`538`	+ The ``getName()`` method was introduced in Symfony 7.1.
	`539`	`+`
`526`	`540`	`If some listeners update the context during a transition, you can retrieve`
`527`	`541`	`it via the marking::`
`528`	`542`

Comments

(0)