Edit PHP.INI File for XDebug - Revision history

Cmb: URL corrections. Other text editing.

2023-06-29T20:57:05Z

URL corrections. Other text editing.

Cmb: Corrected the Linux 'Loaded Configuration File' text.

2019-06-25T18:29:46Z

Corrected the Linux 'Loaded Configuration File' text.

← Older revision		Revision as of 18:29, 25 June 2019
Line 1:		Line 1:
	=Edit PHP.INI File=		=Edit PHP.INI File for XDebug=

	==For Windows==		==For Windows==

	Starting with version 1.7, XAMPP includes the XDebug PHP debugger, but it needs to be configured for use. To do that, we will edit the "php.ini" file to configure XDebug. The "Loaded Configuration File" in the screenshot above tells you what "php.ini" file is being used. For Windows, this is normally "c:\xampp\apache\bin\php.ini".		Starting with version 1.7, XAMPP includes the XDebug PHP debugger, but it needs to be configured for use. To do that, we will edit the "php.ini" file to configure XDebug. The "Loaded Configuration File" in the screenshot above tells you what "php.ini" file is being used. For Windows, this is normally "c:\xampp\apache\bin\php.ini".

Line 44:		Line 43:

	==For Linux==		==For Linux==
			We will edit the ''php.ini'' file to configure XDebug. The ''Loaded Configuration File'' in your ''phpinfo'' display tells you what ''php.ini'' file is being used. For Linux, it will be something like ''/etc/php/7.2/apache2/php.ini''. (The PHP configuration is available in the Administrator of your Website: ''Administrator > System > System Information > PHP Information tab''.)

	We will edit the "php.ini" file to configure XDebug. The "Loaded Configuration File" in the screenshot above tells you what "php.ini" file is being used. For Linux, it will be something like "/opt/lampp/etc/php.ini".		Edit this file to configure XDebug as follows:
			# Find the line ''implicit_flush'' and set it as follows: <syntaxhighlight lang="ini">implicit_flush = On</syntaxhighlight>
	~~We need to edit~~ this file to configure XDebug as follows:		# Add the following lines at the end: <syntaxhighlight lang="ini">
	# Find the line "implicit_flush" and set it as follows: <syntaxhighlight lang="ini">implicit_flush = On</syntaxhighlight>
	# Add the following lines at the end:<syntaxhighlight lang="ini">
	;xDebug Configuration starts		;xDebug Configuration starts

Line 66:		Line 64:
	The xDebug Configuration detailed above can be appended to:		The xDebug Configuration detailed above can be appended to:
	<syntaxhighlight lang="ini">/etc/php5/apache2/conf.d/xdebug.ini </syntaxhighlight>		<syntaxhighlight lang="ini">/etc/php5/apache2/conf.d/xdebug.ini </syntaxhighlight>
	It should already contain the "zend_extension" variable and only needs the following variables added:		It should already contain the ''zend_extension'' variable and only needs the following variables added:
	<syntaxhighlight lang="ini">		<syntaxhighlight lang="ini">
	xdebug.profiler_enable = On		xdebug.profiler_enable = On
Line 80:		Line 78:

	==For Mac OS X==		==For Mac OS X==

	XAMPP for Mac OS X includes the XDebug PHP debugger, but it needs to be added to the "php.ini" file so that XDebug runs when Apache is started. To do this, open up the php.ini file, located at "/Applications/XAMPP/xamppfiles/etc/php.ini".		XAMPP for Mac OS X includes the XDebug PHP debugger, but it needs to be added to the "php.ini" file so that XDebug runs when Apache is started. To do this, open up the php.ini file, located at "/Applications/XAMPP/xamppfiles/etc/php.ini".

Tom Hutchison: playing with new syntaxhighlighter

2017-07-02T00:00:28Z

playing with new syntaxhighlighter

