vendor/sonata-project/notification-bundle/src/Backend/PostponeRuntimeBackend.php line 77

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the Sonata Project package.
  7.  *
  8.  * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Sonata\NotificationBundle\Backend;
  16. use Sonata\NotificationBundle\Iterator\IteratorProxyMessageIterator;
  17. use Sonata\NotificationBundle\Model\MessageInterface;
  18. use Symfony\Component\EventDispatcher\Event;
  19. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  20. use ZendDiagnostics\Result\Success;
  22. /**
  23.  * This backend postpones the handling of messages to a registered event.
  24.  *
  25.  * It's based on the asynchronous event dispatcher:
  26.  *
  27.  * @see https://gist.github.com/3852361
  28.  *
  29.  * @author Toni Uebernickel <tuebernickel@gmail.com>
  30.  */
  31. class PostponeRuntimeBackend extends RuntimeBackend
  32. {
  33.     /**
  34.      * @var MessageInterface[]
  35.      */
  36.     protected $messages = [];
  38.     /**
  39.      * If set to true, you have to fire an event the onEvent method is subscribed to manually!
  40.      *
  41.      * @var bool
  42.      */
  43.     protected $postponeOnCli = false;
  45.     /**
  46.      * @param bool $postponeOnCli Whether to postpone the messages on the CLI, too
  47.      */
  48.     public function __construct(EventDispatcherInterface $dispatcher, $postponeOnCli = false)
  49.     {
  50.         parent::__construct($dispatcher);
  52.         $this->postponeOnCli = $postponeOnCli;
  53.     }
  55.     /**
  56.      * {@inheritdoc}
  57.      */
  58.     public function publish(MessageInterface $message)
  59.     {
  60.         // if the message is generated from the cli the message is handled
  61.         // directly as there is no kernel.terminate in cli
  62.         if (!$this->postponeOnCli && $this->isCommandLineInterface()) {
  63.             $this->handle($message, $this->dispatcher);
  65.             return;
  66.         }
  68.         $this->messages[] = $message;
  69.     }
  71.     /**
  72.      * Listen on any event and handle the messages.
  73.      *
  74.      * Actually, an event is not necessary, you can call this method manually, to.
  75.      * The event is not processed in any way.
  76.      */
  77.     public function onEvent(Event $event = null)
  78.     {
  79.         while (!empty($this->messages)) {
  80.             $message = array_shift($this->messages);
  82.             $this->handle($message, $this->dispatcher);
  83.         }
  84.     }
  86.     /**
  87.      * {@inheritdoc}
  88.      */
  89.     public function getIterator()
  90.     {
  91.         return new IteratorProxyMessageIterator(new \ArrayIterator($this->messages));
  92.     }
  94.     /**
  95.      * {@inheritdoc}
  96.      */
  97.     public function getStatus()
  98.     {
  99.         return new Success('Postpone runtime backend', 'Ok (Postpone Runtime)');
  100.     }
  102.     /**
  103.      * Check whether this Backend is run on the CLI.
  104.      *
  105.      * @return bool
  106.      */
  107.     protected function isCommandLineInterface()
  108.     {
  109.         return 'cli' === \PHP_SAPI;
  110.     }
  111. }