vendor/symfony/monolog-bridge/Handler/SwiftMailerHandler.php line 51

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\Bridge\Monolog\Handler;
  14. use Monolog\Handler\SwiftMailerHandler as BaseSwiftMailerHandler;
  15. use Symfony\Component\Console\Event\ConsoleTerminateEvent;
  16. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  18. trigger_deprecation('symfony/monolog-bridge', '5.4', '"%s" is deprecated and will be removed in 6.0.', SwiftMailerHandler::class);
  20. /**
  21.  * Extended SwiftMailerHandler that flushes mail queue if necessary.
  22.  *
  23.  * @author Philipp Kräutli <pkraeutli@astina.ch>
  24.  *
  25.  * @final
  26.  *
  27.  * @deprecated since Symfony 5.4
  28.  */
  29. class SwiftMailerHandler extends BaseSwiftMailerHandler
  30. {
  31.     protected $transport;
  33.     protected $instantFlush = false;
  35.     public function setTransport(\Swift_Transport $transport)
  36.     {
  37.         $this->transport = $transport;
  38.     }
  40.     /**
  41.      * After the kernel has been terminated we will always flush messages.
  42.      */
  43.     public function onKernelTerminate(TerminateEvent $event)
  44.     {
  45.         $this->instantFlush = true;
  46.     }
  48.     /**
  49.      * After the CLI application has been terminated we will always flush messages.
  50.      */
  51.     public function onCliTerminate(ConsoleTerminateEvent $event)
  52.     {
  53.         $this->instantFlush = true;
  54.     }
  56.     /**
  57.      * {@inheritdoc}
  58.      */
  59.     protected function send($content, array $records): void
  60.     {
  61.         parent::send($content, $records);
  63.         if ($this->instantFlush) {
  64.             $this->flushMemorySpool();
  65.         }
  66.     }
  68.     /**
  69.      * {@inheritdoc}
  70.      */
  71.     public function reset(): void
  72.     {
  73.         $this->flushMemorySpool();
  74.     }
  76.     /**
  77.      * Flushes the mail queue if a memory spool is used.
  78.      */
  79.     private function flushMemorySpool()
  80.     {
  81.         $mailerTransport = $this->mailer->getTransport();
  82.         if (!$mailerTransport instanceof \Swift_Transport_SpoolTransport) {
  83.             return;
  84.         }
  86.         $spool = $mailerTransport->getSpool();
  87.         if (!$spool instanceof \Swift_MemorySpool) {
  88.             return;
  89.         }
  91.         if (null === $this->transport) {
  92.             throw new \Exception('No transport available to flush mail queue.');
  93.         }
  95.         $spool->flushQueue($this->transport);
  96.     }
  97. }