← Older revision		Revision as of 00:00, 2 July 2017
Line 9:		Line 9:

	We need to edit this file to configure XDebug as follows:		We need to edit this file to configure XDebug as follows:
	# Find the line "implicit_flush" and set it as follows: <~~pre~~>implicit_flush = On</~~pre~~>		# Find the line "implicit_flush" and set it as follows: <syntaxhighlight lang="ini">implicit_flush = On</syntaxhighlight>
	# Find the section called "[Zend]" and comment out all of the lines by putting a semi-colon (";") at the start of each line.		# Find the section called "[Zend]" and comment out all of the lines by putting a semi-colon (";") at the start of each line.
	# Find the line: zend_extension = "c:\xampp\php\ext\php_xdebug.dll" and uncomment it out.		# Find the line: zend_extension = "c:\xampp\php\ext\php_xdebug.dll" and uncomment it out.
	# Find the "[XDebug]" section and uncomment out all of the lines (except for the first comment line). For Windows, it should look like the example below:		# Find the "[XDebug]" section and uncomment out all of the lines (except for the first comment line). For Windows, it should look like the example below:<syntaxhighlight lang="ini">

	<~~pre~~>
	[XDebug]		[XDebug]
	;; Only Zend OR (!) XDebug		;; Only Zend OR (!) XDebug
Line 22:		Line 20:
	xdebug.remote_port=10000		xdebug.remote_port=10000
	xdebug.remote_handler=dbgp		xdebug.remote_handler=dbgp
	</~~pre~~>		</syntaxhighlight>

	You do not need to enable XDebug profiling to use XDebug to debug Joomla code. Profiling allows you to find performance bottlenecks in your PHP code. However, enabling profiling with XDebug can slow down your system substantially, so it is not recommended unless you need it. To enable XDebug profiling, add these entries to your php.ini file.		You do not need to enable XDebug profiling to use XDebug to debug Joomla code. Profiling allows you to find performance bottlenecks in your PHP code. However, enabling profiling with XDebug can slow down your system substantially, so it is not recommended unless you need it. To enable XDebug profiling, add these entries to your php.ini file.
	<~~pre~~>		<syntaxhighlight lang="ini">
	xdebug.profiler_enable=1		xdebug.profiler_enable=1
	xdebug.profiler_output_dir="C:\xampp\tmp"		xdebug.profiler_output_dir="C:\xampp\tmp"
	</~~pre~~>		</syntaxhighlight>

	For Windows 7 & Vista, you will use the file downloaded from the XDebug site. So the first line will be		For Windows 7 & Vista, you will use the file downloaded from the XDebug site. So the first line will be
	<~~pre~~>		<syntaxhighlight lang="ini">
	zend_extension_ts="C:\xampp\php\ext\php_xdebug-2.0.0-5.2.2.dll"		zend_extension_ts="C:\xampp\php\ext\php_xdebug-2.0.0-5.2.2.dll"
	</~~pre~~>		</syntaxhighlight>

	For PHP version 5.3 or later, the "_ts" has been dropped, so the first line will read		For PHP version 5.3 or later, the "_ts" has been dropped, so the first line will read
	<~~pre~~>		<syntaxhighlight lang="ini">
	zend_extension="C:\xampp\php\ext\php_xdebug.dll"		zend_extension="C:\xampp\php\ext\php_xdebug.dll"
	</~~pre~~>		</syntaxhighlight>

	In XAMPP 1.7.3 on Windows 7 (currently not verified/tested with prior Windows versions), XDebug may not work correctly if the path to the DLL file is in quotes. In this case, the line should be		In XAMPP 1.7.3 on Windows 7 (currently not verified/tested with prior Windows versions), XDebug may not work correctly if the path to the DLL file is in quotes. In this case, the line should be
	<~~pre~~>		<syntaxhighlight lang="ini">
	zend_extension = C:\xampp\php\ext\php_xdebug-2.1.0-5.3-vc6.dll		zend_extension = C:\xampp\php\ext\php_xdebug-2.1.0-5.3-vc6.dll
	</~~pre~~>		</syntaxhighlight>

	==For Linux==		==For Linux==
