reformat code

.gitignore

@@ -0,0 +1,5 @@
+source
+var
+vendor
+.php-cs-fixer.cache
+composer.lock

.php-cs-fixer.php

@@ -0,0 +1,34 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__)
+;
+
+$header = <<<EOF
+Copyright (c) D3 Data Development (Inh. Thomas Dartsch)
+
+For the full copyright and license information, please view
+the LICENSE file that was distributed with this source code.
+
+https://www.d3data.de
+
+@copyright (C) D3 Data Development (Inh. Thomas Dartsch)
+@author    D3 Data Development - Daniel Seifert <info@shopmodule.com>
+@link      https://www.oxidmodule.com
+EOF;
+
+$config = new PhpCsFixer\Config();
+return $config->setRules([
+    '@PHP80Migration' => true,
+    '@PSR12' => true,
+    'header_comment' => [
+        'comment_type' => 'PHPDoc',
+        'header' => $header,
+        'location' => 'after_open',
+        'separate' => 'both',
+    ],
+    'php_unit_test_class_requires_covers' => true,
+    'doctrine_annotation_indentation' => true,
+])
+    ->setFinder($finder)
+;

composer.json

@@ -22,9 +22,23 @@
     "monolog/monolog": "^1.27",
     "d3/sensitive-message-formatter": "^1.0"
   },
+  "require-dev": {
+    "friendsofphp/php-cs-fixer": "^3.65",
+    "phpstan/phpstan": "^2.0"
+  },
   "autoload": {
     "psr-4": {
       "D3\\GuzzleFactory\\": "src/"
     }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "D3\\OxidGuzzleFactory\\tests\\": "tests/"
+    }
+  },
+  "scripts": {
+    "check-style": "./vendor/bin/php-cs-fixer fix --verbose --dry-run",
+    "fix-style": "./vendor/bin/php-cs-fixer fix --verbose",
+    "check-code": "./vendor/bin/phpstan analyse -c phpstan.neon --no-progress --ansi"
   }
 }

phpstan.neon

@@ -0,0 +1,9 @@
+parameters:
+  scanFiles:
+    - vendor/oxid-esales/oxideshop-ce/source/bootstrap.php
+    - vendor/oxid-esales/oxideshop-ce/source/oxfunctions.php
+    - vendor/oxid-esales/oxideshop-ce/source/overridablefunctions.php
+  paths:
+    - src
+  level: 10
+  phpVersion: 80000

src/GuzzleFactory.php

@@ -1,8 +1,10 @@
 <?php
 
 /**
- * For the full copyright and license information, please view the LICENSE
+ * Copyright (c) D3 Data Development (Inh. Thomas Dartsch)
- * file that was distributed with this source code.
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
  *
  * https://www.d3data.de
  *
@@ -11,11 +13,14 @@
  * @link      https://www.oxidmodule.com
  */
 
+declare(strict_types=1);
+
 namespace D3\GuzzleFactory;
 
 use GuzzleHttp\Client;
 use GuzzleHttp\HandlerStack;
 use GuzzleHttp\Middleware;
+use Monolog\Logger;
 
 class GuzzleFactory
 {
@@ -23,7 +28,7 @@ class GuzzleFactory
     use LoggerTrait;
     use MessageFormatterTrait;
 
-    public static function create()
+    public static function create(): GuzzleFactory
     {
         return new GuzzleFactory();
     }
@@ -36,8 +41,8 @@ class GuzzleFactory
                  'headers' => [
                      'Content-Type' => $this->getContentType(),
                      'Accept'       => $this->getAccept(),
-                     'User-Agent'   => $this->getUserAgent()
+                     'User-Agent'   => $this->getUserAgent(),
-                 ]
+                 ],
              ]);
     }
 
@@ -46,7 +51,15 @@ class GuzzleFactory
         $stack = HandlerStack::create();
 
         foreach ($this->getLoggers() as $logger) {
-            $stack->push( Middleware::log( $logger, $this->getMessageFormatter(), $this->getMessageLevel() ) );
+            /** @var 'alert'|'critical'|'debug'|'emergency'|'error'|'info'|'notice'|'warning' $logLevelName */
+            $logLevelName = Logger::getLevelName($this->getMessageLevel());
+            $stack->push(
+                Middleware::log(
+                    $logger,
+                    $this->getMessageFormatter(),
+                    $logLevelName
+                )
+            );
         }
 
         return $stack;

src/HeaderTrait.php

@@ -1,8 +1,10 @@
 <?php
 
 /**
- * For the full copyright and license information, please view the LICENSE
+ * Copyright (c) D3 Data Development (Inh. Thomas Dartsch)
- * file that was distributed with this source code.
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
  *
  * https://www.d3data.de
  *
@@ -11,6 +13,8 @@
  * @link      https://www.oxidmodule.com
  */
 
