Skip to content

Commit 0435d4a

Browse files
committed
[Workflow] Document the EventNameTrait
1 parent 3dba331 commit 0435d4a

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',
522523
];
523524
}
524525
}
525526

527+
.. tip::
528+
529+
All built-in workflow events define the ``getName(?string $workflowName, ?string $transitionOrPlaceName)``
530+
method to build the full event name (e.g. ``'workflow.blog_publishing.leave'``)
531+
without having to work with strings.
532+
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)