Skip to content

[EventDispatcher] Document dispatch() with one argument as a FQCN #17035

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions components/event_dispatcher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -291,14 +291,14 @@ order. Start by creating this custom event class and documenting it::
use Symfony\Contracts\EventDispatcher\Event;

/**
* The order.placed event is dispatched each time an order is created
* in the system.
* The order.placed event is dispatched each time
* an order is placed in the system.
*/
class OrderPlacedEvent extends Event
{
public const NAME = 'order.placed';

protected $order;
protected Order $order;

public function __construct(Order $order)
{
Expand Down Expand Up @@ -328,18 +328,22 @@ Dispatch the Event
The :method:`Symfony\\Component\\EventDispatcher\\EventDispatcher::dispatch`
method notifies all listeners of the given event. It takes two arguments:
the ``Event`` instance to pass to each listener of that event and the name
of the event to dispatch::
of the event to dispatch. Alternatively, it can takes only one argument: the
``Event`` instance itself::

use Acme\Store\Event\OrderPlacedEvent;
use Acme\Store\Order;

// the order is somehow created or retrieved
// the order is somehow created
$order = new Order();
// ...

// creates the OrderPlacedEvent and dispatches it
$event = new OrderPlacedEvent($order);
$dispatcher->dispatch($event, OrderPlacedEvent::NAME);

$dispatcher->dispatch($event, OrderPlacedEvent::NAME);
// alternatively, you can also dispatch the event like this
$dispatcher->dispatch($event);

Notice that the special ``OrderPlacedEvent`` object is created and passed to
the ``dispatch()`` method. Now, any listener to the ``order.placed``
Expand Down Expand Up @@ -375,28 +379,30 @@ Take the following example of a subscriber that subscribes to the

class StoreSubscriber implements EventSubscriberInterface
{
public static function getSubscribedEvents()
public static function getSubscribedEvents(): array
{
return [
KernelEvents::RESPONSE => [
['onKernelResponsePre', 10],
['onKernelResponsePost', -10],
],
OrderPlacedEvent::NAME => 'onStoreOrder',
OrderPlacedEvent::NAME => 'onOrderPlaced',
// alternatively, you can also subscribe to the event like this
OrderPlacedEvent::class => 'onOrderPlaced',
];
}

public function onKernelResponsePre(ResponseEvent $event)
public function onKernelResponsePre(ResponseEvent $event): void
{
// ...
}

public function onKernelResponsePost(ResponseEvent $event)
public function onKernelResponsePost(ResponseEvent $event): void
{
// ...
}

public function onStoreOrder(OrderPlacedEvent $event)
public function onOrderPlaced(OrderPlacedEvent $event): void
{
// ...
}
Expand Down