Issue #44: Added support for laminas/laminas-servicemanager:4.x

Signed-off-by: alexmerlin <[email protected]>
dotkernel · Jan 10, 2025 · 6bf62b6 · 6bf62b6
1 parent e54eedf
commit 6bf62b6
Show file tree

Hide file tree

Showing 10 changed files with 137 additions and 88 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # dot-log
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-log)
-![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-log/4.0.0)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-log/4.1.0)
 
 [![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-log)](https://github.com/dotkernel/dot-log/issues)
 [![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-log)](https://github.com/dotkernel/dot-log/network)
@@ -11,8 +11,6 @@
 [![Build Static](https://github.com/dotkernel/dot-log/actions/workflows/continuous-integration.yml/badge.svg?branch=4.0)](https://github.com/dotkernel/dot-log/actions/workflows/continuous-integration.yml)
 [![codecov](https://codecov.io/gh/dotkernel/dot-log/graph/badge.svg?token=JX19KTBRCZ)](https://codecov.io/gh/dotkernel/dot-log)
 
-[![SymfonyInsight](https://insight.symfony.com/projects/287e81e8-b4fb-4452-bd8f-4f12c0ab1f76/big.svg)](https://insight.symfony.com/projects/287e81e8-b4fb-4452-bd8f-4f12c0ab1f76)
-
 ## Adding The Config Provider
 
 * Enter config/config.php

diff --git a/composer.json b/composer.json
@@ -20,12 +20,12 @@
     ],
     "require": {
         "php": "~8.1.0 || ~8.2.0 || ~8.3.0",
-        "laminas/laminas-servicemanager": "^3.22",
-        "laminas/laminas-validator": "^2.64"
+        "laminas/laminas-servicemanager": "^4.0",
+        "laminas/laminas-validator": "^3.0"
     },
     "require-dev": {
+        "laminas/laminas-coding-standard": "^3.0",
         "phpunit/phpunit": "^10.2",
-        "laminas/laminas-coding-standard": "^2.5",
         "vimeo/psalm": "^5.13"
     },
     "autoload": {
@@ -48,7 +48,8 @@
     "scripts": {
         "check": [
             "@cs-check",
-            "@test"
+            "@test",
+            "@static-analysis"
         ],
         "cs-check": "phpcs",
         "cs-fix": "phpcbf",

diff --git a/src/Logger.php b/src/Logger.php
@@ -17,6 +17,7 @@
 use Laminas\ServiceManager\ServiceManager;
 use Laminas\Stdlib\ArrayUtils;
 use Laminas\Stdlib\SplPriorityQueue;
+use Psr\Container\ContainerExceptionInterface;
 use Traversable;
 
 use function array_reverse;
@@ -133,6 +134,8 @@ class Logger implements LoggerInterface
      * - writers: array of writers to add to this logger
      * - exceptionhandler: if true register this logger as exceptionhandler
      * - errorhandler: if true register this logger as errorhandler
+     *
+     * @throws ContainerExceptionInterface
      */
     public function __construct(?iterable $options = null)
     {
@@ -210,7 +213,7 @@ public function __destruct()
         foreach ($this->writers as $writer) {
             try {
                 $writer->shutdown();
-            } catch (Exception $e) {
+            } catch (Exception) {
             }
         }
     }
@@ -232,15 +235,17 @@ public function setWriterPluginManager(WriterPluginManager $writerPlugins): stat
     /**
      * Get writer instance
      *
-     * @psalm-suppress InvalidReturnStatement
+     * @throws ContainerExceptionInterface
      */
-    public function writerPlugin(string $name, ?array $options = null): WriterInterface
+    public function writerPlugin(string $name, ?array $options = null): ?WriterInterface
     {
-        return $this->getWriterPluginManager()->get($name, $options);
+        return $this->getWriterPluginManager()?->build($name, $options);
     }
 
     /**
      * Add a writer to a logger
+     *
+     * @throws ContainerExceptionInterface
      */
     public function addWriter(WriterInterface|string $writer, int $priority = 1, ?array $options = null): static
     {
@@ -284,6 +289,9 @@ public function getProcessorPluginManager(): ?ProcessorPluginManager
         return $this->processorPlugins;
     }
 
+    /**
+     * @param class-string|ProcessorPluginManager $plugins
+     */
     public function setProcessorPluginManager(string|ProcessorPluginManager $plugins): static
     {
         if (is_string($plugins)) {
@@ -302,13 +310,16 @@ public function setProcessorPluginManager(string|ProcessorPluginManager $plugins
     }
 
     /**
-     * @psalm-suppress InvalidReturnStatement
+     * @throws ContainerExceptionInterface
      */
-    public function processorPlugin(string $name, ?array $options = null): ProcessorInterface
+    public function processorPlugin(string $name, ?array $options = null): ?ProcessorInterface
     {
-        return $this->getProcessorPluginManager()->get($name, $options);
+        return $this->getProcessorPluginManager()?->build($name, $options);
     }
 
+    /**
+     * @throws ContainerExceptionInterface
+     */
     public function addProcessor(
         ProcessorInterface|string $processor,
         int $priority = 1,

diff --git a/src/Manager/FilterPluginManager.php b/src/Manager/FilterPluginManager.php
@@ -24,7 +24,7 @@
 class FilterPluginManager extends AbstractPluginManager
 {
     /** @var string[] */
-    protected $aliases = [
+    protected array $aliases = [
         'priority'       => Priority::class,
         'regex'          => Regex::class,
         'suppress'       => SuppressFilter::class,
@@ -33,22 +33,19 @@ class FilterPluginManager extends AbstractPluginManager
     ];
 
     /** @var string[]|callable[] */
-    protected $factories = [
+    protected array $factories = [
         Priority::class       => InvokableFactory::class,
         Regex::class          => InvokableFactory::class,
         SuppressFilter::class => InvokableFactory::class,
         Validator::class      => InvokableFactory::class,
     ];
 
-    /** @var ?string */
-    protected $instanceOf = FilterInterface::class;
+    protected string $instanceOf = FilterInterface::class;
 
     /**
      * Allow many filters of the same type
-     *
-     * @var bool
      */
-    protected $sharedByDefault = false;
+    protected bool $sharedByDefault = false;
 
     /**
      * Validate the plugin is of the expected type.

diff --git a/src/Manager/FormatterPluginManager.php b/src/Manager/FormatterPluginManager.php
@@ -21,24 +21,21 @@
 class FormatterPluginManager extends AbstractPluginManager
 {
     /** @var string[]  */
-    protected $aliases = [
+    protected array $aliases = [
         'simple' => Simple::class,
     ];
 
     /** @var string[]|callable[] */
-    protected $factories = [
+    protected array $factories = [
         Simple::class => InvokableFactory::class,
     ];
 
-    /** @var ?string */
-    protected $instanceOf = FormatterInterface::class;
+    protected string $instanceOf = FormatterInterface::class;
 
     /**
      * Allow many formatters of the same type
-     *
-     * @var bool
      */
-    protected $sharedByDefault = false;
+    protected bool $sharedByDefault = false;
 
     /**
      * Validate the plugin is of the expected type.

diff --git a/src/Manager/ProcessorPluginManager.php b/src/Manager/ProcessorPluginManager.php
@@ -24,30 +24,27 @@
 class ProcessorPluginManager extends AbstractPluginManager
 {
     /** @var string[] */
-    protected $aliases = [
+    protected array $aliases = [
         'backtrace'      => Backtrace::class,
         'psrplaceholder' => PsrPlaceholder::class,
         'referenceid'    => ReferenceId::class,
         'requestid'      => RequestId::class,
     ];
 
     /** @var string[]|callable[] */
-    protected $factories = [
+    protected array $factories = [
         Backtrace::class      => InvokableFactory::class,
         PsrPlaceholder::class => InvokableFactory::class,
         ReferenceId::class    => InvokableFactory::class,
         RequestId::class      => InvokableFactory::class,
     ];
 
-    /** @var ?string */
-    protected $instanceOf = ProcessorInterface::class;
+    protected string $instanceOf = ProcessorInterface::class;
 
     /**
      * Allow many processors of the same type
-     *
-     * @var bool
      */
-    protected $sharedByDefault = false;
+    protected bool $sharedByDefault = false;
 
     /**
      * Validate the plugin is of the expected type.

diff --git a/src/Manager/WriterPluginManager.php b/src/Manager/WriterPluginManager.php
@@ -22,7 +22,7 @@
 class WriterPluginManager extends AbstractPluginManager
 {
     /** @var string[] */
-    protected $aliases = [
+    protected array $aliases = [
         'noop'   => Noop::class,
         'stream' => Stream::class,
 
@@ -33,20 +33,17 @@ class WriterPluginManager extends AbstractPluginManager
     ];
 
     /** @var string[]|callable[] */
-    protected $factories = [
+    protected array $factories = [
         Noop::class   => WriterFactory::class,
         Stream::class => WriterFactory::class,
     ];
 
-    /** @var ?string */
-    protected $instanceOf = WriterInterface::class;
+    protected string $instanceOf = WriterInterface::class;
 
     /**
      * Allow many writers of the same type
-     *
-     * @var bool
      */
-    protected $sharedByDefault = false;
+    protected bool $sharedByDefault = false;
 
     /**
      * Validate the plugin is of the expected type.

diff --git a/src/Writer/AbstractWriter.php b/src/Writer/AbstractWriter.php
@@ -15,8 +15,10 @@
 use Exception;
 use Laminas\ServiceManager\ServiceManager;
 use Laminas\Stdlib\ErrorHandler;
+use Psr\Container\ContainerExceptionInterface;
 use Traversable;
 
+use function class_exists;
 use function gettype;
 use function is_array;
 use function is_int;
@@ -35,7 +37,7 @@ abstract class AbstractWriter implements WriterInterface
 
     protected array $filters = [];
 
-    protected FormatterInterface $formatter;
+    protected ?FormatterInterface $formatter = null;
 
     /**
      * Use Laminas\Stdlib\ErrorHandler to report errors during calls to write
@@ -53,6 +55,8 @@ abstract class AbstractWriter implements WriterInterface
      * Set options for a writer. Accepted options are:
      * - filters: array of filters to add to this filter
      * - formatter: formatter for this writer
+     *
+     * @throws ContainerExceptionInterface
      */
     public function __construct(?iterable $options = null)
     {
@@ -99,14 +103,22 @@ public function __construct(?iterable $options = null)
                         throw new InvalidArgumentException('Options must contain a name for the formatter');
                     }
                     $formatterOptions = $formatter['options'] ?? null;
-                    $this->setFormatter($formatter['name'], $formatterOptions);
+
+                    $formatterClass = $formatter['name'];
+                    if (class_exists($formatterClass)) {
+                        $formatterClass = new $formatterClass();
+                    }
+
+                    $this->setFormatter($formatterClass, $formatterOptions);
                 }
             }
         }
     }
 
     /**
      * Add a filter specific to this writer.
+     *
+     * @throws ContainerExceptionInterface
      */
     public function addFilter(int|string|FilterInterface $filter, ?array $options = null): WriterInterface
     {
@@ -138,6 +150,9 @@ public function getFilterPluginManager(): ?FilterPluginManager
         return $this->filterPlugins;
     }
 
+    /**
+     * @param class-string|FilterPluginManager $plugins
+     */
     public function setFilterPluginManager(string|FilterPluginManager $plugins): static
     {
         if (is_string($plugins)) {
@@ -155,9 +170,12 @@ public function setFilterPluginManager(string|FilterPluginManager $plugins): sta
         return $this;
     }
 
+    /**
+     * @throws ContainerExceptionInterface
+     */
     public function filterPlugin(string $name, ?array $options = null): mixed
     {
-        return $this->getFilterPluginManager()->get($name, $options);
+        return $this->getFilterPluginManager()?->build($name, $options);
     }
 
     public function getFormatterPluginManager(): ?FormatterPluginManager
@@ -168,6 +186,9 @@ public function getFormatterPluginManager(): ?FormatterPluginManager
         return $this->formatterPlugins;
     }
 
+    /**
+     * @param class-string|FormatterPluginManager $plugins
+     */
     public function setFormatterPluginManager(string|FormatterPluginManager $plugins): static
     {
         if (is_string($plugins)) {
@@ -187,9 +208,12 @@ public function setFormatterPluginManager(string|FormatterPluginManager $plugins
         return $this;
     }
 
+    /**
+     * @throws ContainerExceptionInterface
+     */
     public function formatterPlugin(string $name, ?array $options = null): mixed
     {
-        return $this->getFormatterPluginManager()->get($name, $options);
+        return $this->getFormatterPluginManager()?->build($name, $options);
     }
 
     /**
@@ -229,6 +253,9 @@ public function write(array $event): void
         }
     }
 
+    /**
+     * @throws ContainerExceptionInterface
+     */
     public function setFormatter(FormatterInterface|string $formatter, ?array $options = null): WriterInterface
     {
         if (is_string($formatter)) {
@@ -247,7 +274,7 @@ public function setFormatter(FormatterInterface|string $formatter, ?array $optio
         return $this;
     }
 
-    protected function getFormatter(): FormatterInterface
+    protected function getFormatter(): ?FormatterInterface
     {
         return $this->formatter;
     }