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

Commit 4af6de7

Browse files
authored
Update README.md
1 parent 41b804d commit 4af6de7

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,17 @@ BitrixDebugger - библиотека для дебага в 1с битрикс,
88

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

11-
Как пользоваться?
11+
Способы установки
1212
--------------------------
13-
Зайдите в Вашу папку php_interface где лежит так же файл init.php и введите команду (либо скачайте архив с данного репозитория):
13+
1) Скопируйте папку ggrachdev.debugbar из папки module и положите в /bitrix/modules и выполните стандартную установку и подключите модуль в init.php:
14+
```php
15+
<?php
16+
17+
\Bitrix\Main\Loader::includeModule('ggrachdev.debugbar');
18+
```
19+
Теперь вам будут доступны все нижеописанные функции для дебага данных.
20+
21+
2) Зайдите в Вашу папку php_interface где лежит так же файл init.php и введите команду (либо скачайте архив с данного репозитория):
1422

1523
```console
1624
$ git clone https://github.com/ggrachdev/BitrixDebugger
@@ -40,6 +48,12 @@ DD()->success('Моя переменная', 'Моя переменная 2', '
4048
1,2,3
4149
]
4250
]]);
51+
52+
// Можно осуществлять цепочку вызовов
53+
DD()->notice('Моя переменная', 'Моя переменная 2')->error(/*...*/)->notice(/*...*/)->...;
54+
55+
// Можно дебажить без вызова notice явно (просто передав параметры в DD() - идентично notice):
56+
DD('Моя переменная', 'Моя переменная 2')->error(/*...*/)->...;
4357
```
4458

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

59-
$ggrachDebuggerConfigurator->setLogPath('error', __DIR__ . '/logs/error.log');
60-
$ggrachDebuggerConfigurator->setLogPath('warning', __DIR__ . '/logs/warning.log');
61-
$ggrachDebuggerConfigurator->setLogPath('success', __DIR__ . '/logs/success.log');
62-
$ggrachDebuggerConfigurator->setLogPath('notice', __DIR__ . '/logs/notice.log');
73+
$ggrachDebuggerConfigurator->setLogPath('error', $ggrachPathLogFolder . '/error.log')
74+
->setLogPath('warning', $ggrachPathLogFolder . '/warning.log')
75+
->setLogPath('success', $ggrachPathLogFolder . '/success.log')
76+
->setLogPath('notice', $ggrachPathLogFolder . '/notice.log');
6377
```
6478

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

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

0 commit comments

Comments
 (0)