ConsoleLogger.php 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Console\Logger;
  11. use Psr\Log\AbstractLogger;
  12. use Psr\Log\InvalidArgumentException;
  13. use Psr\Log\LogLevel;
  14. use Symfony\Component\Console\Output\ConsoleOutputInterface;
  15. use Symfony\Component\Console\Output\OutputInterface;
  16. /**
  17. * PSR-3 compliant console logger.
  18. *
  19. * @author Kévin Dunglas <dunglas@gmail.com>
  20. *
  21. * @see https://www.php-fig.org/psr/psr-3/
  22. */
  23. class ConsoleLogger extends AbstractLogger
  24. {
  25. public const INFO = 'info';
  26. public const ERROR = 'error';
  27. private OutputInterface $output;
  28. private array $verbosityLevelMap = [
  29. LogLevel::EMERGENCY => OutputInterface::VERBOSITY_NORMAL,
  30. LogLevel::ALERT => OutputInterface::VERBOSITY_NORMAL,
  31. LogLevel::CRITICAL => OutputInterface::VERBOSITY_NORMAL,
  32. LogLevel::ERROR => OutputInterface::VERBOSITY_NORMAL,
  33. LogLevel::WARNING => OutputInterface::VERBOSITY_NORMAL,
  34. LogLevel::NOTICE => OutputInterface::VERBOSITY_VERBOSE,
  35. LogLevel::INFO => OutputInterface::VERBOSITY_VERY_VERBOSE,
  36. LogLevel::DEBUG => OutputInterface::VERBOSITY_DEBUG,
  37. ];
  38. private array $formatLevelMap = [
  39. LogLevel::EMERGENCY => self::ERROR,
  40. LogLevel::ALERT => self::ERROR,
  41. LogLevel::CRITICAL => self::ERROR,
  42. LogLevel::ERROR => self::ERROR,
  43. LogLevel::WARNING => self::INFO,
  44. LogLevel::NOTICE => self::INFO,
  45. LogLevel::INFO => self::INFO,
  46. LogLevel::DEBUG => self::INFO,
  47. ];
  48. private bool $errored = false;
  49. public function __construct(OutputInterface $output, array $verbosityLevelMap = [], array $formatLevelMap = [])
  50. {
  51. $this->output = $output;
  52. $this->verbosityLevelMap = $verbosityLevelMap + $this->verbosityLevelMap;
  53. $this->formatLevelMap = $formatLevelMap + $this->formatLevelMap;
  54. }
  55. public function log($level, $message, array $context = []): void
  56. {
  57. if (!isset($this->verbosityLevelMap[$level])) {
  58. throw new InvalidArgumentException(sprintf('The log level "%s" does not exist.', $level));
  59. }
  60. $output = $this->output;
  61. // Write to the error output if necessary and available
  62. if (self::ERROR === $this->formatLevelMap[$level]) {
  63. if ($this->output instanceof ConsoleOutputInterface) {
  64. $output = $output->getErrorOutput();
  65. }
  66. $this->errored = true;
  67. }
  68. // the if condition check isn't necessary -- it's the same one that $output will do internally anyway.
  69. // We only do it for efficiency here as the message formatting is relatively expensive.
  70. if ($output->getVerbosity() >= $this->verbosityLevelMap[$level]) {
  71. $output->writeln(sprintf('<%1$s>[%2$s] %3$s</%1$s>', $this->formatLevelMap[$level], $level, $this->interpolate($message, $context)), $this->verbosityLevelMap[$level]);
  72. }
  73. }
  74. /**
  75. * Returns true when any messages have been logged at error levels.
  76. */
  77. public function hasErrored(): bool
  78. {
  79. return $this->errored;
  80. }
  81. /**
  82. * Interpolates context values into the message placeholders.
  83. *
  84. * @author PHP Framework Interoperability Group
  85. */
  86. private function interpolate(string $message, array $context): string
  87. {
  88. if (!str_contains($message, '{')) {
  89. return $message;
  90. }
  91. $replacements = [];
  92. foreach ($context as $key => $val) {
  93. if (null === $val || \is_scalar($val) || $val instanceof \Stringable) {
  94. $replacements["{{$key}}"] = $val;
  95. } elseif ($val instanceof \DateTimeInterface) {
  96. $replacements["{{$key}}"] = $val->format(\DateTimeInterface::RFC3339);
  97. } elseif (\is_object($val)) {
  98. $replacements["{{$key}}"] = '[object '.$val::class.']';
  99. } else {
  100. $replacements["{{$key}}"] = '['.\gettype($val).']';
  101. }
  102. }
  103. return strtr($message, $replacements);
  104. }
  105. }