8000 [EventDispatcher] Document dispatch() with one argument as a FQCN by 94noni · Pull Request #17035 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
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.

Sign up for GitHub

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

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6eeea59
Update event_dispatcher.rst
94noni Jul 22, 2022
7c8b2fe
Update event_dispatcher.rst
94noni Aug 4, 2022
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
Prev Previous commit
Update event_dispatcher.rst
  • Loading branch information
@94noni
94noni authored Aug 4, 2022
commit 7c8b2fe0a3a85c35166961dff2ffca98cd9d9cf9
23 changes: 12 additions & 11 deletions components/event_dispatcher.rst
View file
Open in desktop
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 placed
* 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,19 +328,20 @@ 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);

Expand Down Expand Up @@ -378,7 +379,7 @@ 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 => [
Expand All @@ -391,17 +392,17 @@ Take the following example of a subscriber that subscribes to the
];
}

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

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

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