Кнопка "trace" перенесена наверх, исправлено форматирование PHPDoc, исправлены ошибки в документации,css (цвет классов)

Author: peraleks

src/Core/ConfigObject.php

@@ -39,7 +39,7 @@ class ConfigObject
     /**
      * Имя класса-уведомителя.
      *
-     * $this->get() будет искать значения в масиве конфигурации
+     * $this->get() будет искать значения в массиве конфигурации
      * по этому имени и переданному ключу
      *
      * @var string
@@ -212,7 +212,7 @@ public function getAppDir(): string
     }
 
     /**
-     * Вщзвращает значение конфигурации 'MODE'.
+     * Возвращает значение конфигурации 'MODE'.
      *
      * Не определяет режим CLI. Для этого воспользуйтесь
      * на месте выражением if (PHP_SAPI === 'cli')
@@ -225,7 +225,7 @@ public function getMode(): string
     }
 
     /**
-     * Вщзвращает значение конфигурации 'SELF_LOG_FILE'.
+     * Возвращает значение конфигурации 'SELF_LOG_FILE'.
      *
      * @return string если не задано, то пустая строка
      */

src/Core/ErrorHandler.php

@@ -26,7 +26,7 @@ class ErrorHandler
     /**
      * Текущая версия пакета.
      */
-    const VERSION = '0.9.1';
+    const VERSION = '0.9.2';
 
     /**
      * Singleton.
@@ -96,7 +96,7 @@ private function __construct($configFile = null)
     /**
      * Singleton.
      *
-     * @param null          $configFile string полное имя файла конфигурации
+     * @param null | string  $configFile  полное имя файла конфигурации
      * @return ErrorHandler
      */
     public static function instance($configFile = null)
@@ -139,13 +139,12 @@ public function error($code, $message, $file, $line)
      * <br>
      * ErrorHandler::instance()->exception($e, 'someType').
      * <br>
-     * Если не передать второй зараметр ServerErrorNotifier отправит
-     * заголовок 500, покажет страницу ошибки и прервёт вполнение скрипта.
+     * Если не передать второй параметр, ServerErrorNotifier отправит
+     * заголовок "500", покажет страницу ошибки и прервёт вполнение скрипта.
      *
      * @param \Throwable $e       объект ошибки
      * @param string     $logType тип ошибки
