Debugging with a PHP Web Application Debug Configuration
In this debugging mode, PhpStorm fully controls the debugging process: it launches the application, opens the browser, and activates the debugging engine according to a PHP Web Application debug configuration.
A PHP Web Application debug configuration tells PhpStorm where the PHP application to debug is deployed, the URL address to access the starting page of the application, the browser to open the starting page in, and the correspondence between files and folders deployed on the server and their local copies (mappings).
Mappings are necessary for the following reason. During the debugging session on the local or remote server, the server side of the debugger tells PhpStorm the name of the currently processed file and the number of the line to be processed. PhpStorm opens the local copy of this file and indicates the line with the provided number. This behaviour is enabled by specifying correspondence between files and folders on the server and their local copies. This correspondence is called mapping.
You can also specify the scripts requests to which you want PhpStorm to ignore during debugging.
This approach can be useful, when your application contains scripts that use AJAX. Suppose you have a
menu-ajax-script.php that "reloads" a part of your web page.
This script works properly so you do not need to debug it. However, this script is still requested during the debugging session. To have incoming connections to this script ignored,
menu-ajax-script.php script to the skipped paths list. You can also group such scripts into folders and add these folders to the "ignore list".
On this page:
- Preparing the debugging engine
- Setting the breakpoints
- Creating a PHP Web Application debug configuration
- Defining a debug server configuration
- Initiating a debugging session and examining the suspended program
- Specifying scripts to skip requests to
Preparing the debugging engine
Before you start debugging, make sure that you have a debugging engine installed and configured properly. PhpStorm supports debugging with two most popular tools:
Xdebug and Zend Debugger.
These tools cannot be used simultaneously because they block each other. To avoid this problem, you need to update the corresponding sections in the
file. To find out which
php.ini file is active, create and run a test file with
then search for the Loaded Configuration File.
For more information on configuring debugging engines, see Configuring XDebug, Configuring Zend Debugger, http://confluence.jetbrains.com/display/PhpStorm/Xdebug+Installation+Guide, and http://confluence.jetbrains.com/display/PhpStorm/Zend+Debugger+Installation+Guide.
Setting the breakpoints
Place the caret on the desired line of the source code.
Breakpoints can be set in the PHP context inside
*.html, and files of other types. Only executable lines are valid locations for line breakpoints. Comments, declarations, and empty lines are not valid locations for the
Do one of the following:
- Click the left gutter area at a line where you want to toggle a breakpoint.
- On the main menu, choose Run | Toggle Line Breakpoint .
- Press Ctrl+F8.
Creating a PHP Web Application debug configuration
Open the Run/Debug Configuration dialog box by doing one of the following:
- On the main menu, choose Run | Edit Configurations .
- Press Shift+Alt+F10, then press 0 to display the Edit Configuration dialog box or select the configuration from the pop-up window and press F4.
- Click on the toolbar or press Insert. From the drop-down list, select the PHP Web Application configuration type. The PHP Web Application dialog box opens.
- Specify the configuration name.
- Choose the applicable debug server configuration from the Server drop-down list or click the Browse button and define a debug server configuration in the Servers dialog box that opens.
- In the Start URL text pox, type the server path to the file that implements the application starting page. Specify the path relative to the server configuration root. The read-only field below shows the URL address of the application starting page. The URL address is composed dynamically as you type.
- Specify the browser to open the application in. Choose a configured browser from the Browser drop-down list or click the Browse button and specify another browser in the Web Browsers dialog box that opens.
- To have the debugging engine stop as soon as connection between it and PhpStorm is established (instead of running automatically until the first breakpoint is reached), select Stop at first line check box.
Defining a debug server configuration
Open the Servers dialog box by doing one of the following:
- Choose File | Settings for Windows and Linux or PhpStorm | Preferences for OS X. Then click Servers under the PHP node.
- In the Run/Debug Configuration: PHP Web Application dialog box, click the Browse button next to the Server drop-down list.
- Specify the server configuration name.
- Specify the host where the application is run and the port to access it.
- From the Debugger drop-down list, choose the debugging engine to use.
Specify how the PhpStorm will set up a correspondence between files on the server and their local copies. Based on these mappings,
PhpStorm will open local copies of currently processed files.
- To have PhpStorm suggest mappings itself, clear the Use path mappings check box. When you start a debugging session, PhpStorm will try to detect the local copies of the application files on the server. The suggestions are displayed in a dialog box where PhpStorm asks you to confirm or edit suggested mappings.
- To specify correspondence between files on the server and their local copies manually, select the Use path mappings check box and map files and folders on the server to their local copies.
Initiating a debugging session and examining the suspended program
- To start debugging, click the Debug button on the toolbar.
- As soon as the debugger suspends on reaching the first breakpoint, examine the application by analyzing frames. A frame corresponds to an active method or function call and stores the local variables of the called method or function, the arguments to it, and the code context that enables expression evaluation. All currently active frames are displayed on the Frames pane of the Debug tool window. where you can switch between them and analyze the information stored therein in the Variables and Watches panes. For more details, see the section Examining Suspended Program.
Continue running the program and examine its frames as soon it is suspended.
- To control the program execution manually, step through the code using the commands under the Run menu or toolbar buttons: Step Into (F7), Step Out (Shift+F8), Step Over (F8), and others. For more details, see Stepping Through the Program.
- To have the program run automatically up to the next breakpoint, resume the session by choosing Run | Resume Program or pressing F9
Specifying scripts to skip requests to
- Open the Settings dialog box, click Debug under the PHP node, then click Skipped Paths.
On the Skipped Paths page that opens, configure an "ignore list" of scripts and folders with scripts not to be invoked if PhpStorm receives incoming connections to them.
- To add a new entry to the list, click the Add button or press Alt+Insert. Then click the Browse button and in the dialog box that opens choose the file or folder to skip connections to.
- To remove an entry from the list, select it and click the Remove button or press Alt+Delete. The script will be now executed upon receiving requests to it.
- To have PhpStorm inform you every time it receives a request to a script to be skipped, select the Notify about skipped paths check box.