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

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ggrachdev authored Mar 10, 2021
1 parent 41b804d commit 4af6de7
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,17 @@ BitrixDebugger - библиотека для дебага в 1с битрикс,

Из проекта в проект я видел картину, что каждый разработчик реализует свою дебаг-функцию, которая в целом делает то же самое - вывод код внутри тега \<pre\>. Согласитесь, было бы удобнее скачать библиотеку и настроить в IDE сниппеты для нее

Как пользоваться?
Способы установки
--------------------------
Зайдите в Вашу папку php_interface где лежит так же файл init.php и введите команду (либо скачайте архив с данного репозитория):
1) Скопируйте папку ggrachdev.debugbar из папки module и положите в /bitrix/modules и выполните стандартную установку и подключите модуль в init.php:
```php
<?php

\Bitrix\Main\Loader::includeModule('ggrachdev.debugbar');
```
Теперь вам будут доступны все нижеописанные функции для дебага данных.

2) Зайдите в Вашу папку php_interface где лежит так же файл init.php и введите команду (либо скачайте архив с данного репозитория):

```console
$ git clone https://github.com/ggrachdev/BitrixDebugger
Expand Down Expand Up @@ -40,6 +48,12 @@ DD()->success('Моя переменная', 'Моя переменная 2', '
1,2,3
]
]]);

// Можно осуществлять цепочку вызовов
DD()->notice('Моя переменная', 'Моя переменная 2')->error(/*...*/)->notice(/*...*/)->...;

// Можно дебажить без вызова notice явно (просто передав параметры в DD() - идентично notice):
DD('Моя переменная', 'Моя переменная 2')->error(/*...*/)->...;
```

Так же можно логировать дебаг-данные в файлы (Эти данные не будут отображены в дебаг-панели и будут записываться в файлы при хите):
Expand All @@ -56,10 +70,10 @@ DD()->successLog('Моя переменная', 'Моя переменная 2',
```php
<?php

$ggrachDebuggerConfigurator->setLogPath('error', __DIR__ . '/logs/error.log');
$ggrachDebuggerConfigurator->setLogPath('warning', __DIR__ . '/logs/warning.log');
$ggrachDebuggerConfigurator->setLogPath('success', __DIR__ . '/logs/success.log');
$ggrachDebuggerConfigurator->setLogPath('notice', __DIR__ . '/logs/notice.log');
$ggrachDebuggerConfigurator->setLogPath('error', $ggrachPathLogFolder . '/error.log')
->setLogPath('warning', $ggrachPathLogFolder . '/warning.log')
->setLogPath('success', $ggrachPathLogFolder . '/success.log')
->setLogPath('notice', $ggrachPathLogFolder . '/notice.log');
```

Если планируете использовать логирование в файлы без сервера (cli), то укажите ваш DOCUMENT_ROOT в папке initializers в файле cli.php
Expand All @@ -71,4 +85,4 @@ $ggrachDebuggerConfigurator->setLogPath('notice', __DIR__ . '/logs/notice.log');
Тестировалась скорость формирования страницы с библиотекой и без, при ее наличии скорость дольше примерно на 0,01 сек., что не значительно замедляет проект.

Дебаг-панель:
![Image alt](https://github.com/ggrachdev/BitrixDebugger/raw/master/assets/DebugBar/images/git/example_for_git.png)
![Image alt](https://github.com/ggrachdev/BitrixDebugger/raw/master/assets/images/git/example_for_git.png)

0 comments on commit 4af6de7

Please sign in to comment.