vendor/symfony/console/EventListener/ErrorListener.php line 51

  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\Console\EventListener;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\Console\ConsoleEvents;
  16. use Symfony\Component\Console\Event\ConsoleErrorEvent;
  17. use Symfony\Component\Console\Event\ConsoleEvent;
  18. use Symfony\Component\Console\Event\ConsoleTerminateEvent;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  21. /**
  22.  * @author James Halsall <james.t.halsall@googlemail.com>
  23.  * @author Robin Chalas <robin.chalas@gmail.com>
  24.  */
  25. class ErrorListener implements EventSubscriberInterface
  26. {
  27.     private ?LoggerInterface $logger;
  29.     public function __construct(?LoggerInterface $logger = null)
  30.     {
  31.         $this->logger = $logger;
  32.     }
  34.     /**
  35.      * @return void
  36.      */
  37.     public function onConsoleError(ConsoleErrorEvent $event)
  38.     {
  39.         if (null === $this->logger) {
  40.             return;
  41.         }
  43.         $error = $event->getError();
  45.         if (!$inputString = $this->getInputString($event)) {
  46.             $this->logger->critical('An error occurred while using the console. Message: "{message}"', ['exception' => $error, 'message' => $error->getMessage()]);
  48.             return;
  49.         }
  51.         $this->logger->critical('Error thrown while running command "{command}". Message: "{message}"', ['exception' => $error, 'command' => $inputString, 'message' => $error->getMessage()]);
  52.     }
  54.     /**
  55.      * @return void
  56.      */
  57.     public function onConsoleTerminate(ConsoleTerminateEvent $event)
  58.     {
  59.         if (null === $this->logger) {
  60.             return;
  61.         }
  63.         $exitCode = $event->getExitCode();
  65.         if (0 === $exitCode) {
  66.             return;
  67.         }
  69.         if (!$inputString = $this->getInputString($event)) {
  70.             $this->logger->debug('The console exited with code "{code}"', ['code' => $exitCode]);
  72.             return;
  73.         }
  75.         $this->logger->debug('Command "{command}" exited with code "{code}"', ['command' => $inputString, 'code' => $exitCode]);
  76.     }
  78.     public static function getSubscribedEvents(): array
  79.     {
  80.         return [
  81.             ConsoleEvents::ERROR => ['onConsoleError', -128],
  82.             ConsoleEvents::TERMINATE => ['onConsoleTerminate', -128],
  83.         ];
  84.     }
  86.     private static function getInputString(ConsoleEvent $event): ?string
  87.     {
  88.         $commandName = $event->getCommand()?->getName();
  89.         $input = $event->getInput();
  91.         if ($input instanceof \Stringable) {
  92.             if ($commandName) {
  93.                 return str_replace(["'$commandName'", "\"$commandName\""], $commandName, (string) $input);
  94.             }
  96.             return (string) $input;
  97.         }
  99.         return $commandName;
  100.     }
  101. }