XDebug

Note: Xdebug is disabled by default.

xdebug:disable

Disable Xdebug

Syntax

box xdebug:disable

xdebug:enable

Enable Xdebug

Syntax

box xdebug:enable

xdebug:profiler

Toggle profiling

Syntax

box xdebug:profiler <action>

To profile your PHP code, you have to start the Xdebug profiler first:

box xdebug:profiler start

Every PHP file that gets executed will now generate profiling information in the form of a cachegrind file. You can analyze these files using an application like KCacheGrind, MCG or PHPStorm.

The box has Webgrind pre-installed and configured at http://webgrind.joomla.box. However, please note that it might fail on complex and large cachegrind files. A desktop app is recommended.

By default, cachegrind files will be stored in .

Remember to disable profiling once you are done:

box xdebug:profiler stop

For more information about Xdebug profiling, refer to the official documentation at http://www.xdebug.org/docs/profiler.

Arguments

action
start|stop

xdebug:toggle

Toggle Xdebug

Syntax

box xdebug:toggle

Need Help?

Let our developers personally assist you. You can ask development related questions in our Support Center. Only for Business or Agency subscribers.