You are here:Home»KB»Web Server»xampp»Debugging with Netbeans, Xdebug and Xampp in Windows
Tuesday, 12 December 2017 13:23

Debugging with Netbeans, Xdebug and Xampp in Windows

Written by

Getting Xdebug, Xampp and Netbeans to work together in Windows can be a tricky thing and I want to address that here. These instructions will get debugging working all on the same PC and IP.

A symptom of a PC that is not setup correctly is this Netbeans Socket Exception error. You get this error when Netbeans cannot communicate with Xdebug and is usually because you are running them both on the same computer and therefore IP so the traffic routing is getting mixed up. It could also because something else is running on the debug port you have selected.

Netbeans Socket Exception error

Tutorials

Troubleshooting

  • Truncated Values
    • debugging - Shortened value in Netbeans PHP debugger - Stack Overflow 
      xdebug.var_display_max_data=16384

// Source - https://stackoverflow.com/a/40608738
// Posted by matt
// Retrieved 2026-05-06, License - CC BY-SA 3.0

netbeans_default_options="-J-client -J-Xss2m -J-Xms32m -J-Dapple.laf.useScreenMenuBar=true -J-Dapple.awt.graphics.UseQuartz=true -J-Dsun.java2d.noddraw=true -J-Dsun.java2d.dpiaware=true -J-Dsun.zip.disableMemoryMapping=true -J-Dnb.php.debugger.full.values=true"
    • php - How to view value of long strings using NetBeans and x-debug? - Stack Overflow 
      • For this goto to Options -> PHP -> Debugging tab in netbeans and set Maximum Data Length to a large number like 100000 (I think -1 should also work here).
      • Setting xdebug.var_display_max_data to -1 seems to have fixed the problem. Hope this helps someone else.

These Settings Work

These settings are what I am using now and work well.

Windows

  • You need to set a static IP on your ethernet adapter (or wifi)

php.ini

    • Use your static IP to set xdebug.remote_host. Setting a static IP seems to fix most connecion issues. xdebug does not like 127.0.0.1 it works sometimes but can be problematic.
    • Swapping xdebug.remote_port to 9001 helped when xdebug just stopped working. The default is 9000.
    • Disable output_buffering in your php.ini by altering/uncommenting the following line 
      output_buffering = Off
    • Add the following code to the end of your php.ini file. 
      [XDebug]

zend_extension="D:\websites\php\ext\php_xdebug.dll"
;zend_extension="D:\websites\php\ext\php_xdebug-2.5.4-5.6-vc11.dll"
xdebug.idekey = netbeans-xdebug
xdebug.profiler_append = 0
xdebug.profiler_enable = 0
xdebug.profiler_enable_trigger = 0
xdebug.profiler_output_dir = "d:\websites\tmp\xdebug"
xdebug.profiler_output_name = "cachegrind.out.%t-%s"
xdebug.remote_enable = 1
xdebug.remote_autostart = 0
xdebug.remote_connect_back = 0
xdebug.remote_host = "192.168.1.160"
xdebug.remote_port = 9001
xdebug.remote_handler = "dbgp"
xdebug.remote_mode = req
xdebug.remote_log = "d:\websites\tmp\xdebug\xdebug_remote.log"
xdebug.show_local_vars = 9
xdebug.trace_output_dir = "d:\websites\tmp"

;xdebug.show_exception_trace = 1

      Minimum working settings

      These are the minimum settings I have found to work but are here only for reference.

      [XDebug]

;zend_extension="D:\websites\php\ext\php_xdebug.dll"
zend_extension="D:\websites\php\ext\php_xdebug-2.5.4-5.6-vc11.dll"
xdebug.remote_enable=1
xdebug.remote_handler=dbgp
xdebug.remote_mode=req
xdebug.remote_host=192.168.1.160
xdebug.remote_port=9001
xdebug.idekey=netbeans-xdebug

Netbeans

(Tools --> Options --> PHP --> Debugging)

  • Debugger Port: 9001
  • Session ID: netbeans-xdebug
  • Maximum Data Length: 2048 - I think this is the default
  • Stop at First Line: off
  • Watches and Balloon Evaluation: All off
  • Show Requested URLs: off
  • Show Debugger Console: On

Browser

You need to send a trigger to Xdebug via your browser to trigger the debugger. You can send the trigger via GET/POST but you need a plugin for this.

Getting debugger to work

  • Project Properties --> Run Configuration --> Advanced --> Do Not Open Web Browser (not needed to enable debugging but it prevent the browser opening everytime you start debug)
  • Project Properties --> Run Configuration --> Advanced --> Path Mapping (not sure what this does, but if debugging does not work then this needs adding) 
    ### Example
Server Path: D:\websites\htdocs\platforms\Joomla4
Project Path: D:\websites\htdocs\platforms\Joomla4
  • use a browser extension to add the required POST variable. Adding GET variable is messy. (you can use special xdebug calls in your code, see xdebug website for details)
  • the xdebug settings in the php.ini file
  • use your real local IP i.e. 192.168.1.15 , NOT `localhost` or 127.0.0.1 - these do not always route correctly on my Windows 10 PC with Xampp
    {add my example ini file}

