Skip to content
This repository was archived by the owner on Sep 6, 2023. It is now read-only.

Commit 270acad

Browse files
authored
Update README.md
1 parent 187dd25 commit 270acad

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
Что это?
22
--------------------------
33

4-
BitrixDebugger - библиотека для дебага в 1с битрикс, которая позволяет выводить данные в дебаг-панель, логировать в файлы, в будущем появится функционал
5-
вывода дебаг-данных на месте вызова методов.
4+
BitrixDebugger - библиотека для дебага в 1с битрикс, которая позволяет выводить данные в дебаг-панель, логировать в файлы, выводить дебаг-данные на месте вызова соответствующей функции.
65

7-
Зачем мне это?
6+
Зачем вам это?
87
--------------------------
98

109
Из проекта в проект я видел картину, что каждый разработчик реализует свою дебаг-функцию, которая в целом делает то же самое - вывод код внутри тега \<pre\>. Согласитесь, было бы удобнее скачать библиотеку и настроить в IDE сниппеты для нее
@@ -27,10 +26,10 @@ include 'BitrixDebugger/initializer.php';
2726
```php
2827
<?php
2928

30-
GD()->notice('Моя переменная', 'Моя переменная 2');
31-
GD()->error('Моя переменная', 'Моя переменная 2');
32-
GD()->warning('Моя переменная', 'Моя переменная 2');
33-
GD()->success('Моя переменная', 'Моя переменная 2', 'Моя переменная 3', ['test' => [
29+
DD()->notice('Моя переменная', 'Моя переменная 2');
30+
DD()->error('Моя переменная', 'Моя переменная 2');
31+
DD()->warning('Моя переменная', 'Моя переменная 2');
32+
DD()->success('Моя переменная', 'Моя переменная 2', 'Моя переменная 3', ['test' => [
3433
'testSubKey1' => [
3534
1,2,3
3635
],
@@ -47,13 +46,13 @@ GD()->success('Моя переменная', 'Моя переменная 2', '
4746
```php
4847
<?php
4948

50-
GD()->noticeLog('Моя переменная', 'Моя переменная 2');
51-
GD()->errorLog('Моя переменная', 'Моя переменная 2');
52-
GD()->warningLog('Моя переменная', 'Моя переменная 2');
53-
GD()->successLog('Моя переменная', 'Моя переменная 2', 'Моя переменная 3');
49+
DD()->noticeLog('Моя переменная', 'Моя переменная 2');
50+
DD()->errorLog('Моя переменная', 'Моя переменная 2');
51+
DD()->warningLog('Моя переменная', 'Моя переменная 2');
52+
DD()->successLog('Моя переменная', 'Моя переменная 2', 'Моя переменная 3');
5453
```
5554

56-
Папку для логирования можно настроить в файле initializer.php
55+
Папку для логирования можно настроить в папке initializers в файле server.php
5756
```php
5857
<?php
5958

@@ -63,9 +62,11 @@ $ggrachDebuggerConfigurator->setLogPath('success', __DIR__ . '/logs/success.log'
6362
$ggrachDebuggerConfigurator->setLogPath('notice', __DIR__ . '/logs/notice.log');
6463
```
6564

66-
В данный момент дебаг-данные отображаются только в дебаг-панели, на месте вызова отображать нельзя. Дебаг-панель видна только пользователям, которые являются администраторами.
65+
Если планируете использовать логирование в файлы без сервера (cli), то укажите DOCUMENT_ROOT в папке initializers в файле cli.php
6766

68-
Данные в дебаг-панели можно скрывать, раскрывать, если присутствует переменная-строка. Если она больше 200 символов, то будет замена на [Очень длинный текст] и удаляются все html теги, чтобы исключить ошибки в отображении
67+
Дебаг-панель видна только пользователям, которые являются администраторами.
68+
69+
Данные в дебаг-панели можно скрывать, раскрывать по ключам массива. Если присутствует переменная-строка и она больше 200 символов, то будет замена на [Очень длинный текст], так же у строк удаляются все html теги, чтобы исключить ошибки в отображении.
6970

7071
Тестировалась скорость формирования страницы с библиотекой и без, при ее наличии скорость дольше примерно на 0,01 сек., что не значительно замедляет проект.
7172

0 commit comments

Comments
 (0)