Настройка отладки php-кода при помощи Xdebug

Зайдите в панель управления хостингом в раздел «Домены» и переключите php в режим CGI при помощи панели, расположенной справа от названия Вашего сайта. Необходимо выбрать «Стандартный режим».

Дальше нужно добавить следующие опции (сначала идёт название, через тире - значение):

1. zend_extension - /usr/local/php-profilers/xdebug/php-version/xdebug.so
   Пропишите версию php, которую Вы используете в данный момент. Вот возможные пути:
   • /usr/local/php-profilers/xdebug/php-5.2/xdebug.so
   • /usr/local/php-profilers/xdebug/php-5.3/xdebug.so
   • /usr/local/php-profilers/xdebug/php-5.4/xdebug.so
   • /usr/local/php-profilers/xdebug/php-5.5/xdebug.so
   • /usr/local/php-profilers/xdebug/php-5.6/xdebug.so
   • /usr/local/php-profilers/xdebug/php-7.0/xdebug.so
   • /usr/local/php-profilers/xdebug/php-7.1/xdebug.so
   • /usr/local/php-profilers/xdebug/php-7.2/xdebug.so
2. xdebug.profiler_enable - 1
3. xdebug.profiler_enable_trigger - 1
4. xdebug.remote_host - 127.0.0.1
5. xdebug.remote_port - 8015
   Вы можете прописать любой порт, только необходимо его запомнить для дальнейших настроек в IDE
6. xdebug.idekey - PHPSTORM, либо VSCODE (в зависимости от той, какую Вы планируете использовать)
7. xdebug.remote_enable - 1
8. xdebug.remote_handler - dbgp
9. xdebug.remote_mode - req
10. xdebug.remote_autostart - 1
11. xdebug.show_local_vars - 1
12. xdebug.overload_var_dump - 1
13. xdebug.max_nesting_level - 200
14. xdebug.extended_info - 1

Дальше нажмите Сохранить конфигурацию и подождите. Чтобы настройки подхватились необходимо около 5-10 минут.

Cоздайте 3 файла на сервере через файловый менеджер панели управления хостингом:

1. php.ini в любой удобной для Вас директории
2. .htaccess в папке /domain-name.ru/htdocs/www/, где domain-name.ru - имя Вашего домена
3. php.cgi в папке /domain-name.ru/htdocs/www/cgi-bin/, где domain-name.ru - имя Вашего домена

Добавьте в файл .htaccess содержимое:

Action php-cgi /cgi-bin/php.cgi
AddHandler php-cgi .php .php3 .phtml

Установите на файл php.cgi права 0755 (rwxr-xr-x) и пропишите в файле следующие директивы:

#!/bin/bash
/usr/local/php/php-version/bin/php-cgi -c /home/hostXXXXXX/путь/к/файлу/php.ini

php-version - версия php, которую Вы используете. Вот возможные пути:

/usr/local/php/php-5.2/bin/php-cgi
/usr/local/php/php-5.3/bin/php-cgi
/usr/local/php/php-5.4/bin/php-cgi
/usr/local/php/php-5.5/bin/php-cgi
/usr/local/php/php-5.6/bin/php-cgi
/usr/local/php/php-7.0/bin/php-cgi
/usr/local/php/php-7.1/bin/php-cgi
/usr/local/php/php-7.2/bin/php-cgi

Наполните файл php.ini следующим содержимым:

;xDebug Configuration starts
zend_extension = /usr/local/php-profilers/xdebug/php-version/xdebug.so
xdebug.profiler_enable = 1
xdebug.profiler_enable_trigger = 1
xdebug.remote_host = 127.0.0.1
xdebug.remote_enable = 1
xdebug.remote_connect_back = 1
xdebug.remote_autostart = 1
xdebug.show_local_vars = 1
xdebug.overload_var_dump = 1
xdebug.max_nesting_level = 200
xdebug.extended_info = 1
xdebug.idekey = IDE
xdebug.remote_port = 8015
xdebug.remote_handler = dbgp
xdebug.remote_mode = req
;xDebug Configuration ends

В примере выше мы прописали путь к файлу расширения Xdebug, который по умолчанию уже лежит в дирекитории /usr/local/php-profilers/xdebug/php-version/ (php-version - Вы прописываете версию php, с которой работаете, например, php-7.1)

Мы выбрали порт 8015 (remote_port) для примера. Вы можете использовать любой, только запомните его, так как он ещё понадобится.

Вначале необходимо сгенерировать пару ключей ssh в папке .ssh/ на локальной машине:

ssh-keygen -t rsa

