mirror/php-monolog
1
0
Fork 0
mirror of https://github.com/Seldaek/monolog.git synced 2025-08-11 15:44:34 +02:00
Code Issues Releases Wiki Activity

Merge remote-tracking branch 'redmatter/backport-psr-log-message-processor-from-v2' into 1.x

Browse Source
This commit is contained in:
Jordi Boggiano
2020-12-10 09:55:19 +01:00
parent 7c977e451c a05c1a9732
commit 2bb3ffa6e0
2 changed files with 68 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
src/Monolog/Processor/PsrLogMessageProcessor.php
View File

@@ -22,6 +22,24 @@ use Monolog\Utils;
*/
class PsrLogMessageProcessor implements ProcessorInterface
{
const SIMPLE_DATE = "Y-m-d\TH:i:s.uP";
/** @var string|null */
private $dateFormat;
/** @var bool */
private $removeUsedContextFields;
/**
* @param string|null $dateFormat The format of the timestamp: one supported by DateTime::format
* @param bool $removeUsedContextFields If set to true the fields interpolated into message gets unset
*/
public function __construct($dateFormat = null, $removeUsedContextFields = false)
{
$this->dateFormat = $dateFormat;
$this->removeUsedContextFields = $removeUsedContextFields;
}
/**
* @param array $record
* @return array
@@ -34,12 +52,25 @@ class PsrLogMessageProcessor implements ProcessorInterface
$replacements = array();
foreach ($record['context'] as $key => $val) {
$placeholder = '{' . $key . '}';
if (strpos($record['message'], $placeholder) === false) {
continue;
}
if (is_null($val) || is_scalar($val) || (is_object($val) && method_exists($val, "__toString"))) {
$replacements['{'.$key.'}'] = $val;
$replacements[$placeholder] = $val;
} elseif ($val instanceof \DateTime) {
$replacements[$placeholder] = $val->format($this->dateFormat ?: static::SIMPLE_DATE);
} elseif (is_object($val)) {
$replacements['{'.$key.'}'] = '[object '.Utils::getClass($val).']';
$replacements[$placeholder] = '[object '.Utils::getClass($val).']';
} elseif (is_array($val)) {
$replacements[$placeholder] = 'array'.@json_encode($val);
} else {
$replacements['{'.$key.'}'] = '['.gettype($val).']';
$replacements[$placeholder] = '['.gettype($val).']';
}
if ($this->removeUsedContextFields) {
unset($record['context'][$key]);
}
}

35
tests/Monolog/Processor/PsrLogMessageProcessorTest.php
View File

@@ -27,8 +27,37 @@ class PsrLogMessageProcessorTest extends \PHPUnit_Framework_TestCase
$this->assertEquals($expected, $message['message']);
}
public function testReplacementWithContextRemoval()
{
$proc = new PsrLogMessageProcessor($dateFormat = null, $removeUsedContextFields = true);
$message = $proc(array(
'message' => '{foo}',
'context' => array('foo' => 'bar', 'lorem' => 'ipsum'),
));
$this->assertSame('bar', $message['message']);
$this->assertSame(array('lorem' => 'ipsum'), $message['context']);
}
public function testCustomDateFormat()
{
$format = "Y-m-d";
$date = new \DateTime();
$proc = new PsrLogMessageProcessor($format);
$message = $proc(array(
'message' => '{foo}',
'context' => array('foo' => $date),
));
$this->assertEquals($date->format($format), $message['message']);
$this->assertSame(array('foo' => $date), $message['context']);
}
public function getPairs()
{
$date = new \DateTime();
return array(
array('foo', 'foo'),
array('3', '3'),
@@ -36,8 +65,12 @@ class PsrLogMessageProcessorTest extends \PHPUnit_Framework_TestCase
array(null, ''),
array(true, '1'),
array(false, ''),
array($date, $date->format(PsrLogMessageProcessor::SIMPLE_DATE)),
array(new \stdClass, '[object stdClass]'),
array(array(), '[array]'),
array(array(), 'array[]'),
array(array(1, 2, 3), 'array[1,2,3]'),
array(array('foo' => 'bar'), 'array{"foo":"bar"}'),
array(stream_context_create(), '[resource]'),
);
}
}