vendor/monolog/monolog/src/Monolog/Processor/PsrLogMessageProcessor.php line 24

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. /*
  4. * This file is part of the Monolog package.
  5. *
  6. * (c) Jordi Boggiano <j.boggiano@seld.be>
  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 Monolog\Processor;
  14. use Monolog\Utils;
  15. use Monolog\LogRecord;
  17. /**
  18. * Processes a record's message according to PSR-3 rules
  19. *
  20. * It replaces {foo} with the value from $context['foo']
  21. *
  22. * @author Jordi Boggiano <j.boggiano@seld.be>
  23. */
  24. class PsrLogMessageProcessor implements ProcessorInterface
  25. {
  26. public const SIMPLE_DATE = "Y-m-d\TH:i:s.uP";
  28. private ?string $dateFormat;
  30. private bool $removeUsedContextFields;
  32. /**
  33. * @param string|null $dateFormat The format of the timestamp: one supported by DateTime::format
  34. * @param bool $removeUsedContextFields If set to true the fields interpolated into message gets unset
  35. */
  36. public function __construct(?string $dateFormat = null, bool $removeUsedContextFields = false)
  37. {
  38. $this->dateFormat = $dateFormat;
  39. $this->removeUsedContextFields = $removeUsedContextFields;
  40. }
  42. /**
  43. * @inheritDoc
  44. */
  45. public function __invoke(LogRecord $record): LogRecord
  46. {
  47. if (false === strpos($record->message, '{')) {
  48. return $record;
  49. }
  51. $replacements = [];
  52. $context = $record->context;
  54. foreach ($context as $key => $val) {
  55. $placeholder = '{' . $key . '}';
  56. if (strpos($record->message, $placeholder) === false) {
  57. continue;
  58. }
  60. if (null === $val || \is_scalar($val) || (\is_object($val) && method_exists($val, "__toString"))) {
  61. $replacements[$placeholder] = $val;
  62. } elseif ($val instanceof \DateTimeInterface) {
  63. if (null === $this->dateFormat && $val instanceof \Monolog\JsonSerializableDateTimeImmutable) {
  64. // handle monolog dates using __toString if no specific dateFormat was asked for
  65. // so that it follows the useMicroseconds flag
  66. $replacements[$placeholder] = (string) $val;
  67. } else {
  68. $replacements[$placeholder] = $val->format($this->dateFormat ?? static::SIMPLE_DATE);
  69. }
  70. } elseif ($val instanceof \UnitEnum) {
  71. $replacements[$placeholder] = $val instanceof \BackedEnum ? $val->value : $val->name;
  72. } elseif (\is_object($val)) {
  73. $replacements[$placeholder] = '[object '.Utils::getClass($val).']';
  74. } elseif (\is_array($val)) {
  75. $replacements[$placeholder] = 'array'.Utils::jsonEncode($val, null, true);
  76. } else {
  77. $replacements[$placeholder] = '['.\gettype($val).']';
  78. }
  80. if ($this->removeUsedContextFields) {
  81. unset($context[$key]);
  82. }
  83. }
  85. return $record->with(message: strtr($record->message, $replacements), context: $context);
  86. }
  87. }