Mamp Xdebug Phpstorm

Set PhpStorm to listen to Xdebug on port 9000 JetBrains, the maker of PhpStorm, has detailed instructions on configuring Xdebug in their IDE. There are a few places settings need to be set, so I defer to their help pages. Essentially, you want to set the Xdebug IDE port to 9000 and the IDE key to PHPSTORM. Verify that the page reflects the xdebug settings you entered in the xdebug.ini or php.ini file above. 4) Configure PHPStorm for debugging. Go to PHPStorm and open File Default Settings menu item. In the search field, enter 'xdebug'. Click on 'Languages & Frameworks' PHP Debug. Under Xdebug section, make sure that the port is 9000. Using PhpStorm, Xdebug, MAMP &.htaccess Follow. James Bredijk Created March 15, 2014 05:50. Hi, I'm new to PhpStorm and Xdebug, so please forgive what may be a simple question. I've been able to get PhpStorm and Xdebug to work, so I can debug my PHP. But I can't seem to get PhpStorm to load my.htaccess file before it starts the debug process. PHP and Xdebug (Notes on OS X, VVV and MAMP). GitHub Gist: instantly share code, notes, and snippets.

In a previous article, we looked at how to set up a development environment with Local by Flywheel and Visual Studio Code.

PhpStorm is another code editor that can be used instead of Visual Studio code, both editors are good, and I’d certainly recommend that you give both a try to see what you think.

In our post about Local and Visual Studio code, we looked at how to set-up a debug environment, so I thought I’d do the same for PhpStorm so you’re covered if you need to debug using either text editor.

There is a plug-in for Local by Flywheel that aims to simplify the process of setting up debugging in your dev environment, read on to find out how to set it up and what to do if the plugin does not work for you.

Adding the Debugging Plugin to Local by Flywheel

In Local by Flywheel, choose the extensions section

From there, choose the “Xdebug + PhpStorm”

From the extension screen click the “Install” button, then click “Enable and Restart” when prompted, you should now see a button has been added to the “Utilities” tab of the website properties window in Local.

Click this button, then open your website in PhpStorm using the “File” -> “Open Directory” option, you should choose the “app/public” folder of your website when prompted to choose a directory.

If everything has gone as planned, you should now see a “Local by Flywheel” option in the debug drop-down

select this option and then click the debug button.

Your website should now launch in your default browser and any breakpoints you have added will be hit

The Xdebug + PhpStorm Plugin is not Working/I Can’t See the “Local by Flywheel” Option

If you’re not seeing the “Local by Flywheel” option then something has gone wrong.

If the plugin has executed successfully then it should add two XML files to your website, the files should appear in the following locations –

<path to your website>apppublic.ideaphp.xml
<path to your website>apppublic.idearunConfigurationsLocal-By-Flywheel.xml

If those two files have not appeared in your website after clicking the “Configure Phpstorm and Intellij IDEs” then the plug-in has not executed as expected.

Fortunately, we are able to view and change the plug-in’s code. We can do this by selecting the “Show Folder” option from the installed plug-ins folder screen.

Once the folder has opened you need to find the “renderer.js” file on my box it was located in the “addonslocal-addon-xdebug-phpstormlib” folder. Once you’ve found the file open it in your favorite text editor.

Now the file is open we can begin to diagnose why the plug-in is not working as expected, on my Windows box it was this line that was causing the problem

On my Windows machine the “site.path” variable resolves to “~Local Siteswpbaseline” this prevents the first part of the replace from working and as the script uses the “sitePath” variable to create the xml files then they do not get created successfully.

I was able to fix the script by replacing the match for “~/” with a regex that matches either “~/” or “~”. So if you replace the line above with this line

then save the script and stop and restart Local by Flywheel, then hopefully, everything should start working as expected.

A similar fix is described in a GitHub issue here.

I Still Can’t Get The Functionality to Work After Changing the Script

Ok, there are two further options to get things working.

Manually Add the Files

If we add the files manually that the plug-in adds then we should be able to get everything working as expected. Firstly, we need to ceate a file named “php.xml” in this folder “<path to your local website>apppublic.idea”. The file should contain the following

You’ll need to change the following things

