feature #27801 [MonologBridge] Add ProcessorInterface, enabling autoconfiguration of monolog processors (nicolas-grekas)

fabpot · fabpot · commit f27c3a85843f · 2018-07-03T10:16:22.000+02:00
This PR was merged into the 4.2-dev branch. Discussion ---------- [MonologBridge] Add ProcessorInterface, enabling autoconfiguration of monolog processors | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | symfony/symfony-docs#9996 Using this, enabling e.g. TokenProcessor or WebProcessor just needs one line in `services.yaml`: ```yaml services: Symfony\Bridge\Monolog\Processor\TokenProcessor: ~ Symfony\Bridge\Monolog\Processor\WebProcessor: ~ ``` Commits ------- 28a4912 [MonologBridge] Add ProcessorInterface, enabling autoconfiguration of monolog processors
diff --git a/src/Symfony/Bridge/Monolog/CHANGELOG.md b/src/Symfony/Bridge/Monolog/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.2.0
+-----
+
+ * added `ProcessorInterface`: an optional interface to allow autoconfiguration of Monolog processors
+
 4.1.0
 -----
 
diff --git a/src/Symfony/Bridge/Monolog/Processor/ProcessorInterface.php b/src/Symfony/Bridge/Monolog/Processor/ProcessorInterface.php
@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Monolog\Processor;
+
+/**
+ * An optional interface to allow autoconfiguration of Monolog processors.
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+interface ProcessorInterface
+{
+    /**
+     * @return array The processed records
+     */
+    public function __invoke(array $records);
+}
diff --git a/src/Symfony/Bridge/Monolog/Processor/TokenProcessor.php b/src/Symfony/Bridge/Monolog/Processor/TokenProcessor.php
@@ -18,7 +18,7 @@
  *
  * @author Dany Maillard <danymaillard93b@gmail.com>
  */
-class TokenProcessor
+class TokenProcessor implements ProcessorInterface
 {
     private $tokenStorage;
 
diff --git a/src/Symfony/Bridge/Monolog/Processor/WebProcessor.php b/src/Symfony/Bridge/Monolog/Processor/WebProcessor.php
@@ -21,7 +21,7 @@
  *
  * @author Jordi Boggiano <j.boggiano@seld.be>
  */
-class WebProcessor extends BaseWebProcessor implements EventSubscriberInterface
+class WebProcessor extends BaseWebProcessor implements EventSubscriberInterface, ProcessorInterface
 {
     public function __construct(array $extraFields = null)
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -14,6 +14,7 @@
 use Doctrine\Common\Annotations\Reader;
 use Doctrine\Common\Annotations\AnnotationRegistry;
 use Symfony\Bridge\Monolog\Processor\DebugProcessor;
+use Symfony\Bridge\Monolog\Processor\ProcessorInterface;
 use Symfony\Bridge\Twig\Extension\CsrfExtension;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
@@ -324,6 +325,8 @@ public function load(array $configs, ContainerBuilder $container)
             ->addTag('kernel.event_subscriber');
         $container->registerForAutoconfiguration(ResettableInterface::class)
             ->addTag('kernel.reset', array('method' => 'reset'));
+        $container->registerForAutoconfiguration(ProcessorInterface::class)
+            ->addTag('monolog.processor');
         $container->registerForAutoconfiguration(PropertyListExtractorInterface::class)
             ->addTag('property_info.list_extractor');
         $container->registerForAutoconfiguration(PropertyTypeExtractorInterface::class)

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`*`
`19`	`19`	`* @author Dany Maillard <danymaillard93b@gmail.com>`
`20`	`20`	`*/`
`21`		`-class TokenProcessor`
	`21`	`+class TokenProcessor implements ProcessorInterface`
`22`	`22`	`{`
`23`	`23`	`private $tokenStorage;`
`24`	`24`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`*`
`22`	`22`	`* @author Jordi Boggiano <j.boggiano@seld.be>`
`23`	`23`	`*/`
`24`		`-class WebProcessor extends BaseWebProcessor implements EventSubscriberInterface`
	`24`	`+class WebProcessor extends BaseWebProcessor implements EventSubscriberInterface, ProcessorInterface`
`25`	`25`	`{`
`26`	`26`	`public function __construct(array $extraFields = null)`
`27`	`27`	`{`