implement comprehensive container logging for compiler passes

DependencyInjection/Compiler/AbstractCompilerPass.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the `liip/LiipImagineBundle` project.
+ *
+ * (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
+namespace Liip\ImagineBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+abstract class AbstractCompilerPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function log(ContainerBuilder $container, $message, array $replacements = array())
+    {
+        if (count($replacements) > 0) {
+            $message = vsprintf($message, $replacements);
+        }
+
+        if (method_exists($container, 'log')) {
+            $container->log($this, $message);
+        } else {
+            $compiler = $container->getCompiler();
+            $formatter = $compiler->getLoggingFormatter();
+            $compiler->addLogMessage($formatter->format($this, $message));
+        }
+    }
+}

DependencyInjection/Compiler/FiltersCompilerPass.php

@@ -11,11 +11,10 @@
 
 namespace Liip\ImagineBundle\DependencyInjection\Compiler;
 
-use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-class FiltersCompilerPass implements CompilerPassInterface
+class FiltersCompilerPass extends AbstractCompilerPass
 {
     /**
      * {@inheritdoc}
@@ -28,6 +27,7 @@ public function process(ContainerBuilder $container)
             $manager = $container->getDefinition('liip_imagine.filter.manager');
 
             foreach ($tags as $id => $tag) {
+                $this->log($container, 'Registering imagine filter loader: %s', array($id));
                 $manager->addMethodCall('addLoader', array($tag[0]['loader'], new Reference($id)));
             }
         }

DependencyInjection/Compiler/LoadersCompilerPass.php

@@ -11,11 +11,10 @@
 
 namespace Liip\ImagineBundle\DependencyInjection\Compiler;
 
-use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-class LoadersCompilerPass implements CompilerPassInterface
+class LoadersCompilerPass extends AbstractCompilerPass
 {
     /**
      * {@inheritdoc}
@@ -28,6 +27,7 @@ public function process(ContainerBuilder $container)
             $manager = $container->getDefinition('liip_imagine.data.manager');
 
             foreach ($tags as $id => $tag) {
+                $this->log($container, 'Registering imagine binary loader: %s', array($id));
                 $manager->addMethodCall('addLoader', array($tag[0]['loader'], new Reference($id)));
             }
         }

DependencyInjection/Compiler/MetadataReaderCompilerPass.php

@@ -11,15 +11,14 @@
 
 namespace Liip\ImagineBundle\DependencyInjection\Compiler;
 
-use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
  * By default, a metadata reader based on the exif php extension is used.
  * This compiler pass checks if the extension is loaded an switches to a simpler
  * implementation if not.
  */
-class MetadataReaderCompilerPass implements CompilerPassInterface
+class MetadataReaderCompilerPass extends AbstractCompilerPass
 {
     const METADATA_READER_PARAM = 'liip_imagine.meta_data.reader.class';
 
@@ -34,7 +33,7 @@ public function process(ContainerBuilder $container)
     {
         if (!$this->extExifIsAvailable() && $this->isDefaultMetadataReader($container)) {
             $container->setParameter(self::METADATA_READER_PARAM, self::DEFAULT_METADATA_READER_CLASS);
-            $this->logMetadataReaderReplaced($container);
+            $this->log($container, 'Replacing imagine metadata reader: missing "exif" extension (installing this extension is suggested).');
         }
     }
 
@@ -50,21 +49,6 @@ protected function isDefaultMetadataReader(ContainerBuilder $container)
         return $currentMetadataReaderParameter === self::EXIF_METADATA_READER_CLASS;
     }
 
-    /**
-     * @param ContainerBuilder $container
-     */
-    protected function logMetadataReaderReplaced(ContainerBuilder $container)
-    {
-        $compiler = $container->getCompiler();
-        $formatter = $compiler->getLoggingFormatter();
-        $message = 'Automatically replaced Imagine ExifMetadataReader with DefaultMetadataReader; '.
-            'you might experience issues with LiipImagineBundle; reason: PHP extension "exif" is missing; solution: '.
-            'for advanced metadata extraction install the PHP extension "exif" or set a custom MetadataReader '.
-            'through the "liip_imagine.meta_data.reader.class" parameter';
-
-        $compiler->addLogMessage($formatter->format($this, $message));
-    }
-
     /**
      * @return bool
      */

DependencyInjection/Compiler/PostProcessorsCompilerPass.php

@@ -11,7 +11,6 @@
 
 namespace Liip\ImagineBundle\DependencyInjection\Compiler;
 
-use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
@@ -20,7 +19,7 @@
  *
  * @author Konstantin Tjuterev <[email protected]>
  */
-class PostProcessorsCompilerPass implements CompilerPassInterface
+class PostProcessorsCompilerPass extends AbstractCompilerPass
 {
     /**
      * {@inheritdoc}
@@ -33,6 +32,7 @@ public function process(ContainerBuilder $container)
             $manager = $container->getDefinition('liip_imagine.filter.manager');
 
             foreach ($tags as $id => $tag) {
+                $this->log($container, 'Registering imagine filter post-processor: %s', array($id));
                 $manager->addMethodCall('addPostProcessor', array($tag[0]['post_processor'], new Reference($id)));
             }
         }

DependencyInjection/Compiler/ResolversCompilerPass.php

@@ -11,11 +11,10 @@
 
 namespace Liip\ImagineBundle\DependencyInjection\Compiler;
 
-use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-class ResolversCompilerPass implements CompilerPassInterface
+class ResolversCompilerPass extends AbstractCompilerPass
 {
     /**
      * {@inheritdoc}
@@ -28,6 +27,7 @@ public function process(ContainerBuilder $container)
             $manager = $container->getDefinition('liip_imagine.cache.manager');
 
             foreach ($tags as $id => $tag) {
+                $this->log($container, 'Registering imagine cache resolver: %s', array($id));
                 $manager->addMethodCall('addResolver', array($tag[0]['resolver'], new Reference($id)));
             }
         }