drupal_debug.md

Drupal Twig Debugging

Locating Template files

1. Copy the docroot/sites/default/example.services.local.yml file to docroot/sites/default/services.local.yml.
2. Clear the cache by running ddev drush cr.
3. Inspect the rendered page in a browser.
4. You should see HTML comments indicating what templates are being used throughout the source code. See Drupal.org: Locating Template Files with Debugging

Quickest Debug for Twig Templates: Twig Tweak Drupal Dump

• Add {{ drupal_dump() }}, {{ drupal_dump(variable-name) }} or {{ dd() }} or {{ dd(variable-name) }} to a Twig template file and refresh the browser with mass.local. See Drupal.org: Twig Tweak Cheat sheet (Drupal Dump)
• You can add this multiple times to the same or different template files.

Remember to remove all calls to drupal_dump() or dd() from templates before committing.

PHP Debug with Xdebug and PhpStorm

Initial setup:

1. Set up Xdebug in PhpStorm.
2. Enable Xdebug in ddev by running ddev xdebug on. See DDEV PHP Step Debugging for ddev specific setup instructions and how to configure your IDE.
3. Download and enable the Xdebug helper browser extension.

Drupal PhpStorm integration:

1. In PhpStorm, under Preferences > PHP > Frameworks:
   • Check off Enable Drupal integration
   • Set Drupal installation path to [you_local_path_to_openmass_parent_folder]/openmass/docroot
   • Select version 9
2. In PhpStorm, under Preferences > PHP > Servers, set Absolute path on the server to /var/www/html for openmass.
3. Edit debug configurations:
   • 
   • Click on the "+" sign to add new configuration and choose PHP Web Page
   • Set server to mass.local in your config.

For more information, refer to PHP frameworks and external tools/Drupal

Starting a PHP debugging session:

1. Enable the Devel module by running ddev drush en devel.
2. Clear the cache by running ddev drush cr.
3. Enable Xdebug listening in PhpStorm.
4. Enable Debug in the Xdebug helper browser extension for the page you are debugging.
5. Set a breakpoint by clicking to the right of a line number in a PHP file.
6. Refresh mass.local in the browser to hit the breakpoint.

Don't commit changes to the core.extension file enabling the devel module, or devel related config files.

For Twig debugging (not working consistently):

0. Comment out cache: false in docroot/sites/default/services.local.yml.

1. Clear the cache by running ddev drush cr, and make sure openmass/docroot/sites/default/files/php/twig folder exists.

2. In PhpStorm, under Preferences > PHP > Debug > Templates > Twig Debug, set the Cache path to [you_local_path_to_openmass_parent_folder]/openmass/docroot/sites/default/files/php/twig, or use the file locator to point to that folder.

3. Set a breakpoint by clicking to the right of a line number in a Twig template file.

   

Please note: this method is not working consistently. Refer to the quickest debug method for Twig template logging for now. If you can get this the Twig debug working consistently with Xdebug, please suggest changes to these steps.

Use Xdebug with Drush 13 in PHPStorm.

In order use xdebug with Drush in PHPStorm follow this steps:

1. ddev xdebug on
2. ddev ssh
3. export PHP_IDE_CONFIG="serverName=mass.local"
4. exit
5. Start listening for PHP Debug Connections in PHPStorm
   Switch to .
6. Set the break point in your PHP code.
   
7. Execute the Drush command with --xdebug parameter, for example ddev drush status --xdebug. See more here.
8. For debugging purposes, if you can't get xdebug work with drush, set check "Break at the first line in PHP scripts" in PHPStorm Settings > PHP > Debug.
   1. Make sure "Ignore external connections through unregistered server configurations" is unchecked.

Additional Resources

Twig debugging

• Drupal.org: Debugging Twig templates

Viewing variables

• Drupal.org: Debugging Twig tempaltes (Viewing variables)