Skip to content

Commit f06e595

Browse files
committed
minor #19706 [Workflow] Document the EventNameTrait (javiereguiluz)
This PR was squashed before being merged into the 7.1 branch. Discussion ---------- [Workflow] Document the EventNameTrait Fixes #19694. Commits ------- 08a12ec [Workflow] Document the EventNameTrait
2 parents 166d57a + 08a12ec commit f06e595

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

workflow.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -496,6 +496,7 @@ workflow leaves a place::
496496
use Psr\Log\LoggerInterface;
497497
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
498498
use Symfony\Component\Workflow\Event\Event;
499+
use Symfony\Component\Workflow\Event\LeaveEvent;
499500

500501
class WorkflowLoggerSubscriber implements EventSubscriberInterface
501502
{
@@ -518,11 +519,24 @@ workflow leaves a place::
518519
public static function getSubscribedEvents(): array
519520
{
520521
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',
522525
];
523526
}
524527
}
525528

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+
526540
If some listeners update the context during a transition, you can retrieve
527541
it via the marking::
528542

0 commit comments

Comments
 (0)