Linux

Installation sur Linux^[1][2] :

 sudo apt-get install php8.3-xdebug

ou

 pecl install xdebug

Puis dans php.ini :

 xdebug.remote_enable = On

ou sur PHP via Apache :

 sudo vim /etc/php/8.3/apache2/conf.d/20-xdebug.ini

Ajouter :

 xdebug.remote_enable=1

Configuration complète

Exemple en V3^[3] :

sudo apt-get install php8.3-xdebug
&& echo "xdebug.discover_client_host=0" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.start_with_request=yes" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.mode=debug,coverage,profile" >> /usr/local/etc/php/php.ini

sudo apt-get install php7.4-xdebug
&& echo "xdebug.remote_handler=dbgp" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.remote_connect_back=0" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.remote_port=9000" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.remote_enable=1" >> /usr/local/etc/php/php.ini \
&& echo "xdebug.remote_autostart=1" >> /usr/local/etc/php/php.ini

Docker

Avec Docker, il faut aussi spécifier le "client_host"^[6].

Exemple d'installation et activation :

RUN pecl install xdebug \
  && docker-php-ext-enable xdebug

RUN echo "xdebug.client_host = 172.170.0.1" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
    && echo "xdebug.discover_client_host=0" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
    && echo "xdebug.start_with_request=yes" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
    && echo "xdebug.mode=debug,coverage,profile" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini

Windows

Wamp fournit Xdebug en mode "develop". Pour activer le débogage pas à pas, il faut donc éditer le php.ini :

xdebug.mode=debug
xdebug.client_host=127.0.0.1
xdebug.start_with_request=trigger

NB : on peut aussi le lancer tout le temps mais cela ralentit l'application et si l'IDE n'écoute plus, rajouter des logs "Xdebug: [Step Debug] Could not connect to debugging client".

xdebug.start_with_request=yes

Dans un navigateur

Il faut installer un module sur son navigateur (ex : Xdebug-ext sur Firefox^[7]) pour pouvoir activer ou désactiver le débogage d'une page. Ce module s'interface avec les principaux IDE, par exemple PhpStorm^[8], pour leur faire lancer le débogage lors du chargement d'une page.

En ligne de commande

On peut ajouter un argument à PHP^[9]. Ex :

php -d xdebug.mode=debug,profile bin/console MaCommande.php

Pour PhpStorm et Docker, il faut ajouter l'interpréteur dans les paramètres^[10].

Débogage pas à pas

Lors du débogage, PhpStorm fera apparaitre un menu "Debug" avec trois sous-menus dont :

1. la liste des variables du script et leurs valeurs (modifiables à la volée)
2. les warnings PHP
3. la sortie HTML.

Quand on clique dans la marge, un point d’arrêt est créé et représenté par une ligne rouge.

Raccourcis clavier (voir le menu "Run" en haut) :

• F7 (step into) : mode pas à pas détaillé.
• F8 (step over) : mode pas à pas sans sauter dans les dépendances.
• F9 (resume) : poursuivre l'exécution du programme sans s'arrêter.
• Alt + F9 : poursuivre jusqu'au prochain point d'arrêt.
• Shift + F7 : pas à pas intelligent.

Profilage

Ajouter le mode au précédent^[11] :

xdebug.mode=debug,profile

Un ensemble de vidéos explicatives existent en anglais^[12].