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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Sonata Project package.
  5.  *
  6.  * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  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 Sonata\NotificationBundle\Backend;
  14. use Sonata\NotificationBundle\Iterator\IteratorProxyMessageIterator;
  15. use Sonata\NotificationBundle\Model\MessageInterface;
  16. use Symfony\Component\EventDispatcher\Event;
  17. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  18. use ZendDiagnostics\Result\Success;
  20. /**
  21.  * This backend postpones the handling of messages to a registered event.
  22.  *
  23.  * It's based on the asynchronous event dispatcher:
  24.  *
  25.  * @see https://gist.github.com/3852361
  26.  *
  27.  * @author Toni Uebernickel <tuebernickel@gmail.com>
  28.  */
  29. class PostponeRuntimeBackend extends RuntimeBackend
  30. {
  31.     /**
  32.      * @var MessageInterface[]
  33.      */
  34.     protected $messages = array();
  36.     /**
  37.      * If set to true, you have to fire an event the onEvent method is subscribed to manually!
  38.      *
  39.      * @var bool
  40.      */
  41.     protected $postponeOnCli = false;
  43.     /**
  44.      * @param EventDispatcherInterface $dispatcher
  45.      * @param bool                     $postponeOnCli Whether to postpone the messages on the CLI, too
  46.      */
  47.     public function __construct(EventDispatcherInterface $dispatcher, $postponeOnCli = false)
  48.     {
  49.         parent::__construct($dispatcher);
  51.         $this->postponeOnCli = $postponeOnCli;
  52.     }
  54.     /**
  55.      * {@inheritdoc}
  56.      */
  57.     public function publish(MessageInterface $message)
  58.     {
  59.         // if the message is generated from the cli the message is handled
  60.         // directly as there is no kernel.terminate in cli
  61.         if (!$this->postponeOnCli && $this->isCommandLineInterface()) {
  62.             $this->handle($message, $this->dispatcher);
  64.             return;
  65.         }
  67.         $this->messages[] = $message;
  68.     }
  70.     /**
  71.      * Listen on any event and handle the messages.
  72.      *
  73.      * Actually, an event is not necessary, you can call this method manually, to.
  74.      * The event is not processed in any way.
  75.      *
  76.      * @param Event|null $event
  77.      */
  78.     public function onEvent(Event $event = null)
  79.     {
  80.         reset($this->messages);
  82.         while (list($key, $message) = each($this->messages)) {
  83.             $this->handle($message, $this->dispatcher);
  85.             unset($this->messages[$key]);
  86.         }
  87.     }
  89.     /**
  90.      * {@inheritdoc}
  91.      */
  92.     public function getIterator()
  93.     {
  94.         return new IteratorProxyMessageIterator(new \ArrayIterator($this->messages));
  95.     }
  97.     /**
  98.      * {@inheritdoc}
  99.      */
  100.     public function getStatus()
  101.     {
  102.         return new Success('Postpone runtime backend', 'Ok (Postpone Runtime)');
  103.     }
  105.     /**
  106.      * Check whether this Backend is run on the CLI.
  107.      *
  108.      * @return bool
  109.      */
  110.     protected function isCommandLineInterface()
  111.     {
  112.         return 'cli' === PHP_SAPI;
  113.     }
  114. }