The following assumes that you are using ApiOpenStudio Docker Dev.
¶ Enable xDebug in your docker image
The dockerfile is configured toi create a build from php:n.n-fpm, and you can enable the build to include the xDebug packages using a simple environment variable,
Turn on Xdebug in .env in your checkout of ApiOpenStudio Docker Dev:
WITH_XDEBUG=true
Rebuild your docker containers
$ docker-compose build
Or
$ docker-compose up -d --build
¶ PHPStorm configurations
¶ PHP language level and CLI interpreter
If this is the first time that xDebug has been set up in your PHPStorm, you need to set up the PHP interpreters.
-
Ensure that your docker instance is running, so that PHPStorm can detect the
apiopenstudio-phpcontainer. -
Click on Preferences -> PHP.
-
Select the
PHP language level- this should be the same as the PHP version in your docker setup.
-
In the CLI interpreter, click on the
.... -
In the
CLI Interpretersmodal that pops up, click on the+to add a new interpreter and selectFrom Docker, Vagrant, VM, WSL, Remote....
-
In the new popup:
- Select
Docker. - Image name:
apiopenstudio_docker_dev_php. - Leave the
PHP interpreter pathasphp. - Click on
ApplyandOK.
- Select
¶ Set the port
In PhpStorm, go to PhpStorm -> Preferences -> PHP -> Debug.
¶ Configure a server.
This is how PHPStorm will map the local file paths to the ones in your container.
Go to File -> Settings -> PHP -> Servers
Give a name to the server. It should be a recognisable name, so you can identify it later, i.e. apiopenstudio.
Ensure you have "Use path mappings" checked, and edit the RHS to /var/www/html/api.
Click Apply to save your configurations.
¶ Configuring xDebug for ApiOpenStudio Admin
Depending on how you have set up your projects, and you have admin in a separate project, you will also need to set up servers as above, for your admin project.
The remote path mapping will be /var/www/html/admin.