+declare(strict_types=1);
+
 namespace D3\GuzzleFactory;
 
 use GuzzleHttp\Utils;
@@ -26,7 +30,7 @@ trait HeaderTrait
         return $this->accept ?? 'application/json';
     }
 
-    public function setAccept( ?string $accept ): void
+    public function setAccept(?string $accept): void
     {
         $this->accept = $accept;
     }
@@ -36,7 +40,7 @@ trait HeaderTrait
         return $this->contentType ?? 'application/json';
     }
 
-    public function setContentType( ?string $contentType ): void
+    public function setContentType(?string $contentType): void
     {
         $this->contentType = $contentType;
     }
@@ -46,7 +50,7 @@ trait HeaderTrait
         return $this->userAgent ?? Utils::defaultUserAgent();
     }
 
-    public function setUserAgent( ?string $userAgent ): void
+    public function setUserAgent(?string $userAgent): void
     {
         $this->userAgent = $userAgent;
     }

src/LoggerTrait.php

@@ -1,8 +1,10 @@
 <?php
 
 /**
- * For the full copyright and license information, please view the LICENSE
+ * Copyright (c) D3 Data Development (Inh. Thomas Dartsch)
- * file that was distributed with this source code.
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
  *
  * https://www.d3data.de
  *
@@ -11,6 +13,8 @@
  * @link      https://www.oxidmodule.com
  */
 
+declare(strict_types=1);
+
 namespace D3\GuzzleFactory;
 
 use Monolog\Handler\RotatingFileHandler;
@@ -21,6 +25,7 @@ use Psr\Log\LoggerInterface;
 
 trait LoggerTrait
 {
+    /** @var LoggerInterface[]  */
     protected array $loggers = [];
     protected ?int $messageLevel = null;
 
@@ -36,7 +41,7 @@ trait LoggerTrait
             new StreamHandler(
                 OX_BASE_PATH . 'log' . DIRECTORY_SEPARATOR . $fileName,
                 $logLevel
-            ):
+            ) :
             new RotatingFileHandler(
                 OX_BASE_PATH . 'log' . DIRECTORY_SEPARATOR . $fileName,
                 $maxFiles,
@@ -52,6 +57,9 @@ trait LoggerTrait
         $this->loggers[md5(serialize($logger))] = $logger;
     }
 
+    /**
+     * @return LoggerInterface[]
+     */
     protected function getLoggers(): array
     {
         return $this->loggers;
@@ -62,7 +70,7 @@ trait LoggerTrait
         return $this->messageLevel ?? Logger::INFO;
     }
 
-    public function setMessageLevel( ?int $messageLevel ): void
+    public function setMessageLevel(?int $messageLevel): void
     {
         $this->messageLevel = $messageLevel;
     }

src/MessageFormatterTrait.php

@@ -1,8 +1,10 @@
 <?php
 
 /**
- * For the full copyright and license information, please view the LICENSE
+ * Copyright (c) D3 Data Development (Inh. Thomas Dartsch)
- * file that was distributed with this source code.
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
  *
  * https://www.d3data.de
  *
@@ -11,6 +13,8 @@
  * @link      https://www.oxidmodule.com
  */
 
+declare(strict_types=1);
+
 namespace D3\GuzzleFactory;
 
 use D3\SensitiveMessageFormatter\sensitiveMessageFormatter;
@@ -26,13 +30,19 @@ trait MessageFormatterTrait
         return $this->formatter ?? $this->getDefaultMessageFormatter();
     }
 
-    public function setMessageFormatter( ?string $template, ?array $anonymisations = null, ?string $replaceChar = null): void
+    /**
+     * @param string|null $template
+     * @param string[]|null $anonymisations
+     * @param string|null $replaceChar
+     * @return void
+     */
+    public function setMessageFormatter(?string $template, ?array $anonymisations = null, ?string $replaceChar = null): void
     {
-        $template = $template ?? $this->getDefaultFormatterTemplate();
+        $template ??= $this->getDefaultFormatterTemplate();
 
         $this->formatter =
             is_null($anonymisations) ?
-                $this->getDefaultMessageFormatter( $template) :
+                $this->getDefaultMessageFormatter($template) :
                 new sensitiveMessageFormatter(
                     $template,
                     $anonymisations,
@@ -42,7 +52,7 @@ trait MessageFormatterTrait
 
     protected function getDefaultMessageFormatter(?string $template = null): MessageFormatterInterface
     {
-        $template = $template ?? $this->getDefaultFormatterTemplate();
+        $template ??= $this->getDefaultFormatterTemplate();
         return new MessageFormatter(
             $template,
         );