Затем копируете содержимое файла id_rsa.pub (локальная машина) и, создав новый файл authorized_keys на сервере в директории /home/hostXXXXXXX/.ssh/ через файловый менеджер панели управления, сохраняете в нём данное содержимое.

После чего можно создать ssh-тунель командой на Linux и OS X:

ssh -R 8015:localhost:8015 hostXXXXXXX@servXX.hostland.ru -p1024

Для работы потребуется программа PuTTY - её можно скачать с официального сайта

После того как Вы её скачаете, из архива распакуйте папку PuTTY Portable, будем работать с ней. В папке PuTTY Portable найдите файл puttygen.exe и запустите его.

Тип ключа для генерации выберите SSH-2 RSA,
Длина генерируемого ключа(в битах) - 2048

Жмём Сгенерировать. Хаотично перемещайте курсор мыши внутри окна программы. Введите желаемый комментарий к созданным ключам, чтобы Вам было удобнее различать созданные ключевые пары в будущем.

Сохраните открытый и личный (закрытый) ключ, не перепутайте ключи в будущем. (Рекомендуем открытым ключам давать расширение .pub, а закрытым .ppk)

Не закрывая окно программы генерации ключей, скопируйте открытый ключ и, создав новый файл authorized_keys на сервере в директории /home/hostXXXXXXX/.ssh/ через файловый менеджер панели управления, сохраните в нём содержимое открытого ключа.

Перейдя во вкладку Connection → SSH → Auth → Credintials, в верхнем поле выберите созданный на прошлом шаге приватный ключ, как на скриншоте ниже:

Для настройки туннеля нужно указать имя сервера либо его IP (вкладка Session). Порт по умолчанию изменяем на 1024, протокол оставляем SSH и нажимаем Save:

Во вкладке Connection → Data вводим ваш логин (имя аккаунта hostXXXXXXX):

После этого нужно открыть вкладку Connection → SSH → Tunnels и настроить так, как указано на скриншоте:

Возвращаемся в раздел Session, нажимаем кнопку Open и на запрос Putty о корректности ключей (только при первом подключении), нужно ответить Да (Yes). Для дальнейшего использования настроек, просто открывайте Putty в меню сохраненных сессий и, выбрав нужную, нажимаете Load и наконец Open

IDE PHPStorm можно скачать с официального сайта.

Для начала, создайте новую пустую папку и откройте её в редакторе. Далее, заходим в настройки: File → Settings

1. Languages & Frameworks → PHP → Debug: Пропишем порт для соединения с сервером, который мы ранее указали в php.ini или прописали через панель управления. В нашем случае, это порт 8015

2. Languages & Frameworks → PHP → Debug → DBGp Proxy
   IDE key - PHPSTORM
   Host - название вашего домена (domain_name)
   Port - ещё раз укажем порт 8015

3. Languages & Frameworks → PHP → Servers
   Чтобы добавить соответствие путей на Вашем компьютере и удалённом сервере, нажмите значок "+" вверху слева Add(insert)
   Name - указываем рандомное имя, к примеру testdev.com
   Host - название вашего домена (domain_name)
   Post - 80
   Ставим галочку в чекбоксе Use path mappings и прописываем соответствие пути к только что созданной папке на локальной машине и абсолютного пути к рабочим файлам на сервере, к примеру:

4. Build, Execution, Deployment → Deployment
   В данном пункте настроим SFTP соединение с нашим сервером. Для этого также необходимо добавить новое соединение, нажав на значок "+" вверху слева и выбрать Type - SFTP, Name можно выбрать рандомный, к примеру xDebugTest
   SFTP host - указываем название вашего домена
   Port - 1024
   Root path - /home/hostXXXXXXX (номер Вашего аккаунта)
   User Name - вводим номер своего аккаунта hostXXXXXXX
   Auth type - выбираем Key pair (OpenSSH or PuTTY) из выпадающего списка
   Private key file - указываем путь до приватного ssh-ключа (id_rsa), предварительно скачанного с нашего сервера из папки /home/hostXXXXXXX/.ssh/
   Web server root URL - прописываем корневой URL к Вашему сайту
   Чтобы проверить, настроили ли Вы соединение правильно, нажмите на кнопку Test SFTP connection... В следующей вкладке Mappings укажем каталог, в котором будут располагаться файлы проекта локально и соответствующую директорию на сервере (можно пользоваться функцией обзора файловой системы):
5. Languages & Frameworks → PHP
   PHP language level - выбираем версию php, используемую Вами в проекте
   CLI Interpreter добавляем интерпретатор для обработки php-скриптов:
   Name - можно указать рандомное, к примеру Remote PHP
   Выбираем radio-button Deployment configuration и находим наше новое SFTP-соединение
   В пункте PHP executable прописываем путь до исполняемого файла на сервере /home/hostXXXXXXX/domain_name/htdocs/www/sys-php-cgi/php_wrapper.cgi и нажимаем Apply

