Xdebug

На этой странице

• Общие данные
• Настройка для windows

---

Общие данные

В проекте установлен Xdebug. Но потребуется настроить его конфиг и php-storm.
Файл конфига: config/php/99-xdebug.ini
Параметр xdebug.log в конфиге логирует работу xdebug в директорию site. Логи не мешают работе отладчика и могут помочь при настройке.

Ниже приводятся основные шаги по настройке для Windows, когда докер установлен в дистрибутиве linux на WSL2.

Для сред, отличных от Windows, шаги по настройке должны быть проще, но будут отличаться от указанных здесь. Используйте поиск в интернете. Начните со следующих сссылок:

• https://habr.com/ru/articles/834922/
• https://gitlab.com/bitrix-docker/server#xdebug

Настройка для windows

1. В корне проекта выполните команду

   ip route show | grep -i default | awk '{ print $3 }'
   

2. Откройте файл config/php/99-xdebug.ini. Введите полученный выше ip-адрес в значение параметра xdebug.client_host
   Например: xdebug.client_host=154.25.98.2

3. Для параметра xdebug.mode установите значение debug
   Итоговый конфиг выглядит так

   

4. Установите расширение браузера

5. Откройте статью. Перейдите к разделу “Настраиваем PhpStorm” и выполните указанные в нем шаги. Обратите внимание на некоторые отличия:

   • на одном из шагов потребуется установить маппинг.
     Введите значения как на скрине:

     
   • не спользуйте php-storm для добавления переменной PHP_IDE_CONFIG. Вместо этого добавьте переменную PHP_IDE_CONFIG в файл site/.env
     Файл с добавленной переменной

     
   • в статье контейнер запускается из IDE (зеленые стрелочки). Не повторяйте такой запуск, вместо этого используйте команду перезапуска контейнеров

     docker compose up -d
     

6. В соответствии со статьей убедитесь, что отладка работает. Далее дополнительно можно продолжить настройку для отказа от переменной PHP_IDE_CONFIG (см. радел Бонусные материалы)