Refactoring

Author: andrey-tech

README.md

@@ -55,10 +55,10 @@ $ composer require andrey-tech/debug-logger-php:"^2.0"
 <a id="%D0%9C%D0%B5%D1%82%D0%BE%D0%B4%D1%8B-%D0%BA%D0%BB%D0%B0%D1%81%D1%81%D0%B0"></a>
 ### Методы класса
 
-- `static instance(string $logFileName = 'debug.log') :self`  
-    Возвращает единственный объект данного класса **для заданного лог-файла** `$logFileName`.
+- `static instance(string $logFileName = 'debug.log'): DebugLogger`  
+    Возвращает единственный объект класса `DebugLogger` **для заданного лог-файла** `$logFileName`.
     + `$logFileName` - имя лог-файла.
-- `save(mixed $info, object $object = null, string $header = null) :void` Сохраняет подлежащую логированию информацию в файл.
+- `save(mixed $info, object $object = null, string $header = null): void` Сохраняет подлежащую логированию информацию в файл.
     + `$info` - строка, массив или объект для логирования;
     + `$object` - ссылка на объект класса в котором выполняется логирование;
     + `$header` - строка заголовка для сохраняемой в лог файл информации.

src/App/DebugLogger/DebugLogger.php

@@ -4,11 +4,11 @@
  * Простой логгер, сохраняющий отладочную информацию в файл
  *
  * @author    andrey-tech
- * @copyright 2019-2021 andrey-tech
+ * @copyright 2019-2022 andrey-tech
  * @see https://github.com/andrey-tech/debug-logger-php
  * @license   MIT
  *
- * @version 2.0.0
+ * @version 2.0.1
  *
  * v1.0.0 (23.08.2019) Начальный релиз
  * v1.1.0 (30.08.2019) Добавлен флаг isActive
@@ -27,6 +27,7 @@
  * v1.8.0 (10.06.2020) Удален параметр $header из метода save(). Рефакторинг
  * v1.9.0 (13.07.2020) Добавлен необязательный заголовок для отладочной информации
  * v2.0.0 (06.02.2021) Изменение пространства имен на \App\DebugLogger
+ * v2.0.1 (05.06.2022) Рефакторинг
  *
  */
 
@@ -108,7 +109,7 @@ private function __construct(string $logFileName)
      * @param string $logFileName Имя лог файла
      * @return DebugLogger
      */
-    public static function instance(string $logFileName = 'debug.log'): DebugLogger
+    public static function instance(string $logFileName = 'debug.log'): DebugLoggerInterface
     {
         if (! isset(self::$instances[ $logFileName ])) {
             self::$instances[ $logFileName ] = new self($logFileName);
@@ -122,6 +123,7 @@ public static function instance(string $logFileName = 'debug.log'): DebugLogger
      * @param ?object $object Объект класса в котором вызывается метод
      * @param ?string $header Заголовок отладочной информации
      * @return void
+     * @throws DebugLoggerException
      */
     public function save($info, $object = null, string $header = null)
     {
@@ -145,7 +147,6 @@ public function save($info, $object = null, string $header = null)
         $this->microtime = $microtime;
 
         // Форматирует время запроса
-        /** @noinspection PrintfScanfArgumentsInspection */
         $dateTime = DateTime::createFromFormat('U.u', sprintf('%.f', $microtime));
         $timeZone = new DateTimeZone(date_default_timezone_get());
         $dateTime->setTimeZone($timeZone);
@@ -189,6 +190,7 @@ public function save($info, $object = null, string $header = null)
      * @param string $relativeFileName Относительное имя файла
      * @param bool $createDir Создавать каталоги при необходимости?
      * @return string|null Абсолютное имя файла
+     * @throws DebugLoggerException
      * @see http://php.net/manual/ru/function.stream-resolve-include-path.php#115229
      */
     private function getAbsoluteFileName(string $relativeFileName, bool $createDir = true)
@@ -201,7 +203,7 @@ private function getAbsoluteFileName(string $relativeFileName, bool $createDir =
                 return $absoluteFileName;
             }
             if ($createDir) {
-                if (!mkdir($checkDir, self::$mkdirMode, $recursive = true) && !is_dir($checkDir)) {
+                if (!mkdir($checkDir, self::$mkdirMode, true) && !is_dir($checkDir)) {
                     throw new DebugLoggerException("Не удалось создать каталог для лог файлов '{$checkDir}'");
                 }
                 return $absoluteFileName;

src/App/DebugLogger/DebugLoggerInterface.php

@@ -8,10 +8,11 @@
  * @see https://github.com/andrey-tech/debug-logger-php
  * @license   MIT
  *
- * @version 1.0.1
+ * @version 1.0.2
  *
  * v1.0.0 (06.02.2021) Начальный релиз
  * v1.0.1 (03.06.2022) Исправлена сигнатура метода instance()
+ * v1.0.2 (05.06.2022) Изменена сигнатура метода instance()
  *
  */
 
@@ -24,8 +25,9 @@ interface DebugLoggerInterface
     /**
      * Возвращает единственный объект класса логгера для заданного лог файла
      * @param string $logFileName Имя лог файла
+     * @return DebugLoggerInterface
      */
-    public static function instance(string $logFileName);
+    public static function instance(string $logFileName): DebugLoggerInterface;
 
     /**
      * Сохраняет отладочную информацию в файл