IDE VSCode можно скачать с официального сайта.

Нам понадобится скачать 2 расширения. Это можно сделать прямо из приложения:

1. Sync-Rsync (для упрощения работы с удалённым сервером)
   Его можно скачать, открыв в программе VSCode панель Расширения и набрав в поисковой строке sync-rsync

2. PHP Debug, которое и будет "дебажить" наши php-скрипты

Далее, создаём пустую папку в любой удобной для Вас директории на локальной машине и открываем её в VSCode через верхнее меню: Файл → Открыть папку

Добавим в нее подпапку .vscode и создадим в ней новый файл settings.json, в котором пропишем настройки для расширения sync-rsync:

{
  "folders": [
    {
      "path": "/home/путь/до/локальной/папки"
    }
  ],
  "sync-rsync.onSaveIndividual": true,
  "sync-rsync.executableShell": "/bin/bash",
  "sync-rsync.shell": "ssh -p 1024 -i /home/user/.ssh/id_rsa",
  "sync-rsync.delete": true,
  "sync-rsync.sites": [
    {
      "localPath": "/home/путь/до/локальной/папки",
      "remotePath": "hostXXXXXXX@mysqlXX.hostland.ru:/home/hostXXXXXXX/domain_name.ru/htdocs/www/"
    }
  ]
}

/home/user/.ssh/id_rsa - это путь до сгенерированного на втором шаге закрытого ключа на локальной машине.

Сохраните файл, затем нажмите F1, введите в поисковую строку sync и выберите из выпадающего списка пункт Sync Remote to Local - это действие автоматически скопирует файлы с сервера в Вашу локальную папку:

После этого нажмите на значок отладки (1) и на иконку с маленькой шестеренкой (2):

В папке .vscode автоматически создастся файл launch.json, в которм нужно исправить и дописать следующее:

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Listen for XDebug",
      "type": "php",
      "request": "launch",
      "port": 8015,
      "pathMappings": {
        "/home/hostXXXXXXX/domain_name.ru/htdocs/www": "${workspaceRoot}/"
      }
    },
    {
      "name": "Launch currently open script",
      "type": "php",
      "request": "launch",
      "program": "${file}",
      "cwd": "${fileDirname}",
      "port": 8015
    }
  ]
}

Настройка VSCode завершена.

Для просмотра файлов Вашего домена выбираем в верхнем меню Tools → Deployment → Browse Remote Host

Найдём ранее созданный файл myFile.php и скачаем его к себе в локальную папку, нажав на файл правой кнопкой мыши и выбрав пункт Download from here

Открыв файл из локальной папки, дополним его содержимое следующим кодом (phpinfo() можно удалить):

$arr = array(1, 2, 3, 4, 5, 6);
foreach ($arr as &$value) {
    $value = $value * 3;
    echo $value.'
';
}

Сохранив файл загрузим его обратно на сервер в уже изменённом виде: нажмите правой кнопкой на файл и выберите пункт Deployment → Upload to xDebugTest

Проверим, что содержимое изменилось, открыв сайт в браузере http://domain_name/myFile.php. Вы должны увидеть следующее:

3
6
9
12
15
18

Далее, убедившись, что ssh-тунель всё ещё открыт, ставим точку останова рядом со строкой "foreach ($arr as &$value) {" и нажимаем значок вверху справа для "прослушивания соединения" (Start Listening for PHP Debug Connections), перезагружаем страницу сайта.

Если всё было сделано правильно, Вы должны увидеть следующее:

Заменим содержимое файла myFile.php на следующее:

<?php
$arr = array(1, 2, 3, 4, 5, 6);
foreach ($arr as &$value) {
    $value = $value * 3;
    echo $value.'
';
}
?>

Загрузим изменённый файл на сервер: нажмите F1 и введите в строке команду Sync-Rsync: Sync Local to Remote

Откроем файл в браузере на сервере и перед тем, как начать debug, ещё раз убедимся, что ssh-тунель между машинами открыт.

После этого в VScode расставим точки останова, просто нажав слева от тех строк, которые Вам необходимы. Ещё раз выберем режим Отладка, убедимся, что выделен пункт Listen for XDebug и нажмём значок зелёного треугольника, либо кнопку F5 на клавиатуре.

Перезагрузив сайт в браузере, вернёмся в VSCode. Если всё было сделано верно, Вы должны увидеть глобальные переменные, их значения, а также иметь возможность перемещаться по коду и смотреть, как меняются значения переменных на каждом шаге: