Configuring Xdebug for PHP development/Windows: Difference between revisions

From Joomla! Documentation

< Configuring Xdebug for PHP development
← Older edit
Tom Hutchison (talk | contribs)
Email Confirmed
13,131 edits
m update
Cmb (talk | contribs)
956 edits
URL corrections. Other text editing.
 
Line 1: Line 1:
{{incomplete}}
{{incomplete}}
Configuring Xdebug is split into two parts:
Configuring XDebug is split into two parts: Server-side and Client-side.


== Serverside (extension in PHP) ==
== Server-side (Extension in PHP) ==


=== Installation ===
=== Installation ===
First check if this extension is already installed. Create a new file with the content ''<?php phpinfo(); ?>'', save it in your web folder (e.g. ''C:\xampp\htdocs\phpinfo.php'') and call it using your browser (https://localhost/phpinfo.php). The command ''phpinfo'' will show you the information about installed plugins and their configuration. If you see a headline called XDebug, it is already downloaded and enabled.


First check if this extension is already installed. Create a new file with the content ''<?php phpinfo(); ?>'', save it in your webfolder (f.e. C:\xampp\htdocs\phpinfo.php) and call it using your browser (f.e. http://localhost/phpinfo.php). The command PHPINFO will show you all information about installed plugins, their configuration and so on. If you see a headline called Xdebug, it is already downloaded and enabled.
To get the extension for a Windows system, you have to download the DLL file from https://xdebug.org/download that fits your PHP version, move it into the ''ext'' folder of your PHP installation. If the file ''php_xdebug.dll'' exists, leave it there. It's most likely the right version, just that it's not enabled.


To get the extension for a Windows-System, you have to download the DLL-file from http://xdebug.org/download.php that fit's to your PHP version, move it into the ''ext'' folder of your PHP-installation. If the file php_xdebug.dll exists, leave it there. It's most likely the right version, just that it's not enabled. This was f.e. the case for the last XAMPP package I used.
=== Enable XDebug ===
On Windows systems you most likely just have one ''php.ini'' file for all configuration whereas on several Linux distributions you have a directory called ''conf.d'' in addition. If you have installed XDebug on a Linux-based system, you'll probably find a file ''xdebug.ini''. Use this file instead if you have it.


=== Enable Xdebug ===
Enable the plugin by adding (or uncommenting) the following line in your config file:
 
<syntaxhighlight lang="ini">
On windows-systems you most likely just have one ''php.ini'' file for all configuration whereas on several Linux distributions you have a directory called ''conf.d'' in addition. If you have installed Xdebug on a Linux based system, you'll probably find a file xdebug.ini in there. Use this file instead if you have it (just not to mess-up the main config-file).
 
You enable the plugin by adding (or uncommenting) the following line to your config-file:
<source lang="ini">
; Example for XAMPP
; Example for XAMPP
zend_extension = "\xampp\php\ext\php_xdebug.dll"
zend_extension = "\xampp\php\ext\php_xdebug.dll"
Line 21: Line 19:
; Example on Mac OS X for XAMPP
; Example on Mac OS X for XAMPP
zend_extension="/Applications/XAMPP/xamppfiles/lib/php/php-5.3.1/extensions/no-debug-non-zts-20090626/xdebug.so"
zend_extension="/Applications/XAMPP/xamppfiles/lib/php/php-5.3.1/extensions/no-debug-non-zts-20090626/xdebug.so"
</source>
</syntaxhighlight>


Please make sure you use ''zend_extension'' instead of ''extension'' which (not as extension) requires the full path to the extension-file.
Make sure you use ''zend_extension'' instead of ''extension'' which requires the full path to the extension-file.


=== Configuration ===
=== Configuration ===
Please also read this introduction for configuration-details: http://xdebug.org/docs/remote
Also read this introduction for configuration details: https://xdebug.org/docs/step_debug


Here is an example of the configuration I use and some comments around that:
Here is an example configuration:
<source lang="ini">
<syntaxhighlight lang="ini">
; location of my configuration-file
; location of my configuration-file
zend_extension=/usr/lib/php5/20090626/xdebug.so
zend_extension=/usr/lib/php5/20090626/xdebug.so


; Enables colors if you use xdebug on the console
; Enables colors if you use XDebug on the console
xdebug.cli_color=1
xdebug.cli_color=1


Line 45: Line 43:
; Enables the debugger
; Enables the debugger
xdebug.remote_enable=1
xdebug.remote_enable=1
</source>
</syntaxhighlight>
 
== Clientside (configure your IDE) ==


If your IDE is not listed on http://xdebug.org/docs/remote#clients, you'll probably find a tutorial in the manual of your IDE.
== Client-side (Configure Your IDE) ==
If your IDE is not listed on https://xdebug.org/docs/step_debug#clients, you'll probably find a tutorial in the manual of your IDE.
Feel free to add helpful tutorials here.
Feel free to add helpful tutorials here.

Latest revision as of 17:13, 29 June 2023

Content is Incomplete

This article or section is incomplete, which means it may be lacking information. You are welcome to assist in its completion by editing it as well. If this article or section has not been edited in several days, please consider helping complete the content.
This article was last edited by Cmb (talk| contribs) 21 months ago. (Purge)

Configuring XDebug is split into two parts: Server-side and Client-side.

Server-side (Extension in PHP)

Installation

First check if this extension is already installed. Create a new file with the content <?php phpinfo(); ?>, save it in your web folder (e.g. C:\xampp\htdocs\phpinfo.php) and call it using your browser (https://localhost/phpinfo.php). The command phpinfo will show you the information about installed plugins and their configuration. If you see a headline called XDebug, it is already downloaded and enabled.

To get the extension for a Windows system, you have to download the DLL file from https://xdebug.org/download that fits your PHP version, move it into the ext folder of your PHP installation. If the file php_xdebug.dll exists, leave it there. It's most likely the right version, just that it's not enabled.

Enable XDebug

On Windows systems you most likely just have one php.ini file for all configuration whereas on several Linux distributions you have a directory called conf.d in addition. If you have installed XDebug on a Linux-based system, you'll probably find a file xdebug.ini. Use this file instead if you have it.

Enable the plugin by adding (or uncommenting) the following line in your config file: 

; Example for XAMPP
zend_extension = "\xampp\php\ext\php_xdebug.dll"

; Example on Mac OS X for XAMPP
zend_extension="/Applications/XAMPP/xamppfiles/lib/php/php-5.3.1/extensions/no-debug-non-zts-20090626/xdebug.so"

Make sure you use zend_extension instead of extension which requires the full path to the extension-file.

Configuration

Also read this introduction for configuration details: https://xdebug.org/docs/step_debug

Here is an example configuration: 

; location of my configuration-file
zend_extension=/usr/lib/php5/20090626/xdebug.so

; Enables colors if you use XDebug on the console
xdebug.cli_color=1

; Enable profiler by a trigger (f.e. cookie or GET-param)
xdebug.profiler_enable_trigger=1
xdebug.profiler_output_dir=/var/www/log/

; Debugger will try to connect back to the machine sending the HTTP-Request
xdebug.remote_connect_back=1

; Enables the debugger
xdebug.remote_enable=1

Client-side (Configure Your IDE)

If your IDE is not listed on https://xdebug.org/docs/step_debug#clients, you'll probably find a tutorial in the manual of your IDE. Feel free to add helpful tutorials here.

Retrieved from "https://docs.sandbox.joomla.org/index.php?title=Configuring_Xdebug_for_PHP_development/Windows&oldid=1005731"