itrukhin/bxkint

Permanent Kint debug info for admin user in 1C-Bitrix

dev-master 2023-03-28 06:29 UTC

This package is auto-updated.

Last update: 2024-05-28 09:07:28 UTC


README

Scrutinizer Code Quality Build Status Code Intelligence Status

В сложных информационных системах зачастую необходима одна и та же отладочная информация для анализа и поиска ошибок. Причем эта информация нужна на продакшене, с актуальной базы. Чтобы она всегда была под рукой - сделал небольшую библиотеку, в основе которой лежит популярный и удобный отладчик Kint. Установив это расширение вы получаете как возможность стандартного использования отладчика Kint так и возможность добавлять в код вывод информации, видимой только для администратора и пользователей панели управления.

Установка

composer require itrukhin/bxkint:dev-master

Принцип работы

Расширение работает через обработчики событий 1С-Битрикс. Чтобы включить вывод отладочной информации, на административную панель добавлена кнопка-триггер, включающая и выключающая отладку.
Кнопка на панели Кнопка доступна на панели Битрикс, по умолчанию выключена. Состояние кнопки хранится в сессии.

В файл init.php добавляем инициализацию расширения (предполагается, что у вас Битрикс уже умеет работать с автозагрузкой composer)

\App\BxKint::init();

В необходимых участках кода вызывается метод добавления отладочной информации:

\App\BxKint::info(['name' => $value]);

Я, обычно, добавляю информацию как массив - тогда в отладчике автоматически появляется название 'name'. Но можно передавать и просто переменную.

Количество вызовов добавления информации в коде не ограничено. Все переменные собираются в один глобавльный массив $BX_KINT_INFO, который и выводится на эпилоге.

Включив отладку вы увидите стандартный вывод типа: Пример отладки