• The “host” value to the URL of your website
• The “id” value, from what I can tell this just needs to be unique to your machine, the plug-in populates it by generating a random number between 1 and 1 million. You could use a random number generator to generate the value.

Now we need to generate a file named “php.xml” in this folder “<path to your local website>apppublic.idea”. The file should contain text similar to the below

You should not need to make any changes to the text above.

The advantage of doing things this way is that once you have created the files you could save them to a Blueprint site as we did when setting up Local with Visual Studio Code.

You would then only need to make a couple of minor changes to the “php.xml” file to get debugging working n your new site.

Setting up Debugging in PhpStorm

We can also set-up debugging on a Flywheel website by using PhpStrom’s GUI interface, here’s how.

Go to “Run” -> “Edit Configurations”, you should see a screen similar to the one below

Click the green plus button, and add a new PHP WebPage

You should now see a dialog that looks similar to this

Click the “…” button next to the server drop down

From the server dialog screen add a new server and fill in the values as below

Click “OK” and then complete the remaining details as below

If you then click “OK” again you should be all set-up and ready to debug.

Download Xdebug

• Download the Xdebug extension compatible with your PHP version and install it as described in the installation guide.

  Xdebug 3 brings performance improvements, simplified configuration, and PHP 8 support. To learn more on upgrading to Xdebug 3, see the Upgrade guide.

  If you are using an AMP package, the Xdebug extension may be already installed. Refer to the instructions specific for your package.

Integrate Xdebug with the PHP interpreter

1. Open the active php.ini file in the editor:

   1. In the Settings/Preferences dialog Ctrl+Alt+S, click PHP.

   2. On the PHP page that opens, click next to the CLI Interpreter field.

   3. In the CLI Interpreters dialog that opens, the Configuration file read-only field shows the path to the active php.ini file. Click Open in Editor.

2. To disable the Zend Debugger and Zend Optimizer tools, which block Xdebug, remove or comment out the following lines in the php.ini file:

   zend_extension=<path_to_zend_debugger> zend_extension=<path_to_zend_optimizer>

3. To enable Xdebug, locate or create the [xdebug] section in the php.ini file and update it as follows:

   [xdebug] zend_extension='<path to xdebug extension>' xdebug.remote_enable=1 xdebug.remote_host=127.0.0.1 xdebug.remote_port='<the port (9000 by default) to which Xdebug connects>'

   [xdebug] zend_extension='<path to xdebug extension>' xdebug.mode=debug xdebug.client_host=127.0.0.1 xdebug.client_port='<the port (9003 by default) to which Xdebug connects>'

   In PHP 5.3 and later, you need to use only zend_extension, not zend_extension_ts, zend_extension_debug, or extension.

   To enable multi-user debugging via Xdebug proxies, locate the xdebug.idekey setting and assign it a value of your choice. This value will be used to register your IDE on Xdebug proxy servers.

4. Save and close the php.ini file.

5. Verify Xdebug installation by doing any of the following:

   • In the command line, run the following command:

     The output should list Xdebug among the installed extensions:

   • Create a php file containing the following code:

     <?php phpinfo();

     Open the file in the browser. The phpinfo output should contain the Xdebug section:

Configure Xdebug in PhpStorm

1. In the Settings/Preferences dialog Ctrl+Alt+S, select PHP.

2. Check the Xdebug installation associated with the selected PHP interpreter:

   1. On the PHP page, choose the relevant PHP installation from the CLI Interpreter list and click next to the field. The list shows all the PHP installations available in PhpStorm, see Configure local PHP interpreters and Configure remote PHP interpreters.

   2. The CLI Interpreters dialog that opens shows the following:

      • The version of the selected PHP installation.

      • The name and version of the debugging engine associated with the selected PHP installation (Xdebug or Zend Debugger). If no debugger is configured, PhpStorm shows the corresponding message:

   Alternatively, open the Installation Wizard, paste the output of the phpinfo(), and click Analyze my phpinfo() output. Learn more about checking the Xdebug installation in Validate the Configuration of a Debugging Engine.

