Merge pull request #53 from FabianTe/feat/psr-logger-interface

Introduce PSR 3 for logging

Author: Tim Helfensdörfer

composer.json

@@ -16,7 +16,8 @@
         "php": ">=7.2.0",
         "desarrolla2/cache": "^3.0",
         "monolog/monolog": "^2.1",
-        "composer/semver": "^3.0"
+        "composer/semver": "^3.0",
+        "psr/log": "1.1.4"
     },
     "require-dev": {
         "roave/security-advisories": "dev-master",

example/client/update/index.php

@@ -9,9 +9,12 @@
 // Replace with your server update directory
 $update->setUpdateUrl('http://127.0.0.1:8090/example/server');
 
-// Log handler and cache are optional
-$update->addLogHandler(new Monolog\Handler\StreamHandler(__DIR__ . '/update.log'));
+// Custom logger (optional)
+$logger = new \Monolog\Logger("default");
+$logger->pushHandler(new Monolog\Handler\StreamHandler(__DIR__ . '/update.log'));
+$update->setLogger($logger);
 
+// Cache (optional but recommended)
 $cache = new Desarrolla2\Cache\File(__DIR__ . '/cache');
 $update->setCache($cache, 3600);
 

src/AutoUpdate.php

@@ -9,9 +9,8 @@
 use Composer\Semver\Comparator;
 use Desarrolla2\Cache\CacheInterface;
 use Desarrolla2\Cache\NotCache;
-use Monolog\Handler\HandlerInterface;
 use Monolog\Logger;
-use Monolog\Handler\NullHandler;
+use Psr\Log\LoggerInterface;
 use Psr\SimpleCache\InvalidArgumentException;
 use VisualAppeal\Exceptions\DownloadException;
 use VisualAppeal\Exceptions\ParserException;
@@ -44,7 +43,7 @@ class AutoUpdate {
     /**
      * Logger instance.
      *
-     * @var Logger
+     * @var LoggerInterface
      */
     private $log;
 
@@ -199,7 +198,6 @@ public function __construct(?string $tempDir = null, ?string $installDir = null,
     {
         // Init logger
         $this->log = new Logger('auto-update');
-        $this->log->pushHandler(new NullHandler());
 
         $this->setTempDir($tempDir ?? (__DIR__ . DIRECTORY_SEPARATOR . 'temp' . DIRECTORY_SEPARATOR));
         $this->setInstallDir($installDir ?? (__DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR));
@@ -364,14 +362,14 @@ private function useBasicAuth()
     }
 
     /**
-     * Add a new logging handler.
+     * Replace the logger internally used by the given logger instance.
      *
-     * @param HandlerInterface $handler See https://github.com/Seldaek/monolog
+     * @param LoggerInterface $logger
      * @return AutoUpdate
      */
-    public function addLogHandler(HandlerInterface $handler): AutoUpdate
+    public function setLogger(LoggerInterface $logger): AutoUpdate
     {
-        $this->log->pushHandler($handler);
+        $this->log = $logger;
 
         return $this;
     }

tests/AutoUpdateTest.php

@@ -25,7 +25,9 @@ protected function setUp(): void
         $this->_update = new AutoUpdate(__DIR__ . DIRECTORY_SEPARATOR . 'temp', __DIR__ . DIRECTORY_SEPARATOR . 'install');
         $this->_update->setCurrentVersion('0.1.0');
         $this->_update->setUpdateUrl(__DIR__ . DIRECTORY_SEPARATOR . 'fixtures');
-        $this->_update->addLogHandler(new Monolog\Handler\StreamHandler(__DIR__ . DIRECTORY_SEPARATOR . 'temp' . DIRECTORY_SEPARATOR . 'update.log'));
+        $logger = new Monolog\Logger("default");
+        $logger->pushHandler(new Monolog\Handler\StreamHandler(__DIR__ . DIRECTORY_SEPARATOR . 'temp' . DIRECTORY_SEPARATOR . 'update.log'));
+        $this->_update->setLogger($logger);
     }
 
     /**