-     * @param string     $handler название функции обработчика ('error' |
-     *                            'exception' | 'shutdown')
+     * @param string     $handler название функции обработчика ('error' | 'exception' | 'shutdown')
      */
     public function exception(\Throwable $e, $logType = '', string $handler = 'exception')
     {

src/Core/ErrorObject.php

@@ -46,7 +46,7 @@ class ErrorObject
     protected $type = '';
 
     /**
-     * Лубая строка, заданная пользователем.
+     * Любая строка, заданная пользователем.
      *
      * Будет трактоваться как тип ошибки в логах и т.д.
      * Является флагом для ServerErrorNotifier

src/Core/SelfErrorHandler.php

@@ -157,7 +157,7 @@ private function htmlReport($e)
     /**
      * Пишет ошибку в файл.
      *
-     * Eсли требуется, отправляет состояние 500 с последующим
+     * Если требуется, отправляет состояние 500 с последующим
      * прерыванием выполнения скрипта.
      *
      * @param \Throwable|ErrorObject $e    объект ошибки

src/Exception/ErrorHandlerException.php

@@ -16,7 +16,7 @@
  * Class ErrorHandlerException
  *
  * Исключение для любых ошибок, произошедших внутри обработчика
- * и не подподающих под категории исключений расширяющих данный класс.
+ * и не подпадающих под категории исключений расширяющих данный класс.
  */
 class ErrorHandlerException extends \Exception
 {

src/Exception/PropertyMustBeDefinedException.php

@@ -30,7 +30,7 @@ class PropertyMustBeDefinedException extends ErrorHandlerException
      * <br>
      * Например: "TailNotifier: the property 'file'=> must be defined".
      *
-     * @param string $key ключ нассива конфигурации
+     * @param string $key ключ массива конфигурации
      */
     public function __construct(string $key)
     {

src/Trace/AbstractTraceFormatter.php

@@ -58,7 +58,7 @@ abstract class AbstractTraceFormatter implements FormatterInterface
     final public function __construct() {}
 
     /**
-     * Инизиализирует начальные параметры.
+     * Инициализирует начальные параметры.
      *
      * Запускает шаблонный метод handleTrace()
      * И возвращает форматированный стек вызовов.
@@ -171,12 +171,12 @@ protected function isClosedResource($arg)
      * Вычисляет количество (всего) параметров и обязательных параметров функции.<br>
      * Проверяет был ли параметр уничтожен в ходе выполнения функции/метода
      * и добовляет 'unset{количество}' к строке с количеством аргументов.
-     * Это покаежет, что стек вызовов содеожит не все параметры функции,
+     * Это покаежет, что стек вызовов содержит не все параметры функции,
      * которые ей реально были переданы.<br>
      * Этот функционал добавлен потому, что уничтоженный
      * (unset()) параметр невозможно отличить от непереданного.
      * И если один из параметров был уничтожен, невозможно определить каким по счёту он был,
-     * значит произошло смещение параметров, и не стоит полагаться на их порядковое расположение
+     * значит произошло смещение параметров в таблице, и не стоит полагаться на их порядковое расположение
      * при соотнесении с аргументами функции.
      *
      * @param string   $func    имя функции/метода

src/Trace/CliTraceFormatter.php

@@ -42,7 +42,7 @@ class CliTraceFormatter extends AbstractTraceFormatter
     protected $align = 15;
 
     /**
-     * Максимальная длянна строки при показе содержимого
+     * Максимальная длинна строки при показе содержимого
      * строковых параметров и массивов.
      *
      * @var int

src/Trace/HtmlTraceFormatter.php

@@ -197,28 +197,32 @@ protected function className(string $class, string $type): string
     }
 
     /**
-     * Возвращает форматированнцй PHPDoc метода или класса в HTML
+     * Возвращает форматированнцй в HTML PHPDoc метода или класса
      *
      * @param string $doc PHPDoc
      * @return string
      */
     protected function formatDocToHtml(string $doc): string
     {
+        $doc = preg_replace('/\t/', '    ', $doc);
+
         /* удаляем спецсимволы комментария (/** * /) и нормализуем окончание строк */
-        $doc = preg_replace('/(\r\n\s*\*)|(\n\s*\*)|(\r\s*\*)/', "\n", $doc);
-        $doc = preg_replace('/(^.*?\/\*\*)|(\/$)/', '', $doc);
+        $doc = preg_replace('/(\r\n *\*)|(\n *\*)|(\r *\*)/', "\n", $doc);
+        $doc = preg_replace('/(^.*?\/\*\*(?:\n))|(\/$)/', '', $doc);
 
         $doc = htmlentities($doc, ENT_SUBSTITUTE | ENT_COMPAT);
 
         /* выделяем названия типов */
-        $doc = preg_replace('/(@param\s+)(.*?)(\s+\$)/', '$1'.sprintf(static::DOC_TYPE, '$2 ').'$3', $doc);
-        $doc = preg_replace('/(@return\s+)(.*? )/', '$1'.sprintf(static::DOC_TYPE, '$2 '), $doc);
+        $doc = preg_replace(
+            '/^ *((?:@return|@throws|@param) +)([^ \n]+)( +)?(.*)$/m',
+            '$1'.sprintf(static::DOC_TYPE, '$2').'$3$4', $doc
+        );
 
         /* выделяем теги PHPDoc */
-        $doc = preg_replace('/(@.*?) /', sprintf(static::DOC_TAG, '$1 '), $doc);
+        $doc = preg_replace('/^ *(@[^ ]+)( +)?(.+)?$/m', sprintf(static::DOC_TAG, '$1').'$2$3', $doc);
 
         /* выделяем имена переменных */
-        $doc = preg_replace('/(@.*?)(\$.*?)( |\n)/', '$1'.sprintf(static::DOC_VAR, '$2').'$3', $doc);
+        $doc = preg_replace('/(@.*?)(\$.*?)(\s)/', '$1'.sprintf(static::DOC_VAR, '$2').'$3', $doc);
 
         /* выделяем ссылки */
         $doc = preg_replace('#(http(?:s)?://.*?)( |<|\n)#', sprintf(static::DOC_HREF, '$1', '$1').'$2', $doc);

src/View/error.tpl.php

@@ -21,18 +21,18 @@
     <div class="text">
         <?= $message ?>
     </div>
-    <div id="<?= $id ?>" class="peraleks_tw <?= $hidden ?>">
-        <?= $trace ?>
-    </div>
     <div class="file">
         <span title="<?= $path ?>"><?= $file ?></span><span class="bracket">(</span><span
                 class="line"><?= $line ?></span><span class="bracket">)</span>
         <?php if ($trace != '') : ?>
-            <div class="but_trace" onclick="parentNode.previousElementSibling.classList.toggle('hidden')">
+            <div class="but_trace" onclick="parentNode.nextElementSibling.classList.toggle('hidden')">
                 trace <?= $traceCount ?>
             </div>
         <?php endif; ?>
     </div>
+    <div id="<?= $id ?>" class="peraleks_tw <?= $hidden ?>">
+        <?= $trace ?>
+    </div>
 </div>
 <?php if ($trace != '') : ?>
     <script>