3. Define the Xdebug behaviour. Click Debug under the PHP node. On the Debug page that opens, specify the following settings in the Xdebug area:

   • In the Debug port field, appoint the port through which the tool will communicate with PhpStorm.

     This must be the same port number as specified in the php.ini file:

     xdebug.remote_port='<the port (9000 by default) to which Xdebug connects>'

     xdebug.client_port='<the port (9003 by default) to which Xdebug connects>'

     By default, Xdebug 2 listens on port 9000. For Xdebug 3, the default port has changed from 9000 to 9003. You can specify several ports by separating them with a comma. By default, the Debug port value is set to 9001,9003 to have PhpStorm listen on both ports simultaneously.

   • To have PhpStorm accept any incoming connections from Xdebug engine through the port specified in the Debug port field, select the Can accept external connections checkbox.

   • Select the Force break at first line when no path mapping specified checkbox to have the debugger stop as soon as it reaches and opens a file that is not mapped to any file in the project on the Servers page. The debugger stops at the first line of this file and Examine/update variables shows the following error message: Cannot find a local copy of the file on server <path to the file on the server> and a link Click to set up mappings. Click the link to open the Resolve Path Mappings Problem dialog and map the problem file to its local copy.

     When this checkbox cleared, the debugger does not stop upon reaching and opening an unmapped file, the file is just processed, and no error messages are displayed.

   • Select the Force break at first line when a script is outside the project checkbox to have the debugger stop at the first line as soon as it reaches and opens a file outside the current project. With this checkbox cleared, the debugger continues upon opening a file outside the current project.

4. In the External connections area, specify how you want PhpStorm to treat connections received from hosts and through ports that are not registered as deployment server configurations.

   • Ignore external connections through unregistered server configurations: Select this checkbox to have PhpStorm ignore connections received from hosts and through ports that are not registered as deployment server configurations. When this checkbox is selected, PhpStorm does not attempt to create a deployment server configuration automatically.

   • Break at first line in PHP scripts: Select this checkbox to have the debugger stop as soon as connection between it and PhpStorm is established (instead of running automatically until the first breakpoint is reached). Alternatively turn on the Run | Break at first line in PHP scripts option from the main menu.

   • Max. simultaneous connections Use this spin box to limit the number of external connections that can be processed simultaneously.

By default, PhpStorm only listens for incoming IPv4 connections. To enable IPv6 support, you need to make adjustments in PhpStorm JVM options:

1. Select Help | Edit Custom VM Options from the main menu.

2. In the .vmoptions file that opens, delete the -Djava.net.preferIPv4Stack=true line.

3. Restart PhpStorm.

Configure Xdebug for using in the On-Demand mode

PhpStorm supports the On-Demand mode, where you can disable Xdebug for your global PHP installation and have it enabled automatically on demand only when you are debugging your command-line scripts or when you need code coverage reports. This lets your command line scripts (including Composer and unit tests) run much faster.

1. Disable Xdebug for command-line scripts:

   1. In the Settings/Preferences dialog Ctrl+Alt+S, go to PHP.

   2. From the PHP executable list, choose the relevant PHP interpreter and click next to it. In the CLI Interpreters dialog that opens, click the Open in Editor link next to the Configuration file: <path to php.ini> file. Close all the dialogs and switch to the tab where the php.ini file is opened.

   3. In the php.ini file, find the [xdebug] section and comment the following line in it by adding ; in preposition:

      ;[xdebug] ;zend_extension = '<path to xdebug extension>'

   4. Open the CLI Interpreters dialog and click next to the PHP executable field. PhpStorm informs you that debugger is not installed:

2. To enable PhpStorm to activate Xdebug when it is necessary, specify the path to it in the Debugger extension field, in the Additional area. Type the path manually or click and select the location in the dialog that opens.

Configure Xdebug for using in the Just-In-Time mode

PhpStorm supports the use of Xdebug in the Just-In-Time (JIT) mode so it is not attached to your code all the time but connects to PhpStorm only when an error occurs or an exception is thrown. Depending on the Xdebug version used, this operation mode is toggled through the following settings:

• Xdebug 2 uses the xdebug .remote_mode setting, which has to be set to jit.

• Xdebug 3 uses the xdebug.start_upon_error setting, which has to be set to yes.

The mode is available both for debugging command-line scripts and for web server debugging.

