vendor/symfony/messenger/Stamp/HandledStamp.php line 28

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\Stamp;
  14. use Symfony\Component\Messenger\Handler\HandlerDescriptor;
  16. /**
  17.  * Stamp identifying a message handled by the `HandleMessageMiddleware` middleware
  18.  * and storing the handler returned value.
  19.  *
  20.  * This is used by synchronous command buses expecting a return value and the retry logic
  21.  * to only execute handlers that didn't succeed.
  22.  *
  23.  * @see \Symfony\Component\Messenger\Middleware\HandleMessageMiddleware
  24.  * @see \Symfony\Component\Messenger\HandleTrait
  25.  *
  26.  * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
  27.  */
  28. final class HandledStamp implements StampInterface
  29. {
  30.     private $result;
  31.     private $handlerName;
  33.     /**
  34.      * @param mixed $result The returned value of the message handler
  35.      */
  36.     public function __construct($result, string $handlerName)
  37.     {
  38.         $this->result = $result;
  39.         $this->handlerName = $handlerName;
  40.     }
  42.     /**
  43.      * @param mixed $result The returned value of the message handler
  44.      */
  45.     public static function fromDescriptor(HandlerDescriptor $handler, $result): self
  46.     {
  47.         return new self($result, $handler->getName());
  48.     }
  50.     /**
  51.      * @return mixed
  52.      */
  53.     public function getResult()
  54.     {
  55.         return $this->result;
  56.     }
  58.     public function getHandlerName(): string
  59.     {
  60.         return $this->handlerName;
  61.     }
  62. }