Line 50:		Line 48:

	We need to edit this file to configure XDebug as follows:		We need to edit this file to configure XDebug as follows:
	# Find the line "implicit_flush" and set it as follows: <~~pre~~>implicit_flush = On</~~pre~~>		# Find the line "implicit_flush" and set it as follows: <syntaxhighlight lang="ini">implicit_flush = On</syntaxhighlight>
	# Add the following lines at the end:		# Add the following lines at the end:<syntaxhighlight lang="ini">
	<~~pre~~>;xDebug Configuration starts		;xDebug Configuration starts

	zend_extension = /opt/lampp/lib/php/extensions/no-debug-non-zts-20090626/xdebug.so		zend_extension = /opt/lampp/lib/php/extensions/no-debug-non-zts-20090626/xdebug.so
Line 63:		Line 61:
	xdebug.remote_handler="dbgp"		xdebug.remote_handler="dbgp"

	;xDebug Configuration ends </~~pre~~>		;xDebug Configuration ends </syntaxhighlight>

	'''If using php5-xdebug on Ubuntu'''		'''If using php5-xdebug on Ubuntu'''
	The xDebug Configuration detailed above can be appended to:		The xDebug Configuration detailed above can be appended to:
	<~~pre~~>/etc/php5/apache2/conf.d/xdebug.ini </~~pre~~>		<syntaxhighlight lang="ini">/etc/php5/apache2/conf.d/xdebug.ini </syntaxhighlight>
	It should already contain the "zend_extension" variable and only needs the following variables added:		It should already contain the "zend_extension" variable and only needs the following variables added:
	<~~pre~~>xdebug.profiler_enable = On		<syntaxhighlight lang="ini">
			xdebug.profiler_enable = On
	xdebug.remote_enable=On		xdebug.remote_enable=On
	xdebug.remote_host="localhost"		xdebug.remote_host="localhost"
	xdebug.remote_port=10000		xdebug.remote_port=10000
	xdebug.remote_handler="dbgp"</~~pre~~>		xdebug.remote_handler="dbgp"</syntaxhighlight>

	'''Tip for users with LAN or remote servers:'''		'''Tip for users with LAN or remote servers:'''
	<~~pre~~>xdebug.remote_host="localhost"</~~pre~~>		<syntaxhighlight lang="ini">xdebug.remote_host="localhost"</syntaxhighlight>
	Should be set to the IP address of your Eclipse workstation [LAN users] or your public IP. For example:		Should be set to the IP address of your Eclipse workstation [LAN users] or your public IP. For example:
	<~~pre~~>xdebug.remote_host=192.168.0.199</~~pre~~>		<syntaxhighlight lang="ini">xdebug.remote_host=192.168.0.199</syntaxhighlight>

	==For Mac OS X==		==For Mac OS X==
Line 85:		Line 84:

	We need to edit this file to configure XDebug as follows:		We need to edit this file to configure XDebug as follows:
	# Find the line "implicit_flush" and set it as follows: <~~pre~~>implicit_flush = On</~~pre~~>		# Find the line "implicit_flush" and set it as follows: <syntaxhighlight lang="ini">implicit_flush = On</syntaxhighlight>
	# Add the following lines at the end:		# Add the following lines at the end:<syntaxhighlight lang="ini">
	<~~pre~~>;xDebug Configuration starts		;xDebug Configuration starts

	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"
Line 98:		Line 97:
	xdebug.remote_handler="dbgp"		xdebug.remote_handler="dbgp"

	;xDebug Configuration ends </~~pre~~>		;xDebug Configuration ends
			</syntaxhighlight>

	Be sure to navigate to the directory where you targeted the extension and check to see that the file path is correct. The folders in your XAMPP installation may be named differently.		Be sure to navigate to the directory where you targeted the extension and check to see that the file path is correct. The folders in your XAMPP installation may be named differently.
Line 115:		Line 115:
	In Linux, to restart XAMPP execute the command		In Linux, to restart XAMPP execute the command

	<~~pre~~> sudo /opt/lampp/lampp restart </~~pre~~>		<syntaxhighlight lang="shell">
			sudo /opt/lampp/lampp restart
			</syntaxhighlight>

	In Mac, open the "XAMPP Control" application, stop, and then start the Apache service again.		In Mac, open the "XAMPP Control" application, stop, and then start the Apache service again.

