Getting Started With Xdebug
1 like675 views
The document provides an overview of Xdebug, an open source PHP extension that enables debugging and profiling of PHP applications. It discusses Xdebug features like stepping through code line-by-line, viewing application data at breakpoints, and function call stack tracing. The document also covers installing and configuring Xdebug, enabling and disabling debugging sessions, and using tools like KCacheGrind and Webgrind for profiling. Useful Xdebug functions and additional resources are listed.
![• Add query parameters to the script you’re trying to load:
• Start: [url]?XDEBUG_SESSION_START=[session_name]
• Stop: [url]?XDEBUG_SESSION_STOP=[session_name]
Enabling/Disabling Xdebug](https://image.slidesharecdn.com/gettingstartedwithxdebug-pnwphpseptember2015-150912180126-lva1-app6892/85/Getting-Started-With-Xdebug-23-320.jpg)
Getting Started With Xdebug
- 1. Jeremy Ward Pacific Northwest PHP Conference September 12, 2015 Getting Started With Xdebug
- 2. • Developer at Westwerk • Drummer for Loud Nerves • Board game geek • Fan of stand-up comedy About Me
- 3. • About ‘Debugging’ • Xdebug: Overview, Features, and Benefits • Xdebug Installation and Setup • Application Debugging and Profiling Today’s Topics
- 5. Our Goal
- 7. Understanding Debugging and Context
- 8. Evaluating, understanding, and validating how your application works. What is ‘debugging’?
- 9. var_dump()
- 11. Context Matters
- 12. Xdebug Overview
- 13. • PHP extension that provides debugging and profiling capabilities • Developed by Derick Rethans • First released in May 2002 • Uses the DBGp debugging protocol What is Xdebug?
- 14. • Debugging support • Stack trace view • Profiling • Code coverage analysis • Function logging Features
- 15. • Step through code operations line-by-line • View application data in memory at pre-determined breakpoints • Access function call stack • Update variable values during runtime • More detailed error messaging Benefits
- 16. • Xdebug support exists in over a dozen IDES, including: • PhpStorm • Eclipse • NetBeans • Plain text editors too (with extensions)! • VIM • Sublime Text • Notepad++ Editor Support
- 18. Assumptions
- 19. • Pre-installed w/ some environments (MAMP, XAMPP, Vagrant) • Install from source • PEAR/PECL • Detailed instructions at http://xdebug.org/docs/install Installation
- 20. • Locate php.ini file for your PHP installation • Unsure? Check ‘Loaded Configuration File’ using phpinfo() • Basic settings needed to enable remote debugging: • zend_extension=“/path/to/your/xdebug/extension” • xdebug.remote_enable=1 • xdebug.remote_host=localhost • xdebug.remote_port=9000 • xdebug.remote_autostart=1 Configuration
- 21. • Used primarily in virtual environments such as Vagrant • Helps the server layer find the location of local files • PhpStorm (and presumably other IDEs) include wizards for setting this up Path Mappings
- 22. Using Xdebug
- 23. • Add query parameters to the script you’re trying to load: • Start: [url]?XDEBUG_SESSION_START=[session_name] • Stop: [url]?XDEBUG_SESSION_STOP=[session_name] Enabling/Disabling Xdebug
- 24. • PhpStorm’s website has a list of recommended browser extensions: https://confluence.jetbrains.com/display/PhpStorm/Browser+Debugging +Extensions • Chrome: • Xdebug Helper • Xdebug Enabler • Firefox: • easy Xdebug • The Easiest Xdebug • Safari: • Xdebug Toogler Browser Extensions
- 25. • var_dump() - stylized! • xdebug_break() - pauses the app as if a breakpoint was set • xdebug_get_declared_vars() - returns array of elements defined in the current scope. • Complete list: http://xdebug.org/docs/all_functions Useful functions
- 26. • Profiling • KCacheGrind (Linux) • Webgrind: https://github.com/jokkedk/webgrind • Debugging • MacGDBp (OSX) • Aforementioned browser extensions Tools
- 27. Demo
- 28. • Xdebug website: http://xdebug.org • Xdebug and You: Why You Should Be Using a Real Debugger (Juan Treminio) https://jtreminio.com/2012/07/xdebug-and- you-why-you-should-be-using-a-real-debugger/ • Debugging and Profiling PHP with Xdebug (Shameer C) http://www.sitepoint.com/debugging-and-profiling-php- with-xdebug/ Additional Resources
- 29. Thank You! Feedback http://joind.in/15183 Questions? Email: [email protected] Twitter: @_jmichaelward IRC: jmichaelward