Debug en PHP : XDebug avec Notepad++

Vous utilisez Notepad++ (donc Windows) pour développer en PHP ? Peu importe votre expérience sur PHP, nous sommes bien d'accord sur le fait que debugger du PHP s'avère être une tâche fastidieuse si l'on a pas les bons outils (la seconde image est un peu caricaturée :p mais avouez, vous l'avez déjà fait !).

Ne vous inquiétez pas, il y a plusieurs solutions, dont XDebug.

Plusieurs articles ont déjà été écrits à ce sujet, cependant, pour avoir un résultat fonctionnel il a fallut faire un compromis entre toutes les solutions proposées.

Installation de XDebug

Pour le fonctionnement d'XDebug, vous trouverez plusieurs liens à ce sujet, cet article a uniquement pour but de décrire la procédure d'installation rapide.

Afin installer XDebug, je vous conseille de suivre les consignes indiquées à l'adresse suivante.

Pour résumer, vous devez copier le résultat de la fonction :

phpinfo()

dans la zone de texte prévu à cet effet. Veillez à ne pas coller le résultat au format HTML mais sélectionnez le texte affiché sur la page et le collez le directement.

Cliquez ensuite sur le bouton en bas de la zone de texte afin d'avoir les instructions adaptées à votre installation actuelle de PHP.

Une fois l'installation effectuée, c'est à dire la dll copiée dans le répertoire adéquat, il faut modifier le fichier php.ini, pour certains ce peut être le fichier xdebug.ini (ça dépend des installations).

Si vous avez suivi les instructions détaillées sur le site de XDebug, vous devez avoir ajouté la ligne suivante :

zend_extension=path_vers_le_fichier_xdebug\php_xdebug­x.x.xx.x­vcx.dll

Ajoutez ensuite les lignes suivantes :

xdebug.remote_enable=On
xdebug.remote_connect_back=1 (certains vous diront de mettre xdebug.remote_host="localhost")
xdebug.remote_port=9001 (DBGP communique sur le port 9000, ce port étant occupé, j'ai mis 9001)
xdebug.remote_handler="dbgp"

On peut vérifier que l'installation a fonctionné en redémarrant le serveur web et en affichant phpinfo().

Configuration de Notepad++

Installez la dernière version de DBGP pour Nodepad++. Placez le fichier dll dans le répertoire plugin de Notepad++ puis redémarrez l'éditeur de texte.
Vous devriez avoir dans le menu "Compléments" de Notepad++, un menu "DBGp".
Dans ce menu, configurez les options comme suit :

Une fois la configuration de DBGp faite, ouvrez le fichier PHP que vous souhaitez débugger. Pour ajouter un point d'arrêt, rendez-vous dans la view Debug (Complémenents -> DBGp -> Debugger) puis placez votre curseur sur la ligne à debugger et cliquez sur le boutton contenant un point rouge. 

Il vous suffit ensuite de lancer le debug de la page souhaitée en suffixant son url avec  "?XDEBUG_SESSION_START=session_name"  (session_name pouvant avoir n’importe quelle valeur). Si tout se passe bien, le programme sera stoppé à la ligne sur laquelle vous avez posé un point d'arrêt. Ainsi, vous pourrez consulter le contenu des variables, parcourir votre programme, etc. sans laisser des traces partout.

Bon debug !