added the ability to pass a logger

Signed-off-by: waahhhh <40632052+waahhhh@users.noreply.github.com>
laminas · Aug 29, 2020 · c3d25c6 · c3d25c6
1 parent d2bebdb
commit c3d25c6
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 2 deletions.
diff --git a/docs/book/codegen.md b/docs/book/codegen.md
@@ -29,7 +29,7 @@ use Laminas\Di\Resolver\DependencyResolver;
 use Laminas\Di\CodeGenerator\InjectorGenerator;
 
 $config = new Config();
-$resolver = new DependencyResolver(new RuntimeDefinition(), $config)
+$resolver = new DependencyResolver(new RuntimeDefinition(), $config);
 $generator = new InjectorGenerator($config, $resolver);
 
 // It is highly recommended to set the container that is used at runtime:
@@ -75,6 +75,9 @@ following keys (unknown keys are ignored):
   this value is not provided, you will need to set it with the generator's
   `setOutputDirectory()` method before calling `generate()`.
 
+- `logger`: must be resolvable in container and must be an instance of `Psr\Log\LoggerInterface.`
+  By default `Psr\Log\NullLogger` is used. See the [Logging section](#logging) for details.
+
 Below is an example detailing configuration of the generator factory:
 
 ```php
@@ -84,6 +87,7 @@ return [
             'aot' => [
                 'namespace' => 'AppAoT\Generated',
                 'directory' => __DIR__ . '/../gen',
+                'logger' => Psr\Log\LoggerInterface::class,
             ],
         ],
     ],

diff --git a/src/Container/GeneratorFactory.php b/src/Container/GeneratorFactory.php
@@ -40,8 +40,13 @@ public function create(ContainerInterface $container) : InjectorGenerator
         $config = $container->has('config') ? $container->get('config') : [];
         $aotConfig = $config['dependencies']['auto']['aot'] ?? [];
         $namespace = $aotConfig['namespace'] ?? null;
+        $logger = null;
 
-        $generator = new InjectorGenerator($diConfig, $resolver, $namespace);
+        if (isset($aotConfig['logger'])) {
+            $logger = $container->get($aotConfig['logger']);
+        }
+
+        $generator = new InjectorGenerator($diConfig, $resolver, $namespace, $logger);
 
         if (isset($aotConfig['directory'])) {
             $generator->setOutputDirectory($aotConfig['directory']);

diff --git a/test/Container/GeneratorFactoryTest.php b/test/Container/GeneratorFactoryTest.php
@@ -19,6 +19,8 @@
 use org\bovigo\vfs\vfsStream;
 use PHPUnit\Framework\TestCase;
 use Psr\Container\ContainerInterface;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
 
 /**
  * @covers Laminas\Di\Container\GeneratorFactory
@@ -87,6 +89,40 @@ public function testSetsNamespaceFromConfig() : void
         $this->assertEquals($expected, $generator->getNamespace());
     }
 
+    public function testDefaultLogger() : void
+    {
+        $generator = (new GeneratorFactory())->create(new ServiceManager());
+        $reflection = new \ReflectionClass($generator);
+        $property = $reflection->getProperty('logger');
+        $property->setAccessible(true);
+
+        $this->assertInstanceOf(NullLogger::class, $property->getValue($generator));
+    }
+
+    public function testSetsLoggerFromConfig() : void
+    {
+        $logger = $this->getMockBuilder(LoggerInterface::class)
+            ->getMockForAbstractClass();
+        $container = new ServiceManager();
+        $container->setService('MyCustomLogger', $logger);
+        $container->setService('config', [
+            'dependencies' => [
+                'auto' => [
+                    'aot' => [
+                        'logger' => 'MyCustomLogger',
+                    ],
+                ],
+            ],
+        ]);
+
+        $generator = (new GeneratorFactory())->create($container);
+        $reflection = new \ReflectionClass($generator);
+        $property = $reflection->getProperty('logger');
+        $property->setAccessible(true);
+
+        $this->assertNotInstanceOf(NullLogger::class, $property->getValue($generator));
+    }
+
     public function testInvokeCallsCreate() : void
     {
         $mock = $this->getMockBuilder(GeneratorFactory::class)