Test Debugger is working

Now you have configured your system as above you need to test it before you can rely on it.

  • Set a breakpoint in Netbeans on the index.php (or a PHP file that is parsed) in your software project, preferably one before the content is displayed. (or you can enable the ‘Stop at First Line’ option in the Netbeans config
  • Start debugging in Netbeans
  • Open your project in a chrome browser with the xdebug helper plugin enabled
  • If the browser and Netbeans stop at the breakpoint, everything is working

Diagnostics / Troubleshooting

If xdebug will not stop at breakpoints, try 

  • try putting breakpoints on different items. Xdebug might not always be able to stop on certain items. Add them in your self if needed ie $chimp = 13;
  • a different version of xdebug DLL, (ie different VC).
  • debugging some other code. i.e. QWcrm works but Joomla did not. I then retried joomla and debugging joomla worked (however i did it after doing the item below)
  • remove all other xdebug entry defintions in php.ini so you just have the one in that you think should work, save, restart and retry.

Things that Might help

If xdebug does not work straight away then trying these things might help.

  • could disabling ipv6 in the network adapter help? because xampp has issues with ipv6
  • xdebug might fail if you have multiple version of xampp running
  • Localhost is mapping to ::1 and not 127.0.0.1
  • Not all lines can act as breakpoints, these are displayed as cracked breakpoint markers in Netbeans. These breakpoints will not work because Netbeans does not like them. To fix this yoou should choose another breakpoint.
  • Run the Xdebug on another server which has another IP
  • Get the latest dll from xdebug site (i.e. php_xdebug-2.5.4-5.6-vc11.dll)
  • Comment out any zend extensions
  • Some people use port 9001 when they have issues with 9000.

Test the port is not already in use - dbgtest.php

This code is taken from 21.4.2 How to Set Up XDebug | Oracle

<?php
$address = '127.0.0.1';
$port = '9000';
$sock = socket_create(AF_INET, SOCK_STREAM, 0);
socket_bind($sock, $address, $port) or die();
socket_listen($sock);
$client = socket_accept($sock);
echo "Connection established: $client";
socket_close($client);
socket_close($sock);
?>

However I found this slightly better version from dbgtest.php · GitHub

<?php
// adapted from https://blogs.oracle.com/netbeansphp/entry/howto_check_xdebug_installation
$address = $argv[1] ?: '127.0.0.1';
$port = '9000';
$sock = socket_create(AF_INET, SOCK_STREAM, 0);
socket_bind($sock, $address, $port) or die();
echo "Listening to $address:$port\n";
socket_listen($sock);
$client = socket_accept($sock);
echo "Connection established: $client\n";
socket_close($client);
socket_close($sock);
  1. Create a php file with the code above called dbgtest.php and put it in the htdocs folder of your xampp server
  2. Change the port to 9001 if that is the port number you are using/diagnosing
  3. Enable sockets - extension=php_sockets.dll
    • only be need for the test script
    • You enable this by uncommenting the appropriate line in the php.ini
    • if you do not enable this you will get this error 
      Call to undefined function socket_create()
  4. Close Netbeans if that is running.
  5. Restart Xampp
  6. Run the script

If there is something running on this socket you will get an error as shown below. This shows that some other process is using the port 9000.

Warning: socket_bind(): unable to bind address [10048]: Only one usage of each socket address (protocol/network address/port) is normally permitted. in D:\websites\htdocs\dbgtest.php on line 5

Workarounds

These are a few workarounds I tried and might work for you. These are not designed to be a permanent fix.

Method 1

  • Make sure netbeans and xampp are not running
  • Put the basic xdebug settings in php.ini
  • Enable extension=php_sockets.dll in php.ini
  • Run xampp
  • Put a copy of the oracle script in your Webroot and run it. This causes xampp to open socket on 9000
  • Now open and run NetBeans debugging

* I am not sure if you need to do the IP fix aswell for this to work. It is all caused by routing issues on the loopback system of the PC. Or sockets might be needed.

Method 2

  • Turn of netbeans debugging (leave netbeans open)
  • Run the dbgtest.php to allow xampp/xdebug to grab the port
  • Now start netbeans debugging

Method 3 - (if working and then stops for no reason)

  • Close Netbeans, Xampp and browsers
  • Restart them all

 

Clickable Links for Xdebug Trace Errors

This is so when you get parsing errors and Xdebug shows those errors in the browser, you can click on the link to open up Netbeans at the appropriate file and line number.

Files

These files are required to make this function work.

netbeans.bat

:: Useful Sites
:: https://quantumwarp.com/kb/articles/72-xampp/928-debugging-with-netbeans-xdebug-and-xampp-in-windows
:: https://xdebug.org/docs/all_settings#file_link_format

:: Disable onscreen text
@echo off

:: This allows variable replacements
:: Cause each variable to be expanded at execution time rather than at parse time.
:: https://quantumwarp.com/kb/articles/10-windows-family/988-replace-a-text-string-in-a-windows-batch-file
:: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/setlocal
setlocal EnableExtensions EnableDelayedExpansion

:: Replace netbeans:// with the full program path
set NETBEANS=%1

:: This holds the open command defined in xdebug/xampp
set FILE=%~2

:: Convert '%5C' --> '\'
:: This requires EnableDelayedExpansion
:: We use the !! because of the % special character
:: Cycles once but does not parse variables and only removes one of the percent signs
:: You can use ENDLOCAL to stop this looping, but we dont need to
SET FILE=!FILE:%%5C=\!

:: the ~19 appends the page number on. This just assumes there are 18 or less other variables
%NETBEANS% --nosplash --console suppress --open "%FILE:~19%"

:: `nircmd` is a utility that does various computer related commands
:: nircmd win activate process netbeans.exe

:: Dont Close the Window after running - useful for debugging
:: cmd /k
  • This batch file accepts the link from the stack traces and parses the variables.

netbeans_protocol.reg

Windows Registry Editor Version 5.00

[HKEY_CLASSES_ROOT\netbeans]
"URL Protocol"=""
@="URL:Netbeans Protocol"

[HKEY_CLASSES_ROOT\netbeans\DefaultIcon]
@="\"C:\\Program Files\\NetBeans-12.6\\netbeans\\bin\\netbeans64.exe,1\""

[HKEY_CLASSES_ROOT\netbeans\shell]

[HKEY_CLASSES_ROOT\netbeans\shell\open]

[HKEY_CLASSES_ROOT\netbeans\shell\open\command]
@="\"C:\\Windows\\netbeans.bat\" \"C:\\Program Files\\NetBeans-12.6\\netbeans\\bin\\netbeans64.exe\" \"%1\""
  • This registry file causes netbeans.bat to open Netbeans.
  • It configures the shell command and path to be run when netbeans.bat is executed.

Instructions

  1. Place the netbeans.bat batch file in C:\Windows
    • I put it here because I know this folder is in my PATH.
  2. Update the netbeans_protocol.reg to your current version of Netbeans and make sure you select the correct 32/64-bit executable. 
    ie: "C:\Program Files\NetBeans-12.6\netbeans\bin\netbeans64.exe"
  3. Run netbeans_protocol.reg to apply to the registry
  4. In php.ini, configure or set the following: xdebug.file_link_format = "netbeans://open/?f=%f:%l"
 

when xdebug wiil not debug inside a large file

  • Issue
    • xdebug is working but when you get to a large class, Xdebug stops and this is caused by Netbeans not opening a large file
    • Set a breakpoint just before it calls the class
    • an you can manually advanced into the class and when you do you get a warning from Netbeans that opening the file is so large it will cause stability issues
    • but you click yes and it is fine after clicking yes to open it.
  • Diagnostics
    • Once in the file, advance manually until you break it. This will help find what is causing the issue. You can also add breakpoints at various parts in the afflicted file to advnce quicker
  • Solutions
    1. Reduce your class size
    2. Find the setting in Netbeans where you can allow files over a certain size to open, make this bigger
      • If you couldn't reduce your class size try to add this in your \NetBeans\harness\etc\app.conf 
        default_options="-J-Xms24m -J-Xmx1024m"
      • I have increased the -J-Xmx memory parameter to 1G both in netbeans.config as well as in the project properties file.
    3. Pre open the file
    4. Start Netbeans with command line switches that allow larger files

 Links

File too big warning

  • Background
    • Bug 98701 - Allow to open very big files? | ASF Bugzilla
      • 'The user can choose' to ignore the warning and open the document in Full editor mode at their own risk (Thankfully we can already achieve this by setting a system property '-J-Dorg.openide.text.big.file.size=25', Personally I currently use 25mb to reduce the occurrence of this issue).
  • Cause
    • The 'big file size' is hardcoded in netbeans to 1MB.
    • This is handled in the file D:\netbeans-master\platform\openide.loaders\src\org\openide\text\DataEditorSupport.java : Line 849 - 870
  • Solution
    • it is now possible to override this size with the option "org.openide.text.big.file.size". This is an integer and is MB.
    • '-J-Dorg.openide.text.big.file.size=5' --> will set the large file size to 5MB - This is a system property. should not matter beginning or end, but does work at end
    • add this to C:\Program Files\NetBeans-11.1\netbeans\etc\netbeans.conf (this will affect all projects)
  • Additional
    • warnedFiles - Holds the files the user has already accepted, where is this list? add this to my article, someone might answer. i cant.
    • is it stored in the project but as a binary thing, maybw a hash
    • 1,029KB is the size of the mpdf.php file

XDebug session stuck on curl_exec call

Links

Read 6541 times Last modified on Wednesday, 06 May 2026 16:32
Published in xampp
back to top