vendor/symfony/messenger/HandleTrait.php line 43

Open in your IDE?
  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;
  14. use Symfony\Component\Messenger\Exception\LogicException;
  15. use Symfony\Component\Messenger\Stamp\HandledStamp;
  17. /**
  18.  * Leverages a message bus to expect a single, synchronous message handling and return its result.
  19.  *
  20.  * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
  21.  */
  22. trait HandleTrait
  23. {
  24.     /** @var MessageBusInterface */
  25.     private $messageBus;
  27.     /**
  28.      * Dispatches the given message, expecting to be handled by a single handler
  29.      * and returns the result from the handler returned value.
  30.      * This behavior is useful for both synchronous command & query buses,
  31.      * the last one usually returning the handler result.
  32.      *
  33.      * @param object|Envelope $message The message or the message pre-wrapped in an envelope
  34.      *
  35.      * @return mixed
  36.      */
  37.     private function handle(object $message)
  38.     {
  39.         if (!$this->messageBus instanceof MessageBusInterface) {
  40.             throw new LogicException(sprintf('You must provide a "%s" instance in the "%s::$messageBus" property, "%s" given.', MessageBusInterface::class, static::class, get_debug_type($this->messageBus)));
  41.         }
  43.         $envelope = $this->messageBus->dispatch($message);
  44.         /** @var HandledStamp[] $handledStamps */
  45.         $handledStamps = $envelope->all(HandledStamp::class);
  47.         if (!$handledStamps) {
  48.             throw new LogicException(sprintf('Message of type "%s" was handled zero times. Exactly one handler is expected when using "%s::%s()".', get_debug_type($envelope->getMessage()), static::class, __FUNCTION__));
  49.         }
  51.         if (\count($handledStamps) > 1) {
  52.             $handlers = implode(', ', array_map(function (HandledStamp $stamp): string {
  53.                 return sprintf('"%s"', $stamp->getHandlerName());
  54.             }, $handledStamps));
  56.             throw new LogicException(sprintf('Message of type "%s" was handled multiple times. Only one handler is expected when using "%s::%s()", got %d: %s.', get_debug_type($envelope->getMessage()), static::class, __FUNCTION__, \count($handledStamps), $handlers));
  57.         }
  59.         return $handledStamps[0]->getResult();
  60.     }
  61. }