vendor/symfony/messenger/Middleware/SendMessageMiddleware.php line 36

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Messenger\Middleware;
  14. use Psr\EventDispatcher\EventDispatcherInterface;
  15. use Psr\Log\LoggerAwareTrait;
  16. use Psr\Log\NullLogger;
  17. use Symfony\Component\Messenger\Envelope;
  18. use Symfony\Component\Messenger\Event\SendMessageToTransportsEvent;
  19. use Symfony\Component\Messenger\Exception\NoSenderForMessageException;
  20. use Symfony\Component\Messenger\Stamp\ReceivedStamp;
  21. use Symfony\Component\Messenger\Stamp\SentStamp;
  22. use Symfony\Component\Messenger\Transport\Sender\SendersLocatorInterface;
  24. /**
  25.  * @author Samuel Roze <samuel.roze@gmail.com>
  26.  * @author Tobias Schultze <http://tobion.de>
  27.  */
  28. class SendMessageMiddleware implements MiddlewareInterface
  29. {
  30.     use LoggerAwareTrait;
  32.     private SendersLocatorInterface $sendersLocator;
  33.     private ?EventDispatcherInterface $eventDispatcher;
  34.     private bool $allowNoSenders;
  36.     public function __construct(SendersLocatorInterface $sendersLocator, EventDispatcherInterface $eventDispatcher = null, bool $allowNoSenders = true)
  37.     {
  38.         $this->sendersLocator = $sendersLocator;
  39.         $this->eventDispatcher = $eventDispatcher;
  40.         $this->allowNoSenders = $allowNoSenders;
  41.         $this->logger = new NullLogger();
  42.     }
  44.     public function handle(Envelope $envelope, StackInterface $stack): Envelope
  45.     {
  46.         $context = [
  47.             'class' => \get_class($envelope->getMessage()),
  48.         ];
  50.         $sender = null;
  52.         if ($envelope->all(ReceivedStamp::class)) {
  53.             // it's a received message, do not send it back
  54.             $this->logger->info('Received message {class}', $context);
  55.         } else {
  56.             $shouldDispatchEvent = true;
  57.             $senders = $this->sendersLocator->getSenders($envelope);
  58.             $senders = \is_array($senders) ? $senders : iterator_to_array($senders);
  59.             foreach ($senders as $alias => $sender) {
  60.                 if (null !== $this->eventDispatcher && $shouldDispatchEvent) {
  61.                     $event = new SendMessageToTransportsEvent($envelope, $senders);
  62.                     $this->eventDispatcher->dispatch($event);
  63.                     $envelope = $event->getEnvelope();
  64.                     $shouldDispatchEvent = false;
  65.                 }
  67.                 $this->logger->info('Sending message {class} with {alias} sender using {sender}', $context + ['alias' => $alias, 'sender' => $sender::class]);
  68.                 $envelope = $sender->send($envelope->with(new SentStamp($sender::class, \is_string($alias) ? $alias : null)));
  69.             }
  71.             if (!$this->allowNoSenders && !$sender) {
  72.                 throw new NoSenderForMessageException(sprintf('No sender for message "%s".', $context['class']));
  73.             }
  74.         }
  76.         if (null === $sender) {
  77.             return $stack->next()->handle($envelope, $stack);
  78.         }
  80.         // message should only be sent and not be handled by the next middleware
  81.         return $envelope;
  82.     }
  83. }