Шпаргалка по PHP: настройка Xdebug 3.x в PhpStorm через Docker для Laravel 11

1. 1.
   Клонировать проект из репозитория: https://github.com/ekangash/laravel-infrastructure
2. 2.
   Следуйте инструкциям, изложенным в файле README.md данного репозитория, чтобы подготовить проект к работе.

1. 1.
   Откройте настройки PhpStorm: Перейдите в меню File (Файл) -> Settings (Настройки).
2. 2.
   Найдите раздел Docker: В открывшемся окне настроек перейдите в раздел Build, Execution, Deployment (Сборка, Выполнение, Развертывание) -> Docker.
3. 3.
   Добавьте новое Docker-подключение: В левом верхнем углу окна настроек Docker нажмите на значок "+" (добавить). Это действие позволит создать новую конфигурацию подключения к Docker.
4. 4.
   Проверьте успешность подключения: После добавления новой конфигурации PhpStorm автоматически попытается установить соединение с Docker-контейнером, запущенным на вашем локальном хосте.
5. 5.
   Убедитесь в наличии сообщения об успехе: В нижней части вкладки "Docker" должно отобразиться зеленое сообщение "Connection successful" (Соединение установлено успешно). Это является подтверждением того, что PhpStorm успешно подключился к Docker, и дальнейшая работа будет стабильной.

Trigger zoom image

1. 1.
   Откройте настройки PHP-серверов: В главном меню PhpStorm перейдите в раздел File (Файл) -> Settings (Настройки) -> PHP -> Servers.
2. 2.
   Добавьте новый сервер: В открывшемся окне "Servers" нажмите кнопку "+" (Add insert) или значок плюса. Это действие создаст новую запись для вашего PHP-сервера.
3. 3.
   Укажите параметры сервера: В появившемся интерфейсе заполните следующие поля, основываясь на конфигурации вашего Docker-проекта:

   • •
     Name (Имя): Введите имя для вашего сервера.

Важно: Это имя должно совпадать со значением переменной окружения PHP_IDE_CONFIG, указанной в файле docker-compose.yaml для сервиса php-fpm. Для текущего репозитория это выглядит так: PHP_IDE_CONFIG: "serverName=${APP_NAME}".

• •
  Host (Хост): Укажите внешний хост вашего приложения, на котором оно доступно. В большинстве случаев для локальной разработки это значение будет localhost.
• •
  Port (Порт): Введите внешний порт, который вы пробросили (замаппили) для контейнера nginx в вашем файле docker-compose.yaml. Именно на этом порту ваше приложение доступно через браузер.
• •
  Use path mappings (Использовать сопоставление путей): Обязательно установите галочку напротив этой опции. Это позволит PhpStorm правильно сопоставлять локальные файлы проекта с файлами внутри Docker-контейнера.

1. 1.
   Настройте сопоставление путей (Path Mappings):

   • •
     В нижней части окна "Add New Server" добавьте новую запись в разделе "Path mappings".
   • •
     В поле "File/Directory" указан по умолчанию абсолютный путь к корневой директории вашего PHP-проекта на вашем локальном компьютере.
   • •
     В поле "Absolute path on the server" укажите абсолютный путь к корневой директории вашего приложения внутри Docker-контейнера. Для нашего проекта конфигураций это значение будет /var/www/.

1. 1.
   Перейдите в настройки PHP: В главном меню PhpStorm выберите File (Файл) -> Settings (Настройки) -> PHP.
2. 2.
   Укажите уровень языка PHP: В поле PHP language level выберите версию PHP, которая используется в вашем контейнере php-fpm в Docker.
3. 3.
   Настройте CLI Interpreter: Напротив поля CLI Interpreter, нажмите на кнопку с тремя точками (...). Откроется окно PHP Interpreters.
4. 4.
   Добавьте новый интерпретатор: В окне PHP Interpreters нажмите на значок "+" (добавить новый интерпретатор), расположенный в левом верхнем углу.
5. 5.
   В появившемся меню выберите опцию Docker Compose. Откроется следующее окно с настройками Docker:

Trigger zoom image

1. 1.
   Выберите способ подключения к Docker в зависимости от вашей операционной системы:

   • •
     Для Linux:

     • •
       Выберите Docker Compose.
     • •
       В разделе Server нажмите кнопку New и оставьте параметры подключения Docker по умолчанию (если вы еще не настраивали подключение на предыдущих шагах).
     • •
       В поле Service выберите имя вашего сервиса php-fpm из файла docker-compose.yaml.
   • •
     Для Windows:

     • •
       Выберите Docker.
     • •
       В разделе Server нажмите кнопку New и оставьте параметры подключения Docker по умолчанию.
     • •
       В поле PHP executable выберите ваш сервис php-fpm, возможно, с указанием тега :latest (например, your-php-fpm-docker-server-name:latest).
2. 2.
   Проверьте версию PHP и Xdebug: После выбора сервиса Docker PhpStorm должен автоматически определить версию PHP и наличие установленного расширения Xdebug внутри вашего контейнера. Убедитесь, что отображаемая информация корректна.

   

   Trigger zoom image

3. 3.
   Настройте сопоставление путей (Path Mappings) для CLI Interpreter: Выберите добавленный CLI Interpreter и перейдите на вкладку Path mappings. Укажите соответствие между локальным путем к файлам вашего проекта на компьютере и абсолютным путем к этим же файлам **внутри контейнера **php-fpm. Этот путь должен совпадать с настройками volumes в вашем файле docker-compose.yaml.

   

   Trigger zoom image

1. 1.
   Поставьте специальную метку (точку остановки) в самом начале вашего приложения (например, в файле index.php или bootstrap/app.php, если у вас Laravel).
2. 2.
   Потом запустите отладку в PhpStorm и откройте свою страницу в браузере. Если все правильно, программа остановится там, где вы поставили метку, а в PhpStorm появится окошко отладки.