Depending on whether you are going to debug command-line scripts or use a Web server, use one of the scenarios below.

Command-line scripts

For debugging command-line scripts, specify the custom -dxdebug.remote_mode=jit (for Xdebug 2) or -dxdebug.start_upon_error=yes (for Xdebug 3) directive as an additional configuration option:

1. In the Settings/Preferences dialog Ctrl+Alt+S, navigate to PHP.

2. From the PHP executable list, choose the relevant PHP interpreter and click next to it.

3. In the CLI Interpreters dialog that opens, click next to the Configuration options field in the Additional area.

4. In the Configuration Options dialog that opens, click to add a new entry.

   • For Xdebug 2, type xdebug.remote_mode in the Configuration directive field and jit in the Value field.

   • For Xdebug 3, type xdebug.start_upon_error in the Configuration directive field and yes in the Value field.

   When you click OK, you return to the CLI Interpreters dialog where the Configuration options field shows -dxdebug.remote_mode=jit (for Xdebug 2) or -dxdebug.start_upon_error=yes (for Xdebug 3).

Web server debugging

Phpstorm Xdebug Vagrant

1. From the main menu, choose Run | Web Server Debug Validation.

2. In the Validate Remote Environment that opens, choose the Web server to validate the debugger on.

   • Choose Local Web Server or Shared Folder to check a debugger associated with a local Web server.

     • Path to Create Validation Script: In this field, specify the absolute path to the folder under the server document root where the validation script will be created. For Web servers of the type Inplace, the folder is under the project root.

       The folder must be accessible through http.

     • URL to Validation Script: In this field, type the URL address of the folder where the validation script will be created. If the project root is mapped to a folder accessible through http, you can specify the project root or any other folder under it.

   • Choose Remote Web Server to check a debugger associated with a remote server.

     • Path to Create Validation Script: In this field, specify the absolute path to the folder under the server document root where the validation script will be created. The folder must be accessible through http.

     • Deployment Server: In this field, specify the server access configuration of the type Local Server or Remote Server to access the target environment. For details, see Configure synchronization with a Web server.

       Choose a configuration from the list or click Browse in the Deployment dialog.

3. Click Validate to have PhpStorm create a validation script, deploy it to the target remote environment, and run it there.

4. Open the php.ini file which is reported as loaded and associated with Xdebug.

5. In the php.ini file, find the [xdebug] section.

   Change the value of the xdebug.remote_mode from the default req to jit.

   Change the value of the xdebug.start_upon_error from the default default to yes.

See also Just-In-Time debugging and PHP Exception Breakpoints with PhpStorm and Xdebug

Configure Xdebug running in a Docker container

To configure Xdebug running in a Docker container, provide the Xdebug-specific parameters in the Dockerfile, for example:

In this example, we're modifying /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini providing the remote_enable and remote_host Xdebug parameters.

Note that the xdebug.remote_host value should be replaced with the IP address of the machine where PhpStorm is running, which is accessible from the Docker container. If you are using Docker for Windows or Docker for Mac, you can set xdebug.remote_host to host.docker.internal, which automatically resolves to the internal address of the host, letting you easily connect to it from the container.

Xdebug Phpstorm Cli

In this example, we're modifying /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini providing the mode and client_host Xdebug parameters.

Note that the xdebug.client_host value should be replaced with the IP address of the machine where PhpStorm is running, which is accessible from the Docker container. If you are using Docker for Windows or Docker for Mac, you can set xdebug.client_host to host.docker.internal, which automatically resolves to the internal address of the host, letting you easily connect to it from the container.

Configure Xdebug running on a Vagrant instance

To configure Xdebug running on a Vagrant instance, connect to the Vagrant machine and provide the Xdebug-specific parameters in the php.ini file:

Phpstorm Setup Xdebug

Note that the xdebug.remote_host value is 10.0.2.2. This is the gateway used in the default Vagrant setup, which allows connecting from the instance to host where PhpStorm is running.

Php Docker Xdebug Phpstorm

Note that the xdebug.client_host value is 10.0.2.2. This is the gateway used in the default Vagrant setup, which allows connecting from the instance to host where PhpStorm is running.