Actions

Difference between revisions of "How to debug your code"

From Joomla! Documentation

(edited to correct grammar and added link to eclipse installation instructions)
(Added: The Easy Way 2 (joomla message))
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
==The Easy Way 1 (echo)==
 
The simplest way to see what is going on inside your code is to temporarily add echo statements for variables to show their values on the screen. For example, say you want to know what the value of some variables are when $i is "5". You could use code like this:
 
The simplest way to see what is going on inside your code is to temporarily add echo statements for variables to show their values on the screen. For example, say you want to know what the value of some variables are when $i is "5". You could use code like this:
  
 
<source lang="PHP">for ( $i = 0; $i < 10; $i++ ) {
 
<source lang="PHP">for ( $i = 0; $i < 10; $i++ ) {
 
if ( $i == 5 ) {
 
if ( $i == 5 ) {
echo "$i=" . $i;  
+
echo '$i=' . $i;  
 
                 // other echo statements  
 
                 // other echo statements  
 
}
 
}
Line 10: Line 11:
 
This works for simple situations. However, if you are planning on doing a lot of Joomla! development, it is worth the effort to install and learn an integrated development environment (IDE) that includes a real PHP debugger.
 
This works for simple situations. However, if you are planning on doing a lot of Joomla! development, it is worth the effort to install and learn an integrated development environment (IDE) that includes a real PHP debugger.
  
Many Joomla! developers use the Eclipse IDE. This is free and includes a debugger. Instructions for installing it are available at [[Setting_up_your_workstation_for_Joomla!_development]].
+
==The Easy Way 2 (joomla message)==
 +
Your code won't always display simple echo statements. In that case you can try this alternative, still easy way:
 +
<source lang="PHP">JFactory::getApplication()->enqueueMessage( 'Some debug string(s)');</source>
 +
You can choose different [[Display_error_messages_and_notices|message types]] which corresponds to grouping with different styles (colors mainly).
  
 +
==Using an IDE==
 +
Many Joomla! developers use the Eclipse IDE. This is free and includes a debugger. Instructions for installing it are available at [[Setting_up_your_workstation_for_Joomla!_development]].
 +
==Using the PHP Expert editor==
 
Another option is the PHP Expert editor with an installed extension for debugging. Add the following lines to the php.ini file:
 
Another option is the PHP Expert editor with an installed extension for debugging. Add the following lines to the php.ini file:
  
Line 19: Line 26:
 
  debugger.profiler_enabled=off
 
  debugger.profiler_enabled=off
  
It is best to set profiler_enable to "off". Than you need set options in the menu Run/Options menu to use HTTP-server and the directory to where your script is located.
+
It is best to set profiler_enable to "off". Then you need to set options in the Run/Options menu to use HTTP-server and the directory in which your script is located.
  
If all options are correct you may run you script in debug mode by clicking on the Debug button (F8).
+
If all options are correct, you may run your script in debug mode by clicking on the Debug button (F8)
 +
==J!Dump==
 +
An often handy extension that can be found in the JED is the J!Dump extension that will allow you to dump variable, stack traces, and system information into a popup window at run time. This extension works like the PHP command `var_dump` but formats the output in a much more readable fashion.
 +
==JDEBUG==
 +
To check whether the Website is in the debug mode, test the JDEBUG variable:
 +
<source lang="PHP">
 +
if(JDEBUG){
 +
//whatever debugging code you want to run
 +
}
 +
</source>
 +
==JFirePHP==
 +
Use the Joomla [http://extensions.joomla.org/extensions/miscellaneous/development/11343 JFirePHP extension].
  
 
[[Category:Development]]
 
[[Category:Development]]

Revision as of 09:30, 11 September 2012

Contents

The Easy Way 1 (echo)

The simplest way to see what is going on inside your code is to temporarily add echo statements for variables to show their values on the screen. For example, say you want to know what the value of some variables are when $i is "5". You could use code like this:

for ( $i = 0; $i < 10; $i++ ) {
        if ( $i == 5 ) {
                echo '$i=' . $i; 
                // other echo statements 
        }
}

This works for simple situations. However, if you are planning on doing a lot of Joomla! development, it is worth the effort to install and learn an integrated development environment (IDE) that includes a real PHP debugger.

The Easy Way 2 (joomla message)

Your code won't always display simple echo statements. In that case you can try this alternative, still easy way:

JFactory::getApplication()->enqueueMessage( 'Some debug string(s)');

You can choose different message types which corresponds to grouping with different styles (colors mainly).

Using an IDE

Many Joomla! developers use the Eclipse IDE. This is free and includes a debugger. Instructions for installing it are available at Setting_up_your_workstation_for_Joomla!_development.

Using the PHP Expert editor

Another option is the PHP Expert editor with an installed extension for debugging. Add the following lines to the php.ini file:

extension=php_dbg.dll
[Debugger]
debugger.enabled=on
debugger.profiler_enabled=off

It is best to set profiler_enable to "off". Then you need to set options in the Run/Options menu to use HTTP-server and the directory in which your script is located.

If all options are correct, you may run your script in debug mode by clicking on the Debug button (F8)

J!Dump

An often handy extension that can be found in the JED is the J!Dump extension that will allow you to dump variable, stack traces, and system information into a popup window at run time. This extension works like the PHP command `var_dump` but formats the output in a much more readable fashion.

JDEBUG

To check whether the Website is in the debug mode, test the JDEBUG variable:

if(JDEBUG){
//whatever debugging code you want to run
}

JFirePHP

Use the Joomla JFirePHP extension.