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

  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.     public function onConsoleError(ConsoleErrorEvent $event)
  35.     {
  36.         if (null === $this->logger) {
  37.             return;
  38.         }
  40.         $error = $event->getError();
  42.         if (!$inputString = $this->getInputString($event)) {
  43.             $this->logger->critical('An error occurred while using the console. Message: "{message}"', ['exception' => $error, 'message' => $error->getMessage()]);
  45.             return;
  46.         }
  48.         $this->logger->critical('Error thrown while running command "{command}". Message: "{message}"', ['exception' => $error, 'command' => $inputString, 'message' => $error->getMessage()]);
  49.     }
  51.     public function onConsoleTerminate(ConsoleTerminateEvent $event)
  52.     {
  53.         if (null === $this->logger) {
  54.             return;
  55.         }
  57.         $exitCode = $event->getExitCode();
  59.         if (0 === $exitCode) {
  60.             return;
  61.         }
  63.         if (!$inputString = $this->getInputString($event)) {
  64.             $this->logger->debug('The console exited with code "{code}"', ['code' => $exitCode]);
  66.             return;
  67.         }
  69.         $this->logger->debug('Command "{command}" exited with code "{code}"', ['command' => $inputString, 'code' => $exitCode]);
  70.     }
  72.     public static function getSubscribedEvents(): array
  73.     {
  74.         return [
  75.             ConsoleEvents::ERROR => ['onConsoleError', -128],
  76.             ConsoleEvents::TERMINATE => ['onConsoleTerminate', -128],
  77.         ];
  78.     }
  80.     private static function getInputString(ConsoleEvent $event): ?string
  81.     {
  82.         $commandName = $event->getCommand()?->getName();
  83.         $input = $event->getInput();
  85.         if ($input instanceof \Stringable) {
  86.             if ($commandName) {
  87.                 return str_replace(["'$commandName'", "\"$commandName\""], $commandName, (string) $input);
  88.             }
  90.             return (string) $input;
  91.         }
  93.         return $commandName;
  94.     }
  95. }