mirror/php-monolog
1
0
Fork 0
mirror of https://github.com/Seldaek/monolog.git synced 2025-08-08 14:16:42 +02:00
Code Issues Releases Wiki Activity

Add AsMonologProcessor attribute (#1637)

Browse Source
This commit is contained in:
Thomas Calvet
2022-03-06 13:08:33 +01:00
committed by GitHub
parent 4b34c2893f
commit 8c58abad9e
2 changed files with 69 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
src/Monolog/Attribute/AsMonologProcessor.php Normal file
View File

@@ -0,0 +1,36 @@
<?php declare(strict_types=1);
/*
* This file is part of the Monolog package.
*
* (c) Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Monolog\Attribute;
/**
* A reusable attribute to help configure a class or a method as a processor.
*
* Using it offers no guarantee: it needs to be leveraged by a Monolog third-party consumer.
*
* Using it with the Monolog library only has no effect at all: processors should still be turned into a callable if
* needed and manually pushed to the loggers and to the processable handlers.
*/
#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
class AsMonologProcessor
{
/**
* @param string|null $channel The logging channel the processor should be pushed to.
* @param string|null $handler The handler the processor should be pushed to.
* @param string|null $method The method that processes the records (if the attribute is used at the class level).
*/
public function __construct(
public ?string $channel = null,
public ?string $handler = null,
public ?string $method = null,
) {
}
}

33
tests/Monolog/Attribute/AsMonologProcessorTest.php Normal file
View File

@@ -0,0 +1,33 @@
<?php declare(strict_types=1);
/*
* This file is part of the Monolog package.
*
* (c) Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Monolog\Attribute;
use PHPUnit\Framework\TestCase;
/**
* @requires PHP 8.0
*/
final class AsMonologProcessorTest extends TestCase
{
public function test(): void
{
$asMonologProcessor = new AsMonologProcessor('channel', 'handler', 'method');
$this->assertSame('channel', $asMonologProcessor->channel);
$this->assertSame('handler', $asMonologProcessor->handler);
$this->assertSame('method', $asMonologProcessor->method);
$asMonologProcessor = new AsMonologProcessor(null, null, null);
$this->assertNull($asMonologProcessor->channel);
$this->assertNull($asMonologProcessor->handler);
$this->assertNull($asMonologProcessor->method);
}
}