Tom Hutchison: added Category:Development using HotCat

2013-09-01T15:59:23Z

added Category:Development using HotCat

← Older revision		Revision as of 15:59, 1 September 2013
Line 130:		Line 130:

	[[Category:Bug Squad]]		[[Category:Bug Squad]]
			[[Category:Development]]

Tom Hutchison: added Category:Bug Squad using HotCat

2013-09-01T15:58:34Z

added Category:Bug Squad using HotCat

← Older revision		Revision as of 15:58, 1 September 2013
Line 128:		Line 128:

	At this point, XDebug is set up correctly.		At this point, XDebug is set up correctly.

			[[Category:Bug Squad]]

Dextercowley: update xdebug dll instructions

2013-09-01T15:07:06Z

update xdebug dll instructions

← Older revision		Revision as of 15:07, 1 September 2013
Line 5:		Line 5:
	Starting with version 1.7, XAMPP includes the XDebug PHP debugger, but it needs to be configured for use. To do that, we will edit the "php.ini" file to configure XDebug. The "Loaded Configuration File" in the screenshot above tells you what "php.ini" file is being used. For Windows, this is normally "c:\xampp\apache\bin\php.ini".		Starting with version 1.7, XAMPP includes the XDebug PHP debugger, but it needs to be configured for use. To do that, we will edit the "php.ini" file to configure XDebug. The "Loaded Configuration File" in the screenshot above tells you what "php.ini" file is being used. For Windows, this is normally "c:\xampp\apache\bin\php.ini".

	<blockquote>''Important note for Windows 7 & Vista users: As of ~~April 2009~~ (XAMPP version 1.7.0), the file "php_xdebug.dll" that is included with XAMPP ~~does not work~~ with Windows 7 & Vista. The symptom of this problem is that the Apache server ~~will~~ stop if this version of XDebug is loaded. To correct ~~this problem~~, ~~download XDebug version "Xdebug 2.0.0 / 5.2 VC6" from the~~ [http://xdebug.org/~~download~~.php ~~XDebug website~~]~~. This will download a file called <code>php_xdebug-2.0.0-5.2.2.dll</code>. Save this file in the extensions folder (for example, <code>c:\xampp\php\ext</code>) and change~~ the ~~php.ini file to point to this file, as shown below. With this file,~~ XDebug ~~works correctly with Windows 7 & Vista, including 64-bit~~.''		<blockquote>''Important note for Windows 7 & Vista users: As of August 2013 (XAMPP version 1.8.2), the file "php_xdebug.dll" that is included with XAMPP now works with Windows 7 & Vista. In some earlier versions of XAMPP, the distributed version of XDebug did not work correctly. The symptom of this earlier problem was that the Apache server would stop if this version of XDebug is loaded. To check that you are running the correct version of XDebug on your system, [http://xdebug.org/wizard.php follow these instructions] on the XDebug site.''
	</blockquote>		</blockquote>

Dextercowley: add warning about profiling slow down

2013-09-01T14:57:54Z

add warning about profiling slow down

← Older revision		Revision as of 14:57, 1 September 2013
Line 22:		Line 22:
	xdebug.remote_port=10000		xdebug.remote_port=10000
	xdebug.remote_handler=dbgp		xdebug.remote_handler=dbgp
			</pre>

			You do not need to enable XDebug profiling to use XDebug to debug Joomla code. Profiling allows you to find performance bottlenecks in your PHP code. However, enabling profiling with XDebug can slow down your system substantially, so it is not recommended unless you need it. To enable XDebug profiling, add these entries to your php.ini file.
			<pre>
	xdebug.profiler_enable=1		xdebug.profiler_enable=1
	xdebug.profiler_output_dir="C:\xampp\tmp"		xdebug.profiler_output_dir="C:\xampp\tmp"

E-builds: moved Edit PHP.INI File to Edit PHP.INI File for XDebug: Better title

2012-08-10T21:17:56Z

moved Edit PHP.INI File to Edit PHP.INI File for XDebug: Better title

← Older revision	Revision as of 21:17, 10 August 2012
(No difference)

E-builds: Created page with "=Edit PHP.INI File= ==For Windows== Starting with version 1.7, XAMPP includes the XDebug PHP debugger, but it needs to be configured for use. To do that, we will edit the "php...."

2012-08-10T16:50:08Z

Created page with "=Edit PHP.INI File= ==For Windows== Starting with version 1.7, XAMPP includes the XDebug PHP debugger, but it needs to be configured for use. To do that, we will edit the "php...."

New page

=Edit PHP.INI File=

==For Windows==

Starting with version 1.7, XAMPP includes the XDebug PHP debugger, but it needs to be configured for use. To do that, we will edit the "php.ini" file to configure XDebug. The "Loaded Configuration File" in the screenshot above tells you what "php.ini" file is being used. For Windows, this is normally "c:\xampp\apache\bin\php.ini".

<blockquote>''Important note for Windows 7 & Vista users: As of April 2009 (XAMPP version 1.7.0), the file "php_xdebug.dll" that is included with XAMPP does not work with Windows 7 & Vista. The symptom of this problem is that the Apache server will stop if this version of XDebug is loaded. To correct this problem, download XDebug version "Xdebug 2.0.0 / 5.2 VC6" from the [http://xdebug.org/download.php XDebug website]. This will download a file called <code>php_xdebug-2.0.0-5.2.2.dll</code>. Save this file in the extensions folder (for example, <code>c:\xampp\php\ext</code>) and change the php.ini file to point to this file, as shown below. With this file, XDebug works correctly with Windows 7 & Vista, including 64-bit.''
</blockquote>

We need to edit this file to configure XDebug as follows:
# Find the line "implicit_flush" and set it as follows: <pre>implicit_flush = On</pre>
# Find the section called "[Zend]" and comment out all of the lines by putting a semi-colon (";") at the start of each line.
# Find the line: zend_extension = "c:\xampp\php\ext\php_xdebug.dll" and uncomment it out.
# Find the "[XDebug]" section and uncomment out all of the lines (except for the first comment line). For Windows, it should look like the example below:

<pre>
[XDebug]
;; Only Zend OR (!) XDebug
zend_extension_ts="C:\xampp\php\ext\php_xdebug.dll"
xdebug.remote_enable=true
xdebug.remote_host=localhost
xdebug.remote_port=10000
xdebug.remote_handler=dbgp
xdebug.profiler_enable=1
xdebug.profiler_output_dir="C:\xampp\tmp"
</pre>

For Windows 7 & Vista, you will use the file downloaded from the XDebug site. So the first line will be
<pre>
zend_extension_ts="C:\xampp\php\ext\php_xdebug-2.0.0-5.2.2.dll"
</pre>

For PHP version 5.3 or later, the "_ts" has been dropped, so the first line will read
<pre>
zend_extension="C:\xampp\php\ext\php_xdebug.dll"
</pre>

In XAMPP 1.7.3 on Windows 7 (currently not verified/tested with prior Windows versions), XDebug may not work correctly if the path to the DLL file is in quotes. In this case, the line should be
<pre>
zend_extension = C:\xampp\php\ext\php_xdebug-2.1.0-5.3-vc6.dll
</pre>

==For Linux==

We will edit the "php.ini" file to configure XDebug. The "Loaded Configuration File" in the screenshot above tells you what "php.ini" file is being used. For Linux, it will be something like "/opt/lampp/etc/php.ini".

We need to edit this file to configure XDebug as follows:
# Find the line "implicit_flush" and set it as follows: <pre>implicit_flush = On</pre>
# Add the following lines at the end:
<pre>;xDebug Configuration starts

zend_extension = /opt/lampp/lib/php/extensions/no-debug-non-zts-20090626/xdebug.so

xdebug.profiler_output_dir = "/tmp/xdebug/"
xdebug.profiler_enable = On
xdebug.remote_enable=On
xdebug.remote_host="localhost"
xdebug.remote_port=10000
xdebug.remote_handler="dbgp"

;xDebug Configuration ends </pre>

'''If using php5-xdebug on Ubuntu'''
The xDebug Configuration detailed above can be appended to:
<pre>/etc/php5/apache2/conf.d/xdebug.ini </pre>
It should already contain the "zend_extension" variable and only needs the following variables added:
<pre>xdebug.profiler_enable = On
xdebug.remote_enable=On
xdebug.remote_host="localhost"
xdebug.remote_port=10000
xdebug.remote_handler="dbgp"</pre>

'''Tip for users with LAN or remote servers:'''
<pre>xdebug.remote_host="localhost"</pre>
Should be set to the IP address of your Eclipse workstation [LAN users] or your public IP. For example:
<pre>xdebug.remote_host=192.168.0.199</pre>

==For Mac OS X==

XAMPP for Mac OS X includes the XDebug PHP debugger, but it needs to be added to the "php.ini" file so that XDebug runs when Apache is started. To do this, open up the php.ini file, located at "/Applications/XAMPP/xamppfiles/etc/php.ini".

We need to edit this file to configure XDebug as follows:
# Find the line "implicit_flush" and set it as follows: <pre>implicit_flush = On</pre>
# Add the following lines at the end:
<pre>;xDebug Configuration starts

zend_extension="/Applications/XAMPP/xamppfiles/lib/php/php-5.3.1/extensions/no-debug-non-zts-20090626/xdebug.so"

xdebug.profiler_output_dir = "/tmp/xdebug/"
xdebug.profiler_enable = On
xdebug.remote_enable=On
xdebug.remote_host="localhost"
xdebug.remote_port=10000
xdebug.remote_handler="dbgp"

;xDebug Configuration ends </pre>

Be sure to navigate to the directory where you targeted the extension and check to see that the file path is correct. The folders in your XAMPP installation may be named differently.

The current (as of Sept 2010) version of the XAMPP binary for OS X contains the 2.0.4 version of Xdebug which will not let you see the variable data from included files when running xdebug. You can download a newer version from http://code.activestate.com/komodo/remotedebugging/. Unzip and copy one of the xdebug.so files to /Applications/XAMPP/xamppfiles/lib/php/php-5.3.1/extensions/no-debug-non-zts-20090626. As of Oct 2, 2010 this binary is still out of date (2.1beta3 rather than the stable 2.1) but it will show the variable data appropriately.

==Test XDebug Installation==
Now, we need to check that XDebug is installed correctly. To do this, we need to re-start XAMPP. In Windows, we can just browse to the "c:\xampp" folder in Windows Explorer and double-click the program "xampp-control.exe" to open the application shown below.

[[Image:Xampp-control.png]]

Press the "Stop" button for "Apache". The button with then read "Start". Press "Start" for Apache and wait a few seconds and the green "Running" message will again display. Then press "Exit" to close the application.

In Windows, if you get "ERROR: MySQL service not started [-1]", you may be able to correct this by going to c:\xampp\mysql and running mysql_uninstallservice.bat followed by mysql_installservice.bat.

In Linux, to restart XAMPP execute the command

<pre> sudo /opt/lampp/lampp restart </pre>

In Mac, open the "XAMPP Control" application, stop, and then start the Apache service again.

Once XAMPP has been restarted, open a browser and navigate to "http://localhost" to display the XAMPP welcome message (if you set XAMPP to listen to another port, you must append the port to the url; e.g.:"http://localhost:8080/"). Press the "phpinfo()" link again to display the PHP information screen. Scroll down to the lower part of the screen. You should see a section for "XDebug" as shown below.

[[Image:Phpinfo_xdebug.png]]

Look at the settings you entered in the "php.ini" file above. You should see these same settings in the xdebug display, as shown below.

[[Image:Xdebug settings.png]]

At this point, XDebug is set up correctly.